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



java.lang.Object


org.eclipse.dawnsci.analysis.tree.impl.NodeImpl


org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl


org.eclipse.dawnsci.nexus.impl.NXobjectImpl


org.eclipse.dawnsci.nexus.impl.NXdataImpl













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




public class NXdataImpl
extends NXobjectImpl
implements NXdata
: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

See Also:
Serialized Form












Field Summary

Fields 

Modifier and Type
Field and Description


static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES 






Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS





Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT





Fields inherited from interface org.eclipse.dawnsci.nexus.NXdata
NX_ATTRIBUTE_AXES, NX_ATTRIBUTE_AXISNAME_INDICES, NX_ATTRIBUTE_SIGNAL, NX_DATA, NX_DATA_ATTRIBUTE_AXES, NX_DATA_ATTRIBUTE_LONG_NAME, NX_DATA_ATTRIBUTE_SIGNAL, NX_DATA_ATTRIBUTE_UNCERTAINTIES, NX_ERRORS, NX_OFFSET, NX_SCALING_FACTOR, NX_VARIABLE, NX_VARIABLE_ATTRIBUTE_AXIS, NX_VARIABLE_ATTRIBUTE_DISTRIBUTION, NX_VARIABLE_ATTRIBUTE_FIRST_GOOD, NX_VARIABLE_ATTRIBUTE_LAST_GOOD, NX_VARIABLE_ATTRIBUTE_LONG_NAME, NX_VARIABLE_ERRORS, NX_X, NX_Y, NX_Z





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








Constructor Summary

Constructors 

Constructor and Description


NXdataImpl() 


NXdataImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods 

Modifier and Type
Method and Description


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

 ..



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

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



java.util.Map<java.lang.String,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. 



java.lang.String
getDataAttributeLong_name()
data label



java.lang.Long
getDataAttributeSignal()
Deprecated. 



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``.



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



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.



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



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. 



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
setData(java.lang.String name,
       IDataset data) 


void
setDataAttributeAxes(java.lang.String axes)
Deprecated. 



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



void
setDataAttributeSignal(java.lang.Long signal)
Deprecated. 



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``.



void
setVARIABLE_errors(java.lang.String name,
                  IDataset VARIABLE_errors) 


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
setVARIABLE(java.lang.String name,
           IDataset VARIABLE) 


void
setVARIABLEAttributeAxis(java.lang.Long axis)
Deprecated. 



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 class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString





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





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait





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, getNumber, 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





PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES









Constructor Detail





NXdataImpl
public NXdataImpl()







