• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXcollimator.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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 NXcollimator






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


All Known Implementing Classes:
NXcollimatorImpl




public interface NXcollimator
extends NXobject
A beamline collimator.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_ABSORBING_MATERIAL 


static java.lang.String
NX_BLADE_SPACING 


static java.lang.String
NX_BLADE_THICKNESS 


static java.lang.String
NX_DIVERGENCE_X 


static java.lang.String
NX_DIVERGENCE_Y 


static java.lang.String
NX_FREQUENCY 


static java.lang.String
NX_SOLLER_ANGLE 


static java.lang.String
NX_TRANSMITTING_MATERIAL 


static java.lang.String
NX_TYPE 






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
getAbsorbing_material()
name of absorbing material



java.lang.String
getAbsorbing_materialScalar()
name of absorbing material



java.util.Map<java.lang.String,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
 
 
 position, shape and size
 



IDataset
getBlade_spacing()
blade spacing



java.lang.Double
getBlade_spacingScalar()
blade spacing



IDataset
getBlade_thickness()
blade thickness



java.lang.Double
getBlade_thicknessScalar()
blade thickness



IDataset
getDivergence_x()
divergence of collimator in local x direction



java.lang.Double
getDivergence_xScalar()
divergence of collimator in local x direction



IDataset
getDivergence_y()
divergence of collimator in local y direction



java.lang.Double
getDivergence_yScalar()
divergence of collimator in local y direction



NXlog
getFrequency_log()
Log of frequency



IDataset
getFrequency()
Frequency of oscillating collimator



java.lang.Double
getFrequencyScalar()
Frequency of oscillating collimator



NXgeometry
getGeometry()
position, shape and size



NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 position, shape and size
 



IDataset
getSoller_angle()
Angular divergence of Soller collimator



java.lang.Double
getSoller_angleScalar()
Angular divergence of Soller collimator



IDataset
getTransmitting_material()
name of transmitting material



java.lang.String
getTransmitting_materialScalar()
name of transmitting material



IDataset
getType()


java.lang.String
getTypeScalar()


DataNode
setAbsorbing_material(IDataset absorbing_material)
name of absorbing material



DataNode
setAbsorbing_materialScalar(java.lang.String absorbing_material)
name of absorbing material



void
setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.



DataNode
setBlade_spacing(IDataset blade_spacing)
blade spacing



DataNode
setBlade_spacingScalar(java.lang.Double blade_spacing)
blade spacing



DataNode
setBlade_thickness(IDataset blade_thickness)
blade thickness



DataNode
setBlade_thicknessScalar(java.lang.Double blade_thickness)
blade thickness



DataNode
setDivergence_x(IDataset divergence_x)
divergence of collimator in local x direction



DataNode
setDivergence_xScalar(java.lang.Double divergence_x)
divergence of collimator in local x direction



DataNode
setDivergence_y(IDataset divergence_y)
divergence of collimator in local y direction



DataNode
setDivergence_yScalar(java.lang.Double divergence_y)
divergence of collimator in local y direction



void
setFrequency_log(NXlog frequency_log)
Log of frequency



DataNode
setFrequency(IDataset frequency)
Frequency of oscillating collimator



DataNode
setFrequencyScalar(java.lang.Double frequency)
Frequency of oscillating collimator



void
setGeometry(NXgeometry geometry)
position, shape and size



void
setGeometry(java.lang.String name,
           NXgeometry geometry)
Set a NXgeometry node by name:
 
 
 position, shape and size
 



DataNode
setSoller_angle(IDataset soller_angle)
Angular divergence of Soller collimator



DataNode
setSoller_angleScalar(java.lang.Double soller_angle)
Angular divergence of Soller collimator



DataNode
setTransmitting_material(IDataset transmitting_material)
name of transmitting material



DataNode
setTransmitting_materialScalar(java.lang.String transmitting_material)
name of transmitting material



DataNode
setType(IDataset type)


DataNode
setTypeScalar(java.lang.String type)






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_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_SOLLER_ANGLE
static final java.lang.String NX_SOLLER_ANGLE

See Also:
Constant Field Values








NX_DIVERGENCE_X
static final java.lang.String NX_DIVERGENCE_X

See Also:
Constant Field Values








NX_DIVERGENCE_Y
static final java.lang.String NX_DIVERGENCE_Y

See Also:
Constant Field Values








NX_FREQUENCY
static final java.lang.String NX_FREQUENCY

See Also:
Constant Field Values








NX_BLADE_THICKNESS
static final java.lang.String NX_BLADE_THICKNESS

See Also:
Constant Field Values








NX_BLADE_SPACING
static final java.lang.String NX_BLADE_SPACING

See Also:
Constant Field Values








NX_ABSORBING_MATERIAL
static final java.lang.String NX_ABSORBING_MATERIAL

See Also:
Constant Field Values








NX_TRANSMITTING_MATERIAL
static final java.lang.String NX_TRANSMITTING_MATERIAL

See Also:
Constant Field Values










Method Detail





getGeometry
NXgeometry getGeometry()
position, shape and size

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)
position, shape and size

Parameters:
geometry - the geometry








getGeometry
NXgeometry getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 

 

 position, shape and size
 

Parameters:
name - the name of the node.
Returns:
a map from node names to the NXgeometry for that node.








setGeometry
void setGeometry(java.lang.String name,
                 NXgeometry geometry)
