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






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


All Known Implementing Classes:
NXsampleImpl




public interface NXsample
extends NXobject
Any information on the sample.
 This could include scanned variables that
 are associated with one of the data dimensions, e.g. the magnetic field, or
 logged data, e.g. monitored temperature vs elapsed time.
 
Symbols: 
 symbolic array lengths to be coordinated between various fields

 
n_comp 
 number of compositions
 
n_Temp 
 number of temperatures
 
n_eField 
 number of values in applied electric field
 
n_mField 
 number of values in applied magnetic field
 
n_pField 
 number of values in applied pressure field
 
n_sField 
 number of values in applied stress field












Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_CHANGER_POSITION 


static java.lang.String
NX_CHEMICAL_FORMULA 


static java.lang.String
NX_COMPONENT 


static java.lang.String
NX_CONCENTRATION 


static java.lang.String
NX_DENSITY 


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_DISTANCE 


static java.lang.String
NX_ELECTRIC_FIELD 


static java.lang.String
NX_ELECTRIC_FIELD_ATTRIBUTE_DIRECTION 


static java.lang.String
NX_EXTERNAL_DAC 


static java.lang.String
NX_MAGNETIC_FIELD 


static java.lang.String
NX_MAGNETIC_FIELD_ATTRIBUTE_DIRECTION 


static java.lang.String
NX_MASS 


static java.lang.String
NX_NAME 


static java.lang.String
NX_ORIENTATION_MATRIX 


static java.lang.String
NX_PATH_LENGTH 


static java.lang.String
NX_PATH_LENGTH_WINDOW 


static java.lang.String
NX_POINT_GROUP 


static java.lang.String
NX_PREPARATION_DATE 


static java.lang.String
NX_PRESSURE 


static java.lang.String
NX_RELATIVE_MOLECULAR_MASS 


static java.lang.String
NX_ROTATION_ANGLE 


static java.lang.String
NX_SAMPLE_COMPONENT 


static java.lang.String
NX_SAMPLE_ORIENTATION 


static java.lang.String
NX_SCATTERING_LENGTH_DENSITY 


static java.lang.String
NX_SHORT_TITLE 


static java.lang.String
NX_SITUATION 


static java.lang.String
NX_SPACE_GROUP 


static java.lang.String
NX_STRESS_FIELD 


static java.lang.String
NX_STRESS_FIELD_ATTRIBUTE_DIRECTION 


static java.lang.String
NX_TEMPERATURE 


static java.lang.String
NX_THICKNESS 


static java.lang.String
NX_TYPE 


static java.lang.String
NX_UB_MATRIX 


static java.lang.String
NX_UNIT_CELL 


static java.lang.String
NX_UNIT_CELL_ABC 


static java.lang.String
NX_UNIT_CELL_ALPHABETAGAMMA 


static java.lang.String
NX_UNIT_CELL_CLASS 


static java.lang.String
NX_UNIT_CELL_VOLUME 


static java.lang.String
NX_VOLUME_FRACTION 


static java.lang.String
NX_X_TRANSLATION 






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,NXbeam>
getAllBeam()
Get all NXbeam nodes:
 
 
 Details of beam incident on sample - used to calculate sample/beam interaction point
 



java.util.Map<java.lang.String,NXpositioner>
getAllPositioner()
Get all NXpositioner nodes:
 
 
 Any positioner (motor, PZT, ...) used to locate the sample
 



java.util.Map<java.lang.String,NXsample_component>
getAllSample_componentGroup()
Get all NXsample_component nodes:
 
 
 One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays
 



NXbeam
getBeam()
Details of beam incident on sample - used to calculate sample/beam interaction point



NXbeam
getBeam(java.lang.String name)
Get a NXbeam node by name:
 
 
 Details of beam incident on sample - used to calculate sample/beam interaction point
 



IDataset
getChanger_position()
Sample changer position



java.lang.Long
getChanger_positionScalar()
Sample changer position



IDataset
getChemical_formula()
The chemical formula specified using CIF conventions.



java.lang.String
getChemical_formulaScalar()
The chemical formula specified using CIF conventions.



IDataset
getComponent()
Details of the component of the sample and/or can



java.lang.String
getComponentScalar()
Details of the component of the sample and/or can



IDataset
getConcentration()
Concentration of each component



java.lang.Double
getConcentrationScalar()
Concentration of each component



IDataset
getDensity()
Density of sample



java.lang.Double
getDensityScalar()
Density of sample



IDataset
getDescription()
Description of the sample



java.lang.String
getDescriptionScalar()
Description of the sample



IDataset
getDistance()
Translation of the sample along the Z-direction of the laboratory coordinate system



java.lang.Double
getDistanceScalar()
Translation of the sample along the Z-direction of the laboratory coordinate system



IDataset
getElectric_field()
Applied electric field



java.lang.String
getElectric_fieldAttributeDirection()


java.lang.Double
getElectric_fieldScalar()
Applied electric field



NXlog
getExternal_ADC()
logged value (or logic state) read from user's setup



IDataset
getExternal_DAC()
value sent to user's sample setup



java.lang.Double
getExternal_DACScalar()
value sent to user's sample setup



NXgeometry
getGeometry()
The position and orientation of the center of mass of the sample



NXenvironment
getMagnetic_field_env()
Additional sample magnetic environment information



NXlog
getMagnetic_field_log()
magnetic_field_log.value is a link to e.g.



IDataset
getMagnetic_field()
Applied magnetic field



java.lang.String
getMagnetic_fieldAttributeDirection()


java.lang.Double
getMagnetic_fieldScalar()
Applied magnetic field



IDataset
getMass()
Mass of sample



java.lang.Double
getMassScalar()
Mass of sample



IDataset
getName()
Descriptive name of sample



java.lang.String
getNameScalar()
Descriptive name of sample



IDataset
getOrientation_matrix()
Orientation matrix of single crystal sample using Busing-Levy convention:
 W.



java.lang.Double
getOrientation_matrixScalar()
Orientation matrix of single crystal sample using Busing-Levy convention:
 W.



IDataset
getPath_length_window()
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit



java.lang.Double
getPath_length_windowScalar()
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit



IDataset
getPath_length()
Path length through sample/can for simple case when
 it does not vary with scattering direction



java.lang.Double
getPath_lengthScalar()
Path length through sample/can for simple case when
 it does not vary with scattering direction



IDataset
getPoint_group()
Crystallographic point group, deprecated if space_group present



java.lang.String
getPoint_groupScalar()
Crystallographic point group, deprecated if space_group present



NXpositioner
getPositioner()
Any positioner (motor, PZT, ...) used to locate the sample



NXpositioner
getPositioner(java.lang.String name)
Get a NXpositioner node by name:
 
 
 Any positioner (motor, PZT, ...) used to locate the sample
 



IDataset
getPreparation_date()
Date of preparation of the sample



java.util.Date
getPreparation_dateScalar()
Date of preparation of the sample



IDataset
getPressure()
Applied pressure



java.lang.Double
getPressureScalar()
Applied pressure



IDataset
getRelative_molecular_mass()
Relative Molecular Mass of sample



java.lang.Double
getRelative_molecular_massScalar()
Relative Molecular Mass of sample



IDataset
getRotation_angle()
Optional rotation angle for the case when the powder diagram has
 been obtained through an omega-2theta scan like from a traditional
 single detector powder diffractometer



java.lang.Double
getRotation_angleScalar()
Optional rotation angle for the case when the powder diagram has
 been obtained through an omega-2theta scan like from a traditional
 single detector powder diffractometer



IDataset
getSample_component()
Type of component



NXsample_component
getSample_componentGroup()
One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays



NXsample_component
getSample_componentGroup(java.lang.String name)
Get a NXsample_component node by name:
 
 
 One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays
 



java.lang.String
getSample_componentScalar()
Type of component



IDataset
getSample_orientation()
This will follow the Busing-Levy convention:
 W.



java.lang.Double
getSample_orientationScalar()
This will follow the Busing-Levy convention:
 W.



