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






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


All Known Implementing Classes:
NXdisk_chopperImpl




public interface NXdisk_chopper
extends NXobject
A device blocking the beam in a temporal periodic pattern.
 TODO: need documentation











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DISTANCE 


static java.lang.String
NX_PAIR_SEPARATION 


static java.lang.String
NX_PHASE 


static java.lang.String
NX_RADIUS 


static java.lang.String
NX_RATIO 


static java.lang.String
NX_ROTATION_SPEED 


static java.lang.String
NX_SLIT_ANGLE 


static java.lang.String
NX_SLIT_HEIGHT 


static java.lang.String
NX_SLITS 


static java.lang.String
NX_TYPE 


static java.lang.String
NX_WAVELENGTH_RANGE 






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








Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
 
 
 



IDataset
getDistance()
Effective distance to the origin



java.lang.Double
getDistanceScalar()
Effective distance to the origin



NXgeometry
getGeometry() 


NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 



IDataset
getPair_separation()
disc spacing in direction of beam



java.lang.Double
getPair_separationScalar()
disc spacing in direction of beam



IDataset
getPhase()
chopper phase angle



java.lang.Double
getPhaseScalar()
chopper phase angle



IDataset
getRadius()
radius to centre of slit



java.lang.Double
getRadiusScalar()
radius to centre of slit



IDataset
getRatio()
pulse reduction factor of this chopper in relation to other
 choppers/fastest pulse in the instrument



java.lang.Long
getRatioScalar()
pulse reduction factor of this chopper in relation to other
 choppers/fastest pulse in the instrument



IDataset
getRotation_speed()
chopper rotation speed



java.lang.Double
getRotation_speedScalar()
chopper rotation speed



IDataset
getSlit_angle()
angular opening



java.lang.Double
getSlit_angleScalar()
angular opening



IDataset
getSlit_height()
total slit height



java.lang.Double
getSlit_heightScalar()
total slit height



IDataset
getSlits()
Number of slits



java.lang.Long
getSlitsScalar()
Number of slits



IDataset
getType()
Type of the disk-chopper: only one from the enumerated list (match text exactly)



java.lang.String
getTypeScalar()
Type of the disk-chopper: only one from the enumerated list (match text exactly)



IDataset
getWavelength_range()
low and high values of wavelength range transmitted



java.lang.Double
getWavelength_rangeScalar()
low and high values of wavelength range transmitted



void
setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.



DataNode
setDistance(IDataset distance)
Effective distance to the origin



DataNode
setDistanceScalar(java.lang.Double distance)
Effective distance to the origin



void
setGeometry(NXgeometry geometry) 


void
setGeometry(java.lang.String name,
           NXgeometry geometry)
Set a NXgeometry node by name:
 
 
 



DataNode
setPair_separation(IDataset pair_separation)
disc spacing in direction of beam



DataNode
setPair_separationScalar(java.lang.Double pair_separation)
disc spacing in direction of beam



DataNode
setPhase(IDataset phase)
chopper phase angle



DataNode
setPhaseScalar(java.lang.Double phase)
chopper phase angle



DataNode
setRadius(IDataset radius)
radius to centre of slit



DataNode
setRadiusScalar(java.lang.Double radius)
radius to centre of slit



DataNode
setRatio(IDataset ratio)
pulse reduction factor of this chopper in relation to other
 choppers/fastest pulse in the instrument



DataNode
setRatioScalar(java.lang.Long ratio)
pulse reduction factor of this chopper in relation to other
 choppers/fastest pulse in the instrument



DataNode
setRotation_speed(IDataset rotation_speed)
chopper rotation speed



DataNode
setRotation_speedScalar(java.lang.Double rotation_speed)
chopper rotation speed



DataNode
setSlit_angle(IDataset slit_angle)
angular opening



DataNode
setSlit_angleScalar(java.lang.Double slit_angle)
angular opening



DataNode
setSlit_height(IDataset slit_height)
total slit height



DataNode
setSlit_heightScalar(java.lang.Double slit_height)
total slit height



