• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXdata.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.NXdata.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 NXdata






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


All Known Implementing Classes:
NXdataImpl




public interface NXdata
extends NXobject
:ref:`NXdata` describes the plottable data and related dimension scales.
 .. index:: plotting
 It is mandatory that there is at least one :ref:`NXdata` group
 in each :ref:`NXentry` group.
 Note that the ``variable`` and ``data``
 can be defined with different names.
 The ``signal`` and ``axes`` attributes of the
 ``data`` group define which items
 are plottable data and which are *dimension scales*, respectively.
 :ref:`NXdata` is used to implement one of the basic motivations in NeXus,
 to provide a default plot for the data of this :ref:`NXentry`. The actual data
 might be stored in another group and (hard) linked to the :ref:`NXdata` group.
 * Each :ref:`NXdata` group will define only one data set
 containing plottable data, dimension scales, and
 possibly associated standard deviations.
 Other data sets may be present in the group.
 * The plottable data may be of arbitrary rank up to a maximum
 of ``NX_MAXRANK=32``.
 * The plottable data will be named as the value of
 the group ``signal`` attribute, such as::
 data:NXdata











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_ATTRIBUTE_AXES 


static java.lang.String
NX_ATTRIBUTE_AXISNAME_INDICES 


static java.lang.String
NX_ATTRIBUTE_SIGNAL 


static java.lang.String
NX_DATA 


static java.lang.String
NX_DATA_ATTRIBUTE_AXES 


static java.lang.String
NX_DATA_ATTRIBUTE_LONG_NAME 


static java.lang.String
NX_DATA_ATTRIBUTE_SIGNAL 


static java.lang.String
NX_DATA_ATTRIBUTE_UNCERTAINTIES 


static java.lang.String
NX_ERRORS 


static java.lang.String
NX_OFFSET 


static java.lang.String
NX_SCALING_FACTOR 


static java.lang.String
NX_VARIABLE 


static java.lang.String
NX_VARIABLE_ATTRIBUTE_AXIS 


static java.lang.String
NX_VARIABLE_ATTRIBUTE_DISTRIBUTION 


static java.lang.String
NX_VARIABLE_ATTRIBUTE_FIRST_GOOD 


static java.lang.String
NX_VARIABLE_ATTRIBUTE_LAST_GOOD 


static java.lang.String
NX_VARIABLE_ATTRIBUTE_LONG_NAME 


static java.lang.String
NX_VARIABLE_ERRORS 


static java.lang.String
NX_X 


static java.lang.String
NX_Y 


static java.lang.String
NX_Z 






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








Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,? extends IDataset>
getAllData()
Get all Data fields:

 ..



java.util.Map<java.lang.String,? extends IDataset>
getAllVARIABLE_errors()
Get all VARIABLE_errors fields:

 Errors (uncertainties) associated with axis ``VARIABLE``.



java.util.Map<java.lang.String,? extends IDataset>
getAllVARIABLE()
Get all VARIABLE fields:

 Dimension scale defining an axis of the data.



java.lang.String
getAttributeAxes()
..



java.lang.String
getAttributeAXISNAME_indices()
Each ``AXISNAME_indices`` attribute indicates the dependency
 relationship of the ``AXISNAME`` field (where ``AXISNAME``
 is the name of a field that exists in this ``NXdata`` group)
 with one or more dimensions of the plottable data.



java.lang.String
getAttributeSignal()
..



IDataset
getData()
..



java.lang.String
getDataAttributeAxes()
Deprecated. 
Use the group ``axes`` attribute   (NIAC2014)




java.lang.String
getDataAttributeLong_name()
data label



java.lang.Long
getDataAttributeSignal()
Deprecated. 
Use the group ``signal`` attribute   (NIAC2014)




java.lang.String
getDataAttributeUncertainties()
Specify the name (or names) of the uncertainties (errors)
 of the dependent axes as plottable data.



java.lang.Number
getDataScalar()
..



