LowRank.ComponentCurve

LowRank.ComponentCurve.py

class ComponentCurve(x, params)

Bases: object

A class to represent a component curve.

This object stores the elution-curve EGH parameters (H, tR, sigma, tau) and can evaluate the model curve, but it does not hold scattering profiles and therefore cannot compute Rg directly.

To obtain Rg values, use one of:

• decomp.get_rgs() — list of Rg for all components.

• decomp.get_xr_components() — returns XrComponent objects, each of which has get_guinier_object() for full Guinier-fit results.

x

The x-values of the component curve.

Type:

array-like

params

The EGH parameters [H, tR, sigma, tau] of the component curve.

Type:

array-like

moment

The moment of the component curve. Computed on demand. If None, it has not been computed yet.

Type:

Moment or None

Initializes the ComponentCurve object with the given x-values and parameters.

Parameters:

• x (array-like) – The x-values of the component curve.

• params (array-like) – The parameters of the component curve.

property y

The y-values of the component curve evaluated at self.x.

get_y(x=None)

Returns the y-values of the component curve.

Parameters:

x (array-like or None, optional) – The x-values to compute the y-values for. If None, uses the object’s x-values.

Returns:

The y-values of the component curve.

Return type:

array-like

get_xy()

Returns the x and y values of the component curve.

Returns:

The x and y values of the component curve.

Return type:

tuple of array-like

get_moment()

Returns the moment of the component curve.

Returns:

The moment of the component curve.

Return type:

Moment

get_params()

Returns the parameters of the component curve.

Returns:

The parameters of the component curve.

Return type:

array-like

get_peak_top_x()

Returns the x value at the peak top.

Returns:

The x value at the peak top.

Return type:

float

get_scale_param()

Returns the scale parameter.

Returns:

The scale parameter.

Return type:

float