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






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


All Known Implementing Classes:
NXmonochromatorImpl




public interface NXmonochromator
extends NXobject
A wavelength defining device.
 This is a base class for everything which
 selects a wavelength or energy, be it a
 monochromator crystal, a velocity selector,
 an undulator or whatever.
 The expected units are:
 * wavelength: angstrom
 * energy: eV











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_ENERGY 


static java.lang.String
NX_ENERGY_ERROR 


static java.lang.String
NX_WAVELENGTH 


static java.lang.String
NX_WAVELENGTH_ERROR 






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,NXcrystal>
getAllCrystal()
Get all NXcrystal nodes:
 
 
 Use as many crystals as necessary to describe
 



java.util.Map<java.lang.String,NXgrating>
getAllGrating()
Get all NXgrating nodes:
 
 
 For diffraction grating based monochromators
 



java.util.Map<java.lang.String,NXvelocity_selector>
getAllVelocity_selector()
Get all NXvelocity_selector nodes:
 
 
 



NXcrystal
getCrystal()
Use as many crystals as necessary to describe



NXcrystal
getCrystal(java.lang.String name)
Get a NXcrystal node by name:
 
 
 Use as many crystals as necessary to describe
 



NXdata
getDistribution() 


IDataset
getEnergy_error()
energy standard deviation



java.lang.Double
getEnergy_errorScalar()
energy standard deviation



IDataset
getEnergy()
energy selected



java.lang.Double
getEnergyScalar()
energy selected



NXgeometry
getGeometry() 


NXgrating
getGrating()
For diffraction grating based monochromators



NXgrating
getGrating(java.lang.String name)
Get a NXgrating node by name:
 
 
 For diffraction grating based monochromators
 



NXvelocity_selector
getVelocity_selector() 


NXvelocity_selector
getVelocity_selector(java.lang.String name)
Get a NXvelocity_selector node by name:
 
 
 



IDataset
getWavelength_error()
wavelength standard deviation



java.lang.Double
getWavelength_errorScalar()
wavelength standard deviation



IDataset
getWavelength()
wavelength selected



java.lang.Double
getWavelengthScalar()
wavelength selected



void
setAllCrystal(java.util.Map<java.lang.String,NXcrystal> crystal)
Set multiple child nodes of a particular type.



void
setAllGrating(java.util.Map<java.lang.String,NXgrating> grating)
Set multiple child nodes of a particular type.



void
setAllVelocity_selector(java.util.Map<java.lang.String,NXvelocity_selector> velocity_selector)
Set multiple child nodes of a particular type.



void
setCrystal(NXcrystal crystal)
Use as many crystals as necessary to describe



void
setCrystal(java.lang.String name,
          NXcrystal crystal)
Set a NXcrystal node by name:
 
 
 Use as many crystals as necessary to describe
 



void
setDistribution(NXdata distribution) 


DataNode
setEnergy_error(IDataset energy_error)
energy standard deviation



DataNode
setEnergy_errorScalar(java.lang.Double energy_error)
energy standard deviation



DataNode
setEnergy(IDataset energy)
energy selected



DataNode
setEnergyScalar(java.lang.Double energy)
energy selected



void
setGeometry(NXgeometry geometry) 


void
setGrating(NXgrating grating)
For diffraction grating based monochromators



void
setGrating(java.lang.String name,
          NXgrating grating)
Set a NXgrating node by name:
 
 
 For diffraction grating based monochromators
 



void
setVelocity_selector(NXvelocity_selector velocity_selector) 


void
setVelocity_selector(java.lang.String name,
                    NXvelocity_selector velocity_selector)
Set a NXvelocity_selector node by name:
 
 
 



DataNode
setWavelength_error(IDataset wavelength_error)
wavelength standard deviation



DataNode
setWavelength_errorScalar(java.lang.Double wavelength_error)
wavelength standard deviation



DataNode
setWavelength(IDataset wavelength)
wavelength selected



DataNode
setWavelengthScalar(java.lang.Double wavelength)
wavelength selected







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_WAVELENGTH
static final java.lang.String NX_WAVELENGTH

See Also:
Constant Field Values








NX_WAVELENGTH_ERROR
static final java.lang.String NX_WAVELENGTH_ERROR

See Also:
Constant Field Values








NX_ENERGY
static final java.lang.String NX_ENERGY

See Also:
Constant Field Values








NX_ENERGY_ERROR
static final java.lang.String NX_ENERGY_ERROR

See Also:
Constant Field Values










Method Detail





getWavelength
IDataset getWavelength()
wavelength selected
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Returns:
the value.








setWavelength
DataNode setWavelength(IDataset wavelength)
wavelength selected
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Parameters:
wavelength - the wavelength








