• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXlog.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.nexus
Interface NXlog






All Superinterfaces:
GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject


All Known Implementing Classes:
NXlogImpl




public interface NXlog
extends NXobject
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``.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_AVERAGE_VALUE 


static java.lang.String
NX_AVERAGE_VALUE_ERROR 


static java.lang.String
NX_CUE_INDEX 


static java.lang.String
NX_CUE_TIMESTAMP_ZERO 


static java.lang.String
NX_CUE_TIMESTAMP_ZERO_ATTRIBUTE_SCALING_FACTOR 


static java.lang.String
NX_CUE_TIMESTAMP_ZERO_ATTRIBUTE_START 


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_DURATION 


static java.lang.String
NX_MAXIMUM_VALUE 


static java.lang.String
NX_MINIMUM_VALUE 


static java.lang.String
NX_RAW_VALUE 


static java.lang.String
NX_TIME 


static java.lang.String
NX_TIME_ATTRIBUTE_SCALING_FACTOR 


static java.lang.String
NX_TIME_ATTRIBUTE_START 


static java.lang.String
NX_VALUE 






Fields inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
ATTRIBUTE, SEPARATOR








Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


IDataset
getAverage_value_error()
estimated uncertainty (often used: standard deviation) of average_value



java.lang.Double
getAverage_value_errorScalar()
estimated uncertainty (often used: standard deviation) of average_value



IDataset
getAverage_value()

 Type: NX_FLOAT
 Units: NX_ANY



java.lang.Double
getAverage_valueScalar()

 Type: NX_FLOAT
 Units: NX_ANY



IDataset
getCue_index()
Index into the time, value pair matching the corresponding
 cue_timestamp.



java.lang.Long
getCue_indexScalar()
Index into the time, value pair matching the corresponding
 cue_timestamp.



IDataset
getCue_timestamp_zero()
Timestamps matching the corresponding cue_index into the
 time, value pair.



java.lang.Number
getCue_timestamp_zeroAttributeScaling_factor()
If missing start is assumed to be the same as for "time".



java.util.Date
getCue_timestamp_zeroAttributeStart()
If missing start is assumed to be the same as for "time".



java.lang.Number
getCue_timestamp_zeroScalar()
Timestamps matching the corresponding cue_index into the
 time, value pair.



IDataset
getDescription()
Description of logged value



java.lang.String
getDescriptionScalar()
Description of logged value



IDataset
getDuration()
Total time log was taken



java.lang.Double
getDurationScalar()
Total time log was taken



IDataset
getMaximum_value()

 Type: NX_FLOAT
 Units: NX_ANY



java.lang.Double
getMaximum_valueScalar()

 Type: NX_FLOAT
 Units: NX_ANY



IDataset
getMinimum_value()

 Type: NX_FLOAT
 Units: NX_ANY



java.lang.Double
getMinimum_valueScalar()

 Type: NX_FLOAT
 Units: NX_ANY



IDataset
getRaw_value()
Array of raw information, such as thermocouple voltage



java.lang.Number
getRaw_valueScalar()
Array of raw information, such as thermocouple voltage



IDataset
getTime()
Time of logged entry.



java.lang.Number
getTimeAttributeScaling_factor() 


java.util.Date
getTimeAttributeStart() 


java.lang.Number
getTimeScalar()
Time of logged entry.



IDataset
getValue()
Array of logged value, such as temperature.



java.lang.Number
getValueScalar()
Array of logged value, such as temperature.



DataNode
setAverage_value_error(IDataset average_value_error)
estimated uncertainty (often used: standard deviation) of average_value



DataNode
setAverage_value_errorScalar(java.lang.Double average_value_error)
estimated uncertainty (often used: standard deviation) of average_value



DataNode
setAverage_value(IDataset average_value)

 Type: NX_FLOAT
 Units: NX_ANY



DataNode
setAverage_valueScalar(java.lang.Double average_value)

 Type: NX_FLOAT
 Units: NX_ANY



DataNode
setCue_index(IDataset cue_index)
Index into the time, value pair matching the corresponding
 cue_timestamp.



