sdynpy.core.sdynpy_shape.rigid_body_check

rigid_body_check(geometry, rigid_shapes, distance=0.25, distance_number=5, distance_yscale=20, residuals_to_label=5, return_shape_diagnostics=False, plot=True, return_figures=False, **rigid_shape_kwargs)[source]

Performs rigid body checks, both looking at the complex plane and residuals

Parameters

  • geometry (Geometry) – Geometry from which analytic rigid body shapes will be created

  • rigid_shapes (ShapeArray) – ShapeArray consisting of nominally rigid shapes from which errors are to be computed

  • distance (float, optional) – Threshold for computing distance from other points to find outliers. The default is 0.25.

  • distance_number (int, optional) – Threshold for number of neighbors to find outliers. The default is 5.

  • distance_yscale (float, optional) – Penalty factor applied to the complex portion of the shape when computing distances. The default is 20.

  • residuals_to_label (int, optional) – The top residuals_to_label residuals will be highlighted in the residual plots. The default is 5.

  • return_shape_diagnostics (True, optional) – If True, additional outputs are returned to help diagnose issues. The default is False.

  • plot (bool, optional) – Whether or not to create plots of the results. The default is True.

  • **rigid_shape_kwargs (various) – Additional keywords that can be passed to the Geometry.rigid_body_shapes method.

Returns

  • suspicious_channels (CoordinateArray) – A set of suspicous channels that should be investigated

  • analytic_rigid_shapes (ShapeArray) – Rigid body shapes created from the geometry. Only returned if return_shape_diagnostics is True

  • residual (np.ndarray) – Values of the residuals at coordinates np.unique(rigid_shapes.coordinate). Only returned if return_shape_diagnostics is True

  • shape_matrix_exp (np.ndarray) – The shape matrix of the supplied rigid shapes. Only returned if return_shape_diagnostics is True