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






NXoff_geometryImpl (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.impl
Class NXoff_geometryImpl



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













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




public class NXoff_geometryImpl
extends NXobjectImpl
implements NXoff_geometry
Geometry (shape) description.
 The format closely matches the Object File Format (OFF) which can be output
 by most CAD software.
 It can be used to describe the shape of any beamline component, including detectors.
 In the case of detectors it can be used to define the shape of a single pixel, or,
 if the pixel shapes are non-uniform, to describe the shape of the whole detector.

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.NXoff_geometry
NX_DETECTOR_FACES, NX_FACES, NX_VERTICES, NX_WINDING_ORDER





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








Constructor Summary

Constructors 

Constructor and Description


NXoff_geometryImpl() 


NXoff_geometryImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getDetector_faces()
List of pairs of index in the "faces" dataset and detector id.



java.lang.Long
getDetector_facesScalar()
List of pairs of index in the "faces" dataset and detector id.



IDataset
getFaces()
The start index in ``winding_order`` for each face.



java.lang.Long
getFacesScalar()
The start index in ``winding_order`` for each face.



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.



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



IDataset
getVertices()
List of x,y,z coordinates for vertices.



java.lang.Number
getVerticesScalar()
List of x,y,z coordinates for vertices.



IDataset
getWinding_order()
List of indices of vertices in the ``vertices`` dataset to form each face,
 right-hand rule for face normal.



java.lang.Long
getWinding_orderScalar()
List of indices of vertices in the ``vertices`` dataset to form each face,
 right-hand rule for face normal.



DataNode
setDetector_faces(IDataset detector_faces)
List of pairs of index in the "faces" dataset and detector id.



DataNode
setDetector_facesScalar(java.lang.Long detector_faces)
List of pairs of index in the "faces" dataset and detector id.



DataNode
setFaces(IDataset faces)
The start index in ``winding_order`` for each face.



DataNode
setFacesScalar(java.lang.Long faces)
The start index in ``winding_order`` for each face.



DataNode
setVertices(IDataset vertices)
List of x,y,z coordinates for vertices.



DataNode
setVerticesScalar(java.lang.Number vertices)
List of x,y,z coordinates for vertices.



DataNode
setWinding_order(IDataset winding_order)
List of indices of vertices in the ``vertices`` dataset to form each face,
 right-hand rule for face normal.



DataNode
setWinding_orderScalar(java.lang.Long winding_order)
List of indices of vertices in the ``vertices`` dataset to form each face,
 right-hand rule for face normal.







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





NXoff_geometryImpl
public NXoff_geometryImpl()







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








getVertices
public IDataset getVertices()
Description copied from interface: NXoff_geometry
List of x,y,z coordinates for vertices.
 The origin of the coordinates is the position of the parent component, for
 example the NXdetector which the geometry describes.
 If the shape describes a single pixel for a detector with uniform pixel
 shape then the origin is the position of each pixel as described by the
 ``x/y/z_pixel_offset`` datasets in ``NXdetector``.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 Dimensions: 1: i; 2: 3;
 

Specified by:
getVertices in interface NXoff_geometry
Returns:
the value.








getVerticesScalar
public java.lang.Number getVerticesScalar()
Description copied from interface: NXoff_geometry
List of x,y,z coordinates for vertices.
 The origin of the coordinates is the position of the parent component, for
 example the NXdetector which the geometry describes.
 If the shape describes a single pixel for a detector with uniform pixel
 shape then the origin is the position of each pixel as described by the
 ``x/y/z_pixel_offset`` datasets in ``NXdetector``.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 Dimensions: 1: i; 2: 3;
 

Specified by:
getVerticesScalar in interface NXoff_geometry
Returns:
the value.








setVertices
public DataNode setVertices(IDataset vertices)
Description copied from interface: NXoff_geometry
List of x,y,z coordinates for vertices.
 The origin of the coordinates is the position of the parent component, for
 example the NXdetector which the geometry describes.
 If the shape describes a single pixel for a detector with uniform pixel
 shape then the origin is the position of each pixel as described by the
 ``x/y/z_pixel_offset`` datasets in ``NXdetector``.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 Dimensions: 1: i; 2: 3;
 

Specified by:
setVertices in interface NXoff_geometry
Parameters:
vertices - the vertices








setVerticesScalar
public DataNode setVerticesScalar(java.lang.Number vertices)
Description copied from interface: NXoff_geometry
List of x,y,z coordinates for vertices.
 The origin of the coordinates is the position of the parent component, for
 example the NXdetector which the geometry describes.
 If the shape describes a single pixel for a detector with uniform pixel
 shape then the origin is the position of each pixel as described by the
 ``x/y/z_pixel_offset`` datasets in ``NXdetector``.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 Dimensions: 1: i; 2: 3;
 

Specified by:
setVerticesScalar in interface NXoff_geometry
Parameters:
vertices - the vertices








getWinding_order
public IDataset getWinding_order()
Description copied from interface: NXoff_geometry
List of indices of vertices in the ``vertices`` dataset to form each face,
 right-hand rule for face normal.
 
 Type: NX_INT
 Dimensions: 1: j;
 

Specified by:
getWinding_order in interface NXoff_geometry
Returns:
the value.








getWinding_orderScalar
public java.lang.Long getWinding_orderScalar()
Description copied from interface: NXoff_geometry
List of indices of vertices in the ``vertices`` dataset to form each face,
 right-hand rule for face normal.
 
 Type: NX_INT
 Dimensions: 1: j;
 

Specified by:
getWinding_orderScalar in interface NXoff_geometry
Returns:
the value.








setWinding_order
public DataNode setWinding_order(IDataset winding_order)
Description copied from interface: NXoff_geometry
List of indices of vertices in the ``vertices`` dataset to form each face,
 right-hand rule for face normal.
 
 Type: NX_INT
 Dimensions: 1: j;
 

Specified by:
setWinding_order in interface NXoff_geometry
Parameters:
winding_order - the winding_order








setWinding_orderScalar
public DataNode setWinding_orderScalar(java.lang.Long winding_order)
Description copied from interface: NXoff_geometry
List of indices of vertices in the ``vertices`` dataset to form each face,
 right-hand rule for face normal.
 
 Type: NX_INT
 Dimensions: 1: j;
 

Specified by:
setWinding_orderScalar in interface NXoff_geometry
Parameters:
winding_order - the winding_order








getFaces
public IDataset getFaces()
Description copied from interface: NXoff_geometry
The start index in ``winding_order`` for each face.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Specified by:
getFaces in interface NXoff_geometry
Returns:
the value.








getFacesScalar
public java.lang.Long getFacesScalar()
Description copied from interface: NXoff_geometry
The start index in ``winding_order`` for each face.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Specified by:
getFacesScalar in interface NXoff_geometry
Returns:
the value.








setFaces
public DataNode setFaces(IDataset faces)
Description copied from interface: NXoff_geometry
The start index in ``winding_order`` for each face.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Specified by:
setFaces in interface NXoff_geometry
Parameters:
faces - the faces








setFacesScalar
public DataNode setFacesScalar(java.lang.Long faces)
Description copied from interface: NXoff_geometry
The start index in ``winding_order`` for each face.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Specified by:
setFacesScalar in interface NXoff_geometry
Parameters:
faces - the faces








getDetector_faces
public IDataset getDetector_faces()
Description copied from interface: NXoff_geometry
List of pairs of index in the "faces" dataset and detector id. Face IDs in
 the first column, and corresponding detector IDs in the second column.
 This dataset should only be used only if the ``NXoff_geometry`` group is
 describing a detector.
 Note, the face indices must be in ascending order but need not be
 consecutive as not every face in faces need be a detecting surface or
 boundary of detecting volume.
 Can use multiple entries with the same detector id to define detector volumes.
 
 Type: NX_INT
 Dimensions: 1: l; 2: 2;
 

Specified by:
getDetector_faces in interface NXoff_geometry
Returns:
the value.








getDetector_facesScalar
public java.lang.Long getDetector_facesScalar()
Description copied from interface: NXoff_geometry
List of pairs of index in the "faces" dataset and detector id. Face IDs in
 the first column, and corresponding detector IDs in the second column.
 This dataset should only be used only if the ``NXoff_geometry`` group is
 describing a detector.
 Note, the face indices must be in ascending order but need not be
 consecutive as not every face in faces need be a detecting surface or
 boundary of detecting volume.
 Can use multiple entries with the same detector id to define detector volumes.
 
 Type: NX_INT
 Dimensions: 1: l; 2: 2;
 

Specified by:
getDetector_facesScalar in interface NXoff_geometry
Returns:
the value.








setDetector_faces
public DataNode setDetector_faces(IDataset detector_faces)
Description copied from interface: NXoff_geometry
List of pairs of index in the "faces" dataset and detector id. Face IDs in
 the first column, and corresponding detector IDs in the second column.
 This dataset should only be used only if the ``NXoff_geometry`` group is
 describing a detector.
 Note, the face indices must be in ascending order but need not be
 consecutive as not every face in faces need be a detecting surface or
 boundary of detecting volume.
 Can use multiple entries with the same detector id to define detector volumes.
 
 Type: NX_INT
 Dimensions: 1: l; 2: 2;
 

Specified by:
setDetector_faces in interface NXoff_geometry
Parameters:
detector_faces - the detector_faces








setDetector_facesScalar
public DataNode setDetector_facesScalar(java.lang.Long detector_faces)
Description copied from interface: NXoff_geometry
List of pairs of index in the "faces" dataset and detector id. Face IDs in
 the first column, and corresponding detector IDs in the second column.
 This dataset should only be used only if the ``NXoff_geometry`` group is
 describing a detector.
 Note, the face indices must be in ascending order but need not be
 consecutive as not every face in faces need be a detecting surface or
 boundary of detecting volume.
 Can use multiple entries with the same detector id to define detector volumes.
 
 Type: NX_INT
 Dimensions: 1: l; 2: 2;
 

Specified by:
setDetector_facesScalar in interface NXoff_geometry
Parameters:
detector_faces - the detector_faces














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`	`getDetector_faces()` List of pairs of index in the "faces" dataset and detector id.
`java.lang.Long`	`getDetector_facesScalar()` List of pairs of index in the "faces" dataset and detector id.
`IDataset`	`getFaces()` The start index in ``winding_order`` for each face.
`java.lang.Long`	`getFacesScalar()` The start index in ``winding_order`` for each face.
`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.
`java.util.Set<NexusBaseClass>`	`getPermittedChildGroupClasses()` Returns a set containing the `NexusBaseClass` constants for the permitted child group types of this base class.
`IDataset`	`getVertices()` List of x,y,z coordinates for vertices.
`java.lang.Number`	`getVerticesScalar()` List of x,y,z coordinates for vertices.
`IDataset`	`getWinding_order()` List of indices of vertices in the ``vertices`` dataset to form each face, right-hand rule for face normal.
`java.lang.Long`	`getWinding_orderScalar()` List of indices of vertices in the ``vertices`` dataset to form each face, right-hand rule for face normal.
`DataNode`	`setDetector_faces(IDataset detector_faces)` List of pairs of index in the "faces" dataset and detector id.
`DataNode`	`setDetector_facesScalar(java.lang.Long detector_faces)` List of pairs of index in the "faces" dataset and detector id.
`DataNode`	`setFaces(IDataset faces)` The start index in ``winding_order`` for each face.
`DataNode`	`setFacesScalar(java.lang.Long faces)` The start index in ``winding_order`` for each face.
`DataNode`	`setVertices(IDataset vertices)` List of x,y,z coordinates for vertices.
`DataNode`	`setVerticesScalar(java.lang.Number vertices)` List of x,y,z coordinates for vertices.
`DataNode`	`setWinding_order(IDataset winding_order)` List of indices of vertices in the ``vertices`` dataset to form each face, right-hand rule for face normal.
`DataNode`	`setWinding_orderScalar(java.lang.Long winding_order)` List of indices of vertices in the ``vertices`` dataset to form each face, right-hand rule for face normal.

Constructors
Constructor and Description
`NXoff_geometryImpl()`
`NXoff_geometryImpl(long oid)`