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






NXattenuatorImpl (h5jan API)











Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.nexus.impl
Class NXattenuatorImpl



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.NXattenuatorImpl













All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXattenuator, NXobject




public class NXattenuatorImpl
extends NXobjectImpl
implements NXattenuator
A device that reduces the intensity of a beam by attenuation.
 If uncertain whether to use :ref:`NXfilter` (band-pass filter)
 or :ref:`NXattenuator` (reduces beam intensity), then choose
 :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.NXattenuator
NX_ABSORPTION_CROSS_SECTION, NX_ATTENUATOR_TRANSMISSION, NX_DISTANCE, NX_SCATTERING_CROSS_SECTION, NX_STATUS, NX_STATUS_ATTRIBUTE_TIME, NX_THICKNESS, NX_TYPE





Fields inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
ATTRIBUTE, SEPARATOR








Constructor Summary

Constructors 

Constructor and Description


NXattenuatorImpl() 


NXattenuatorImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getAbsorption_cross_section()
Absorption cross section



java.lang.Double
getAbsorption_cross_sectionScalar()
Absorption cross section



IDataset
getAttenuator_transmission()
The nominal amount of the beam that gets through
 (transmitted intensity)/(incident intensity)



java.lang.Double
getAttenuator_transmissionScalar()
The nominal amount of the beam that gets through
 (transmitted intensity)/(incident intensity)



IDataset
getDistance()
Distance from sample



java.lang.Double
getDistanceScalar()
Distance from sample



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.



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



IDataset
getScattering_cross_section()
Scattering cross section (coherent+incoherent)



java.lang.Double
getScattering_cross_sectionScalar()
Scattering cross section (coherent+incoherent)



IDataset
getStatus()
In or out or moving of the beam



java.util.Date
getStatusAttributeTime()
time stamp for this observation



java.lang.String
getStatusScalar()
In or out or moving of the beam



IDataset
getThickness()
Thickness of attenuator along beam direction



java.lang.Double
getThicknessScalar()
Thickness of attenuator along beam direction



IDataset
getType()
Type or composition of attenuator, e.g.



java.lang.String
getTypeScalar()
Type or composition of attenuator, e.g.



DataNode
setAbsorption_cross_section(IDataset absorption_cross_section)
Absorption cross section



DataNode
setAbsorption_cross_sectionScalar(java.lang.Double absorption_cross_section)
Absorption cross section



DataNode
setAttenuator_transmission(IDataset attenuator_transmission)
The nominal amount of the beam that gets through
 (transmitted intensity)/(incident intensity)



DataNode
setAttenuator_transmissionScalar(java.lang.Double attenuator_transmission)
The nominal amount of the beam that gets through
 (transmitted intensity)/(incident intensity)



DataNode
setDistance(IDataset distance)
Distance from sample



DataNode
setDistanceScalar(java.lang.Double distance)
Distance from sample



DataNode
setScattering_cross_section(IDataset scattering_cross_section)
Scattering cross section (coherent+incoherent)



DataNode
setScattering_cross_sectionScalar(java.lang.Double scattering_cross_section)
Scattering cross section (coherent+incoherent)



DataNode
setStatus(IDataset status)
In or out or moving of the beam



void
setStatusAttributeTime(java.util.Date time)
time stamp for this observation



DataNode
setStatusScalar(java.lang.String status)
In or out or moving of the beam



DataNode
setThickness(IDataset thickness)
Thickness of attenuator along beam direction



DataNode
setThicknessScalar(java.lang.Double thickness)
Thickness of attenuator along beam direction



DataNode
setType(IDataset type)
Type or composition of attenuator, e.g.



DataNode
setTypeScalar(java.lang.String type)
Type or composition of attenuator, e.g.







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





Methods inherited from interface java.lang.Iterable
forEach, spliterator














Field Detail





PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES









Constructor Detail





NXattenuatorImpl
public NXattenuatorImpl()







NXattenuatorImpl
public NXattenuatorImpl(long oid)









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








getDistance
public IDataset getDistance()
Description copied from interface: NXattenuator
Distance from sample
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDistance in interface NXattenuator
Returns:
the value.








getDistanceScalar
public java.lang.Double getDistanceScalar()
Description copied from interface: NXattenuator
Distance from sample
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDistanceScalar in interface NXattenuator
Returns:
the value.








setDistance
public DataNode setDistance(IDataset distance)
Description copied from interface: NXattenuator
Distance from sample
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDistance in interface NXattenuator
Parameters:
distance - the distance








setDistanceScalar
public DataNode setDistanceScalar(java.lang.Double distance)
Description copied from interface: NXattenuator
Distance from sample
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDistanceScalar in interface NXattenuator
Parameters:
distance - the distance








getType
public IDataset getType()
Description copied from interface: NXattenuator
Type or composition of attenuator, e.g. polythene

Specified by:
getType in interface NXattenuator
Returns:
the value.








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXattenuator
Type or composition of attenuator, e.g. polythene

