FlowChange.NullFlowChange

FlowChange.NullFlowChange#

FlowChange.NullFlowChange.py

class CsProxy(slope, intercept, a_curve=None, x_curve=None)#

Bases: object

A proxy class for Cs similarity computation.

slope#

The slope of the linear regression line.

Type:

float

intercept#

The intercept of the linear regression line.

Type:

float

mapped_info#

The mapping information, computed on demand.

Type:

MappingInfo or None

a_curve#

The A-curve.

Type:

Curve or None

x_curve#

The X-curve.

Type:

Curve or None

Initializes the CsProxy with given slope and intercept.

Parameters:

  • slope (float) – The slope of the linear regression line.

  • intercept (float) – The intercept of the linear regression line.

  • a_curve (Curve or None, optional) – The A-curve. If None, no A-curve is associated.

  • x_curve (Curve or None, optional) – The X-curve. If None, no X-curve is associated.

compute_whole_similarity()#

Computes the whole similarity.

Returns:

The whole similarity value.

Return type:

float

get_mapped_info()#

Gets the mapping information, computing it if necessary.

Returns:

The mapping information.

Return type:

MappingInfo

class NullFlowChange(a_curve, a_curve2, x_curve)#

Bases: object

A class representing a null flow change.

a_curve#

The A-curve.

Type:

Curve

a_curve2#

The second A-curve.

Type:

Curve

x_curve#

The X-curve.

Type:

Curve

cs#

The CsProxy object for similarity computation, computed on demand.

Type:

CsProxy or None

Initializes the NullFlowChange with given curves. :param a_curve: The A-curve. :type a_curve: Curve :param a_curve2: The second A-curve. :type a_curve2: Curve :param x_curve: The X-curve. :type x_curve: Curve

get_similarity()#

Gets the similarity value.

Returns:

The similarity value.

Return type:

float

get_real_flow_changes()#

Gets the real flow changes.

Returns:

Indicates no real flow changes.

Return type:

None, None

has_special()#

Indicates whether there are special flow changes.

Returns:

Always returns False.

Return type:

bool

remove_irregular_points()#

Removes irregular points.

Returns:

Empty arrays and a full slice.

Return type:

array, array, slice

Contents