IDataset
getErrors()
Standard deviations of data values -
 the data array is identified by the group attribute ``signal``.



java.lang.Number
getErrorsScalar()
Standard deviations of data values -
 the data array is identified by the group attribute ``signal``.



IDataset
getOffset()
An optional offset to apply to the values in data.



java.lang.Double
getOffsetScalar()
An optional offset to apply to the values in data.



IDataset
getScaling_factor()
The elements in data are usually float values really.



java.lang.Double
getScaling_factorScalar()
The elements in data are usually float values really.



IDataset
getVARIABLE_errors()
Errors (uncertainties) associated with axis ``VARIABLE``.



java.lang.Number
getVARIABLE_errorsScalar()
Errors (uncertainties) associated with axis ``VARIABLE``.



IDataset
getVARIABLE()
Dimension scale defining an axis of the data.



java.lang.Long
getVARIABLEAttributeAxis()
Deprecated. 
Use the group ``axes`` attribute   (NIAC2014)




java.lang.Boolean
getVARIABLEAttributeDistribution()
``0|false``: single value,
 ``1|true``: multiple values



java.lang.Long
getVARIABLEAttributeFirst_good()
Index of first good value



java.lang.Long
getVARIABLEAttributeLast_good()
Index of last good value



java.lang.String
getVARIABLEAttributeLong_name()
Axis label



java.lang.Number
getVARIABLEScalar()
Dimension scale defining an axis of the data.



IDataset
getX()
This is an array holding the values to use for the x-axis of
 data.



java.lang.Double
getXScalar()
This is an array holding the values to use for the x-axis of
 data.



IDataset
getY()
This is an array holding the values to use for the y-axis of
 data.



java.lang.Double
getYScalar()
This is an array holding the values to use for the y-axis of
 data.



IDataset
getZ()
This is an array holding the values to use for the z-axis of
 data.



java.lang.Double
getZScalar()
This is an array holding the values to use for the z-axis of
 data.



void
setAttributeAxes(java.lang.String axes)
..



void
setAttributeAXISNAME_indices(java.lang.String AXISNAME_indices)
Each ``AXISNAME_indices`` attribute indicates the dependency
 relationship of the ``AXISNAME`` field (where ``AXISNAME``
 is the name of a field that exists in this ``NXdata`` group)
 with one or more dimensions of the plottable data.



void
setAttributeSignal(java.lang.String signal)
..



DataNode
setData(IDataset data)
..



void
setDataAttributeAxes(java.lang.String axes)
Deprecated. 
Use the group ``axes`` attribute   (NIAC2014)




void
setDataAttributeLong_name(java.lang.String long_name)
data label



void
setDataAttributeSignal(java.lang.Long signal)
Deprecated. 
Use the group ``signal`` attribute   (NIAC2014)




void
setDataAttributeUncertainties(java.lang.String uncertainties)
Specify the name (or names) of the uncertainties (errors)
 of the dependent axes as plottable data.



DataNode
setDataScalar(java.lang.Number data)
..



DataNode
setErrors(IDataset errors)
Standard deviations of data values -
 the data array is identified by the group attribute ``signal``.



DataNode
setErrorsScalar(java.lang.Number errors)
Standard deviations of data values -
 the data array is identified by the group attribute ``signal``.



DataNode
setOffset(IDataset offset)
An optional offset to apply to the values in data.



DataNode
setOffsetScalar(java.lang.Double offset)
An optional offset to apply to the values in data.



DataNode
setScaling_factor(IDataset scaling_factor)
The elements in data are usually float values really.



DataNode
setScaling_factorScalar(java.lang.Double scaling_factor)
The elements in data are usually float values really.



DataNode
setVARIABLE_errors(IDataset VARIABLE_errors)
Errors (uncertainties) associated with axis ``VARIABLE``.



DataNode
setVARIABLE_errorsScalar(java.lang.Number VARIABLE_errors)
Errors (uncertainties) associated with axis ``VARIABLE``.



DataNode
setVARIABLE(IDataset VARIABLE)
Dimension scale defining an axis of the data.



