From 2aabe16499c8b580d6f758f3d3c06bd433a712e4 Mon Sep 17 00:00:00 2001 From: Tobias Richter Date: Wed, 11 Apr 2018 18:13:10 +0200 Subject: [PATCH 1/6] editorial corrections to NXlog fixes #617 make cue_timestamp_zero a number as intended, not a string allow NX_NUMBER for time, like in NXevent_data clarify what a missing @start means in cue_timestamp_zero --- base_classes/NXlog.nxdl.xml | 47 +++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/base_classes/NXlog.nxdl.xml b/base_classes/NXlog.nxdl.xml index 6af86845b..7fc9d0021 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 + + It 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,19 @@ 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". + Index into the time, value pair matching the corresponding - cue_timestamp. + cue_timestamp. From 44c82a31f484995ade52fe71d9279de71fc61409 Mon Sep 17 00:00:00 2001 From: Tobias Richter Date: Wed, 11 Apr 2018 18:39:42 +0200 Subject: [PATCH 2/6] address more of @prjemians' comments --- base_classes/NXlog.nxdl.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/base_classes/NXlog.nxdl.xml b/base_classes/NXlog.nxdl.xml index 7fc9d0021..f5896bee0 100644 --- a/base_classes/NXlog.nxdl.xml +++ b/base_classes/NXlog.nxdl.xml @@ -43,7 +43,7 @@ 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 @@ -63,7 +63,7 @@ coarser ``cue_timestamp_zero``. - + Time of logged entry. The times are relative to the "start" attribute and in the units specified in the "units" From 77858a57176306efcc04c7591c3dd21622c21140 Mon Sep 17 00:00:00 2001 From: Tobias Richter Date: Wed, 18 Apr 2018 17:21:58 +0200 Subject: [PATCH 3/6] add missing @scaling_factor and missing comma --- base_classes/NXlog.nxdl.xml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/base_classes/NXlog.nxdl.xml b/base_classes/NXlog.nxdl.xml index f5896bee0..5cfe6828e 100644 --- a/base_classes/NXlog.nxdl.xml +++ b/base_classes/NXlog.nxdl.xml @@ -43,7 +43,7 @@ correlated later in data reduction with other data, - In 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 @@ -109,6 +109,9 @@ If missing start is assumed to be the same as for "time". + + If missing start is assumed to be the same as for "time". + From a8a4de6f049d2a66ba8f450603f1685b18dc5b94 Mon Sep 17 00:00:00 2001 From: Tobias Richter Date: Thu, 19 Apr 2018 15:48:30 +0200 Subject: [PATCH 4/6] remove errorneous slash --- base_classes/NXlog.nxdl.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/base_classes/NXlog.nxdl.xml b/base_classes/NXlog.nxdl.xml index 5cfe6828e..5512d71b8 100644 --- a/base_classes/NXlog.nxdl.xml +++ b/base_classes/NXlog.nxdl.xml @@ -108,10 +108,10 @@ If missing start is assumed to be the same as for "time". - - + + If missing start is assumed to be the same as for "time". - + From cd64cf577328985e1d87cbcbd79317bdca9a1d56 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Tue, 24 Apr 2018 09:58:37 -0500 Subject: [PATCH 5/6] URL has changed Thanks @vasole via https://github.com/nexusformat/NIAC/issues/27#issuecomment-383959249 --- base_classes/NXdata.nxdl.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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. From 2298e443e9fd64aaa6337930eb00c4e8939a485d Mon Sep 17 00:00:00 2001 From: Mark Koennecke Date: Thu, 26 Apr 2018 14:47:59 +0200 Subject: [PATCH 6/6] Fixed sequence_number in NXdetector to be NX_INT Refs #620 --- base_classes/NXdetector.nxdl.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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