EmissionSpectrum

nexus.EmissionSpectrum(experiment, velocity, electronic=True, intensity_data=[], scaling='auto', background='auto', distribution_points=1, fit_weight=1.0, instrument=<nexus.clib.cnexus.DefaultInstrumentLorentzian; proxy of <Swig Object of type 'Instrument *'> >, residual=<nexus.clib.cnexus.Sqrt; proxy of <Swig Object of type 'Residual *'> >, time_gate=[], coherence=False, id='')

Constructor for the EmissionSpectrum class. Class to calculate the energy-dependent emission intensity of the experiment.

Parameters:
  • id (string) – User identifier.

  • experiment (Experiment) – Experiment for the calculation.

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

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

  • intensity_data (list or ndarray) – Intensity data for fitting. Default is an empty list.

  • 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 auto.

  • resolution (float or Var) –

    Resolution value for convolution (Gamma). Default is 1.

    Removed in version 2.0.0.

  • distribution_points (int) – Number of points for thickness distributions in forward geometry and angular divergence in grazing geometry. Both distributions assume incoherent summation over the weighted contributions. Default is 1.

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

  • kernel_type (string) –

    Type of the resolution kernel. Is used for the convolution of the calculated energy spectrum with the resolution kernel. Can be Gauss or Lorentz. Default is Lorentz.

    Removed in version 2.0.0.

  • instrument (Instrument) –

    Instrument object. Default is Lorentzian with :math:’1 Gamma’.

    Added in version 2.0.0.

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

  • 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. 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.

  • coherence (bool) –

    Determines if the summation over the thickness and divergence distributions is performed coherently (True) or incoherently (False). Default is False.

    Added in version 1.0.3.

nexus.id

User identifier.

Type:

string

nexus.experiment

Experiment for the calculation.

Type:

Experiment

nexus.detuning

Detuning values for the calculation (Gamma).

Type:

list or ndarray

nexus.electronic

If True electronic scattering is included.

Type:

bool

nexus.result

List of detuning dependent intensity values.

Type:

list

nexus.intensity_data

Intensity data for fitting.

Type:

list

nexus.data_size

Number of data points of experimental intensity data.

Type:

int

nexus.scaling

Intensity scaling factor for fitting.

Type:

Var

nexus.background

Background for fitting.

Type:

Var

nexus.resolution

Resolution value for convolution.

Removed in version 2.0.0.

Type:

Var

nexus.resolution_kernel

The used kernel, same step size as detuning.

Removed in version 2.0.0.

Type:

list

nexus.distribution_points

Number of points for thickness distributions in forward geometry and angular divergence in grazing geometry. Both distributions assume incoherent summation over the weighted contributions.

Type:

int

nexus.fit_weight

Relative weight for the cost function in multi measurement fitting.

Type:

float

nexus.kernel_type

Type of the resolution kernel. Is used for the convolution of the calculated energy spectrum with the resolution kernel. Can be Gauss or Lorentz.

Removed in version 2.0.0.

Type:

string

nexus.instrument

Instrument object.

Added in version 2.0.0.

Type:

Instrument

nexus.residual

Implementation of the residual calculation used for fitting.

Type:

Residual

nexus.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

nexus.coherence

Determines if the summation over the thickness and divergence distributions is performed coherently (True) or incoherently (False). Default is False.

Added in version 1.0.3.

Type:

bool