DataNode
setSlits(IDataset slits)
Number of slits



DataNode
setSlitsScalar(java.lang.Long slits)
Number of slits



DataNode
setType(IDataset type)
Type of the disk-chopper: only one from the enumerated list (match text exactly)



DataNode
setTypeScalar(java.lang.String type)
Type of the disk-chopper: only one from the enumerated list (match text exactly)



DataNode
setWavelength_range(IDataset wavelength_range)
low and high values of wavelength range transmitted



DataNode
setWavelength_rangeScalar(java.lang.Double wavelength_range)
low and high values of wavelength range transmitted







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_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_ROTATION_SPEED
static final java.lang.String NX_ROTATION_SPEED

See Also:
Constant Field Values








NX_SLITS
static final java.lang.String NX_SLITS

See Also:
Constant Field Values








NX_SLIT_ANGLE
static final java.lang.String NX_SLIT_ANGLE

See Also:
Constant Field Values








NX_PAIR_SEPARATION
static final java.lang.String NX_PAIR_SEPARATION

See Also:
Constant Field Values








NX_RADIUS
static final java.lang.String NX_RADIUS

See Also:
Constant Field Values








NX_SLIT_HEIGHT
static final java.lang.String NX_SLIT_HEIGHT

See Also:
Constant Field Values








NX_PHASE
static final java.lang.String NX_PHASE

See Also:
Constant Field Values








NX_RATIO
static final java.lang.String NX_RATIO

See Also:
Constant Field Values








NX_DISTANCE
static final java.lang.String NX_DISTANCE

See Also:
Constant Field Values








NX_WAVELENGTH_RANGE
static final java.lang.String NX_WAVELENGTH_RANGE

See Also:
Constant Field Values










Method Detail





getType
IDataset getType()
Type of the disk-chopper: only one from the enumerated list (match text exactly)
 

 
Enumeration:

 
Chopper type single 
 
contra_rotating_pair 
 
synchro_pair 

 


Returns:
the value.








setType
DataNode setType(IDataset type)
Type of the disk-chopper: only one from the enumerated list (match text exactly)
 

 
Enumeration:

 
Chopper type single 
 
contra_rotating_pair 
 
synchro_pair 

 


Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()
Type of the disk-chopper: only one from the enumerated list (match text exactly)
 

 
Enumeration:

 
Chopper type single 
 
contra_rotating_pair 
 
synchro_pair 

 


Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)
Type of the disk-chopper: only one from the enumerated list (match text exactly)
 

 
Enumeration:

 
Chopper type single 
 
contra_rotating_pair 
 
synchro_pair 

 


Parameters:
type - the type








getRotation_speed
IDataset getRotation_speed()
chopper rotation speed
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Returns:
the value.








setRotation_speed
DataNode setRotation_speed(IDataset rotation_speed)
chopper rotation speed
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Parameters:
rotation_speed - the rotation_speed








getRotation_speedScalar
java.lang.Double getRotation_speedScalar()
chopper rotation speed
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Returns:
the value.








setRotation_speedScalar
DataNode setRotation_speedScalar(java.lang.Double rotation_speed)
chopper rotation speed
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Parameters:
rotation_speed - the rotation_speed








getSlits
IDataset getSlits()
Number of slits
 

 Type: NX_INT
 

Returns:
the value.








setSlits
DataNode setSlits(IDataset slits)
Number of slits
 

 Type: NX_INT
 

Parameters:
slits - the slits








getSlitsScalar
java.lang.Long getSlitsScalar()
Number of slits
 

 Type: NX_INT
 

Returns:
the value.








setSlitsScalar
DataNode setSlitsScalar(java.lang.Long slits)
Number of slits
 

 Type: NX_INT
 

Parameters:
slits - the slits








getSlit_angle
IDataset getSlit_angle()
angular opening
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setSlit_angle
DataNode setSlit_angle(IDataset slit_angle)
angular opening
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
slit_angle - the slit_angle








getSlit_angleScalar
java.lang.Double getSlit_angleScalar()
angular opening
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setSlit_angleScalar
DataNode setSlit_angleScalar(java.lang.Double slit_angle)
angular opening
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
slit_angle - the slit_angle