IDataset
getScattering_length_density()
Scattering length density of each component



java.lang.Double
getScattering_length_densityScalar()
Scattering length density of each component



IDataset
getShort_title()
20 character fixed length sample description for legends



java.lang.String
getShort_titleScalar()
20 character fixed length sample description for legends



IDataset
getSituation()
The atmosphere will be one of the components, which is where
 its details will be stored; the relevant components will be
 indicated by the entry in the sample_component member.



java.lang.String
getSituationScalar()
The atmosphere will be one of the components, which is where
 its details will be stored; the relevant components will be
 indicated by the entry in the sample_component member.



IDataset
getSpace_group()
Crystallographic space group



java.lang.String
getSpace_groupScalar()
Crystallographic space group



IDataset
getStress_field()
Applied external stress field



java.lang.String
getStress_fieldAttributeDirection()


java.lang.Double
getStress_fieldScalar()
Applied external stress field



NXenvironment
getTemperature_env()
Additional sample temperature environment information



NXlog
getTemperature_log()
temperature_log.value is a link to e.g.



IDataset
getTemperature()
Sample temperature.



java.lang.Double
getTemperatureScalar()
Sample temperature.



IDataset
getThickness()
sample thickness



java.lang.Double
getThicknessScalar()
sample thickness



NXdata
getTransmission()
As a function of Wavelength



IDataset
getType()


java.lang.String
getTypeScalar()


IDataset
getUb_matrix()
UB matrix of single crystal sample using Busing-Levy convention:
 W.



java.lang.Double
getUb_matrixScalar()
UB matrix of single crystal sample using Busing-Levy convention:
 W.



IDataset
getUnit_cell_abc()
Crystallography unit cell parameters a, b, and c



java.lang.Double
getUnit_cell_abcScalar()
Crystallography unit cell parameters a, b, and c



IDataset
getUnit_cell_alphabetagamma()
Crystallography unit cell parameters alpha, beta, and gamma



java.lang.Double
getUnit_cell_alphabetagammaScalar()
Crystallography unit cell parameters alpha, beta, and gamma



IDataset
getUnit_cell_class()
In case it is all we know and we want to record/document it



java.lang.String
getUnit_cell_classScalar()
In case it is all we know and we want to record/document it



IDataset
getUnit_cell_volume()
Volume of the unit cell



java.lang.Double
getUnit_cell_volumeScalar()
Volume of the unit cell



IDataset
getUnit_cell()
Unit cell parameters (lengths and angles)



java.lang.Double
getUnit_cellScalar()
Unit cell parameters (lengths and angles)



IDataset
getVolume_fraction()
Volume fraction of each component



java.lang.Double
getVolume_fractionScalar()
Volume fraction of each component



IDataset
getX_translation()
Translation of the sample along the X-direction of the laboratory coordinate system



java.lang.Double
getX_translationScalar()
Translation of the sample along the X-direction of the laboratory coordinate system



void
setAllBeam(java.util.Map<java.lang.String,NXbeam> beam)
Set multiple child nodes of a particular type.



void
setAllPositioner(java.util.Map<java.lang.String,NXpositioner> positioner)
Set multiple child nodes of a particular type.



void
setAllSample_componentGroup(java.util.Map<java.lang.String,NXsample_component> sample_componentGroup)
Set multiple child nodes of a particular type.



void
setBeam(NXbeam beam)
Details of beam incident on sample - used to calculate sample/beam interaction point



void
setBeam(java.lang.String name,
       NXbeam beam)
Set a NXbeam node by name:
 
 
 Details of beam incident on sample - used to calculate sample/beam interaction point
 



DataNode
setChanger_position(IDataset changer_position)
Sample changer position



DataNode
setChanger_positionScalar(java.lang.Long changer_position)
Sample changer position



DataNode
setChemical_formula(IDataset chemical_formula)
The chemical formula specified using CIF conventions.



DataNode
setChemical_formulaScalar(java.lang.String chemical_formula)
The chemical formula specified using CIF conventions.



DataNode
setComponent(IDataset component)
Details of the component of the sample and/or can



DataNode
setComponentScalar(java.lang.String component)
Details of the component of the sample and/or can



DataNode
setConcentration(IDataset concentration)
Concentration of each component



DataNode
setConcentrationScalar(java.lang.Double concentration)
Concentration of each component



DataNode
setDensity(IDataset density)
Density of sample



DataNode
setDensityScalar(java.lang.Double density)
Density of sample



DataNode
setDescription(IDataset description)
Description of the sample



DataNode
setDescriptionScalar(java.lang.String description)
Description of the sample



DataNode
setDistance(IDataset distance)
Translation of the sample along the Z-direction of the laboratory coordinate system



DataNode
setDistanceScalar(java.lang.Double distance)
Translation of the sample along the Z-direction of the laboratory coordinate system



DataNode
setElectric_field(IDataset electric_field)
Applied electric field



void
setElectric_fieldAttributeDirection(java.lang.String direction)


DataNode
setElectric_fieldScalar(java.lang.Double electric_field)
Applied electric field



void
setExternal_ADC(NXlog external_ADC)
logged value (or logic state) read from user's setup



DataNode
setExternal_DAC(IDataset external_DAC)
value sent to user's sample setup



DataNode
setExternal_DACScalar(java.lang.Double external_DAC)
value sent to user's sample setup



void
setGeometry(NXgeometry geometry)
The position and orientation of the center of mass of the sample



void
setMagnetic_field_env(NXenvironment magnetic_field_env)
Additional sample magnetic environment information



void
setMagnetic_field_log(NXlog magnetic_field_log)
magnetic_field_log.value is a link to e.g.



DataNode
setMagnetic_field(IDataset magnetic_field)
Applied magnetic field



void
setMagnetic_fieldAttributeDirection(java.lang.String direction)


DataNode
setMagnetic_fieldScalar(java.lang.Double magnetic_field)
Applied magnetic field



DataNode
setMass(IDataset mass)
Mass of sample



DataNode
setMassScalar(java.lang.Double mass)
Mass of sample



DataNode
setName(IDataset name)
Descriptive name of sample



DataNode
setNameScalar(java.lang.String name)
Descriptive name of sample



DataNode
setOrientation_matrix(IDataset orientation_matrix)
Orientation matrix of single crystal sample using Busing-Levy convention:
 W.



DataNode
setOrientation_matrixScalar(java.lang.Double orientation_matrix)
Orientation matrix of single crystal sample using Busing-Levy convention:
 W.



DataNode
setPath_length_window(IDataset path_length_window)
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit



DataNode
setPath_length_windowScalar(java.lang.Double path_length_window)
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit



DataNode
setPath_length(IDataset path_length)
Path length through sample/can for simple case when
 it does not vary with scattering direction



DataNode
setPath_lengthScalar(java.lang.Double path_length)
Path length through sample/can for simple case when
 it does not vary with scattering direction



DataNode
setPoint_group(IDataset point_group)
Crystallographic point group, deprecated if space_group present



DataNode
setPoint_groupScalar(java.lang.String point_group)
Crystallographic point group, deprecated if space_group present



void
setPositioner(NXpositioner positioner)
Any positioner (motor, PZT, ...) used to locate the sample



void
setPositioner(java.lang.String name,
             NXpositioner positioner)
Set a NXpositioner node by name:
 
 
 Any positioner (motor, PZT, ...) used to locate the sample
 



DataNode
setPreparation_date(IDataset preparation_date)
Date of preparation of the sample



DataNode
setPreparation_dateScalar(java.util.Date preparation_date)
Date of preparation of the sample



DataNode
setPressure(IDataset pressure)
Applied pressure



DataNode
setPressureScalar(java.lang.Double pressure)
Applied pressure



DataNode
setRelative_molecular_mass(IDataset relative_molecular_mass)
Relative Molecular Mass of sample



DataNode
setRelative_molecular_massScalar(java.lang.Double relative_molecular_mass)
Relative Molecular Mass of sample



DataNode
setRotation_angle(IDataset rotation_angle)
Optional rotation angle for the case when the powder diagram has
 been obtained through an omega-2theta scan like from a traditional
 single detector powder diffractometer



