sdynpy.core.sdynpy_shape.shape_comparison_table

shape_comparison_table(shape_1, shape_2, frequency_format='{:0.2f}', damping_format='{:.02f}%', mac_format='{:0.0f}', percent_error_format='{:0.1f}%', spacing=2, table_format='text', node_id_map=None)[source]

Generates a shape comparison table between two sets of shapes

Parameters

  • shape_1 (ShapeArray) – The first shape set to compare

  • shape_2 (ShapeArray) – The second shape set to compare

  • frequency_format (str, optional) – Format specifier for frequency. The default is ‘{:0.2f}’.

  • damping_format (TYPE, optional) – Format specifier for damping. The default is ‘{:.02f}%’.

  • mac_format (TYPE, optional) – Format specifier for MAC. The default is ‘{:0.0f}’.

  • percent_error_format (TYPE, optional) – Format specifier for percent error. The default is ‘{:0.1f}%’.

  • spacing (TYPE, optional) – Spacing added between columns. The default is 2.

  • table_format (str, optional) – Table format to return. Must be ‘text’, ‘markdown’, or ‘latex’. The default is ‘text’.

  • node_id_map (id_map, optional) – An ID map to use if shapes do not have identical node ids. The default is to assume that the shapes have common node ids.

Raises

ValueError – Raised if an invalid table_format is specified

Returns

output_string – String representation of the output table

Return type

str