DataNode
setCue_indexScalar(java.lang.Long cue_index)
Index into the time, value pair matching the corresponding
 cue_timestamp.



DataNode
setCue_timestamp_zero(IDataset cue_timestamp_zero)
Timestamps matching the corresponding cue_index into the
 time, value pair.



void
setCue_timestamp_zeroAttributeScaling_factor(java.lang.Number scaling_factor)
If missing start is assumed to be the same as for "time".



void
setCue_timestamp_zeroAttributeStart(java.util.Date start)
If missing start is assumed to be the same as for "time".



DataNode
setCue_timestamp_zeroScalar(java.lang.Number cue_timestamp_zero)
Timestamps matching the corresponding cue_index into the
 time, value pair.



DataNode
setDescription(IDataset description)
Description of logged value



DataNode
setDescriptionScalar(java.lang.String description)
Description of logged value



DataNode
setDuration(IDataset duration)
Total time log was taken



DataNode
setDurationScalar(java.lang.Double duration)
Total time log was taken



DataNode
setMaximum_value(IDataset maximum_value)

 Type: NX_FLOAT
 Units: NX_ANY



DataNode
setMaximum_valueScalar(java.lang.Double maximum_value)

 Type: NX_FLOAT
 Units: NX_ANY



DataNode
setMinimum_value(IDataset minimum_value)

 Type: NX_FLOAT
 Units: NX_ANY



DataNode
setMinimum_valueScalar(java.lang.Double minimum_value)

 Type: NX_FLOAT
 Units: NX_ANY



DataNode
setRaw_value(IDataset raw_value)
Array of raw information, such as thermocouple voltage



DataNode
setRaw_valueScalar(java.lang.Number raw_value)
Array of raw information, such as thermocouple voltage



DataNode
setTime(IDataset time)
Time of logged entry.



void
setTimeAttributeScaling_factor(java.lang.Number scaling_factor) 


void
setTimeAttributeStart(java.util.Date start) 


DataNode
setTimeScalar(java.lang.Number time)
Time of logged entry.



DataNode
setValue(IDataset value)
Array of logged value, such as temperature.



DataNode
setValueScalar(java.lang.Number value)
Array of logged value, such as temperature.







Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNexusBaseClass, getNumber, getNXclass, getPermittedChildGroupClasses, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setField





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode





Methods inherited from interface java.lang.Iterable
forEach, spliterator














Field Detail





NX_TIME
static final java.lang.String NX_TIME

See Also:
Constant Field Values








NX_TIME_ATTRIBUTE_START
static final java.lang.String NX_TIME_ATTRIBUTE_START

See Also:
Constant Field Values








NX_TIME_ATTRIBUTE_SCALING_FACTOR
static final java.lang.String NX_TIME_ATTRIBUTE_SCALING_FACTOR

See Also:
Constant Field Values








NX_VALUE
static final java.lang.String NX_VALUE

See Also:
Constant Field Values








NX_RAW_VALUE
static final java.lang.String NX_RAW_VALUE

See Also:
Constant Field Values








NX_DESCRIPTION
static final java.lang.String NX_DESCRIPTION

See Also:
Constant Field Values








NX_AVERAGE_VALUE
static final java.lang.String NX_AVERAGE_VALUE

See Also:
Constant Field Values








NX_AVERAGE_VALUE_ERROR
static final java.lang.String NX_AVERAGE_VALUE_ERROR

See Also:
Constant Field Values








NX_MINIMUM_VALUE
static final java.lang.String NX_MINIMUM_VALUE

See Also:
Constant Field Values








NX_MAXIMUM_VALUE
static final java.lang.String NX_MAXIMUM_VALUE

See Also:
Constant Field Values








NX_DURATION
static final java.lang.String NX_DURATION

See Also:
Constant Field Values








NX_CUE_TIMESTAMP_ZERO
static final java.lang.String NX_CUE_TIMESTAMP_ZERO

See Also:
Constant Field Values








