FitMeasurement

class nexus.FitMeasurement(*args, **kwargs)

Bases: Measurement

Abstract class for all fittable measurement class objects. Do not initialize this method, use the derived classes.

Parameters:

  • id (string) – String identifier.

  • experiment (Experiment) – Experiment.

  • detuning (list) – Detuning values for nuclear calculation.

  • time (list) – Time values for nuclear calculation which depend on time.

  • distribution_points (int) – Number of distribution_points for objects in forward geometry.

  • data_size (int) – Number of data points of experimental data.

  • scaling (Var) – Intensity scaling factor for fitting.

  • background (Var) – Background for fitting.

  • ( (offset) –

    class:Var): Offset in the x axis.

    New in version 1.1.0.

  • fit_weight (float) – Relative weight for the cost function in multi measurement fitting. Default is 1.

  • resolution (Var) – FWHM of the convolution kernel.

  • resolution_2 (Var) – FWHM of the convolution kernel along the second axis in 2D data sets.

  • kernel_type (string) – The kernel used for the convolution, either Gauss or Lorentz.

data_size

Number of data points of experimental data.

Type:

int

scaling

Intensity scaling factor for fitting.

Type:

Var

background

Background for fitting.

Type:

Var

offset (

class:Var): Offset in the x axis.

New in version 1.1.0.

fit_weight

Relative weight for the cost function in multi measurement fitting. Default is 1.

Type:

float

resolution

FWHM of the convolution kernel.

Type:

Var

resolution_2

FWHM of the convolution kernel along the second axis in 2D data sets.

Type:

Var

kernel_type

The kernel used for the convolution, either “Gauss” or “Lorentz”.

Type:

string

squared_residuals

Sum of the squared residuals. Calculated during fitting.

Type:

float

fit_residuals

The resdiuals from the fit. Calculated during fitting.

New in version 1.0.3.

Type:

array

class nexus.FitMeasurementVector(*args)

Bases: object

List of FitMeasurement objects.