Skip to content

Commit

Permalink
bring in NXdata from base class branch
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaspie committed Nov 27, 2024
1 parent 87ded74 commit b6269c4
Showing 1 changed file with 26 additions and 29 deletions.
55 changes: 26 additions & 29 deletions base_classes/NXdata.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -309,18 +309,18 @@

</doc>
</attribute>
<attribute name="reference">
<attribute name="target">
<doc>
Points to the path of a field defining the data to which the `DATA` group refers.
Points to the path of a field defining the data to which the `DATA` group refers.

This attribute indicates the origin of the data, thereby providing an association to
further metadata that define the physical quantity that the data represents.

Example:
If the data corresponds to a readout of a detector, ``@reference`` points
If the data corresponds to a readout of a detector, ``@target`` points
to that detectors data:

@reference: '/entry/instrument/detector/data' for a detector
@target: '/entry/instrument/detector/data' for a detector
</doc>
</attribute>
<attribute name="AXISNAME_indices" type="NX_INT" nameType="partial">
Expand Down Expand Up @@ -385,28 +385,28 @@
The :ref:`axes &lt;/NXdata@axes-attribute&gt;` attribute is now preferred.
</doc>
</attribute>
<attribute name="reference">
<attribute name="target">
<doc>
Points to the path of a field defining the axis to which the ``AXISNAME`` axis refers.
Points to the path of a field defining the axis to which the ``AXISNAME`` axis refers.

This attribute indicates the origin of the axis, thereby providing an association to
further metadata that define the physical quantity that the ``AXISNAME`` represents.
This attribute indicates the origin of the axis, thereby providing an association to
further metadata that define the physical quantity that the ``AXISNAME`` represents.

Examples:
If a calibration has been performed, ``@reference`` points to the result of
that calibration:
Examples:
If a calibration has been performed, ``@target`` points to the result of
that calibration:

@reference: '/entry/process/calibration/calibrated_axis'
@target: '/entry/process/calibration/calibrated_axis'

If the axis corresponds to a coordinate of a detector, ``@reference`` points
to that detector axis:
If the axis corresponds to a coordinate of a detector, ``@target`` points
to that detector axis:

@reference: '/entry/instrument/detector/axis/some_axis' for a 2D detector
@target: '/entry/instrument/detector/axis/some_axis' for a 2D detector

If the axis is a scanned motor, ``@reference`` points to the transformation
describing the respective motion, e.g.:
If the axis is a scanned motor, ``@target`` points to the transformation
describing the respective motion, e.g.:

@reference: '/entry/instrument/detector/transformations/some_transformation' for a motion of the detector
@target: '/entry/instrument/detector/transformations/some_transformation' for a motion of the detector
</doc>
</attribute>
</field>
Expand Down Expand Up @@ -452,21 +452,18 @@
<attribute name="long_name">
<doc>data label</doc>
</attribute>
<attribute name="reference">
<attribute name="target">
<doc>
Points to the path of a field defining the data to which the `DATA` field refers.
Points to the path of a field defining the data to which the ``DATA`` field refers.

This attribute indicates the origin of the data, thereby providing an association to
further metadata that define the physical quantity that the ``DATA`` represents.
This attribute indicates the origin of the data, thereby providing an association to
further metadata that define the physical quantity that the ``DATA`` represents.

Here, *DATA* is to be replaced by the name of each
data field.
Example:
If the data corresponds to a readout of a detector, ``@target`` points
to that detectors data:

Example:
If the data corresponds to a readout of a detector, ``@reference`` points
to that detectors data:

@reference: '/entry/instrument/detector/data' for a 2D detector
@target: '/entry/instrument/detector/data' for a 2D detector
</doc>
</attribute>
</field>
Expand Down

0 comments on commit b6269c4

Please sign in to comment.