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






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


All Known Implementing Classes:
NXsourceImpl




public interface NXsource
extends NXobject
The neutron or x-ray storage ring/facility.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_BUNCH_DISTANCE 


static java.lang.String
NX_BUNCH_LENGTH 


static java.lang.String
NX_CURRENT 


static java.lang.String
NX_DISTANCE 


static java.lang.String
NX_EMITTANCE_X 


static java.lang.String
NX_EMITTANCE_Y 


static java.lang.String
NX_ENERGY 


static java.lang.String
NX_FLUX 


static java.lang.String
NX_FREQUENCY 


static java.lang.String
NX_LAST_FILL 


static java.lang.String
NX_LAST_FILL_ATTRIBUTE_TIME 


static java.lang.String
NX_MODE 


static java.lang.String
NX_NAME 


static java.lang.String
NX_NAME_ATTRIBUTE_SHORT_NAME 


static java.lang.String
NX_NUMBER_OF_BUNCHES 


static java.lang.String
NX_PERIOD 


static java.lang.String
NX_POWER 


static java.lang.String
NX_PROBE 


static java.lang.String
NX_PULSE_WIDTH 


static java.lang.String
NX_SIGMA_X 


static java.lang.String
NX_SIGMA_Y 


static java.lang.String
NX_TARGET_MATERIAL 


static java.lang.String
NX_TOP_UP 


static java.lang.String
NX_TYPE 


static java.lang.String
NX_VOLTAGE 






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


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



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.



IDataset
getPeriod()
Period of pulsed source



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



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 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_NAME
static final java.lang.String NX_NAME

See Also:
Constant Field Values








NX_NAME_ATTRIBUTE_SHORT_NAME
static final java.lang.String NX_NAME_ATTRIBUTE_SHORT_NAME

See Also:
Constant Field Values








NX_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_PROBE
static final java.lang.String NX_PROBE

See Also:
Constant Field Values








NX_POWER
static final java.lang.String NX_POWER

See Also:
Constant Field Values








NX_EMITTANCE_X
static final java.lang.String NX_EMITTANCE_X

See Also:
Constant Field Values








NX_EMITTANCE_Y
static final java.lang.String NX_EMITTANCE_Y

See Also:
Constant Field Values








NX_SIGMA_X
static final java.lang.String NX_SIGMA_X

See Also:
Constant Field Values








NX_SIGMA_Y
static final java.lang.String NX_SIGMA_Y

See Also:
Constant Field Values








NX_FLUX
static final java.lang.String NX_FLUX

See Also:
Constant Field Values








NX_ENERGY
static final java.lang.String NX_ENERGY

See Also:
Constant Field Values








NX_CURRENT
static final java.lang.String NX_CURRENT

See Also:
Constant Field Values








NX_VOLTAGE
static final java.lang.String NX_VOLTAGE

See Also:
Constant Field Values








NX_FREQUENCY
static final java.lang.String NX_FREQUENCY

See Also:
Constant Field Values








NX_PERIOD
static final java.lang.String NX_PERIOD

See Also:
Constant Field Values








NX_TARGET_MATERIAL
static final java.lang.String NX_TARGET_MATERIAL

See Also:
Constant Field Values








NX_NUMBER_OF_BUNCHES
static final java.lang.String NX_NUMBER_OF_BUNCHES

See Also:
Constant Field Values








NX_BUNCH_LENGTH
static final java.lang.String NX_BUNCH_LENGTH

See Also:
Constant Field Values








NX_BUNCH_DISTANCE
static final java.lang.String NX_BUNCH_DISTANCE

See Also:
Constant Field Values








NX_PULSE_WIDTH
static final java.lang.String NX_PULSE_WIDTH

See Also:
Constant Field Values








NX_MODE
static final java.lang.String NX_MODE

See Also:
Constant Field Values








NX_TOP_UP
static final java.lang.String NX_TOP_UP

See Also:
Constant Field Values








NX_LAST_FILL
static final java.lang.String NX_LAST_FILL

See Also:
Constant Field Values








NX_LAST_FILL_ATTRIBUTE_TIME
static final java.lang.String NX_LAST_FILL_ATTRIBUTE_TIME

See Also:
Constant Field Values










Method Detail





getDistance
IDataset getDistance()
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
 

Returns:
the value.








setDistance
DataNode setDistance(IDataset distance)
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
 

