generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXbending_magnet.html Maven / Gradle / Ivy
NXbending_magnet (h5jan API)
org.eclipse.dawnsci.nexus
Interface NXbending_magnet
-
-
Field Summary
Fields
Modifier and Type
Field and Description
static java.lang.String
NX_ACCEPTED_PHOTON_BEAM_DIVERGENCE
static java.lang.String
NX_BENDING_RADIUS
static java.lang.String
NX_CRITICAL_ENERGY
static java.lang.String
NX_DIVERGENCE_X_MINUS
static java.lang.String
NX_DIVERGENCE_X_PLUS
static java.lang.String
NX_DIVERGENCE_Y_MINUS
static java.lang.String
NX_DIVERGENCE_Y_PLUS
static java.lang.String
NX_MAGNETIC_FIELD
static java.lang.String
NX_SOURCE_DISTANCE_X
static java.lang.String
NX_SOURCE_DISTANCE_Y
-
Method Summary
All Methods Instance Methods Abstract Methods
Modifier and Type
Method and Description
IDataset
getAccepted_photon_beam_divergence()
An array of four numbers giving X+, X-, Y+ and Y- half divergence
java.lang.Double
getAccepted_photon_beam_divergenceScalar()
An array of four numbers giving X+, X-, Y+ and Y- half divergence
java.util.Map<java.lang.String,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
"Engineering" position of bending magnet
IDataset
getBending_radius()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getBending_radiusScalar()
Type: NX_FLOAT
Units: NX_LENGTH
IDataset
getCritical_energy()
Type: NX_FLOAT
Units: NX_ENERGY
java.lang.Double
getCritical_energyScalar()
Type: NX_FLOAT
Units: NX_ENERGY
IDataset
getDivergence_x_minus()
Accepted photon beam divergence in X- (horizontal inboard) direction.
java.lang.Double
getDivergence_x_minusScalar()
Accepted photon beam divergence in X- (horizontal inboard) direction.
IDataset
getDivergence_x_plus()
Accepted photon beam divergence in X+ (horizontal outboard) direction.
java.lang.Double
getDivergence_x_plusScalar()
Accepted photon beam divergence in X+ (horizontal outboard) direction.
IDataset
getDivergence_y_minus()
Accepted photon beam divergence in Y- (vertical downward) direction.
java.lang.Double
getDivergence_y_minusScalar()
Accepted photon beam divergence in Y- (vertical downward) direction.
IDataset
getDivergence_y_plus()
Accepted photon beam divergence in Y+ (vertical upward) direction.
java.lang.Double
getDivergence_y_plusScalar()
Accepted photon beam divergence in Y+ (vertical upward) direction.
NXgeometry
getGeometry()
"Engineering" position of bending magnet
NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
"Engineering" position of bending magnet
IDataset
getMagnetic_field()
strength of magnetic field of dipole magnets
java.lang.Double
getMagnetic_fieldScalar()
strength of magnetic field of dipole magnets
IDataset
getSource_distance_x()
Distance of source point from particle beam waist in X (horizontal) direction.
java.lang.Double
getSource_distance_xScalar()
Distance of source point from particle beam waist in X (horizontal) direction.
IDataset
getSource_distance_y()
Distance of source point from particle beam waist in Y (vertical) direction.
java.lang.Double
getSource_distance_yScalar()
Distance of source point from particle beam waist in Y (vertical) direction.
NXdata
getSpectrum()
bending magnet spectrum
DataNode
setAccepted_photon_beam_divergence(IDataset accepted_photon_beam_divergence)
An array of four numbers giving X+, X-, Y+ and Y- half divergence
DataNode
setAccepted_photon_beam_divergenceScalar(java.lang.Double accepted_photon_beam_divergence)
An array of four numbers giving X+, X-, Y+ and Y- half divergence
void
setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.
DataNode
setBending_radius(IDataset bending_radius)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setBending_radiusScalar(java.lang.Double bending_radius)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setCritical_energy(IDataset critical_energy)
Type: NX_FLOAT
Units: NX_ENERGY
DataNode
setCritical_energyScalar(java.lang.Double critical_energy)
Type: NX_FLOAT
Units: NX_ENERGY
DataNode
setDivergence_x_minus(IDataset divergence_x_minus)
Accepted photon beam divergence in X- (horizontal inboard) direction.
DataNode
setDivergence_x_minusScalar(java.lang.Double divergence_x_minus)
Accepted photon beam divergence in X- (horizontal inboard) direction.
DataNode
setDivergence_x_plus(IDataset divergence_x_plus)
Accepted photon beam divergence in X+ (horizontal outboard) direction.
DataNode
setDivergence_x_plusScalar(java.lang.Double divergence_x_plus)
Accepted photon beam divergence in X+ (horizontal outboard) direction.
DataNode
setDivergence_y_minus(IDataset divergence_y_minus)
Accepted photon beam divergence in Y- (vertical downward) direction.
DataNode
setDivergence_y_minusScalar(java.lang.Double divergence_y_minus)
Accepted photon beam divergence in Y- (vertical downward) direction.
DataNode
setDivergence_y_plus(IDataset divergence_y_plus)
Accepted photon beam divergence in Y+ (vertical upward) direction.
DataNode
setDivergence_y_plusScalar(java.lang.Double divergence_y_plus)
Accepted photon beam divergence in Y+ (vertical upward) direction.
void
setGeometry(NXgeometry geometry)
"Engineering" position of bending magnet
void
setGeometry(java.lang.String name,
NXgeometry geometry)
Set a NXgeometry node by name:
"Engineering" position of bending magnet
DataNode
setMagnetic_field(IDataset magnetic_field)
strength of magnetic field of dipole magnets
DataNode
setMagnetic_fieldScalar(java.lang.Double magnetic_field)
strength of magnetic field of dipole magnets
DataNode
setSource_distance_x(IDataset source_distance_x)
Distance of source point from particle beam waist in X (horizontal) direction.
DataNode
setSource_distance_xScalar(java.lang.Double source_distance_x)
Distance of source point from particle beam waist in X (horizontal) direction.
DataNode
setSource_distance_y(IDataset source_distance_y)
Distance of source point from particle beam waist in Y (vertical) direction.
DataNode
setSource_distance_yScalar(java.lang.Double source_distance_y)
Distance of source point from particle beam waist in Y (vertical) direction.
void
setSpectrum(NXdata spectrum)
bending magnet spectrum
-
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_CRITICAL_ENERGY
static final java.lang.String NX_CRITICAL_ENERGY
- See Also:
- Constant Field Values
-
NX_BENDING_RADIUS
static final java.lang.String NX_BENDING_RADIUS
- See Also:
- Constant Field Values
-
NX_MAGNETIC_FIELD
static final java.lang.String NX_MAGNETIC_FIELD
- See Also:
- Constant Field Values
-
NX_ACCEPTED_PHOTON_BEAM_DIVERGENCE
static final java.lang.String NX_ACCEPTED_PHOTON_BEAM_DIVERGENCE
- See Also:
- Constant Field Values
-
NX_SOURCE_DISTANCE_X
static final java.lang.String NX_SOURCE_DISTANCE_X
- See Also:
- Constant Field Values
-
NX_SOURCE_DISTANCE_Y
static final java.lang.String NX_SOURCE_DISTANCE_Y
- See Also:
- Constant Field Values
-
NX_DIVERGENCE_X_PLUS
static final java.lang.String NX_DIVERGENCE_X_PLUS
- See Also:
- Constant Field Values
-
NX_DIVERGENCE_X_MINUS
static final java.lang.String NX_DIVERGENCE_X_MINUS
- See Also:
- Constant Field Values
-
NX_DIVERGENCE_Y_PLUS
static final java.lang.String NX_DIVERGENCE_Y_PLUS
- See Also:
- Constant Field Values
-
NX_DIVERGENCE_Y_MINUS
static final java.lang.String NX_DIVERGENCE_Y_MINUS
- See Also:
- Constant Field Values
-
Method Detail
-
getCritical_energy
IDataset getCritical_energy()
Type: NX_FLOAT
Units: NX_ENERGY
- Returns:
- the value.
-
setCritical_energy
DataNode setCritical_energy(IDataset critical_energy)
Type: NX_FLOAT
Units: NX_ENERGY
- Parameters:
critical_energy
- the critical_energy
-
getCritical_energyScalar
java.lang.Double getCritical_energyScalar()
Type: NX_FLOAT
Units: NX_ENERGY
- Returns:
- the value.
-
setCritical_energyScalar
DataNode setCritical_energyScalar(java.lang.Double critical_energy)
Type: NX_FLOAT
Units: NX_ENERGY
- Parameters:
critical_energy
- the critical_energy
-
getBending_radius
IDataset getBending_radius()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setBending_radius
DataNode setBending_radius(IDataset bending_radius)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
bending_radius
- the bending_radius
-
getBending_radiusScalar
java.lang.Double getBending_radiusScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setBending_radiusScalar
DataNode setBending_radiusScalar(java.lang.Double bending_radius)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
bending_radius
- the bending_radius
-
getMagnetic_field
IDataset getMagnetic_field()
strength of magnetic field of dipole magnets
Type: NX_FLOAT
Units: NX_CURRENT
- Returns:
- the value.
-
setMagnetic_field
DataNode setMagnetic_field(IDataset magnetic_field)
strength of magnetic field of dipole magnets
Type: NX_FLOAT
Units: NX_CURRENT
- Parameters:
magnetic_field
- the magnetic_field
-
getMagnetic_fieldScalar
java.lang.Double getMagnetic_fieldScalar()
strength of magnetic field of dipole magnets
Type: NX_FLOAT
Units: NX_CURRENT
- Returns:
- the value.
-
setMagnetic_fieldScalar
DataNode setMagnetic_fieldScalar(java.lang.Double magnetic_field)
strength of magnetic field of dipole magnets
Type: NX_FLOAT
Units: NX_CURRENT
- Parameters:
magnetic_field
- the magnetic_field
-
getAccepted_photon_beam_divergence
IDataset getAccepted_photon_beam_divergence()
An array of four numbers giving X+, X-, Y+ and Y- half divergence
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setAccepted_photon_beam_divergence
DataNode setAccepted_photon_beam_divergence(IDataset accepted_photon_beam_divergence)
An array of four numbers giving X+, X-, Y+ and Y- half divergence
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
accepted_photon_beam_divergence
- the accepted_photon_beam_divergence
-
getAccepted_photon_beam_divergenceScalar
java.lang.Double getAccepted_photon_beam_divergenceScalar()
An array of four numbers giving X+, X-, Y+ and Y- half divergence
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setAccepted_photon_beam_divergenceScalar
DataNode setAccepted_photon_beam_divergenceScalar(java.lang.Double accepted_photon_beam_divergence)
An array of four numbers giving X+, X-, Y+ and Y- half divergence
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
accepted_photon_beam_divergence
- the accepted_photon_beam_divergence
-
getSource_distance_x
IDataset getSource_distance_x()
Distance of source point from particle beam waist in X (horizontal) direction.
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setSource_distance_x
DataNode setSource_distance_x(IDataset source_distance_x)
Distance of source point from particle beam waist in X (horizontal) direction.
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
source_distance_x
- the source_distance_x
-
getSource_distance_xScalar
java.lang.Double getSource_distance_xScalar()
Distance of source point from particle beam waist in X (horizontal) direction.
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setSource_distance_xScalar
DataNode setSource_distance_xScalar(java.lang.Double source_distance_x)
Distance of source point from particle beam waist in X (horizontal) direction.
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
source_distance_x
- the source_distance_x
-
getSource_distance_y
IDataset getSource_distance_y()
Distance of source point from particle beam waist in Y (vertical) direction.
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setSource_distance_y
DataNode setSource_distance_y(IDataset source_distance_y)
Distance of source point from particle beam waist in Y (vertical) direction.
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
source_distance_y
- the source_distance_y
-
getSource_distance_yScalar
java.lang.Double getSource_distance_yScalar()
Distance of source point from particle beam waist in Y (vertical) direction.
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setSource_distance_yScalar
DataNode setSource_distance_yScalar(java.lang.Double source_distance_y)
Distance of source point from particle beam waist in Y (vertical) direction.
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
source_distance_y
- the source_distance_y
-
getDivergence_x_plus
IDataset getDivergence_x_plus()
Accepted photon beam divergence in X+ (horizontal outboard) direction.
Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Returns:
- the value.
-
setDivergence_x_plus
DataNode setDivergence_x_plus(IDataset divergence_x_plus)
Accepted photon beam divergence in X+ (horizontal outboard) direction.
Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Parameters:
divergence_x_plus
- the divergence_x_plus
-
getDivergence_x_plusScalar
java.lang.Double getDivergence_x_plusScalar()
Accepted photon beam divergence in X+ (horizontal outboard) direction.
Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Returns:
- the value.
-
setDivergence_x_plusScalar
DataNode setDivergence_x_plusScalar(java.lang.Double divergence_x_plus)
Accepted photon beam divergence in X+ (horizontal outboard) direction.
Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Parameters:
divergence_x_plus
- the divergence_x_plus
-
getDivergence_x_minus
IDataset getDivergence_x_minus()
Accepted photon beam divergence in X- (horizontal inboard) direction.
Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Returns:
- the value.
-
setDivergence_x_minus
DataNode setDivergence_x_minus(IDataset divergence_x_minus)
Accepted photon beam divergence in X- (horizontal inboard) direction.
Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Parameters:
divergence_x_minus
- the divergence_x_minus
-
getDivergence_x_minusScalar
java.lang.Double getDivergence_x_minusScalar()
Accepted photon beam divergence in X- (horizontal inboard) direction.
Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Returns:
- the value.
-
setDivergence_x_minusScalar
DataNode setDivergence_x_minusScalar(java.lang.Double divergence_x_minus)
Accepted photon beam divergence in X- (horizontal inboard) direction.
Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Parameters:
divergence_x_minus
- the divergence_x_minus
-
getDivergence_y_plus
IDataset getDivergence_y_plus()
Accepted photon beam divergence in Y+ (vertical upward) direction.
Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Returns:
- the value.
-
setDivergence_y_plus
DataNode setDivergence_y_plus(IDataset divergence_y_plus)
Accepted photon beam divergence in Y+ (vertical upward) direction.
Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Parameters:
divergence_y_plus
- the divergence_y_plus
-
getDivergence_y_plusScalar
java.lang.Double getDivergence_y_plusScalar()
Accepted photon beam divergence in Y+ (vertical upward) direction.
Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Returns:
- the value.
-
setDivergence_y_plusScalar
DataNode setDivergence_y_plusScalar(java.lang.Double divergence_y_plus)
Accepted photon beam divergence in Y+ (vertical upward) direction.
Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Parameters:
divergence_y_plus
- the divergence_y_plus
-
getDivergence_y_minus
IDataset getDivergence_y_minus()
Accepted photon beam divergence in Y- (vertical downward) direction.
Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Returns:
- the value.
-
setDivergence_y_minus
DataNode setDivergence_y_minus(IDataset divergence_y_minus)
Accepted photon beam divergence in Y- (vertical downward) direction.
Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Parameters:
divergence_y_minus
- the divergence_y_minus
-
getDivergence_y_minusScalar
java.lang.Double getDivergence_y_minusScalar()
Accepted photon beam divergence in Y- (vertical downward) direction.
Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Returns:
- the value.
-
setDivergence_y_minusScalar
DataNode setDivergence_y_minusScalar(java.lang.Double divergence_y_minus)
Accepted photon beam divergence in Y- (vertical downward) direction.
Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
Type: NX_FLOAT
Units: NX_ANGLE
- Parameters:
divergence_y_minus
- the divergence_y_minus
-
getSpectrum
NXdata getSpectrum()
bending magnet spectrum
- Returns:
- the value.
-
setSpectrum
void setSpectrum(NXdata spectrum)
bending magnet spectrum
- Parameters:
spectrum
- the spectrum
-
getGeometry
NXgeometry getGeometry()
"Engineering" position of bending magnet
- Returns:
- the value.
-
setGeometry
void setGeometry(NXgeometry geometry)
"Engineering" position of bending magnet
- Parameters:
geometry
- the geometry
-
getGeometry
NXgeometry getGeometry(java.lang.String name)
Get a NXgeometry node by name:
-
"Engineering" position of bending magnet
- 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:
-
"Engineering" position of bending magnet
- 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:
-
"Engineering" position of bending magnet
- 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.
-
"Engineering" position of bending magnet
- Parameters:
geometry
- the child nodes to add