FoldOptLib.splot package¶

Submodules¶

class FoldOptLib.splot.splot_processor.SPlotProcessor[source]¶

Bases: object

calculate_asymmetry(theta)[source]¶

Calculates the fold asymmetry for a given set of fourier parameters. The asymmetry of a curve is a measure of how much it deviates from symmetry.

calculate_splot(fold_frame, theta)[source]¶

Calculates the curve using the passed ref_fold_frame and theta values, it uses the passed coeff value to determine the specific function to use.

Parameters:

fold_frame (array) – The fold frame coordinates of the fold rotation angles
theta (float) – The fourier parameters

Returns:

curve – The calculated curve.

Return type:

array

calculate_tightness(theta)[source]¶

Calculates the tightness metric of the curve using the passed theta value

Parameters:: theta (float) – The parameter that is used to calculate the curve
Returns:: tightness – The tightness metric of the curve
Return type:: float

find_amax_amin(theta, v='radians')[source]¶

Helper method to find the amax and amin values of a fold rotation angle curve

Parameters:

theta (float) – The fourier parameters

Returns: