• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXbeamImpl.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.impl.NXbeamImpl.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.impl
Class NXbeamImpl



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













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




public class NXbeamImpl
extends NXobjectImpl
implements NXbeam
Properties of the neutron or X-ray beam at a given location.
 It will be referenced
 by beamline component groups within the :ref:`NXinstrument` group or by the :ref:`NXsample` group. Note
 that variables such as the incident energy could be scalar values or arrays. This group is
 especially valuable in storing the results of instrument simulations in which it is useful
 to specify the beam profile, time distribution etc. at each beamline component. Otherwise,
 its most likely use is in the :ref:`NXsample` group in which it defines the results of the neutron
 scattering by the sample, e.g., energy transfer, polarizations.

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.NXbeam
NX_DISTANCE, NX_ENERGY_TRANSFER, NX_FINAL_BEAM_DIVERGENCE, NX_FINAL_ENERGY, NX_FINAL_POLARIZATION, NX_FINAL_WAVELENGTH, NX_FINAL_WAVELENGTH_SPREAD, NX_FLUX, NX_INCIDENT_BEAM_DIVERGENCE, NX_INCIDENT_ENERGY, NX_INCIDENT_POLARIZATION, NX_INCIDENT_WAVELENGTH, NX_INCIDENT_WAVELENGTH_SPREAD





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








Constructor Summary

Constructors 

Constructor and Description


NXbeamImpl() 


NXbeamImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXdata>
getAllData()
Get all NXdata nodes:
 
 
 Distribution of beam with respect to relevant variable e.g.



NXdata
getData()
Distribution of beam with respect to relevant variable e.g.



NXdata
getData(java.lang.String name)
Get a NXdata node by name:
 
 
 Distribution of beam with respect to relevant variable e.g.



IDataset
getDistance()
Distance from sample



java.lang.Double
getDistanceScalar()
Distance from sample



IDataset
getEnergy_transfer()
Energy change caused by beamline component



java.lang.Double
getEnergy_transferScalar()
Energy change caused by beamline component



IDataset
getFinal_beam_divergence()
Divergence FWHM of beam leaving this component



java.lang.Double
getFinal_beam_divergenceScalar()
Divergence FWHM of beam leaving this component



IDataset
getFinal_energy()
Energy on leaving beamline component



java.lang.Double
getFinal_energyScalar()
Energy on leaving beamline component



IDataset
getFinal_polarization()
Polarization vector on leaving beamline component



java.lang.Double
getFinal_polarizationScalar()
Polarization vector on leaving beamline component



IDataset
getFinal_wavelength_spread()
Wavelength spread FWHM of beam leaving this component



java.lang.Double
getFinal_wavelength_spreadScalar()
Wavelength spread FWHM of beam leaving this component



IDataset
getFinal_wavelength()
Wavelength on leaving beamline component



java.lang.Double
getFinal_wavelengthScalar()
Wavelength on leaving beamline component



IDataset
getFlux()
flux incident on beam plane area



java.lang.Double
getFluxScalar()
flux incident on beam plane area



IDataset
getIncident_beam_divergence()
Divergence of beam entering this component



java.lang.Double
getIncident_beam_divergenceScalar()
Divergence of beam entering this component



IDataset
getIncident_energy()
Energy on entering beamline component



java.lang.Double
getIncident_energyScalar()
Energy on entering beamline component



IDataset
getIncident_polarization()
Polarization vector on entering beamline component



java.lang.Double
getIncident_polarizationScalar()
Polarization vector on entering beamline component



IDataset
getIncident_wavelength_spread()
Wavelength spread FWHM on entering component



java.lang.Double
getIncident_wavelength_spreadScalar()
Wavelength spread FWHM on entering component



IDataset
getIncident_wavelength()
Wavelength on entering beamline component



java.lang.Double
getIncident_wavelengthScalar()
Wavelength on entering beamline component



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.



void
setAllData(java.util.Map<java.lang.String,NXdata> data)
Set multiple child nodes of a particular type.



void
setData(NXdata data)
Distribution of beam with respect to relevant variable e.g.



void
setData(java.lang.String name,
       NXdata data)
Set a NXdata node by name:
 
 
 Distribution of beam with respect to relevant variable e.g.



DataNode
setDistance(IDataset distance)
Distance from sample



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



DataNode
setEnergy_transfer(IDataset energy_transfer)
Energy change caused by beamline component



DataNode
setEnergy_transferScalar(java.lang.Double energy_transfer)
Energy change caused by beamline component