NX_CUE_TIMESTAMP_ZERO_ATTRIBUTE_START
static final java.lang.String NX_CUE_TIMESTAMP_ZERO_ATTRIBUTE_START

See Also:
Constant Field Values








NX_CUE_TIMESTAMP_ZERO_ATTRIBUTE_SCALING_FACTOR
static final java.lang.String NX_CUE_TIMESTAMP_ZERO_ATTRIBUTE_SCALING_FACTOR

See Also:
Constant Field Values








NX_CUE_INDEX
static final java.lang.String NX_CUE_INDEX

See Also:
Constant Field Values










Method Detail





getTime
IDataset getTime()
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
 

Returns:
the value.








setTime
DataNode setTime(IDataset time)
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
 

Parameters:
time - the time








getTimeScalar
java.lang.Number getTimeScalar()
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
 

Returns:
the value.








setTimeScalar
DataNode setTimeScalar(java.lang.Number time)
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
 

Parameters:
time - the time








getTimeAttributeStart
java.util.Date getTimeAttributeStart()

Returns:
the value.








setTimeAttributeStart
void setTimeAttributeStart(java.util.Date start)

Parameters:
start - the start








getTimeAttributeScaling_factor
java.lang.Number getTimeAttributeScaling_factor()

Returns:
the value.








setTimeAttributeScaling_factor
void setTimeAttributeScaling_factor(java.lang.Number scaling_factor)

Parameters:
scaling_factor - the scaling_factor








getValue
IDataset getValue()
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
 

Returns:
the value.








setValue
DataNode setValue(IDataset value)
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
 

Parameters:
value - the value








getValueScalar
java.lang.Number getValueScalar()
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
 

Returns:
the value.








setValueScalar
DataNode setValueScalar(java.lang.Number value)
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
 

Parameters:
value - the value








getRaw_value
IDataset getRaw_value()
Array of raw information, such as thermocouple voltage
 

 Units: NX_ANY
 Type: NX_NUMBER
 

Returns:
the value.








setRaw_value
DataNode setRaw_value(IDataset raw_value)
Array of raw information, such as thermocouple voltage
 

 Units: NX_ANY
 Type: NX_NUMBER
 

Parameters:
raw_value - the raw_value








getRaw_valueScalar
java.lang.Number getRaw_valueScalar()
Array of raw information, such as thermocouple voltage
 

 Units: NX_ANY
 Type: NX_NUMBER
 

Returns:
the value.








setRaw_valueScalar
DataNode setRaw_valueScalar(java.lang.Number raw_value)
Array of raw information, such as thermocouple voltage
 

 Units: NX_ANY
 Type: NX_NUMBER
 

Parameters:
raw_value - the raw_value








getDescription
IDataset getDescription()
Description of logged value

Returns:
the value.








setDescription
DataNode setDescription(IDataset description)
Description of logged value

Parameters:
description - the description








getDescriptionScalar
java.lang.String getDescriptionScalar()
Description of logged value

Returns:
the value.








setDescriptionScalar
DataNode setDescriptionScalar(java.lang.String description)
Description of logged value

Parameters:
description - the description








getAverage_value
IDataset getAverage_value()

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setAverage_value
DataNode setAverage_value(IDataset average_value)

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
average_value - the average_value








getAverage_valueScalar
java.lang.Double getAverage_valueScalar()

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setAverage_valueScalar
DataNode setAverage_valueScalar(java.lang.Double average_value)

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
average_value - the average_value








getAverage_value_error
IDataset getAverage_value_error()
estimated uncertainty (often used: standard deviation) of average_value
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setAverage_value_error
DataNode setAverage_value_error(IDataset average_value_error)
estimated uncertainty (often used: standard deviation) of average_value
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
average_value_error - the average_value_error








getAverage_value_errorScalar
java.lang.Double getAverage_value_errorScalar()
estimated uncertainty (often used: standard deviation) of average_value
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setAverage_value_errorScalar
DataNode setAverage_value_errorScalar(java.lang.Double average_value_error)
estimated uncertainty (often used: standard deviation) of average_value
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
average_value_error - the average_value_error








