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






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






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


All Known Implementing Classes:
NXpinholeImpl




public interface NXpinhole
extends NXobject
A simple pinhole.
 For more complex geometries, :ref:`NXaperture` should be used.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DEPENDS_ON 


static java.lang.String
NX_DIAMETER 






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
getDepends_on()
Points to the path of the last element in the geometry chain that places
 this object in space.



java.lang.String
getDepends_onScalar()
Points to the path of the last element in the geometry chain that places
 this object in space.



IDataset
getDiameter()
Size of the circular hole defining the transmitted beam size.



java.lang.Number
getDiameterScalar()
Size of the circular hole defining the transmitted beam size.



DataNode
setDepends_on(IDataset depends_on)
Points to the path of the last element in the geometry chain that places
 this object in space.



DataNode
setDepends_onScalar(java.lang.String depends_on)
Points to the path of the last element in the geometry chain that places
 this object in space.



DataNode
setDiameter(IDataset diameter)
Size of the circular hole defining the transmitted beam size.



DataNode
setDiameterScalar(java.lang.Number diameter)
Size of the circular hole defining the transmitted beam size.







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_DEPENDS_ON
static final java.lang.String NX_DEPENDS_ON

See Also:
Constant Field Values








NX_DIAMETER
static final java.lang.String NX_DIAMETER

See Also:
Constant Field Values










Method Detail





getDepends_on
IDataset getDepends_on()
Points to the path of the last element in the geometry chain that places
 this object in space.
 When followed through that chain is supposed to end at an element depending
 on "." i.e. the origin of the coordinate system.
 If desired the location of the slit can also be described relative to
 an NXbeam, which will allow a simple description of a non-centred pinhole.
 
 Type: NX_CHAR
 

Returns:
the value.








setDepends_on
DataNode setDepends_on(IDataset depends_on)
Points to the path of the last element in the geometry chain that places
 this object in space.
 When followed through that chain is supposed to end at an element depending
 on "." i.e. the origin of the coordinate system.
 If desired the location of the slit can also be described relative to
 an NXbeam, which will allow a simple description of a non-centred pinhole.
 
 Type: NX_CHAR
 

Parameters:
depends_on - the depends_on








getDepends_onScalar
java.lang.String getDepends_onScalar()
Points to the path of the last element in the geometry chain that places
 this object in space.
 When followed through that chain is supposed to end at an element depending
 on "." i.e. the origin of the coordinate system.
 If desired the location of the slit can also be described relative to
 an NXbeam, which will allow a simple description of a non-centred pinhole.
 
 Type: NX_CHAR
 

Returns:
the value.








setDepends_onScalar
DataNode setDepends_onScalar(java.lang.String depends_on)
Points to the path of the last element in the geometry chain that places
 this object in space.
 When followed through that chain is supposed to end at an element depending
 on "." i.e. the origin of the coordinate system.
 If desired the location of the slit can also be described relative to
 an NXbeam, which will allow a simple description of a non-centred pinhole.
 
 Type: NX_CHAR
 

Parameters:
depends_on - the depends_on








getDiameter
IDataset getDiameter()
Size of the circular hole defining the transmitted beam size.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Returns:
the value.








setDiameter
DataNode setDiameter(IDataset diameter)
Size of the circular hole defining the transmitted beam size.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Parameters:
diameter - the diameter








getDiameterScalar
java.lang.Number getDiameterScalar()
Size of the circular hole defining the transmitted beam size.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Returns:
the value.








setDiameterScalar
DataNode setDiameterScalar(java.lang.Number diameter)
Size of the circular hole defining the transmitted beam size.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Parameters:
diameter - the diameter














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_DEPENDS_ON`
`static java.lang.String`	`NX_DIAMETER`

Modifier and Type	Method and Description
`IDataset`	`getDepends_on()` Points to the path of the last element in the geometry chain that places this object in space.
`java.lang.String`	`getDepends_onScalar()` Points to the path of the last element in the geometry chain that places this object in space.
`IDataset`	`getDiameter()` Size of the circular hole defining the transmitted beam size.
`java.lang.Number`	`getDiameterScalar()` Size of the circular hole defining the transmitted beam size.
`DataNode`	`setDepends_on(IDataset depends_on)` Points to the path of the last element in the geometry chain that places this object in space.
`DataNode`	`setDepends_onScalar(java.lang.String depends_on)` Points to the path of the last element in the geometry chain that places this object in space.
`DataNode`	`setDiameter(IDataset diameter)` Size of the circular hole defining the transmitted beam size.
`DataNode`	`setDiameterScalar(java.lang.Number diameter)` Size of the circular hole defining the transmitted beam size.