(sovvolume)¶

The @RadiationOutput module for calculating the volume of the surface-of-visibility. The volume of the surface-of-visibility depends on a number of factors, including the magnetic field geometry and the detector aperture size.

Summary of options¶

Option	Description
`@RadiationOutput(sovvolume) common`	List of common quantities to include in the output file.
`@RadiationOutput(sovvolume) output`	Name of the output file to generate.

Example configuration¶

The following example shows how to configure this module:

@RadiationOutput ourVolume (sovvolume) {
    output = "ourVolume.h5";
}

Output file structure¶

Output files generated by this module contain the following variables:

Variable	Description
`volumearray`	An \(1\times n_{p_1}n_{p_2}\) array containing the volume for each SoV.

Common quantities¶

By default, the following common quantities are included with the output generated by this module:

Name	Description
`param1`	First momentum parameter grid.
`param2`	Second momentum parameter grid.
`param1name`	SOFT name of first momentum parameter.
`param2name`	SOFT name of second momentum parameter.

To add further common quantities, use the @RadiationOutput(sovvolume) 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.