DataNode
setRotation_angleScalar(java.lang.Double rotation_angle)
Optional rotation angle for the case when the powder diagram has
 been obtained through an omega-2theta scan like from a traditional
 single detector powder diffractometer



DataNode
setSample_component(IDataset sample_component)
Type of component



void
setSample_componentGroup(NXsample_component sample_componentGroup)
One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays



void
setSample_componentGroup(java.lang.String name,
                        NXsample_component sample_componentGroup)
Set a NXsample_component node by name:
 
 
 One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays
 



DataNode
setSample_componentScalar(java.lang.String sample_component)
Type of component



DataNode
setSample_orientation(IDataset sample_orientation)
This will follow the Busing-Levy convention:
 W.



DataNode
setSample_orientationScalar(java.lang.Double sample_orientation)
This will follow the Busing-Levy convention:
 W.



DataNode
setScattering_length_density(IDataset scattering_length_density)
Scattering length density of each component



DataNode
setScattering_length_densityScalar(java.lang.Double scattering_length_density)
Scattering length density of each component



DataNode
setShort_title(IDataset short_title)
20 character fixed length sample description for legends



DataNode
setShort_titleScalar(java.lang.String short_title)
20 character fixed length sample description for legends



DataNode
setSituation(IDataset situation)
The atmosphere will be one of the components, which is where
 its details will be stored; the relevant components will be
 indicated by the entry in the sample_component member.



DataNode
setSituationScalar(java.lang.String situation)
The atmosphere will be one of the components, which is where
 its details will be stored; the relevant components will be
 indicated by the entry in the sample_component member.



DataNode
setSpace_group(IDataset space_group)
Crystallographic space group



DataNode
setSpace_groupScalar(java.lang.String space_group)
Crystallographic space group



DataNode
setStress_field(IDataset stress_field)
Applied external stress field



void
setStress_fieldAttributeDirection(java.lang.String direction)


DataNode
setStress_fieldScalar(java.lang.Double stress_field)
Applied external stress field



void
setTemperature_env(NXenvironment temperature_env)
Additional sample temperature environment information



void
setTemperature_log(NXlog temperature_log)
temperature_log.value is a link to e.g.



DataNode
setTemperature(IDataset temperature)
Sample temperature.



DataNode
setTemperatureScalar(java.lang.Double temperature)
Sample temperature.



DataNode
setThickness(IDataset thickness)
sample thickness



DataNode
setThicknessScalar(java.lang.Double thickness)
sample thickness



void
setTransmission(NXdata transmission)
As a function of Wavelength



DataNode
setType(IDataset type)


DataNode
setTypeScalar(java.lang.String type)


DataNode
setUb_matrix(IDataset ub_matrix)
UB matrix of single crystal sample using Busing-Levy convention:
 W.



DataNode
setUb_matrixScalar(java.lang.Double ub_matrix)
UB matrix of single crystal sample using Busing-Levy convention:
 W.



DataNode
setUnit_cell_abc(IDataset unit_cell_abc)
Crystallography unit cell parameters a, b, and c



DataNode
setUnit_cell_abcScalar(java.lang.Double unit_cell_abc)
Crystallography unit cell parameters a, b, and c



DataNode
setUnit_cell_alphabetagamma(IDataset unit_cell_alphabetagamma)
Crystallography unit cell parameters alpha, beta, and gamma



DataNode
setUnit_cell_alphabetagammaScalar(java.lang.Double unit_cell_alphabetagamma)
Crystallography unit cell parameters alpha, beta, and gamma



DataNode
setUnit_cell_class(IDataset unit_cell_class)
In case it is all we know and we want to record/document it



DataNode
setUnit_cell_classScalar(java.lang.String unit_cell_class)
In case it is all we know and we want to record/document it



DataNode
setUnit_cell_volume(IDataset unit_cell_volume)
Volume of the unit cell



DataNode
setUnit_cell_volumeScalar(java.lang.Double unit_cell_volume)
Volume of the unit cell



DataNode
setUnit_cell(IDataset unit_cell)
Unit cell parameters (lengths and angles)



DataNode
setUnit_cellScalar(java.lang.Double unit_cell)
Unit cell parameters (lengths and angles)



DataNode
setVolume_fraction(IDataset volume_fraction)
Volume fraction of each component



DataNode
setVolume_fractionScalar(java.lang.Double volume_fraction)
Volume fraction of each component



DataNode
setX_translation(IDataset x_translation)
Translation of the sample along the X-direction of the laboratory coordinate system



DataNode
setX_translationScalar(java.lang.Double x_translation)
Translation of the sample along the X-direction of the laboratory coordinate system







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

See Also:
Constant Field Values








NX_CHEMICAL_FORMULA
static final java.lang.String NX_CHEMICAL_FORMULA

See Also:
Constant Field Values








NX_TEMPERATURE
static final java.lang.String NX_TEMPERATURE

See Also:
Constant Field Values








NX_ELECTRIC_FIELD
static final java.lang.String NX_ELECTRIC_FIELD

See Also:
Constant Field Values








NX_ELECTRIC_FIELD_ATTRIBUTE_DIRECTION
static final java.lang.String NX_ELECTRIC_FIELD_ATTRIBUTE_DIRECTION

See Also:
Constant Field Values








NX_MAGNETIC_FIELD
static final java.lang.String NX_MAGNETIC_FIELD

See Also:
Constant Field Values








NX_MAGNETIC_FIELD_ATTRIBUTE_DIRECTION
static final java.lang.String NX_MAGNETIC_FIELD_ATTRIBUTE_DIRECTION

See Also:
Constant Field Values








NX_STRESS_FIELD
static final java.lang.String NX_STRESS_FIELD

See Also:
Constant Field Values








NX_STRESS_FIELD_ATTRIBUTE_DIRECTION
static final java.lang.String NX_STRESS_FIELD_ATTRIBUTE_DIRECTION

See Also:
Constant Field Values








NX_PRESSURE
static final java.lang.String NX_PRESSURE

See Also:
Constant Field Values








NX_CHANGER_POSITION
static final java.lang.String NX_CHANGER_POSITION

See Also:
Constant Field Values








NX_UNIT_CELL_ABC
static final java.lang.String NX_UNIT_CELL_ABC

See Also:
Constant Field Values








NX_UNIT_CELL_ALPHABETAGAMMA
static final java.lang.String NX_UNIT_CELL_ALPHABETAGAMMA

See Also:
Constant Field Values








NX_UNIT_CELL
static final java.lang.String NX_UNIT_CELL

See Also:
Constant Field Values








NX_UNIT_CELL_VOLUME
static final java.lang.String NX_UNIT_CELL_VOLUME

See Also:
Constant Field Values








NX_SAMPLE_ORIENTATION
static final java.lang.String NX_SAMPLE_ORIENTATION

See Also:
Constant Field Values








NX_ORIENTATION_MATRIX
static final java.lang.String NX_ORIENTATION_MATRIX

See Also:
Constant Field Values








NX_UB_MATRIX
static final java.lang.String NX_UB_MATRIX

See Also:
Constant Field Values








NX_MASS
static final java.lang.String NX_MASS

See Also:
Constant Field Values








NX_DENSITY
static final java.lang.String NX_DENSITY

See Also:
Constant Field Values








NX_RELATIVE_MOLECULAR_MASS
static final java.lang.String NX_RELATIVE_MOLECULAR_MASS

See Also:
Constant Field Values








NX_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_SITUATION
static final java.lang.String NX_SITUATION

See Also:
Constant Field Values








NX_DESCRIPTION
static final java.lang.String NX_DESCRIPTION

See Also:
Constant Field Values








NX_PREPARATION_DATE
static final java.lang.String NX_PREPARATION_DATE

See Also:
Constant Field Values








NX_COMPONENT
static final java.lang.String NX_COMPONENT

See Also:
Constant Field Values








NX_SAMPLE_COMPONENT
static final java.lang.String NX_SAMPLE_COMPONENT