void
setVARIABLEAttributeAxis(java.lang.Long axis)
Deprecated. 
Use the group ``axes`` attribute   (NIAC2014)




void
setVARIABLEAttributeDistribution(java.lang.Boolean distribution)
``0|false``: single value,
 ``1|true``: multiple values



void
setVARIABLEAttributeFirst_good(java.lang.Long first_good)
Index of first good value



void
setVARIABLEAttributeLast_good(java.lang.Long last_good)
Index of last good value



void
setVARIABLEAttributeLong_name(java.lang.String long_name)
Axis label



DataNode
setVARIABLEScalar(java.lang.Number VARIABLE)
Dimension scale defining an axis of the data.



DataNode
setX(IDataset x)
This is an array holding the values to use for the x-axis of
 data.



DataNode
setXScalar(java.lang.Double x)
This is an array holding the values to use for the x-axis of
 data.



DataNode
setY(IDataset y)
This is an array holding the values to use for the y-axis of
 data.



DataNode
setYScalar(java.lang.Double y)
This is an array holding the values to use for the y-axis of
 data.



DataNode
setZ(IDataset z)
This is an array holding the values to use for the z-axis of
 data.



DataNode
setZScalar(java.lang.Double z)
This is an array holding the values to use for the z-axis of
 data.







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_ATTRIBUTE_SIGNAL
static final java.lang.String NX_ATTRIBUTE_SIGNAL

See Also:
Constant Field Values








NX_ATTRIBUTE_AXES
static final java.lang.String NX_ATTRIBUTE_AXES

See Also:
Constant Field Values








NX_ATTRIBUTE_AXISNAME_INDICES
static final java.lang.String NX_ATTRIBUTE_AXISNAME_INDICES

See Also:
Constant Field Values








NX_VARIABLE
static final java.lang.String NX_VARIABLE

See Also:
Constant Field Values








NX_VARIABLE_ATTRIBUTE_LONG_NAME
static final java.lang.String NX_VARIABLE_ATTRIBUTE_LONG_NAME

See Also:
Constant Field Values








NX_VARIABLE_ATTRIBUTE_DISTRIBUTION
static final java.lang.String NX_VARIABLE_ATTRIBUTE_DISTRIBUTION

See Also:
Constant Field Values








NX_VARIABLE_ATTRIBUTE_FIRST_GOOD
static final java.lang.String NX_VARIABLE_ATTRIBUTE_FIRST_GOOD

See Also:
Constant Field Values








NX_VARIABLE_ATTRIBUTE_LAST_GOOD
static final java.lang.String NX_VARIABLE_ATTRIBUTE_LAST_GOOD

See Also:
Constant Field Values








NX_VARIABLE_ATTRIBUTE_AXIS
static final java.lang.String NX_VARIABLE_ATTRIBUTE_AXIS

See Also:
Constant Field Values








NX_VARIABLE_ERRORS
static final java.lang.String NX_VARIABLE_ERRORS

See Also:
Constant Field Values








NX_DATA
static final java.lang.String NX_DATA

See Also:
Constant Field Values








NX_DATA_ATTRIBUTE_SIGNAL
static final java.lang.String NX_DATA_ATTRIBUTE_SIGNAL

See Also:
Constant Field Values








NX_DATA_ATTRIBUTE_AXES
static final java.lang.String NX_DATA_ATTRIBUTE_AXES

See Also:
Constant Field Values








NX_DATA_ATTRIBUTE_UNCERTAINTIES
static final java.lang.String NX_DATA_ATTRIBUTE_UNCERTAINTIES

See Also:
Constant Field Values








NX_DATA_ATTRIBUTE_LONG_NAME
static final java.lang.String NX_DATA_ATTRIBUTE_LONG_NAME

See Also:
Constant Field Values








NX_ERRORS
static final java.lang.String NX_ERRORS

See Also:
Constant Field Values








NX_SCALING_FACTOR
static final java.lang.String NX_SCALING_FACTOR

