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






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


All Known Implementing Classes:
NXxraylensImpl




public interface NXxraylens
extends NXobject
An X-ray lens, typically at a synchrotron X-ray beam line.
 Based on information provided by Gerd Wellenreuther (DESY).











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_APERTURE 


static java.lang.String
NX_CURVATURE 


static java.lang.String
NX_CYLINDRICAL 


static java.lang.String
NX_FOCUS_TYPE 


static java.lang.String
NX_GAS 


static java.lang.String
NX_GAS_PRESSURE 


static java.lang.String
NX_LENS_GEOMETRY 


static java.lang.String
NX_LENS_LENGTH 


static java.lang.String
NX_LENS_MATERIAL 


static java.lang.String
NX_LENS_THICKNESS 


static java.lang.String
NX_NUMBER_OF_LENSES 


static java.lang.String
NX_SYMMETRIC 






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
getAperture()
Diameter of the lens.



java.lang.Double
getApertureScalar()
Diameter of the lens.



IDataset
getCurvature()
Radius of the curvature as measured in the middle of the lens



java.lang.Double
getCurvatureScalar()
Radius of the curvature as measured in the middle of the lens



NXnote
getCylinder_orientation()
Orientation of the cylinder axis.



IDataset
getCylindrical()
Is the device cylindrical?



java.lang.Boolean
getCylindricalScalar()
Is the device cylindrical?



IDataset
getFocus_type()
The type of focus of the lens



java.lang.String
getFocus_typeScalar()
The type of focus of the lens



IDataset
getGas_pressure()
Gas pressure in the lens



java.lang.Double
getGas_pressureScalar()
Gas pressure in the lens



IDataset
getGas()
Gas used to fill the lens



java.lang.String
getGasScalar()
Gas used to fill the lens



IDataset
getLens_geometry()
Geometry of the lens



java.lang.String
getLens_geometryScalar()
Geometry of the lens



IDataset
getLens_length()
Length of the lens



java.lang.Double
getLens_lengthScalar()
Length of the lens



IDataset
getLens_material()
Material used to make the lens.



java.lang.String
getLens_materialScalar()
Material used to make the lens.



IDataset
getLens_thickness()
Thickness of the lens



java.lang.Double
getLens_thicknessScalar()
Thickness of the lens



IDataset
getNumber_of_lenses()
Number of lenses that make up the compound lens.



java.lang.Long
getNumber_of_lensesScalar()
Number of lenses that make up the compound lens.



IDataset
getSymmetric()
Is the device symmetric?



java.lang.Boolean
getSymmetricScalar()
Is the device symmetric?



DataNode
setAperture(IDataset aperture)
Diameter of the lens.



DataNode
setApertureScalar(java.lang.Double aperture)
Diameter of the lens.



DataNode
setCurvature(IDataset curvature)
Radius of the curvature as measured in the middle of the lens



DataNode
setCurvatureScalar(java.lang.Double curvature)
Radius of the curvature as measured in the middle of the lens



void
setCylinder_orientation(NXnote cylinder_orientation)
Orientation of the cylinder axis.



DataNode
setCylindrical(IDataset cylindrical)
Is the device cylindrical?



DataNode
setCylindricalScalar(java.lang.Boolean cylindrical)
Is the device cylindrical?



DataNode
setFocus_type(IDataset focus_type)
The type of focus of the lens



DataNode
setFocus_typeScalar(java.lang.String focus_type)
The type of focus of the lens



DataNode
setGas_pressure(IDataset gas_pressure)
Gas pressure in the lens



DataNode
setGas_pressureScalar(java.lang.Double gas_pressure)
Gas pressure in the lens



DataNode
setGas(IDataset gas)
Gas used to fill the lens



DataNode
setGasScalar(java.lang.String gas)
Gas used to fill the lens



DataNode
setLens_geometry(IDataset lens_geometry)
Geometry of the lens



DataNode
setLens_geometryScalar(java.lang.String lens_geometry)
Geometry of the lens



DataNode
setLens_length(IDataset lens_length)
Length of the lens



DataNode
setLens_lengthScalar(java.lang.Double lens_length)
Length of the lens



DataNode
setLens_material(IDataset lens_material)
Material used to make the lens.



DataNode
setLens_materialScalar(java.lang.String lens_material)
Material used to make the lens.



DataNode
setLens_thickness(IDataset lens_thickness)
Thickness of the lens



DataNode
setLens_thicknessScalar(java.lang.Double lens_thickness)
Thickness of the lens



DataNode
setNumber_of_lenses(IDataset number_of_lenses)
Number of lenses that make up the compound lens.



DataNode
setNumber_of_lensesScalar(java.lang.Long number_of_lenses)
Number of lenses that make up the compound lens.