Specified by:
getTypeScalar in interface NXattenuator
Returns:
the value.








setType
public DataNode setType(IDataset type)
Description copied from interface: NXattenuator
Type or composition of attenuator, e.g. polythene

Specified by:
setType in interface NXattenuator
Parameters:
type - the type








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXattenuator
Type or composition of attenuator, e.g. polythene

Specified by:
setTypeScalar in interface NXattenuator
Parameters:
type - the type








getThickness
public IDataset getThickness()
Description copied from interface: NXattenuator
Thickness of attenuator along beam direction
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getThickness in interface NXattenuator
Returns:
the value.








getThicknessScalar
public java.lang.Double getThicknessScalar()
Description copied from interface: NXattenuator
Thickness of attenuator along beam direction
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getThicknessScalar in interface NXattenuator
Returns:
the value.








setThickness
public DataNode setThickness(IDataset thickness)
Description copied from interface: NXattenuator
Thickness of attenuator along beam direction
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setThickness in interface NXattenuator
Parameters:
thickness - the thickness








setThicknessScalar
public DataNode setThicknessScalar(java.lang.Double thickness)
Description copied from interface: NXattenuator
Thickness of attenuator along beam direction
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setThicknessScalar in interface NXattenuator
Parameters:
thickness - the thickness








getScattering_cross_section
public IDataset getScattering_cross_section()
Description copied from interface: NXattenuator
Scattering cross section (coherent+incoherent)
 
 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Specified by:
getScattering_cross_section in interface NXattenuator
Returns:
the value.








getScattering_cross_sectionScalar
public java.lang.Double getScattering_cross_sectionScalar()
Description copied from interface: NXattenuator
Scattering cross section (coherent+incoherent)
 
 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Specified by:
getScattering_cross_sectionScalar in interface NXattenuator
Returns:
the value.








setScattering_cross_section
public DataNode setScattering_cross_section(IDataset scattering_cross_section)
Description copied from interface: NXattenuator
Scattering cross section (coherent+incoherent)
 
 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Specified by:
setScattering_cross_section in interface NXattenuator
Parameters:
scattering_cross_section - the scattering_cross_section








setScattering_cross_sectionScalar
public DataNode setScattering_cross_sectionScalar(java.lang.Double scattering_cross_section)
Description copied from interface: NXattenuator
Scattering cross section (coherent+incoherent)
 
 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Specified by:
setScattering_cross_sectionScalar in interface NXattenuator
Parameters:
scattering_cross_section - the scattering_cross_section








getAbsorption_cross_section
public IDataset getAbsorption_cross_section()
Description copied from interface: NXattenuator
Absorption cross section
 
 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Specified by:
getAbsorption_cross_section in interface NXattenuator
Returns:
the value.








getAbsorption_cross_sectionScalar
public java.lang.Double getAbsorption_cross_sectionScalar()
Description copied from interface: NXattenuator
Absorption cross section
 
 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Specified by:
getAbsorption_cross_sectionScalar in interface NXattenuator
Returns:
the value.








setAbsorption_cross_section
public DataNode setAbsorption_cross_section(IDataset absorption_cross_section)
Description copied from interface: NXattenuator
Absorption cross section
 
 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Specified by:
setAbsorption_cross_section in interface NXattenuator
Parameters:
absorption_cross_section - the absorption_cross_section








setAbsorption_cross_sectionScalar
public DataNode setAbsorption_cross_sectionScalar(java.lang.Double absorption_cross_section)
Description copied from interface: NXattenuator
Absorption cross section
 
 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Specified by:
setAbsorption_cross_sectionScalar in interface NXattenuator
Parameters:
absorption_cross_section - the absorption_cross_section








getAttenuator_transmission
public IDataset getAttenuator_transmission()
Description copied from interface: NXattenuator
The nominal amount of the beam that gets through
 (transmitted intensity)/(incident intensity)
 
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Specified by:
getAttenuator_transmission in interface NXattenuator
Returns:
the value.








getAttenuator_transmissionScalar
public java.lang.Double getAttenuator_transmissionScalar()
Description copied from interface: NXattenuator
The nominal amount of the beam that gets through
 (transmitted intensity)/(incident intensity)
 
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Specified by:
getAttenuator_transmissionScalar in interface NXattenuator
Returns:
the value.








setAttenuator_transmission
public DataNode setAttenuator_transmission(IDataset attenuator_transmission)
Description copied from interface: NXattenuator
The nominal amount of the beam that gets through
 (transmitted intensity)/(incident intensity)
 
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Specified by:
setAttenuator_transmission in interface NXattenuator
Parameters:
attenuator_transmission - the attenuator_transmission








setAttenuator_transmissionScalar
public DataNode setAttenuator_transmissionScalar(java.lang.Double attenuator_transmission)
Description copied from interface: NXattenuator
The nominal amount of the beam that gets through
 (transmitted intensity)/(incident intensity)
 
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Specified by:
setAttenuator_transmissionScalar in interface NXattenuator
Parameters:
attenuator_transmission - the attenuator_transmission








