IntegratedEnergyTimeSpectrum

class nexus.IntegratedEnergyTimeSpectrum(experiment, time_length=200, time_step=0.2, integration_start=0, integration_stop=200, mode='i', electronic=False, intensity_data=[], scaling='auto', background=0.0, energy_resolution=0.0, time_resolution=0.7, distribution=1, fit_weight=1.0, bunch_spacing=inf, residual=<nexus.clib.cnexus.Sqrt; proxy of <Swig Object of type 'Residual *'> >, id='')

Bases: FitMeasurement

Constructor for the IntegratedEnergyTimeSpectrum class. Class to calculate the energy and time-integrated [integration_start, integration_stop] resonant intensity of the experiment. One sample has to have a drive detuning.

Parameters:

• id (string) – User identifier.

• experiment (Experiment) – Experiment.

• time_length (float) – Length of the calculation (nanoseconds).

• time_step (float) – Step size of the calculation (nanoseconds).

• integration_start (float) – Start time of the integration (nanosecond).

• integration_stop (float) – Stop time of the integration (nanosecond).

• mode (string) –

  Identifier for the calculation mode.

  • i - Interpolate detuning values. Fast mode.

  • f - Full calculation via change of the isomer shift. Slow mode.

• electronic (bool) – If True electronic scattering is also included.

• time_data (list or ndarray) – Time data for fitting.

• intensity_data (list or ndarray) – Time integrated intensity data for fitting.

• scaling (float or Var or string) – Intensity scaling factor for fitting. Default is auto.

• background (float or Var or string) – Background for fitting. Default is 0.

• energy_resolution (float or Var) – Energy resolution value for convolution. The energy resolution is not the energy resolution of the drive sample (e.g. an analyzer foil). This intrinsic resolution is given by the energy spectrum of drive sample. The energy resolution specified here is an additional energy resolution due to the experimental conditions, like an in proper drive motion itself.

• time_resolution (float or Var) – Time resolution value for convolution.

• distribution_points (int) – Number of points for roughness distributions in forward geometry

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

• residual (Residual) – Implementation of the residual calculation used for fitting.

id

User identifier.

Type:

string

experiment

Experiment

Type:

Experiment

time_length

Length of the calculation (nanoseconds).

Type:

float

time_step

Step size of the calculation (nanoseconds).

Type:

float

integration_start

Start time of the integration (nanosecond).

Type:

float

integration_stop

Stop time of the integration (nanosecond).

Type:

float

electronic

If True electronic scattering is also included.

Type:

bool

mode

Identifier for the calculation mode.

• i - Interpolate detuning values. Fast mode.

• f - Full calculation via change of the isomer shift. Slow mode.

Type:

string

time_data

Time data for fitting.

Type:

list

intensity_data

Time integrated intensity data for fitting.

Type:

list or ndarray

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

energy_resolution

Energy resolution value for convolution. The energy resolution is not the energy resolution of the drive sample (e.g. an analyzer foil). This intrinsic resolution is given by the energy spectrum of drive sample. The energy resolution specified here is an additional energy resolution due to the experimental conditions, like an in proper drive motion itself.

Type:

Var

time_resolution

Time resolution value for convolution.

Type:

Var

resolution_kernel

Weight of 2D Gaussian resolution. Same step size as detuning.

Type:

array

distribution_points

Number of points for roughness distributions in forward geometry

Type:

int

fit_weight

Relative weight for the cost function in multi measurement fitting.

Type:

float

residual

Implementation of the residual calculation used for fitting.

Type:

Residual

result

List of intensity values in units of (\(\Gamma\)).

Type:

ndarray

drive_sample

Sample object with drive detuning.

Added in version 1.0.3.

Type:

Sample

Calculate()

Calculates the class method. Also callable via operator ().

Returns:

array of intensities.

Return type:

ndarray

Plot()

Plot the IntegratedEnergyTimeSpectrum.

Added in version 1.0.3.

Velocity()

Returns the velocity detuning of the measurement in units of mm/s.

Returns:

Velocity detuning (mm/s).

Return type:

ndarray