See Also:
Constant Field Values








NX_CONCENTRATION
static final java.lang.String NX_CONCENTRATION

See Also:
Constant Field Values








NX_VOLUME_FRACTION
static final java.lang.String NX_VOLUME_FRACTION

See Also:
Constant Field Values








NX_SCATTERING_LENGTH_DENSITY
static final java.lang.String NX_SCATTERING_LENGTH_DENSITY

See Also:
Constant Field Values








NX_UNIT_CELL_CLASS
static final java.lang.String NX_UNIT_CELL_CLASS

See Also:
Constant Field Values








NX_SPACE_GROUP
static final java.lang.String NX_SPACE_GROUP

See Also:
Constant Field Values








NX_POINT_GROUP
static final java.lang.String NX_POINT_GROUP

See Also:
Constant Field Values








NX_PATH_LENGTH
static final java.lang.String NX_PATH_LENGTH

See Also:
Constant Field Values








NX_PATH_LENGTH_WINDOW
static final java.lang.String NX_PATH_LENGTH_WINDOW

See Also:
Constant Field Values








NX_THICKNESS
static final java.lang.String NX_THICKNESS

See Also:
Constant Field Values








NX_EXTERNAL_DAC
static final java.lang.String NX_EXTERNAL_DAC

See Also:
Constant Field Values








NX_SHORT_TITLE
static final java.lang.String NX_SHORT_TITLE

See Also:
Constant Field Values








NX_ROTATION_ANGLE
static final java.lang.String NX_ROTATION_ANGLE

See Also:
Constant Field Values








NX_X_TRANSLATION
static final java.lang.String NX_X_TRANSLATION

See Also:
Constant Field Values








NX_DISTANCE
static final java.lang.String NX_DISTANCE

See Also:
Constant Field Values










Method Detail





getName
IDataset getName()
Descriptive name of sample

Returns:
the value.








setName
DataNode setName(IDataset name)
Descriptive name of sample

Parameters:
name - the name








getNameScalar
java.lang.String getNameScalar()
Descriptive name of sample

Returns:
the value.








setNameScalar
DataNode setNameScalar(java.lang.String name)
Descriptive name of sample

Parameters:
name - the name








getChemical_formula
IDataset getChemical_formula()
The chemical formula specified using CIF conventions.
 Abbreviated version of CIF standard:
 * Only recognized element symbols may be used.
 * Each element symbol is followed by a 'count' number. A count of '1' may be omitted.
 * A space or parenthesis must separate each cluster of (element symbol + count).
 * Where a group of elements is enclosed in parentheses, the multiplier for the
 group must follow the closing parentheses. That is, all element and group
 multipliers are assumed to be printed as subscripted numbers.
 * Unless the elements are ordered in a manner that corresponds to their chemical
 structure, the order of the elements within any group or moiety depends on
 whether or not carbon is present.
 * If carbon is present, the order should be:
 - C, then H, then the other elements in alphabetical order of their symbol.
 - If carbon is not present, the elements are listed purely in alphabetic order of their symbol.
 * This is the *Hill* system used by Chemical Abstracts.

Returns:
the value.








setChemical_formula
DataNode setChemical_formula(IDataset chemical_formula)
The chemical formula specified using CIF conventions.
 Abbreviated version of CIF standard:
 * Only recognized element symbols may be used.
 * Each element symbol is followed by a 'count' number. A count of '1' may be omitted.
 * A space or parenthesis must separate each cluster of (element symbol + count).
 * Where a group of elements is enclosed in parentheses, the multiplier for the
 group must follow the closing parentheses. That is, all element and group
 multipliers are assumed to be printed as subscripted numbers.
 * Unless the elements are ordered in a manner that corresponds to their chemical
 structure, the order of the elements within any group or moiety depends on
 whether or not carbon is present.
 * If carbon is present, the order should be:
 - C, then H, then the other elements in alphabetical order of their symbol.
 - If carbon is not present, the elements are listed purely in alphabetic order of their symbol.
 * This is the *Hill* system used by Chemical Abstracts.

Parameters:
chemical_formula - the chemical_formula








getChemical_formulaScalar
java.lang.String getChemical_formulaScalar()
The chemical formula specified using CIF conventions.
 Abbreviated version of CIF standard:
 * Only recognized element symbols may be used.
 * Each element symbol is followed by a 'count' number. A count of '1' may be omitted.
 * A space or parenthesis must separate each cluster of (element symbol + count).
 * Where a group of elements is enclosed in parentheses, the multiplier for the
 group must follow the closing parentheses. That is, all element and group
 multipliers are assumed to be printed as subscripted numbers.
 * Unless the elements are ordered in a manner that corresponds to their chemical
 structure, the order of the elements within any group or moiety depends on
 whether or not carbon is present.
 * If carbon is present, the order should be:
 - C, then H, then the other elements in alphabetical order of their symbol.
 - If carbon is not present, the elements are listed purely in alphabetic order of their symbol.
 * This is the *Hill* system used by Chemical Abstracts.

Returns:
the value.








setChemical_formulaScalar
DataNode setChemical_formulaScalar(java.lang.String chemical_formula)
The chemical formula specified using CIF conventions.
 Abbreviated version of CIF standard:
 * Only recognized element symbols may be used.
 * Each element symbol is followed by a 'count' number. A count of '1' may be omitted.
 * A space or parenthesis must separate each cluster of (element symbol + count).
 * Where a group of elements is enclosed in parentheses, the multiplier for the
 group must follow the closing parentheses. That is, all element and group
 multipliers are assumed to be printed as subscripted numbers.
 * Unless the elements are ordered in a manner that corresponds to their chemical
 structure, the order of the elements within any group or moiety depends on
 whether or not carbon is present.
 * If carbon is present, the order should be:
 - C, then H, then the other elements in alphabetical order of their symbol.
 - If carbon is not present, the elements are listed purely in alphabetic order of their symbol.
 * This is the *Hill* system used by Chemical Abstracts.

Parameters:
chemical_formula - the chemical_formula








getTemperature
IDataset getTemperature()
Sample temperature. This could be a scanned variable
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 Dimensions: 1: n_Temp;
 

Returns:
the value.








setTemperature
DataNode setTemperature(IDataset temperature)
Sample temperature. This could be a scanned variable
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 Dimensions: 1: n_Temp;
 

Parameters:
temperature - the temperature








getTemperatureScalar
java.lang.Double getTemperatureScalar()
Sample temperature. This could be a scanned variable
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 Dimensions: 1: n_Temp;
 

Returns:
the value.








setTemperatureScalar
DataNode setTemperatureScalar(java.lang.Double temperature)
Sample temperature. This could be a scanned variable
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 Dimensions: 1: n_Temp;
 

Parameters:
temperature - the temperature








getElectric_field
IDataset getElectric_field()
Applied electric field
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 Dimensions: 1: n_eField;
 

Returns:
the value.








setElectric_field
DataNode setElectric_field(IDataset electric_field)
Applied electric field
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 Dimensions: 1: n_eField;
 

Parameters:
electric_field - the electric_field








getElectric_fieldScalar
java.lang.Double getElectric_fieldScalar()
Applied electric field
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 Dimensions: 1: n_eField;
 

Returns:
the value.








setElectric_fieldScalar
DataNode setElectric_fieldScalar(java.lang.Double electric_field)
Applied electric field
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 Dimensions: 1: n_eField;
 

Parameters:
electric_field - the electric_field








getElectric_fieldAttributeDirection
java.lang.String getElectric_fieldAttributeDirection()

 
Enumeration:

 
x 
 
y 
 
z 

 


Returns:
the value.








setElectric_fieldAttributeDirection
void setElectric_fieldAttributeDirection(java.lang.String direction)

 
Enumeration:

 
x 
 
y 
 
z 

 


Parameters:
direction - the direction








getMagnetic_field
IDataset getMagnetic_field()
Applied magnetic field
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: n_mField;
 

Returns:
the value.








setMagnetic_field
DataNode setMagnetic_field(IDataset magnetic_field)
Applied magnetic field
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: n_mField;
 