getWavelengthScalar
java.lang.Double getWavelengthScalar()
wavelength selected
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Returns:
the value.








setWavelengthScalar
DataNode setWavelengthScalar(java.lang.Double wavelength)
wavelength selected
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Parameters:
wavelength - the wavelength








getWavelength_error
IDataset getWavelength_error()
wavelength standard deviation
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Returns:
the value.








setWavelength_error
DataNode setWavelength_error(IDataset wavelength_error)
wavelength standard deviation
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Parameters:
wavelength_error - the wavelength_error








getWavelength_errorScalar
java.lang.Double getWavelength_errorScalar()
wavelength standard deviation
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Returns:
the value.








setWavelength_errorScalar
DataNode setWavelength_errorScalar(java.lang.Double wavelength_error)
wavelength standard deviation
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Parameters:
wavelength_error - the wavelength_error








getEnergy
IDataset getEnergy()
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setEnergy
DataNode setEnergy(IDataset energy)
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
energy - the energy








getEnergyScalar
java.lang.Double getEnergyScalar()
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setEnergyScalar
DataNode setEnergyScalar(java.lang.Double energy)
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
energy - the energy








getEnergy_error
IDataset getEnergy_error()
energy standard deviation
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setEnergy_error
DataNode setEnergy_error(IDataset energy_error)
energy standard deviation
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
energy_error - the energy_error








getEnergy_errorScalar
java.lang.Double getEnergy_errorScalar()
energy standard deviation
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setEnergy_errorScalar
DataNode setEnergy_errorScalar(java.lang.Double energy_error)
energy standard deviation
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
energy_error - the energy_error








getDistribution
NXdata getDistribution()

Returns:
the value.








setDistribution
void setDistribution(NXdata distribution)

Parameters:
distribution - the distribution








getGeometry
NXgeometry getGeometry()

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)

Parameters:
geometry - the geometry








getCrystal
NXcrystal getCrystal()
Use as many crystals as necessary to describe

Returns:
the value.








setCrystal
void setCrystal(NXcrystal crystal)
Use as many crystals as necessary to describe

Parameters:
crystal - the crystal








getCrystal
NXcrystal getCrystal(java.lang.String name)
Get a NXcrystal node by name:
 

 

 Use as many crystals as necessary to describe
 

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








setCrystal
void setCrystal(java.lang.String name,
                NXcrystal crystal)
Set a NXcrystal node by name:
 

 

 Use as many crystals as necessary to describe
 

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








getAllCrystal
java.util.Map<java.lang.String,NXcrystal> getAllCrystal()
Get all NXcrystal nodes:
 

 

 Use as many crystals as necessary to describe
 

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








setAllCrystal
void setAllCrystal(java.util.Map<java.lang.String,NXcrystal> crystal)
Set multiple child nodes of a particular type.
 

 

 Use as many crystals as necessary to describe
 

Parameters:
crystal - the child nodes to add








getVelocity_selector
NXvelocity_selector getVelocity_selector()

Returns:
the value.








setVelocity_selector
void setVelocity_selector(NXvelocity_selector velocity_selector)

Parameters:
velocity_selector - the velocity_selector








getVelocity_selector
NXvelocity_selector getVelocity_selector(java.lang.String name)
Get a NXvelocity_selector node by name:
 

 

 

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








setVelocity_selector
void setVelocity_selector(java.lang.String name,
                          NXvelocity_selector velocity_selector)
Set a NXvelocity_selector node by name:
 

 

 

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








getAllVelocity_selector
java.util.Map<java.lang.String,NXvelocity_selector> getAllVelocity_selector()
Get all NXvelocity_selector nodes:
 

 

 

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








setAllVelocity_selector
void setAllVelocity_selector(java.util.Map<java.lang.String,NXvelocity_selector> velocity_selector)
Set multiple child nodes of a particular type.
 

 

 

Parameters:
velocity_selector - the child nodes to add








getGrating
NXgrating getGrating()
For diffraction grating based monochromators

Returns:
the value.








setGrating
void setGrating(NXgrating grating)
For diffraction grating based monochromators

Parameters:
grating - the grating








getGrating
NXgrating getGrating(java.lang.String name)
Get a NXgrating node by name:
 

 

 For diffraction grating based monochromators
 

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








setGrating
void setGrating(java.lang.String name,
                NXgrating grating)
Set a NXgrating node by name:
 

 

 For diffraction grating based monochromators
 

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








getAllGrating
java.util.Map<java.lang.String,NXgrating> getAllGrating()
Get all NXgrating nodes:
 

 

 For diffraction grating based monochromators
 

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








setAllGrating
void setAllGrating(java.util.Map<java.lang.String,NXgrating> grating)
Set multiple child nodes of a particular type.
 

 

 For diffraction grating based monochromators
 

Parameters:
grating - 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