See Also:
Constant Field Values








NX_OFFSET
static final java.lang.String NX_OFFSET

See Also:
Constant Field Values








NX_X
static final java.lang.String NX_X

See Also:
Constant Field Values








NX_Y
static final java.lang.String NX_Y

See Also:
Constant Field Values








NX_Z
static final java.lang.String NX_Z

See Also:
Constant Field Values










Method Detail





getAttributeSignal
java.lang.String getAttributeSignal()
.. index:: plotting
 Declares which dataset is the default.
 The value is the name of the dataset to be plotted.
 A field of this name *must* exist (either as dataset
 or as a link to a dataset).
 It is recommended (as of NIAC2014) to use this attribute
 rather than adding a signal attribute to the dataset.
 See http://wiki.nexusformat.org/2014_How_to_find_default_data
 for a summary of the discussion.

Returns:
the value.








setAttributeSignal
void setAttributeSignal(java.lang.String signal)
.. index:: plotting
 Declares which dataset is the default.
 The value is the name of the dataset to be plotted.
 A field of this name *must* exist (either as dataset
 or as a link to a dataset).
 It is recommended (as of NIAC2014) to use this attribute
 rather than adding a signal attribute to the dataset.
 See http://wiki.nexusformat.org/2014_How_to_find_default_data
 for a summary of the discussion.

Parameters:
signal - the signal








getAttributeAxes
java.lang.String getAttributeAxes()
.. index:: plotting
 String array that defines the independent data fields used in
 the default plot for all of the dimensions of the *signal* field
 (the *signal* field is the field in this group that is named by
 the ``signal`` attribute of this group).
 One entry is provided for every dimension in the *signal* field.
 The field(s) named as values (known as "axes") of this attribute
 *must* exist. An axis slice is specified using a field named
 ``AXISNAME_indices`` as described below (where the text shown here
 as ``AXISNAME`` is to be replaced by the actual field name).
 When no default axis is available for a particular dimension
 of the plottable data, use a "." in that position.
 Such as::

Returns:
the value.








setAttributeAxes
void setAttributeAxes(java.lang.String axes)
.. index:: plotting
 String array that defines the independent data fields used in
 the default plot for all of the dimensions of the *signal* field
 (the *signal* field is the field in this group that is named by
 the ``signal`` attribute of this group).
 One entry is provided for every dimension in the *signal* field.
 The field(s) named as values (known as "axes") of this attribute
 *must* exist. An axis slice is specified using a field named
 ``AXISNAME_indices`` as described below (where the text shown here
 as ``AXISNAME`` is to be replaced by the actual field name).
 When no default axis is available for a particular dimension
 of the plottable data, use a "." in that position.
 Such as::

Parameters:
axes - the axes








getAttributeAXISNAME_indices
java.lang.String getAttributeAXISNAME_indices()
Each ``AXISNAME_indices`` attribute indicates the dependency
 relationship of the ``AXISNAME`` field (where ``AXISNAME``
 is the name of a field that exists in this ``NXdata`` group)
 with one or more dimensions of the plottable data.
 Integer array that defines the indices of the *signal* field
 (that field will be a multidimensional array)
 which need to be used in the *AXISNAME* dataset in
 order to reference the corresponding axis value.
 The first index of an array is ``0`` (zero).
 Here, *AXISNAME* is to be replaced by the name of each
 field described in the ``axes`` attribute.
 An example with 2-D data, :math:`d(t,P)`, will illustrate::
 data_2d:NXdata

Returns:
the value.








setAttributeAXISNAME_indices
void setAttributeAXISNAME_indices(java.lang.String AXISNAME_indices)
Each ``AXISNAME_indices`` attribute indicates the dependency
 relationship of the ``AXISNAME`` field (where ``AXISNAME``
 is the name of a field that exists in this ``NXdata`` group)
 with one or more dimensions of the plottable data.
 Integer array that defines the indices of the *signal* field
 (that field will be a multidimensional array)
 which need to be used in the *AXISNAME* dataset in
 order to reference the corresponding axis value.
 The first index of an array is ``0`` (zero).
 Here, *AXISNAME* is to be replaced by the name of each
 field described in the ``axes`` attribute.
 An example with 2-D data, :math:`d(t,P)`, will illustrate::
 data_2d:NXdata