DataNode
setSymmetric(IDataset symmetric)
Is the device symmetric?



DataNode
setSymmetricScalar(java.lang.Boolean symmetric)
Is the device symmetric?







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_LENS_GEOMETRY
static final java.lang.String NX_LENS_GEOMETRY

See Also:
Constant Field Values








NX_SYMMETRIC
static final java.lang.String NX_SYMMETRIC

See Also:
Constant Field Values








NX_CYLINDRICAL
static final java.lang.String NX_CYLINDRICAL

See Also:
Constant Field Values








NX_FOCUS_TYPE
static final java.lang.String NX_FOCUS_TYPE

See Also:
Constant Field Values








NX_LENS_THICKNESS
static final java.lang.String NX_LENS_THICKNESS

See Also:
Constant Field Values








NX_LENS_LENGTH
static final java.lang.String NX_LENS_LENGTH

See Also:
Constant Field Values








NX_CURVATURE
static final java.lang.String NX_CURVATURE

See Also:
Constant Field Values








NX_APERTURE
static final java.lang.String NX_APERTURE

See Also:
Constant Field Values








NX_NUMBER_OF_LENSES
static final java.lang.String NX_NUMBER_OF_LENSES

See Also:
Constant Field Values








NX_LENS_MATERIAL
static final java.lang.String NX_LENS_MATERIAL

See Also:
Constant Field Values








NX_GAS
static final java.lang.String NX_GAS

See Also:
Constant Field Values








NX_GAS_PRESSURE
static final java.lang.String NX_GAS_PRESSURE

See Also:
Constant Field Values










Method Detail





getLens_geometry
IDataset getLens_geometry()
Geometry of the lens
 

 Type: NX_CHAR
 
Enumeration:

 
paraboloid 
 
spherical 
 
elliptical 
 
hyperbolical 

 


Returns:
the value.








setLens_geometry
DataNode setLens_geometry(IDataset lens_geometry)
Geometry of the lens
 

 Type: NX_CHAR
 
Enumeration:

 
paraboloid 
 
spherical 
 
elliptical 
 
hyperbolical 

 


Parameters:
lens_geometry - the lens_geometry








getLens_geometryScalar
java.lang.String getLens_geometryScalar()
Geometry of the lens
 

 Type: NX_CHAR
 
Enumeration:

 
paraboloid 
 
spherical 
 
elliptical 
 
hyperbolical 

 


Returns:
the value.








setLens_geometryScalar
DataNode setLens_geometryScalar(java.lang.String lens_geometry)
Geometry of the lens
 

 Type: NX_CHAR
 
Enumeration:

 
paraboloid 
 
spherical 
 
elliptical 
 
hyperbolical 

 


Parameters:
lens_geometry - the lens_geometry








getSymmetric
IDataset getSymmetric()
Is the device symmetric?
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setSymmetric
DataNode setSymmetric(IDataset symmetric)
Is the device symmetric?
 

 Type: NX_BOOLEAN
 

Parameters:
symmetric - the symmetric








getSymmetricScalar
java.lang.Boolean getSymmetricScalar()
Is the device symmetric?
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setSymmetricScalar
DataNode setSymmetricScalar(java.lang.Boolean symmetric)
Is the device symmetric?
 

 Type: NX_BOOLEAN
 

Parameters:
symmetric - the symmetric








getCylindrical
IDataset getCylindrical()
Is the device cylindrical?
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setCylindrical
DataNode setCylindrical(IDataset cylindrical)
Is the device cylindrical?
 

 Type: NX_BOOLEAN
 

Parameters:
cylindrical - the cylindrical








getCylindricalScalar
java.lang.Boolean getCylindricalScalar()
Is the device cylindrical?
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setCylindricalScalar
DataNode setCylindricalScalar(java.lang.Boolean cylindrical)
Is the device cylindrical?
 

 Type: NX_BOOLEAN
 

Parameters:
cylindrical - the cylindrical








getCylinder_orientation
NXnote getCylinder_orientation()
Orientation of the cylinder axis.

Returns:
the value.








setCylinder_orientation
void setCylinder_orientation(NXnote cylinder_orientation)
Orientation of the cylinder axis.

Parameters:
cylinder_orientation - the cylinder_orientation








getFocus_type
IDataset getFocus_type()
The type of focus of the lens
 

 Type: NX_CHAR
 
Enumeration:

 
line 
 
point 

 


Returns:
the value.








setFocus_type
DataNode setFocus_type(IDataset focus_type)
The type of focus of the lens
 

 Type: NX_CHAR
 
Enumeration:

 
line 
 
point 

 


Parameters:
focus_type - the focus_type








getFocus_typeScalar
java.lang.String getFocus_typeScalar()
The type of focus of the lens
 

 Type: NX_CHAR
 
