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



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













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




public class NXsourceImpl
extends NXobjectImpl
implements NXsource
The neutron or x-ray storage ring/facility.

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.NXsource
NX_BUNCH_DISTANCE, NX_BUNCH_LENGTH, NX_CURRENT, NX_DISTANCE, NX_EMITTANCE_X, NX_EMITTANCE_Y, NX_ENERGY, NX_FLUX, NX_FREQUENCY, NX_LAST_FILL, NX_LAST_FILL_ATTRIBUTE_TIME, NX_MODE, NX_NAME, NX_NAME_ATTRIBUTE_SHORT_NAME, NX_NUMBER_OF_BUNCHES, NX_PERIOD, NX_POWER, NX_PROBE, NX_PULSE_WIDTH, NX_SIGMA_X, NX_SIGMA_Y, NX_TARGET_MATERIAL, NX_TOP_UP, NX_TYPE, NX_VOLTAGE





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








Constructor Summary

Constructors 

Constructor and Description


NXsourceImpl() 


NXsourceImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getBunch_distance()
For storage rings, time between bunches



java.lang.Double
getBunch_distanceScalar()
For storage rings, time between bunches



IDataset
getBunch_length()
For storage rings, temporal length of the bunch



java.lang.Double
getBunch_lengthScalar()
For storage rings, temporal length of the bunch



NXdata
getBunch_pattern()
For storage rings, description of the bunch pattern.



IDataset
getCurrent()
Accelerator, X-ray tube, or storage ring current



java.lang.Double
getCurrentScalar()
Accelerator, X-ray tube, or storage ring current



IDataset
getDistance()
Effective distance from sample
 Distance as seen by radiation from sample.



java.lang.Double
getDistanceScalar()
Effective distance from sample
 Distance as seen by radiation from sample.



NXdata
getDistribution()
The wavelength or energy distribution of the source



IDataset
getEmittance_x()
Source emittance (nm-rad) in X (horizontal) direction.



java.lang.Double
getEmittance_xScalar()
Source emittance (nm-rad) in X (horizontal) direction.



IDataset
getEmittance_y()
Source emittance (nm-rad) in Y (horizontal) direction.



java.lang.Double
getEmittance_yScalar()
Source emittance (nm-rad) in Y (horizontal) direction.



IDataset
getEnergy()
Source energy.



java.lang.Double
getEnergyScalar()
Source energy.



IDataset
getFlux()
Source intensity/area (example: s-1 cm-2)



java.lang.Double
getFluxScalar()
Source intensity/area (example: s-1 cm-2)



IDataset
getFrequency()
Frequency of pulsed source



java.lang.Double
getFrequencyScalar()
Frequency of pulsed source



NXgeometry
getGeometry()
"Engineering" location of source



IDataset
getLast_fill()
For storage rings, the current at the end of the most recent injection.



java.util.Date
getLast_fillAttributeTime()
date and time of the most recent injection.



java.lang.Number
getLast_fillScalar()
For storage rings, the current at the end of the most recent injection.



IDataset
getMode()
source operating mode



java.lang.String
getModeScalar()
source operating mode



IDataset
getName()
Name of source



java.lang.String
getNameAttributeShort_name()
short name for source, perhaps the acronym



java.lang.String
getNameScalar()
Name of source



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



NXnote
getNotes()
any source/facility related messages/events that
 occurred during the experiment



IDataset
getNumber_of_bunches()
For storage rings, the number of bunches in use.



java.lang.Long
getNumber_of_bunchesScalar()
For storage rings, the number of bunches in use.



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



IDataset
getPeriod()
Period of pulsed source



java.lang.Double
getPeriodScalar()
Period of pulsed source



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



IDataset
getPower()
Source power



java.lang.Double
getPowerScalar()
Source power



IDataset
getProbe()
type of radiation probe (pick one from the enumerated list and spell exactly)



java.lang.String
getProbeScalar()
type of radiation probe (pick one from the enumerated list and spell exactly)



NXdata
getPulse_shape()
source pulse shape



IDataset
getPulse_width()
temporal width of source pulse



java.lang.Double
getPulse_widthScalar()
temporal width of source pulse



IDataset
getSigma_x()
particle beam size in x



java.lang.Double
getSigma_xScalar()
particle beam size in x



IDataset
getSigma_y()
particle beam size in y



java.lang.Double
getSigma_yScalar()
particle beam size in y



IDataset
getTarget_material()
Pulsed source target material



java.lang.String
getTarget_materialScalar()
Pulsed source target material



IDataset
getTop_up()
Is the synchrotron operating in top_up mode?



java.lang.Boolean
getTop_upScalar()
Is the synchrotron operating in top_up mode?