DataNode
setFinal_beam_divergence(IDataset final_beam_divergence)
Divergence FWHM of beam leaving this component



DataNode
setFinal_beam_divergenceScalar(java.lang.Double final_beam_divergence)
Divergence FWHM of beam leaving this component



DataNode
setFinal_energy(IDataset final_energy)
Energy on leaving beamline component



DataNode
setFinal_energyScalar(java.lang.Double final_energy)
Energy on leaving beamline component



DataNode
setFinal_polarization(IDataset final_polarization)
Polarization vector on leaving beamline component



DataNode
setFinal_polarizationScalar(java.lang.Double final_polarization)
Polarization vector on leaving beamline component



DataNode
setFinal_wavelength_spread(IDataset final_wavelength_spread)
Wavelength spread FWHM of beam leaving this component



DataNode
setFinal_wavelength_spreadScalar(java.lang.Double final_wavelength_spread)
Wavelength spread FWHM of beam leaving this component



DataNode
setFinal_wavelength(IDataset final_wavelength)
Wavelength on leaving beamline component



DataNode
setFinal_wavelengthScalar(java.lang.Double final_wavelength)
Wavelength on leaving beamline component



DataNode
setFlux(IDataset flux)
flux incident on beam plane area



DataNode
setFluxScalar(java.lang.Double flux)
flux incident on beam plane area



DataNode
setIncident_beam_divergence(IDataset incident_beam_divergence)
Divergence of beam entering this component



DataNode
setIncident_beam_divergenceScalar(java.lang.Double incident_beam_divergence)
Divergence of beam entering this component



DataNode
setIncident_energy(IDataset incident_energy)
Energy on entering beamline component



DataNode
setIncident_energyScalar(java.lang.Double incident_energy)
Energy on entering beamline component



DataNode
setIncident_polarization(IDataset incident_polarization)
Polarization vector on entering beamline component



DataNode
setIncident_polarizationScalar(java.lang.Double incident_polarization)
Polarization vector on entering beamline component



DataNode
setIncident_wavelength_spread(IDataset incident_wavelength_spread)
Wavelength spread FWHM on entering component



DataNode
setIncident_wavelength_spreadScalar(java.lang.Double incident_wavelength_spread)
Wavelength spread FWHM on entering component



DataNode
setIncident_wavelength(IDataset incident_wavelength)
Wavelength on entering beamline component



DataNode
setIncident_wavelengthScalar(java.lang.Double incident_wavelength)
Wavelength on entering beamline component







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





NXbeamImpl
public NXbeamImpl()







