• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXattenuator.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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
Interface NXattenuator






All Superinterfaces:
GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject


All Known Implementing Classes:
NXattenuatorImpl




public interface NXattenuator
extends NXobject
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`.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_ABSORPTION_CROSS_SECTION 


static java.lang.String
NX_ATTENUATOR_TRANSMISSION 


static java.lang.String
NX_DISTANCE 


static java.lang.String
NX_SCATTERING_CROSS_SECTION 


static java.lang.String
NX_STATUS 


static java.lang.String
NX_STATUS_ATTRIBUTE_TIME 


static java.lang.String
NX_THICKNESS 


static java.lang.String
NX_TYPE 






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








Method Summary

All Methods Instance Methods Abstract 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



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





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














Field Detail





NX_DISTANCE
static final java.lang.String NX_DISTANCE

See Also:
Constant Field Values








NX_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_THICKNESS
static final java.lang.String NX_THICKNESS

See Also:
Constant Field Values








NX_SCATTERING_CROSS_SECTION
static final java.lang.String NX_SCATTERING_CROSS_SECTION

See Also:
Constant Field Values








NX_ABSORPTION_CROSS_SECTION
static final java.lang.String NX_ABSORPTION_CROSS_SECTION

See Also:
Constant Field Values








NX_ATTENUATOR_TRANSMISSION
static final java.lang.String NX_ATTENUATOR_TRANSMISSION

See Also:
Constant Field Values








NX_STATUS
static final java.lang.String NX_STATUS

See Also:
Constant Field Values








NX_STATUS_ATTRIBUTE_TIME
static final java.lang.String NX_STATUS_ATTRIBUTE_TIME

See Also:
Constant Field Values










Method Detail





getDistance
IDataset getDistance()
Distance from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistance
DataNode setDistance(IDataset distance)
Distance from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getDistanceScalar
java.lang.Double getDistanceScalar()
Distance from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








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

Returns:
the value.








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

Parameters:
type - the type








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

Returns:
the value.








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

Parameters:
type - the type








getThickness
IDataset getThickness()
Thickness of attenuator along beam direction
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
thickness - the thickness








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
thickness - the thickness








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

 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Parameters:
scattering_cross_section - the scattering_cross_section








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

 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Parameters:
scattering_cross_section - the scattering_cross_section








getAbsorption_cross_section
IDataset getAbsorption_cross_section()
Absorption cross section
 

 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Returns:
the value.








setAbsorption_cross_section
DataNode setAbsorption_cross_section(IDataset absorption_cross_section)
Absorption cross section
 

 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Parameters:
absorption_cross_section - the absorption_cross_section








getAbsorption_cross_sectionScalar
java.lang.Double getAbsorption_cross_sectionScalar()
Absorption cross section
 

 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_CROSS_SECTION
 

Parameters:
absorption_cross_section - the absorption_cross_section








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

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Parameters:
attenuator_transmission - the attenuator_transmission








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

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Parameters:
attenuator_transmission - the attenuator_transmission








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

 
Enumeration:

 
in 
 
out 
 
moving 

 


Returns:
the value.








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

 
Enumeration:

 
in 
 
out 
 
moving 

 


Parameters:
status - the status








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

 
Enumeration:

 
in 
 
out 
 
moving 

 


Returns:
the value.








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

 
Enumeration:

 
in 
 
out 
 
moving 

 


Parameters:
status - the status








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

Returns:
the value.








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

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