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



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













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




public class NXmonochromatorImpl
extends NXobjectImpl
implements NXmonochromator
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

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.NXmonochromator
NX_ENERGY, NX_ENERGY_ERROR, NX_WAVELENGTH, NX_WAVELENGTH_ERROR





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








Constructor Summary

Constructors 

Constructor and Description


NXmonochromatorImpl() 


NXmonochromatorImpl(long oid) 









Method Summary

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



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.



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





NXmonochromatorImpl
public NXmonochromatorImpl()







NXmonochromatorImpl
public NXmonochromatorImpl(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








getWavelength
public IDataset getWavelength()
Description copied from interface: NXmonochromator
wavelength selected
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Specified by:
getWavelength in interface NXmonochromator
Returns:
the value.








getWavelengthScalar
public java.lang.Double getWavelengthScalar()
Description copied from interface: NXmonochromator
wavelength selected
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Specified by:
getWavelengthScalar in interface NXmonochromator
Returns:
the value.








setWavelength
public DataNode setWavelength(IDataset wavelength)
Description copied from interface: NXmonochromator
wavelength selected
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Specified by:
setWavelength in interface NXmonochromator
Parameters:
wavelength - the wavelength








setWavelengthScalar
public DataNode setWavelengthScalar(java.lang.Double wavelength)
Description copied from interface: NXmonochromator
wavelength selected
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Specified by:
setWavelengthScalar in interface NXmonochromator
Parameters:
wavelength - the wavelength








getWavelength_error
public IDataset getWavelength_error()
Description copied from interface: NXmonochromator
wavelength standard deviation
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Specified by:
getWavelength_error in interface NXmonochromator
Returns:
the value.








getWavelength_errorScalar
public java.lang.Double getWavelength_errorScalar()
Description copied from interface: NXmonochromator
wavelength standard deviation
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Specified by:
getWavelength_errorScalar in interface NXmonochromator
Returns:
the value.








setWavelength_error
public DataNode setWavelength_error(IDataset wavelength_error)
Description copied from interface: NXmonochromator
wavelength standard deviation
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Specified by:
setWavelength_error in interface NXmonochromator
Parameters:
wavelength_error - the wavelength_error








setWavelength_errorScalar
public DataNode setWavelength_errorScalar(java.lang.Double wavelength_error)
Description copied from interface: NXmonochromator
wavelength standard deviation
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Specified by:
setWavelength_errorScalar in interface NXmonochromator
Parameters:
wavelength_error - the wavelength_error








getEnergy
public IDataset getEnergy()
Description copied from interface: NXmonochromator
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
getEnergy in interface NXmonochromator
Returns:
the value.








getEnergyScalar
public java.lang.Double getEnergyScalar()
Description copied from interface: NXmonochromator
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
getEnergyScalar in interface NXmonochromator
Returns:
the value.








setEnergy
public DataNode setEnergy(IDataset energy)
Description copied from interface: NXmonochromator
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
setEnergy in interface NXmonochromator
Parameters:
energy - the energy








setEnergyScalar
public DataNode setEnergyScalar(java.lang.Double energy)
Description copied from interface: NXmonochromator
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
setEnergyScalar in interface NXmonochromator
Parameters:
energy - the energy








getEnergy_error
public IDataset getEnergy_error()
Description copied from interface: NXmonochromator
energy standard deviation
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
getEnergy_error in interface NXmonochromator
Returns:
the value.








getEnergy_errorScalar
public java.lang.Double getEnergy_errorScalar()
Description copied from interface: NXmonochromator
energy standard deviation
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
getEnergy_errorScalar in interface NXmonochromator
Returns:
the value.








setEnergy_error
public DataNode setEnergy_error(IDataset energy_error)
Description copied from interface: NXmonochromator
energy standard deviation
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
setEnergy_error in interface NXmonochromator
Parameters:
energy_error - the energy_error








setEnergy_errorScalar
public DataNode setEnergy_errorScalar(java.lang.Double energy_error)
Description copied from interface: NXmonochromator
energy standard deviation
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
setEnergy_errorScalar in interface NXmonochromator
Parameters:
energy_error - the energy_error








getDistribution
public NXdata getDistribution()

Specified by:
getDistribution in interface NXmonochromator
Returns:
the value.








setDistribution
public void setDistribution(NXdata distribution)

Specified by:
setDistribution in interface NXmonochromator
Parameters:
distribution - the distribution








getGeometry
public NXgeometry getGeometry()

Specified by:
getGeometry in interface NXmonochromator
Returns:
the value.








setGeometry
public void setGeometry(NXgeometry geometry)

Specified by:
setGeometry in interface NXmonochromator
Parameters:
geometry - the geometry








getCrystal
public NXcrystal getCrystal()
Description copied from interface: NXmonochromator
Use as many crystals as necessary to describe

Specified by:
getCrystal in interface NXmonochromator
Returns:
the value.








setCrystal
public void setCrystal(NXcrystal crystal)
Description copied from interface: NXmonochromator
Use as many crystals as necessary to describe

Specified by:
setCrystal in interface NXmonochromator
Parameters:
crystal - the crystal








getCrystal
public NXcrystal getCrystal(java.lang.String name)
Description copied from interface: NXmonochromator
Get a NXcrystal node by name:
 

 

 Use as many crystals as necessary to describe
 

Specified by:
getCrystal in interface NXmonochromator
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXcrystal for that node.








setCrystal
public void setCrystal(java.lang.String name,
                       NXcrystal crystal)
Description copied from interface: NXmonochromator
Set a NXcrystal node by name:
 

 

 Use as many crystals as necessary to describe
 

Specified by:
setCrystal in interface NXmonochromator
Parameters:
name - the name of the node
crystal - the value to set








getAllCrystal
public java.util.Map<java.lang.String,NXcrystal> getAllCrystal()
Description copied from interface: NXmonochromator
Get all NXcrystal nodes:
 

 

 Use as many crystals as necessary to describe
 

Specified by:
getAllCrystal in interface NXmonochromator
Returns:
a map from node names to the NXcrystal for that node.








setAllCrystal
public void setAllCrystal(java.util.Map<java.lang.String,NXcrystal> crystal)
Description copied from interface: NXmonochromator
Set multiple child nodes of a particular type.
 

 

 Use as many crystals as necessary to describe
 

Specified by:
setAllCrystal in interface NXmonochromator
Parameters:
crystal - the child nodes to add








getVelocity_selector
public NXvelocity_selector getVelocity_selector()

Specified by:
getVelocity_selector in interface NXmonochromator
Returns:
the value.








setVelocity_selector
public void setVelocity_selector(NXvelocity_selector velocity_selector)

Specified by:
setVelocity_selector in interface NXmonochromator
Parameters:
velocity_selector - the velocity_selector








getVelocity_selector
public NXvelocity_selector getVelocity_selector(java.lang.String name)
Description copied from interface: NXmonochromator
Get a NXvelocity_selector node by name:
 

 

 

Specified by:
getVelocity_selector in interface NXmonochromator
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXvelocity_selector for that node.








setVelocity_selector
public void setVelocity_selector(java.lang.String name,
                                 NXvelocity_selector velocity_selector)
Description copied from interface: NXmonochromator
Set a NXvelocity_selector node by name:
 

 

 

Specified by:
setVelocity_selector in interface NXmonochromator
Parameters:
name - the name of the node
velocity_selector - the value to set








getAllVelocity_selector
public java.util.Map<java.lang.String,NXvelocity_selector> getAllVelocity_selector()
Description copied from interface: NXmonochromator
Get all NXvelocity_selector nodes:
 

 

 

Specified by:
getAllVelocity_selector in interface NXmonochromator
Returns:
a map from node names to the NXvelocity_selector for that node.








setAllVelocity_selector
public void setAllVelocity_selector(java.util.Map<java.lang.String,NXvelocity_selector> velocity_selector)
Description copied from interface: NXmonochromator
Set multiple child nodes of a particular type.
 

 

 

Specified by:
setAllVelocity_selector in interface NXmonochromator
Parameters:
velocity_selector - the child nodes to add








getGrating
public NXgrating getGrating()
Description copied from interface: NXmonochromator
For diffraction grating based monochromators

Specified by:
getGrating in interface NXmonochromator
Returns:
the value.








setGrating
public void setGrating(NXgrating grating)
Description copied from interface: NXmonochromator
For diffraction grating based monochromators

Specified by:
setGrating in interface NXmonochromator
Parameters:
grating - the grating








getGrating
public NXgrating getGrating(java.lang.String name)
Description copied from interface: NXmonochromator
Get a NXgrating node by name:
 

 

 For diffraction grating based monochromators
 

Specified by:
getGrating in interface NXmonochromator
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXgrating for that node.








setGrating
public void setGrating(java.lang.String name,
                       NXgrating grating)
Description copied from interface: NXmonochromator
Set a NXgrating node by name:
 

 

 For diffraction grating based monochromators
 

Specified by:
setGrating in interface NXmonochromator
Parameters:
name - the name of the node
grating - the value to set








getAllGrating
public java.util.Map<java.lang.String,NXgrating> getAllGrating()
Description copied from interface: NXmonochromator
Get all NXgrating nodes:
 

 

 For diffraction grating based monochromators
 

Specified by:
getAllGrating in interface NXmonochromator
Returns:
a map from node names to the NXgrating for that node.








setAllGrating
public void setAllGrating(java.util.Map<java.lang.String,NXgrating> grating)
Description copied from interface: NXmonochromator
Set multiple child nodes of a particular type.
 

 

 For diffraction grating based monochromators
 

Specified by:
setAllGrating in interface NXmonochromator
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