.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXcontainer.nxdl.xml -- DO NOT EDIT
.. index::
! NXcontainer (base class)
! container (base class)
see: container (base class); NXcontainer
.. _NXcontainer:
===========
NXcontainer
===========
**Status**:
base class, extends :ref:`NXobject`
**Description**:
.. collapse:: State of a container holding the sample under investigation. ...
State of a container holding the sample under investigation.
A container is any object in the beam path which absorbs the beam and
whose contribution to the overall attenuation/scattering needs to be
determined to process the experimental data. Examples of containers
include glass capillary tubes, vanadium cans, windows in furnaces or
diamonds in a Diamond Anvil Cell. The following figures show a complex
example of a container:
.. figure:: container/ComplexExampleContainer.png
A hypothetical capillary furnace. The beam passes from left to right
(blue dashes), passing through window 1, then window 2, before
passing through the downstream wall of the capillary. It is then
scattered by the sample with scattered beams passing through the
upstream wall of the capillary, then windows 4 and 5. As part of the
corrections for a PDF experiment it is necessary to subtract the PDF
of the empty container (i.e. each of the windows and the capillary).
To calculate the PDF of the empty container it is necessary to have
the measured scattering data and to know the nature (e.g. density,
elemental composition, etc.) of the portion of the container which
the beam passed through.
.. figure:: container/ComplexContainerBeampath.png
A complete description of the shapes of the container elements with
their orientation relative to the beam and also information on
whether they are upstream or downstream of the sample is also
therefore important. For example, although the windows 2 and 4 have
the same shape, the path taken through them by the beam is very
different and this needs to be modelled. Furthermore, it is not
inconceivable that windows might move during an experiment and thus
the changes to the beampath would need to be accounted for.
This class encodes the position of the container with respect to the
sample and allows the calculation of the beampath through the container.
It also includes sufficient data to model beam absorption of the
container and a link to a dataset containing a measurement of the
container with nothing inside, to allow data corrections (at a specific
beam energy/measurement time) to be made.
**Symbols**:
No symbol table
**Groups cited**:
:ref:`NXbeam`, :ref:`NXshape`, :ref:`NXtransformations`
.. index:: NXbeam (base class); used in base class, NXshape (base class); used in base class, NXtransformations (base class); used in base class
**Structure**:
.. _/NXcontainer/name-field:
.. index:: name (field)
**name**: (optional) :ref:`NX_CHAR <NX_CHAR>`
Descriptive name of container.
.. _/NXcontainer/description-field:
.. index:: description (field)
**description**: (optional) :ref:`NX_CHAR <NX_CHAR>`
.. collapse:: Verbose description of container and how it fits into the wider ...
Verbose description of container and how it fits into the wider
experimental set up.
.. _/NXcontainer/chemical_formula-field:
.. index:: chemical_formula (field)
**chemical_formula**: (optional) :ref:`NX_CHAR <NX_CHAR>`
.. collapse:: Chemical composition of the material the container is made from. ...
Chemical composition of the material the container is made from.
Specified using CIF conventions. Abbreviated version of CIF
standard:
* Only recognized element symbols may be used.
* Each element symbol is followed by a 'count' number. A count of
'1' may be omitted.
* A space or parenthesis must separate each cluster of (element
symbol + count).
* Where a group of elements is enclosed in parentheses, the
multiplier for the group must follow the closing parentheses.
That is, all element and group multipliers are assumed to be
printed as subscripted numbers.
* Unless the elements are ordered in a manner that corresponds to
their chemical structure, the order of the elements within any
group or moiety depends on whether or not carbon is present.
* If carbon is present, the order should be:
- C, then H, then the other elements in alphabetical order of
their symbol.
- If carbon is not present, the elements are listed purely in
alphabetic order of their symbol.
* This is the *Hill* system used by Chemical Abstracts.
.. _/NXcontainer/density-field:
.. index:: density (field)
**density**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_MASS_DENSITY <NX_MASS_DENSITY>`}
Density of the material the container is made from.
.. _/NXcontainer/packing_fraction-field:
.. index:: packing_fraction (field)
**packing_fraction**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}
.. collapse:: Fraction of the volume of the container occupied by the material ...
Fraction of the volume of the container occupied by the material
forming the container.
.. _/NXcontainer/relative_molecular_mass-field:
.. index:: relative_molecular_mass (field)
**relative_molecular_mass**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_MASS <NX_MASS>`}
Relative molecular mass of container.
.. _/NXcontainer/beam-group:
**beam**: (optional) :ref:`NXbeam`
.. collapse:: Details of beam incident on container, including the position ...
Details of beam incident on container, including the position
relative to the sample (to determine whether the container is
upstream or downstream of the sample).
.. _/NXcontainer/shape-group:
**shape**: (optional) :ref:`NXshape`
.. collapse:: Shape of the container. In combination with orientation this ...
Shape of the container. In combination with orientation this
should allow the beampath through the container to be modelled to
allow the adsorption to be calculated.
.. _/NXcontainer/orientation-group:
**orientation**: (optional) :ref:`NXtransformations`
.. collapse:: The angle the container makes to the beam and how it may change ...
The angle the container makes to the beam and how it may change
during the experiment.In combination with shape this should allow
the beampath through the container to be modelled to allow the
adsorption of the container to be calculated.
.. _/NXcontainer/reference_measurement-link:
**reference_measurement**: :ref:`link<Design-Links>` (suggested target: ``/NXentry``)
.. collapse:: A link to a full data collection which contains the actual ...
A link to a full data collection which contains the actual
measured data for this container within the experimental set up
(with no sample or inner container(s)). This data set will also
include the wavelength/energy, measurement time and intensity for
which these data are valid.
Hypertext Anchors
-----------------
List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.
* :ref:`/NXcontainer/beam-group </NXcontainer/beam-group>`
* :ref:`/NXcontainer/chemical_formula-field </NXcontainer/chemical_formula-field>`
* :ref:`/NXcontainer/density-field </NXcontainer/density-field>`
* :ref:`/NXcontainer/description-field </NXcontainer/description-field>`
* :ref:`/NXcontainer/name-field </NXcontainer/name-field>`
* :ref:`/NXcontainer/orientation-group </NXcontainer/orientation-group>`
* :ref:`/NXcontainer/packing_fraction-field </NXcontainer/packing_fraction-field>`
* :ref:`/NXcontainer/reference_measurement-link </NXcontainer/reference_measurement-link>`
* :ref:`/NXcontainer/relative_molecular_mass-field </NXcontainer/relative_molecular_mass-field>`
* :ref:`/NXcontainer/shape-group </NXcontainer/shape-group>`
**NXDL Source**:
https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXcontainer.nxdl.xml