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






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


All Known Implementing Classes:
NXbeamImpl




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











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DISTANCE 


static java.lang.String
NX_ENERGY_TRANSFER 


static java.lang.String
NX_FINAL_BEAM_DIVERGENCE 


static java.lang.String
NX_FINAL_ENERGY 


static java.lang.String
NX_FINAL_POLARIZATION 


static java.lang.String
NX_FINAL_WAVELENGTH 


static java.lang.String
NX_FINAL_WAVELENGTH_SPREAD 


static java.lang.String
NX_FLUX 


static java.lang.String
NX_INCIDENT_BEAM_DIVERGENCE 


static java.lang.String
NX_INCIDENT_ENERGY 


static java.lang.String
NX_INCIDENT_POLARIZATION 


static java.lang.String
NX_INCIDENT_WAVELENGTH 


static java.lang.String
NX_INCIDENT_WAVELENGTH_SPREAD 






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


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



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 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_INCIDENT_ENERGY
static final java.lang.String NX_INCIDENT_ENERGY

See Also:
Constant Field Values








NX_FINAL_ENERGY
static final java.lang.String NX_FINAL_ENERGY

See Also:
Constant Field Values








NX_ENERGY_TRANSFER
static final java.lang.String NX_ENERGY_TRANSFER

See Also:
Constant Field Values








NX_INCIDENT_WAVELENGTH
static final java.lang.String NX_INCIDENT_WAVELENGTH

See Also:
Constant Field Values








NX_INCIDENT_WAVELENGTH_SPREAD
static final java.lang.String NX_INCIDENT_WAVELENGTH_SPREAD

See Also:
Constant Field Values








NX_INCIDENT_BEAM_DIVERGENCE
static final java.lang.String NX_INCIDENT_BEAM_DIVERGENCE

See Also:
Constant Field Values








NX_FINAL_WAVELENGTH
static final java.lang.String NX_FINAL_WAVELENGTH

See Also:
Constant Field Values








NX_INCIDENT_POLARIZATION
static final java.lang.String NX_INCIDENT_POLARIZATION

See Also:
Constant Field Values








NX_FINAL_POLARIZATION
static final java.lang.String NX_FINAL_POLARIZATION

See Also:
Constant Field Values








NX_FINAL_WAVELENGTH_SPREAD
static final java.lang.String NX_FINAL_WAVELENGTH_SPREAD

See Also:
Constant Field Values








NX_FINAL_BEAM_DIVERGENCE
static final java.lang.String NX_FINAL_BEAM_DIVERGENCE

See Also:
Constant Field Values








NX_FLUX
static final java.lang.String NX_FLUX

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








getIncident_energy
IDataset getIncident_energy()
Energy on entering beamline component
 

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

Returns:
the value.








setIncident_energy
DataNode setIncident_energy(IDataset incident_energy)
Energy on entering beamline component
 

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

Parameters:
incident_energy - the incident_energy








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

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

Returns:
the value.








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

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

Parameters:
incident_energy - the incident_energy








getFinal_energy
IDataset getFinal_energy()
Energy on leaving beamline component
 

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

Returns:
the value.








setFinal_energy
DataNode setFinal_energy(IDataset final_energy)
Energy on leaving beamline component
 

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

Parameters:
final_energy - the final_energy








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

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

Returns:
the value.








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

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

Parameters:
final_energy - the final_energy








getEnergy_transfer
IDataset getEnergy_transfer()
Energy change caused by beamline component
 

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

Returns:
the value.








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

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

Parameters:
energy_transfer - the energy_transfer








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

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

Returns:
the value.








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

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

Parameters:
energy_transfer - the energy_transfer








getIncident_wavelength
IDataset getIncident_wavelength()
Wavelength on entering beamline component
 

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

Returns:
the value.








setIncident_wavelength
DataNode setIncident_wavelength(IDataset incident_wavelength)
Wavelength on entering beamline component
 

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

Parameters:
incident_wavelength - the incident_wavelength








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

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

Returns:
the value.








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

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

Parameters:
incident_wavelength - the incident_wavelength








getIncident_wavelength_spread
IDataset getIncident_wavelength_spread()
Wavelength spread FWHM on entering component
 

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

Returns:
the value.








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

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

Parameters:
incident_wavelength_spread - the incident_wavelength_spread








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

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

Returns:
the value.








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

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

Parameters:
incident_wavelength_spread - the incident_wavelength_spread








getIncident_beam_divergence
IDataset getIncident_beam_divergence()
Divergence of beam entering this component
 

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

Returns:
the value.








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

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

Parameters:
incident_beam_divergence - the incident_beam_divergence








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

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

Returns:
the value.








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

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

Parameters:
incident_beam_divergence - the incident_beam_divergence








getFinal_wavelength
IDataset getFinal_wavelength()
Wavelength on leaving beamline component
 

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

Returns:
the value.








setFinal_wavelength
DataNode setFinal_wavelength(IDataset final_wavelength)
Wavelength on leaving beamline component
 

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

Parameters:
final_wavelength - the final_wavelength








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

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

Returns:
the value.








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

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

Parameters:
final_wavelength - the final_wavelength








getIncident_polarization
IDataset getIncident_polarization()
Polarization vector on entering beamline component
 

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

Returns:
the value.








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

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

Parameters:
incident_polarization - the incident_polarization








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

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

Returns:
the value.








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

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

Parameters:
incident_polarization - the incident_polarization








getFinal_polarization
IDataset getFinal_polarization()
Polarization vector on leaving beamline component
 

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

Returns:
the value.








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

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

Parameters:
final_polarization - the final_polarization








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

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

Returns:
the value.








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

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

Parameters:
final_polarization - the final_polarization








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

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

Returns:
the value.








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

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

Parameters:
final_wavelength_spread - the final_wavelength_spread








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

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

Returns:
the value.








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

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

Parameters:
final_wavelength_spread - the final_wavelength_spread








getFinal_beam_divergence
IDataset getFinal_beam_divergence()
Divergence FWHM of beam leaving this component
 

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

Returns:
the value.








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

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

Parameters:
final_beam_divergence - the final_beam_divergence








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

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

Returns:
the value.








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

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

Parameters:
final_beam_divergence - the final_beam_divergence








getFlux
IDataset getFlux()
flux incident on beam plane area
 

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

Returns:
the value.








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

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

Parameters:
flux - the flux








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

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

Returns:
the value.








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

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

Parameters:
flux - the flux








getData
NXdata getData()
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.

Returns:
the value.








setData
void setData(NXdata data)
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.

Parameters:
data - the data








getData
NXdata getData(java.lang.String name)
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.
 

Parameters:
name - the name of the node.
Returns:
a map from node names to the NXdata for that node.








setData
void setData(java.lang.String name,
             NXdata data)
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.
 

Parameters:
name - the name of the node
data - the value to set








getAllData
java.util.Map<java.lang.String,NXdata> getAllData()
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.
 

Returns:
a map from node names to the NXdata for that node.








setAllData
void setAllData(java.util.Map<java.lang.String,NXdata> data)
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.
 

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