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






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













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




public class NXcylindrical_geometryImpl
extends NXobjectImpl
implements NXcylindrical_geometry
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.

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.NXcylindrical_geometry
NX_CYLINDERS, NX_DETECTOR_NUMBER, NX_VERTICES





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








Constructor Summary

Constructors 

Constructor and Description


NXcylindrical_geometryImpl() 


NXcylindrical_geometryImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete 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.



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.



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





NXcylindrical_geometryImpl
public NXcylindrical_geometryImpl()







NXcylindrical_geometryImpl
public NXcylindrical_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: NXcylindrical_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 NXcylindrical_geometry
Returns:
the value.








getVerticesScalar
public java.lang.Number getVerticesScalar()
Description copied from interface: NXcylindrical_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 NXcylindrical_geometry
Returns:
the value.








setVertices
public DataNode setVertices(IDataset vertices)
Description copied from interface: NXcylindrical_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 NXcylindrical_geometry
Parameters:
vertices - the vertices








setVerticesScalar
public DataNode setVerticesScalar(java.lang.Number vertices)
Description copied from interface: NXcylindrical_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 NXcylindrical_geometry
Parameters:
vertices - the vertices








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

Specified by:
getCylinders in interface NXcylindrical_geometry
Returns:
the value.








getCylindersScalar
public java.lang.Long getCylindersScalar()
Description copied from interface: NXcylindrical_geometry
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;
 

Specified by:
getCylindersScalar in interface NXcylindrical_geometry
Returns:
the value.








setCylinders
public DataNode setCylinders(IDataset cylinders)
Description copied from interface: NXcylindrical_geometry
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;
 

Specified by:
setCylinders in interface NXcylindrical_geometry
Parameters:
cylinders - the cylinders








setCylindersScalar
public DataNode setCylindersScalar(java.lang.Long cylinders)
Description copied from interface: NXcylindrical_geometry
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;
 

Specified by:
setCylindersScalar in interface NXcylindrical_geometry
Parameters:
cylinders - the cylinders








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

Specified by:
getDetector_number in interface NXcylindrical_geometry
Returns:
the value.








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

Specified by:
getDetector_numberScalar in interface NXcylindrical_geometry
Returns:
the value.








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

Specified by:
setDetector_number in interface NXcylindrical_geometry
Parameters:
detector_number - the detector_number








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

Specified by:
setDetector_numberScalar in interface NXcylindrical_geometry
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	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.
`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.
`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.

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