diff --git a/base_classes/NXdata.nxdl.xml b/base_classes/NXdata.nxdl.xml index 42c49d63a..89c9d8b9a 100644 --- a/base_classes/NXdata.nxdl.xml +++ b/base_classes/NXdata.nxdl.xml @@ -66,7 +66,7 @@ - + .. index:: plotting @@ -93,7 +93,7 @@ while the other two dimensions have no fields to be used as dimension scales. See examples provided on the NeXus wiki: - http://wiki.nexusformat.org/2014_axes_and_uncertainties + http://www.nexusformat.org/2014_axes_and_uncertainties If there are no axes at all (such as with a stack of images), the axes attribute can be omitted. diff --git a/base_classes/NXdetector.nxdl.xml b/base_classes/NXdetector.nxdl.xml index d7851bb38..ebd396bc9 100644 --- a/base_classes/NXdetector.nxdl.xml +++ b/base_classes/NXdetector.nxdl.xml @@ -492,7 +492,7 @@ - + In order to properly sort the order of the images taken in (for example) a tomography experiment, a sequence number is stored with each diff --git a/base_classes/NXlog.nxdl.xml b/base_classes/NXlog.nxdl.xml index 6af86845b..5512d71b8 100644 --- a/base_classes/NXlog.nxdl.xml +++ b/base_classes/NXlog.nxdl.xml @@ -2,9 +2,9 @@ Information recorded as a function of time. - + Description of information that is recorded against time. There are two common use cases for this: - When logging data such as temperature during a run - When data is taken in streaming mode data acquisition, i.e. just timestamp, value pairs are stored and - correlated later in data reduction with other data, + correlated later in data reduction with other data, - - It both cases NXlog contains + + In both cases, NXlog contains the logged or streamed values and the times at which they were measured as elapsed time since a starting time recorded in ISO8601 format. The time units are specified in the units attribute. An optional scaling attribute - can be used to accomodate non standard clocks. + can be used to accomodate non standard clocks. + - This method of storing logged data helps to distinguish instances in which a variable is a dimension scale of the data, in which case it is stored - in an :ref:`NXdata` group, and instances in which it is logged during the + in an :ref:`NXdata` group, and instances in which it is logged during the run, when it should be stored in an :ref:`NXlog` group. In order to make random access to timestamped data faster there is an optional array pair of @@ -60,19 +60,19 @@ contain coarser timestamps than in the time array, say every five minutes. The ``cue_index`` will then contain the index into the time,value pair of arrays for that - coarser ``cue_timestamp_zero``. + coarser ``cue_timestamp_zero``. - + - Time of logged entry. The times are relative to the "start" attribute + Time of logged entry. The times are relative to the "start" attribute and in the units specified in the "units" attribute. Please note that absolute timestamps under unix are relative to ``1970-01-01T:00:00``. - The scaling_factor, when present, has to be applied to the time values in order - to arrive at the units specified in the units attribute. The scaling_factor allows - for arbitrary time units such as ticks of some hardware clock. + The scaling_factor, when present, has to be applied to the time values in order + to arrive at the units specified in the units attribute. The scaling_factor allows + for arbitrary time units such as ticks of some hardware clock. @@ -83,7 +83,7 @@ a single value the dimensionality is nEntries. However, NXlog can also be used to store multi dimensional time stamped data such as images. In - this example the dimensionality of values would be value[nEntries,xdim,ydim]. + this example the dimensionality of values would be value[nEntries,xdim,ydim]. @@ -101,18 +101,22 @@ Total time log was taken - + Timestamps matching the corresponding cue_index into the time, value pair. - + + If missing start is assumed to be the same as for "time". + + + If missing start is assumed to be the same as for "time". + Index into the time, value pair matching the corresponding - cue_timestamp. + cue_timestamp.