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






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


All Known Implementing Classes:
NXcapillaryImpl




public interface NXcapillary
extends NXobject
A capillary lens to focus the X-ray beam.
 Based on information provided by Gerd Wellenreuther (DESY).











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_ACCEPTING_APERTURE 


static java.lang.String
NX_FOCAL_SIZE 


static java.lang.String
NX_MANUFACTURER 


static java.lang.String
NX_MAXIMUM_INCIDENT_ANGLE 


static java.lang.String
NX_TYPE 


static java.lang.String
NX_WORKING_DISTANCE 






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
getAccepting_aperture()

 Type: NX_FLOAT
 Units: NX_ANGLE



java.lang.Double
getAccepting_apertureScalar()

 Type: NX_FLOAT
 Units: NX_ANGLE



IDataset
getFocal_size()
The focal size in FWHM



java.lang.Double
getFocal_sizeScalar()
The focal size in FWHM



NXdata
getGain()
The gain of the capillary as a function of energy



IDataset
getManufacturer()
The manufacturer of the capillary.



java.lang.String
getManufacturerScalar()
The manufacturer of the capillary.



IDataset
getMaximum_incident_angle()

 Type: NX_FLOAT
 Units: NX_ANGLE



java.lang.Double
getMaximum_incident_angleScalar()

 Type: NX_FLOAT
 Units: NX_ANGLE



NXdata
getTransmission()
The transmission of the capillary as a function of energy



IDataset
getType()
Type of the capillary



java.lang.String
getTypeScalar()
Type of the capillary



IDataset
getWorking_distance()

 Type: NX_FLOAT
 Units: NX_LENGTH



java.lang.Double
getWorking_distanceScalar()

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setAccepting_aperture(IDataset accepting_aperture)

 Type: NX_FLOAT
 Units: NX_ANGLE



DataNode
setAccepting_apertureScalar(java.lang.Double accepting_aperture)

 Type: NX_FLOAT
 Units: NX_ANGLE



DataNode
setFocal_size(IDataset focal_size)
The focal size in FWHM



DataNode
setFocal_sizeScalar(java.lang.Double focal_size)
The focal size in FWHM



void
setGain(NXdata gain)
The gain of the capillary as a function of energy



DataNode
setManufacturer(IDataset manufacturer)
The manufacturer of the capillary.



DataNode
setManufacturerScalar(java.lang.String manufacturer)
The manufacturer of the capillary.



DataNode
setMaximum_incident_angle(IDataset maximum_incident_angle)

 Type: NX_FLOAT
 Units: NX_ANGLE



DataNode
setMaximum_incident_angleScalar(java.lang.Double maximum_incident_angle)

 Type: NX_FLOAT
 Units: NX_ANGLE



void
setTransmission(NXdata transmission)
The transmission of the capillary as a function of energy



DataNode
setType(IDataset type)
Type of the capillary



DataNode
setTypeScalar(java.lang.String type)
Type of the capillary



DataNode
setWorking_distance(IDataset working_distance)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setWorking_distanceScalar(java.lang.Double working_distance)

 Type: NX_FLOAT
 Units: NX_LENGTH







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_MANUFACTURER
static final java.lang.String NX_MANUFACTURER

See Also:
Constant Field Values








NX_MAXIMUM_INCIDENT_ANGLE
static final java.lang.String NX_MAXIMUM_INCIDENT_ANGLE

See Also:
Constant Field Values








NX_ACCEPTING_APERTURE
static final java.lang.String NX_ACCEPTING_APERTURE

See Also:
Constant Field Values








NX_WORKING_DISTANCE
static final java.lang.String NX_WORKING_DISTANCE

See Also:
Constant Field Values








NX_FOCAL_SIZE
static final java.lang.String NX_FOCAL_SIZE

See Also:
Constant Field Values










Method Detail





getType
IDataset getType()
Type of the capillary
 

 Type: NX_CHAR
 
Enumeration:

 
single_bounce 
 
polycapillary 
 
conical_capillary 

 