Parameters:
AXISNAME_indices - the AXISNAME_indices








getVARIABLE
IDataset getVARIABLE()
Dimension scale defining an axis of the data.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances.
 Standard NeXus client tools will use the attributes to determine
 how to use this field.
 

 Type: NX_NUMBER
 Dimensions: 1: n;
 

Returns:
the value.








setVARIABLE
DataNode setVARIABLE(IDataset VARIABLE)
Dimension scale defining an axis of the data.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances.
 Standard NeXus client tools will use the attributes to determine
 how to use this field.
 

 Type: NX_NUMBER
 Dimensions: 1: n;
 

Parameters:
VARIABLE - the VARIABLE








getVARIABLEScalar
java.lang.Number getVARIABLEScalar()
Dimension scale defining an axis of the data.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances.
 Standard NeXus client tools will use the attributes to determine
 how to use this field.
 

 Type: NX_NUMBER
 Dimensions: 1: n;
 

Returns:
the value.








setVARIABLEScalar
DataNode setVARIABLEScalar(java.lang.Number VARIABLE)
Dimension scale defining an axis of the data.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances.
 Standard NeXus client tools will use the attributes to determine
 how to use this field.
 

 Type: NX_NUMBER
 Dimensions: 1: n;
 

Parameters:
VARIABLE - the VARIABLE








getAllVARIABLE
java.util.Map<java.lang.String,? extends IDataset> getAllVARIABLE()
Get all VARIABLE fields:

 Dimension scale defining an axis of the data.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances.
 Standard NeXus client tools will use the attributes to determine
 how to use this field.
 

 Type: NX_NUMBER
 Dimensions: 1: n;
 

Returns:
a map from node names to the ? extends IDataset for that node.








getVARIABLEAttributeLong_name
java.lang.String getVARIABLEAttributeLong_name()
Axis label

Returns:
the value.








setVARIABLEAttributeLong_name
void setVARIABLEAttributeLong_name(java.lang.String long_name)
Axis label

Parameters:
long_name - the long_name








getVARIABLEAttributeDistribution
java.lang.Boolean getVARIABLEAttributeDistribution()
``0|false``: single value,
 ``1|true``: multiple values

Returns:
the value.








setVARIABLEAttributeDistribution
void setVARIABLEAttributeDistribution(java.lang.Boolean distribution)
``0|false``: single value,
 ``1|true``: multiple values

Parameters:
distribution - the distribution








getVARIABLEAttributeFirst_good
java.lang.Long getVARIABLEAttributeFirst_good()
Index of first good value

Returns:
the value.








setVARIABLEAttributeFirst_good
void setVARIABLEAttributeFirst_good(java.lang.Long first_good)
Index of first good value

Parameters:
first_good - the first_good








getVARIABLEAttributeLast_good
java.lang.Long getVARIABLEAttributeLast_good()
Index of last good value

Returns:
the value.








setVARIABLEAttributeLast_good
void setVARIABLEAttributeLast_good(java.lang.Long last_good)
Index of last good value

Parameters:
last_good - the last_good








getVARIABLEAttributeAxis
@Deprecated
java.lang.Long getVARIABLEAttributeAxis()
Deprecated. Use the group ``axes`` attribute   (NIAC2014)
Index (positive integer) identifying this specific set of numbers.
 N.B. The ``axis`` attribute is the old way of designating a link.
 Do not use the ``axes`` attribute with the ``axis`` attribute.
 The ``axes`` *group* attribute is now preferred.

Returns:
the value.








