(spectrum)¶

The @RadiationOutput module for simulating spectrometers.

Summary of options¶

Option	Description
`@RadiationOutput(spectrum) common`	List of common quantities to include in the output file.
`@RadiationOutput(spectrum) output`	Name of the output file to generate.
`@RadiationOutput(spectrum) stokesparams`	Specifies whether or not to store Stokes parameters.

Example configuration¶

The following example shows how to configure this module:

@RadiationOutput ourSpectrum (spectrum) {
    output = "ourSpectrum.h5";
}

Output file structure¶

Output files generated by this module contain the following variables:

Variable	Description
`I`	Full spectrum (also known as Stokes \(I\) parameter).
`Q`	Spectrum corresponding to Stokes \(Q\) parameter.
`U`	Spectrum corresponding to Stokes \(U\) parameter.
`V`	Spectrum corresponding to Stokes \(V\) parameter.
`wavelengths`	List of wavelengths/photon energies corresponding to each element in the spectra.

Note

The name wavelengths is a bit misleading, as the values have the meaning of photon energies (normalized to \(m_e c^2\), the electron rest energy) when simulating bremsstrahlung.

Note

For synchrotron radiation, the unit of the wavelengths array is meters.

Common quantities¶

By default, no common quantities are included with output generated by this module. To add common quantities, use the @RadiationOutput(spectrum) common option.

All options¶

common¶

Default value:	`none`
Allowed values:	See the list on @RadiationOutput.

Specifies which “common quantities” to include in the output file. A full list of possible options is given on @RadiationOutput.

output¶

Default value:	Nothing
Allowed values:	Any valid file name.

Specifies the name of the output file to generate. The file name extension determines the type of the output file.

stokesparams¶

Default value:	`no`
Allowed values:	`yes` or `no`.

If yes, adds information about the Stokes parameter \((I, Q, U, V)\) to the Green’s function. Another dimension is added to the output array, and becomes the new first dimension. This effectively means that instead of storing one Green’s function, four separate Green’s function corresponding to each of the Stokes parameters is stored contiguously in memory.