analysis.compression_metrics.compression_metric

Enumerations for compression metric analysis.

Classes

CompressionMetric

Enumeration for compression metrics.

class CompressionMetric

Enumeration for compression metrics.

NON_COPLANARITY = 'non_coplanarity'

PEAK_ASYMMETRY = 'peak_asymmetry'

SUM_BENDING_ENERGY = 'sum_bending_energy'

AVERAGE_PERP_DISTANCE = 'average_perp_distance'

TOTAL_FIBER_TWIST = 'total_fiber_twist'

ENERGY_ASYMMETRY = 'energy_asymmetry'

CALC_BENDING_ENERGY = 'calc_bending_energy'

CONTOUR_LENGTH = 'contour_length'

COMPRESSION_RATIO = 'compression_ratio'

TWIST_ANGLE = 'twist_angle'

label() → str

Return the label for the compression metric.

Returns:

The label for the compression metric.

description() → str

Return the description for the compression metric.

Returns:

The description (and units) for the compression metric.

bounds() → tuple[float, float]

Return the default bounds for the compression metric.

Returns:

The default bounds for the compression metric.

calculate_metric(polymer_trace: ndarray, **options: dict[str, Any]) → float | floating[Any]

Calculate the compression metric for the given polymer trace.

Parameters:

• polymer_trace – Array containing the x,y,z positions of the polymer trace

• **options – Additional options as key-value pairs.

Returns:

The calculated compression metric for the polymer