All Downloads are FREE. Search and download functionalities are using the official Maven repository.

generated.docs.javadoc.org.eclipse.dawnsci.nexus.impl.NXlogImpl.html Maven / Gradle / Ivy






NXlogImpl (h5jan API)












org.eclipse.dawnsci.nexus.impl

Class NXlogImpl

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXlog, NXobject


    public class NXlogImpl
    extends NXobjectImpl
    implements NXlog
    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 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 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``.
    See Also:
    Serialized Form
    • Field Detail

      • PERMITTED_CHILD_GROUP_CLASSES

        public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES
    • Constructor Detail

      • NXlogImpl

        public NXlogImpl()
      • NXlogImpl

        public NXlogImpl(long oid)
    • Method Detail

      • getNXclass

        public java.lang.Class<? extends NXobject> getNXclass()
        Description copied from interface: NXobject
        Java Class object of the interface for this base class, e.g. NXsample.class.
        Specified by:
        getNXclass in interface NXobject
        Returns:
        name of Nexus class
      • getTime

        public IDataset getTime()
        Description copied from interface: NXlog
        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.

        Type: NX_NUMBER Units: NX_TIME

        Specified by:
        getTime in interface NXlog
        Returns:
        the value.
      • getTimeScalar

        public java.lang.Number getTimeScalar()
        Description copied from interface: NXlog
        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.

        Type: NX_NUMBER Units: NX_TIME

        Specified by:
        getTimeScalar in interface NXlog
        Returns:
        the value.
      • setTime

        public DataNode setTime(IDataset time)
        Description copied from interface: NXlog
        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.

        Type: NX_NUMBER Units: NX_TIME

        Specified by:
        setTime in interface NXlog
        Parameters:
        time - the time
      • setTimeScalar

        public DataNode setTimeScalar(java.lang.Number time)
        Description copied from interface: NXlog
        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.

        Type: NX_NUMBER Units: NX_TIME

        Specified by:
        setTimeScalar in interface NXlog
        Parameters:
        time - the time
      • getTimeAttributeStart

        public java.util.Date getTimeAttributeStart()
        Specified by:
        getTimeAttributeStart in interface NXlog
        Returns:
        the value.
      • setTimeAttributeStart

        public void setTimeAttributeStart(java.util.Date start)
        Specified by:
        setTimeAttributeStart in interface NXlog
        Parameters:
        start - the start
      • getTimeAttributeScaling_factor

        public java.lang.Number getTimeAttributeScaling_factor()
        Specified by:
        getTimeAttributeScaling_factor in interface NXlog
        Returns:
        the value.
      • setTimeAttributeScaling_factor

        public void setTimeAttributeScaling_factor(java.lang.Number scaling_factor)
        Specified by:
        setTimeAttributeScaling_factor in interface NXlog
        Parameters:
        scaling_factor - the scaling_factor
      • getValue

        public IDataset getValue()
        Description copied from interface: NXlog
        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].

        Units: NX_ANY Type: NX_NUMBER

        Specified by:
        getValue in interface NXlog
        Returns:
        the value.
      • getValueScalar

        public java.lang.Number getValueScalar()
        Description copied from interface: NXlog
        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].

        Units: NX_ANY Type: NX_NUMBER

        Specified by:
        getValueScalar in interface NXlog
        Returns:
        the value.
      • setValue

        public DataNode setValue(IDataset value)
        Description copied from interface: NXlog
        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].

        Units: NX_ANY Type: NX_NUMBER

        Specified by:
        setValue in interface NXlog
        Parameters:
        value - the value
      • setValueScalar

        public DataNode setValueScalar(java.lang.Number value)
        Description copied from interface: NXlog
        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].

        Units: NX_ANY Type: NX_NUMBER

        Specified by:
        setValueScalar in interface NXlog
        Parameters:
        value - the value
      • getRaw_value

        public IDataset getRaw_value()
        Description copied from interface: NXlog
        Array of raw information, such as thermocouple voltage

        Units: NX_ANY Type: NX_NUMBER

        Specified by:
        getRaw_value in interface NXlog
        Returns:
        the value.
      • getRaw_valueScalar

        public java.lang.Number getRaw_valueScalar()
        Description copied from interface: NXlog
        Array of raw information, such as thermocouple voltage

        Units: NX_ANY Type: NX_NUMBER

        Specified by:
        getRaw_valueScalar in interface NXlog
        Returns:
        the value.
      • setRaw_value

        public DataNode setRaw_value(IDataset raw_value)
        Description copied from interface: NXlog
        Array of raw information, such as thermocouple voltage

        Units: NX_ANY Type: NX_NUMBER

        Specified by:
        setRaw_value in interface NXlog
        Parameters:
        raw_value - the raw_value
      • setRaw_valueScalar

        public DataNode setRaw_valueScalar(java.lang.Number raw_value)
        Description copied from interface: NXlog
        Array of raw information, such as thermocouple voltage

        Units: NX_ANY Type: NX_NUMBER

        Specified by:
        setRaw_valueScalar in interface NXlog
        Parameters:
        raw_value - the raw_value
      • getDescription

        public IDataset getDescription()
        Description copied from interface: NXlog
        Description of logged value
        Specified by:
        getDescription in interface NXlog
        Returns:
        the value.
      • getDescriptionScalar

        public java.lang.String getDescriptionScalar()
        Description copied from interface: NXlog
        Description of logged value
        Specified by:
        getDescriptionScalar in interface NXlog
        Returns:
        the value.
      • setDescription

        public DataNode setDescription(IDataset description)
        Description copied from interface: NXlog
        Description of logged value
        Specified by:
        setDescription in interface NXlog
        Parameters:
        description - the description
      • setDescriptionScalar

        public DataNode setDescriptionScalar(java.lang.String description)
        Description copied from interface: NXlog
        Description of logged value
        Specified by:
        setDescriptionScalar in interface NXlog
        Parameters:
        description - the description
      • getAverage_value

        public IDataset getAverage_value()
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        getAverage_value in interface NXlog
        Returns:
        the value.
      • getAverage_valueScalar

        public java.lang.Double getAverage_valueScalar()
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        getAverage_valueScalar in interface NXlog
        Returns:
        the value.
      • setAverage_value

        public DataNode setAverage_value(IDataset average_value)
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        setAverage_value in interface NXlog
        Parameters:
        average_value - the average_value
      • setAverage_valueScalar

        public DataNode setAverage_valueScalar(java.lang.Double average_value)
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        setAverage_valueScalar in interface NXlog
        Parameters:
        average_value - the average_value
      • getAverage_value_error

        public IDataset getAverage_value_error()
        Description copied from interface: NXlog
        estimated uncertainty (often used: standard deviation) of average_value

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        getAverage_value_error in interface NXlog
        Returns:
        the value.
      • getAverage_value_errorScalar

        public java.lang.Double getAverage_value_errorScalar()
        Description copied from interface: NXlog
        estimated uncertainty (often used: standard deviation) of average_value

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        getAverage_value_errorScalar in interface NXlog
        Returns:
        the value.
      • setAverage_value_error

        public DataNode setAverage_value_error(IDataset average_value_error)
        Description copied from interface: NXlog
        estimated uncertainty (often used: standard deviation) of average_value

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        setAverage_value_error in interface NXlog
        Parameters:
        average_value_error - the average_value_error
      • setAverage_value_errorScalar

        public DataNode setAverage_value_errorScalar(java.lang.Double average_value_error)
        Description copied from interface: NXlog
        estimated uncertainty (often used: standard deviation) of average_value

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        setAverage_value_errorScalar in interface NXlog
        Parameters:
        average_value_error - the average_value_error
      • getMinimum_value

        public IDataset getMinimum_value()
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        getMinimum_value in interface NXlog
        Returns:
        the value.
      • getMinimum_valueScalar

        public java.lang.Double getMinimum_valueScalar()
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        getMinimum_valueScalar in interface NXlog
        Returns:
        the value.
      • setMinimum_value

        public DataNode setMinimum_value(IDataset minimum_value)
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        setMinimum_value in interface NXlog
        Parameters:
        minimum_value - the minimum_value
      • setMinimum_valueScalar

        public DataNode setMinimum_valueScalar(java.lang.Double minimum_value)
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        setMinimum_valueScalar in interface NXlog
        Parameters:
        minimum_value - the minimum_value
      • getMaximum_value

        public IDataset getMaximum_value()
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        getMaximum_value in interface NXlog
        Returns:
        the value.
      • getMaximum_valueScalar

        public java.lang.Double getMaximum_valueScalar()
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        getMaximum_valueScalar in interface NXlog
        Returns:
        the value.
      • setMaximum_value

        public DataNode setMaximum_value(IDataset maximum_value)
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        setMaximum_value in interface NXlog
        Parameters:
        maximum_value - the maximum_value
      • setMaximum_valueScalar

        public DataNode setMaximum_valueScalar(java.lang.Double maximum_value)
        Description copied from interface: NXlog

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        setMaximum_valueScalar in interface NXlog
        Parameters:
        maximum_value - the maximum_value
      • getDuration

        public IDataset getDuration()
        Description copied from interface: NXlog
        Total time log was taken

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        getDuration in interface NXlog
        Returns:
        the value.
      • getDurationScalar

        public java.lang.Double getDurationScalar()
        Description copied from interface: NXlog
        Total time log was taken

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        getDurationScalar in interface NXlog
        Returns:
        the value.
      • setDuration

        public DataNode setDuration(IDataset duration)
        Description copied from interface: NXlog
        Total time log was taken

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        setDuration in interface NXlog
        Parameters:
        duration - the duration
      • setDurationScalar

        public DataNode setDurationScalar(java.lang.Double duration)
        Description copied from interface: NXlog
        Total time log was taken

        Type: NX_FLOAT Units: NX_ANY

        Specified by:
        setDurationScalar in interface NXlog
        Parameters:
        duration - the duration
      • getCue_timestamp_zero

        public IDataset getCue_timestamp_zero()
        Description copied from interface: NXlog
        Timestamps matching the corresponding cue_index into the time, value pair.

        Type: NX_NUMBER Units: NX_TIME

        Specified by:
        getCue_timestamp_zero in interface NXlog
        Returns:
        the value.
      • getCue_timestamp_zeroScalar

        public java.lang.Number getCue_timestamp_zeroScalar()
        Description copied from interface: NXlog
        Timestamps matching the corresponding cue_index into the time, value pair.

        Type: NX_NUMBER Units: NX_TIME

        Specified by:
        getCue_timestamp_zeroScalar in interface NXlog
        Returns:
        the value.
      • setCue_timestamp_zero

        public DataNode setCue_timestamp_zero(IDataset cue_timestamp_zero)
        Description copied from interface: NXlog
        Timestamps matching the corresponding cue_index into the time, value pair.

        Type: NX_NUMBER Units: NX_TIME

        Specified by:
        setCue_timestamp_zero in interface NXlog
        Parameters:
        cue_timestamp_zero - the cue_timestamp_zero
      • setCue_timestamp_zeroScalar

        public DataNode setCue_timestamp_zeroScalar(java.lang.Number cue_timestamp_zero)
        Description copied from interface: NXlog
        Timestamps matching the corresponding cue_index into the time, value pair.

        Type: NX_NUMBER Units: NX_TIME

        Specified by:
        setCue_timestamp_zeroScalar in interface NXlog
        Parameters:
        cue_timestamp_zero - the cue_timestamp_zero
      • getCue_timestamp_zeroAttributeStart

        public java.util.Date getCue_timestamp_zeroAttributeStart()
        Description copied from interface: NXlog
        If missing start is assumed to be the same as for "time".
        Specified by:
        getCue_timestamp_zeroAttributeStart in interface NXlog
        Returns:
        the value.
      • setCue_timestamp_zeroAttributeStart

        public void setCue_timestamp_zeroAttributeStart(java.util.Date start)
        Description copied from interface: NXlog
        If missing start is assumed to be the same as for "time".
        Specified by:
        setCue_timestamp_zeroAttributeStart in interface NXlog
        Parameters:
        start - the start
      • getCue_timestamp_zeroAttributeScaling_factor

        public java.lang.Number getCue_timestamp_zeroAttributeScaling_factor()
        Description copied from interface: NXlog
        If missing start is assumed to be the same as for "time".
        Specified by:
        getCue_timestamp_zeroAttributeScaling_factor in interface NXlog
        Returns:
        the value.
      • setCue_timestamp_zeroAttributeScaling_factor

        public void setCue_timestamp_zeroAttributeScaling_factor(java.lang.Number scaling_factor)
        Description copied from interface: NXlog
        If missing start is assumed to be the same as for "time".
        Specified by:
        setCue_timestamp_zeroAttributeScaling_factor in interface NXlog
        Parameters:
        scaling_factor - the scaling_factor
      • getCue_index

        public IDataset getCue_index()
        Description copied from interface: NXlog
        Index into the time, value pair matching the corresponding cue_timestamp.

        Type: NX_INT

        Specified by:
        getCue_index in interface NXlog
        Returns:
        the value.
      • getCue_indexScalar

        public java.lang.Long getCue_indexScalar()
        Description copied from interface: NXlog
        Index into the time, value pair matching the corresponding cue_timestamp.

        Type: NX_INT

        Specified by:
        getCue_indexScalar in interface NXlog
        Returns:
        the value.
      • setCue_index

        public DataNode setCue_index(IDataset cue_index)
        Description copied from interface: NXlog
        Index into the time, value pair matching the corresponding cue_timestamp.

        Type: NX_INT

        Specified by:
        setCue_index in interface NXlog
        Parameters:
        cue_index - the cue_index
      • setCue_indexScalar

        public DataNode setCue_indexScalar(java.lang.Long cue_index)
        Description copied from interface: NXlog
        Index into the time, value pair matching the corresponding cue_timestamp.

        Type: NX_INT

        Specified by:
        setCue_indexScalar in interface NXlog
        Parameters:
        cue_index - the cue_index




© 2015 - 2024 Weber Informatics LLC | Privacy Policy