getPair_separation
IDataset getPair_separation()
disc spacing in direction of beam
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setPair_separation
DataNode setPair_separation(IDataset pair_separation)
disc spacing in direction of beam
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
pair_separation - the pair_separation








getPair_separationScalar
java.lang.Double getPair_separationScalar()
disc spacing in direction of beam
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setPair_separationScalar
DataNode setPair_separationScalar(java.lang.Double pair_separation)
disc spacing in direction of beam
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
pair_separation - the pair_separation








getRadius
IDataset getRadius()
radius to centre of slit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setRadius
DataNode setRadius(IDataset radius)
radius to centre of slit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
radius - the radius








getRadiusScalar
java.lang.Double getRadiusScalar()
radius to centre of slit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setRadiusScalar
DataNode setRadiusScalar(java.lang.Double radius)
radius to centre of slit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
radius - the radius








getSlit_height
IDataset getSlit_height()
total slit height
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setSlit_height
DataNode setSlit_height(IDataset slit_height)
total slit height
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
slit_height - the slit_height








getSlit_heightScalar
java.lang.Double getSlit_heightScalar()
total slit height
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setSlit_heightScalar
DataNode setSlit_heightScalar(java.lang.Double slit_height)
total slit height
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
slit_height - the slit_height








getPhase
IDataset getPhase()
chopper phase angle
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setPhase
DataNode setPhase(IDataset phase)
chopper phase angle
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
phase - the phase








getPhaseScalar
java.lang.Double getPhaseScalar()
chopper phase angle
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setPhaseScalar
DataNode setPhaseScalar(java.lang.Double phase)
chopper phase angle
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
phase - the phase








getRatio
IDataset getRatio()
pulse reduction factor of this chopper in relation to other
 choppers/fastest pulse in the instrument
 

 Type: NX_INT
 

Returns:
the value.








setRatio
DataNode setRatio(IDataset ratio)
pulse reduction factor of this chopper in relation to other
 choppers/fastest pulse in the instrument
 

 Type: NX_INT
 

Parameters:
ratio - the ratio








getRatioScalar
java.lang.Long getRatioScalar()
pulse reduction factor of this chopper in relation to other
 choppers/fastest pulse in the instrument
 

 Type: NX_INT
 

Returns:
the value.








setRatioScalar
DataNode setRatioScalar(java.lang.Long ratio)
pulse reduction factor of this chopper in relation to other
 choppers/fastest pulse in the instrument
 

 Type: NX_INT
 

Parameters:
ratio - the ratio








getDistance
IDataset getDistance()
Effective distance to the origin
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistance
DataNode setDistance(IDataset distance)
Effective distance to the origin
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getDistanceScalar
java.lang.Double getDistanceScalar()
Effective distance to the origin
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistanceScalar
DataNode setDistanceScalar(java.lang.Double distance)
Effective distance to the origin
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getWavelength_range
IDataset getWavelength_range()
low and high values of wavelength range transmitted
 

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

Returns:
the value.








setWavelength_range
DataNode setWavelength_range(IDataset wavelength_range)
low and high values of wavelength range transmitted
 

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

Parameters:
wavelength_range - the wavelength_range








getWavelength_rangeScalar
java.lang.Double getWavelength_rangeScalar()
low and high values of wavelength range transmitted
 

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

Returns:
the value.








setWavelength_rangeScalar
DataNode setWavelength_rangeScalar(java.lang.Double wavelength_range)
low and high values of wavelength range transmitted
 

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

Parameters:
wavelength_range - the wavelength_range








getGeometry
NXgeometry getGeometry()

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)

Parameters:
geometry - the geometry








getGeometry
NXgeometry getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 

 

 

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








setGeometry
void setGeometry(java.lang.String name,
                 NXgeometry geometry)
Set a NXgeometry node by name:
 

 

 

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








getAllGeometry
java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Get all NXgeometry nodes:
 

 

 

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








setAllGeometry
void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.
 

 

 

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