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






NXcylindrical_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 NXcylindrical_geometry






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


All Known Implementing Classes:
NXcylindrical_geometryImpl




public interface NXcylindrical_geometry
extends NXobject
Geometry description for cylindrical shapes.
 This class can be used in place of ``NXoff_geometry`` when an exact
 representation for cylinders is preferred.
 For example, for Helium-tube, neutron detectors.
 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 required to define all cylinders in the shape
 j 
 number of cylinders in the shape
 k 
 number cylinders which are detectors












Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_CYLINDERS 


static java.lang.String
NX_DETECTOR_NUMBER 


static java.lang.String
NX_VERTICES 






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
getCylinders()
List of indices of vertices in the ``vertices`` dataset to form each cylinder.



java.lang.Long
getCylindersScalar()
List of indices of vertices in the ``vertices`` dataset to form each cylinder.



IDataset
getDetector_number()
Maps cylinders in ``cylinder``, by index, with a detector id.



java.lang.Long
getDetector_numberScalar()
Maps cylinders in ``cylinder``, by index, with a detector id.



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



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



DataNode
setCylinders(IDataset cylinders)
List of indices of vertices in the ``vertices`` dataset to form each cylinder.



DataNode
setCylindersScalar(java.lang.Long cylinders)
List of indices of vertices in the ``vertices`` dataset to form each cylinder.



DataNode
setDetector_number(IDataset detector_number)
Maps cylinders in ``cylinder``, by index, with a detector id.



DataNode
setDetector_numberScalar(java.lang.Long detector_number)
Maps cylinders in ``cylinder``, by index, with a detector id.



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.







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_CYLINDERS
static final java.lang.String NX_CYLINDERS

See Also:
Constant Field Values








NX_DETECTOR_NUMBER
static final java.lang.String NX_DETECTOR_NUMBER

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








getCylinders
IDataset getCylinders()
List of indices of vertices in the ``vertices`` dataset to form each cylinder.
 Each cylinder is described by three vertices A, B, C.
 First vertex A lies on the cylinder axis and circular face, second point B
 on edge of the same face as A, and third point C at the other face and on axis.
 
 Type: NX_INT
 Dimensions: 1: j; 2: 3;
 

Returns:
the value.








setCylinders
DataNode setCylinders(IDataset cylinders)
List of indices of vertices in the ``vertices`` dataset to form each cylinder.
 Each cylinder is described by three vertices A, B, C.
 First vertex A lies on the cylinder axis and circular face, second point B
 on edge of the same face as A, and third point C at the other face and on axis.
 
 Type: NX_INT
 Dimensions: 1: j; 2: 3;
 

Parameters:
cylinders - the cylinders








getCylindersScalar
java.lang.Long getCylindersScalar()
List of indices of vertices in the ``vertices`` dataset to form each cylinder.
 Each cylinder is described by three vertices A, B, C.
 First vertex A lies on the cylinder axis and circular face, second point B
 on edge of the same face as A, and third point C at the other face and on axis.
 
 Type: NX_INT
 Dimensions: 1: j; 2: 3;
 

Returns:
the value.








setCylindersScalar
DataNode setCylindersScalar(java.lang.Long cylinders)
List of indices of vertices in the ``vertices`` dataset to form each cylinder.
 Each cylinder is described by three vertices A, B, C.
 First vertex A lies on the cylinder axis and circular face, second point B
 on edge of the same face as A, and third point C at the other face and on axis.
 
 Type: NX_INT
 Dimensions: 1: j; 2: 3;
 

Parameters:
cylinders - the cylinders








getDetector_number
IDataset getDetector_number()
Maps cylinders in ``cylinder``, by index, with a detector id.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Returns:
the value.








setDetector_number
DataNode setDetector_number(IDataset detector_number)
Maps cylinders in ``cylinder``, by index, with a detector id.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Parameters:
detector_number - the detector_number








getDetector_numberScalar
java.lang.Long getDetector_numberScalar()
Maps cylinders in ``cylinder``, by index, with a detector id.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Returns:
the value.








setDetector_numberScalar
DataNode setDetector_numberScalar(java.lang.Long detector_number)
Maps cylinders in ``cylinder``, by index, with a detector id.
 
 Type: NX_INT
 Dimensions: 1: k;
 

Parameters:
detector_number - the detector_number














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_CYLINDERS`
`static java.lang.String`	`NX_DETECTOR_NUMBER`
`static java.lang.String`	`NX_VERTICES`

Modifier and Type	Method and Description
`IDataset`	`getCylinders()` List of indices of vertices in the ``vertices`` dataset to form each cylinder.
`java.lang.Long`	`getCylindersScalar()` List of indices of vertices in the ``vertices`` dataset to form each cylinder.
`IDataset`	`getDetector_number()` Maps cylinders in ``cylinder``, by index, with a detector id.
`java.lang.Long`	`getDetector_numberScalar()` Maps cylinders in ``cylinder``, by index, with a detector id.
`IDataset`	`getVertices()` List of x,y,z coordinates for vertices.
`java.lang.Number`	`getVerticesScalar()` List of x,y,z coordinates for vertices.
`DataNode`	`setCylinders(IDataset cylinders)` List of indices of vertices in the ``vertices`` dataset to form each cylinder.
`DataNode`	`setCylindersScalar(java.lang.Long cylinders)` List of indices of vertices in the ``vertices`` dataset to form each cylinder.
`DataNode`	`setDetector_number(IDataset detector_number)` Maps cylinders in ``cylinder``, by index, with a detector id.
`DataNode`	`setDetector_numberScalar(java.lang.Long detector_number)` Maps cylinders in ``cylinder``, by index, with a detector id.
`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.