IDataset
getType()
type of radiation source (pick one from the enumerated list and spell exactly)



java.lang.String
getTypeScalar()
type of radiation source (pick one from the enumerated list and spell exactly)



IDataset
getVoltage()
Accelerator voltage



java.lang.Double
getVoltageScalar()
Accelerator voltage



DataNode
setBunch_distance(IDataset bunch_distance)
For storage rings, time between bunches



DataNode
setBunch_distanceScalar(java.lang.Double bunch_distance)
For storage rings, time between bunches



DataNode
setBunch_length(IDataset bunch_length)
For storage rings, temporal length of the bunch



DataNode
setBunch_lengthScalar(java.lang.Double bunch_length)
For storage rings, temporal length of the bunch



void
setBunch_pattern(NXdata bunch_pattern)
For storage rings, description of the bunch pattern.



DataNode
setCurrent(IDataset current)
Accelerator, X-ray tube, or storage ring current



DataNode
setCurrentScalar(java.lang.Double current)
Accelerator, X-ray tube, or storage ring current



DataNode
setDistance(IDataset distance)
Effective distance from sample
 Distance as seen by radiation from sample.



DataNode
setDistanceScalar(java.lang.Double distance)
Effective distance from sample
 Distance as seen by radiation from sample.



void
setDistribution(NXdata distribution)
The wavelength or energy distribution of the source



DataNode
setEmittance_x(IDataset emittance_x)
Source emittance (nm-rad) in X (horizontal) direction.



DataNode
setEmittance_xScalar(java.lang.Double emittance_x)
Source emittance (nm-rad) in X (horizontal) direction.



DataNode
setEmittance_y(IDataset emittance_y)
Source emittance (nm-rad) in Y (horizontal) direction.



DataNode
setEmittance_yScalar(java.lang.Double emittance_y)
Source emittance (nm-rad) in Y (horizontal) direction.



DataNode
setEnergy(IDataset energy)
Source energy.



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



DataNode
setFlux(IDataset flux)
Source intensity/area (example: s-1 cm-2)



DataNode
setFluxScalar(java.lang.Double flux)
Source intensity/area (example: s-1 cm-2)



DataNode
setFrequency(IDataset frequency)
Frequency of pulsed source



DataNode
setFrequencyScalar(java.lang.Double frequency)
Frequency of pulsed source



void
setGeometry(NXgeometry geometry)
"Engineering" location of source



DataNode
setLast_fill(IDataset last_fill)
For storage rings, the current at the end of the most recent injection.



void
setLast_fillAttributeTime(java.util.Date time)
date and time of the most recent injection.



DataNode
setLast_fillScalar(java.lang.Number last_fill)
For storage rings, the current at the end of the most recent injection.



DataNode
setMode(IDataset mode)
source operating mode



DataNode
setModeScalar(java.lang.String mode)
source operating mode



DataNode
setName(IDataset name)
Name of source



void
setNameAttributeShort_name(java.lang.String short_name)
short name for source, perhaps the acronym



DataNode
setNameScalar(java.lang.String name)
Name of source



void
setNotes(NXnote notes)
any source/facility related messages/events that
 occurred during the experiment



DataNode
setNumber_of_bunches(IDataset number_of_bunches)
For storage rings, the number of bunches in use.



DataNode
setNumber_of_bunchesScalar(java.lang.Long number_of_bunches)
For storage rings, the number of bunches in use.



DataNode
setPeriod(IDataset period)
Period of pulsed source



DataNode
setPeriodScalar(java.lang.Double period)
Period of pulsed source



DataNode
setPower(IDataset power)
Source power



DataNode
setPowerScalar(java.lang.Double power)
Source power



DataNode
setProbe(IDataset probe)
type of radiation probe (pick one from the enumerated list and spell exactly)



DataNode
setProbeScalar(java.lang.String probe)
type of radiation probe (pick one from the enumerated list and spell exactly)



void
setPulse_shape(NXdata pulse_shape)
source pulse shape



DataNode
setPulse_width(IDataset pulse_width)
temporal width of source pulse



DataNode
setPulse_widthScalar(java.lang.Double pulse_width)
temporal width of source pulse



DataNode
setSigma_x(IDataset sigma_x)
particle beam size in x



DataNode
setSigma_xScalar(java.lang.Double sigma_x)
particle beam size in x



DataNode
setSigma_y(IDataset sigma_y)
particle beam size in y



DataNode
setSigma_yScalar(java.lang.Double sigma_y)
particle beam size in y



DataNode
setTarget_material(IDataset target_material)
Pulsed source target material



DataNode
setTarget_materialScalar(java.lang.String target_material)
Pulsed source target material