Parameters:
distance - the distance








getDistanceScalar
java.lang.Double getDistanceScalar()
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
 

Returns:
the value.








setDistanceScalar
DataNode setDistanceScalar(java.lang.Double distance)
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
 

Parameters:
distance - the distance








getName
IDataset getName()
Name of source

Returns:
the value.








setName
DataNode setName(IDataset name)
Name of source

Parameters:
name - the name








getNameScalar
java.lang.String getNameScalar()
Name of source

Returns:
the value.








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

Parameters:
name - the name








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

Returns:
the value.








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

Parameters:
short_name - the short_name








getType
IDataset getType()
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 

 


Returns:
the value.








setType
DataNode setType(IDataset type)
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 

 


Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()
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 

 


Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)
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 

 


Parameters:
type - the type








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

 
Enumeration:

 
neutron 
 
x-ray 
 
muon 
 
electron 
 
ultraviolet 
 
visible light 
 
positron 
 
proton 

 


Returns:
the value.








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

 
Enumeration:

 
neutron 
 
x-ray 
 
muon 
 
electron 
 
ultraviolet 
 
visible light 
 
positron 
 
proton 

 


Parameters:
probe - the probe








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

 
Enumeration:

 
neutron 
 
x-ray 
 
muon 
 
electron 
 
ultraviolet 
 
visible light 
 
positron 
 
proton 

 


Returns:
the value.








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

 
Enumeration:

 
neutron 
 
x-ray 
 
muon 
 
electron 
 
ultraviolet 
 
visible light 
 
positron 
 
proton 

 


Parameters:
probe - the probe








getPower
IDataset getPower()
Source power
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Returns:
the value.








setPower
DataNode setPower(IDataset power)
Source power
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Parameters:
power - the power








getPowerScalar
java.lang.Double getPowerScalar()
Source power
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_POWER
 

Parameters:
power - the power








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

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Parameters:
emittance_x - the emittance_x








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

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Parameters:
emittance_x - the emittance_x








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

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Parameters:
emittance_y - the emittance_y








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

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_EMITTANCE
 

Parameters:
emittance_y - the emittance_y








getSigma_x
IDataset getSigma_x()
particle beam size in x
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setSigma_x
DataNode setSigma_x(IDataset sigma_x)
particle beam size in x
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
sigma_x - the sigma_x








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
sigma_x - the sigma_x








getSigma_y
IDataset getSigma_y()
particle beam size in y
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setSigma_y
DataNode setSigma_y(IDataset sigma_y)
particle beam size in y
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
sigma_y - the sigma_y








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
sigma_y - the sigma_y








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

 Type: NX_FLOAT
 Units: NX_FLUX
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_FLUX
 

Parameters:
flux - the flux








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

 Type: NX_FLOAT
 Units: NX_FLUX
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_FLUX
 

Parameters:
flux - the flux








getEnergy
IDataset getEnergy()
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
 

Returns:
the value.








setEnergy
DataNode setEnergy(IDataset energy)
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
 

Parameters:
energy - the energy








getEnergyScalar
java.lang.Double getEnergyScalar()
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
 

Returns:
the value.








setEnergyScalar
DataNode setEnergyScalar(java.lang.Double energy)
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
 

Parameters:
energy - the energy








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

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Parameters:
current - the current








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

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Parameters:
current - the current








getVoltage
IDataset getVoltage()
Accelerator voltage
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Returns:
the value.








setVoltage
DataNode setVoltage(IDataset voltage)
Accelerator voltage
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Parameters:
voltage - the voltage








getVoltageScalar
java.lang.Double getVoltageScalar()
Accelerator voltage
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Parameters:
voltage - the voltage








getFrequency
IDataset getFrequency()
Frequency of pulsed source
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Returns:
the value.








setFrequency
DataNode setFrequency(IDataset frequency)
Frequency of pulsed source
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Parameters:
frequency - the frequency








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

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Parameters:
frequency - the frequency








getPeriod
IDataset getPeriod()
Period of pulsed source
 

 Type: NX_FLOAT
 Units: NX_PERIOD
 

Returns:
the value.








setPeriod
DataNode setPeriod(IDataset period)
Period of pulsed source
 

 Type: NX_FLOAT
 Units: NX_PERIOD
 

Parameters:
period - the period








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

 Type: NX_FLOAT
 Units: NX_PERIOD
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_PERIOD
 