NXdataImpl
public NXdataImpl(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








getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass for this base class, e.g. NexusBaseClass.NX_SAMPLE.

Specified by:
getNexusBaseClass in interface NXobject
Returns:
NexusBaseClass enum constant for this class








getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.

Specified by:
getPermittedChildGroupClasses in interface NXobject
Returns:
NexusBaseClass constants for permitted child groups








getAttributeSignal
public java.lang.String getAttributeSignal()
Description copied from interface: NXdata
.. 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.

Specified by:
getAttributeSignal in interface NXdata
Returns:
the value.








setAttributeSignal
public void setAttributeSignal(java.lang.String signal)
Description copied from interface: NXdata
.. 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.

Specified by:
setAttributeSignal in interface NXdata
Parameters:
signal - the signal








getAttributeAxes
public java.lang.String getAttributeAxes()
Description copied from interface: NXdata
.. 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::

Specified by:
getAttributeAxes in interface NXdata
Returns:
the value.








setAttributeAxes
public void setAttributeAxes(java.lang.String axes)
Description copied from interface: NXdata
.. 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::

Specified by:
setAttributeAxes in interface NXdata
Parameters:
axes - the axes








getAttributeAXISNAME_indices
public java.lang.String getAttributeAXISNAME_indices()
Description copied from interface: NXdata
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

Specified by:
getAttributeAXISNAME_indices in interface NXdata
Returns:
the value.








setAttributeAXISNAME_indices
public void setAttributeAXISNAME_indices(java.lang.String AXISNAME_indices)
Description copied from interface: NXdata
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

Specified by:
setAttributeAXISNAME_indices in interface NXdata
Parameters:
AXISNAME_indices - the AXISNAME_indices








getVARIABLE
public IDataset getVARIABLE()
Description copied from interface: NXdata
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;
 

Specified by:
getVARIABLE in interface NXdata
Returns:
the value.








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

Specified by:
getVARIABLEScalar in interface NXdata
Returns:
the value.








setVARIABLE
public DataNode setVARIABLE(IDataset VARIABLE)
Description copied from interface: NXdata
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;
 

Specified by:
setVARIABLE in interface NXdata
Parameters:
VARIABLE - the VARIABLE








setVARIABLEScalar
public DataNode setVARIABLEScalar(java.lang.Number VARIABLE)
Description copied from interface: NXdata
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;
 

Specified by:
setVARIABLEScalar in interface NXdata
Parameters:
VARIABLE - the VARIABLE








getAllVARIABLE
public java.util.Map<java.lang.String,IDataset> getAllVARIABLE()
Description copied from interface: NXdata
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;
 

Specified by:
getAllVARIABLE in interface NXdata
Returns:
a map from node names to the ? extends IDataset for that node.








setVARIABLE
public void setVARIABLE(java.lang.String name,
                        IDataset VARIABLE)







getVARIABLEAttributeLong_name
public java.lang.String getVARIABLEAttributeLong_name()
Description copied from interface: NXdata
Axis label

Specified by:
getVARIABLEAttributeLong_name in interface NXdata
Returns:
the value.








setVARIABLEAttributeLong_name
public void setVARIABLEAttributeLong_name(java.lang.String long_name)
Description copied from interface: NXdata
Axis label

Specified by:
setVARIABLEAttributeLong_name in interface NXdata
Parameters:
long_name - the long_name








getVARIABLEAttributeDistribution
public java.lang.Boolean getVARIABLEAttributeDistribution()
Description copied from interface: NXdata
``0|false``: single value,
 ``1|true``: multiple values

Specified by:
getVARIABLEAttributeDistribution in interface NXdata
Returns:
the value.








setVARIABLEAttributeDistribution
public void setVARIABLEAttributeDistribution(java.lang.Boolean distribution)
Description copied from interface: NXdata
``0|false``: single value,
 ``1|true``: multiple values

Specified by:
setVARIABLEAttributeDistribution in interface NXdata
Parameters:
distribution - the distribution








getVARIABLEAttributeFirst_good
public java.lang.Long getVARIABLEAttributeFirst_good()
Description copied from interface: NXdata
Index of first good value

Specified by:
getVARIABLEAttributeFirst_good in interface NXdata
Returns:
the value.








setVARIABLEAttributeFirst_good
public void setVARIABLEAttributeFirst_good(java.lang.Long first_good)
Description copied from interface: NXdata
Index of first good value

Specified by:
setVARIABLEAttributeFirst_good in interface NXdata
Parameters:
first_good - the first_good








getVARIABLEAttributeLast_good
public java.lang.Long getVARIABLEAttributeLast_good()
Description copied from interface: NXdata
Index of last good value

Specified by:
getVARIABLEAttributeLast_good in interface NXdata
Returns:
the value.








setVARIABLEAttributeLast_good
public void setVARIABLEAttributeLast_good(java.lang.Long last_good)
Description copied from interface: NXdata
Index of last good value

Specified by:
setVARIABLEAttributeLast_good in interface NXdata
Parameters:
last_good - the last_good








getVARIABLEAttributeAxis
@Deprecated
public java.lang.Long getVARIABLEAttributeAxis()
Deprecated. 
Description copied from interface: NXdata
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.

Specified by:
getVARIABLEAttributeAxis in interface NXdata
Returns:
the value.








setVARIABLEAttributeAxis
@Deprecated
public void setVARIABLEAttributeAxis(java.lang.Long axis)
Deprecated. 
Description copied from interface: NXdata
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.

Specified by:
setVARIABLEAttributeAxis in interface NXdata
Parameters:
axis - the axis








getVARIABLE_errors
public IDataset getVARIABLE_errors()
Description copied from interface: NXdata
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;
 

Specified by:
getVARIABLE_errors in interface NXdata
Returns:
the value.








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

Specified by:
getVARIABLE_errorsScalar in interface NXdata
Returns:
the value.








setVARIABLE_errors
public DataNode setVARIABLE_errors(IDataset VARIABLE_errors)
Description copied from interface: NXdata
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;
 

Specified by:
setVARIABLE_errors in interface NXdata
Parameters:
VARIABLE_errors - the VARIABLE_errors








setVARIABLE_errorsScalar
public DataNode setVARIABLE_errorsScalar(java.lang.Number VARIABLE_errors)
Description copied from interface: NXdata
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;
 

Specified by:
setVARIABLE_errorsScalar in interface NXdata
Parameters:
VARIABLE_errors - the VARIABLE_errors








getAllVARIABLE_errors
public java.util.Map<java.lang.String,IDataset> getAllVARIABLE_errors()
Description copied from interface: NXdata
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;
 

Specified by:
getAllVARIABLE_errors in interface NXdata
Returns:
a map from node names to the ? extends IDataset for that node.








setVARIABLE_errors
public void setVARIABLE_errors(java.lang.String name,
                               IDataset VARIABLE_errors)







getData
public IDataset getData()
Description copied from interface: NXdata
.. 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;
 

Specified by:
getData in interface NXdata
Returns:
the value.








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

Specified by:
getDataScalar in interface NXdata
Returns:
the value.








setData
public DataNode setData(IDataset data)
Description copied from interface: NXdata
.. 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;
 

Specified by:
setData in interface NXdata
Parameters:
data - the data








setDataScalar
public DataNode setDataScalar(java.lang.Number data)
Description copied from interface: NXdata
.. 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;
 

Specified by:
setDataScalar in interface NXdata
Parameters:
data - the data








getAllData
public java.util.Map<java.lang.String,IDataset> getAllData()
Description copied from interface: NXdata
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;
 

Specified by:
getAllData in interface NXdata
Returns:
a map from node names to the ? extends IDataset for that node.








setData
public void setData(java.lang.String name,
                    IDataset data)







getDataAttributeSignal
@Deprecated
public java.lang.Long getDataAttributeSignal()
Deprecated. 
Description copied from interface: NXdata
.. 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.

Specified by:
getDataAttributeSignal in interface NXdata
Returns:
the value.








setDataAttributeSignal
@Deprecated
public void setDataAttributeSignal(java.lang.Long signal)
Deprecated. 
Description copied from interface: NXdata
.. 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.

Specified by:
setDataAttributeSignal in interface NXdata
Parameters:
signal - the signal








getDataAttributeAxes
@Deprecated
public java.lang.String getDataAttributeAxes()
Deprecated. 
Description copied from interface: NXdata
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.

Specified by:
getDataAttributeAxes in interface NXdata
Returns:
the value.








setDataAttributeAxes
@Deprecated
public void setDataAttributeAxes(java.lang.String axes)
Deprecated. 
Description copied from interface: NXdata
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.

Specified by:
setDataAttributeAxes in interface NXdata
Parameters:
axes - the axes








getDataAttributeUncertainties
public java.lang.String getDataAttributeUncertainties()
Description copied from interface: NXdata
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::

Specified by:
getDataAttributeUncertainties in interface NXdata
Returns:
the value.








setDataAttributeUncertainties
public void setDataAttributeUncertainties(java.lang.String uncertainties)
Description copied from interface: NXdata
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::

Specified by:
setDataAttributeUncertainties in interface NXdata
Parameters:
uncertainties - the uncertainties








getDataAttributeLong_name
public java.lang.String getDataAttributeLong_name()
Description copied from interface: NXdata
data label

Specified by:
getDataAttributeLong_name in interface NXdata
Returns:
the value.








setDataAttributeLong_name
public void setDataAttributeLong_name(java.lang.String long_name)
Description copied from interface: NXdata
data label

Specified by:
setDataAttributeLong_name in interface NXdata
Parameters:
long_name - the long_name








getErrors
public IDataset getErrors()
Description copied from interface: NXdata
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;
 

Specified by:
getErrors in interface NXdata
Returns:
the value.








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

Specified by:
getErrorsScalar in interface NXdata
Returns:
the value.








setErrors
public DataNode setErrors(IDataset errors)
Description copied from interface: NXdata
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;
 

Specified by:
setErrors in interface NXdata
Parameters:
errors - the errors








setErrorsScalar
public DataNode setErrorsScalar(java.lang.Number errors)
Description copied from interface: NXdata
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;
 

Specified by:
setErrorsScalar in interface NXdata
Parameters:
errors - the errors








getScaling_factor
public IDataset getScaling_factor()
Description copied from interface: NXdata
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
 

Specified by:
getScaling_factor in interface NXdata
Returns:
the value.








getScaling_factorScalar
public java.lang.Double getScaling_factorScalar()
Description copied from interface: NXdata
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
 

Specified by:
getScaling_factorScalar in interface NXdata
Returns:
the value.








setScaling_factor
public DataNode setScaling_factor(IDataset scaling_factor)
Description copied from interface: NXdata
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
 

Specified by:
setScaling_factor in interface NXdata
Parameters:
scaling_factor - the scaling_factor








setScaling_factorScalar
public DataNode setScaling_factorScalar(java.lang.Double scaling_factor)
Description copied from interface: NXdata
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
 

Specified by:
setScaling_factorScalar in interface NXdata
Parameters:
scaling_factor - the scaling_factor








getOffset
public IDataset getOffset()
Description copied from interface: NXdata
An optional offset to apply to the values in data.
 

 Type: NX_FLOAT
 

Specified by:
getOffset in interface NXdata
Returns:
the value.








getOffsetScalar
public java.lang.Double getOffsetScalar()
Description copied from interface: NXdata
An optional offset to apply to the values in data.
 

 Type: NX_FLOAT
 

Specified by:
getOffsetScalar in interface NXdata
Returns:
the value.








setOffset
public DataNode setOffset(IDataset offset)
Description copied from interface: NXdata
An optional offset to apply to the values in data.
 

 Type: NX_FLOAT
 

Specified by:
setOffset in interface NXdata
Parameters:
offset - the offset








setOffsetScalar
public DataNode setOffsetScalar(java.lang.Double offset)
Description copied from interface: NXdata
An optional offset to apply to the values in data.
 

 Type: NX_FLOAT
 

Specified by:
setOffsetScalar in interface NXdata
Parameters:
offset - the offset








getX
public IDataset getX()
Description copied from interface: NXdata
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;
 

Specified by:
getX in interface NXdata
Returns:
the value.








getXScalar
public java.lang.Double getXScalar()
Description copied from interface: NXdata
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;
 

Specified by:
getXScalar in interface NXdata
Returns:
the value.








setX
public DataNode setX(IDataset x)
Description copied from interface: NXdata
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;
 

Specified by:
setX in interface NXdata
Parameters:
x - the x








setXScalar
public DataNode setXScalar(java.lang.Double x)
Description copied from interface: NXdata
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;
 

Specified by:
setXScalar in interface NXdata
Parameters:
x - the x








getY
public IDataset getY()
Description copied from interface: NXdata
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;
 

Specified by:
getY in interface NXdata
Returns:
the value.








getYScalar
public java.lang.Double getYScalar()
Description copied from interface: NXdata
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;
 

Specified by:
getYScalar in interface NXdata
Returns:
the value.








setY
public DataNode setY(IDataset y)
Description copied from interface: NXdata
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;
 

Specified by:
setY in interface NXdata
Parameters:
y - the y








setYScalar
public DataNode setYScalar(java.lang.Double y)
Description copied from interface: NXdata
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;
 

Specified by:
setYScalar in interface NXdata
Parameters:
y - the y








getZ
public IDataset getZ()
Description copied from interface: NXdata
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;
 

Specified by:
getZ in interface NXdata
Returns:
the value.








getZScalar
public java.lang.Double getZScalar()
Description copied from interface: NXdata
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;
 

Specified by:
getZScalar in interface NXdata
Returns:
the value.








setZ
public DataNode setZ(IDataset z)
Description copied from interface: NXdata
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;
 

Specified by:
setZ in interface NXdata
Parameters:
z - the z








setZScalar
public DataNode setZScalar(java.lang.Double z)
Description copied from interface: NXdata
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;
 

Specified by:
setZScalar in interface NXdata
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