.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXtransmission.nxdl.xml .. index:: ! NXtransmission (application definition) ! transmission (application definition) see: transmission (application definition); NXtransmission .. _NXtransmission: ============== NXtransmission ============== **Status**: application definition, extends :ref:`NXobject` **Description**: Application definition for transmission experiments **Symbols**: Variables used throughout the experiment **N_wavelengths**: Number of wavelength points **N_scans**: Number of scans **Groups cited**: :ref:`NXattenuator`, :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXfabrication`, :ref:`NXgrating`, :ref:`NXinstrument`, :ref:`NXmonochromator`, :ref:`NXsample`, :ref:`NXslit`, :ref:`NXsource`, :ref:`NXuser` .. index:: NXentry (base class); used in application definition, NXfabrication (base class); used in application definition, NXuser (base class); used in application definition, NXinstrument (base class); used in application definition, NXslit (base class); used in application definition, NXattenuator (base class); used in application definition, NXmonochromator (base class); used in application definition, NXgrating (base class); used in application definition, NXdetector (base class); used in application definition, NXsource (base class); used in application definition, NXsample (base class); used in application definition, NXdata (base class); used in application definition **Structure**: .. _/NXtransmission/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` This application definition .. _/NXtransmission/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` An application definition for transmission. Obligatory value: ``NXtransmission`` .. _/NXtransmission/ENTRY/definition@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` Version number to identify which definition of this application definition was used for this entry/data. .. _/NXtransmission/ENTRY/definition@url-attribute: .. index:: url (field attribute) **@url**: (required) :ref:`NX_CHAR ` URL where to find further material (documentation, examples) relevant to the application definition. .. _/NXtransmission/ENTRY/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` Start time of the experiment. .. _/NXtransmission/ENTRY/experiment_identifier-field: .. index:: experiment_identifier (field) **experiment_identifier**: (required) :ref:`NX_CHAR ` Unique identifier of the experiment, such as a (globally persistent) unique identifier. * The identifier is usually defined by the facility or principle investigator. * The identifier enables to link experiments to e.g. proposals. .. _/NXtransmission/ENTRY/experiment_description-field: .. index:: experiment_description (field) **experiment_description**: (optional) :ref:`NX_CHAR ` An optional free-text description of the experiment. However, details of the experiment should be defined in the specific fields of this application definition rather than in this experiment description. .. _/NXtransmission/ENTRY/acquisition_program-group: **acquisition_program**: (optional) :ref:`NXfabrication` .. _/NXtransmission/ENTRY/acquisition_program@url-attribute: .. index:: url (group attribute) **@url**: (recommended) :ref:`NX_CHAR ` Website of the software .. _/NXtransmission/ENTRY/acquisition_program/model-field: .. index:: model (field) **model**: (required) :ref:`NX_CHAR ` Commercial or otherwise defined given name to the program that was used to generate the result file(s) with measured data and metadata. .. _/NXtransmission/ENTRY/acquisition_program/identifier-field: .. index:: identifier (field) **identifier**: (required) :ref:`NX_CHAR ` Version number of the program that was used to generate the result file(s) with measured data and metadata. .. _/NXtransmission/ENTRY/operator-group: **operator**: (required) :ref:`NXuser` Contact information of at least the user of the instrument or the investigator who performed this experiment. Adding multiple users if relevant is recommended. .. _/NXtransmission/ENTRY/operator/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` Name of the user. .. _/NXtransmission/ENTRY/operator/affiliation-field: .. index:: affiliation (field) **affiliation**: (required) :ref:`NX_CHAR ` Name of the affiliation of the user at the point in time when the experiment was performed. .. _/NXtransmission/ENTRY/operator/address-field: .. index:: address (field) **address**: (required) :ref:`NX_CHAR ` Street address of the user's affiliation. .. _/NXtransmission/ENTRY/operator/email-field: .. index:: email (field) **email**: (required) :ref:`NX_CHAR ` Email address of the user. .. _/NXtransmission/ENTRY/operator/url-field: .. index:: url (field) **url**: (recommended) :ref:`NX_CHAR ` Author ID defined by reasearch id services, e.g. orcid (https://orcid.org/). .. _/NXtransmission/ENTRY/operator/telephone_number-field: .. index:: telephone_number (field) **telephone_number**: (recommended) :ref:`NX_CHAR ` Telephone number of the user. .. _/NXtransmission/ENTRY/instrument-group: **instrument**: (required) :ref:`NXinstrument` .. _/NXtransmission/ENTRY/instrument/common_beam_depolarizer-field: .. index:: common_beam_depolarizer (field) **common_beam_depolarizer**: (required) :ref:`NX_BOOLEAN ` If true, the incident beam is depolarized. .. _/NXtransmission/ENTRY/instrument/polarizer-field: .. index:: polarizer (field) **polarizer**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} Polarizer value inside the beam path .. _/NXtransmission/ENTRY/instrument/time_points-field: .. index:: time_points (field) **time_points**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [N_scans]) {units=\ :ref:`NX_TIME `} An array of relative scan start time points. .. _/NXtransmission/ENTRY/instrument/measured_data-field: .. index:: measured_data (field) **measured_data**: (required) :ref:`NX_NUMBER ` (Rank: 2, Dimensions: [N_scans, N_wavelengths]) Resulting data from the measurement. The length of the 2nd dimension is the number of time points. If it has length one the time_points may be empty. .. _/NXtransmission/ENTRY/instrument/manufacturer-group: **manufacturer**: (recommended) :ref:`NXfabrication` Manufacturer of the instrument. .. _/NXtransmission/ENTRY/instrument/common_beam_mask-group: **common_beam_mask**: (required) :ref:`NXslit` Common beam mask to shape the incident beam .. _/NXtransmission/ENTRY/instrument/common_beam_mask/y_gap-field: .. index:: y_gap (field) **y_gap**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_UNITLESS `} The height of the common beam in percentage of the beam .. _/NXtransmission/ENTRY/instrument/ref_attenuator-group: **ref_attenuator**: (required) :ref:`NXattenuator` Attenuator in the reference beam .. _/NXtransmission/ENTRY/instrument/ref_attenuator/attenuator_transmission-field: .. index:: attenuator_transmission (field) **attenuator_transmission**: (required) :ref:`NX_FLOAT ` .. _/NXtransmission/ENTRY/instrument/sample_attenuator-group: **sample_attenuator**: (required) :ref:`NXattenuator` Attenuator in the sample beam .. _/NXtransmission/ENTRY/instrument/sample_attenuator/attenuator_transmission-field: .. index:: attenuator_transmission (field) **attenuator_transmission**: (required) :ref:`NX_FLOAT ` .. _/NXtransmission/ENTRY/instrument/spectrometer-group: **spectrometer**: (required) :ref:`NXmonochromator` .. _/NXtransmission/ENTRY/instrument/spectrometer/wavelength-field: .. index:: wavelength (field) **wavelength**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [N_wavelengths]) {units=\ :ref:`NX_LENGTH `} Wavelength value(s) used for the measurement. An array of 1 or more elements. Length defines N_wavelenghts .. _/NXtransmission/ENTRY/instrument/spectrometer/spectral_resolution-field: .. index:: spectral_resolution (field) **spectral_resolution**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_WAVENUMBER `} Overall spectral resolution of this spectrometer. If several gratings are employed the spectral resoultion should rather be specified for each grating inside the NXgrating group of this spectrometer. .. _/NXtransmission/ENTRY/instrument/spectrometer/GRATING-group: **GRATING**: (optional) :ref:`NXgrating` Diffraction grating, as could be used in a monochromator. If two or more gratings were used, define the angular dispersion and the wavelength range (min/max wavelength) for each grating and make sure that the wavelength ranges do not overlap. The dispersion should be defined for the entire wavelength range of the experiment. .. _/NXtransmission/ENTRY/instrument/spectrometer/GRATING/angular_dispersion-field: .. index:: angular_dispersion (field) **angular_dispersion**: (optional) :ref:`NX_NUMBER ` Dispersion of the grating in nm/mm used. .. _/NXtransmission/ENTRY/instrument/spectrometer/GRATING/blaze_wavelength-field: .. index:: blaze_wavelength (field) **blaze_wavelength**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} The blaze wavelength of the grating used. .. _/NXtransmission/ENTRY/instrument/spectrometer/GRATING/spectral_resolution-field: .. index:: spectral_resolution (field) **spectral_resolution**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_WAVENUMBER `} Overall spectral resolution of the instrument when this grating is used. .. _/NXtransmission/ENTRY/instrument/spectrometer/GRATING/wavelength_range-field: .. index:: wavelength_range (field) **wavelength_range**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_LENGTH `} Wavelength range in which this grating was used .. _/NXtransmission/ENTRY/instrument/DETECTOR-group: **DETECTOR**: (required) :ref:`NXdetector` .. _/NXtransmission/ENTRY/instrument/DETECTOR/wavelength_range-field: .. index:: wavelength_range (field) **wavelength_range**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_LENGTH `} Wavelength range in which this detector was used .. _/NXtransmission/ENTRY/instrument/DETECTOR/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` Detector type Any of these values: ``PMT`` | ``PbS`` | ``InGaAs`` .. _/NXtransmission/ENTRY/instrument/DETECTOR/response_time-field: .. index:: response_time (field) **response_time**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_TIME `} Response time of the detector .. _/NXtransmission/ENTRY/instrument/DETECTOR/gain-field: .. index:: gain (field) **gain**: (optional) :ref:`NX_NUMBER ` Detector gain .. _/NXtransmission/ENTRY/instrument/DETECTOR/slit-group: **slit**: (required) :ref:`NXslit` Slit setting used for measurement with this detector .. _/NXtransmission/ENTRY/instrument/DETECTOR/slit/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` Any of these values: ``fixed`` | ``servo`` .. _/NXtransmission/ENTRY/instrument/SOURCE-group: **SOURCE**: (required) :ref:`NXsource` The lamp used for illumination .. _/NXtransmission/ENTRY/instrument/SOURCE/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` The type of lamp, e.g. halogen, D2 etc. Any of these values: ``halogen`` | ``D2`` .. _/NXtransmission/ENTRY/instrument/SOURCE/spectrum-field: .. index:: spectrum (field) **spectrum**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [N_wavelengths]) The spectrum of the lamp used .. _/NXtransmission/ENTRY/instrument/SOURCE/wavelength_range-field: .. index:: wavelength_range (field) **wavelength_range**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_LENGTH `} Wavelength range in which the lamp was used .. _/NXtransmission/ENTRY/SAMPLE-group: **SAMPLE**: (required) :ref:`NXsample` Properties of the sample measured .. _/NXtransmission/ENTRY/SAMPLE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` .. _/NXtransmission/ENTRY/data-group: **data**: (required) :ref:`NXdata` A default view of the data emitted intensity vs. wavelength. From measured_data plot intensity and wavelength. .. _/NXtransmission/ENTRY/data@axes-attribute: .. index:: axes (group attribute) **@axes**: (required) :ref:`NX_CHAR ` We recommend to use wavelength as a default attribute, but it can be replaced by any suitable parameter along the X-axis. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXtransmission/ENTRY-group ` * :ref:`/NXtransmission/ENTRY/acquisition_program-group ` * :ref:`/NXtransmission/ENTRY/acquisition_program/identifier-field ` * :ref:`/NXtransmission/ENTRY/acquisition_program/model-field ` * :ref:`/NXtransmission/ENTRY/acquisition_program@url-attribute ` * :ref:`/NXtransmission/ENTRY/data-group ` * :ref:`/NXtransmission/ENTRY/data@axes-attribute ` * :ref:`/NXtransmission/ENTRY/definition-field ` * :ref:`/NXtransmission/ENTRY/definition@url-attribute ` * :ref:`/NXtransmission/ENTRY/definition@version-attribute ` * :ref:`/NXtransmission/ENTRY/experiment_description-field ` * :ref:`/NXtransmission/ENTRY/experiment_identifier-field ` * :ref:`/NXtransmission/ENTRY/instrument-group ` * :ref:`/NXtransmission/ENTRY/instrument/common_beam_depolarizer-field ` * :ref:`/NXtransmission/ENTRY/instrument/common_beam_mask-group ` * :ref:`/NXtransmission/ENTRY/instrument/common_beam_mask/y_gap-field ` * :ref:`/NXtransmission/ENTRY/instrument/DETECTOR-group ` * :ref:`/NXtransmission/ENTRY/instrument/DETECTOR/gain-field ` * :ref:`/NXtransmission/ENTRY/instrument/DETECTOR/response_time-field ` * :ref:`/NXtransmission/ENTRY/instrument/DETECTOR/slit-group ` * :ref:`/NXtransmission/ENTRY/instrument/DETECTOR/slit/type-field ` * :ref:`/NXtransmission/ENTRY/instrument/DETECTOR/type-field ` * :ref:`/NXtransmission/ENTRY/instrument/DETECTOR/wavelength_range-field ` * :ref:`/NXtransmission/ENTRY/instrument/manufacturer-group ` * :ref:`/NXtransmission/ENTRY/instrument/measured_data-field ` * :ref:`/NXtransmission/ENTRY/instrument/polarizer-field ` * :ref:`/NXtransmission/ENTRY/instrument/ref_attenuator-group ` * :ref:`/NXtransmission/ENTRY/instrument/ref_attenuator/attenuator_transmission-field ` * :ref:`/NXtransmission/ENTRY/instrument/sample_attenuator-group ` * :ref:`/NXtransmission/ENTRY/instrument/sample_attenuator/attenuator_transmission-field ` * :ref:`/NXtransmission/ENTRY/instrument/SOURCE-group ` * :ref:`/NXtransmission/ENTRY/instrument/SOURCE/spectrum-field ` * :ref:`/NXtransmission/ENTRY/instrument/SOURCE/type-field ` * :ref:`/NXtransmission/ENTRY/instrument/SOURCE/wavelength_range-field ` * :ref:`/NXtransmission/ENTRY/instrument/spectrometer-group ` * :ref:`/NXtransmission/ENTRY/instrument/spectrometer/GRATING-group ` * :ref:`/NXtransmission/ENTRY/instrument/spectrometer/GRATING/angular_dispersion-field ` * :ref:`/NXtransmission/ENTRY/instrument/spectrometer/GRATING/blaze_wavelength-field ` * :ref:`/NXtransmission/ENTRY/instrument/spectrometer/GRATING/spectral_resolution-field ` * :ref:`/NXtransmission/ENTRY/instrument/spectrometer/GRATING/wavelength_range-field ` * :ref:`/NXtransmission/ENTRY/instrument/spectrometer/spectral_resolution-field ` * :ref:`/NXtransmission/ENTRY/instrument/spectrometer/wavelength-field ` * :ref:`/NXtransmission/ENTRY/instrument/time_points-field ` * :ref:`/NXtransmission/ENTRY/operator-group ` * :ref:`/NXtransmission/ENTRY/operator/address-field ` * :ref:`/NXtransmission/ENTRY/operator/affiliation-field ` * :ref:`/NXtransmission/ENTRY/operator/email-field ` * :ref:`/NXtransmission/ENTRY/operator/name-field ` * :ref:`/NXtransmission/ENTRY/operator/telephone_number-field ` * :ref:`/NXtransmission/ENTRY/operator/url-field ` * :ref:`/NXtransmission/ENTRY/SAMPLE-group ` * :ref:`/NXtransmission/ENTRY/SAMPLE/name-field ` * :ref:`/NXtransmission/ENTRY/start_time-field ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXtransmission.nxdl.xml