Set a NXgeometry node by name:
 

 

 position, shape and size
 

Parameters:
name - the name of the node
geometry - the value to set








getAllGeometry
java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Get all NXgeometry nodes:
 

 

 position, shape and size
 

Returns:
a map from node names to the NXgeometry for that node.








setAllGeometry
void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.
 

 

 position, shape and size
 

Parameters:
geometry - the child nodes to add








getType
IDataset getType()

 
Enumeration:

 
Soller 
 
radial 
 
oscillating 
 
honeycomb 

 


Returns:
the value.








setType
DataNode setType(IDataset type)

 
Enumeration:

 
Soller 
 
radial 
 
oscillating 
 
honeycomb 

 


Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()

 
Enumeration:

 
Soller 
 
radial 
 
oscillating 
 
honeycomb 

 


Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)

 
Enumeration:

 
Soller 
 
radial 
 
oscillating 
 
honeycomb 

 


Parameters:
type - the type








getSoller_angle
IDataset getSoller_angle()
Angular divergence of Soller collimator
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setSoller_angle
DataNode setSoller_angle(IDataset soller_angle)
Angular divergence of Soller collimator
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
soller_angle - the soller_angle








getSoller_angleScalar
java.lang.Double getSoller_angleScalar()
Angular divergence of Soller collimator
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setSoller_angleScalar
DataNode setSoller_angleScalar(java.lang.Double soller_angle)
Angular divergence of Soller collimator
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
soller_angle - the soller_angle








getDivergence_x
IDataset getDivergence_x()
divergence of collimator in local x direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setDivergence_x
DataNode setDivergence_x(IDataset divergence_x)
divergence of collimator in local x direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
divergence_x - the divergence_x








getDivergence_xScalar
java.lang.Double getDivergence_xScalar()
divergence of collimator in local x direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setDivergence_xScalar
DataNode setDivergence_xScalar(java.lang.Double divergence_x)
divergence of collimator in local x direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
divergence_x - the divergence_x








getDivergence_y
IDataset getDivergence_y()
divergence of collimator in local y direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setDivergence_y
DataNode setDivergence_y(IDataset divergence_y)
divergence of collimator in local y direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
divergence_y - the divergence_y








getDivergence_yScalar
java.lang.Double getDivergence_yScalar()
divergence of collimator in local y direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setDivergence_yScalar
DataNode setDivergence_yScalar(java.lang.Double divergence_y)
divergence of collimator in local y direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
divergence_y - the divergence_y








getFrequency
IDataset getFrequency()
Frequency of oscillating collimator
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Returns:
the value.








setFrequency
DataNode setFrequency(IDataset frequency)
Frequency of oscillating collimator
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Parameters:
frequency - the frequency








getFrequencyScalar
java.lang.Double getFrequencyScalar()
Frequency of oscillating collimator
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Returns:
the value.








setFrequencyScalar
DataNode setFrequencyScalar(java.lang.Double frequency)
Frequency of oscillating collimator
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Parameters:
frequency - the frequency








getFrequency_log
NXlog getFrequency_log()
Log of frequency

Returns:
the value.








setFrequency_log
void setFrequency_log(NXlog frequency_log)
Log of frequency

Parameters:
frequency_log - the frequency_log








getBlade_thickness
IDataset getBlade_thickness()
blade thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setBlade_thickness
DataNode setBlade_thickness(IDataset blade_thickness)
blade thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
blade_thickness - the blade_thickness








getBlade_thicknessScalar
java.lang.Double getBlade_thicknessScalar()
blade thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setBlade_thicknessScalar
DataNode setBlade_thicknessScalar(java.lang.Double blade_thickness)
blade thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
blade_thickness - the blade_thickness








getBlade_spacing
IDataset getBlade_spacing()
blade spacing
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setBlade_spacing
DataNode setBlade_spacing(IDataset blade_spacing)
blade spacing
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
blade_spacing - the blade_spacing








getBlade_spacingScalar
java.lang.Double getBlade_spacingScalar()
blade spacing
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setBlade_spacingScalar
DataNode setBlade_spacingScalar(java.lang.Double blade_spacing)
blade spacing
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
blade_spacing - the blade_spacing








getAbsorbing_material
IDataset getAbsorbing_material()
name of absorbing material

Returns:
the value.








setAbsorbing_material
DataNode setAbsorbing_material(IDataset absorbing_material)
name of absorbing material

Parameters:
absorbing_material - the absorbing_material








getAbsorbing_materialScalar
java.lang.String getAbsorbing_materialScalar()
name of absorbing material

Returns:
the value.








setAbsorbing_materialScalar
DataNode setAbsorbing_materialScalar(java.lang.String absorbing_material)
name of absorbing material

Parameters:
absorbing_material - the absorbing_material








getTransmitting_material
IDataset getTransmitting_material()
name of transmitting material

Returns:
the value.








setTransmitting_material
DataNode setTransmitting_material(IDataset transmitting_material)
name of transmitting material

Parameters:
transmitting_material - the transmitting_material








getTransmitting_materialScalar
java.lang.String getTransmitting_materialScalar()
name of transmitting material

Returns:
the value.








setTransmitting_materialScalar
DataNode setTransmitting_materialScalar(java.lang.String transmitting_material)
name of transmitting material

Parameters:
transmitting_material - the transmitting_material














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