NXbeamImpl
public NXbeamImpl(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: NXbeam
Distance from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

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








getDistanceScalar
public java.lang.Double getDistanceScalar()
Description copied from interface: NXbeam
Distance from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

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








setDistance
public DataNode setDistance(IDataset distance)
Description copied from interface: NXbeam
Distance from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

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








setDistanceScalar
public DataNode setDistanceScalar(java.lang.Double distance)
Description copied from interface: NXbeam
Distance from sample
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

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








getIncident_energy
public IDataset getIncident_energy()
Description copied from interface: NXbeam
Energy on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
getIncident_energy in interface NXbeam
Returns:
the value.








getIncident_energyScalar
public java.lang.Double getIncident_energyScalar()
Description copied from interface: NXbeam
Energy on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
getIncident_energyScalar in interface NXbeam
Returns:
the value.








setIncident_energy
public DataNode setIncident_energy(IDataset incident_energy)
Description copied from interface: NXbeam
Energy on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
setIncident_energy in interface NXbeam
Parameters:
incident_energy - the incident_energy








setIncident_energyScalar
public DataNode setIncident_energyScalar(java.lang.Double incident_energy)
Description copied from interface: NXbeam
Energy on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
setIncident_energyScalar in interface NXbeam
Parameters:
incident_energy - the incident_energy








getFinal_energy
public IDataset getFinal_energy()
Description copied from interface: NXbeam
Energy on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
getFinal_energy in interface NXbeam
Returns:
the value.








getFinal_energyScalar
public java.lang.Double getFinal_energyScalar()
Description copied from interface: NXbeam
Energy on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
getFinal_energyScalar in interface NXbeam
Returns:
the value.








setFinal_energy
public DataNode setFinal_energy(IDataset final_energy)
Description copied from interface: NXbeam
Energy on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
setFinal_energy in interface NXbeam
Parameters:
final_energy - the final_energy








setFinal_energyScalar
public DataNode setFinal_energyScalar(java.lang.Double final_energy)
Description copied from interface: NXbeam
Energy on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
setFinal_energyScalar in interface NXbeam
Parameters:
final_energy - the final_energy








getEnergy_transfer
public IDataset getEnergy_transfer()
Description copied from interface: NXbeam
Energy change caused by beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
getEnergy_transfer in interface NXbeam
Returns:
the value.








getEnergy_transferScalar
public java.lang.Double getEnergy_transferScalar()
Description copied from interface: NXbeam
Energy change caused by beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
getEnergy_transferScalar in interface NXbeam
Returns:
the value.








setEnergy_transfer
public DataNode setEnergy_transfer(IDataset energy_transfer)
Description copied from interface: NXbeam
Energy change caused by beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
setEnergy_transfer in interface NXbeam
Parameters:
energy_transfer - the energy_transfer








setEnergy_transferScalar
public DataNode setEnergy_transferScalar(java.lang.Double energy_transfer)
Description copied from interface: NXbeam
Energy change caused by beamline component
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 Dimensions: 1: i;
 

Specified by:
setEnergy_transferScalar in interface NXbeam
Parameters:
energy_transfer - the energy_transfer








getIncident_wavelength
public IDataset getIncident_wavelength()
Description copied from interface: NXbeam
Wavelength on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
getIncident_wavelength in interface NXbeam
Returns:
the value.








getIncident_wavelengthScalar
public java.lang.Double getIncident_wavelengthScalar()
Description copied from interface: NXbeam
Wavelength on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
getIncident_wavelengthScalar in interface NXbeam
Returns:
the value.








setIncident_wavelength
public DataNode setIncident_wavelength(IDataset incident_wavelength)
Description copied from interface: NXbeam
Wavelength on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
setIncident_wavelength in interface NXbeam
Parameters:
incident_wavelength - the incident_wavelength








setIncident_wavelengthScalar
public DataNode setIncident_wavelengthScalar(java.lang.Double incident_wavelength)
Description copied from interface: NXbeam
Wavelength on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
setIncident_wavelengthScalar in interface NXbeam
Parameters:
incident_wavelength - the incident_wavelength








getIncident_wavelength_spread
public IDataset getIncident_wavelength_spread()
Description copied from interface: NXbeam
Wavelength spread FWHM on entering component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
getIncident_wavelength_spread in interface NXbeam
Returns:
the value.








getIncident_wavelength_spreadScalar
public java.lang.Double getIncident_wavelength_spreadScalar()
Description copied from interface: NXbeam
Wavelength spread FWHM on entering component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
getIncident_wavelength_spreadScalar in interface NXbeam
Returns:
the value.








setIncident_wavelength_spread
public DataNode setIncident_wavelength_spread(IDataset incident_wavelength_spread)
Description copied from interface: NXbeam
Wavelength spread FWHM on entering component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
setIncident_wavelength_spread in interface NXbeam
Parameters:
incident_wavelength_spread - the incident_wavelength_spread








setIncident_wavelength_spreadScalar
public DataNode setIncident_wavelength_spreadScalar(java.lang.Double incident_wavelength_spread)
Description copied from interface: NXbeam
Wavelength spread FWHM on entering component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
setIncident_wavelength_spreadScalar in interface NXbeam
Parameters:
incident_wavelength_spread - the incident_wavelength_spread








getIncident_beam_divergence
public IDataset getIncident_beam_divergence()
Description copied from interface: NXbeam
Divergence of beam entering this component
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2; 2: j;
 

Specified by:
getIncident_beam_divergence in interface NXbeam
Returns:
the value.








getIncident_beam_divergenceScalar
public java.lang.Double getIncident_beam_divergenceScalar()
Description copied from interface: NXbeam
Divergence of beam entering this component
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2; 2: j;
 

Specified by:
getIncident_beam_divergenceScalar in interface NXbeam
Returns:
the value.








setIncident_beam_divergence
public DataNode setIncident_beam_divergence(IDataset incident_beam_divergence)
Description copied from interface: NXbeam
Divergence of beam entering this component
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2; 2: j;
 

Specified by:
setIncident_beam_divergence in interface NXbeam
Parameters:
incident_beam_divergence - the incident_beam_divergence








setIncident_beam_divergenceScalar
public DataNode setIncident_beam_divergenceScalar(java.lang.Double incident_beam_divergence)
Description copied from interface: NXbeam
Divergence of beam entering this component
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2; 2: j;
 

Specified by:
setIncident_beam_divergenceScalar in interface NXbeam
Parameters:
incident_beam_divergence - the incident_beam_divergence








getFinal_wavelength
public IDataset getFinal_wavelength()
Description copied from interface: NXbeam
Wavelength on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
getFinal_wavelength in interface NXbeam
Returns:
the value.








getFinal_wavelengthScalar
public java.lang.Double getFinal_wavelengthScalar()
Description copied from interface: NXbeam
Wavelength on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
getFinal_wavelengthScalar in interface NXbeam
Returns:
the value.








setFinal_wavelength
public DataNode setFinal_wavelength(IDataset final_wavelength)
Description copied from interface: NXbeam
Wavelength on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
setFinal_wavelength in interface NXbeam
Parameters:
final_wavelength - the final_wavelength








setFinal_wavelengthScalar
public DataNode setFinal_wavelengthScalar(java.lang.Double final_wavelength)
Description copied from interface: NXbeam
Wavelength on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
setFinal_wavelengthScalar in interface NXbeam
Parameters:
final_wavelength - the final_wavelength








getIncident_polarization
public IDataset getIncident_polarization()
Description copied from interface: NXbeam
Polarization vector on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2; 2: j;
 

Specified by:
getIncident_polarization in interface NXbeam
Returns:
the value.








getIncident_polarizationScalar
public java.lang.Double getIncident_polarizationScalar()
Description copied from interface: NXbeam
Polarization vector on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2; 2: j;
 

Specified by:
getIncident_polarizationScalar in interface NXbeam
Returns:
the value.








setIncident_polarization
public DataNode setIncident_polarization(IDataset incident_polarization)
Description copied from interface: NXbeam
Polarization vector on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2; 2: j;
 

Specified by:
setIncident_polarization in interface NXbeam
Parameters:
incident_polarization - the incident_polarization








setIncident_polarizationScalar
public DataNode setIncident_polarizationScalar(java.lang.Double incident_polarization)
Description copied from interface: NXbeam
Polarization vector on entering beamline component
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2; 2: j;
 

Specified by:
setIncident_polarizationScalar in interface NXbeam
Parameters:
incident_polarization - the incident_polarization








getFinal_polarization
public IDataset getFinal_polarization()
Description copied from interface: NXbeam
Polarization vector on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2; 2: j;
 

Specified by:
getFinal_polarization in interface NXbeam
Returns:
the value.








getFinal_polarizationScalar
public java.lang.Double getFinal_polarizationScalar()
Description copied from interface: NXbeam
Polarization vector on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2; 2: j;
 

Specified by:
getFinal_polarizationScalar in interface NXbeam
Returns:
the value.








setFinal_polarization
public DataNode setFinal_polarization(IDataset final_polarization)
Description copied from interface: NXbeam
Polarization vector on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2; 2: j;
 

Specified by:
setFinal_polarization in interface NXbeam
Parameters:
final_polarization - the final_polarization








setFinal_polarizationScalar
public DataNode setFinal_polarizationScalar(java.lang.Double final_polarization)
Description copied from interface: NXbeam
Polarization vector on leaving beamline component
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: 2; 2: j;
 

Specified by:
setFinal_polarizationScalar in interface NXbeam
Parameters:
final_polarization - the final_polarization








getFinal_wavelength_spread
public IDataset getFinal_wavelength_spread()
Description copied from interface: NXbeam
Wavelength spread FWHM of beam leaving this component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
getFinal_wavelength_spread in interface NXbeam
Returns:
the value.








getFinal_wavelength_spreadScalar
public java.lang.Double getFinal_wavelength_spreadScalar()
Description copied from interface: NXbeam
Wavelength spread FWHM of beam leaving this component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
getFinal_wavelength_spreadScalar in interface NXbeam
Returns:
the value.








setFinal_wavelength_spread
public DataNode setFinal_wavelength_spread(IDataset final_wavelength_spread)
Description copied from interface: NXbeam
Wavelength spread FWHM of beam leaving this component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
setFinal_wavelength_spread in interface NXbeam
Parameters:
final_wavelength_spread - the final_wavelength_spread








setFinal_wavelength_spreadScalar
public DataNode setFinal_wavelength_spreadScalar(java.lang.Double final_wavelength_spread)
Description copied from interface: NXbeam
Wavelength spread FWHM of beam leaving this component
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 Dimensions: 1: i;
 

Specified by:
setFinal_wavelength_spreadScalar in interface NXbeam
Parameters:
final_wavelength_spread - the final_wavelength_spread








getFinal_beam_divergence
public IDataset getFinal_beam_divergence()
Description copied from interface: NXbeam
Divergence FWHM of beam leaving this component
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2; 2: j;
 

Specified by:
getFinal_beam_divergence in interface NXbeam
Returns:
the value.








getFinal_beam_divergenceScalar
public java.lang.Double getFinal_beam_divergenceScalar()
Description copied from interface: NXbeam
Divergence FWHM of beam leaving this component
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2; 2: j;
 

Specified by:
getFinal_beam_divergenceScalar in interface NXbeam
Returns:
the value.








setFinal_beam_divergence
public DataNode setFinal_beam_divergence(IDataset final_beam_divergence)
Description copied from interface: NXbeam
Divergence FWHM of beam leaving this component
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2; 2: j;
 

Specified by:
setFinal_beam_divergence in interface NXbeam
Parameters:
final_beam_divergence - the final_beam_divergence








setFinal_beam_divergenceScalar
public DataNode setFinal_beam_divergenceScalar(java.lang.Double final_beam_divergence)
Description copied from interface: NXbeam
Divergence FWHM of beam leaving this component
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2; 2: j;
 

Specified by:
setFinal_beam_divergenceScalar in interface NXbeam
Parameters:
final_beam_divergence - the final_beam_divergence








getFlux
public IDataset getFlux()
Description copied from interface: NXbeam
flux incident on beam plane area
 

 Type: NX_FLOAT
 Units: NX_FLUX
 Dimensions: 1: i;
 

Specified by:
getFlux in interface NXbeam
Returns:
the value.








getFluxScalar
public java.lang.Double getFluxScalar()
Description copied from interface: NXbeam
flux incident on beam plane area
 

 Type: NX_FLOAT
 Units: NX_FLUX
 Dimensions: 1: i;
 

Specified by:
getFluxScalar in interface NXbeam
Returns:
the value.








setFlux
public DataNode setFlux(IDataset flux)
Description copied from interface: NXbeam
flux incident on beam plane area
 

 Type: NX_FLOAT
 Units: NX_FLUX
 Dimensions: 1: i;
 

Specified by:
setFlux in interface NXbeam
Parameters:
flux - the flux








setFluxScalar
public DataNode setFluxScalar(java.lang.Double flux)
Description copied from interface: NXbeam
flux incident on beam plane area
 

 Type: NX_FLOAT
 Units: NX_FLUX
 Dimensions: 1: i;
 

Specified by:
setFluxScalar in interface NXbeam
Parameters:
flux - the flux








getData
public NXdata getData()
Description copied from interface: NXbeam
Distribution of beam with respect to relevant variable e.g. wavelength. This is mainly
 useful for simulations which need to store plottable information at each beamline
 component.

Specified by:
getData in interface NXbeam
Returns:
the value.








setData
public void setData(NXdata data)
Description copied from interface: NXbeam
Distribution of beam with respect to relevant variable e.g. wavelength. This is mainly
 useful for simulations which need to store plottable information at each beamline
 component.

Specified by:
setData in interface NXbeam
Parameters:
data - the data








getData
public NXdata getData(java.lang.String name)
Description copied from interface: NXbeam
Get a NXdata node by name:
 

 

 Distribution of beam with respect to relevant variable e.g. wavelength. This is mainly
 useful for simulations which need to store plottable information at each beamline
 component.
 

Specified by:
getData in interface NXbeam
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXdata for that node.








setData
public void setData(java.lang.String name,
                    NXdata data)
Description copied from interface: NXbeam
Set a NXdata node by name:
 

 

 Distribution of beam with respect to relevant variable e.g. wavelength. This is mainly
 useful for simulations which need to store plottable information at each beamline
 component.
 

Specified by:
setData in interface NXbeam
Parameters:
name - the name of the node
data - the value to set








getAllData
public java.util.Map<java.lang.String,NXdata> getAllData()
Description copied from interface: NXbeam
Get all NXdata nodes:
 

 

 Distribution of beam with respect to relevant variable e.g. wavelength. This is mainly
 useful for simulations which need to store plottable information at each beamline
 component.
 

Specified by:
getAllData in interface NXbeam
Returns:
a map from node names to the NXdata for that node.








setAllData
public void setAllData(java.util.Map<java.lang.String,NXdata> data)
Description copied from interface: NXbeam
Set multiple child nodes of a particular type.
 

 

 Distribution of beam with respect to relevant variable e.g. wavelength. This is mainly
 useful for simulations which need to store plottable information at each beamline
 component.
 

Specified by:
setAllData in interface NXbeam
Parameters:
data - the child nodes to add














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