spectrochempy.analysis.constraints.ReferenceProfile

class ReferenceProfile(profile, component, data)[source]

Reference-profile constraint.

States that a selected component profile must remain close to a known reference (e.g. a measured kinetic trace for concentrations, or a pure-component spectrum measured independently). The actual enforcement (projection vs. regularised least squares) is chosen by the engine; this object only carries the intent.

Parameters:

  • profile (str) – Must be "C" (concentrations) or "St" (spectra).

  • component (int) – Index of the component the reference applies to.

  • data (array-like) – The reference profile, as a 1-D array-like.

Examples

>>> from spectrochempy import ReferenceProfile
>>> ReferenceProfile("C", component=0, data=[0.1, 0.2, 0.7, 0.5])
ReferenceProfile(profile='C', component=0, data=[0.1, 0.2, 0.7, 0.5])
>>> ReferenceProfile("St", component=1, data=[0.1, 0.9, 0.5, 0.2])
ReferenceProfile(profile='St', component=1, data=[0.1, 0.9, 0.5, 0.2])

Attributes Summary

component

Index of the component the reference applies to.

data

The reference profile (1-D).

name

Short human-readable name of the constraint family.

profile

Canonical profile identifier ("C" or "St").

Attributes Documentation

component

Index of the component the reference applies to.

Type:

int

data

The reference profile (1-D).

Type:

array-like

name

Short human-readable name of the constraint family.

Type:

str

profile

Canonical profile identifier ("C" or "St").

Type:

str

Examples using spectrochempy.analysis.constraints.ReferenceProfile