setVARIABLEAttributeAxis
@Deprecated
void setVARIABLEAttributeAxis(java.lang.Long axis)
Deprecated. Use the group ``axes`` attribute   (NIAC2014)
Index (positive integer) identifying this specific set of numbers.
 N.B. The ``axis`` attribute is the old way of designating a link.
 Do not use the ``axes`` attribute with the ``axis`` attribute.
 The ``axes`` *group* attribute is now preferred.

Parameters:
axis - the axis








getVARIABLE_errors
IDataset getVARIABLE_errors()
Errors (uncertainties) associated with axis ``VARIABLE``.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances
 but is matched with the *VARIABLE*
 field with ``_errors`` appended.
 

 Type: NX_NUMBER
 Dimensions: 1: n;
 

Returns:
the value.








setVARIABLE_errors
DataNode setVARIABLE_errors(IDataset VARIABLE_errors)
Errors (uncertainties) associated with axis ``VARIABLE``.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances
 but is matched with the *VARIABLE*
 field with ``_errors`` appended.
 

 Type: NX_NUMBER
 Dimensions: 1: n;
 

Parameters:
VARIABLE_errors - the VARIABLE_errors








getVARIABLE_errorsScalar
java.lang.Number getVARIABLE_errorsScalar()
Errors (uncertainties) associated with axis ``VARIABLE``.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances
 but is matched with the *VARIABLE*
 field with ``_errors`` appended.
 

 Type: NX_NUMBER
 Dimensions: 1: n;
 

Returns:
the value.








setVARIABLE_errorsScalar
DataNode setVARIABLE_errorsScalar(java.lang.Number VARIABLE_errors)
Errors (uncertainties) associated with axis ``VARIABLE``.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances
 but is matched with the *VARIABLE*
 field with ``_errors`` appended.
 

 Type: NX_NUMBER
 Dimensions: 1: n;
 

Parameters:
VARIABLE_errors - the VARIABLE_errors








getAllVARIABLE_errors
java.util.Map<java.lang.String,? extends IDataset> getAllVARIABLE_errors()
Get all VARIABLE_errors fields:

 Errors (uncertainties) associated with axis ``VARIABLE``.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances
 but is matched with the *VARIABLE*
 field with ``_errors`` appended.
 

 Type: NX_NUMBER
 Dimensions: 1: n;
 

Returns:
a map from node names to the ? extends IDataset for that node.








getData
IDataset getData()
.. index:: plotting
 This field contains the data values to be used as the
 NeXus *plottable data*.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances.
 Standard NeXus client tools will use the attributes to determine
 how to use this field.
 

 Type: NX_NUMBER
 Dimensions: 0: n;
 

Returns:
the value.








setData
DataNode setData(IDataset data)
.. index:: plotting
 This field contains the data values to be used as the
 NeXus *plottable data*.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances.
 Standard NeXus client tools will use the attributes to determine
 how to use this field.
 

 Type: NX_NUMBER
 Dimensions: 0: n;
 

Parameters:
data - the data








getDataScalar
java.lang.Number getDataScalar()
.. index:: plotting
 This field contains the data values to be used as the
 NeXus *plottable data*.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances.
 Standard NeXus client tools will use the attributes to determine
 how to use this field.
 

 Type: NX_NUMBER
 Dimensions: 0: n;
 

Returns:
the value.








setDataScalar
DataNode setDataScalar(java.lang.Number data)
.. index:: plotting
 This field contains the data values to be used as the
 NeXus *plottable data*.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances.
 Standard NeXus client tools will use the attributes to determine
 how to use this field.
 

 Type: NX_NUMBER
 Dimensions: 0: n;
 

Parameters:
data - the data








getAllData
java.util.Map<java.lang.String,? extends IDataset> getAllData()
Get all Data fields:

 .. index:: plotting
 This field contains the data values to be used as the
 NeXus *plottable data*.
 Client is responsible for defining the dimensions of the data.
 The name of this field may be changed to fit the circumstances.
 Standard NeXus client tools will use the attributes to determine
 how to use this field.
 

 Type: NX_NUMBER
 Dimensions: 0: n;
 

