ess.nmx.mcstas.xml.McStasInstrument#

class ess.nmx.mcstas.xml.McStasInstrument(simulation_settings, detectors, source, sample)[source]#
__init__(simulation_settings, detectors, source, sample)#

Methods

__init__(simulation_settings, detectors, ...)

detector_metadata(*det_names)

Extract detector metadata from the McStas instrument description.

experiment_metadata()

Extract experiment metadata from the McStas instrument description.

from_xml(tree)

Create McStas instrument from xml.

pixel_ids(*det_names)

Pixel IDs for the detectors.

Attributes

simulation_settings

detectors

source

sample

detector_metadata(*det_names)[source]#

Extract detector metadata from the McStas instrument description.

If multiple detector is requested, all metadata will be concatenated along the ‘panel’ dimension.

Parameters:

det_names (str) – Names of the detectors to extract metadata for.

Return type:

dict[str, Variable]

experiment_metadata()[source]#

Extract experiment metadata from the McStas instrument description.

Return type:

dict[str, Variable]

classmethod from_xml(tree)[source]#

Create McStas instrument from xml.

Return type:

McStasInstrument

pixel_ids(*det_names)[source]#

Pixel IDs for the detectors.

If multiple detectors are requested, all pixel IDs will be concatenated along the ‘id’ dimension.

Parameters:

det_names (str) – Names of the detectors to extract pixel IDs for.

Return type:

Variable