Parameters:
magnetic_field - the magnetic_field








getMagnetic_fieldScalar
java.lang.Double getMagnetic_fieldScalar()
Applied magnetic field
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: n_mField;
 

Returns:
the value.








setMagnetic_fieldScalar
DataNode setMagnetic_fieldScalar(java.lang.Double magnetic_field)
Applied magnetic field
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: n_mField;
 

Parameters:
magnetic_field - the magnetic_field








getMagnetic_fieldAttributeDirection
java.lang.String getMagnetic_fieldAttributeDirection()

 
Enumeration:

 
x 
 
y 
 
z 

 


Returns:
the value.








setMagnetic_fieldAttributeDirection
void setMagnetic_fieldAttributeDirection(java.lang.String direction)

 
Enumeration:

 
x 
 
y 
 
z 

 


Parameters:
direction - the direction








getStress_field
IDataset getStress_field()
Applied external stress field
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: n_sField;
 

Returns:
the value.








setStress_field
DataNode setStress_field(IDataset stress_field)
Applied external stress field
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: n_sField;
 

Parameters:
stress_field - the stress_field








getStress_fieldScalar
java.lang.Double getStress_fieldScalar()
Applied external stress field
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: n_sField;
 

Returns:
the value.








setStress_fieldScalar
DataNode setStress_fieldScalar(java.lang.Double stress_field)
Applied external stress field
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: n_sField;
 

Parameters:
stress_field - the stress_field








getStress_fieldAttributeDirection
java.lang.String getStress_fieldAttributeDirection()

 
Enumeration:

 
x 
 
y 
 
z 

 


Returns:
the value.








setStress_fieldAttributeDirection
void setStress_fieldAttributeDirection(java.lang.String direction)

 
Enumeration:

 
x 
 
y 
 
z 

 


Parameters:
direction - the direction








getPressure
IDataset getPressure()
Applied pressure
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 Dimensions: 1: n_pField;
 

Returns:
the value.








setPressure
DataNode setPressure(IDataset pressure)
Applied pressure
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 Dimensions: 1: n_pField;
 

Parameters:
pressure - the pressure








getPressureScalar
java.lang.Double getPressureScalar()
Applied pressure
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 Dimensions: 1: n_pField;
 

Returns:
the value.








setPressureScalar
DataNode setPressureScalar(java.lang.Double pressure)
Applied pressure
 

 Type: NX_FLOAT
 Units: NX_PRESSURE
 Dimensions: 1: n_pField;
 

Parameters:
pressure - the pressure








getChanger_position
IDataset getChanger_position()
Sample changer position
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Returns:
the value.








setChanger_position
DataNode setChanger_position(IDataset changer_position)
Sample changer position
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Parameters:
changer_position - the changer_position








getChanger_positionScalar
java.lang.Long getChanger_positionScalar()
Sample changer position
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Returns:
the value.








setChanger_positionScalar
DataNode setChanger_positionScalar(java.lang.Long changer_position)
Sample changer position
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Parameters:
changer_position - the changer_position








getUnit_cell_abc
IDataset getUnit_cell_abc()
Crystallography unit cell parameters a, b, and c
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: 3;
 

Returns:
the value.








setUnit_cell_abc
DataNode setUnit_cell_abc(IDataset unit_cell_abc)
Crystallography unit cell parameters a, b, and c
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: 3;
 

Parameters:
unit_cell_abc - the unit_cell_abc








getUnit_cell_abcScalar
java.lang.Double getUnit_cell_abcScalar()
Crystallography unit cell parameters a, b, and c
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: 3;
 

Returns:
the value.








setUnit_cell_abcScalar
DataNode setUnit_cell_abcScalar(java.lang.Double unit_cell_abc)
Crystallography unit cell parameters a, b, and c
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: 3;
 

Parameters:
unit_cell_abc - the unit_cell_abc








getUnit_cell_alphabetagamma
IDataset getUnit_cell_alphabetagamma()
Crystallography unit cell parameters alpha, beta, and gamma
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 3;
 

Returns:
the value.








setUnit_cell_alphabetagamma
DataNode setUnit_cell_alphabetagamma(IDataset unit_cell_alphabetagamma)
Crystallography unit cell parameters alpha, beta, and gamma
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 3;
 

Parameters:
unit_cell_alphabetagamma - the unit_cell_alphabetagamma








getUnit_cell_alphabetagammaScalar
java.lang.Double getUnit_cell_alphabetagammaScalar()
Crystallography unit cell parameters alpha, beta, and gamma
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 3;
 

Returns:
the value.








setUnit_cell_alphabetagammaScalar
DataNode setUnit_cell_alphabetagammaScalar(java.lang.Double unit_cell_alphabetagamma)
Crystallography unit cell parameters alpha, beta, and gamma
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 3;
 

Parameters:
unit_cell_alphabetagamma - the unit_cell_alphabetagamma








getUnit_cell
IDataset getUnit_cell()
Unit cell parameters (lengths and angles)
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: n_comp; 2: 6;
 

Returns:
the value.








setUnit_cell
DataNode setUnit_cell(IDataset unit_cell)
Unit cell parameters (lengths and angles)
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: n_comp; 2: 6;
 

Parameters:
unit_cell - the unit_cell








getUnit_cellScalar
java.lang.Double getUnit_cellScalar()
Unit cell parameters (lengths and angles)
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: n_comp; 2: 6;
 

Returns:
the value.








setUnit_cellScalar
DataNode setUnit_cellScalar(java.lang.Double unit_cell)
Unit cell parameters (lengths and angles)
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: n_comp; 2: 6;
 

Parameters:
unit_cell - the unit_cell








getUnit_cell_volume
IDataset getUnit_cell_volume()
Volume of the unit cell
 

 Type: NX_FLOAT
 Units: NX_VOLUME
 Dimensions: 1: n_comp;
 

Returns:
the value.








setUnit_cell_volume
DataNode setUnit_cell_volume(IDataset unit_cell_volume)
Volume of the unit cell
 

 Type: NX_FLOAT
 Units: NX_VOLUME
 Dimensions: 1: n_comp;
 

Parameters:
unit_cell_volume - the unit_cell_volume








getUnit_cell_volumeScalar
java.lang.Double getUnit_cell_volumeScalar()
Volume of the unit cell
 

 Type: NX_FLOAT
 Units: NX_VOLUME
 Dimensions: 1: n_comp;
 

Returns:
the value.








setUnit_cell_volumeScalar
DataNode setUnit_cell_volumeScalar(java.lang.Double unit_cell_volume)
Volume of the unit cell
 

 Type: NX_FLOAT
 Units: NX_VOLUME
 Dimensions: 1: n_comp;
 

Parameters:
unit_cell_volume - the unit_cell_volume








getSample_orientation
IDataset getSample_orientation()
This will follow the Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 3;
 

Returns:
the value.








setSample_orientation
DataNode setSample_orientation(IDataset sample_orientation)
This will follow the Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 3;
 

Parameters:
sample_orientation - the sample_orientation








getSample_orientationScalar
java.lang.Double getSample_orientationScalar()
This will follow the Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 3;
 

Returns:
the value.








setSample_orientationScalar
DataNode setSample_orientationScalar(java.lang.Double sample_orientation)
This will follow the Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 3;
 

Parameters:
sample_orientation - the sample_orientation








getOrientation_matrix
IDataset getOrientation_matrix()
Orientation matrix of single crystal sample using Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp; 2: 3; 3: 3;
 

Returns:
the value.








setOrientation_matrix
DataNode setOrientation_matrix(IDataset orientation_matrix)
Orientation matrix of single crystal sample using Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp; 2: 3; 3: 3;
 

Parameters:
orientation_matrix - the orientation_matrix








getOrientation_matrixScalar
java.lang.Double getOrientation_matrixScalar()
Orientation matrix of single crystal sample using Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp; 2: 3; 3: 3;
 

Returns:
the value.








setOrientation_matrixScalar
DataNode setOrientation_matrixScalar(java.lang.Double orientation_matrix)
Orientation matrix of single crystal sample using Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp; 2: 3; 3: 3;
 

