generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXfresnel_zone_plate.html Maven / Gradle / Ivy
NXfresnel_zone_plate (h5jan API)
org.eclipse.dawnsci.nexus
Interface NXfresnel_zone_plate
-
-
Field Summary
Fields
Modifier and Type
Field and Description
static java.lang.String
NX_CENTRAL_STOP_DIAMETER
static java.lang.String
NX_CENTRAL_STOP_MATERIAL
static java.lang.String
NX_CENTRAL_STOP_THICKNESS
static java.lang.String
NX_FABRICATION
static java.lang.String
NX_FOCUS_PARAMETERS
static java.lang.String
NX_MASK_MATERIAL
static java.lang.String
NX_MASK_THICKNESS
static java.lang.String
NX_OUTER_DIAMETER
static java.lang.String
NX_OUTERMOST_ZONE_WIDTH
static java.lang.String
NX_SUPPORT_MEMBRANE_MATERIAL
static java.lang.String
NX_SUPPORT_MEMBRANE_THICKNESS
static java.lang.String
NX_ZONE_HEIGHT
static java.lang.String
NX_ZONE_MATERIAL
static java.lang.String
NX_ZONE_SUPPORT_MATERIAL
-
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 fresnel zone plate
IDataset
getCentral_stop_diameter()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getCentral_stop_diameterScalar()
Type: NX_FLOAT
Units: NX_LENGTH
IDataset
getCentral_stop_material()
java.lang.String
getCentral_stop_materialScalar()
IDataset
getCentral_stop_thickness()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getCentral_stop_thicknessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
IDataset
getFabrication()
how the zone plate was manufactured
java.lang.String
getFabricationScalar()
how the zone plate was manufactured
IDataset
getFocus_parameters()
list of polynomial coefficients describing the focal length of the zone plate, in increasing powers of photon energy,
that describes the focal length of the zone plate (in microns) at an X-ray photon energy (in electron volts).
java.lang.Double
getFocus_parametersScalar()
list of polynomial coefficients describing the focal length of the zone plate, in increasing powers of photon energy,
that describes the focal length of the zone plate (in microns) at an X-ray photon energy (in electron volts).
IDataset
getMask_material()
If no mask is present, set mask_thickness to 0 and omit the mask_material field
java.lang.String
getMask_materialScalar()
If no mask is present, set mask_thickness to 0 and omit the mask_material field
IDataset
getMask_thickness()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getMask_thicknessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
IDataset
getOuter_diameter()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getOuter_diameterScalar()
Type: NX_FLOAT
Units: NX_LENGTH
IDataset
getOutermost_zone_width()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getOutermost_zone_widthScalar()
Type: NX_FLOAT
Units: NX_LENGTH
IDataset
getSupport_membrane_material()
java.lang.String
getSupport_membrane_materialScalar()
IDataset
getSupport_membrane_thickness()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getSupport_membrane_thicknessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
NXtransformations
getTransformations()
"Engineering" position of the fresnel zone plate
NXtransformations
getTransformations(java.lang.String name)
Get a NXtransformations node by name:
"Engineering" position of the fresnel zone plate
IDataset
getZone_height()
Type: NX_FLOAT
Units: NX_LENGTH
java.lang.Double
getZone_heightScalar()
Type: NX_FLOAT
Units: NX_LENGTH
IDataset
getZone_material()
Material of the zones themselves
java.lang.String
getZone_materialScalar()
Material of the zones themselves
IDataset
getZone_support_material()
Material present between the zones.
java.lang.String
getZone_support_materialScalar()
Material present between the zones.
void
setAllTransformations(java.util.Map<java.lang.String,NXtransformations> transformations)
Set multiple child nodes of a particular type.
DataNode
setCentral_stop_diameter(IDataset central_stop_diameter)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setCentral_stop_diameterScalar(java.lang.Double central_stop_diameter)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setCentral_stop_material(IDataset central_stop_material)
DataNode
setCentral_stop_materialScalar(java.lang.String central_stop_material)
DataNode
setCentral_stop_thickness(IDataset central_stop_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setCentral_stop_thicknessScalar(java.lang.Double central_stop_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setFabrication(IDataset fabrication)
how the zone plate was manufactured
DataNode
setFabricationScalar(java.lang.String fabrication)
how the zone plate was manufactured
DataNode
setFocus_parameters(IDataset focus_parameters)
list of polynomial coefficients describing the focal length of the zone plate, in increasing powers of photon energy,
that describes the focal length of the zone plate (in microns) at an X-ray photon energy (in electron volts).
DataNode
setFocus_parametersScalar(java.lang.Double focus_parameters)
list of polynomial coefficients describing the focal length of the zone plate, in increasing powers of photon energy,
that describes the focal length of the zone plate (in microns) at an X-ray photon energy (in electron volts).
DataNode
setMask_material(IDataset mask_material)
If no mask is present, set mask_thickness to 0 and omit the mask_material field
DataNode
setMask_materialScalar(java.lang.String mask_material)
If no mask is present, set mask_thickness to 0 and omit the mask_material field
DataNode
setMask_thickness(IDataset mask_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setMask_thicknessScalar(java.lang.Double mask_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setOuter_diameter(IDataset outer_diameter)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setOuter_diameterScalar(java.lang.Double outer_diameter)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setOutermost_zone_width(IDataset outermost_zone_width)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setOutermost_zone_widthScalar(java.lang.Double outermost_zone_width)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setSupport_membrane_material(IDataset support_membrane_material)
DataNode
setSupport_membrane_materialScalar(java.lang.String support_membrane_material)
DataNode
setSupport_membrane_thickness(IDataset support_membrane_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setSupport_membrane_thicknessScalar(java.lang.Double support_membrane_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
void
setTransformations(NXtransformations transformations)
"Engineering" position of the fresnel zone plate
void
setTransformations(java.lang.String name,
NXtransformations transformations)
Set a NXtransformations node by name:
"Engineering" position of the fresnel zone plate
DataNode
setZone_height(IDataset zone_height)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setZone_heightScalar(java.lang.Double zone_height)
Type: NX_FLOAT
Units: NX_LENGTH
DataNode
setZone_material(IDataset zone_material)
Material of the zones themselves
DataNode
setZone_materialScalar(java.lang.String zone_material)
Material of the zones themselves
DataNode
setZone_support_material(IDataset zone_support_material)
Material present between the zones.
DataNode
setZone_support_materialScalar(java.lang.String zone_support_material)
Material present between the zones.
-
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_FOCUS_PARAMETERS
static final java.lang.String NX_FOCUS_PARAMETERS
- See Also:
- Constant Field Values
-
NX_OUTER_DIAMETER
static final java.lang.String NX_OUTER_DIAMETER
- See Also:
- Constant Field Values
-
NX_OUTERMOST_ZONE_WIDTH
static final java.lang.String NX_OUTERMOST_ZONE_WIDTH
- See Also:
- Constant Field Values
-
NX_CENTRAL_STOP_DIAMETER
static final java.lang.String NX_CENTRAL_STOP_DIAMETER
- See Also:
- Constant Field Values
-
NX_FABRICATION
static final java.lang.String NX_FABRICATION
- See Also:
- Constant Field Values
-
NX_ZONE_HEIGHT
static final java.lang.String NX_ZONE_HEIGHT
- See Also:
- Constant Field Values
-
NX_ZONE_MATERIAL
static final java.lang.String NX_ZONE_MATERIAL
- See Also:
- Constant Field Values
-
NX_ZONE_SUPPORT_MATERIAL
static final java.lang.String NX_ZONE_SUPPORT_MATERIAL
- See Also:
- Constant Field Values
-
NX_CENTRAL_STOP_MATERIAL
static final java.lang.String NX_CENTRAL_STOP_MATERIAL
- See Also:
- Constant Field Values
-
NX_CENTRAL_STOP_THICKNESS
static final java.lang.String NX_CENTRAL_STOP_THICKNESS
- See Also:
- Constant Field Values
-
NX_MASK_THICKNESS
static final java.lang.String NX_MASK_THICKNESS
- See Also:
- Constant Field Values
-
NX_MASK_MATERIAL
static final java.lang.String NX_MASK_MATERIAL
- See Also:
- Constant Field Values
-
NX_SUPPORT_MEMBRANE_MATERIAL
static final java.lang.String NX_SUPPORT_MEMBRANE_MATERIAL
- See Also:
- Constant Field Values
-
NX_SUPPORT_MEMBRANE_THICKNESS
static final java.lang.String NX_SUPPORT_MEMBRANE_THICKNESS
- See Also:
- Constant Field Values
-
Method Detail
-
getFocus_parameters
IDataset getFocus_parameters()
list of polynomial coefficients describing the focal length of the zone plate, in increasing powers of photon energy,
that describes the focal length of the zone plate (in microns) at an X-ray photon energy (in electron volts).
Type: NX_FLOAT
Dimensions:
- Returns:
- the value.
-
setFocus_parameters
DataNode setFocus_parameters(IDataset focus_parameters)
list of polynomial coefficients describing the focal length of the zone plate, in increasing powers of photon energy,
that describes the focal length of the zone plate (in microns) at an X-ray photon energy (in electron volts).
Type: NX_FLOAT
Dimensions:
- Parameters:
focus_parameters
- the focus_parameters
-
getFocus_parametersScalar
java.lang.Double getFocus_parametersScalar()
list of polynomial coefficients describing the focal length of the zone plate, in increasing powers of photon energy,
that describes the focal length of the zone plate (in microns) at an X-ray photon energy (in electron volts).
Type: NX_FLOAT
Dimensions:
- Returns:
- the value.
-
setFocus_parametersScalar
DataNode setFocus_parametersScalar(java.lang.Double focus_parameters)
list of polynomial coefficients describing the focal length of the zone plate, in increasing powers of photon energy,
that describes the focal length of the zone plate (in microns) at an X-ray photon energy (in electron volts).
Type: NX_FLOAT
Dimensions:
- Parameters:
focus_parameters
- the focus_parameters
-
getOuter_diameter
IDataset getOuter_diameter()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setOuter_diameter
DataNode setOuter_diameter(IDataset outer_diameter)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
outer_diameter
- the outer_diameter
-
getOuter_diameterScalar
java.lang.Double getOuter_diameterScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setOuter_diameterScalar
DataNode setOuter_diameterScalar(java.lang.Double outer_diameter)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
outer_diameter
- the outer_diameter
-
getOutermost_zone_width
IDataset getOutermost_zone_width()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setOutermost_zone_width
DataNode setOutermost_zone_width(IDataset outermost_zone_width)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
outermost_zone_width
- the outermost_zone_width
-
getOutermost_zone_widthScalar
java.lang.Double getOutermost_zone_widthScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setOutermost_zone_widthScalar
DataNode setOutermost_zone_widthScalar(java.lang.Double outermost_zone_width)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
outermost_zone_width
- the outermost_zone_width
-
getCentral_stop_diameter
IDataset getCentral_stop_diameter()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setCentral_stop_diameter
DataNode setCentral_stop_diameter(IDataset central_stop_diameter)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
central_stop_diameter
- the central_stop_diameter
-
getCentral_stop_diameterScalar
java.lang.Double getCentral_stop_diameterScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setCentral_stop_diameterScalar
DataNode setCentral_stop_diameterScalar(java.lang.Double central_stop_diameter)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
central_stop_diameter
- the central_stop_diameter
-
getFabrication
IDataset getFabrication()
how the zone plate was manufactured
Enumeration:
- etched
- plated
- zone doubled
- other
- Returns:
- the value.
-
setFabrication
DataNode setFabrication(IDataset fabrication)
how the zone plate was manufactured
Enumeration:
- etched
- plated
- zone doubled
- other
- Parameters:
fabrication
- the fabrication
-
getFabricationScalar
java.lang.String getFabricationScalar()
how the zone plate was manufactured
Enumeration:
- etched
- plated
- zone doubled
- other
- Returns:
- the value.
-
setFabricationScalar
DataNode setFabricationScalar(java.lang.String fabrication)
how the zone plate was manufactured
Enumeration:
- etched
- plated
- zone doubled
- other
- Parameters:
fabrication
- the fabrication
-
getZone_height
IDataset getZone_height()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setZone_height
DataNode setZone_height(IDataset zone_height)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
zone_height
- the zone_height
-
getZone_heightScalar
java.lang.Double getZone_heightScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setZone_heightScalar
DataNode setZone_heightScalar(java.lang.Double zone_height)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
zone_height
- the zone_height
-
getZone_material
IDataset getZone_material()
Material of the zones themselves
- Returns:
- the value.
-
setZone_material
DataNode setZone_material(IDataset zone_material)
Material of the zones themselves
- Parameters:
zone_material
- the zone_material
-
getZone_materialScalar
java.lang.String getZone_materialScalar()
Material of the zones themselves
- Returns:
- the value.
-
setZone_materialScalar
DataNode setZone_materialScalar(java.lang.String zone_material)
Material of the zones themselves
- Parameters:
zone_material
- the zone_material
-
getZone_support_material
IDataset getZone_support_material()
Material present between the zones. This is usually only present for the "zone doubled" fabrication process
- Returns:
- the value.
-
setZone_support_material
DataNode setZone_support_material(IDataset zone_support_material)
Material present between the zones. This is usually only present for the "zone doubled" fabrication process
- Parameters:
zone_support_material
- the zone_support_material
-
getZone_support_materialScalar
java.lang.String getZone_support_materialScalar()
Material present between the zones. This is usually only present for the "zone doubled" fabrication process
- Returns:
- the value.
-
setZone_support_materialScalar
DataNode setZone_support_materialScalar(java.lang.String zone_support_material)
Material present between the zones. This is usually only present for the "zone doubled" fabrication process
- Parameters:
zone_support_material
- the zone_support_material
-
getCentral_stop_material
IDataset getCentral_stop_material()
- Returns:
- the value.
-
setCentral_stop_material
DataNode setCentral_stop_material(IDataset central_stop_material)
- Parameters:
central_stop_material
- the central_stop_material
-
getCentral_stop_materialScalar
java.lang.String getCentral_stop_materialScalar()
- Returns:
- the value.
-
setCentral_stop_materialScalar
DataNode setCentral_stop_materialScalar(java.lang.String central_stop_material)
- Parameters:
central_stop_material
- the central_stop_material
-
getCentral_stop_thickness
IDataset getCentral_stop_thickness()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setCentral_stop_thickness
DataNode setCentral_stop_thickness(IDataset central_stop_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
central_stop_thickness
- the central_stop_thickness
-
getCentral_stop_thicknessScalar
java.lang.Double getCentral_stop_thicknessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setCentral_stop_thicknessScalar
DataNode setCentral_stop_thicknessScalar(java.lang.Double central_stop_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
central_stop_thickness
- the central_stop_thickness
-
getMask_thickness
IDataset getMask_thickness()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setMask_thickness
DataNode setMask_thickness(IDataset mask_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
mask_thickness
- the mask_thickness
-
getMask_thicknessScalar
java.lang.Double getMask_thicknessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setMask_thicknessScalar
DataNode setMask_thicknessScalar(java.lang.Double mask_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
mask_thickness
- the mask_thickness
-
getMask_material
IDataset getMask_material()
If no mask is present, set mask_thickness to 0 and omit the mask_material field
- Returns:
- the value.
-
setMask_material
DataNode setMask_material(IDataset mask_material)
If no mask is present, set mask_thickness to 0 and omit the mask_material field
- Parameters:
mask_material
- the mask_material
-
getMask_materialScalar
java.lang.String getMask_materialScalar()
If no mask is present, set mask_thickness to 0 and omit the mask_material field
- Returns:
- the value.
-
setMask_materialScalar
DataNode setMask_materialScalar(java.lang.String mask_material)
If no mask is present, set mask_thickness to 0 and omit the mask_material field
- Parameters:
mask_material
- the mask_material
-
getSupport_membrane_material
IDataset getSupport_membrane_material()
- Returns:
- the value.
-
setSupport_membrane_material
DataNode setSupport_membrane_material(IDataset support_membrane_material)
- Parameters:
support_membrane_material
- the support_membrane_material
-
getSupport_membrane_materialScalar
java.lang.String getSupport_membrane_materialScalar()
- Returns:
- the value.
-
setSupport_membrane_materialScalar
DataNode setSupport_membrane_materialScalar(java.lang.String support_membrane_material)
- Parameters:
support_membrane_material
- the support_membrane_material
-
getSupport_membrane_thickness
IDataset getSupport_membrane_thickness()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setSupport_membrane_thickness
DataNode setSupport_membrane_thickness(IDataset support_membrane_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
support_membrane_thickness
- the support_membrane_thickness
-
getSupport_membrane_thicknessScalar
java.lang.Double getSupport_membrane_thicknessScalar()
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setSupport_membrane_thicknessScalar
DataNode setSupport_membrane_thicknessScalar(java.lang.Double support_membrane_thickness)
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
support_membrane_thickness
- the support_membrane_thickness
-
getTransformations
NXtransformations getTransformations()
"Engineering" position of the fresnel zone plate
- Returns:
- the value.
-
setTransformations
void setTransformations(NXtransformations transformations)
"Engineering" position of the fresnel zone plate
- Parameters:
transformations
- the transformations
-
getTransformations
NXtransformations getTransformations(java.lang.String name)
Get a NXtransformations node by name:
-
"Engineering" position of the fresnel zone plate
- 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 fresnel zone plate
- 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 fresnel zone plate
- 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 fresnel zone plate
- Parameters:
transformations
- the child nodes to add