Returns:
the value.








setType
DataNode setType(IDataset type)
Type of the capillary
 

 Type: NX_CHAR
 
Enumeration:

 
single_bounce 
 
polycapillary 
 
conical_capillary 

 


Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()
Type of the capillary
 

 Type: NX_CHAR
 
Enumeration:

 
single_bounce 
 
polycapillary 
 
conical_capillary 

 


Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)
Type of the capillary
 

 Type: NX_CHAR
 
Enumeration:

 
single_bounce 
 
polycapillary 
 
conical_capillary 

 


Parameters:
type - the type








getManufacturer
IDataset getManufacturer()
The manufacturer of the capillary. This is actually important as
 it may have an impact on performance.
 

 Type: NX_CHAR
 

Returns:
the value.








setManufacturer
DataNode setManufacturer(IDataset manufacturer)
The manufacturer of the capillary. This is actually important as
 it may have an impact on performance.
 

 Type: NX_CHAR
 

Parameters:
manufacturer - the manufacturer








getManufacturerScalar
java.lang.String getManufacturerScalar()
The manufacturer of the capillary. This is actually important as
 it may have an impact on performance.
 

 Type: NX_CHAR
 

Returns:
the value.








setManufacturerScalar
DataNode setManufacturerScalar(java.lang.String manufacturer)
The manufacturer of the capillary. This is actually important as
 it may have an impact on performance.
 

 Type: NX_CHAR
 

Parameters:
manufacturer - the manufacturer








getMaximum_incident_angle
IDataset getMaximum_incident_angle()

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setMaximum_incident_angle
DataNode setMaximum_incident_angle(IDataset maximum_incident_angle)

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
maximum_incident_angle - the maximum_incident_angle








getMaximum_incident_angleScalar
java.lang.Double getMaximum_incident_angleScalar()

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setMaximum_incident_angleScalar
DataNode setMaximum_incident_angleScalar(java.lang.Double maximum_incident_angle)

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
maximum_incident_angle - the maximum_incident_angle








getAccepting_aperture
IDataset getAccepting_aperture()

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setAccepting_aperture
DataNode setAccepting_aperture(IDataset accepting_aperture)

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
accepting_aperture - the accepting_aperture








getAccepting_apertureScalar
java.lang.Double getAccepting_apertureScalar()

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setAccepting_apertureScalar
DataNode setAccepting_apertureScalar(java.lang.Double accepting_aperture)

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
accepting_aperture - the accepting_aperture








getGain
NXdata getGain()
The gain of the capillary as a function of energy

Returns:
the value.








setGain
void setGain(NXdata gain)
The gain of the capillary as a function of energy

Parameters:
gain - the gain








getTransmission
NXdata getTransmission()
The transmission of the capillary as a function of energy

Returns:
the value.








setTransmission
void setTransmission(NXdata transmission)
The transmission of the capillary as a function of energy

Parameters:
transmission - the transmission








getWorking_distance
IDataset getWorking_distance()

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setWorking_distance
DataNode setWorking_distance(IDataset working_distance)

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
working_distance - the working_distance








getWorking_distanceScalar
java.lang.Double getWorking_distanceScalar()

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setWorking_distanceScalar
DataNode setWorking_distanceScalar(java.lang.Double working_distance)

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
working_distance - the working_distance








getFocal_size
IDataset getFocal_size()
The focal size in FWHM
 

 Type: NX_FLOAT
 

Returns:
the value.








setFocal_size
DataNode setFocal_size(IDataset focal_size)
The focal size in FWHM
 

 Type: NX_FLOAT
 

Parameters:
focal_size - the focal_size








getFocal_sizeScalar
java.lang.Double getFocal_sizeScalar()
The focal size in FWHM
 

 Type: NX_FLOAT
 

Returns:
the value.








setFocal_sizeScalar
DataNode setFocal_sizeScalar(java.lang.Double focal_size)
The focal size in FWHM
 

 Type: NX_FLOAT
 

Parameters:
focal_size - the focal_size














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