Enumeration:

 
line 
 
point 

 


Returns:
the value.








setFocus_typeScalar
DataNode setFocus_typeScalar(java.lang.String focus_type)
The type of focus of the lens
 

 Type: NX_CHAR
 
Enumeration:

 
line 
 
point 

 


Parameters:
focus_type - the focus_type








getLens_thickness
IDataset getLens_thickness()
Thickness of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setLens_thickness
DataNode setLens_thickness(IDataset lens_thickness)
Thickness of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
lens_thickness - the lens_thickness








getLens_thicknessScalar
java.lang.Double getLens_thicknessScalar()
Thickness of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setLens_thicknessScalar
DataNode setLens_thicknessScalar(java.lang.Double lens_thickness)
Thickness of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
lens_thickness - the lens_thickness








getLens_length
IDataset getLens_length()
Length of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setLens_length
DataNode setLens_length(IDataset lens_length)
Length of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
lens_length - the lens_length








getLens_lengthScalar
java.lang.Double getLens_lengthScalar()
Length of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setLens_lengthScalar
DataNode setLens_lengthScalar(java.lang.Double lens_length)
Length of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
lens_length - the lens_length








getCurvature
IDataset getCurvature()
Radius of the curvature as measured in the middle of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setCurvature
DataNode setCurvature(IDataset curvature)
Radius of the curvature as measured in the middle of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
curvature - the curvature








getCurvatureScalar
java.lang.Double getCurvatureScalar()
Radius of the curvature as measured in the middle of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setCurvatureScalar
DataNode setCurvatureScalar(java.lang.Double curvature)
Radius of the curvature as measured in the middle of the lens
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
curvature - the curvature








getAperture
IDataset getAperture()
Diameter of the lens.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setAperture
DataNode setAperture(IDataset aperture)
Diameter of the lens.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
aperture - the aperture








getApertureScalar
java.lang.Double getApertureScalar()
Diameter of the lens.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setApertureScalar
DataNode setApertureScalar(java.lang.Double aperture)
Diameter of the lens.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
aperture - the aperture








getNumber_of_lenses
IDataset getNumber_of_lenses()
Number of lenses that make up the compound lens.
 

 Type: NX_INT
 

Returns:
the value.








setNumber_of_lenses
DataNode setNumber_of_lenses(IDataset number_of_lenses)
Number of lenses that make up the compound lens.
 

 Type: NX_INT
 

Parameters:
number_of_lenses - the number_of_lenses








getNumber_of_lensesScalar
java.lang.Long getNumber_of_lensesScalar()
Number of lenses that make up the compound lens.
 

 Type: NX_INT
 

Returns:
the value.








setNumber_of_lensesScalar
DataNode setNumber_of_lensesScalar(java.lang.Long number_of_lenses)
Number of lenses that make up the compound lens.
 

 Type: NX_INT
 

Parameters:
number_of_lenses - the number_of_lenses








getLens_material
IDataset getLens_material()
Material used to make the lens.
 

 Type: NX_CHAR
 

Returns:
the value.








setLens_material
DataNode setLens_material(IDataset lens_material)
Material used to make the lens.
 

 Type: NX_CHAR
 

Parameters:
lens_material - the lens_material








getLens_materialScalar
java.lang.String getLens_materialScalar()
Material used to make the lens.
 

 Type: NX_CHAR
 

Returns:
the value.








setLens_materialScalar
DataNode setLens_materialScalar(java.lang.String lens_material)
Material used to make the lens.
 

 Type: NX_CHAR
 

Parameters:
lens_material - the lens_material








getGas
IDataset getGas()
Gas used to fill the lens
 

 Type: NX_CHAR
 

Returns:
the value.








setGas
DataNode setGas(IDataset gas)
Gas used to fill the lens
 

 Type: NX_CHAR
 

Parameters:
gas - the gas








getGasScalar
java.lang.String getGasScalar()
Gas used to fill the lens
 

 Type: NX_CHAR
 

Returns:
the value.








setGasScalar
DataNode setGasScalar(java.lang.String gas)
Gas used to fill the lens
 

 Type: NX_CHAR
 

Parameters:
gas - the gas








getGas_pressure
IDataset getGas_pressure()
Gas pressure in the lens
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 

Returns:
the value.








setGas_pressure
DataNode setGas_pressure(IDataset gas_pressure)
Gas pressure in the lens
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 

Parameters:
gas_pressure - the gas_pressure








getGas_pressureScalar
java.lang.Double getGas_pressureScalar()
Gas pressure in the lens
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 

Returns:
the value.








setGas_pressureScalar
DataNode setGas_pressureScalar(java.lang.Double gas_pressure)
Gas pressure in the lens
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 

Parameters:
gas_pressure - the gas_pressure














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