DataNode
setTop_up(IDataset top_up)
Is the synchrotron operating in top_up mode?



DataNode
setTop_upScalar(java.lang.Boolean top_up)
Is the synchrotron operating in top_up mode?



DataNode
setType(IDataset type)
type of radiation source (pick one from the enumerated list and spell exactly)



DataNode
setTypeScalar(java.lang.String type)
type of radiation source (pick one from the enumerated list and spell exactly)



DataNode
setVoltage(IDataset voltage)
Accelerator voltage



DataNode
setVoltageScalar(java.lang.Double voltage)
Accelerator voltage







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





NXsourceImpl
public NXsourceImpl()







NXsourceImpl
public NXsourceImpl(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: NXsource
Effective distance from sample
 Distance as seen by radiation from sample. This number should be negative
 to signify that it is upstream of the sample.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

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








getDistanceScalar
public java.lang.Double getDistanceScalar()
Description copied from interface: NXsource
Effective distance from sample
 Distance as seen by radiation from sample. This number should be negative
 to signify that it is upstream of the sample.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

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








setDistance
public DataNode setDistance(IDataset distance)
Description copied from interface: NXsource
Effective distance from sample
 Distance as seen by radiation from sample. This number should be negative
 to signify that it is upstream of the sample.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

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








setDistanceScalar
public DataNode setDistanceScalar(java.lang.Double distance)
Description copied from interface: NXsource
Effective distance from sample
 Distance as seen by radiation from sample. This number should be negative
 to signify that it is upstream of the sample.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

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








getName
public IDataset getName()
Description copied from interface: NXsource
Name of source

Specified by:
getName in interface NXsource
Returns:
the value.








getNameScalar
public java.lang.String getNameScalar()
Description copied from interface: NXsource
Name of source

Specified by:
getNameScalar in interface NXsource
Returns:
the value.








setName
public DataNode setName(IDataset name)
Description copied from interface: NXsource
Name of source

Specified by:
setName in interface NXsource
Parameters:
name - the name








setNameScalar
public DataNode setNameScalar(java.lang.String name)
Description copied from interface: NXsource
Name of source

Specified by:
setNameScalar in interface NXsource
Parameters:
name - the name








getNameAttributeShort_name
public java.lang.String getNameAttributeShort_name()
Description copied from interface: NXsource
short name for source, perhaps the acronym

Specified by:
getNameAttributeShort_name in interface NXsource
Returns:
the value.








setNameAttributeShort_name
public void setNameAttributeShort_name(java.lang.String short_name)
Description copied from interface: NXsource
short name for source, perhaps the acronym

Specified by:
setNameAttributeShort_name in interface NXsource
Parameters:
short_name - the short_name








getType
public IDataset getType()
Description copied from interface: NXsource
type of radiation source (pick one from the enumerated list and spell exactly)
 

 
Enumeration:

 
Spallation Neutron Source 
 
Pulsed Reactor Neutron Source 
 
Reactor Neutron Source 
 
Synchrotron X-ray Source 
 
Pulsed Muon Source 
 
Rotating Anode X-ray 
 
Fixed Tube X-ray 
 
UV Laser 
 
Free-Electron Laser 
 
Optical Laser 
 
Ion Source 
 
UV Plasma Source 

 


Specified by:
getType in interface NXsource
Returns:
the value.








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXsource
type of radiation source (pick one from the enumerated list and spell exactly)
 

 
Enumeration:

 
Spallation Neutron Source 
 
Pulsed Reactor Neutron Source 
 
Reactor Neutron Source 
 
Synchrotron X-ray Source 
 
Pulsed Muon Source 
 
Rotating Anode X-ray 
 
Fixed Tube X-ray 
 
UV Laser 
 
Free-Electron Laser 
 
Optical Laser 
 
Ion Source 
 
UV Plasma Source 

 


Specified by:
getTypeScalar in interface NXsource
Returns:
the value.








setType
public DataNode setType(IDataset type)
Description copied from interface: NXsource
type of radiation source (pick one from the enumerated list and spell exactly)
 

 
Enumeration:

 
Spallation Neutron Source 
 
Pulsed Reactor Neutron Source 
 
Reactor Neutron Source 
 
Synchrotron X-ray Source 
 
Pulsed Muon Source 
 
Rotating Anode X-ray 
 
Fixed Tube X-ray 
 
UV Laser 
 
Free-Electron Laser 
 
Optical Laser 
 
Ion Source 
 
UV Plasma Source 

 


Specified by:
setType in interface NXsource
Parameters:
type - the type








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXsource
type of radiation source (pick one from the enumerated list and spell exactly)
 

 
Enumeration:

 
Spallation Neutron Source 
 
Pulsed Reactor Neutron Source 
 
Reactor Neutron Source 
 
Synchrotron X-ray Source 
 
Pulsed Muon Source 
 
Rotating Anode X-ray 
 
Fixed Tube X-ray 
 
UV Laser 
 
Free-Electron Laser 
 
Optical Laser 
 
Ion Source 
 
UV Plasma Source 

 


Specified by:
setTypeScalar in interface NXsource
Parameters:
type - the type








getProbe
public IDataset getProbe()
Description copied from interface: NXsource
type of radiation probe (pick one from the enumerated list and spell exactly)
 

 
Enumeration:

 
neutron 
 
x-ray 
 
muon 
 
electron 
 
ultraviolet 
 
visible light 
 
positron 
 
proton 

 


Specified by:
getProbe in interface NXsource
Returns:
the value.








getProbeScalar
public java.lang.String getProbeScalar()
Description copied from interface: NXsource
type of radiation probe (pick one from the enumerated list and spell exactly)
 

 
Enumeration:

 
neutron 
 
x-ray 
 
muon 
 
electron 
 
ultraviolet 
 
visible light 
 
positron 
 
proton 

 


Specified by:
getProbeScalar in interface NXsource
Returns:
the value.








setProbe
public DataNode setProbe(IDataset probe)
Description copied from interface: NXsource
type of radiation probe (pick one from the enumerated list and spell exactly)
 

 
Enumeration:

 
neutron 
 
x-ray 
 
muon 
 
electron 
 
ultraviolet 
 
visible light 
 
positron 
 
proton 

 


Specified by:
setProbe in interface NXsource
Parameters:
probe - the probe








setProbeScalar
public DataNode setProbeScalar(java.lang.String probe)
Description copied from interface: NXsource
type of radiation probe (pick one from the enumerated list and spell exactly)
 

 
Enumeration:

 
neutron 
 
x-ray 
 
muon 
 
electron 
 
ultraviolet 
 
visible light 
 
positron 
 
proton 

 


Specified by:
setProbeScalar in interface NXsource
Parameters:
probe - the probe








getPower
public IDataset getPower()
Description copied from interface: NXsource
Source power
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Specified by:
getPower in interface NXsource
Returns:
the value.








getPowerScalar
public java.lang.Double getPowerScalar()
Description copied from interface: NXsource
Source power
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Specified by:
getPowerScalar in interface NXsource
Returns:
the value.








setPower
public DataNode setPower(IDataset power)
Description copied from interface: NXsource
Source power
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Specified by:
setPower in interface NXsource
Parameters:
power - the power








setPowerScalar
public DataNode setPowerScalar(java.lang.Double power)
Description copied from interface: NXsource
Source power
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Specified by:
setPowerScalar in interface NXsource
Parameters:
power - the power








getEmittance_x
public IDataset getEmittance_x()
Description copied from interface: NXsource
Source emittance (nm-rad) in X (horizontal) direction.
 

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Specified by:
getEmittance_x in interface NXsource
Returns:
the value.








getEmittance_xScalar
public java.lang.Double getEmittance_xScalar()
Description copied from interface: NXsource
Source emittance (nm-rad) in X (horizontal) direction.
 

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Specified by:
getEmittance_xScalar in interface NXsource
Returns:
the value.








setEmittance_x
public DataNode setEmittance_x(IDataset emittance_x)
Description copied from interface: NXsource
Source emittance (nm-rad) in X (horizontal) direction.
 

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Specified by:
setEmittance_x in interface NXsource
Parameters:
emittance_x - the emittance_x








setEmittance_xScalar
public DataNode setEmittance_xScalar(java.lang.Double emittance_x)
Description copied from interface: NXsource
Source emittance (nm-rad) in X (horizontal) direction.
 

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Specified by:
setEmittance_xScalar in interface NXsource
Parameters:
emittance_x - the emittance_x








getEmittance_y
public IDataset getEmittance_y()
Description copied from interface: NXsource
Source emittance (nm-rad) in Y (horizontal) direction.
 

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Specified by:
getEmittance_y in interface NXsource
Returns:
the value.








getEmittance_yScalar
public java.lang.Double getEmittance_yScalar()
Description copied from interface: NXsource
Source emittance (nm-rad) in Y (horizontal) direction.
 

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Specified by:
getEmittance_yScalar in interface NXsource
Returns:
the value.








setEmittance_y
public DataNode setEmittance_y(IDataset emittance_y)
Description copied from interface: NXsource
Source emittance (nm-rad) in Y (horizontal) direction.
 

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Specified by:
setEmittance_y in interface NXsource
Parameters:
emittance_y - the emittance_y








setEmittance_yScalar
public DataNode setEmittance_yScalar(java.lang.Double emittance_y)
Description copied from interface: NXsource
Source emittance (nm-rad) in Y (horizontal) direction.
 

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Specified by:
setEmittance_yScalar in interface NXsource
Parameters:
emittance_y - the emittance_y








getSigma_x
public IDataset getSigma_x()
Description copied from interface: NXsource
particle beam size in x
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSigma_x in interface NXsource
Returns:
the value.








getSigma_xScalar
public java.lang.Double getSigma_xScalar()
Description copied from interface: NXsource
particle beam size in x
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSigma_xScalar in interface NXsource
Returns:
the value.








setSigma_x
public DataNode setSigma_x(IDataset sigma_x)
Description copied from interface: NXsource
particle beam size in x
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSigma_x in interface NXsource
Parameters:
sigma_x - the sigma_x








setSigma_xScalar
public DataNode setSigma_xScalar(java.lang.Double sigma_x)
Description copied from interface: NXsource
particle beam size in x
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSigma_xScalar in interface NXsource
Parameters:
sigma_x - the sigma_x








getSigma_y
public IDataset getSigma_y()
Description copied from interface: NXsource
particle beam size in y
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSigma_y in interface NXsource
Returns:
the value.








getSigma_yScalar
public java.lang.Double getSigma_yScalar()
Description copied from interface: NXsource
particle beam size in y
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSigma_yScalar in interface NXsource
Returns:
the value.








setSigma_y
public DataNode setSigma_y(IDataset sigma_y)
Description copied from interface: NXsource
particle beam size in y
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSigma_y in interface NXsource
Parameters:
sigma_y - the sigma_y








setSigma_yScalar
public DataNode setSigma_yScalar(java.lang.Double sigma_y)
Description copied from interface: NXsource
particle beam size in y
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSigma_yScalar in interface NXsource
Parameters:
sigma_y - the sigma_y








getFlux
public IDataset getFlux()
Description copied from interface: NXsource
Source intensity/area (example: s-1 cm-2)
 

 Type: NX_FLOAT
 Units: NX_FLUX
 

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








getFluxScalar
public java.lang.Double getFluxScalar()
Description copied from interface: NXsource
Source intensity/area (example: s-1 cm-2)
 

 Type: NX_FLOAT
 Units: NX_FLUX
 

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








setFlux
public DataNode setFlux(IDataset flux)
Description copied from interface: NXsource
Source intensity/area (example: s-1 cm-2)
 

 Type: NX_FLOAT
 Units: NX_FLUX
 

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








setFluxScalar
public DataNode setFluxScalar(java.lang.Double flux)
Description copied from interface: NXsource
Source intensity/area (example: s-1 cm-2)
 

 Type: NX_FLOAT
 Units: NX_FLUX
 

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








getEnergy
public IDataset getEnergy()
Description copied from interface: NXsource
Source energy.
 For storage rings, this would be the particle beam energy.
 For X-ray tubes, this would be the excitation voltage.
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

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








getEnergyScalar
public java.lang.Double getEnergyScalar()
Description copied from interface: NXsource
Source energy.
 For storage rings, this would be the particle beam energy.
 For X-ray tubes, this would be the excitation voltage.
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

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








setEnergy
public DataNode setEnergy(IDataset energy)
Description copied from interface: NXsource
Source energy.
 For storage rings, this would be the particle beam energy.
 For X-ray tubes, this would be the excitation voltage.
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

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








setEnergyScalar
public DataNode setEnergyScalar(java.lang.Double energy)
Description copied from interface: NXsource
Source energy.
 For storage rings, this would be the particle beam energy.
 For X-ray tubes, this would be the excitation voltage.
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

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








getCurrent
public IDataset getCurrent()
Description copied from interface: NXsource
Accelerator, X-ray tube, or storage ring current
 

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getCurrent in interface NXsource
Returns:
the value.








getCurrentScalar
public java.lang.Double getCurrentScalar()
Description copied from interface: NXsource
Accelerator, X-ray tube, or storage ring current
 

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getCurrentScalar in interface NXsource
Returns:
the value.








setCurrent
public DataNode setCurrent(IDataset current)
Description copied from interface: NXsource
Accelerator, X-ray tube, or storage ring current
 

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setCurrent in interface NXsource
Parameters:
current - the current








setCurrentScalar
public DataNode setCurrentScalar(java.lang.Double current)
Description copied from interface: NXsource
Accelerator, X-ray tube, or storage ring current
 

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setCurrentScalar in interface NXsource
Parameters:
current - the current








getVoltage
public IDataset getVoltage()
Description copied from interface: NXsource
Accelerator voltage
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Specified by:
getVoltage in interface NXsource
Returns:
the value.








getVoltageScalar
public java.lang.Double getVoltageScalar()
Description copied from interface: NXsource
Accelerator voltage
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Specified by:
getVoltageScalar in interface NXsource
Returns:
the value.








setVoltage
public DataNode setVoltage(IDataset voltage)
Description copied from interface: NXsource
Accelerator voltage
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Specified by:
setVoltage in interface NXsource
Parameters:
voltage - the voltage








setVoltageScalar
public DataNode setVoltageScalar(java.lang.Double voltage)
Description copied from interface: NXsource
Accelerator voltage
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Specified by:
setVoltageScalar in interface NXsource
Parameters:
voltage - the voltage








getFrequency
public IDataset getFrequency()
Description copied from interface: NXsource
Frequency of pulsed source
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Specified by:
getFrequency in interface NXsource
Returns:
the value.








getFrequencyScalar
public java.lang.Double getFrequencyScalar()
Description copied from interface: NXsource
Frequency of pulsed source
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Specified by:
getFrequencyScalar in interface NXsource
Returns:
the value.








setFrequency
public DataNode setFrequency(IDataset frequency)
Description copied from interface: NXsource
Frequency of pulsed source
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Specified by:
setFrequency in interface NXsource
Parameters:
frequency - the frequency








setFrequencyScalar
public DataNode setFrequencyScalar(java.lang.Double frequency)
Description copied from interface: NXsource
Frequency of pulsed source
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Specified by:
setFrequencyScalar in interface NXsource
Parameters:
frequency - the frequency








getPeriod
public IDataset getPeriod()
Description copied from interface: NXsource
Period of pulsed source
 

 Type: NX_FLOAT
 Units: NX_PERIOD
 

Specified by:
getPeriod in interface NXsource
Returns:
the value.








getPeriodScalar
public java.lang.Double getPeriodScalar()
Description copied from interface: NXsource
Period of pulsed source
 

 Type: NX_FLOAT
 Units: NX_PERIOD
 

Specified by:
getPeriodScalar in interface NXsource
Returns:
the value.








setPeriod
public DataNode setPeriod(IDataset period)
Description copied from interface: NXsource
Period of pulsed source
 

 Type: NX_FLOAT
 Units: NX_PERIOD
 

Specified by:
setPeriod in interface NXsource
Parameters:
period - the period








setPeriodScalar
public DataNode setPeriodScalar(java.lang.Double period)
Description copied from interface: NXsource
Period of pulsed source
 

 Type: NX_FLOAT
 Units: NX_PERIOD
 

Specified by:
setPeriodScalar in interface NXsource
Parameters:
period - the period








getTarget_material
public IDataset getTarget_material()
Description copied from interface: NXsource
Pulsed source target material
 

 
Enumeration:

 
Ta 
 
W 
 
depleted_U 
 
enriched_U 
 
Hg 
 
Pb 
 
C 

 


Specified by:
getTarget_material in interface NXsource
Returns:
the value.








getTarget_materialScalar
public java.lang.String getTarget_materialScalar()
Description copied from interface: NXsource
Pulsed source target material
 

 
Enumeration:

 
Ta 
 
W 
 
depleted_U 
 
enriched_U 
 
Hg 
 
Pb 
 
C 

 


Specified by:
getTarget_materialScalar in interface NXsource
Returns:
the value.








setTarget_material
public DataNode setTarget_material(IDataset target_material)
Description copied from interface: NXsource
Pulsed source target material
 

 
Enumeration:

 
Ta 
 
W 
 
depleted_U 
 
enriched_U 
 
Hg 
 
Pb 
 
C 

 


Specified by:
setTarget_material in interface NXsource
Parameters:
target_material - the target_material








setTarget_materialScalar
public DataNode setTarget_materialScalar(java.lang.String target_material)
Description copied from interface: NXsource
Pulsed source target material
 

 
Enumeration:

 
Ta 
 
W 
 
depleted_U 
 
enriched_U 
 
Hg 
 
Pb 
 
C 

 


Specified by:
setTarget_materialScalar in interface NXsource
Parameters:
target_material - the target_material








getNotes
public NXnote getNotes()
Description copied from interface: NXsource
any source/facility related messages/events that
 occurred during the experiment

Specified by:
getNotes in interface NXsource
Returns:
the value.








setNotes
public void setNotes(NXnote notes)
Description copied from interface: NXsource
any source/facility related messages/events that
 occurred during the experiment

Specified by:
setNotes in interface NXsource
Parameters:
notes - the notes








getBunch_pattern
public NXdata getBunch_pattern()
Description copied from interface: NXsource
For storage rings, description of the bunch pattern.
 This is useful to describe irregular bunch patterns.

Specified by:
getBunch_pattern in interface NXsource
Returns:
the value.








setBunch_pattern
public void setBunch_pattern(NXdata bunch_pattern)
Description copied from interface: NXsource
For storage rings, description of the bunch pattern.
 This is useful to describe irregular bunch patterns.

Specified by:
setBunch_pattern in interface NXsource
Parameters:
bunch_pattern - the bunch_pattern








getNumber_of_bunches
public IDataset getNumber_of_bunches()
Description copied from interface: NXsource
For storage rings, the number of bunches in use.
 

 Type: NX_INT
 

Specified by:
getNumber_of_bunches in interface NXsource
Returns:
the value.








getNumber_of_bunchesScalar
public java.lang.Long getNumber_of_bunchesScalar()
Description copied from interface: NXsource
For storage rings, the number of bunches in use.
 

 Type: NX_INT
 

Specified by:
getNumber_of_bunchesScalar in interface NXsource
Returns:
the value.








setNumber_of_bunches
public DataNode setNumber_of_bunches(IDataset number_of_bunches)
Description copied from interface: NXsource
For storage rings, the number of bunches in use.
 

 Type: NX_INT
 

Specified by:
setNumber_of_bunches in interface NXsource
Parameters:
number_of_bunches - the number_of_bunches








setNumber_of_bunchesScalar
public DataNode setNumber_of_bunchesScalar(java.lang.Long number_of_bunches)
Description copied from interface: NXsource
For storage rings, the number of bunches in use.
 

 Type: NX_INT
 

Specified by:
setNumber_of_bunchesScalar in interface NXsource
Parameters:
number_of_bunches - the number_of_bunches








getBunch_length
public IDataset getBunch_length()
Description copied from interface: NXsource
For storage rings, temporal length of the bunch
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
getBunch_length in interface NXsource
Returns:
the value.








getBunch_lengthScalar
public java.lang.Double getBunch_lengthScalar()
Description copied from interface: NXsource
For storage rings, temporal length of the bunch
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
getBunch_lengthScalar in interface NXsource
Returns:
the value.








setBunch_length
public DataNode setBunch_length(IDataset bunch_length)
Description copied from interface: NXsource
For storage rings, temporal length of the bunch
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
setBunch_length in interface NXsource
Parameters:
bunch_length - the bunch_length








setBunch_lengthScalar
public DataNode setBunch_lengthScalar(java.lang.Double bunch_length)
Description copied from interface: NXsource
For storage rings, temporal length of the bunch
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
setBunch_lengthScalar in interface NXsource
Parameters:
bunch_length - the bunch_length








getBunch_distance
public IDataset getBunch_distance()
Description copied from interface: NXsource
For storage rings, time between bunches
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
getBunch_distance in interface NXsource
Returns:
the value.








getBunch_distanceScalar
public java.lang.Double getBunch_distanceScalar()
Description copied from interface: NXsource
For storage rings, time between bunches
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
getBunch_distanceScalar in interface NXsource
Returns:
the value.








setBunch_distance
public DataNode setBunch_distance(IDataset bunch_distance)
Description copied from interface: NXsource
For storage rings, time between bunches
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
setBunch_distance in interface NXsource
Parameters:
bunch_distance - the bunch_distance








setBunch_distanceScalar
public DataNode setBunch_distanceScalar(java.lang.Double bunch_distance)
Description copied from interface: NXsource
For storage rings, time between bunches
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
setBunch_distanceScalar in interface NXsource
Parameters:
bunch_distance - the bunch_distance








getPulse_width
public IDataset getPulse_width()
Description copied from interface: NXsource
temporal width of source pulse
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
getPulse_width in interface NXsource
Returns:
the value.








getPulse_widthScalar
public java.lang.Double getPulse_widthScalar()
Description copied from interface: NXsource
temporal width of source pulse
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
getPulse_widthScalar in interface NXsource
Returns:
the value.








setPulse_width
public DataNode setPulse_width(IDataset pulse_width)
Description copied from interface: NXsource
temporal width of source pulse
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
setPulse_width in interface NXsource
Parameters:
pulse_width - the pulse_width








setPulse_widthScalar
public DataNode setPulse_widthScalar(java.lang.Double pulse_width)
Description copied from interface: NXsource
temporal width of source pulse
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
setPulse_widthScalar in interface NXsource
Parameters:
pulse_width - the pulse_width








getPulse_shape
public NXdata getPulse_shape()
Description copied from interface: NXsource
source pulse shape

Specified by:
getPulse_shape in interface NXsource
Returns:
the value.








setPulse_shape
public void setPulse_shape(NXdata pulse_shape)
Description copied from interface: NXsource
source pulse shape

Specified by:
setPulse_shape in interface NXsource
Parameters:
pulse_shape - the pulse_shape








getMode
public IDataset getMode()
Description copied from interface: NXsource
source operating mode
 

 
Enumeration:

 
Single Bunch 
 for storage rings
 
Multi Bunch 
 for storage rings

 


Specified by:
getMode in interface NXsource
Returns:
the value.








getModeScalar
public java.lang.String getModeScalar()
Description copied from interface: NXsource
source operating mode
 

 
Enumeration:

 
Single Bunch 
 for storage rings
 
Multi Bunch 
 for storage rings

 


Specified by:
getModeScalar in interface NXsource
Returns:
the value.








setMode
public DataNode setMode(IDataset mode)
Description copied from interface: NXsource
source operating mode
 

 
Enumeration:

 
Single Bunch 
 for storage rings
 
Multi Bunch 
 for storage rings

 


Specified by:
setMode in interface NXsource
Parameters:
mode - the mode








setModeScalar
public DataNode setModeScalar(java.lang.String mode)
Description copied from interface: NXsource
source operating mode
 

 
Enumeration:

 
Single Bunch 
 for storage rings
 
Multi Bunch 
 for storage rings

 


Specified by:
setModeScalar in interface NXsource
Parameters:
mode - the mode








getTop_up
public IDataset getTop_up()
Description copied from interface: NXsource
Is the synchrotron operating in top_up mode?
 

 Type: NX_BOOLEAN
 

Specified by:
getTop_up in interface NXsource
Returns:
the value.








getTop_upScalar
public java.lang.Boolean getTop_upScalar()
Description copied from interface: NXsource
Is the synchrotron operating in top_up mode?
 

 Type: NX_BOOLEAN
 

Specified by:
getTop_upScalar in interface NXsource
Returns:
the value.








setTop_up
public DataNode setTop_up(IDataset top_up)
Description copied from interface: NXsource
Is the synchrotron operating in top_up mode?
 

 Type: NX_BOOLEAN
 

Specified by:
setTop_up in interface NXsource
Parameters:
top_up - the top_up








setTop_upScalar
public DataNode setTop_upScalar(java.lang.Boolean top_up)
Description copied from interface: NXsource
Is the synchrotron operating in top_up mode?
 

 Type: NX_BOOLEAN
 

Specified by:
setTop_upScalar in interface NXsource
Parameters:
top_up - the top_up








getLast_fill
public IDataset getLast_fill()
Description copied from interface: NXsource
For storage rings, the current at the end of the most recent injection.
 

 Type: NX_NUMBER
 Units: NX_CURRENT
 

Specified by:
getLast_fill in interface NXsource
Returns:
the value.








getLast_fillScalar
public java.lang.Number getLast_fillScalar()
Description copied from interface: NXsource
For storage rings, the current at the end of the most recent injection.
 

 Type: NX_NUMBER
 Units: NX_CURRENT
 

Specified by:
getLast_fillScalar in interface NXsource
Returns:
the value.








setLast_fill
public DataNode setLast_fill(IDataset last_fill)
Description copied from interface: NXsource
For storage rings, the current at the end of the most recent injection.
 

 Type: NX_NUMBER
 Units: NX_CURRENT
 

Specified by:
setLast_fill in interface NXsource
Parameters:
last_fill - the last_fill








setLast_fillScalar
public DataNode setLast_fillScalar(java.lang.Number last_fill)
Description copied from interface: NXsource
For storage rings, the current at the end of the most recent injection.
 

 Type: NX_NUMBER
 Units: NX_CURRENT
 

Specified by:
setLast_fillScalar in interface NXsource
Parameters:
last_fill - the last_fill








getLast_fillAttributeTime
public java.util.Date getLast_fillAttributeTime()
Description copied from interface: NXsource
date and time of the most recent injection.

Specified by:
getLast_fillAttributeTime in interface NXsource
Returns:
the value.








setLast_fillAttributeTime
public void setLast_fillAttributeTime(java.util.Date time)
Description copied from interface: NXsource
date and time of the most recent injection.

Specified by:
setLast_fillAttributeTime in interface NXsource
Parameters:
time - the time








getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXsource
"Engineering" location of source

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








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXsource
"Engineering" location of source

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








getDistribution
public NXdata getDistribution()
Description copied from interface: NXsource
The wavelength or energy distribution of the source

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








setDistribution
public void setDistribution(NXdata distribution)
Description copied from interface: NXsource
The wavelength or energy distribution of the source

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














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