generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXdetector_module.html Maven / Gradle / Ivy
NXdetector_module (h5jan API)
org.eclipse.dawnsci.nexus
Interface NXdetector_module
-
- All Known Implementing Classes:
- NXdetector_moduleImpl
public interface NXdetector_module
extends NXobject
Geometry and logical description of a detector module.
Many detectors consist of multiple
smaller modules. Sometimes it is important to know the exact position of such
modules.
This is the purpose of this group. It is a child group to NXdetector.
Note, the pixel size is given as values in the array fast_pixel_direction and slow_pixel_direction.
-
-
Field Summary
-
Method Summary
All Methods Instance Methods Abstract Methods
Modifier and Type
Method and Description
IDataset
getData_origin()
A two value field which gives the index of the start of the
modules data in the
main area detector image in the underlying NXdetector module.
java.lang.Long
getData_originScalar()
A two value field which gives the index of the start of the
modules data in the
main area detector image in the underlying NXdetector module.
IDataset
getData_size()
Two values for the size of the module in pixels in each direction.
java.lang.Long
getData_sizeScalar()
Two values for the size of the module in pixels in each direction.
IDataset
getFast_pixel_direction()
Values along the direction of fastest varying pixel direction.
java.lang.String
getFast_pixel_directionAttributeDepends_on()
Points to the path of the next element in the geometry chain.
java.lang.String
getFast_pixel_directionAttributeOffset_units()
Units of the offset.
java.lang.Number
getFast_pixel_directionAttributeOffset()
A fixed offset applied before the transformation (three vector components).
java.lang.String
getFast_pixel_directionAttributeTransformation_type()
java.lang.Number
getFast_pixel_directionAttributeVector()
Three values that define the axis for this transformation
java.lang.Number
getFast_pixel_directionScalar()
Values along the direction of fastest varying pixel direction.
IDataset
getModule_offset()
Offset of the module in regards to the origin of the detector in an
arbitrary direction.
java.lang.String
getModule_offsetAttributeDepends_on()
Points to the path of the next element in the geometry chain.
java.lang.String
getModule_offsetAttributeOffset_units()
Units of the offset.
java.lang.Number
getModule_offsetAttributeOffset()
A fixed offset applied before the transformation (three vector components).
java.lang.String
getModule_offsetAttributeTransformation_type()
java.lang.Number
getModule_offsetAttributeVector()
Three values that define the axis for this transformation
java.lang.Number
getModule_offsetScalar()
Offset of the module in regards to the origin of the detector in an
arbitrary direction.
IDataset
getSlow_pixel_direction()
Values along the direction of fastest varying pixel direction.
java.lang.String
getSlow_pixel_directionAttributeDepends_on()
Points to the path of the next element in the geometry chain.
java.lang.String
getSlow_pixel_directionAttributeOffset_units()
Units of the offset.
java.lang.Number
getSlow_pixel_directionAttributeOffset()
A fixed offset applied before the transformation (three vector components).
java.lang.String
getSlow_pixel_directionAttributeTransformation_type()
java.lang.Number
getSlow_pixel_directionAttributeVector()
Three values that define the axis for this transformation
java.lang.Number
getSlow_pixel_directionScalar()
Values along the direction of fastest varying pixel direction.
DataNode
setData_origin(IDataset data_origin)
A two value field which gives the index of the start of the
modules data in the
main area detector image in the underlying NXdetector module.
DataNode
setData_originScalar(java.lang.Long data_origin)
A two value field which gives the index of the start of the
modules data in the
main area detector image in the underlying NXdetector module.
DataNode
setData_size(IDataset data_size)
Two values for the size of the module in pixels in each direction.
DataNode
setData_sizeScalar(java.lang.Long data_size)
Two values for the size of the module in pixels in each direction.
DataNode
setFast_pixel_direction(IDataset fast_pixel_direction)
Values along the direction of fastest varying pixel direction.
void
setFast_pixel_directionAttributeDepends_on(java.lang.String depends_on)
Points to the path of the next element in the geometry chain.
void
setFast_pixel_directionAttributeOffset_units(java.lang.String offset_units)
Units of the offset.
void
setFast_pixel_directionAttributeOffset(java.lang.Number offset)
A fixed offset applied before the transformation (three vector components).
void
setFast_pixel_directionAttributeTransformation_type(java.lang.String transformation_type)
void
setFast_pixel_directionAttributeVector(java.lang.Number vector)
Three values that define the axis for this transformation
DataNode
setFast_pixel_directionScalar(java.lang.Number fast_pixel_direction)
Values along the direction of fastest varying pixel direction.
DataNode
setModule_offset(IDataset module_offset)
Offset of the module in regards to the origin of the detector in an
arbitrary direction.
void
setModule_offsetAttributeDepends_on(java.lang.String depends_on)
Points to the path of the next element in the geometry chain.
void
setModule_offsetAttributeOffset_units(java.lang.String offset_units)
Units of the offset.
void
setModule_offsetAttributeOffset(java.lang.Number offset)
A fixed offset applied before the transformation (three vector components).
void
setModule_offsetAttributeTransformation_type(java.lang.String transformation_type)
void
setModule_offsetAttributeVector(java.lang.Number vector)
Three values that define the axis for this transformation
DataNode
setModule_offsetScalar(java.lang.Number module_offset)
Offset of the module in regards to the origin of the detector in an
arbitrary direction.
DataNode
setSlow_pixel_direction(IDataset slow_pixel_direction)
Values along the direction of fastest varying pixel direction.
void
setSlow_pixel_directionAttributeDepends_on(java.lang.String depends_on)
Points to the path of the next element in the geometry chain.
void
setSlow_pixel_directionAttributeOffset_units(java.lang.String offset_units)
Units of the offset.
void
setSlow_pixel_directionAttributeOffset(java.lang.Number offset)
A fixed offset applied before the transformation (three vector components).
void
setSlow_pixel_directionAttributeTransformation_type(java.lang.String transformation_type)
void
setSlow_pixel_directionAttributeVector(java.lang.Number vector)
Three values that define the axis for this transformation
DataNode
setSlow_pixel_directionScalar(java.lang.Number slow_pixel_direction)
Values along the direction of fastest varying pixel direction.
-
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
-
-
Field Detail
-
NX_DATA_ORIGIN
static final java.lang.String NX_DATA_ORIGIN
- See Also:
- Constant Field Values
-
NX_DATA_SIZE
static final java.lang.String NX_DATA_SIZE
- See Also:
- Constant Field Values
-
NX_MODULE_OFFSET
static final java.lang.String NX_MODULE_OFFSET
- See Also:
- Constant Field Values
-
NX_MODULE_OFFSET_ATTRIBUTE_TRANSFORMATION_TYPE
static final java.lang.String NX_MODULE_OFFSET_ATTRIBUTE_TRANSFORMATION_TYPE
- See Also:
- Constant Field Values
-
NX_MODULE_OFFSET_ATTRIBUTE_VECTOR
static final java.lang.String NX_MODULE_OFFSET_ATTRIBUTE_VECTOR
- See Also:
- Constant Field Values
-
NX_MODULE_OFFSET_ATTRIBUTE_OFFSET
static final java.lang.String NX_MODULE_OFFSET_ATTRIBUTE_OFFSET
- See Also:
- Constant Field Values
-
NX_MODULE_OFFSET_ATTRIBUTE_OFFSET_UNITS
static final java.lang.String NX_MODULE_OFFSET_ATTRIBUTE_OFFSET_UNITS
- See Also:
- Constant Field Values
-
NX_MODULE_OFFSET_ATTRIBUTE_DEPENDS_ON
static final java.lang.String NX_MODULE_OFFSET_ATTRIBUTE_DEPENDS_ON
- See Also:
- Constant Field Values
-
NX_FAST_PIXEL_DIRECTION
static final java.lang.String NX_FAST_PIXEL_DIRECTION
- See Also:
- Constant Field Values
-
NX_FAST_PIXEL_DIRECTION_ATTRIBUTE_TRANSFORMATION_TYPE
static final java.lang.String NX_FAST_PIXEL_DIRECTION_ATTRIBUTE_TRANSFORMATION_TYPE
- See Also:
- Constant Field Values
-
NX_FAST_PIXEL_DIRECTION_ATTRIBUTE_VECTOR
static final java.lang.String NX_FAST_PIXEL_DIRECTION_ATTRIBUTE_VECTOR
- See Also:
- Constant Field Values
-
NX_FAST_PIXEL_DIRECTION_ATTRIBUTE_OFFSET
static final java.lang.String NX_FAST_PIXEL_DIRECTION_ATTRIBUTE_OFFSET
- See Also:
- Constant Field Values
-
NX_FAST_PIXEL_DIRECTION_ATTRIBUTE_OFFSET_UNITS
static final java.lang.String NX_FAST_PIXEL_DIRECTION_ATTRIBUTE_OFFSET_UNITS
- See Also:
- Constant Field Values
-
NX_FAST_PIXEL_DIRECTION_ATTRIBUTE_DEPENDS_ON
static final java.lang.String NX_FAST_PIXEL_DIRECTION_ATTRIBUTE_DEPENDS_ON
- See Also:
- Constant Field Values
-
NX_SLOW_PIXEL_DIRECTION
static final java.lang.String NX_SLOW_PIXEL_DIRECTION
- See Also:
- Constant Field Values
-
NX_SLOW_PIXEL_DIRECTION_ATTRIBUTE_TRANSFORMATION_TYPE
static final java.lang.String NX_SLOW_PIXEL_DIRECTION_ATTRIBUTE_TRANSFORMATION_TYPE
- See Also:
- Constant Field Values
-
NX_SLOW_PIXEL_DIRECTION_ATTRIBUTE_VECTOR
static final java.lang.String NX_SLOW_PIXEL_DIRECTION_ATTRIBUTE_VECTOR
- See Also:
- Constant Field Values
-
NX_SLOW_PIXEL_DIRECTION_ATTRIBUTE_OFFSET
static final java.lang.String NX_SLOW_PIXEL_DIRECTION_ATTRIBUTE_OFFSET
- See Also:
- Constant Field Values
-
NX_SLOW_PIXEL_DIRECTION_ATTRIBUTE_OFFSET_UNITS
static final java.lang.String NX_SLOW_PIXEL_DIRECTION_ATTRIBUTE_OFFSET_UNITS
- See Also:
- Constant Field Values
-
NX_SLOW_PIXEL_DIRECTION_ATTRIBUTE_DEPENDS_ON
static final java.lang.String NX_SLOW_PIXEL_DIRECTION_ATTRIBUTE_DEPENDS_ON
- See Also:
- Constant Field Values
-
Method Detail
-
getData_origin
IDataset getData_origin()
A two value field which gives the index of the start of the
modules data in the
main area detector image in the underlying NXdetector module.
Type: NX_INT
- Returns:
- the value.
-
setData_origin
DataNode setData_origin(IDataset data_origin)
A two value field which gives the index of the start of the
modules data in the
main area detector image in the underlying NXdetector module.
Type: NX_INT
- Parameters:
data_origin
- the data_origin
-
getData_originScalar
java.lang.Long getData_originScalar()
A two value field which gives the index of the start of the
modules data in the
main area detector image in the underlying NXdetector module.
Type: NX_INT
- Returns:
- the value.
-
setData_originScalar
DataNode setData_originScalar(java.lang.Long data_origin)
A two value field which gives the index of the start of the
modules data in the
main area detector image in the underlying NXdetector module.
Type: NX_INT
- Parameters:
data_origin
- the data_origin
-
getData_size
IDataset getData_size()
Two values for the size of the module in pixels in each direction.
Type: NX_INT
- Returns:
- the value.
-
setData_size
DataNode setData_size(IDataset data_size)
Two values for the size of the module in pixels in each direction.
Type: NX_INT
- Parameters:
data_size
- the data_size
-
getData_sizeScalar
java.lang.Long getData_sizeScalar()
Two values for the size of the module in pixels in each direction.
Type: NX_INT
- Returns:
- the value.
-
setData_sizeScalar
DataNode setData_sizeScalar(java.lang.Long data_size)
Two values for the size of the module in pixels in each direction.
Type: NX_INT
- Parameters:
data_size
- the data_size
-
getModule_offset
IDataset getModule_offset()
Offset of the module in regards to the origin of the detector in an
arbitrary direction.
Units: NX_LENGTH
Type: NX_NUMBER
- Returns:
- the value.
-
setModule_offset
DataNode setModule_offset(IDataset module_offset)
Offset of the module in regards to the origin of the detector in an
arbitrary direction.
Units: NX_LENGTH
Type: NX_NUMBER
- Parameters:
module_offset
- the module_offset
-
getModule_offsetScalar
java.lang.Number getModule_offsetScalar()
Offset of the module in regards to the origin of the detector in an
arbitrary direction.
Units: NX_LENGTH
Type: NX_NUMBER
- Returns:
- the value.
-
setModule_offsetScalar
DataNode setModule_offsetScalar(java.lang.Number module_offset)
Offset of the module in regards to the origin of the detector in an
arbitrary direction.
Units: NX_LENGTH
Type: NX_NUMBER
- Parameters:
module_offset
- the module_offset
-
getModule_offsetAttributeTransformation_type
java.lang.String getModule_offsetAttributeTransformation_type()
Enumeration:
- translation
- Returns:
- the value.
-
setModule_offsetAttributeTransformation_type
void setModule_offsetAttributeTransformation_type(java.lang.String transformation_type)
Enumeration:
- translation
- Parameters:
transformation_type
- the transformation_type
-
getModule_offsetAttributeVector
java.lang.Number getModule_offsetAttributeVector()
Three values that define the axis for this transformation
- Returns:
- the value.
-
setModule_offsetAttributeVector
void setModule_offsetAttributeVector(java.lang.Number vector)
Three values that define the axis for this transformation
- Parameters:
vector
- the vector
-
getModule_offsetAttributeOffset
java.lang.Number getModule_offsetAttributeOffset()
A fixed offset applied before the transformation (three vector components).
- Returns:
- the value.
-
setModule_offsetAttributeOffset
void setModule_offsetAttributeOffset(java.lang.Number offset)
A fixed offset applied before the transformation (three vector components).
- Parameters:
offset
- the offset
-
getModule_offsetAttributeOffset_units
java.lang.String getModule_offsetAttributeOffset_units()
Units of the offset.
- Returns:
- the value.
-
setModule_offsetAttributeOffset_units
void setModule_offsetAttributeOffset_units(java.lang.String offset_units)
Units of the offset.
- Parameters:
offset_units
- the offset_units
-
getModule_offsetAttributeDepends_on
java.lang.String getModule_offsetAttributeDepends_on()
Points to the path of the next element in the geometry chain.
- Returns:
- the value.
-
setModule_offsetAttributeDepends_on
void setModule_offsetAttributeDepends_on(java.lang.String depends_on)
Points to the path of the next element in the geometry chain.
- Parameters:
depends_on
- the depends_on
-
getFast_pixel_direction
IDataset getFast_pixel_direction()
Values along the direction of fastest varying pixel direction. Each value in this
array is the size of a pixel in the units specified. Alternatively, if only one
value is given, all pixels in this direction have the same value. The direction
itself is given through the vector attribute.
Units: NX_LENGTH
Type: NX_NUMBER
- Returns:
- the value.
-
setFast_pixel_direction
DataNode setFast_pixel_direction(IDataset fast_pixel_direction)
Values along the direction of fastest varying pixel direction. Each value in this
array is the size of a pixel in the units specified. Alternatively, if only one
value is given, all pixels in this direction have the same value. The direction
itself is given through the vector attribute.
Units: NX_LENGTH
Type: NX_NUMBER
- Parameters:
fast_pixel_direction
- the fast_pixel_direction
-
getFast_pixel_directionScalar
java.lang.Number getFast_pixel_directionScalar()
Values along the direction of fastest varying pixel direction. Each value in this
array is the size of a pixel in the units specified. Alternatively, if only one
value is given, all pixels in this direction have the same value. The direction
itself is given through the vector attribute.
Units: NX_LENGTH
Type: NX_NUMBER
- Returns:
- the value.
-
setFast_pixel_directionScalar
DataNode setFast_pixel_directionScalar(java.lang.Number fast_pixel_direction)
Values along the direction of fastest varying pixel direction. Each value in this
array is the size of a pixel in the units specified. Alternatively, if only one
value is given, all pixels in this direction have the same value. The direction
itself is given through the vector attribute.
Units: NX_LENGTH
Type: NX_NUMBER
- Parameters:
fast_pixel_direction
- the fast_pixel_direction
-
getFast_pixel_directionAttributeTransformation_type
java.lang.String getFast_pixel_directionAttributeTransformation_type()
Enumeration:
- translation
- Returns:
- the value.
-
setFast_pixel_directionAttributeTransformation_type
void setFast_pixel_directionAttributeTransformation_type(java.lang.String transformation_type)
Enumeration:
- translation
- Parameters:
transformation_type
- the transformation_type
-
getFast_pixel_directionAttributeVector
java.lang.Number getFast_pixel_directionAttributeVector()
Three values that define the axis for this transformation
- Returns:
- the value.
-
setFast_pixel_directionAttributeVector
void setFast_pixel_directionAttributeVector(java.lang.Number vector)
Three values that define the axis for this transformation
- Parameters:
vector
- the vector
-
getFast_pixel_directionAttributeOffset
java.lang.Number getFast_pixel_directionAttributeOffset()
A fixed offset applied before the transformation (three vector components).
- Returns:
- the value.
-
setFast_pixel_directionAttributeOffset
void setFast_pixel_directionAttributeOffset(java.lang.Number offset)
A fixed offset applied before the transformation (three vector components).
- Parameters:
offset
- the offset
-
getFast_pixel_directionAttributeOffset_units
java.lang.String getFast_pixel_directionAttributeOffset_units()
Units of the offset.
- Returns:
- the value.
-
setFast_pixel_directionAttributeOffset_units
void setFast_pixel_directionAttributeOffset_units(java.lang.String offset_units)
Units of the offset.
- Parameters:
offset_units
- the offset_units
-
getFast_pixel_directionAttributeDepends_on
java.lang.String getFast_pixel_directionAttributeDepends_on()
Points to the path of the next element in the geometry chain.
- Returns:
- the value.
-
setFast_pixel_directionAttributeDepends_on
void setFast_pixel_directionAttributeDepends_on(java.lang.String depends_on)
Points to the path of the next element in the geometry chain.
- Parameters:
depends_on
- the depends_on
-
getSlow_pixel_direction
IDataset getSlow_pixel_direction()
Values along the direction of fastest varying pixel direction. Each value in this
array is the size of a pixel in the units specified. Alternatively, if only one
value is given, all pixels in this direction have the same value. The direction
itself is given through the vector attribute.
Type: NX_NUMBER
Units: NX_LENGTH
- Returns:
- the value.
-
setSlow_pixel_direction
DataNode setSlow_pixel_direction(IDataset slow_pixel_direction)
Values along the direction of fastest varying pixel direction. Each value in this
array is the size of a pixel in the units specified. Alternatively, if only one
value is given, all pixels in this direction have the same value. The direction
itself is given through the vector attribute.
Type: NX_NUMBER
Units: NX_LENGTH
- Parameters:
slow_pixel_direction
- the slow_pixel_direction
-
getSlow_pixel_directionScalar
java.lang.Number getSlow_pixel_directionScalar()
Values along the direction of fastest varying pixel direction. Each value in this
array is the size of a pixel in the units specified. Alternatively, if only one
value is given, all pixels in this direction have the same value. The direction
itself is given through the vector attribute.
Type: NX_NUMBER
Units: NX_LENGTH
- Returns:
- the value.
-
setSlow_pixel_directionScalar
DataNode setSlow_pixel_directionScalar(java.lang.Number slow_pixel_direction)
Values along the direction of fastest varying pixel direction. Each value in this
array is the size of a pixel in the units specified. Alternatively, if only one
value is given, all pixels in this direction have the same value. The direction
itself is given through the vector attribute.
Type: NX_NUMBER
Units: NX_LENGTH
- Parameters:
slow_pixel_direction
- the slow_pixel_direction
-
getSlow_pixel_directionAttributeTransformation_type
java.lang.String getSlow_pixel_directionAttributeTransformation_type()
Enumeration:
- translation
- Returns:
- the value.
-
setSlow_pixel_directionAttributeTransformation_type
void setSlow_pixel_directionAttributeTransformation_type(java.lang.String transformation_type)
Enumeration:
- translation
- Parameters:
transformation_type
- the transformation_type
-
getSlow_pixel_directionAttributeVector
java.lang.Number getSlow_pixel_directionAttributeVector()
Three values that define the axis for this transformation
- Returns:
- the value.
-
setSlow_pixel_directionAttributeVector
void setSlow_pixel_directionAttributeVector(java.lang.Number vector)
Three values that define the axis for this transformation
- Parameters:
vector
- the vector
-
getSlow_pixel_directionAttributeOffset
java.lang.Number getSlow_pixel_directionAttributeOffset()
A fixed offset applied before the transformation (three vector components).
- Returns:
- the value.
-
setSlow_pixel_directionAttributeOffset
void setSlow_pixel_directionAttributeOffset(java.lang.Number offset)
A fixed offset applied before the transformation (three vector components).
- Parameters:
offset
- the offset
-
getSlow_pixel_directionAttributeOffset_units
java.lang.String getSlow_pixel_directionAttributeOffset_units()
Units of the offset.
- Returns:
- the value.
-
setSlow_pixel_directionAttributeOffset_units
void setSlow_pixel_directionAttributeOffset_units(java.lang.String offset_units)
Units of the offset.
- Parameters:
offset_units
- the offset_units
-
getSlow_pixel_directionAttributeDepends_on
java.lang.String getSlow_pixel_directionAttributeDepends_on()
Points to the path of the next element in the geometry chain.
- Returns:
- the value.
-
setSlow_pixel_directionAttributeDepends_on
void setSlow_pixel_directionAttributeDepends_on(java.lang.String depends_on)
Points to the path of the next element in the geometry chain.
- Parameters:
depends_on
- the depends_on