Parameters:
orientation_matrix - the orientation_matrix








getUb_matrix
IDataset getUb_matrix()
UB matrix of single crystal sample using Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464. This is
 the multiplication of the orientation_matrix, given above,
 with the :math:`B` matrix which
 can be derived from the lattice constants.
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp; 2: 3; 3: 3;
 

Returns:
the value.








setUb_matrix
DataNode setUb_matrix(IDataset ub_matrix)
UB matrix of single crystal sample using Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464. This is
 the multiplication of the orientation_matrix, given above,
 with the :math:`B` matrix which
 can be derived from the lattice constants.
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp; 2: 3; 3: 3;
 

Parameters:
ub_matrix - the ub_matrix








getUb_matrixScalar
java.lang.Double getUb_matrixScalar()
UB matrix of single crystal sample using Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464. This is
 the multiplication of the orientation_matrix, given above,
 with the :math:`B` matrix which
 can be derived from the lattice constants.
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp; 2: 3; 3: 3;
 

Returns:
the value.








setUb_matrixScalar
DataNode setUb_matrixScalar(java.lang.Double ub_matrix)
UB matrix of single crystal sample using Busing-Levy convention:
 W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464. This is
 the multiplication of the orientation_matrix, given above,
 with the :math:`B` matrix which
 can be derived from the lattice constants.
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp; 2: 3; 3: 3;
 

Parameters:
ub_matrix - the ub_matrix








getMass
IDataset getMass()
Mass of sample
 

 Type: NX_FLOAT
 Units: NX_MASS
 Dimensions: 1: n_comp;
 

Returns:
the value.








setMass
DataNode setMass(IDataset mass)
Mass of sample
 

 Type: NX_FLOAT
 Units: NX_MASS
 Dimensions: 1: n_comp;
 

Parameters:
mass - the mass








getMassScalar
java.lang.Double getMassScalar()
Mass of sample
 

 Type: NX_FLOAT
 Units: NX_MASS
 Dimensions: 1: n_comp;
 

Returns:
the value.








setMassScalar
DataNode setMassScalar(java.lang.Double mass)
Mass of sample
 

 Type: NX_FLOAT
 Units: NX_MASS
 Dimensions: 1: n_comp;
 

Parameters:
mass - the mass








getDensity
IDataset getDensity()
Density of sample
 

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 Dimensions: 1: n_comp;
 

Returns:
the value.








setDensity
DataNode setDensity(IDataset density)
Density of sample
 

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 Dimensions: 1: n_comp;
 

Parameters:
density - the density








getDensityScalar
java.lang.Double getDensityScalar()
Density of sample
 

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 Dimensions: 1: n_comp;
 

Returns:
the value.








setDensityScalar
DataNode setDensityScalar(java.lang.Double density)
Density of sample
 

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 Dimensions: 1: n_comp;
 

Parameters:
density - the density








getRelative_molecular_mass
IDataset getRelative_molecular_mass()
Relative Molecular Mass of sample
 

 Type: NX_FLOAT
 Units: NX_MASS
 Dimensions: 1: n_comp;
 

Returns:
the value.








setRelative_molecular_mass
DataNode setRelative_molecular_mass(IDataset relative_molecular_mass)
Relative Molecular Mass of sample
 

 Type: NX_FLOAT
 Units: NX_MASS
 Dimensions: 1: n_comp;
 

Parameters:
relative_molecular_mass - the relative_molecular_mass








getRelative_molecular_massScalar
java.lang.Double getRelative_molecular_massScalar()
Relative Molecular Mass of sample
 

 Type: NX_FLOAT
 Units: NX_MASS
 Dimensions: 1: n_comp;
 

Returns:
the value.








setRelative_molecular_massScalar
DataNode setRelative_molecular_massScalar(java.lang.Double relative_molecular_mass)
Relative Molecular Mass of sample
 

 Type: NX_FLOAT
 Units: NX_MASS
 Dimensions: 1: n_comp;
 

Parameters:
relative_molecular_mass - the relative_molecular_mass








getType
IDataset getType()

 
Enumeration:

 
sample 
 
sample+can 
 
can 
 
sample+buffer 
 
buffer 
 
calibration sample 
 
normalisation sample 
 
simulated data 
 
none 
 
sample environment 

 


Returns:
the value.








setType
DataNode setType(IDataset type)

 
Enumeration:

 
sample 
 
sample+can 
 
can 
 
sample+buffer 
 
buffer 
 
calibration sample 
 
normalisation sample 
 
simulated data 
 
none 
 
sample environment 

 


Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()

 
Enumeration:

 
sample 
 
sample+can 
 
can 
 
sample+buffer 
 
buffer 
 
calibration sample 
 
normalisation sample 
 
simulated data 
 
none 
 
sample environment 

 


Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)

 
Enumeration:

 
sample 
 
sample+can 
 
can 
 
sample+buffer 
 
buffer 
 
calibration sample 
 
normalisation sample 
 
simulated data 
 
none 
 
sample environment 

 


Parameters:
type - the type








getSituation
IDataset getSituation()
The atmosphere will be one of the components, which is where
 its details will be stored; the relevant components will be
 indicated by the entry in the sample_component member.
 

 
Enumeration:

 
air 
 
vacuum 
 
inert atmosphere 
 
oxidising atmosphere 
 
reducing atmosphere 
 
sealed can 
 
other 

 


Returns:
the value.








setSituation
DataNode setSituation(IDataset situation)
The atmosphere will be one of the components, which is where
 its details will be stored; the relevant components will be
 indicated by the entry in the sample_component member.
 

 
Enumeration:

 
air 
 
vacuum 
 
inert atmosphere 
 
oxidising atmosphere 
 
reducing atmosphere 
 
sealed can 
 
other 

 


Parameters:
situation - the situation








getSituationScalar
java.lang.String getSituationScalar()
The atmosphere will be one of the components, which is where
 its details will be stored; the relevant components will be
 indicated by the entry in the sample_component member.
 

 
Enumeration:

 
air 
 
vacuum 
 
inert atmosphere 
 
oxidising atmosphere 
 
reducing atmosphere 
 
sealed can 
 
other 

 


Returns:
the value.








setSituationScalar
DataNode setSituationScalar(java.lang.String situation)
The atmosphere will be one of the components, which is where
 its details will be stored; the relevant components will be
 indicated by the entry in the sample_component member.
 

 
Enumeration:

 
air 
 
vacuum 
 
inert atmosphere 
 
oxidising atmosphere 
 
reducing atmosphere 
 
sealed can 
 
other 

 


Parameters:
situation - the situation








getDescription
IDataset getDescription()
Description of the sample

Returns:
the value.








setDescription
DataNode setDescription(IDataset description)
Description of the sample

Parameters:
description - the description








getDescriptionScalar
java.lang.String getDescriptionScalar()
Description of the sample

Returns:
the value.








setDescriptionScalar
DataNode setDescriptionScalar(java.lang.String description)
Description of the sample

Parameters:
description - the description








getPreparation_date
IDataset getPreparation_date()
Date of preparation of the sample
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setPreparation_date
DataNode setPreparation_date(IDataset preparation_date)
Date of preparation of the sample
 

 Type: NX_DATE_TIME
 

Parameters:
preparation_date - the preparation_date








getPreparation_dateScalar
java.util.Date getPreparation_dateScalar()
Date of preparation of the sample
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setPreparation_dateScalar
DataNode setPreparation_dateScalar(java.util.Date preparation_date)
Date of preparation of the sample
 

 Type: NX_DATE_TIME
 

Parameters:
preparation_date - the preparation_date








getGeometry
NXgeometry getGeometry()
The position and orientation of the center of mass of the sample

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)
The position and orientation of the center of mass of the sample

Parameters:
geometry - the geometry








getBeam
NXbeam getBeam()
Details of beam incident on sample - used to calculate sample/beam interaction point

Returns:
the value.








setBeam
void setBeam(NXbeam beam)
Details of beam incident on sample - used to calculate sample/beam interaction point