Returns:
a map from node names to the ? extends IDataset for that node.








getDataAttributeSignal
@Deprecated
java.lang.Long getDataAttributeSignal()
Deprecated. Use the group ``signal`` attribute   (NIAC2014)
.. index:: plotting
 Plottable (independent) axis, indicate index number.
 Only one field in a :ref:`NXdata` group may have the
 ``signal=1`` attribute.
 Do not use the ``signal`` attribute with the ``axis`` attribute.

Returns:
the value.








setDataAttributeSignal
@Deprecated
void setDataAttributeSignal(java.lang.Long signal)
Deprecated. Use the group ``signal`` attribute   (NIAC2014)
.. index:: plotting
 Plottable (independent) axis, indicate index number.
 Only one field in a :ref:`NXdata` group may have the
 ``signal=1`` attribute.
 Do not use the ``signal`` attribute with the ``axis`` attribute.

Parameters:
signal - the signal








getDataAttributeAxes
@Deprecated
java.lang.String getDataAttributeAxes()
Deprecated. Use the group ``axes`` attribute   (NIAC2014)
Defines the names of the dimension scales
 (independent axes) for this data set
 as a colon-delimited array.
 NOTE: The ``axes`` attribute is the preferred
 method of designating a link.
 Do not use the ``axes`` attribute with the ``axis`` attribute.

Returns:
the value.








setDataAttributeAxes
@Deprecated
void setDataAttributeAxes(java.lang.String axes)
Deprecated. Use the group ``axes`` attribute   (NIAC2014)
Defines the names of the dimension scales
 (independent axes) for this data set
 as a colon-delimited array.
 NOTE: The ``axes`` attribute is the preferred
 method of designating a link.
 Do not use the ``axes`` attribute with the ``axis`` attribute.

Parameters:
axes - the axes








getDataAttributeUncertainties
java.lang.String getDataAttributeUncertainties()
Specify the name (or names) of the uncertainties (errors)
 of the dependent axes as plottable data.
 NOTE: The ``uncertainties`` attribute uses the same syntax
 as the ``axes`` attribute, a string or an array of strings
 for multiple uncertainties.
 Examples::

Returns:
the value.








setDataAttributeUncertainties
void setDataAttributeUncertainties(java.lang.String uncertainties)
Specify the name (or names) of the uncertainties (errors)
 of the dependent axes as plottable data.
 NOTE: The ``uncertainties`` attribute uses the same syntax
 as the ``axes`` attribute, a string or an array of strings
 for multiple uncertainties.
 Examples::

Parameters:
uncertainties - the uncertainties








getDataAttributeLong_name
java.lang.String getDataAttributeLong_name()
data label

Returns:
the value.








setDataAttributeLong_name
void setDataAttributeLong_name(java.lang.String long_name)
data label

Parameters:
long_name - the long_name








getErrors
IDataset getErrors()
Standard deviations of data values -
 the data array is identified by the group attribute ``signal``.
 The ``errors`` array must have the same dimensions as ``data``.
 Client is responsible for defining the dimensions of the data.
 

 Type: NX_NUMBER
 Dimensions: 0: n;
 

Returns:
the value.








setErrors
DataNode setErrors(IDataset errors)
Standard deviations of data values -
 the data array is identified by the group attribute ``signal``.
 The ``errors`` array must have the same dimensions as ``data``.
 Client is responsible for defining the dimensions of the data.
 

 Type: NX_NUMBER
 Dimensions: 0: n;
 

Parameters:
errors - the errors








getErrorsScalar
java.lang.Number getErrorsScalar()
Standard deviations of data values -
 the data array is identified by the group attribute ``signal``.
 The ``errors`` array must have the same dimensions as ``data``.
 Client is responsible for defining the dimensions of the data.
 

 Type: NX_NUMBER
 Dimensions: 0: n;
 

Returns:
the value.








