.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXsource.nxdl.xml -- DO NOT EDIT .. index:: ! NXsource (base class) ! source (base class) see: source (base class); NXsource .. _NXsource: ======== NXsource ======== .. Contributors List .. |contrib_name| replace:: Aaron Brewster|phyy-nx|https://avatars.githubusercontent.com/u/13471434?v=4|2022-06-15 .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2020-10-20 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 **Status**: base class, extends :ref:`NXobject` **Description**: The neutron or x-ray storage ring/facility. **Symbols**: No symbol table **Groups cited**: :ref:`NXdata`, :ref:`NXgeometry`, :ref:`NXnote`, :ref:`NXoff_geometry`, :ref:`NXtransformations` .. index:: NXnote (base class); used in base class, NXdata (base class); used in base class, NXgeometry (base class); used in base class, NXoff_geometry (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXsource@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. collapse:: Declares which child group contains a path leading ... .. index:: plotting Declares which child group contains a path leading to a :ref:`NXdata` group. It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion. .. _/NXsource/distance-field: .. index:: distance (field) **distance**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. collapse:: Effective distance from sample ... Effective distance from sample Distance as seen by radiation from sample. This number should be negative to signify that it is upstream of the sample. .. _/NXsource/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` Name of source .. _/NXsource/name@short_name-attribute: .. index:: short_name (field attribute) **@short_name**: (optional) :ref:`NX_CHAR ` short name for source, perhaps the acronym .. _/NXsource/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` .. collapse:: type of radiation source (pick one from the enumerated list and spell exactly) ... type of radiation source (pick one from the enumerated list and spell exactly) Any of these values: * ``Spallation Neutron Source`` * ``Pulsed Reactor Neutron Source`` * ``Reactor Neutron Source`` * ``Synchrotron X-ray Source`` * ``Pulsed Muon Source`` * ``Rotating Anode X-ray`` * ``Fixed Tube X-ray`` * ``UV Laser`` * ``Free-Electron Laser`` * ``Optical Laser`` * ``Ion Source`` * ``UV Plasma Source`` * ``Metal Jet X-ray`` .. _/NXsource/probe-field: .. index:: probe (field) **probe**: (optional) :ref:`NX_CHAR ` .. collapse:: type of radiation probe (pick one from the enumerated list and spell exactly) ... type of radiation probe (pick one from the enumerated list and spell exactly) Any of these values: * ``neutron`` * ``x-ray`` * ``muon`` * ``electron`` * ``ultraviolet`` * ``visible light`` * ``positron`` * ``proton`` .. _/NXsource/power-field: .. index:: power (field) **power**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_POWER `} Source power .. _/NXsource/emittance_x-field: .. index:: emittance_x (field) **emittance_x**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_EMITTANCE `} Source emittance (nm-rad) in X (horizontal) direction. .. _/NXsource/emittance_y-field: .. index:: emittance_y (field) **emittance_y**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_EMITTANCE `} Source emittance (nm-rad) in Y (horizontal) direction. .. _/NXsource/sigma_x-field: .. index:: sigma_x (field) **sigma_x**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} particle beam size in x .. _/NXsource/sigma_y-field: .. index:: sigma_y (field) **sigma_y**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} particle beam size in y .. _/NXsource/flux-field: .. index:: flux (field) **flux**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_FLUX `} Source intensity/area (example: s-1 cm-2) .. _/NXsource/energy-field: .. index:: energy (field) **energy**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} .. collapse:: Source energy. ... Source energy. For storage rings, this would be the particle beam energy. For X-ray tubes, this would be the excitation voltage. .. _/NXsource/current-field: .. index:: current (field) **current**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_CURRENT `} Accelerator, X-ray tube, or storage ring current .. _/NXsource/voltage-field: .. index:: voltage (field) **voltage**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_VOLTAGE `} Accelerator voltage .. _/NXsource/frequency-field: .. index:: frequency (field) **frequency**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_FREQUENCY `} Frequency of pulsed source .. _/NXsource/period-field: .. index:: period (field) **period**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_PERIOD `} Period of pulsed source .. _/NXsource/target_material-field: .. index:: target_material (field) **target_material**: (optional) :ref:`NX_CHAR ` .. collapse:: Pulsed source target material ... Pulsed source target material Any of these values: * ``Ta`` * ``W`` * ``depleted_U`` * ``enriched_U`` * ``Hg`` * ``Pb`` * ``C`` .. _/NXsource/number_of_bunches-field: .. index:: number_of_bunches (field) **number_of_bunches**: (optional) :ref:`NX_INT ` For storage rings, the number of bunches in use. .. _/NXsource/bunch_length-field: .. index:: bunch_length (field) **bunch_length**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} For storage rings, temporal length of the bunch .. _/NXsource/bunch_distance-field: .. index:: bunch_distance (field) **bunch_distance**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} For storage rings, time between bunches .. _/NXsource/pulse_width-field: .. index:: pulse_width (field) **pulse_width**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} temporal width of source pulse .. _/NXsource/mode-field: .. index:: mode (field) **mode**: (optional) :ref:`NX_CHAR ` .. collapse:: source operating mode ... source operating mode Any of these values: * ``Single Bunch``: for storage rings * ``Multi Bunch``: for storage rings .. _/NXsource/top_up-field: .. index:: top_up (field) **top_up**: (optional) :ref:`NX_BOOLEAN ` Is the synchrotron operating in top_up mode? .. _/NXsource/last_fill-field: .. index:: last_fill (field) **last_fill**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_CURRENT `} For storage rings, the current at the end of the most recent injection. .. _/NXsource/last_fill@time-attribute: .. index:: time (field attribute) **@time**: (optional) :ref:`NX_DATE_TIME ` date and time of the most recent injection. .. _/NXsource/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` .. collapse:: NeXus positions components by applying a set of translations and rotations ... NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere. The reference point of the source plane is its center in the x and y axis. The source is considered infinitely thin in the z axis. .. image:: source/source.png :width: 40% .. _/NXsource/notes-group: **notes**: (optional) :ref:`NXnote` .. collapse:: any source/facility related messages/events that ... any source/facility related messages/events that occurred during the experiment .. _/NXsource/bunch_pattern-group: **bunch_pattern**: (optional) :ref:`NXdata` .. collapse:: For storage rings, description of the bunch pattern. ... For storage rings, description of the bunch pattern. This is useful to describe irregular bunch patterns. .. _/NXsource/bunch_pattern/title-field: .. index:: title (field) **title**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` name of the bunch pattern .. _/NXsource/pulse_shape-group: **pulse_shape**: (optional) :ref:`NXdata` source pulse shape .. _/NXsource/geometry-group: **geometry**: (optional) :ref:`NXgeometry` .. index:: deprecated **DEPRECATED**: Use the field `depends_on` and :ref:`NXtransformations` to position the source and NXoff_geometry to describe its shape instead "Engineering" location of source. .. _/NXsource/OFF_GEOMETRY-group: **OFF_GEOMETRY**: (optional) :ref:`NXoff_geometry` This group describes the shape of the beam line component .. _/NXsource/distribution-group: **distribution**: (optional) :ref:`NXdata` The wavelength or energy distribution of the source .. _/NXsource/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` .. collapse:: This is the group recommended for holding the chain of translation ... This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXsource/bunch_distance-field ` * :ref:`/NXsource/bunch_length-field ` * :ref:`/NXsource/bunch_pattern-group ` * :ref:`/NXsource/bunch_pattern/title-field ` * :ref:`/NXsource/current-field ` * :ref:`/NXsource/depends_on-field ` * :ref:`/NXsource/distance-field ` * :ref:`/NXsource/distribution-group ` * :ref:`/NXsource/emittance_x-field ` * :ref:`/NXsource/emittance_y-field ` * :ref:`/NXsource/energy-field ` * :ref:`/NXsource/flux-field ` * :ref:`/NXsource/frequency-field ` * :ref:`/NXsource/geometry-group ` * :ref:`/NXsource/last_fill-field ` * :ref:`/NXsource/last_fill@time-attribute ` * :ref:`/NXsource/mode-field ` * :ref:`/NXsource/name-field ` * :ref:`/NXsource/name@short_name-attribute ` * :ref:`/NXsource/notes-group ` * :ref:`/NXsource/number_of_bunches-field ` * :ref:`/NXsource/OFF_GEOMETRY-group ` * :ref:`/NXsource/period-field ` * :ref:`/NXsource/power-field ` * :ref:`/NXsource/probe-field ` * :ref:`/NXsource/pulse_shape-group ` * :ref:`/NXsource/pulse_width-field ` * :ref:`/NXsource/sigma_x-field ` * :ref:`/NXsource/sigma_y-field ` * :ref:`/NXsource/target_material-field ` * :ref:`/NXsource/top_up-field ` * :ref:`/NXsource/TRANSFORMATIONS-group ` * :ref:`/NXsource/type-field ` * :ref:`/NXsource/voltage-field ` * :ref:`/NXsource@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXsource.nxdl.xml