AmplitudeSpectrum

class nexus.AmplitudeSpectrum(experiment, detuning, electronic=True, time_gate=[], id='')

Bases: Measurement

Constructor for the AmplitudeSpectrum class. Class to calculate the energy-dependent scattering amplitudes of the experiment. Only possible for a properly set Jones Vector of the Beam.

Parameters:

  • id (string) – User identifier.

  • experiment (Experiment) – experiment

  • detuning (list or ndarray) – detuning values for the calculation (Gamma).

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

  • time_gate (list) –

    An empty or two element list. If a two element list is passed these two values [start, stop] are taken as a time gating during spectrum collection. Given in ns. Default is an empty list.

    Added in version 1.0.1.

id

User identifier.

Type:

string

experiment

experiment

Type:

Experiment

detuning

detuning values for the calculation (Gamma).

Type:

list

electronic

If True electronic scattering is also included.

Type:

bool

result

List of detuning dependent complex amplitude values.

Type:

list

time_gate

An empty or two element list. If a two element list is passed these two values [start, stop] are taken as a time gating. The spectrum is Fourier transformed, the time gate is applied, and time response is transformed back to a spectrum. This does not give a time gated Moessbauer spectrum. Given in ns.

Added in version 1.0.1.

Type:

list

Calculate()

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

Returns:

Array of Jones vectors.

Return type:

ndarray

Plot(sigma=True, pi=True, polar=False, unwrap=True, name=None)

Plot the AmplitudeSpectrum.

Added in version 1.0.3.

Parameters:

  • sigma (bool) – Select if \(\sigma\) component should be plot.

  • pi (bool) – Select if \(\pi\) component should be plot.

  • phase (bool) – If True absolute and phase are plotted instead of real and imaginary parts.

  • unwrap (bool) – Select if phase should be unwrapped.

  • name (string) –

    If given, the plot is saved under this name.

    Added in version 1.1.0.

Velocity()

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

Returns:

Velocity detuning (mm/s).

Return type:

ndarray