setErrorsScalar
DataNode setErrorsScalar(java.lang.Number errors)
Standard deviations of data values -
 the data array is identified by the group attribute ``signal``.
 The ``errors`` array must have the same dimensions as ``data``.
 Client is responsible for defining the dimensions of the data.
 

 Type: NX_NUMBER
 Dimensions: 0: n;
 

Parameters:
errors - the errors








getScaling_factor
IDataset getScaling_factor()
The elements in data are usually float values really. For
 efficiency reasons these are usually stored as integers
 after scaling with a scale factor. This value is the scale
 factor. It is required to get the actual physical value,
 when necessary.
 

 Type: NX_FLOAT
 

Returns:
the value.








setScaling_factor
DataNode setScaling_factor(IDataset scaling_factor)
The elements in data are usually float values really. For
 efficiency reasons these are usually stored as integers
 after scaling with a scale factor. This value is the scale
 factor. It is required to get the actual physical value,
 when necessary.
 

 Type: NX_FLOAT
 

Parameters:
scaling_factor - the scaling_factor








getScaling_factorScalar
java.lang.Double getScaling_factorScalar()
The elements in data are usually float values really. For
 efficiency reasons these are usually stored as integers
 after scaling with a scale factor. This value is the scale
 factor. It is required to get the actual physical value,
 when necessary.
 

 Type: NX_FLOAT
 

Returns:
the value.








setScaling_factorScalar
DataNode setScaling_factorScalar(java.lang.Double scaling_factor)
The elements in data are usually float values really. For
 efficiency reasons these are usually stored as integers
 after scaling with a scale factor. This value is the scale
 factor. It is required to get the actual physical value,
 when necessary.
 

 Type: NX_FLOAT
 

Parameters:
scaling_factor - the scaling_factor








getOffset
IDataset getOffset()
An optional offset to apply to the values in data.
 

 Type: NX_FLOAT
 

Returns:
the value.








setOffset
DataNode setOffset(IDataset offset)
An optional offset to apply to the values in data.
 

 Type: NX_FLOAT
 

Parameters:
offset - the offset








getOffsetScalar
java.lang.Double getOffsetScalar()
An optional offset to apply to the values in data.
 

 Type: NX_FLOAT
 

Returns:
the value.








setOffsetScalar
DataNode setOffsetScalar(java.lang.Double offset)
An optional offset to apply to the values in data.
 

 Type: NX_FLOAT
 

Parameters:
offset - the offset








getX
IDataset getX()
This is an array holding the values to use for the x-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: nx;
 

Returns:
the value.








setX
DataNode setX(IDataset x)
This is an array holding the values to use for the x-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: nx;
 

Parameters:
x - the x








getXScalar
java.lang.Double getXScalar()
This is an array holding the values to use for the x-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: nx;
 

Returns:
the value.








setXScalar
DataNode setXScalar(java.lang.Double x)
This is an array holding the values to use for the x-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: nx;
 

Parameters:
x - the x








getY
IDataset getY()
This is an array holding the values to use for the y-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: ny;
 

Returns:
the value.








setY
DataNode setY(IDataset y)
This is an array holding the values to use for the y-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: ny;
 

Parameters:
y - the y








getYScalar
java.lang.Double getYScalar()
This is an array holding the values to use for the y-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: ny;
 

Returns:
the value.








setYScalar
DataNode setYScalar(java.lang.Double y)
This is an array holding the values to use for the y-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: ny;
 

Parameters:
y - the y








getZ
IDataset getZ()
This is an array holding the values to use for the z-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: nz;
 

Returns:
the value.








setZ
DataNode setZ(IDataset z)
This is an array holding the values to use for the z-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: nz;
 

Parameters:
z - the z








getZScalar
java.lang.Double getZScalar()
This is an array holding the values to use for the z-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: nz;
 

Returns:
the value.








setZScalar
DataNode setZScalar(java.lang.Double z)
This is an array holding the values to use for the z-axis of
 data. The units must be appropriate for the measurement.
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: nz;
 

Parameters:
z - the z














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