Parameters:
beam - the beam








getBeam
NXbeam getBeam(java.lang.String name)
Get a NXbeam node by name:
 

 

 Details of beam incident on sample - used to calculate sample/beam interaction point
 

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








setBeam
void setBeam(java.lang.String name,
             NXbeam beam)
Set a NXbeam node by name:
 

 

 Details of beam incident on sample - used to calculate sample/beam interaction point
 

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








getAllBeam
java.util.Map<java.lang.String,NXbeam> getAllBeam()
Get all NXbeam nodes:
 

 

 Details of beam incident on sample - used to calculate sample/beam interaction point
 

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








setAllBeam
void setAllBeam(java.util.Map<java.lang.String,NXbeam> beam)
Set multiple child nodes of a particular type.
 

 

 Details of beam incident on sample - used to calculate sample/beam interaction point
 

Parameters:
beam - the child nodes to add








getSample_componentGroup
NXsample_component getSample_componentGroup()
One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays

Returns:
the value.








setSample_componentGroup
void setSample_componentGroup(NXsample_component sample_componentGroup)
One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays

Parameters:
sample_componentGroup - the sample_componentGroup








getSample_componentGroup
NXsample_component getSample_componentGroup(java.lang.String name)
Get a NXsample_component node by name:
 

 

 One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays
 

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








setSample_componentGroup
void setSample_componentGroup(java.lang.String name,
                              NXsample_component sample_componentGroup)
Set a NXsample_component node by name:
 

 

 One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays
 

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








getAllSample_componentGroup
java.util.Map<java.lang.String,NXsample_component> getAllSample_componentGroup()
Get all NXsample_component nodes:
 

 

 One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays
 

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








setAllSample_componentGroup
void setAllSample_componentGroup(java.util.Map<java.lang.String,NXsample_component> sample_componentGroup)
Set multiple child nodes of a particular type.
 

 

 One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays
 

Parameters:
sample_componentGroup - the child nodes to add








getComponent
IDataset getComponent()
Details of the component of the sample and/or can
 

 Dimensions: 1: n_comp;
 

Returns:
the value.








setComponent
DataNode setComponent(IDataset component)
Details of the component of the sample and/or can
 

 Dimensions: 1: n_comp;
 

Parameters:
component - the component








getComponentScalar
java.lang.String getComponentScalar()
Details of the component of the sample and/or can
 

 Dimensions: 1: n_comp;
 

Returns:
the value.








setComponentScalar
DataNode setComponentScalar(java.lang.String component)
Details of the component of the sample and/or can
 

 Dimensions: 1: n_comp;
 

Parameters:
component - the component








getSample_component
IDataset getSample_component()
Type of component
 

 Dimensions: 1: n_comp;
 
Enumeration:

 
sample 
 
can 
 
atmosphere 
 
kit 

 


Returns:
the value.








setSample_component
DataNode setSample_component(IDataset sample_component)
Type of component
 

 Dimensions: 1: n_comp;
 
Enumeration:

 
sample 
 
can 
 
atmosphere 
 
kit 

 


Parameters:
sample_component - the sample_component








getSample_componentScalar
java.lang.String getSample_componentScalar()
Type of component
 

 Dimensions: 1: n_comp;
 
Enumeration:

 
sample 
 
can 
 
atmosphere 
 
kit 

 


Returns:
the value.








setSample_componentScalar
DataNode setSample_componentScalar(java.lang.String sample_component)
Type of component
 

 Dimensions: 1: n_comp;
 
Enumeration:

 
sample 
 
can 
 
atmosphere 
 
kit 

 


Parameters:
sample_component - the sample_component








getConcentration
IDataset getConcentration()
Concentration of each component
 

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 Dimensions: 1: n_comp;
 

Returns:
the value.








setConcentration
DataNode setConcentration(IDataset concentration)
Concentration of each component
 

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 Dimensions: 1: n_comp;
 

Parameters:
concentration - the concentration








getConcentrationScalar
java.lang.Double getConcentrationScalar()
Concentration of each component
 

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 Dimensions: 1: n_comp;
 

Returns:
the value.








setConcentrationScalar
DataNode setConcentrationScalar(java.lang.Double concentration)
Concentration of each component
 

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 Dimensions: 1: n_comp;
 

Parameters:
concentration - the concentration








getVolume_fraction
IDataset getVolume_fraction()
Volume fraction of each component
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp;
 

Returns:
the value.








setVolume_fraction
DataNode setVolume_fraction(IDataset volume_fraction)
Volume fraction of each component
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp;
 

Parameters:
volume_fraction - the volume_fraction








getVolume_fractionScalar
java.lang.Double getVolume_fractionScalar()
Volume fraction of each component
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp;
 

Returns:
the value.








setVolume_fractionScalar
DataNode setVolume_fractionScalar(java.lang.Double volume_fraction)
Volume fraction of each component
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp;
 

Parameters:
volume_fraction - the volume_fraction








getScattering_length_density
IDataset getScattering_length_density()
Scattering length density of each component
 

 Type: NX_FLOAT
 Units: NX_SCATTERING_LENGTH_DENSITY
 Dimensions: 1: n_comp;
 

Returns:
the value.








setScattering_length_density
DataNode setScattering_length_density(IDataset scattering_length_density)
Scattering length density of each component
 

 Type: NX_FLOAT
 Units: NX_SCATTERING_LENGTH_DENSITY
 Dimensions: 1: n_comp;
 

Parameters:
scattering_length_density - the scattering_length_density








getScattering_length_densityScalar
java.lang.Double getScattering_length_densityScalar()
Scattering length density of each component
 

 Type: NX_FLOAT
 Units: NX_SCATTERING_LENGTH_DENSITY
 Dimensions: 1: n_comp;
 

Returns:
the value.








setScattering_length_densityScalar
DataNode setScattering_length_densityScalar(java.lang.Double scattering_length_density)
Scattering length density of each component
 

 Type: NX_FLOAT
 Units: NX_SCATTERING_LENGTH_DENSITY
 Dimensions: 1: n_comp;
 

Parameters:
scattering_length_density - the scattering_length_density








getUnit_cell_class
IDataset getUnit_cell_class()
In case it is all we know and we want to record/document it
 

 
Enumeration:

 
triclinic 
 
monoclinic 
 
orthorhombic 
 
tetragonal 
 
rhombohedral 
 
hexagonal 
 
cubic 

 


Returns:
the value.








setUnit_cell_class
DataNode setUnit_cell_class(IDataset unit_cell_class)
In case it is all we know and we want to record/document it
 

 
Enumeration:

 
triclinic 
 
monoclinic 
 
orthorhombic 
 
tetragonal 
 
rhombohedral 
 
hexagonal 
 
cubic 

 


Parameters:
unit_cell_class - the unit_cell_class








getUnit_cell_classScalar
java.lang.String getUnit_cell_classScalar()
In case it is all we know and we want to record/document it
 

 
Enumeration:

 
triclinic 
 
monoclinic 
 
orthorhombic 
 
tetragonal 
 
rhombohedral 
 
hexagonal 
 
cubic 

 


Returns:
the value.








setUnit_cell_classScalar
DataNode setUnit_cell_classScalar(java.lang.String unit_cell_class)
In case it is all we know and we want to record/document it
 

 
Enumeration:

 
triclinic 
 
monoclinic 
 
orthorhombic 
 
tetragonal 
 
rhombohedral 
 
hexagonal 
 
cubic 

 


Parameters:
unit_cell_class - the unit_cell_class








getSpace_group
IDataset getSpace_group()
Crystallographic space group
 

 Dimensions: 1: n_comp;
 

Returns:
the value.








setSpace_group
DataNode setSpace_group(IDataset space_group)
Crystallographic space group
 

 Dimensions: 1: n_comp;
 

Parameters:
space_group - the space_group








getSpace_groupScalar
java.lang.String getSpace_groupScalar()
Crystallographic space group
 

 Dimensions: 1: n_comp;
 

Returns:
the value.