getMinimum_value
IDataset getMinimum_value()

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setMinimum_value
DataNode setMinimum_value(IDataset minimum_value)

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
minimum_value - the minimum_value








getMinimum_valueScalar
java.lang.Double getMinimum_valueScalar()

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setMinimum_valueScalar
DataNode setMinimum_valueScalar(java.lang.Double minimum_value)

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
minimum_value - the minimum_value








getMaximum_value
IDataset getMaximum_value()

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setMaximum_value
DataNode setMaximum_value(IDataset maximum_value)

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
maximum_value - the maximum_value








getMaximum_valueScalar
java.lang.Double getMaximum_valueScalar()

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setMaximum_valueScalar
DataNode setMaximum_valueScalar(java.lang.Double maximum_value)

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
maximum_value - the maximum_value








getDuration
IDataset getDuration()
Total time log was taken
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setDuration
DataNode setDuration(IDataset duration)
Total time log was taken
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
duration - the duration








getDurationScalar
java.lang.Double getDurationScalar()
Total time log was taken
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setDurationScalar
DataNode setDurationScalar(java.lang.Double duration)
Total time log was taken
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
duration - the duration








getCue_timestamp_zero
IDataset getCue_timestamp_zero()
Timestamps matching the corresponding cue_index into the
 time, value pair.
 

 Type: NX_NUMBER
 Units: NX_TIME
 

Returns:
the value.








setCue_timestamp_zero
DataNode setCue_timestamp_zero(IDataset cue_timestamp_zero)
Timestamps matching the corresponding cue_index into the
 time, value pair.
 

 Type: NX_NUMBER
 Units: NX_TIME
 

Parameters:
cue_timestamp_zero - the cue_timestamp_zero








getCue_timestamp_zeroScalar
java.lang.Number getCue_timestamp_zeroScalar()
Timestamps matching the corresponding cue_index into the
 time, value pair.
 

 Type: NX_NUMBER
 Units: NX_TIME
 

Returns:
the value.








setCue_timestamp_zeroScalar
DataNode setCue_timestamp_zeroScalar(java.lang.Number cue_timestamp_zero)
Timestamps matching the corresponding cue_index into the
 time, value pair.
 

 Type: NX_NUMBER
 Units: NX_TIME
 

Parameters:
cue_timestamp_zero - the cue_timestamp_zero








getCue_timestamp_zeroAttributeStart
java.util.Date getCue_timestamp_zeroAttributeStart()
If missing start is assumed to be the same as for "time".

Returns:
the value.








setCue_timestamp_zeroAttributeStart
void setCue_timestamp_zeroAttributeStart(java.util.Date start)
If missing start is assumed to be the same as for "time".

Parameters:
start - the start








getCue_timestamp_zeroAttributeScaling_factor
java.lang.Number getCue_timestamp_zeroAttributeScaling_factor()
If missing start is assumed to be the same as for "time".

Returns:
the value.








setCue_timestamp_zeroAttributeScaling_factor
void setCue_timestamp_zeroAttributeScaling_factor(java.lang.Number scaling_factor)
If missing start is assumed to be the same as for "time".

Parameters:
scaling_factor - the scaling_factor








getCue_index
IDataset getCue_index()
Index into the time, value pair matching the corresponding
 cue_timestamp.
 

 Type: NX_INT
 

Returns:
the value.








setCue_index
DataNode setCue_index(IDataset cue_index)
Index into the time, value pair matching the corresponding
 cue_timestamp.
 

 Type: NX_INT
 

Parameters:
cue_index - the cue_index








getCue_indexScalar
java.lang.Long getCue_indexScalar()
Index into the time, value pair matching the corresponding
 cue_timestamp.
 

 Type: NX_INT
 

Returns:
the value.








setCue_indexScalar
DataNode setCue_indexScalar(java.lang.Long cue_index)
Index into the time, value pair matching the corresponding
 cue_timestamp.
 

 Type: NX_INT
 

Parameters:
cue_index - the cue_index














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method