getStatus
public IDataset getStatus()
Description copied from interface: NXattenuator
In or out or moving of the beam
 
 
Enumeration:

 in 
 out 
 moving 

 

Specified by:
getStatus in interface NXattenuator
Returns:
the value.








getStatusScalar
public java.lang.String getStatusScalar()
Description copied from interface: NXattenuator
In or out or moving of the beam
 
 
Enumeration:

 in 
 out 
 moving 

 

Specified by:
getStatusScalar in interface NXattenuator
Returns:
the value.








setStatus
public DataNode setStatus(IDataset status)
Description copied from interface: NXattenuator
In or out or moving of the beam
 
 
Enumeration:

 in 
 out 
 moving 

 

Specified by:
setStatus in interface NXattenuator
Parameters:
status - the status








setStatusScalar
public DataNode setStatusScalar(java.lang.String status)
Description copied from interface: NXattenuator
In or out or moving of the beam
 
 
Enumeration:

 in 
 out 
 moving 

 

Specified by:
setStatusScalar in interface NXattenuator
Parameters:
status - the status








getStatusAttributeTime
public java.util.Date getStatusAttributeTime()
Description copied from interface: NXattenuator
time stamp for this observation

Specified by:
getStatusAttributeTime in interface NXattenuator
Returns:
the value.








setStatusAttributeTime
public void setStatusAttributeTime(java.util.Date time)
Description copied from interface: NXattenuator
time stamp for this observation

Specified by:
setStatusAttributeTime in interface NXattenuator
Parameters:
time - the time














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method

Modifier and Type	Method and Description
`IDataset`	`getAbsorption_cross_section()` Absorption cross section
`java.lang.Double`	`getAbsorption_cross_sectionScalar()` Absorption cross section
`IDataset`	`getAttenuator_transmission()` The nominal amount of the beam that gets through (transmitted intensity)/(incident intensity)
`java.lang.Double`	`getAttenuator_transmissionScalar()` The nominal amount of the beam that gets through (transmitted intensity)/(incident intensity)
`IDataset`	`getDistance()` Distance from sample
`java.lang.Double`	`getDistanceScalar()` Distance from sample
`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.
`java.util.Set<NexusBaseClass>`	`getPermittedChildGroupClasses()` Returns a set containing the `NexusBaseClass` constants for the permitted child group types of this base class.
`IDataset`	`getScattering_cross_section()` Scattering cross section (coherent+incoherent)
`java.lang.Double`	`getScattering_cross_sectionScalar()` Scattering cross section (coherent+incoherent)
`IDataset`	`getStatus()` In or out or moving of the beam
`java.util.Date`	`getStatusAttributeTime()` time stamp for this observation
`java.lang.String`	`getStatusScalar()` In or out or moving of the beam
`IDataset`	`getThickness()` Thickness of attenuator along beam direction
`java.lang.Double`	`getThicknessScalar()` Thickness of attenuator along beam direction
`IDataset`	`getType()` Type or composition of attenuator, e.g.
`java.lang.String`	`getTypeScalar()` Type or composition of attenuator, e.g.
`DataNode`	`setAbsorption_cross_section(IDataset absorption_cross_section)` Absorption cross section
`DataNode`	`setAbsorption_cross_sectionScalar(java.lang.Double absorption_cross_section)` Absorption cross section
`DataNode`	`setAttenuator_transmission(IDataset attenuator_transmission)` The nominal amount of the beam that gets through (transmitted intensity)/(incident intensity)
`DataNode`	`setAttenuator_transmissionScalar(java.lang.Double attenuator_transmission)` The nominal amount of the beam that gets through (transmitted intensity)/(incident intensity)
`DataNode`	`setDistance(IDataset distance)` Distance from sample
`DataNode`	`setDistanceScalar(java.lang.Double distance)` Distance from sample
`DataNode`	`setScattering_cross_section(IDataset scattering_cross_section)` Scattering cross section (coherent+incoherent)
`DataNode`	`setScattering_cross_sectionScalar(java.lang.Double scattering_cross_section)` Scattering cross section (coherent+incoherent)
`DataNode`	`setStatus(IDataset status)` In or out or moving of the beam
`void`	`setStatusAttributeTime(java.util.Date time)` time stamp for this observation
`DataNode`	`setStatusScalar(java.lang.String status)` In or out or moving of the beam
`DataNode`	`setThickness(IDataset thickness)` Thickness of attenuator along beam direction
`DataNode`	`setThicknessScalar(java.lang.Double thickness)` Thickness of attenuator along beam direction
`DataNode`	`setType(IDataset type)` Type or composition of attenuator, e.g.
`DataNode`	`setTypeScalar(java.lang.String type)` Type or composition of attenuator, e.g.

Constructors
Constructor and Description
`NXattenuatorImpl()`
`NXattenuatorImpl(long oid)`