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






NXtranslation (h5jan API)











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 NXtranslation






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


All Known Implementing Classes:
NXtranslationImpl




public interface NXtranslation
extends NXobject
legacy class - (used by :ref:`NXgeometry`) - general spatial location of a component.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DISTANCES 






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
getDistances()
(x,y,z)
 This field describes the lateral movement of a component.



java.lang.Double
getDistancesScalar()
(x,y,z)
 This field describes the lateral movement of a component.



NXgeometry
getGeometry()
Link to other object if we are relative, else absent



DataNode
setDistances(IDataset distances)
(x,y,z)
 This field describes the lateral movement of a component.



DataNode
setDistancesScalar(java.lang.Double distances)
(x,y,z)
 This field describes the lateral movement of a component.



void
setGeometry(NXgeometry geometry)
Link to other object if we are relative, else absent







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_DISTANCES
static final java.lang.String NX_DISTANCES

See Also:
Constant Field Values










Method Detail





getGeometry
NXgeometry getGeometry()
Link to other object if we are relative, else absent

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)
Link to other object if we are relative, else absent

Parameters:
geometry - the geometry








getDistances
IDataset getDistances()
(x,y,z)
 This field describes the lateral movement of a component.
 The pair of groups NXtranslation and NXorientation together
 describe the position of a component.
 For absolute position, the origin is the scattering center (where a perfectly
 aligned sample would be) with the z-axis pointing downstream and the y-axis
 pointing gravitationally up. For a relative position the NXtranslation is
 taken into account before the NXorientation. The axes are right-handed and
 orthonormal.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: numobj; 2: 3;
 

Returns:
the value.








setDistances
DataNode setDistances(IDataset distances)
(x,y,z)
 This field describes the lateral movement of a component.
 The pair of groups NXtranslation and NXorientation together
 describe the position of a component.
 For absolute position, the origin is the scattering center (where a perfectly
 aligned sample would be) with the z-axis pointing downstream and the y-axis
 pointing gravitationally up. For a relative position the NXtranslation is
 taken into account before the NXorientation. The axes are right-handed and
 orthonormal.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: numobj; 2: 3;
 

Parameters:
distances - the distances








getDistancesScalar
java.lang.Double getDistancesScalar()
(x,y,z)
 This field describes the lateral movement of a component.
 The pair of groups NXtranslation and NXorientation together
 describe the position of a component.
 For absolute position, the origin is the scattering center (where a perfectly
 aligned sample would be) with the z-axis pointing downstream and the y-axis
 pointing gravitationally up. For a relative position the NXtranslation is
 taken into account before the NXorientation. The axes are right-handed and
 orthonormal.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: numobj; 2: 3;
 

Returns:
the value.








setDistancesScalar
DataNode setDistancesScalar(java.lang.Double distances)
(x,y,z)
 This field describes the lateral movement of a component.
 The pair of groups NXtranslation and NXorientation together
 describe the position of a component.
 For absolute position, the origin is the scattering center (where a perfectly
 aligned sample would be) with the z-axis pointing downstream and the y-axis
 pointing gravitationally up. For a relative position the NXtranslation is
 taken into account before the NXorientation. The axes are right-handed and
 orthonormal.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: numobj; 2: 3;
 

Parameters:
distances - the distances














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

Modifier and Type	Method and Description
`IDataset`	`getDistances()` (x,y,z) This field describes the lateral movement of a component.
`java.lang.Double`	`getDistancesScalar()` (x,y,z) This field describes the lateral movement of a component.
`NXgeometry`	`getGeometry()` Link to other object if we are relative, else absent
`DataNode`	`setDistances(IDataset distances)` (x,y,z) This field describes the lateral movement of a component.
`DataNode`	`setDistancesScalar(java.lang.Double distances)` (x,y,z) This field describes the lateral movement of a component.
`void`	`setGeometry(NXgeometry geometry)` Link to other object if we are relative, else absent