Parameters:
period - the period








getTarget_material
IDataset getTarget_material()
Pulsed source target material
 

 
Enumeration:

 
Ta 
 
W 
 
depleted_U 
 
enriched_U 
 
Hg 
 
Pb 
 
C 

 


Returns:
the value.








setTarget_material
DataNode setTarget_material(IDataset target_material)
Pulsed source target material
 

 
Enumeration:

 
Ta 
 
W 
 
depleted_U 
 
enriched_U 
 
Hg 
 
Pb 
 
C 

 


Parameters:
target_material - the target_material








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

 
Enumeration:

 
Ta 
 
W 
 
depleted_U 
 
enriched_U 
 
Hg 
 
Pb 
 
C 

 


Returns:
the value.








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

 
Enumeration:

 
Ta 
 
W 
 
depleted_U 
 
enriched_U 
 
Hg 
 
Pb 
 
C 

 


Parameters:
target_material - the target_material








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

Returns:
the value.








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

Parameters:
notes - the notes








getBunch_pattern
NXdata getBunch_pattern()
For storage rings, description of the bunch pattern.
 This is useful to describe irregular bunch patterns.

Returns:
the value.








setBunch_pattern
void setBunch_pattern(NXdata bunch_pattern)
For storage rings, description of the bunch pattern.
 This is useful to describe irregular bunch patterns.

Parameters:
bunch_pattern - the bunch_pattern








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

 Type: NX_INT
 

Returns:
the value.








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

 Type: NX_INT
 

Parameters:
number_of_bunches - the number_of_bunches








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

 Type: NX_INT
 

Returns:
the value.








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

 Type: NX_INT
 

Parameters:
number_of_bunches - the number_of_bunches








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

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
bunch_length - the bunch_length








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

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
bunch_length - the bunch_length








getBunch_distance
IDataset getBunch_distance()
For storage rings, time between bunches
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
bunch_distance - the bunch_distance








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

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
bunch_distance - the bunch_distance








getPulse_width
IDataset getPulse_width()
temporal width of source pulse
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








setPulse_width
DataNode setPulse_width(IDataset pulse_width)
temporal width of source pulse
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
pulse_width - the pulse_width








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

 Type: NX_FLOAT
 Units: NX_TIME
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_TIME
 

Parameters:
pulse_width - the pulse_width








getPulse_shape
NXdata getPulse_shape()
source pulse shape

Returns:
the value.








setPulse_shape
void setPulse_shape(NXdata pulse_shape)
source pulse shape

Parameters:
pulse_shape - the pulse_shape








getMode
IDataset getMode()
source operating mode
 

 
Enumeration:

 
Single Bunch 
 for storage rings
 
Multi Bunch 
 for storage rings

 


Returns:
the value.








setMode
DataNode setMode(IDataset mode)
source operating mode
 

 
Enumeration:

 
Single Bunch 
 for storage rings
 
Multi Bunch 
 for storage rings

 


Parameters:
mode - the mode








getModeScalar
java.lang.String getModeScalar()
source operating mode
 

 
Enumeration:

 
Single Bunch 
 for storage rings
 
Multi Bunch 
 for storage rings

 


Returns:
the value.








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

 
Enumeration:

 
Single Bunch 
 for storage rings
 
Multi Bunch 
 for storage rings

 


Parameters:
mode - the mode








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

 Type: NX_BOOLEAN
 

Returns:
the value.








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

 Type: NX_BOOLEAN
 

Parameters:
top_up - the top_up








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

 Type: NX_BOOLEAN
 

Returns:
the value.








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

 Type: NX_BOOLEAN
 

Parameters:
top_up - the top_up








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

 Type: NX_NUMBER
 Units: NX_CURRENT
 

Returns:
the value.








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

 Type: NX_NUMBER
 Units: NX_CURRENT
 

Parameters:
last_fill - the last_fill








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

 Type: NX_NUMBER
 Units: NX_CURRENT
 

Returns:
the value.








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

 Type: NX_NUMBER
 Units: NX_CURRENT
 

Parameters:
last_fill - the last_fill








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

Returns:
the value.








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

Parameters:
time - the time








getGeometry
NXgeometry getGeometry()
"Engineering" location of source

Returns:
the value.








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

Parameters:
geometry - the geometry








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

Returns:
the value.








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

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