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






NXoff_geometry (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 NXoff_geometry






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


All Known Implementing Classes:
NXoff_geometryImpl




public interface NXoff_geometry
extends NXobject
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.
 Symbols: 
 These symbols will be used below.

 i 
 number of vertices in the shape
 k 
 number of faces in the shape
 l 
 number faces which are detecting surfaces or form the boundary of
 detecting volumes












Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DETECTOR_FACES 


static java.lang.String
NX_FACES 


static java.lang.String
NX_VERTICES 


static java.lang.String
NX_WINDING_ORDER 






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



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 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_VERTICES
static final java.lang.String NX_VERTICES

See Also:
Constant Field Values








NX_WINDING_ORDER
static final java.lang.String NX_WINDING_ORDER

See Also:
Constant Field Values








NX_FACES
static final java.lang.String NX_FACES

See Also:
Constant Field Values








NX_DETECTOR_FACES
static final java.lang.String NX_DETECTOR_FACES

See Also:
Constant Field Values










Method Detail





getVertices
IDataset getVertices()
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;
 

Returns:
the value.








setVertices
DataNode setVertices(IDataset vertices)
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;
 

Parameters:
vertices - the vertices








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

Returns:
the value.








setVerticesScalar
DataNode setVerticesScalar(java.lang.Number vertices)
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;
 

Parameters:
vertices - the vertices








getWinding_order
IDataset getWinding_order()
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;
 

Returns:
the value.








setWinding_order
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.
 
 Type: NX_INT
 Dimensions: 1: j;
 

Parameters:
winding_order - the winding_order








getWinding_orderScalar
java.lang.Long getWinding_orderScalar()
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;
 

Returns:
the value.








setWinding_orderScalar
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.
 
 Type: NX_INT
 Dimensions: 1: j;
 

Parameters:
winding_order - the winding_order








getFaces
IDataset getFaces()
The start index in ``winding_order`` for each face.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Returns:
the value.








setFaces
DataNode setFaces(IDataset faces)
The start index in ``winding_order`` for each face.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Parameters:
faces - the faces








getFacesScalar
java.lang.Long getFacesScalar()
The start index in ``winding_order`` for each face.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Returns:
the value.








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

Parameters:
faces - the faces








getDetector_faces
IDataset getDetector_faces()
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;
 

Returns:
the value.








setDetector_faces
DataNode setDetector_faces(IDataset detector_faces)
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;
 

Parameters:
detector_faces - the detector_faces








getDetector_facesScalar
java.lang.Long getDetector_facesScalar()
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;
 

Returns:
the value.








setDetector_facesScalar
DataNode setDetector_facesScalar(java.lang.Long detector_faces)
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;
 

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	Field and Description
`static java.lang.String`	`NX_DETECTOR_FACES`
`static java.lang.String`	`NX_FACES`
`static java.lang.String`	`NX_VERTICES`
`static java.lang.String`	`NX_WINDING_ORDER`

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