generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXgrating.html Maven / Gradle / Ivy
NXgrating (h5jan API)
org.eclipse.dawnsci.nexus
Interface NXgrating
-
-
Field Summary
Fields
Modifier and Type
Field and Description
static java.lang.String
NX_ANGLES
static java.lang.String
NX_COATING_MATERIAL
static java.lang.String
NX_COATING_ROUGHNESS
static java.lang.String
NX_DEFLECTION_ANGLE
static java.lang.String
NX_DEPTH
static java.lang.String
NX_DIFFRACTION_ORDER
static java.lang.String
NX_DUTY_CYCLE
static java.lang.String
NX_INTERIOR_ATMOSPHERE
static java.lang.String
NX_LAYER_THICKNESS
static java.lang.String
NX_PERIOD
static java.lang.String
NX_SUBSTRATE_DENSITY
static java.lang.String
NX_SUBSTRATE_MATERIAL
static java.lang.String
NX_SUBSTRATE_ROUGHNESS
static java.lang.String
NX_SUBSTRATE_THICKNESS
-
Method Summary
All Methods Instance Methods Abstract Methods
Modifier and Type
Method and Description
java.util.Map<java.lang.String,NXtransformations>
getAllTransformations()
Get all NXtransformations nodes:
"Engineering" position of the grating
IDataset
getAngles()
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.
java.lang.Double
getAnglesScalar()
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.
IDataset
getCoating_material()
java.lang.String
getCoating_materialScalar()
IDataset
getCoating_roughness()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getCoating_roughnessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
IDataset
getDeflection_angle()
Angle between the incident beam and the utilised outgoing beam.
java.lang.Double
getDeflection_angleScalar()
Angle between the incident beam and the utilised outgoing beam.
IDataset
getDepth()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getDepthScalar()
Type: NX_FLOAT
Units: NX_LENGTH
IDataset
getDiffraction_order()
Type: NX_INT
Units: NX_UNITLESS
java.lang.Long
getDiffraction_orderScalar()
Type: NX_INT
Units: NX_UNITLESS
IDataset
getDuty_cycle()
Type: NX_FLOAT
Units: NX_UNITLESS
java.lang.Double
getDuty_cycleScalar()
Type: NX_FLOAT
Units: NX_UNITLESS
NXdata
getFigure_data()
Numerical description of the surface figure of the mirror.
IDataset
getInterior_atmosphere()
java.lang.String
getInterior_atmosphereScalar()
IDataset
getLayer_thickness()
An array describing the thickness of each layer
java.lang.Double
getLayer_thicknessScalar()
An array describing the thickness of each layer
IDataset
getPeriod()
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.
java.lang.Double
getPeriodScalar()
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.
NXshape
getShape()
A NXshape group describing the shape of the mirror
IDataset
getSubstrate_density()
Type: NX_FLOAT
Units: NX_MASS_DENSITY
java.lang.Double
getSubstrate_densityScalar()
Type: NX_FLOAT
Units: NX_MASS_DENSITY
IDataset
getSubstrate_material()
java.lang.String
getSubstrate_materialScalar()
IDataset
getSubstrate_roughness()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getSubstrate_roughnessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
IDataset
getSubstrate_thickness()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getSubstrate_thicknessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
NXtransformations
getTransformations()
"Engineering" position of the grating
NXtransformations
getTransformations(java.lang.String name)
Get a NXtransformations node by name:
"Engineering" position of the grating
void
setAllTransformations(java.util.Map<java.lang.String,NXtransformations> transformations)
Set multiple child nodes of a particular type.
DataNode
setAngles(IDataset angles)
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.
DataNode
setAnglesScalar(java.lang.Double angles)
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.
DataNode
setCoating_material(IDataset coating_material)
DataNode
setCoating_materialScalar(java.lang.String coating_material)
DataNode
setCoating_roughness(IDataset coating_roughness)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setCoating_roughnessScalar(java.lang.Double coating_roughness)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setDeflection_angle(IDataset deflection_angle)
Angle between the incident beam and the utilised outgoing beam.
DataNode
setDeflection_angleScalar(java.lang.Double deflection_angle)
Angle between the incident beam and the utilised outgoing beam.
DataNode
setDepth(IDataset depth)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setDepthScalar(java.lang.Double depth)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setDiffraction_order(IDataset diffraction_order)
Type: NX_INT
Units: NX_UNITLESS
DataNode
setDiffraction_orderScalar(java.lang.Long diffraction_order)
Type: NX_INT
Units: NX_UNITLESS
DataNode
setDuty_cycle(IDataset duty_cycle)
Type: NX_FLOAT
Units: NX_UNITLESS
DataNode
setDuty_cycleScalar(java.lang.Double duty_cycle)
Type: NX_FLOAT
Units: NX_UNITLESS
void
setFigure_data(NXdata figure_data)
Numerical description of the surface figure of the mirror.
DataNode
setInterior_atmosphere(IDataset interior_atmosphere)
DataNode
setInterior_atmosphereScalar(java.lang.String interior_atmosphere)
DataNode
setLayer_thickness(IDataset layer_thickness)
An array describing the thickness of each layer
DataNode
setLayer_thicknessScalar(java.lang.Double layer_thickness)
An array describing the thickness of each layer
DataNode
setPeriod(IDataset period)
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.
DataNode
setPeriodScalar(java.lang.Double period)
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.
void
setShape(NXshape shape)
A NXshape group describing the shape of the mirror
DataNode
setSubstrate_density(IDataset substrate_density)
Type: NX_FLOAT
Units: NX_MASS_DENSITY
DataNode
setSubstrate_densityScalar(java.lang.Double substrate_density)
Type: NX_FLOAT
Units: NX_MASS_DENSITY
DataNode
setSubstrate_material(IDataset substrate_material)
DataNode
setSubstrate_materialScalar(java.lang.String substrate_material)
DataNode
setSubstrate_roughness(IDataset substrate_roughness)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setSubstrate_thickness(IDataset substrate_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
void
setTransformations(NXtransformations transformations)
"Engineering" position of the grating
void
setTransformations(java.lang.String name,
NXtransformations transformations)
Set a NXtransformations node by name:
"Engineering" position of the grating
-
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_ANGLES
static final java.lang.String NX_ANGLES
- See Also:
- Constant Field Values
-
NX_PERIOD
static final java.lang.String NX_PERIOD
- See Also:
- Constant Field Values
-
NX_DUTY_CYCLE
static final java.lang.String NX_DUTY_CYCLE
- See Also:
- Constant Field Values
-
NX_DEPTH
static final java.lang.String NX_DEPTH
- See Also:
- Constant Field Values
-
NX_DIFFRACTION_ORDER
static final java.lang.String NX_DIFFRACTION_ORDER
- See Also:
- Constant Field Values
-
NX_DEFLECTION_ANGLE
static final java.lang.String NX_DEFLECTION_ANGLE
- See Also:
- Constant Field Values
-
NX_INTERIOR_ATMOSPHERE
static final java.lang.String NX_INTERIOR_ATMOSPHERE
- See Also:
- Constant Field Values
-
NX_SUBSTRATE_MATERIAL
static final java.lang.String NX_SUBSTRATE_MATERIAL
- See Also:
- Constant Field Values
-
NX_SUBSTRATE_DENSITY
static final java.lang.String NX_SUBSTRATE_DENSITY
- See Also:
- Constant Field Values
-
NX_SUBSTRATE_THICKNESS
static final java.lang.String NX_SUBSTRATE_THICKNESS
- See Also:
- Constant Field Values
-
NX_COATING_MATERIAL
static final java.lang.String NX_COATING_MATERIAL
- See Also:
- Constant Field Values
-
NX_SUBSTRATE_ROUGHNESS
static final java.lang.String NX_SUBSTRATE_ROUGHNESS
- See Also:
- Constant Field Values
-
NX_COATING_ROUGHNESS
static final java.lang.String NX_COATING_ROUGHNESS
- See Also:
- Constant Field Values
-
NX_LAYER_THICKNESS
static final java.lang.String NX_LAYER_THICKNESS
- See Also:
- Constant Field Values
-
Method Detail
-
getAngles
IDataset getAngles()
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle.
Type: NX_FLOAT
Units: NX_ANGLE
Dimensions: 1: 2;
- Returns:
- the value.
-
setAngles
DataNode setAngles(IDataset angles)
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle.
Type: NX_FLOAT
Units: NX_ANGLE
Dimensions: 1: 2;
- Parameters:
angles
- the angles
-
getAnglesScalar
java.lang.Double getAnglesScalar()
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle.
Type: NX_FLOAT
Units: NX_ANGLE
Dimensions: 1: 2;
- Returns:
- the value.
-
setAnglesScalar
DataNode setAnglesScalar(java.lang.Double angles)
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle.
Type: NX_FLOAT
Units: NX_ANGLE
Dimensions: 1: 2;
- Parameters:
angles
- the angles
-
getPeriod
IDataset getPeriod()
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant).
Type: NX_FLOAT
Units: NX_LENGTH
Dimensions:
- Returns:
- the value.
-
setPeriod
DataNode setPeriod(IDataset period)
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant).
Type: NX_FLOAT
Units: NX_LENGTH
Dimensions:
- Parameters:
period
- the period
-
getPeriodScalar
java.lang.Double getPeriodScalar()
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant).
Type: NX_FLOAT
Units: NX_LENGTH
Dimensions:
- Returns:
- the value.
-
setPeriodScalar
DataNode setPeriodScalar(java.lang.Double period)
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant).
Type: NX_FLOAT
Units: NX_LENGTH
Dimensions:
- Parameters:
period
- the period
-
getDuty_cycle
IDataset getDuty_cycle()
Type: NX_FLOAT
Units: NX_UNITLESS
- Returns:
- the value.
-
setDuty_cycle
DataNode setDuty_cycle(IDataset duty_cycle)
Type: NX_FLOAT
Units: NX_UNITLESS
- Parameters:
duty_cycle
- the duty_cycle
-
getDuty_cycleScalar
java.lang.Double getDuty_cycleScalar()
Type: NX_FLOAT
Units: NX_UNITLESS
- Returns:
- the value.
-
setDuty_cycleScalar
DataNode setDuty_cycleScalar(java.lang.Double duty_cycle)
Type: NX_FLOAT
Units: NX_UNITLESS
- Parameters:
duty_cycle
- the duty_cycle
-
getDepth
IDataset getDepth()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setDepth
DataNode setDepth(IDataset depth)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
depth
- the depth
-
getDepthScalar
java.lang.Double getDepthScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setDepthScalar
DataNode setDepthScalar(java.lang.Double depth)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
depth
- the depth
-
getDiffraction_order
IDataset getDiffraction_order()
Type: NX_INT
Units: NX_UNITLESS
- Returns:
- the value.
-
setDiffraction_order
DataNode setDiffraction_order(IDataset diffraction_order)
Type: NX_INT
Units: NX_UNITLESS
- Parameters:
diffraction_order
- the diffraction_order
-
getDiffraction_orderScalar
java.lang.Long getDiffraction_orderScalar()
Type: NX_INT
Units: NX_UNITLESS
- Returns:
- the value.
-
setDiffraction_orderScalar
DataNode setDiffraction_orderScalar(java.lang.Long diffraction_order)
Type: NX_INT
Units: NX_UNITLESS
- Parameters:
diffraction_order
- the diffraction_order
-
getDeflection_angle
IDataset getDeflection_angle()
Angle between the incident beam and the utilised outgoing beam.
Type: NX_FLOAT
Units: NX_ANGLE
- Returns:
- the value.
-
setDeflection_angle
DataNode setDeflection_angle(IDataset deflection_angle)
Angle between the incident beam and the utilised outgoing beam.
Type: NX_FLOAT
Units: NX_ANGLE
- Parameters:
deflection_angle
- the deflection_angle
-
getDeflection_angleScalar
java.lang.Double getDeflection_angleScalar()
Angle between the incident beam and the utilised outgoing beam.
Type: NX_FLOAT
Units: NX_ANGLE
- Returns:
- the value.
-
setDeflection_angleScalar
DataNode setDeflection_angleScalar(java.lang.Double deflection_angle)
Angle between the incident beam and the utilised outgoing beam.
Type: NX_FLOAT
Units: NX_ANGLE
- Parameters:
deflection_angle
- the deflection_angle
-
getInterior_atmosphere
IDataset getInterior_atmosphere()
Enumeration:
- vacuum
- helium
- argon
- Returns:
- the value.
-
setInterior_atmosphere
DataNode setInterior_atmosphere(IDataset interior_atmosphere)
Enumeration:
- vacuum
- helium
- argon
- Parameters:
interior_atmosphere
- the interior_atmosphere
-
getInterior_atmosphereScalar
java.lang.String getInterior_atmosphereScalar()
Enumeration:
- vacuum
- helium
- argon
- Returns:
- the value.
-
setInterior_atmosphereScalar
DataNode setInterior_atmosphereScalar(java.lang.String interior_atmosphere)
Enumeration:
- vacuum
- helium
- argon
- Parameters:
interior_atmosphere
- the interior_atmosphere
-
getSubstrate_material
IDataset getSubstrate_material()
- Returns:
- the value.
-
setSubstrate_material
DataNode setSubstrate_material(IDataset substrate_material)
- Parameters:
substrate_material
- the substrate_material
-
getSubstrate_materialScalar
java.lang.String getSubstrate_materialScalar()
- Returns:
- the value.
-
setSubstrate_materialScalar
DataNode setSubstrate_materialScalar(java.lang.String substrate_material)
- Parameters:
substrate_material
- the substrate_material
-
getSubstrate_density
IDataset getSubstrate_density()
Type: NX_FLOAT
Units: NX_MASS_DENSITY
- Returns:
- the value.
-
setSubstrate_density
DataNode setSubstrate_density(IDataset substrate_density)
Type: NX_FLOAT
Units: NX_MASS_DENSITY
- Parameters:
substrate_density
- the substrate_density
-
getSubstrate_densityScalar
java.lang.Double getSubstrate_densityScalar()
Type: NX_FLOAT
Units: NX_MASS_DENSITY
- Returns:
- the value.
-
setSubstrate_densityScalar
DataNode setSubstrate_densityScalar(java.lang.Double substrate_density)
Type: NX_FLOAT
Units: NX_MASS_DENSITY
- Parameters:
substrate_density
- the substrate_density
-
getSubstrate_thickness
IDataset getSubstrate_thickness()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setSubstrate_thickness
DataNode setSubstrate_thickness(IDataset substrate_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
substrate_thickness
- the substrate_thickness
-
getSubstrate_thicknessScalar
java.lang.Double getSubstrate_thicknessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setSubstrate_thicknessScalar
DataNode setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
substrate_thickness
- the substrate_thickness
-
getCoating_material
IDataset getCoating_material()
- Returns:
- the value.
-
setCoating_material
DataNode setCoating_material(IDataset coating_material)
- Parameters:
coating_material
- the coating_material
-
getCoating_materialScalar
java.lang.String getCoating_materialScalar()
- Returns:
- the value.
-
setCoating_materialScalar
DataNode setCoating_materialScalar(java.lang.String coating_material)
- Parameters:
coating_material
- the coating_material
-
getSubstrate_roughness
IDataset getSubstrate_roughness()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setSubstrate_roughness
DataNode setSubstrate_roughness(IDataset substrate_roughness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
substrate_roughness
- the substrate_roughness
-
getSubstrate_roughnessScalar
java.lang.Double getSubstrate_roughnessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setSubstrate_roughnessScalar
DataNode setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
substrate_roughness
- the substrate_roughness
-
getCoating_roughness
IDataset getCoating_roughness()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setCoating_roughness
DataNode setCoating_roughness(IDataset coating_roughness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
coating_roughness
- the coating_roughness
-
getCoating_roughnessScalar
java.lang.Double getCoating_roughnessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setCoating_roughnessScalar
DataNode setCoating_roughnessScalar(java.lang.Double coating_roughness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
coating_roughness
- the coating_roughness
-
getLayer_thickness
IDataset getLayer_thickness()
An array describing the thickness of each layer
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setLayer_thickness
DataNode setLayer_thickness(IDataset layer_thickness)
An array describing the thickness of each layer
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
layer_thickness
- the layer_thickness
-
getLayer_thicknessScalar
java.lang.Double getLayer_thicknessScalar()
An array describing the thickness of each layer
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setLayer_thicknessScalar
DataNode setLayer_thicknessScalar(java.lang.Double layer_thickness)
An array describing the thickness of each layer
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
layer_thickness
- the layer_thickness
-
getShape
NXshape getShape()
A NXshape group describing the shape of the mirror
- Returns:
- the value.
-
setShape
void setShape(NXshape shape)
A NXshape group describing the shape of the mirror
- Parameters:
shape
- the shape
-
getFigure_data
NXdata getFigure_data()
Numerical description of the surface figure of the mirror.
- Returns:
- the value.
-
setFigure_data
void setFigure_data(NXdata figure_data)
Numerical description of the surface figure of the mirror.
- Parameters:
figure_data
- the figure_data
-
getTransformations
NXtransformations getTransformations()
"Engineering" position of the grating
- Returns:
- the value.
-
setTransformations
void setTransformations(NXtransformations transformations)
"Engineering" position of the grating
- Parameters:
transformations
- the transformations
-
getTransformations
NXtransformations getTransformations(java.lang.String name)
Get a NXtransformations node by name:
-
"Engineering" position of the grating
- Parameters:
name
- the name of the node.
- Returns:
- a map from node names to the NXtransformations for that node.
-
setTransformations
void setTransformations(java.lang.String name,
NXtransformations transformations)
Set a NXtransformations node by name:
-
"Engineering" position of the grating
- Parameters:
name
- the name of the node
transformations
- the value to set
-
getAllTransformations
java.util.Map<java.lang.String,NXtransformations> getAllTransformations()
Get all NXtransformations nodes:
-
"Engineering" position of the grating
- Returns:
- a map from node names to the NXtransformations for that node.
-
setAllTransformations
void setAllTransformations(java.util.Map<java.lang.String,NXtransformations> transformations)
Set multiple child nodes of a particular type.
-
"Engineering" position of the grating
- Parameters:
transformations
- the child nodes to add