diff --git a/base_classes/NXaperture.nxdl.xml b/base_classes/NXaperture.nxdl.xml index 32964dc6a8..030c5d9e23 100644 --- a/base_classes/NXaperture.nxdl.xml +++ b/base_classes/NXaperture.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + A beamline aperture. @@ -32,13 +32,6 @@ - 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 aperture is its center in the x and y axis. The reference point on the z axis is the surface of the aperture pointing towards the source. @@ -48,14 +41,6 @@ :width: 40% - - - 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. - - Use this group to describe the shape of the aperture. @@ -117,17 +102,4 @@ Describe any additional information in a note. - - - .. 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. - - diff --git a/base_classes/NXattenuator.nxdl.xml b/base_classes/NXattenuator.nxdl.xml index 9e64b7cb19..52ff615574 100644 --- a/base_classes/NXattenuator.nxdl.xml +++ b/base_classes/NXattenuator.nxdl.xml @@ -24,7 +24,7 @@ - - - .. 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. - - - 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 attenuator is its center in the x and y axis. The reference point on the z axis is the surface of the attenuator pointing towards the source. @@ -104,17 +84,8 @@ .. image:: attenuator/attenuator.png :width: 40% - - - - 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. - - Shape of this component. Particulary useful to define the origin for position and orientation in non-standard cases. diff --git a/base_classes/NXbeam.nxdl.xml b/base_classes/NXbeam.nxdl.xml index b3a44a1dbc..71370d4592 100644 --- a/base_classes/NXbeam.nxdl.xml +++ b/base_classes/NXbeam.nxdl.xml @@ -251,20 +251,6 @@ useful for simulations which need to store plottable information at each beamline component. - - - .. 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. - - - The NeXus coordinate system defines the Z axis to be along the nominal beam @@ -275,7 +261,6 @@ or a refined beam direction. - Direction (and location) for the beam. The location of the beam can be given by diff --git a/base_classes/NXbeam_stop.nxdl.xml b/base_classes/NXbeam_stop.nxdl.xml index 9e4d45ca46..1fda089ada 100644 --- a/base_classes/NXbeam_stop.nxdl.xml +++ b/base_classes/NXbeam_stop.nxdl.xml @@ -25,7 +25,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd" name="NXbeam_stop" - type="group" extends="NXobject"> + type="group" extends="NXcomponent"> A device that blocks the beam completely, usually to protect a detector. @@ -84,42 +84,13 @@ - - - .. 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. - - - 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 beam stop is its center in the x and y axis. The reference point on the z axis is the surface of the beam stop pointing towards the source. .. image:: beam_stop/beam_stop.png :width: 40% - - - - 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. - - diff --git a/base_classes/NXbending_magnet.nxdl.xml b/base_classes/NXbending_magnet.nxdl.xml index b05a745ad3..5ae5e40c11 100644 --- a/base_classes/NXbending_magnet.nxdl.xml +++ b/base_classes/NXbending_magnet.nxdl.xml @@ -25,7 +25,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd" name="NXbending_magnet" - type="group" extends="NXobject"> + type="group" extends="NXcomponent"> A bending magnet @@ -81,40 +81,10 @@ This group describes the shape of the beam line component - - - .. 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. - - - 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. - .. todo:: Add a definition for the reference point of a bending magnet. - - - - 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. - - - diff --git a/base_classes/NXcapillary.nxdl.xml b/base_classes/NXcapillary.nxdl.xml index f95f14c5d9..8691c980e4 100644 --- a/base_classes/NXcapillary.nxdl.xml +++ b/base_classes/NXcapillary.nxdl.xml @@ -25,7 +25,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd" name="NXcapillary" - type="group" extends="NXobject"> + type="group" extends="NXcomponent"> A capillary lens to focus the X-ray beam. @@ -64,39 +64,10 @@ The focal size in FWHM - - - .. 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. - - - 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. - .. todo:: Add a definition for the reference point of a capillary lens. - - - - 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. - - diff --git a/base_classes/NXcite.nxdl.xml b/base_classes/NXcite.nxdl.xml index ea18fb5bc1..047f8d1332 100644 --- a/base_classes/NXcite.nxdl.xml +++ b/base_classes/NXcite.nxdl.xml @@ -54,17 +54,4 @@ Bibliographic reference data in BibTeX format. - - - .. 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. - - diff --git a/base_classes/NXcollimator.nxdl.xml b/base_classes/NXcollimator.nxdl.xml index 2b8c2b546b..26ab51300b 100644 --- a/base_classes/NXcollimator.nxdl.xml +++ b/base_classes/NXcollimator.nxdl.xml @@ -25,7 +25,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd" name="NXcollimator" - type="group" extends="NXobject"> + type="group" extends="NXcomponent"> A beamline collimator. @@ -71,28 +71,8 @@ This group describes the shape of the beam line component - - - .. 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. - - - 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. - Assuming a collimator with a "flat" entry surface, the reference plane is the plane which contains this surface. The reference point of the collimator in the x and y axis is the centre of the collimator entry surface on that plane. The reference plane is orthogonal to the z axis and the location of this plane is the reference point on the z axis. The collimator faces negative z values. @@ -101,12 +81,4 @@ :width: 40% - - - 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. - - diff --git a/base_classes/NXcomponent.nxdl.xml b/base_classes/NXcomponent.nxdl.xml new file mode 100644 index 0000000000..f9a0b7dec6 --- /dev/null +++ b/base_classes/NXcomponent.nxdl.xml @@ -0,0 +1,92 @@ + + + + + + Base class for components of an instrument - real ones or simulated ones. + + + + Was the component used? + + + + + Name of the component. + + + + + Ideally, use instances of ``identifierNAME`` to point to a resource + that provides further details. + + If such a resource does not exist or should not be used, use this free text, + although it is not recommended. + + + + + Instance or list of instances of ``NXcomponent`` (or base classes + extending ``NXcomponent``) or ``NXbeam`` that act as input(s) to this + component. + + Each input should point to the path of the group acting as input. + + An example usage would be to chain components and/or beams together to describe + the beam path in an experiment. + + + + + Instance or list of instances of ``NXcomponent`` (or base classes + extending ``NXcomponent``) or ``NXbeam`` that act as output(s) of this + component. + + For more information, see :ref:`inputs </NXcomponent/inputs-field>`. + + + + + + + Specifies the position of the component by pointing to the last + transformation in the transformation chain that is defined + via the NXtransformations group. + + 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. + + + + + Collection of axis-based translations and rotations to describe the + location and geometry of the component in the instrument. The dependency + chain may however traverse similar groups in other component groups. + + + + diff --git a/base_classes/NXcrystal.nxdl.xml b/base_classes/NXcrystal.nxdl.xml index 067b96cdf8..a21c16d86b 100644 --- a/base_classes/NXcrystal.nxdl.xml +++ b/base_classes/NXcrystal.nxdl.xml @@ -25,7 +25,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd" name="NXcrystal" - type="group" extends="NXobject" + type="group" extends="NXcomponent" > @@ -267,37 +267,12 @@ This group describes the shape of the beam line component - - - .. 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. - - - 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. - .. todo:: Add a definition for the reference point of a crystal. - - - Transformations used by this component to define its position and orientation. - - - - - - - .. 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. - - - 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 detector is the center of the first pixel. In complex geometries the NXoff_geometry groups can be used to provide an unambiguous reference. - - - 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. - - diff --git a/base_classes/NXdetector_group.nxdl.xml b/base_classes/NXdetector_group.nxdl.xml index 74d7b15c2e..499cc4fe09 100644 --- a/base_classes/NXdetector_group.nxdl.xml +++ b/base_classes/NXdetector_group.nxdl.xml @@ -87,17 +87,4 @@ Code number for group type, e.g. bank=1, tube=2 etc. - - - .. 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. - - diff --git a/base_classes/NXdetector_module.nxdl.xml b/base_classes/NXdetector_module.nxdl.xml index 42bcbd69d7..9c69d80d0a 100644 --- a/base_classes/NXdetector_module.nxdl.xml +++ b/base_classes/NXdetector_module.nxdl.xml @@ -164,17 +164,4 @@ Points to the start of the dependency chain for this module. - - - .. 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. - - diff --git a/base_classes/NXdisk_chopper.nxdl.xml b/base_classes/NXdisk_chopper.nxdl.xml index 280d6cb08e..8d040bdf6c 100644 --- a/base_classes/NXdisk_chopper.nxdl.xml +++ b/base_classes/NXdisk_chopper.nxdl.xml @@ -25,7 +25,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd" name="NXdisk_chopper" - type="group" extends="NXobject"> + type="group" extends="NXcomponent"> This symbol will be used below to coordinate datasets with the same shape. @@ -134,28 +134,8 @@ This group describes the shape of the beam line component - - - .. 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. - - - 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 plane of the disk chopper includes the surface of the spinning disk which faces the source. The reference point in the x and y axis is the point on this surface which is the centre of the axle which the disk is spinning around. The reference plane is orthogonal to @@ -165,15 +145,6 @@ .. image:: disk_chopper/disk_chopper.png :width: 40% - - - - 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. - - diff --git a/base_classes/NXevent_data.nxdl.xml b/base_classes/NXevent_data.nxdl.xml index 0e441ac147..7e9c173433 100644 --- a/base_classes/NXevent_data.nxdl.xml +++ b/base_classes/NXevent_data.nxdl.xml @@ -106,17 +106,4 @@ cue_timestamp. - - - .. 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. - - diff --git a/base_classes/NXfermi_chopper.nxdl.xml b/base_classes/NXfermi_chopper.nxdl.xml index 17c6cea38d..4fe0796222 100644 --- a/base_classes/NXfermi_chopper.nxdl.xml +++ b/base_classes/NXfermi_chopper.nxdl.xml @@ -25,7 +25,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd" name="NXfermi_chopper" - type="group" extends="NXobject"> + type="group" extends="NXcomponent"> A Fermi chopper, possibly with curved slits. Fermi chopper type @@ -75,40 +75,11 @@ This group describes the shape of the beam line component - - - .. 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. - - - 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. - .. todo:: Add a definition for the reference point of a fermi chopper. - - - - 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. - - diff --git a/base_classes/NXfilter.nxdl.xml b/base_classes/NXfilter.nxdl.xml index 36d33de962..2e038be2cb 100644 --- a/base_classes/NXfilter.nxdl.xml +++ b/base_classes/NXfilter.nxdl.xml @@ -24,7 +24,7 @@ - - - .. 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. - - - 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. - .. todo:: Add a definition for the reference point of a filter. - - - - 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. - - diff --git a/base_classes/NXflipper.nxdl.xml b/base_classes/NXflipper.nxdl.xml index fa0d899686..711fc66456 100644 --- a/base_classes/NXflipper.nxdl.xml +++ b/base_classes/NXflipper.nxdl.xml @@ -25,7 +25,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd" name="NXflipper" - type="group" extends="NXobject"> + type="group" extends="NXcomponent"> A spin flipper. @@ -54,40 +54,11 @@ thickness along path of neutron travel - - - .. 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. - - - 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. - .. todo:: Add a definition for the reference point of a spin flipper. - - - - 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. - - diff --git a/base_classes/NXfresnel_zone_plate.nxdl.xml b/base_classes/NXfresnel_zone_plate.nxdl.xml index 390afbbac1..641ce94304 100644 --- a/base_classes/NXfresnel_zone_plate.nxdl.xml +++ b/base_classes/NXfresnel_zone_plate.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - - - - .. 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. - - - 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. - .. todo:: Add a definition for the reference point of a fresnel zone plate. - - - "Engineering" position of the fresnel zone plate - - 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. - - diff --git a/base_classes/NXgeometry.nxdl.xml b/base_classes/NXgeometry.nxdl.xml index 30b663f6cb..d978f58739 100644 --- a/base_classes/NXgeometry.nxdl.xml +++ b/base_classes/NXgeometry.nxdl.xml @@ -63,18 +63,5 @@ component_index. - - - .. 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. - - diff --git a/base_classes/NXgrating.nxdl.xml b/base_classes/NXgrating.nxdl.xml index ae523c9765..6785c94d35 100644 --- a/base_classes/NXgrating.nxdl.xml +++ b/base_classes/NXgrating.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - - - - .. 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. - - - 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. - .. todo:: Add a definition for the reference point of a bending grating. - diff --git a/base_classes/NXguide.nxdl.xml b/base_classes/NXguide.nxdl.xml index 0d37c6d604..7d399e3f11 100644 --- a/base_classes/NXguide.nxdl.xml +++ b/base_classes/NXguide.nxdl.xml @@ -23,7 +23,7 @@ --> - - - .. 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. - - - 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 entry opening of the guide lies on the reference plane. The center of the opening on that plane is the reference point on the x and y axis. The reference plane is orthogonal to the z axis and is the reference point along the z axis. Given no bend in the guide, it is parallel with z axis and extends @@ -215,16 +195,7 @@ .. image:: guide/guide.png :width: 40% - - - - 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. - - diff --git a/base_classes/NXinsertion_device.nxdl.xml b/base_classes/NXinsertion_device.nxdl.xml index 7bef9a6b67..4c3eace644 100644 --- a/base_classes/NXinsertion_device.nxdl.xml +++ b/base_classes/NXinsertion_device.nxdl.xml @@ -25,7 +25,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd" name="NXinsertion_device" - type="group" extends="NXobject"> + type="group" extends="NXcomponent"> An insertion device, as used in a synchrotron light source. @@ -73,39 +73,11 @@ This group describes the shape of the beam line component - - - .. 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. - - - 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. - .. todo:: Add a definition for the reference point of a insertion device. - - - 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. - - diff --git a/base_classes/NXinstrument.nxdl.xml b/base_classes/NXinstrument.nxdl.xml index 15e7645403..616b4e5f38 100644 --- a/base_classes/NXinstrument.nxdl.xml +++ b/base_classes/NXinstrument.nxdl.xml @@ -69,17 +69,4 @@ - - - .. 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. - - diff --git a/base_classes/NXlog.nxdl.xml b/base_classes/NXlog.nxdl.xml index 1af1ebe934..66d218ac71 100644 --- a/base_classes/NXlog.nxdl.xml +++ b/base_classes/NXlog.nxdl.xml @@ -122,17 +122,4 @@ cue_timestamp_zero. - - - .. 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. - - diff --git a/base_classes/NXmirror.nxdl.xml b/base_classes/NXmirror.nxdl.xml index 80f802a3ef..b18571814c 100644 --- a/base_classes/NXmirror.nxdl.xml +++ b/base_classes/NXmirror.nxdl.xml @@ -25,7 +25,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd" name="NXmirror" - type="group" extends="NXobject"> + type="group" extends="NXcomponent"> A beamline mirror or supermirror. @@ -120,28 +120,8 @@ This group describes the shape of the beam line component - - - .. 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. - - - 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. - Given a flat mirror, the reference plane is the plane which contains the "entry" surface of the mirror. The reference point of the mirror in the x and y axis is the centre of the mirror on that plane. The reference plane is orthogonal to the z axis and the location of this plane is the reference point on the z axis. The mirror faces negative z values. @@ -151,14 +131,6 @@ - - - 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. - - - + Details of an individual aperture for beams in electron microscopy. @@ -49,7 +49,6 @@ resource which gives further details. Alternatively a free-text field. - Affine transformation which detail the arrangement in the diff --git a/contributed_definitions/NXbeam_splitter.nxdl.xml b/contributed_definitions/NXbeam_splitter.nxdl.xml index f4ed2ac85a..e4b2d38e4d 100644 --- a/contributed_definitions/NXbeam_splitter.nxdl.xml +++ b/contributed_definitions/NXbeam_splitter.nxdl.xml @@ -22,7 +22,7 @@ # For further information, see http://www.nexusformat.org --> - + diff --git a/contributed_definitions/NXchamber.nxdl.xml b/contributed_definitions/NXchamber.nxdl.xml index edf318e2af..30da2e9d8d 100644 --- a/contributed_definitions/NXchamber.nxdl.xml +++ b/contributed_definitions/NXchamber.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + Component of an instrument to store or place objects and specimens. @@ -36,5 +36,4 @@ For example out of which material was the chamber built. - diff --git a/contributed_definitions/NXcollectioncolumn.nxdl.xml b/contributed_definitions/NXcollectioncolumn.nxdl.xml index 5348d55b5f..2720309109 100644 --- a/contributed_definitions/NXcollectioncolumn.nxdl.xml +++ b/contributed_definitions/NXcollectioncolumn.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + Subclass of NXelectronanalyser to describe the electron collection column of a photoelectron analyser. @@ -67,24 +67,6 @@ The magnification of the electron lens assembly. - - - Specifies the position of the collectioncolumn by pointing to the last - transformation in the transformation chain in the NXtransformations group. - - - - - Collection of axis-based translations and rotations to describe the location and - geometry of the deflector as a component in the instrument. Conventions from the - NXtransformations base class are used. In principle, the McStas coordinate - system is used. The first transformation has to point either to another - component of the system or . (for pointing to the reference frame) to relate it - relative to the experimental setup. Typically, the components of a system should - all be related relative to each other and only one component should relate to - the reference coordinate system. - - The size and position of an aperture inserted in the column, e.g. field aperture diff --git a/contributed_definitions/NXcontainer.nxdl.xml b/contributed_definitions/NXcontainer.nxdl.xml index fe2c2832bf..075f843e96 100644 --- a/contributed_definitions/NXcontainer.nxdl.xml +++ b/contributed_definitions/NXcontainer.nxdl.xml @@ -27,7 +27,7 @@ name="NXcontainer" category="base" type="group" - extends="NXobject" + extends="NXcomponent" > diff --git a/contributed_definitions/NXcorrector_cs.nxdl.xml b/contributed_definitions/NXcorrector_cs.nxdl.xml index fcca05d7a1..a4c834a074 100644 --- a/contributed_definitions/NXcorrector_cs.nxdl.xml +++ b/contributed_definitions/NXcorrector_cs.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + Corrector for aberrations in an electron microscope. @@ -31,24 +31,6 @@ The corrector in an electron microscope is composed of multiple lenses and multipole stigmators with vendor-specific details which are often undisclosed. - - - Was the corrector used? - - - - - Given name/alias. - - - - - - Ideally, a (globally) unique persistent identifier, link, - or text to a resource which gives further details. If this does not exist - a free-text field to report further details about the corrector. - - @@ -89,7 +71,6 @@ NEW ISSUE: following parameters of the these constants and how they are useful-- - diff --git a/contributed_definitions/NXdeflector.nxdl.xml b/contributed_definitions/NXdeflector.nxdl.xml index abdea5bbbf..34a5af5910 100644 --- a/contributed_definitions/NXdeflector.nxdl.xml +++ b/contributed_definitions/NXdeflector.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + Deflectors as they are used e.g. in an electron analyser. @@ -39,24 +39,7 @@ Colloquial or short name for the deflector. For manufacturer names and - identifiers use respective manufacturer fields. - - - - - Name of the manufacturer who built/constructed the deflector. - - - - - Hardware name, hash identifier, or serial number that was given by the - manufacturer to identify the deflector. - - - - - Ideally an identifier, persistent link, or free text which gives further details - about the deflector. + identifiers use ``NXfabrication`` and ``identifierNAME``. @@ -71,22 +54,4 @@ higher orders, it is an array. - - - Specifies the position of the deflector by pointing to the last transformation - in the transformation chain in the NXtransformations group. - - - - - Collection of axis-based translations and rotations to describe the location and - geometry of the deflector as a component in the instrument. Conventions from the - NXtransformations base class are used. In principle, the McStas coordinate - system is used. The first transformation has to point either to another - component of the system or . (for pointing to the reference frame) to relate it - relative to the experimental setup. Typically, the components of a system should - all be related relative to each other and only one component should relate to - the reference coordinate system. - - diff --git a/contributed_definitions/NXebeam_column.nxdl.xml b/contributed_definitions/NXebeam_column.nxdl.xml index 03b54b7792..3edca25f0d 100644 --- a/contributed_definitions/NXebeam_column.nxdl.xml +++ b/contributed_definitions/NXebeam_column.nxdl.xml @@ -23,7 +23,7 @@ --> - + Container for components to form a controlled beam in electron microscopy. @@ -32,12 +32,6 @@ The source which creates the electron beam. - - - Given name/alias. - - - Voltage relevant to compute the energy of the electrons diff --git a/contributed_definitions/NXelectronanalyser.nxdl.xml b/contributed_definitions/NXelectronanalyser.nxdl.xml index db991447d2..8b2bc82efc 100644 --- a/contributed_definitions/NXelectronanalyser.nxdl.xml +++ b/contributed_definitions/NXelectronanalyser.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + The symbols used in the schema to specify e.g. dimensions of arrays @@ -106,24 +106,6 @@ - - - Refers to the last transformation specifying the positon of the manipulator in - the NXtransformations chain. - - - - - Collection of axis-based translations and rotations to describe the location and - geometry of the electron analyser as a component in the instrument. Conventions - from the NXtransformations base class are used. In principle, the McStas - coordinate system is used. The first transformation has to point either to - another component of the system or . (for pointing to the reference frame) to - relate it relative to the experimental setup. Typically, the components of a - system should all be related relative to each other and only one component - should relate to the reference coordinate system. - - Describes the electron collection (spatial and momentum imaging) column diff --git a/contributed_definitions/NXelectrostatic_kicker.nxdl.xml b/contributed_definitions/NXelectrostatic_kicker.nxdl.xml index 3dde21faef..16d9bfeab8 100644 --- a/contributed_definitions/NXelectrostatic_kicker.nxdl.xml +++ b/contributed_definitions/NXelectrostatic_kicker.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - - + Subclass of NXelectronanalyser to describe the energy dispersion section of a photoelectron analyser. diff --git a/contributed_definitions/NXfiber.nxdl.xml b/contributed_definitions/NXfiber.nxdl.xml index 103e7ba65e..f4a32db3c3 100644 --- a/contributed_definitions/NXfiber.nxdl.xml +++ b/contributed_definitions/NXfiber.nxdl.xml @@ -22,7 +22,7 @@ # For further information, see http://www.nexusformat.org --> - + diff --git a/contributed_definitions/NXibeam_column.nxdl.xml b/contributed_definitions/NXibeam_column.nxdl.xml index 0377b93f40..e08b7e8d00 100644 --- a/contributed_definitions/NXibeam_column.nxdl.xml +++ b/contributed_definitions/NXibeam_column.nxdl.xml @@ -23,7 +23,7 @@ --> - + Container for components of a focused-ion-beam (FIB) system. @@ -47,7 +47,6 @@ * `J. F. Ziegler et al. <https://www.sciencedirect.com/science/article/pii/S0168583X10001862>`_ * `J. Lili <https://www.osti.gov/servlets/purl/924801>`_ - The source which creates the ion beam. @@ -71,12 +70,6 @@ - - - Ideally, a (globally) unique persistent identifier, link, - or text to a resource which gives further details. - - Which ionized elements or molecular ions form the beam. diff --git a/contributed_definitions/NXlens_em.nxdl.xml b/contributed_definitions/NXlens_em.nxdl.xml index 92be5ae595..f83021e8f1 100644 --- a/contributed_definitions/NXlens_em.nxdl.xml +++ b/contributed_definitions/NXlens_em.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + Description of an electro-magnetic lens or a compound lens. @@ -47,25 +47,7 @@ Given name, alias, colloquial, or short name for the lens. - For manufacturer names and identifiers use respective manufacturer fields. - - - - - Name of the manufacturer who built/constructed the lens. - - - - - - Hardware name, hash identifier, or serial number that was given by the - manufacturer to identify the lens. - - - - - Ideally an identifier, persistent link, or free text which gives further details - about the lens. + For manufacturer names and identifiers use ``NXfabrication`` and ``identifierNAME``. @@ -91,19 +73,4 @@ and software should bring the lenses into a similar state. - - - Specifies the position of the lens by pointing to the last transformation in the - transformation chain in the NXtransformations group. - - - - - Collection of axis-based translations and rotations to describe the - location and geometry of the lens as a component in the instrument. - Typically, the components of a system should all be related relative to - each other and only one component should relate to the reference - coordinate system. - - diff --git a/contributed_definitions/NXlens_opt.nxdl.xml b/contributed_definitions/NXlens_opt.nxdl.xml index 753a58e550..4738a7b359 100644 --- a/contributed_definitions/NXlens_opt.nxdl.xml +++ b/contributed_definitions/NXlens_opt.nxdl.xml @@ -23,7 +23,7 @@ --> - + diff --git a/contributed_definitions/NXmagnetic_kicker.nxdl.xml b/contributed_definitions/NXmagnetic_kicker.nxdl.xml index 90d983de6c..1ce3aec0bf 100644 --- a/contributed_definitions/NXmagnetic_kicker.nxdl.xml +++ b/contributed_definitions/NXmagnetic_kicker.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - - + Extension of NXpositioner to include fields to describe the use of manipulators in photoemission experiments. @@ -79,22 +79,4 @@ Class to describe the motors that are used in the manipulator - - - Refers to the last transformation specifying the positon of the manipulator in - the NXtransformations chain. - - - - - Collection of axis-based translations and rotations to describe the location and - geometry of the manipulator as a component in the instrument. Conventions from - the NXtransformations base class are used. In principle, the McStas coordinate - system is used. The first transformation has to point either to another - component of the system or . (for pointing to the reference frame) to relate it - relative to the experimental setup. Typically, the components of a system should - all be related relative to each other and only one component should relate to - the reference coordinate system. - - diff --git a/contributed_definitions/NXpid.nxdl.xml b/contributed_definitions/NXpid.nxdl.xml index 62fad3f835..594afbfa45 100644 --- a/contributed_definitions/NXpid.nxdl.xml +++ b/contributed_definitions/NXpid.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + Contains the settings of a PID controller. diff --git a/contributed_definitions/NXpolarizer_opt.nxdl.xml b/contributed_definitions/NXpolarizer_opt.nxdl.xml index c31e365c49..9142ae4817 100644 --- a/contributed_definitions/NXpolarizer_opt.nxdl.xml +++ b/contributed_definitions/NXpolarizer_opt.nxdl.xml @@ -23,7 +23,7 @@ --> - + diff --git a/contributed_definitions/NXpulser_apm.nxdl.xml b/contributed_definitions/NXpulser_apm.nxdl.xml index a57b1af0d5..f2a6edaf02 100644 --- a/contributed_definitions/NXpulser_apm.nxdl.xml +++ b/contributed_definitions/NXpulser_apm.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + The symbols used in the schema to specify e.g. dimensions of arrays. @@ -35,7 +35,6 @@ Metadata for laser- and/or voltage-pulsing in atom probe microscopy. - How is field evaporation physically triggered. diff --git a/contributed_definitions/NXpump.nxdl.xml b/contributed_definitions/NXpump.nxdl.xml index 9f38b2d7b7..bf50623bad 100644 --- a/contributed_definitions/NXpump.nxdl.xml +++ b/contributed_definitions/NXpump.nxdl.xml @@ -21,11 +21,10 @@ # # For further information, see http://www.nexusformat.org --> - + Device to reduce an atmosphere to a controlled remaining pressure level. - Principle type of the pump. diff --git a/contributed_definitions/NXquadrupole_magnet.nxdl.xml b/contributed_definitions/NXquadrupole_magnet.nxdl.xml index 119970e4b3..84442c7a17 100644 --- a/contributed_definitions/NXquadrupole_magnet.nxdl.xml +++ b/contributed_definitions/NXquadrupole_magnet.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - - + Device for reducing flight time differences of ions in ToF experiments. For atom probe the reflectron can be considered an energy_compensation device, which can e.g. be realized technically as via a Poschenrieder lens (see US patent 3863068 or US patents for the reflectron 6740872, or the curved reflectron 8134119 design). - - - Given name/alias. - - - - - - Free-text field to specify further details about the reflectron. - The field can be used to inform e. g. if the reflectron is flat or curved. - - diff --git a/contributed_definitions/NXscanbox_em.nxdl.xml b/contributed_definitions/NXscanbox_em.nxdl.xml index c95f62357d..086ec56e53 100644 --- a/contributed_definitions/NXscanbox_em.nxdl.xml +++ b/contributed_definitions/NXscanbox_em.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + Scan box and coils which deflect an electron beam in a controlled manner. @@ -40,7 +40,6 @@ - diff --git a/contributed_definitions/NXseparator.nxdl.xml b/contributed_definitions/NXseparator.nxdl.xml index 90ebda115a..81ba465340 100644 --- a/contributed_definitions/NXseparator.nxdl.xml +++ b/contributed_definitions/NXseparator.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - - - - + Subclass of NXelectronanalyser to describe the spin filters in photoemission experiments. @@ -66,24 +66,6 @@ Date of last preparation of the spin target - - - Specifies the position of the lens by pointing to the last transformation in the - transformation chain in the NXtransformations group. - - - - - Collection of axis-based translations and rotations to describe the location and - geometry of the deflector as a component in the instrument. Conventions from the - NXtransformations base class are used. In principle, the McStas coordinate - system is used. The first transformation has to point either to another - component of the system or . (for pointing to the reference frame) to relate it - relative to the experimental setup. Typically, the components of a system should - all be related relative to each other and only one component should relate to - the reference coordinate system. - - Deflectors in the spin dispersive section diff --git a/contributed_definitions/NXstage_lab.nxdl.xml b/contributed_definitions/NXstage_lab.nxdl.xml index 7b916d2728..dca422c57d 100644 --- a/contributed_definitions/NXstage_lab.nxdl.xml +++ b/contributed_definitions/NXstage_lab.nxdl.xml @@ -21,7 +21,7 @@ # # For further information, see http://www.nexusformat.org --> - + A stage lab can be used to hold, align, orient, and prepare a specimen. @@ -107,18 +107,6 @@ electrical_biasing_chip, liquid_cell_chip - - - Given name/alias for the components making the stage. - - - - - - Ideally, a (globally) unique persistent identifier, link, - or text to a resource which gives further details. - - Should be defined by the application definition. @@ -148,13 +136,6 @@ - - - The rotation, tilt and position of stage components can be specified - either via NXtransformations or via the tilt_1, tilt_2, rotation, - and position fields. - - - + diff --git a/dev_tools/tests/test_nxdl_utils.py b/dev_tools/tests/test_nxdl_utils.py index 2f7e677685..7924d658cd 100644 --- a/dev_tools/tests/test_nxdl_utils.py +++ b/dev_tools/tests/test_nxdl_utils.py @@ -86,13 +86,13 @@ def test_get_inherited_nodes(): (_, _, elist) = nexus.get_inherited_nodes( nxdl_path="/ENTRY/INSTRUMENT/ENVIRONMENT/voltage_controller", elem=elem ) - assert len(elist) == 4 + assert len(elist) == 5 (_, _, elist) = nexus.get_inherited_nodes( nxdl_path="/ENTRY/INSTRUMENT/ENVIRONMENT/voltage_controller", nx_name="NXiv_temp", ) - assert len(elist) == 4 + assert len(elist) == 5 @pytest.mark.parametrize(