setSpace_groupScalar
DataNode setSpace_groupScalar(java.lang.String space_group)
Crystallographic space group
 

 Dimensions: 1: n_comp;
 

Parameters:
space_group - the space_group








getPoint_group
IDataset getPoint_group()
Crystallographic point group, deprecated if space_group present
 

 Dimensions: 1: n_comp;
 

Returns:
the value.








setPoint_group
DataNode setPoint_group(IDataset point_group)
Crystallographic point group, deprecated if space_group present
 

 Dimensions: 1: n_comp;
 

Parameters:
point_group - the point_group








getPoint_groupScalar
java.lang.String getPoint_groupScalar()
Crystallographic point group, deprecated if space_group present
 

 Dimensions: 1: n_comp;
 

Returns:
the value.








setPoint_groupScalar
DataNode setPoint_groupScalar(java.lang.String point_group)
Crystallographic point group, deprecated if space_group present
 

 Dimensions: 1: n_comp;
 

Parameters:
point_group - the point_group








getPath_length
IDataset getPath_length()
Path length through sample/can for simple case when
 it does not vary with scattering direction
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setPath_length
DataNode setPath_length(IDataset path_length)
Path length through sample/can for simple case when
 it does not vary with scattering direction
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
path_length - the path_length








getPath_lengthScalar
java.lang.Double getPath_lengthScalar()
Path length through sample/can for simple case when
 it does not vary with scattering direction
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setPath_lengthScalar
DataNode setPath_lengthScalar(java.lang.Double path_length)
Path length through sample/can for simple case when
 it does not vary with scattering direction
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
path_length - the path_length








getPath_length_window
IDataset getPath_length_window()
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setPath_length_window
DataNode setPath_length_window(IDataset path_length_window)
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
path_length_window - the path_length_window








getPath_length_windowScalar
java.lang.Double getPath_length_windowScalar()
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setPath_length_windowScalar
DataNode setPath_length_windowScalar(java.lang.Double path_length_window)
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
path_length_window - the path_length_window








getThickness
IDataset getThickness()
sample thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setThickness
DataNode setThickness(IDataset thickness)
sample thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
thickness - the thickness








getThicknessScalar
java.lang.Double getThicknessScalar()
sample thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setThicknessScalar
DataNode setThicknessScalar(java.lang.Double thickness)
sample thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
thickness - the thickness








getTransmission
NXdata getTransmission()
As a function of Wavelength

Returns:
the value.








setTransmission
void setTransmission(NXdata transmission)
As a function of Wavelength

Parameters:
transmission - the transmission








getTemperature_log
NXlog getTemperature_log()
temperature_log.value is a link to e.g. temperature_env.sensor1.value_log.value

Returns:
the value.








setTemperature_log
void setTemperature_log(NXlog temperature_log)
temperature_log.value is a link to e.g. temperature_env.sensor1.value_log.value

Parameters:
temperature_log - the temperature_log








getTemperature_env
NXenvironment getTemperature_env()
Additional sample temperature environment information

Returns:
the value.








setTemperature_env
void setTemperature_env(NXenvironment temperature_env)
Additional sample temperature environment information

Parameters:
temperature_env - the temperature_env








getMagnetic_field_log
NXlog getMagnetic_field_log()
magnetic_field_log.value is a link to e.g. magnetic_field_env.sensor1.value_log.value

Returns:
the value.








setMagnetic_field_log
void setMagnetic_field_log(NXlog magnetic_field_log)
magnetic_field_log.value is a link to e.g. magnetic_field_env.sensor1.value_log.value

Parameters:
magnetic_field_log - the magnetic_field_log








getMagnetic_field_env
NXenvironment getMagnetic_field_env()
Additional sample magnetic environment information

Returns:
the value.








setMagnetic_field_env
void setMagnetic_field_env(NXenvironment magnetic_field_env)
Additional sample magnetic environment information

Parameters:
magnetic_field_env - the magnetic_field_env








getExternal_DAC
IDataset getExternal_DAC()
value sent to user's sample setup
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setExternal_DAC
DataNode setExternal_DAC(IDataset external_DAC)
value sent to user's sample setup
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
external_DAC - the external_DAC








getExternal_DACScalar
java.lang.Double getExternal_DACScalar()
value sent to user's sample setup
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Returns:
the value.








setExternal_DACScalar
DataNode setExternal_DACScalar(java.lang.Double external_DAC)
value sent to user's sample setup
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Parameters:
external_DAC - the external_DAC








getExternal_ADC
NXlog getExternal_ADC()
logged value (or logic state) read from user's setup

Returns:
the value.








setExternal_ADC
void setExternal_ADC(NXlog external_ADC)
logged value (or logic state) read from user's setup

Parameters:
external_ADC - the external_ADC








getShort_title
IDataset getShort_title()
20 character fixed length sample description for legends

Returns:
the value.








setShort_title
DataNode setShort_title(IDataset short_title)
20 character fixed length sample description for legends

Parameters:
short_title - the short_title








getShort_titleScalar
java.lang.String getShort_titleScalar()
20 character fixed length sample description for legends

Returns:
the value.








setShort_titleScalar
DataNode setShort_titleScalar(java.lang.String short_title)
20 character fixed length sample description for legends

Parameters:
short_title - the short_title








getRotation_angle
IDataset getRotation_angle()
Optional rotation angle for the case when the powder diagram has
 been obtained through an omega-2theta scan like from a traditional
 single detector powder diffractometer
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setRotation_angle
DataNode setRotation_angle(IDataset rotation_angle)
Optional rotation angle for the case when the powder diagram has
 been obtained through an omega-2theta scan like from a traditional
 single detector powder diffractometer
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
rotation_angle - the rotation_angle








getRotation_angleScalar
java.lang.Double getRotation_angleScalar()
Optional rotation angle for the case when the powder diagram has
 been obtained through an omega-2theta scan like from a traditional
 single detector powder diffractometer
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setRotation_angleScalar
DataNode setRotation_angleScalar(java.lang.Double rotation_angle)
Optional rotation angle for the case when the powder diagram has
 been obtained through an omega-2theta scan like from a traditional
 single detector powder diffractometer
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
rotation_angle - the rotation_angle








getX_translation
IDataset getX_translation()
Translation of the sample along the X-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setX_translation
DataNode setX_translation(IDataset x_translation)
Translation of the sample along the X-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
x_translation - the x_translation








getX_translationScalar
java.lang.Double getX_translationScalar()
Translation of the sample along the X-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setX_translationScalar
DataNode setX_translationScalar(java.lang.Double x_translation)
Translation of the sample along the X-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
x_translation - the x_translation








getDistance
IDataset getDistance()
Translation of the sample along the Z-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistance
DataNode setDistance(IDataset distance)
Translation of the sample along the Z-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getDistanceScalar
java.lang.Double getDistanceScalar()
Translation of the sample along the Z-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistanceScalar
DataNode setDistanceScalar(java.lang.Double distance)
Translation of the sample along the Z-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getPositioner
NXpositioner getPositioner()
Any positioner (motor, PZT, ...) used to locate the sample

Returns:
the value.








setPositioner
void setPositioner(NXpositioner positioner)
Any positioner (motor, PZT, ...) used to locate the sample

Parameters:
positioner - the positioner








getPositioner
NXpositioner getPositioner(java.lang.String name)
Get a NXpositioner node by name:
 

 

 Any positioner (motor, PZT, ...) used to locate the sample
 

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








setPositioner
void setPositioner(java.lang.String name,
                   NXpositioner positioner)
Set a NXpositioner node by name:
 

 

 Any positioner (motor, PZT, ...) used to locate the sample
 

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








getAllPositioner
java.util.Map<java.lang.String,NXpositioner> getAllPositioner()
Get all NXpositioner nodes:
 

 

 Any positioner (motor, PZT, ...) used to locate the sample
 

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








setAllPositioner
void setAllPositioner(java.util.Map<java.lang.String,NXpositioner> positioner)
Set multiple child nodes of a particular type.
 

 

 Any positioner (motor, PZT, ...) used to locate the sample
 

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