.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXlog.nxdl.xml -- DO NOT EDIT .. index:: ! NXlog (base class) ! log (base class) see: log (base class); NXlog .. _NXlog: ===== NXlog ===== .. Contributors List .. |contrib_name| replace:: Woutdenolf|woutdenolf|https://avatars.githubusercontent.com/u/7264703?v=4|2023-06-16 .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2020-10-20 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-09-07 .. |contrib_name| replace:: Mark Koennecke|mkoennecke|https://avatars.githubusercontent.com/u/5029850?v=4|2018-02-02 **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: Information recorded as a function of time. ... 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, 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. This method of storing logged data helps to distinguish instances in which a variable contains signal or axis coordinate values of plottable data, in which case it is stored 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 ``cue_timestamp_zero`` and ``cue_index``. The ``cue_timestamp_zero`` will 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``. **Symbols**: No symbol table **Groups cited**: none **Structure**: .. _/NXlog@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. collapse:: Declares which child group contains a path leading ... .. 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. .. _/NXlog/time-field: .. index:: time (field) **time**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_TIME `} .. collapse:: 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-01T00:00:00.0Z``. 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. .. _/NXlog/time@start-attribute: .. index:: start (field attribute) **@start**: (optional) :ref:`NX_DATE_TIME ` .. _/NXlog/time@scaling_factor-attribute: .. index:: scaling_factor (field attribute) **@scaling_factor**: (optional) :ref:`NX_NUMBER ` .. _/NXlog/value-field: .. index:: value (field) **value**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} .. collapse:: Array of logged value, such as temperature. If this is ... Array of logged value, such as temperature. If this is 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]. .. _/NXlog/raw_value-field: .. index:: raw_value (field) **raw_value**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} Array of raw information, such as thermocouple voltage .. _/NXlog/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` Description of logged value .. _/NXlog/average_value-field: .. index:: average_value (field) **average_value**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} .. _/NXlog/average_value_error-field: .. index:: average_value_error (field) **average_value_error**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} .. index:: deprecated **DEPRECATED**: see: https://github.com/nexusformat/definitions/issues/639 estimated uncertainty (often used: standard deviation) of average_value .. _/NXlog/average_value_errors-field: .. index:: average_value_errors (field) **average_value_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} estimated uncertainty (often used: standard deviation) of average_value .. _/NXlog/minimum_value-field: .. index:: minimum_value (field) **minimum_value**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} .. _/NXlog/maximum_value-field: .. index:: maximum_value (field) **maximum_value**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} .. _/NXlog/duration-field: .. index:: duration (field) **duration**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} Total time log was taken .. _/NXlog/cue_timestamp_zero-field: .. index:: cue_timestamp_zero (field) **cue_timestamp_zero**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_TIME `} .. collapse:: Timestamps matching the corresponding cue_index into the ... Timestamps matching the corresponding cue_index into the time, value pair. .. _/NXlog/cue_timestamp_zero@start-attribute: .. index:: start (field attribute) **@start**: (optional) :ref:`NX_DATE_TIME ` If missing start is assumed to be the same as for "time". .. _/NXlog/cue_timestamp_zero@scaling_factor-attribute: .. index:: scaling_factor (field attribute) **@scaling_factor**: (optional) :ref:`NX_NUMBER ` If missing start is assumed to be the same as for "time". .. _/NXlog/cue_index-field: .. index:: cue_index (field) **cue_index**: (optional) :ref:`NX_INT ` .. collapse:: Index into the time, value pair matching the corresponding ... Index into the time, value pair matching the corresponding cue_timestamp_zero. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXlog/average_value-field ` * :ref:`/NXlog/average_value_error-field ` * :ref:`/NXlog/average_value_errors-field ` * :ref:`/NXlog/cue_index-field ` * :ref:`/NXlog/cue_timestamp_zero-field ` * :ref:`/NXlog/cue_timestamp_zero@scaling_factor-attribute ` * :ref:`/NXlog/cue_timestamp_zero@start-attribute ` * :ref:`/NXlog/description-field ` * :ref:`/NXlog/duration-field ` * :ref:`/NXlog/maximum_value-field ` * :ref:`/NXlog/minimum_value-field ` * :ref:`/NXlog/raw_value-field ` * :ref:`/NXlog/time-field ` * :ref:`/NXlog/time@scaling_factor-attribute ` * :ref:`/NXlog/time@start-attribute ` * :ref:`/NXlog/value-field ` * :ref:`/NXlog@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXlog.nxdl.xml