generated.docs.javadoc.org.eclipse.dawnsci.nexus.impl.NXfilterImpl.html Maven / Gradle / Ivy
NXfilterImpl (h5jan API)
org.eclipse.dawnsci.nexus.impl
Class NXfilterImpl
- java.lang.Object
-
- org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
-
- org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl
-
- org.eclipse.dawnsci.nexus.impl.NXobjectImpl
-
- org.eclipse.dawnsci.nexus.impl.NXfilterImpl
-
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXfilter, NXobject
public class NXfilterImpl
extends NXobjectImpl
implements NXfilter
For band pass beam filters.
If uncertain whether to use :ref:`NXfilter` (band-pass filter)
or :ref:`NXattenuator` (reduces beam intensity), then use
:ref:`NXattenuator`.
- See Also:
- Serialized Form
-
-
Field Summary
Fields
Modifier and Type
Field and Description
static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES
-
Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS
-
Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT
-
Fields inherited from interface org.eclipse.dawnsci.nexus.NXfilter
NX_CHEMICAL_FORMULA, NX_COATING_MATERIAL, NX_COATING_ROUGHNESS, NX_DENSITY, NX_DESCRIPTION, NX_M_VALUE, NX_ORIENTATION_MATRIX, NX_STATUS, NX_SUBSTRATE_MATERIAL, NX_SUBSTRATE_ROUGHNESS, NX_SUBSTRATE_THICKNESS, NX_TEMPERATURE, NX_THICKNESS, NX_UNIT_CELL_A, NX_UNIT_CELL_ALPHA, NX_UNIT_CELL_B, NX_UNIT_CELL_BETA, NX_UNIT_CELL_C, NX_UNIT_CELL_GAMMA, NX_UNIT_CELL_VOLUME
-
Constructor Summary
Constructors
Constructor and Description
NXfilterImpl()
NXfilterImpl(long oid)
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
java.util.Map<java.lang.String,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
Geometry of the filter
IDataset
getChemical_formula()
The chemical formula specified using CIF conventions.
java.lang.String
getChemical_formulaScalar()
The chemical formula specified using CIF conventions.
IDataset
getCoating_material()
coating material of supermirror filter
java.lang.String
getCoating_materialScalar()
coating material of supermirror filter
IDataset
getCoating_roughness()
coating roughness (RMS) of supermirror filter
java.lang.Double
getCoating_roughnessScalar()
coating roughness (RMS) of supermirror filter
IDataset
getDensity()
mass density of the filter
java.lang.Number
getDensityScalar()
mass density of the filter
IDataset
getDescription()
Composition of the filter.
java.lang.String
getDescriptionScalar()
Composition of the filter.
NXgeometry
getGeometry()
Geometry of the filter
NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
Geometry of the filter
IDataset
getM_value()
m value of supermirror filter
java.lang.Double
getM_valueScalar()
m value of supermirror filter
NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass
for this base class, e.g.
java.lang.Class<? extends NXobject>
getNXclass()
Java Class
object of the interface for this base class, e.g.
IDataset
getOrientation_matrix()
Orientation matrix of single crystal filter using Busing-Levy convention:
W.
java.lang.Double
getOrientation_matrixScalar()
Orientation matrix of single crystal filter using Busing-Levy convention:
W.
java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass
constants for the permitted child group types
of this base class.
NXsensor
getSensor_type()
Sensor(s)used to monitor the filter temperature
IDataset
getStatus()
position with respect to in or out of the beam (choice of only "in" or "out")
java.lang.String
getStatusScalar()
position with respect to in or out of the beam (choice of only "in" or "out")
IDataset
getSubstrate_material()
substrate material of supermirror filter
java.lang.String
getSubstrate_materialScalar()
substrate material of supermirror filter
IDataset
getSubstrate_roughness()
substrate roughness (RMS) of supermirror filter
java.lang.Double
getSubstrate_roughnessScalar()
substrate roughness (RMS) of supermirror filter
IDataset
getSubstrate_thickness()
substrate thickness of supermirror filter
java.lang.Double
getSubstrate_thicknessScalar()
substrate thickness of supermirror filter
NXlog
getTemperature_log()
Linked temperature_log for the filter
IDataset
getTemperature()
average/nominal filter temperature
java.lang.Double
getTemperatureScalar()
average/nominal filter temperature
IDataset
getThickness()
Thickness of the filter
java.lang.Double
getThicknessScalar()
Thickness of the filter
NXdata
getTransmission()
Wavelength transmission profile of filter
IDataset
getUnit_cell_a()
Unit cell lattice parameter: length of side a
IDataset
getUnit_cell_alpha()
Unit cell lattice parameter: angle alpha
java.lang.Double
getUnit_cell_alphaScalar()
Unit cell lattice parameter: angle alpha
java.lang.Double
getUnit_cell_aScalar()
Unit cell lattice parameter: length of side a
IDataset
getUnit_cell_b()
Unit cell lattice parameter: length of side b
IDataset
getUnit_cell_beta()
Unit cell lattice parameter: angle beta
java.lang.Double
getUnit_cell_betaScalar()
Unit cell lattice parameter: angle beta
java.lang.Double
getUnit_cell_bScalar()
Unit cell lattice parameter: length of side b
IDataset
getUnit_cell_c()
Unit cell lattice parameter: length of side c
java.lang.Double
getUnit_cell_cScalar()
Unit cell lattice parameter: length of side c
IDataset
getUnit_cell_gamma()
Unit cell lattice parameter: angle gamma
java.lang.Double
getUnit_cell_gammaScalar()
Unit cell lattice parameter: angle gamma
IDataset
getUnit_cell_volume()
Unit cell
java.lang.Double
getUnit_cell_volumeScalar()
Unit cell
void
setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.
DataNode
setChemical_formula(IDataset chemical_formula)
The chemical formula specified using CIF conventions.
DataNode
setChemical_formulaScalar(java.lang.String chemical_formula)
The chemical formula specified using CIF conventions.
DataNode
setCoating_material(IDataset coating_material)
coating material of supermirror filter
DataNode
setCoating_materialScalar(java.lang.String coating_material)
coating material of supermirror filter
DataNode
setCoating_roughness(IDataset coating_roughness)
coating roughness (RMS) of supermirror filter
DataNode
setCoating_roughnessScalar(java.lang.Double coating_roughness)
coating roughness (RMS) of supermirror filter
DataNode
setDensity(IDataset density)
mass density of the filter
DataNode
setDensityScalar(java.lang.Number density)
mass density of the filter
DataNode
setDescription(IDataset description)
Composition of the filter.
DataNode
setDescriptionScalar(java.lang.String description)
Composition of the filter.
void
setGeometry(NXgeometry geometry)
Geometry of the filter
void
setGeometry(java.lang.String name,
NXgeometry geometry)
Set a NXgeometry node by name:
Geometry of the filter
DataNode
setM_value(IDataset m_value)
m value of supermirror filter
DataNode
setM_valueScalar(java.lang.Double m_value)
m value of supermirror filter
DataNode
setOrientation_matrix(IDataset orientation_matrix)
Orientation matrix of single crystal filter using Busing-Levy convention:
W.
DataNode
setOrientation_matrixScalar(java.lang.Double orientation_matrix)
Orientation matrix of single crystal filter using Busing-Levy convention:
W.
void
setSensor_type(NXsensor sensor_type)
Sensor(s)used to monitor the filter temperature
DataNode
setStatus(IDataset status)
position with respect to in or out of the beam (choice of only "in" or "out")
DataNode
setStatusScalar(java.lang.String status)
position with respect to in or out of the beam (choice of only "in" or "out")
DataNode
setSubstrate_material(IDataset substrate_material)
substrate material of supermirror filter
DataNode
setSubstrate_materialScalar(java.lang.String substrate_material)
substrate material of supermirror filter
DataNode
setSubstrate_roughness(IDataset substrate_roughness)
substrate roughness (RMS) of supermirror filter
DataNode
setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)
substrate roughness (RMS) of supermirror filter
DataNode
setSubstrate_thickness(IDataset substrate_thickness)
substrate thickness of supermirror filter
DataNode
setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)
substrate thickness of supermirror filter
void
setTemperature_log(NXlog temperature_log)
Linked temperature_log for the filter
DataNode
setTemperature(IDataset temperature)
average/nominal filter temperature
DataNode
setTemperatureScalar(java.lang.Double temperature)
average/nominal filter temperature
DataNode
setThickness(IDataset thickness)
Thickness of the filter
DataNode
setThicknessScalar(java.lang.Double thickness)
Thickness of the filter
void
setTransmission(NXdata transmission)
Wavelength transmission profile of filter
DataNode
setUnit_cell_a(IDataset unit_cell_a)
Unit cell lattice parameter: length of side a
DataNode
setUnit_cell_alpha(IDataset unit_cell_alpha)
Unit cell lattice parameter: angle alpha
DataNode
setUnit_cell_alphaScalar(java.lang.Double unit_cell_alpha)
Unit cell lattice parameter: angle alpha
DataNode
setUnit_cell_aScalar(java.lang.Double unit_cell_a)
Unit cell lattice parameter: length of side a
DataNode
setUnit_cell_b(IDataset unit_cell_b)
Unit cell lattice parameter: length of side b
DataNode
setUnit_cell_beta(IDataset unit_cell_beta)
Unit cell lattice parameter: angle beta
DataNode
setUnit_cell_betaScalar(java.lang.Double unit_cell_beta)
Unit cell lattice parameter: angle beta
DataNode
setUnit_cell_bScalar(java.lang.Double unit_cell_b)
Unit cell lattice parameter: length of side b
DataNode
setUnit_cell_c(IDataset unit_cell_c)
Unit cell lattice parameter: length of side c
DataNode
setUnit_cell_cScalar(java.lang.Double unit_cell_c)
Unit cell lattice parameter: length of side c
DataNode
setUnit_cell_gamma(IDataset unit_cell_gamma)
Unit cell lattice parameter: angle gamma
DataNode
setUnit_cell_gammaScalar(java.lang.Double unit_cell_gamma)
Unit cell lattice parameter: angle gamma
DataNode
setUnit_cell_volume(IDataset unit_cell_volume)
Unit cell
DataNode
setUnit_cell_volumeScalar(java.lang.Double unit_cell_volume)
Unit cell
-
Methods inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString
-
Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, createNodeLink, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isGroupNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool, toString
-
Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
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, getNumber, 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
-
PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES
-
Method Detail
-
getNXclass
public java.lang.Class<? extends NXobject> getNXclass()
Description copied from interface: NXobject
Java Class
object of the interface for this base class, e.g. NXsample
.class.
- Specified by:
getNXclass
in interface NXobject
- Returns:
- name of Nexus class
-
getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass
for this base class, e.g. NexusBaseClass.NX_SAMPLE
.
- Specified by:
getNexusBaseClass
in interface NXobject
- Returns:
NexusBaseClass
enum constant for this class
-
getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass
constants for the permitted child group types
of this base class.
- Specified by:
getPermittedChildGroupClasses
in interface NXobject
- Returns:
NexusBaseClass
constants for permitted child groups
-
getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXfilter
Geometry of the filter
- Specified by:
getGeometry
in interface NXfilter
- Returns:
- the value.
-
setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXfilter
Geometry of the filter
- Specified by:
setGeometry
in interface NXfilter
- Parameters:
geometry
- the geometry
-
getGeometry
public NXgeometry getGeometry(java.lang.String name)
Description copied from interface: NXfilter
Get a NXgeometry node by name:
-
Geometry of the filter
- Specified by:
getGeometry
in interface NXfilter
- Parameters:
name
- the name of the node.
- Returns:
- a map from node names to the NXgeometry for that node.
-
setGeometry
public void setGeometry(java.lang.String name,
NXgeometry geometry)
Description copied from interface: NXfilter
Set a NXgeometry node by name:
-
Geometry of the filter
- Specified by:
setGeometry
in interface NXfilter
- Parameters:
name
- the name of the node
geometry
- the value to set
-
getAllGeometry
public java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Description copied from interface: NXfilter
Get all NXgeometry nodes:
-
Geometry of the filter
- Specified by:
getAllGeometry
in interface NXfilter
- Returns:
- a map from node names to the NXgeometry for that node.
-
setAllGeometry
public void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Description copied from interface: NXfilter
Set multiple child nodes of a particular type.
-
Geometry of the filter
- Specified by:
setAllGeometry
in interface NXfilter
- Parameters:
geometry
- the child nodes to add
-
getDescription
public IDataset getDescription()
Description copied from interface: NXfilter
Composition of the filter. Chemical formula can be specified separately.
This field was changed (2010-11-17) from an enumeration to
a string since common usage showed a wider variety of use
than a simple list. These are the items in the list at
the time of the change: Beryllium | Pyrolytic Graphite |
Graphite | Sapphire | Silicon | Supermirror.
- Specified by:
getDescription
in interface NXfilter
- Returns:
- the value.
-
getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXfilter
Composition of the filter. Chemical formula can be specified separately.
This field was changed (2010-11-17) from an enumeration to
a string since common usage showed a wider variety of use
than a simple list. These are the items in the list at
the time of the change: Beryllium | Pyrolytic Graphite |
Graphite | Sapphire | Silicon | Supermirror.
- Specified by:
getDescriptionScalar
in interface NXfilter
- Returns:
- the value.
-
setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXfilter
Composition of the filter. Chemical formula can be specified separately.
This field was changed (2010-11-17) from an enumeration to
a string since common usage showed a wider variety of use
than a simple list. These are the items in the list at
the time of the change: Beryllium | Pyrolytic Graphite |
Graphite | Sapphire | Silicon | Supermirror.
- Specified by:
setDescription
in interface NXfilter
- Parameters:
description
- the description
-
setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXfilter
Composition of the filter. Chemical formula can be specified separately.
This field was changed (2010-11-17) from an enumeration to
a string since common usage showed a wider variety of use
than a simple list. These are the items in the list at
the time of the change: Beryllium | Pyrolytic Graphite |
Graphite | Sapphire | Silicon | Supermirror.
- Specified by:
setDescriptionScalar
in interface NXfilter
- Parameters:
description
- the description
-
getStatus
public IDataset getStatus()
Description copied from interface: NXfilter
position with respect to in or out of the beam (choice of only "in" or "out")
Enumeration:
- in
in the beam
- out
out of the beam
-
getStatusScalar
public java.lang.String getStatusScalar()
Description copied from interface: NXfilter
position with respect to in or out of the beam (choice of only "in" or "out")
Enumeration:
- in
in the beam
- out
out of the beam
- Specified by:
getStatusScalar
in interface NXfilter
- Returns:
- the value.
-
setStatus
public DataNode setStatus(IDataset status)
Description copied from interface: NXfilter
position with respect to in or out of the beam (choice of only "in" or "out")
Enumeration:
- in
in the beam
- out
out of the beam
-
setStatusScalar
public DataNode setStatusScalar(java.lang.String status)
Description copied from interface: NXfilter
position with respect to in or out of the beam (choice of only "in" or "out")
Enumeration:
- in
in the beam
- out
out of the beam
- Specified by:
setStatusScalar
in interface NXfilter
- Parameters:
status
- the status
-
getTransmission
public NXdata getTransmission()
Description copied from interface: NXfilter
Wavelength transmission profile of filter
- Specified by:
getTransmission
in interface NXfilter
- Returns:
- the value.
-
setTransmission
public void setTransmission(NXdata transmission)
Description copied from interface: NXfilter
Wavelength transmission profile of filter
- Specified by:
setTransmission
in interface NXfilter
- Parameters:
transmission
- the transmission
-
getTemperature
public IDataset getTemperature()
Description copied from interface: NXfilter
average/nominal filter temperature
Type: NX_FLOAT
Units: NX_TEMPERATURE
- Specified by:
getTemperature
in interface NXfilter
- Returns:
- the value.
-
getTemperatureScalar
public java.lang.Double getTemperatureScalar()
Description copied from interface: NXfilter
average/nominal filter temperature
Type: NX_FLOAT
Units: NX_TEMPERATURE
- Specified by:
getTemperatureScalar
in interface NXfilter
- Returns:
- the value.
-
setTemperature
public DataNode setTemperature(IDataset temperature)
Description copied from interface: NXfilter
average/nominal filter temperature
Type: NX_FLOAT
Units: NX_TEMPERATURE
- Specified by:
setTemperature
in interface NXfilter
- Parameters:
temperature
- the temperature
-
setTemperatureScalar
public DataNode setTemperatureScalar(java.lang.Double temperature)
Description copied from interface: NXfilter
average/nominal filter temperature
Type: NX_FLOAT
Units: NX_TEMPERATURE
- Specified by:
setTemperatureScalar
in interface NXfilter
- Parameters:
temperature
- the temperature
-
getTemperature_log
public NXlog getTemperature_log()
Description copied from interface: NXfilter
Linked temperature_log for the filter
- Specified by:
getTemperature_log
in interface NXfilter
- Returns:
- the value.
-
setTemperature_log
public void setTemperature_log(NXlog temperature_log)
Description copied from interface: NXfilter
Linked temperature_log for the filter
- Specified by:
setTemperature_log
in interface NXfilter
- Parameters:
temperature_log
- the temperature_log
-
getThickness
public IDataset getThickness()
Description copied from interface: NXfilter
Thickness of the filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getThickness
in interface NXfilter
- Returns:
- the value.
-
getThicknessScalar
public java.lang.Double getThicknessScalar()
Description copied from interface: NXfilter
Thickness of the filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getThicknessScalar
in interface NXfilter
- Returns:
- the value.
-
setThickness
public DataNode setThickness(IDataset thickness)
Description copied from interface: NXfilter
Thickness of the filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setThickness
in interface NXfilter
- Parameters:
thickness
- the thickness
-
setThicknessScalar
public DataNode setThicknessScalar(java.lang.Double thickness)
Description copied from interface: NXfilter
Thickness of the filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setThicknessScalar
in interface NXfilter
- Parameters:
thickness
- the thickness
-
getDensity
public IDataset getDensity()
Description copied from interface: NXfilter
mass density of the filter
Type: NX_NUMBER
Units: NX_MASS_DENSITY
- Specified by:
getDensity
in interface NXfilter
- Returns:
- the value.
-
getDensityScalar
public java.lang.Number getDensityScalar()
Description copied from interface: NXfilter
mass density of the filter
Type: NX_NUMBER
Units: NX_MASS_DENSITY
- Specified by:
getDensityScalar
in interface NXfilter
- Returns:
- the value.
-
setDensity
public DataNode setDensity(IDataset density)
Description copied from interface: NXfilter
mass density of the filter
Type: NX_NUMBER
Units: NX_MASS_DENSITY
- Specified by:
setDensity
in interface NXfilter
- Parameters:
density
- the density
-
setDensityScalar
public DataNode setDensityScalar(java.lang.Number density)
Description copied from interface: NXfilter
mass density of the filter
Type: NX_NUMBER
Units: NX_MASS_DENSITY
- Specified by:
setDensityScalar
in interface NXfilter
- Parameters:
density
- the density
-
getChemical_formula
public IDataset getChemical_formula()
Description copied from interface: NXfilter
The chemical formula specified using CIF conventions.
Abbreviated version of CIF standard:
* Only recognized element symbols may be used.
* Each element symbol is followed by a 'count' number. A count of '1' may be omitted.
* A space or parenthesis must separate each cluster of (element symbol + count).
* Where a group of elements is enclosed in parentheses, the multiplier for the
group must follow the closing parentheses. That is, all element and group
multipliers are assumed to be printed as subscripted numbers.
* Unless the elements are ordered in a manner that corresponds to their chemical
structure, the order of the elements within any group or moiety depends on
whether or not carbon is present.
* If carbon is present, the order should be:
* C, then H, then the other elements in alphabetical order of their symbol.
* If carbon is not present, the elements are listed purely in alphabetic order of their symbol.
* This is the *Hill* system used by Chemical Abstracts.
- Specified by:
getChemical_formula
in interface NXfilter
- Returns:
- the value.
-
getChemical_formulaScalar
public java.lang.String getChemical_formulaScalar()
Description copied from interface: NXfilter
The chemical formula specified using CIF conventions.
Abbreviated version of CIF standard:
* Only recognized element symbols may be used.
* Each element symbol is followed by a 'count' number. A count of '1' may be omitted.
* A space or parenthesis must separate each cluster of (element symbol + count).
* Where a group of elements is enclosed in parentheses, the multiplier for the
group must follow the closing parentheses. That is, all element and group
multipliers are assumed to be printed as subscripted numbers.
* Unless the elements are ordered in a manner that corresponds to their chemical
structure, the order of the elements within any group or moiety depends on
whether or not carbon is present.
* If carbon is present, the order should be:
* C, then H, then the other elements in alphabetical order of their symbol.
* If carbon is not present, the elements are listed purely in alphabetic order of their symbol.
* This is the *Hill* system used by Chemical Abstracts.
- Specified by:
getChemical_formulaScalar
in interface NXfilter
- Returns:
- the value.
-
setChemical_formula
public DataNode setChemical_formula(IDataset chemical_formula)
Description copied from interface: NXfilter
The chemical formula specified using CIF conventions.
Abbreviated version of CIF standard:
* Only recognized element symbols may be used.
* Each element symbol is followed by a 'count' number. A count of '1' may be omitted.
* A space or parenthesis must separate each cluster of (element symbol + count).
* Where a group of elements is enclosed in parentheses, the multiplier for the
group must follow the closing parentheses. That is, all element and group
multipliers are assumed to be printed as subscripted numbers.
* Unless the elements are ordered in a manner that corresponds to their chemical
structure, the order of the elements within any group or moiety depends on
whether or not carbon is present.
* If carbon is present, the order should be:
* C, then H, then the other elements in alphabetical order of their symbol.
* If carbon is not present, the elements are listed purely in alphabetic order of their symbol.
* This is the *Hill* system used by Chemical Abstracts.
- Specified by:
setChemical_formula
in interface NXfilter
- Parameters:
chemical_formula
- the chemical_formula
-
setChemical_formulaScalar
public DataNode setChemical_formulaScalar(java.lang.String chemical_formula)
Description copied from interface: NXfilter
The chemical formula specified using CIF conventions.
Abbreviated version of CIF standard:
* Only recognized element symbols may be used.
* Each element symbol is followed by a 'count' number. A count of '1' may be omitted.
* A space or parenthesis must separate each cluster of (element symbol + count).
* Where a group of elements is enclosed in parentheses, the multiplier for the
group must follow the closing parentheses. That is, all element and group
multipliers are assumed to be printed as subscripted numbers.
* Unless the elements are ordered in a manner that corresponds to their chemical
structure, the order of the elements within any group or moiety depends on
whether or not carbon is present.
* If carbon is present, the order should be:
* C, then H, then the other elements in alphabetical order of their symbol.
* If carbon is not present, the elements are listed purely in alphabetic order of their symbol.
* This is the *Hill* system used by Chemical Abstracts.
- Specified by:
setChemical_formulaScalar
in interface NXfilter
- Parameters:
chemical_formula
- the chemical_formula
-
getSensor_type
public NXsensor getSensor_type()
Description copied from interface: NXfilter
Sensor(s)used to monitor the filter temperature
- Specified by:
getSensor_type
in interface NXfilter
- Returns:
- the value.
-
setSensor_type
public void setSensor_type(NXsensor sensor_type)
Description copied from interface: NXfilter
Sensor(s)used to monitor the filter temperature
- Specified by:
setSensor_type
in interface NXfilter
- Parameters:
sensor_type
- the sensor_type
-
getUnit_cell_a
public IDataset getUnit_cell_a()
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side a
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getUnit_cell_a
in interface NXfilter
- Returns:
- the value.
-
getUnit_cell_aScalar
public java.lang.Double getUnit_cell_aScalar()
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side a
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getUnit_cell_aScalar
in interface NXfilter
- Returns:
- the value.
-
setUnit_cell_a
public DataNode setUnit_cell_a(IDataset unit_cell_a)
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side a
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setUnit_cell_a
in interface NXfilter
- Parameters:
unit_cell_a
- the unit_cell_a
-
setUnit_cell_aScalar
public DataNode setUnit_cell_aScalar(java.lang.Double unit_cell_a)
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side a
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setUnit_cell_aScalar
in interface NXfilter
- Parameters:
unit_cell_a
- the unit_cell_a
-
getUnit_cell_b
public IDataset getUnit_cell_b()
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side b
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getUnit_cell_b
in interface NXfilter
- Returns:
- the value.
-
getUnit_cell_bScalar
public java.lang.Double getUnit_cell_bScalar()
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side b
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getUnit_cell_bScalar
in interface NXfilter
- Returns:
- the value.
-
setUnit_cell_b
public DataNode setUnit_cell_b(IDataset unit_cell_b)
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side b
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setUnit_cell_b
in interface NXfilter
- Parameters:
unit_cell_b
- the unit_cell_b
-
setUnit_cell_bScalar
public DataNode setUnit_cell_bScalar(java.lang.Double unit_cell_b)
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side b
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setUnit_cell_bScalar
in interface NXfilter
- Parameters:
unit_cell_b
- the unit_cell_b
-
getUnit_cell_c
public IDataset getUnit_cell_c()
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side c
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getUnit_cell_c
in interface NXfilter
- Returns:
- the value.
-
getUnit_cell_cScalar
public java.lang.Double getUnit_cell_cScalar()
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side c
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getUnit_cell_cScalar
in interface NXfilter
- Returns:
- the value.
-
setUnit_cell_c
public DataNode setUnit_cell_c(IDataset unit_cell_c)
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side c
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setUnit_cell_c
in interface NXfilter
- Parameters:
unit_cell_c
- the unit_cell_c
-
setUnit_cell_cScalar
public DataNode setUnit_cell_cScalar(java.lang.Double unit_cell_c)
Description copied from interface: NXfilter
Unit cell lattice parameter: length of side c
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setUnit_cell_cScalar
in interface NXfilter
- Parameters:
unit_cell_c
- the unit_cell_c
-
getUnit_cell_alpha
public IDataset getUnit_cell_alpha()
Description copied from interface: NXfilter
Unit cell lattice parameter: angle alpha
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
getUnit_cell_alpha
in interface NXfilter
- Returns:
- the value.
-
getUnit_cell_alphaScalar
public java.lang.Double getUnit_cell_alphaScalar()
Description copied from interface: NXfilter
Unit cell lattice parameter: angle alpha
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
getUnit_cell_alphaScalar
in interface NXfilter
- Returns:
- the value.
-
setUnit_cell_alpha
public DataNode setUnit_cell_alpha(IDataset unit_cell_alpha)
Description copied from interface: NXfilter
Unit cell lattice parameter: angle alpha
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
setUnit_cell_alpha
in interface NXfilter
- Parameters:
unit_cell_alpha
- the unit_cell_alpha
-
setUnit_cell_alphaScalar
public DataNode setUnit_cell_alphaScalar(java.lang.Double unit_cell_alpha)
Description copied from interface: NXfilter
Unit cell lattice parameter: angle alpha
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
setUnit_cell_alphaScalar
in interface NXfilter
- Parameters:
unit_cell_alpha
- the unit_cell_alpha
-
getUnit_cell_beta
public IDataset getUnit_cell_beta()
Description copied from interface: NXfilter
Unit cell lattice parameter: angle beta
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
getUnit_cell_beta
in interface NXfilter
- Returns:
- the value.
-
getUnit_cell_betaScalar
public java.lang.Double getUnit_cell_betaScalar()
Description copied from interface: NXfilter
Unit cell lattice parameter: angle beta
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
getUnit_cell_betaScalar
in interface NXfilter
- Returns:
- the value.
-
setUnit_cell_beta
public DataNode setUnit_cell_beta(IDataset unit_cell_beta)
Description copied from interface: NXfilter
Unit cell lattice parameter: angle beta
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
setUnit_cell_beta
in interface NXfilter
- Parameters:
unit_cell_beta
- the unit_cell_beta
-
setUnit_cell_betaScalar
public DataNode setUnit_cell_betaScalar(java.lang.Double unit_cell_beta)
Description copied from interface: NXfilter
Unit cell lattice parameter: angle beta
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
setUnit_cell_betaScalar
in interface NXfilter
- Parameters:
unit_cell_beta
- the unit_cell_beta
-
getUnit_cell_gamma
public IDataset getUnit_cell_gamma()
Description copied from interface: NXfilter
Unit cell lattice parameter: angle gamma
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
getUnit_cell_gamma
in interface NXfilter
- Returns:
- the value.
-
getUnit_cell_gammaScalar
public java.lang.Double getUnit_cell_gammaScalar()
Description copied from interface: NXfilter
Unit cell lattice parameter: angle gamma
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
getUnit_cell_gammaScalar
in interface NXfilter
- Returns:
- the value.
-
setUnit_cell_gamma
public DataNode setUnit_cell_gamma(IDataset unit_cell_gamma)
Description copied from interface: NXfilter
Unit cell lattice parameter: angle gamma
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
setUnit_cell_gamma
in interface NXfilter
- Parameters:
unit_cell_gamma
- the unit_cell_gamma
-
setUnit_cell_gammaScalar
public DataNode setUnit_cell_gammaScalar(java.lang.Double unit_cell_gamma)
Description copied from interface: NXfilter
Unit cell lattice parameter: angle gamma
Type: NX_FLOAT
Units: NX_ANGLE
- Specified by:
setUnit_cell_gammaScalar
in interface NXfilter
- Parameters:
unit_cell_gamma
- the unit_cell_gamma
-
getUnit_cell_volume
public IDataset getUnit_cell_volume()
Description copied from interface: NXfilter
Unit cell
Type: NX_FLOAT
Units: NX_VOLUME
Dimensions: 1: n_comp;
- Specified by:
getUnit_cell_volume
in interface NXfilter
- Returns:
- the value.
-
getUnit_cell_volumeScalar
public java.lang.Double getUnit_cell_volumeScalar()
Description copied from interface: NXfilter
Unit cell
Type: NX_FLOAT
Units: NX_VOLUME
Dimensions: 1: n_comp;
- Specified by:
getUnit_cell_volumeScalar
in interface NXfilter
- Returns:
- the value.
-
setUnit_cell_volume
public DataNode setUnit_cell_volume(IDataset unit_cell_volume)
Description copied from interface: NXfilter
Unit cell
Type: NX_FLOAT
Units: NX_VOLUME
Dimensions: 1: n_comp;
- Specified by:
setUnit_cell_volume
in interface NXfilter
- Parameters:
unit_cell_volume
- the unit_cell_volume
-
setUnit_cell_volumeScalar
public DataNode setUnit_cell_volumeScalar(java.lang.Double unit_cell_volume)
Description copied from interface: NXfilter
Unit cell
Type: NX_FLOAT
Units: NX_VOLUME
Dimensions: 1: n_comp;
- Specified by:
setUnit_cell_volumeScalar
in interface NXfilter
- Parameters:
unit_cell_volume
- the unit_cell_volume
-
getOrientation_matrix
public IDataset getOrientation_matrix()
Description copied from interface: NXfilter
Orientation matrix of single crystal filter using Busing-Levy convention:
W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
Type: NX_FLOAT
Dimensions: 1: n_comp; 2: 3; 3: 3;
- Specified by:
getOrientation_matrix
in interface NXfilter
- Returns:
- the value.
-
getOrientation_matrixScalar
public java.lang.Double getOrientation_matrixScalar()
Description copied from interface: NXfilter
Orientation matrix of single crystal filter using Busing-Levy convention:
W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
Type: NX_FLOAT
Dimensions: 1: n_comp; 2: 3; 3: 3;
- Specified by:
getOrientation_matrixScalar
in interface NXfilter
- Returns:
- the value.
-
setOrientation_matrix
public DataNode setOrientation_matrix(IDataset orientation_matrix)
Description copied from interface: NXfilter
Orientation matrix of single crystal filter using Busing-Levy convention:
W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
Type: NX_FLOAT
Dimensions: 1: n_comp; 2: 3; 3: 3;
- Specified by:
setOrientation_matrix
in interface NXfilter
- Parameters:
orientation_matrix
- the orientation_matrix
-
setOrientation_matrixScalar
public DataNode setOrientation_matrixScalar(java.lang.Double orientation_matrix)
Description copied from interface: NXfilter
Orientation matrix of single crystal filter using Busing-Levy convention:
W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
Type: NX_FLOAT
Dimensions: 1: n_comp; 2: 3; 3: 3;
- Specified by:
setOrientation_matrixScalar
in interface NXfilter
- Parameters:
orientation_matrix
- the orientation_matrix
-
getM_value
public IDataset getM_value()
Description copied from interface: NXfilter
m value of supermirror filter
Type: NX_FLOAT
Units: NX_DIMENSIONLESS
- Specified by:
getM_value
in interface NXfilter
- Returns:
- the value.
-
getM_valueScalar
public java.lang.Double getM_valueScalar()
Description copied from interface: NXfilter
m value of supermirror filter
Type: NX_FLOAT
Units: NX_DIMENSIONLESS
- Specified by:
getM_valueScalar
in interface NXfilter
- Returns:
- the value.
-
setM_value
public DataNode setM_value(IDataset m_value)
Description copied from interface: NXfilter
m value of supermirror filter
Type: NX_FLOAT
Units: NX_DIMENSIONLESS
- Specified by:
setM_value
in interface NXfilter
- Parameters:
m_value
- the m_value
-
setM_valueScalar
public DataNode setM_valueScalar(java.lang.Double m_value)
Description copied from interface: NXfilter
m value of supermirror filter
Type: NX_FLOAT
Units: NX_DIMENSIONLESS
- Specified by:
setM_valueScalar
in interface NXfilter
- Parameters:
m_value
- the m_value
-
getSubstrate_material
public IDataset getSubstrate_material()
Description copied from interface: NXfilter
substrate material of supermirror filter
- Specified by:
getSubstrate_material
in interface NXfilter
- Returns:
- the value.
-
getSubstrate_materialScalar
public java.lang.String getSubstrate_materialScalar()
Description copied from interface: NXfilter
substrate material of supermirror filter
- Specified by:
getSubstrate_materialScalar
in interface NXfilter
- Returns:
- the value.
-
setSubstrate_material
public DataNode setSubstrate_material(IDataset substrate_material)
Description copied from interface: NXfilter
substrate material of supermirror filter
- Specified by:
setSubstrate_material
in interface NXfilter
- Parameters:
substrate_material
- the substrate_material
-
setSubstrate_materialScalar
public DataNode setSubstrate_materialScalar(java.lang.String substrate_material)
Description copied from interface: NXfilter
substrate material of supermirror filter
- Specified by:
setSubstrate_materialScalar
in interface NXfilter
- Parameters:
substrate_material
- the substrate_material
-
getSubstrate_thickness
public IDataset getSubstrate_thickness()
Description copied from interface: NXfilter
substrate thickness of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getSubstrate_thickness
in interface NXfilter
- Returns:
- the value.
-
getSubstrate_thicknessScalar
public java.lang.Double getSubstrate_thicknessScalar()
Description copied from interface: NXfilter
substrate thickness of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getSubstrate_thicknessScalar
in interface NXfilter
- Returns:
- the value.
-
setSubstrate_thickness
public DataNode setSubstrate_thickness(IDataset substrate_thickness)
Description copied from interface: NXfilter
substrate thickness of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setSubstrate_thickness
in interface NXfilter
- Parameters:
substrate_thickness
- the substrate_thickness
-
setSubstrate_thicknessScalar
public DataNode setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)
Description copied from interface: NXfilter
substrate thickness of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setSubstrate_thicknessScalar
in interface NXfilter
- Parameters:
substrate_thickness
- the substrate_thickness
-
getCoating_material
public IDataset getCoating_material()
Description copied from interface: NXfilter
coating material of supermirror filter
- Specified by:
getCoating_material
in interface NXfilter
- Returns:
- the value.
-
getCoating_materialScalar
public java.lang.String getCoating_materialScalar()
Description copied from interface: NXfilter
coating material of supermirror filter
- Specified by:
getCoating_materialScalar
in interface NXfilter
- Returns:
- the value.
-
setCoating_material
public DataNode setCoating_material(IDataset coating_material)
Description copied from interface: NXfilter
coating material of supermirror filter
- Specified by:
setCoating_material
in interface NXfilter
- Parameters:
coating_material
- the coating_material
-
setCoating_materialScalar
public DataNode setCoating_materialScalar(java.lang.String coating_material)
Description copied from interface: NXfilter
coating material of supermirror filter
- Specified by:
setCoating_materialScalar
in interface NXfilter
- Parameters:
coating_material
- the coating_material
-
getSubstrate_roughness
public IDataset getSubstrate_roughness()
Description copied from interface: NXfilter
substrate roughness (RMS) of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getSubstrate_roughness
in interface NXfilter
- Returns:
- the value.
-
getSubstrate_roughnessScalar
public java.lang.Double getSubstrate_roughnessScalar()
Description copied from interface: NXfilter
substrate roughness (RMS) of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getSubstrate_roughnessScalar
in interface NXfilter
- Returns:
- the value.
-
setSubstrate_roughness
public DataNode setSubstrate_roughness(IDataset substrate_roughness)
Description copied from interface: NXfilter
substrate roughness (RMS) of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setSubstrate_roughness
in interface NXfilter
- Parameters:
substrate_roughness
- the substrate_roughness
-
setSubstrate_roughnessScalar
public DataNode setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)
Description copied from interface: NXfilter
substrate roughness (RMS) of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setSubstrate_roughnessScalar
in interface NXfilter
- Parameters:
substrate_roughness
- the substrate_roughness
-
getCoating_roughness
public IDataset getCoating_roughness()
Description copied from interface: NXfilter
coating roughness (RMS) of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
Dimensions: 1: nsurf;
- Specified by:
getCoating_roughness
in interface NXfilter
- Returns:
- the value.
-
getCoating_roughnessScalar
public java.lang.Double getCoating_roughnessScalar()
Description copied from interface: NXfilter
coating roughness (RMS) of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
Dimensions: 1: nsurf;
- Specified by:
getCoating_roughnessScalar
in interface NXfilter
- Returns:
- the value.
-
setCoating_roughness
public DataNode setCoating_roughness(IDataset coating_roughness)
Description copied from interface: NXfilter
coating roughness (RMS) of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
Dimensions: 1: nsurf;
- Specified by:
setCoating_roughness
in interface NXfilter
- Parameters:
coating_roughness
- the coating_roughness
-
setCoating_roughnessScalar
public DataNode setCoating_roughnessScalar(java.lang.Double coating_roughness)
Description copied from interface: NXfilter
coating roughness (RMS) of supermirror filter
Type: NX_FLOAT
Units: NX_LENGTH
Dimensions: 1: nsurf;
- Specified by:
setCoating_roughnessScalar
in interface NXfilter
- Parameters:
coating_roughness
- the coating_roughness