Skip to content

Commit

Permalink
refs #443: changed signal/axes/_indices in base class NXDL
Browse files Browse the repository at this point in the history
  • Loading branch information
prjemian committed Feb 13, 2016
1 parent 2fbf413 commit cca3862
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 51 deletions.
19 changes: 10 additions & 9 deletions base_classes/NXdata.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,9 @@
the group ``signal`` attribute, such as::

data:NXdata
@signal="counts"
@axes="mr"
@signal = "counts"
@axes = "mr"
@mr_indices = 0
counts: float[100] --> the default dependent data
mr: float[100] --> the default independent data

Expand Down Expand Up @@ -170,7 +171,7 @@

data_2d:NXdata
@signal="data"
@axes="time","pressure"
@axes=["time","pressure"]
@pressure_indices=1
@temperature_indices=1
@time_indices=0
Expand Down Expand Up @@ -216,7 +217,7 @@
``1|true``: multiple values
</doc>
</attribute>
<attribute name="first_good" type="NX_INT"><doc>Index of first good value</doc></attribute>
<attribute name="first_good" type="NX_INT"><doc>Index of first good value</doc></attribute>
<attribute name="last_good" type="NX_INT"><doc>Index of last good value</doc></attribute>
<attribute name="axis" type="NX_POSINT"
deprecated="Use the group ``axes`` attribute (NIAC2014)">
Expand Down Expand Up @@ -264,13 +265,13 @@
</doc>
<dim index="0" value="n"><!-- index="0": cannot know to which dimension this applies a priori --></dim>
</dimensions>
<attribute name="signal" type="NX_POSINT"
<attribute name="signal" type="NX_POSINT"
deprecated="Use the group ``signal`` attribute (NIAC2014)">
<doc>
.. index:: plotting

Plottable (independent) axis, indicate index number.
Only one field in a :ref:`NXdata` group may have the
Only one field in a :ref:`NXdata` group may have the
``signal=1`` attribute.
Do not use the ``signal`` attribute with the ``axis`` attribute.
</doc>
Expand All @@ -281,8 +282,8 @@
Defines the names of the dimension scales
(independent axes) for this data set
as a colon-delimited array.
NOTE: The ``axes`` attribute is the preferred
method of designating a link.
NOTE: The ``axes`` attribute is the preferred
method of designating a link.
Do not use the ``axes`` attribute with the ``axis`` attribute.
</doc>
</attribute>
Expand Down
10 changes: 0 additions & 10 deletions base_classes/NXdetector.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -98,16 +98,6 @@
<dim index="4" value="tof" />
</dimensions>

<attribute name="signal" type="NX_POSINT">
<enumeration>
<item value="1"/>
</enumeration>
</attribute>

<attribute name="axes">
<doc>``[number of scan points,x_offset?,y_offset?,time_of_flight?]``</doc>
</attribute>

<attribute name="long_name">
<doc>Title of measurement</doc>
</attribute>
Expand Down
20 changes: 0 additions & 20 deletions base_classes/NXguide.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -82,26 +82,6 @@
<dim index="1" value="nsurf"/>
<dim index="2" value="nwl"/>
</dimensions>
<attribute name="signal" type="NX_POSINT">
<doc>
.. index:: plotting

Use ``signal=1`` to indicate that this
is the plottable data for NeXus.
</doc>
<enumeration>
<item value="1"/>
</enumeration>
</attribute>
<attribute name="axes">
<doc>
Use ``axes="surface:wavelength"`` to indicate the
dimension scales to be used when plotting this data.
</doc>
<enumeration>
<item value="surface:wavelength"/>
</enumeration>
</attribute>
</field>
<field name="surface" type="NX_NUMBER" units="NX_ANY">
<doc>
Expand Down
14 changes: 2 additions & 12 deletions base_classes/NXmonitor.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -87,16 +87,8 @@
</field>
<field name="data" type="NX_NUMBER" units="NX_ANY">
<doc>
Monitor data

The signal and axes attributes take the same definitions as in :ref:`NXdata`:

:signal:
``signal=1`` means this is the plottable data
:axes:
``axes="names"`` where names are defined as a colon-delimited string
within this attribute in the C-order of the data array
</doc>
Monitor data
</doc>
<dimensions rank="dataRank">
<doc>
The rank (``dataRank``) of the ``data`` must satisfy
Expand All @@ -105,8 +97,6 @@
</doc>
<dim index="0" value="n"><!-- index="0": cannot know to which dimension this applies a priori --></dim>
</dimensions>
<attribute name="signal" type="NX_POSINT"><doc>as defined for NXdata</doc></attribute>
<attribute name="axes"><doc>as defined for NXdata</doc></attribute>
</field>
<field name="sampled_fraction" type="NX_FLOAT" units="NX_DIMENSIONLESS">
<doc>Proportion of incident beam sampled by the monitor (0&lt;x&lt;1)</doc>
Expand Down

0 comments on commit cca3862

Please sign in to comment.