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



java.lang.Object


org.eclipse.dawnsci.analysis.tree.impl.NodeImpl


org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl


org.eclipse.dawnsci.nexus.impl.NXobjectImpl


org.eclipse.dawnsci.nexus.impl.NXsampleImpl













All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXobject, NXsample




public class NXsampleImpl
extends NXobjectImpl
implements NXsample
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.

See Also:
Serialized Form












Field Summary

Fields 

Modifier and Type
Field and Description


static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES 






Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS





Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT





Fields inherited from interface org.eclipse.dawnsci.nexus.NXsample
NX_CHANGER_POSITION, NX_CHEMICAL_FORMULA, NX_COMPONENT, NX_CONCENTRATION, NX_DENSITY, NX_DESCRIPTION, NX_DISTANCE, NX_ELECTRIC_FIELD, NX_ELECTRIC_FIELD_ATTRIBUTE_DIRECTION, NX_EXTERNAL_DAC, NX_MAGNETIC_FIELD, NX_MAGNETIC_FIELD_ATTRIBUTE_DIRECTION, NX_MASS, NX_NAME, NX_ORIENTATION_MATRIX, NX_PATH_LENGTH, NX_PATH_LENGTH_WINDOW, NX_POINT_GROUP, NX_PREPARATION_DATE, NX_PRESSURE, NX_RELATIVE_MOLECULAR_MASS, NX_ROTATION_ANGLE, NX_SAMPLE_COMPONENT, NX_SAMPLE_ORIENTATION, NX_SCATTERING_LENGTH_DENSITY, NX_SHORT_TITLE, NX_SITUATION, NX_SPACE_GROUP, NX_STRESS_FIELD, NX_STRESS_FIELD_ATTRIBUTE_DIRECTION, NX_TEMPERATURE, NX_THICKNESS, NX_TYPE, NX_UB_MATRIX, NX_UNIT_CELL, NX_UNIT_CELL_ABC, NX_UNIT_CELL_ALPHABETAGAMMA, NX_UNIT_CELL_CLASS, NX_UNIT_CELL_VOLUME, NX_VOLUME_FRACTION, NX_X_TRANSLATION





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








Constructor Summary

Constructors 

Constructor and Description


NXsampleImpl() 


NXsampleImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete 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



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



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



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



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 class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, createNodeLink, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isGroupNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool, toString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait





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, getNumber, 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





PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES









Constructor Detail





NXsampleImpl
public NXsampleImpl()







NXsampleImpl
public NXsampleImpl(long oid)









Method Detail





getNXclass
public java.lang.Class<? extends NXobject> getNXclass()
Description copied from interface: NXobject
Java Class object of the interface for this base class, e.g. NXsample.class.

Specified by:
getNXclass in interface NXobject
Returns:
name of Nexus class








getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass for this base class, e.g. NexusBaseClass.NX_SAMPLE.

Specified by:
getNexusBaseClass in interface NXobject
Returns:
NexusBaseClass enum constant for this class








getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.

Specified by:
getPermittedChildGroupClasses in interface NXobject
Returns:
NexusBaseClass constants for permitted child groups








getName
public IDataset getName()
Description copied from interface: NXsample
Descriptive name of sample

Specified by:
getName in interface NXsample
Returns:
the value.








getNameScalar
public java.lang.String getNameScalar()
Description copied from interface: NXsample
Descriptive name of sample

Specified by:
getNameScalar in interface NXsample
Returns:
the value.








setName
public DataNode setName(IDataset name)
Description copied from interface: NXsample
Descriptive name of sample

Specified by:
setName in interface NXsample
Parameters:
name - the name








setNameScalar
public DataNode setNameScalar(java.lang.String name)
Description copied from interface: NXsample
Descriptive name of sample

Specified by:
setNameScalar in interface NXsample
Parameters:
name - the name








getChemical_formula
public IDataset getChemical_formula()
Description copied from interface: NXsample
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.

Specified by:
getChemical_formula in interface NXsample
Returns:
the value.








getChemical_formulaScalar
public java.lang.String getChemical_formulaScalar()
Description copied from interface: NXsample
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.

Specified by:
getChemical_formulaScalar in interface NXsample
Returns:
the value.








setChemical_formula
public DataNode setChemical_formula(IDataset chemical_formula)
Description copied from interface: NXsample
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.

Specified by:
setChemical_formula in interface NXsample
Parameters:
chemical_formula - the chemical_formula








setChemical_formulaScalar
public DataNode setChemical_formulaScalar(java.lang.String chemical_formula)
Description copied from interface: NXsample
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.

Specified by:
setChemical_formulaScalar in interface NXsample
Parameters:
chemical_formula - the chemical_formula








getTemperature
public IDataset getTemperature()
Description copied from interface: NXsample
Sample temperature. This could be a scanned variable
 

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

Specified by:
getTemperature in interface NXsample
Returns:
the value.








getTemperatureScalar
public java.lang.Double getTemperatureScalar()
Description copied from interface: NXsample
Sample temperature. This could be a scanned variable
 

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

Specified by:
getTemperatureScalar in interface NXsample
Returns:
the value.








setTemperature
public DataNode setTemperature(IDataset temperature)
Description copied from interface: NXsample
Sample temperature. This could be a scanned variable
 

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

Specified by:
setTemperature in interface NXsample
Parameters:
temperature - the temperature








setTemperatureScalar
public DataNode setTemperatureScalar(java.lang.Double temperature)
Description copied from interface: NXsample
Sample temperature. This could be a scanned variable
 

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

Specified by:
setTemperatureScalar in interface NXsample
Parameters:
temperature - the temperature








getElectric_field
public IDataset getElectric_field()
Description copied from interface: NXsample
Applied electric field
 

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

Specified by:
getElectric_field in interface NXsample
Returns:
the value.








getElectric_fieldScalar
public java.lang.Double getElectric_fieldScalar()
Description copied from interface: NXsample
Applied electric field
 

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

Specified by:
getElectric_fieldScalar in interface NXsample
Returns:
the value.








setElectric_field
public DataNode setElectric_field(IDataset electric_field)
Description copied from interface: NXsample
Applied electric field
 

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

Specified by:
setElectric_field in interface NXsample
Parameters:
electric_field - the electric_field








setElectric_fieldScalar
public DataNode setElectric_fieldScalar(java.lang.Double electric_field)
Description copied from interface: NXsample
Applied electric field
 

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

Specified by:
setElectric_fieldScalar in interface NXsample
Parameters:
electric_field - the electric_field








getElectric_fieldAttributeDirection
public java.lang.String getElectric_fieldAttributeDirection()
Description copied from interface: NXsample

 
Enumeration:

 
x 
 
y 
 
z 

 


Specified by:
getElectric_fieldAttributeDirection in interface NXsample
Returns:
the value.








setElectric_fieldAttributeDirection
public void setElectric_fieldAttributeDirection(java.lang.String direction)
Description copied from interface: NXsample

 
Enumeration:

 
x 
 
y 
 
z 

 


Specified by:
setElectric_fieldAttributeDirection in interface NXsample
Parameters:
direction - the direction








getMagnetic_field
public IDataset getMagnetic_field()
Description copied from interface: NXsample
Applied magnetic field
 

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

Specified by:
getMagnetic_field in interface NXsample
Returns:
the value.








getMagnetic_fieldScalar
public java.lang.Double getMagnetic_fieldScalar()
Description copied from interface: NXsample
Applied magnetic field
 

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

Specified by:
getMagnetic_fieldScalar in interface NXsample
Returns:
the value.








setMagnetic_field
public DataNode setMagnetic_field(IDataset magnetic_field)
Description copied from interface: NXsample
Applied magnetic field
 

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

Specified by:
setMagnetic_field in interface NXsample
Parameters:
magnetic_field - the magnetic_field








setMagnetic_fieldScalar
public DataNode setMagnetic_fieldScalar(java.lang.Double magnetic_field)
Description copied from interface: NXsample
Applied magnetic field
 

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

Specified by:
setMagnetic_fieldScalar in interface NXsample
Parameters:
magnetic_field - the magnetic_field








getMagnetic_fieldAttributeDirection
public java.lang.String getMagnetic_fieldAttributeDirection()
Description copied from interface: NXsample

 
Enumeration:

 
x 
 
y 
 
z 

 


Specified by:
getMagnetic_fieldAttributeDirection in interface NXsample
Returns:
the value.








setMagnetic_fieldAttributeDirection
public void setMagnetic_fieldAttributeDirection(java.lang.String direction)
Description copied from interface: NXsample

 
Enumeration:

 
x 
 
y 
 
z 

 


Specified by:
setMagnetic_fieldAttributeDirection in interface NXsample
Parameters:
direction - the direction








getStress_field
public IDataset getStress_field()
Description copied from interface: NXsample
Applied external stress field
 

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

Specified by:
getStress_field in interface NXsample
Returns:
the value.








getStress_fieldScalar
public java.lang.Double getStress_fieldScalar()
Description copied from interface: NXsample
Applied external stress field
 

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

Specified by:
getStress_fieldScalar in interface NXsample
Returns:
the value.








setStress_field
public DataNode setStress_field(IDataset stress_field)
Description copied from interface: NXsample
Applied external stress field
 

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

Specified by:
setStress_field in interface NXsample
Parameters:
stress_field - the stress_field








setStress_fieldScalar
public DataNode setStress_fieldScalar(java.lang.Double stress_field)
Description copied from interface: NXsample
Applied external stress field
 

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

Specified by:
setStress_fieldScalar in interface NXsample
Parameters:
stress_field - the stress_field








getStress_fieldAttributeDirection
public java.lang.String getStress_fieldAttributeDirection()
Description copied from interface: NXsample

 
Enumeration:

 
x 
 
y 
 
z 

 


Specified by:
getStress_fieldAttributeDirection in interface NXsample
Returns:
the value.








setStress_fieldAttributeDirection
public void setStress_fieldAttributeDirection(java.lang.String direction)
Description copied from interface: NXsample

 
Enumeration:

 
x 
 
y 
 
z 

 


Specified by:
setStress_fieldAttributeDirection in interface NXsample
Parameters:
direction - the direction








getPressure
public IDataset getPressure()
Description copied from interface: NXsample
Applied pressure
 

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

Specified by:
getPressure in interface NXsample
Returns:
the value.








getPressureScalar
public java.lang.Double getPressureScalar()
Description copied from interface: NXsample
Applied pressure
 

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

Specified by:
getPressureScalar in interface NXsample
Returns:
the value.








setPressure
public DataNode setPressure(IDataset pressure)
Description copied from interface: NXsample
Applied pressure
 

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

Specified by:
setPressure in interface NXsample
Parameters:
pressure - the pressure








setPressureScalar
public DataNode setPressureScalar(java.lang.Double pressure)
Description copied from interface: NXsample
Applied pressure
 

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

Specified by:
setPressureScalar in interface NXsample
Parameters:
pressure - the pressure








getChanger_position
public IDataset getChanger_position()
Description copied from interface: NXsample
Sample changer position
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
getChanger_position in interface NXsample
Returns:
the value.








getChanger_positionScalar
public java.lang.Long getChanger_positionScalar()
Description copied from interface: NXsample
Sample changer position
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
getChanger_positionScalar in interface NXsample
Returns:
the value.








setChanger_position
public DataNode setChanger_position(IDataset changer_position)
Description copied from interface: NXsample
Sample changer position
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
setChanger_position in interface NXsample
Parameters:
changer_position - the changer_position








setChanger_positionScalar
public DataNode setChanger_positionScalar(java.lang.Long changer_position)
Description copied from interface: NXsample
Sample changer position
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
setChanger_positionScalar in interface NXsample
Parameters:
changer_position - the changer_position








getUnit_cell_abc
public IDataset getUnit_cell_abc()
Description copied from interface: NXsample
Crystallography unit cell parameters a, b, and c
 

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

Specified by:
getUnit_cell_abc in interface NXsample
Returns:
the value.








getUnit_cell_abcScalar
public java.lang.Double getUnit_cell_abcScalar()
Description copied from interface: NXsample
Crystallography unit cell parameters a, b, and c
 

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

Specified by:
getUnit_cell_abcScalar in interface NXsample
Returns:
the value.








setUnit_cell_abc
public DataNode setUnit_cell_abc(IDataset unit_cell_abc)
Description copied from interface: NXsample
Crystallography unit cell parameters a, b, and c
 

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

Specified by:
setUnit_cell_abc in interface NXsample
Parameters:
unit_cell_abc - the unit_cell_abc








setUnit_cell_abcScalar
public DataNode setUnit_cell_abcScalar(java.lang.Double unit_cell_abc)
Description copied from interface: NXsample
Crystallography unit cell parameters a, b, and c
 

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

Specified by:
setUnit_cell_abcScalar in interface NXsample
Parameters:
unit_cell_abc - the unit_cell_abc








getUnit_cell_alphabetagamma
public IDataset getUnit_cell_alphabetagamma()
Description copied from interface: NXsample
Crystallography unit cell parameters alpha, beta, and gamma
 

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

Specified by:
getUnit_cell_alphabetagamma in interface NXsample
Returns:
the value.








getUnit_cell_alphabetagammaScalar
public java.lang.Double getUnit_cell_alphabetagammaScalar()
Description copied from interface: NXsample
Crystallography unit cell parameters alpha, beta, and gamma
 

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

Specified by:
getUnit_cell_alphabetagammaScalar in interface NXsample
Returns:
the value.








setUnit_cell_alphabetagamma
public DataNode setUnit_cell_alphabetagamma(IDataset unit_cell_alphabetagamma)
Description copied from interface: NXsample
Crystallography unit cell parameters alpha, beta, and gamma
 

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

Specified by:
setUnit_cell_alphabetagamma in interface NXsample
Parameters:
unit_cell_alphabetagamma - the unit_cell_alphabetagamma








setUnit_cell_alphabetagammaScalar
public DataNode setUnit_cell_alphabetagammaScalar(java.lang.Double unit_cell_alphabetagamma)
Description copied from interface: NXsample
Crystallography unit cell parameters alpha, beta, and gamma
 

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

Specified by:
setUnit_cell_alphabetagammaScalar in interface NXsample
Parameters:
unit_cell_alphabetagamma - the unit_cell_alphabetagamma








getUnit_cell
public IDataset getUnit_cell()
Description copied from interface: NXsample
Unit cell parameters (lengths and angles)
 

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

Specified by:
getUnit_cell in interface NXsample
Returns:
the value.








getUnit_cellScalar
public java.lang.Double getUnit_cellScalar()
Description copied from interface: NXsample
Unit cell parameters (lengths and angles)
 

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

Specified by:
getUnit_cellScalar in interface NXsample
Returns:
the value.








setUnit_cell
public DataNode setUnit_cell(IDataset unit_cell)
Description copied from interface: NXsample
Unit cell parameters (lengths and angles)
 

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

Specified by:
setUnit_cell in interface NXsample
Parameters:
unit_cell - the unit_cell








setUnit_cellScalar
public DataNode setUnit_cellScalar(java.lang.Double unit_cell)
Description copied from interface: NXsample
Unit cell parameters (lengths and angles)
 

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

Specified by:
setUnit_cellScalar in interface NXsample
Parameters:
unit_cell - the unit_cell








getUnit_cell_volume
public IDataset getUnit_cell_volume()
Description copied from interface: NXsample
Volume of the unit cell
 

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

Specified by:
getUnit_cell_volume in interface NXsample
Returns:
the value.








getUnit_cell_volumeScalar
public java.lang.Double getUnit_cell_volumeScalar()
Description copied from interface: NXsample
Volume of the unit cell
 

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

Specified by:
getUnit_cell_volumeScalar in interface NXsample
Returns:
the value.








setUnit_cell_volume
public DataNode setUnit_cell_volume(IDataset unit_cell_volume)
Description copied from interface: NXsample
Volume of the unit cell
 

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

Specified by:
setUnit_cell_volume in interface NXsample
Parameters:
unit_cell_volume - the unit_cell_volume








setUnit_cell_volumeScalar
public DataNode setUnit_cell_volumeScalar(java.lang.Double unit_cell_volume)
Description copied from interface: NXsample
Volume of the unit cell
 

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

Specified by:
setUnit_cell_volumeScalar in interface NXsample
Parameters:
unit_cell_volume - the unit_cell_volume








getSample_orientation
public IDataset getSample_orientation()
Description copied from interface: NXsample
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;
 

Specified by:
getSample_orientation in interface NXsample
Returns:
the value.








getSample_orientationScalar
public java.lang.Double getSample_orientationScalar()
Description copied from interface: NXsample
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;
 

Specified by:
getSample_orientationScalar in interface NXsample
Returns:
the value.








setSample_orientation
public DataNode setSample_orientation(IDataset sample_orientation)
Description copied from interface: NXsample
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;
 

Specified by:
setSample_orientation in interface NXsample
Parameters:
sample_orientation - the sample_orientation








setSample_orientationScalar
public DataNode setSample_orientationScalar(java.lang.Double sample_orientation)
Description copied from interface: NXsample
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;
 

Specified by:
setSample_orientationScalar in interface NXsample
Parameters:
sample_orientation - the sample_orientation








getOrientation_matrix
public IDataset getOrientation_matrix()
Description copied from interface: NXsample
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;
 

Specified by:
getOrientation_matrix in interface NXsample
Returns:
the value.








getOrientation_matrixScalar
public java.lang.Double getOrientation_matrixScalar()
Description copied from interface: NXsample
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;
 

Specified by:
getOrientation_matrixScalar in interface NXsample
Returns:
the value.








setOrientation_matrix
public DataNode setOrientation_matrix(IDataset orientation_matrix)
Description copied from interface: NXsample
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;
 

Specified by:
setOrientation_matrix in interface NXsample
Parameters:
orientation_matrix - the orientation_matrix








setOrientation_matrixScalar
public DataNode setOrientation_matrixScalar(java.lang.Double orientation_matrix)
Description copied from interface: NXsample
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;
 

Specified by:
setOrientation_matrixScalar in interface NXsample
Parameters:
orientation_matrix - the orientation_matrix








getUb_matrix
public IDataset getUb_matrix()
Description copied from interface: NXsample
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;
 

Specified by:
getUb_matrix in interface NXsample
Returns:
the value.








getUb_matrixScalar
public java.lang.Double getUb_matrixScalar()
Description copied from interface: NXsample
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;
 

Specified by:
getUb_matrixScalar in interface NXsample
Returns:
the value.








setUb_matrix
public DataNode setUb_matrix(IDataset ub_matrix)
Description copied from interface: NXsample
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;
 

Specified by:
setUb_matrix in interface NXsample
Parameters:
ub_matrix - the ub_matrix








setUb_matrixScalar
public DataNode setUb_matrixScalar(java.lang.Double ub_matrix)
Description copied from interface: NXsample
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;
 

Specified by:
setUb_matrixScalar in interface NXsample
Parameters:
ub_matrix - the ub_matrix








getMass
public IDataset getMass()
Description copied from interface: NXsample
Mass of sample
 

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

Specified by:
getMass in interface NXsample
Returns:
the value.








getMassScalar
public java.lang.Double getMassScalar()
Description copied from interface: NXsample
Mass of sample
 

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

Specified by:
getMassScalar in interface NXsample
Returns:
the value.








setMass
public DataNode setMass(IDataset mass)
Description copied from interface: NXsample
Mass of sample
 

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

Specified by:
setMass in interface NXsample
Parameters:
mass - the mass








setMassScalar
public DataNode setMassScalar(java.lang.Double mass)
Description copied from interface: NXsample
Mass of sample
 

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

Specified by:
setMassScalar in interface NXsample
Parameters:
mass - the mass








getDensity
public IDataset getDensity()
Description copied from interface: NXsample
Density of sample
 

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

Specified by:
getDensity in interface NXsample
Returns:
the value.








getDensityScalar
public java.lang.Double getDensityScalar()
Description copied from interface: NXsample
Density of sample
 

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

Specified by:
getDensityScalar in interface NXsample
Returns:
the value.








setDensity
public DataNode setDensity(IDataset density)
Description copied from interface: NXsample
Density of sample
 

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

Specified by:
setDensity in interface NXsample
Parameters:
density - the density








setDensityScalar
public DataNode setDensityScalar(java.lang.Double density)
Description copied from interface: NXsample
Density of sample
 

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

Specified by:
setDensityScalar in interface NXsample
Parameters:
density - the density








getRelative_molecular_mass
public IDataset getRelative_molecular_mass()
Description copied from interface: NXsample
Relative Molecular Mass of sample
 

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

Specified by:
getRelative_molecular_mass in interface NXsample
Returns:
the value.








getRelative_molecular_massScalar
public java.lang.Double getRelative_molecular_massScalar()
Description copied from interface: NXsample
Relative Molecular Mass of sample
 

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

Specified by:
getRelative_molecular_massScalar in interface NXsample
Returns:
the value.








setRelative_molecular_mass
public DataNode setRelative_molecular_mass(IDataset relative_molecular_mass)
Description copied from interface: NXsample
Relative Molecular Mass of sample
 

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

Specified by:
setRelative_molecular_mass in interface NXsample
Parameters:
relative_molecular_mass - the relative_molecular_mass








setRelative_molecular_massScalar
public DataNode setRelative_molecular_massScalar(java.lang.Double relative_molecular_mass)
Description copied from interface: NXsample
Relative Molecular Mass of sample
 

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

Specified by:
setRelative_molecular_massScalar in interface NXsample
Parameters:
relative_molecular_mass - the relative_molecular_mass








getType
public IDataset getType()
Description copied from interface: NXsample

 
Enumeration:

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

 


Specified by:
getType in interface NXsample
Returns:
the value.








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXsample

 
Enumeration:

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

 


Specified by:
getTypeScalar in interface NXsample
Returns:
the value.








setType
public DataNode setType(IDataset type)
Description copied from interface: NXsample

 
Enumeration:

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

 


Specified by:
setType in interface NXsample
Parameters:
type - the type








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXsample

 
Enumeration:

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

 


Specified by:
setTypeScalar in interface NXsample
Parameters:
type - the type








getSituation
public IDataset getSituation()
Description copied from interface: NXsample
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 

 


Specified by:
getSituation in interface NXsample
Returns:
the value.








getSituationScalar
public java.lang.String getSituationScalar()
Description copied from interface: NXsample
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 

 


Specified by:
getSituationScalar in interface NXsample
Returns:
the value.








setSituation
public DataNode setSituation(IDataset situation)
Description copied from interface: NXsample
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 

 


Specified by:
setSituation in interface NXsample
Parameters:
situation - the situation








setSituationScalar
public DataNode setSituationScalar(java.lang.String situation)
Description copied from interface: NXsample
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 

 


Specified by:
setSituationScalar in interface NXsample
Parameters:
situation - the situation








getDescription
public IDataset getDescription()
Description copied from interface: NXsample
Description of the sample

Specified by:
getDescription in interface NXsample
Returns:
the value.








getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXsample
Description of the sample

Specified by:
getDescriptionScalar in interface NXsample
Returns:
the value.








setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXsample
Description of the sample

Specified by:
setDescription in interface NXsample
Parameters:
description - the description








setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXsample
Description of the sample

Specified by:
setDescriptionScalar in interface NXsample
Parameters:
description - the description








getPreparation_date
public IDataset getPreparation_date()
Description copied from interface: NXsample
Date of preparation of the sample
 

 Type: NX_DATE_TIME
 

Specified by:
getPreparation_date in interface NXsample
Returns:
the value.








getPreparation_dateScalar
public java.util.Date getPreparation_dateScalar()
Description copied from interface: NXsample
Date of preparation of the sample
 

 Type: NX_DATE_TIME
 

Specified by:
getPreparation_dateScalar in interface NXsample
Returns:
the value.








setPreparation_date
public DataNode setPreparation_date(IDataset preparation_date)
Description copied from interface: NXsample
Date of preparation of the sample
 

 Type: NX_DATE_TIME
 

Specified by:
setPreparation_date in interface NXsample
Parameters:
preparation_date - the preparation_date








setPreparation_dateScalar
public DataNode setPreparation_dateScalar(java.util.Date preparation_date)
Description copied from interface: NXsample
Date of preparation of the sample
 

 Type: NX_DATE_TIME
 

Specified by:
setPreparation_dateScalar in interface NXsample
Parameters:
preparation_date - the preparation_date








getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXsample
The position and orientation of the center of mass of the sample

Specified by:
getGeometry in interface NXsample
Returns:
the value.








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXsample
The position and orientation of the center of mass of the sample

Specified by:
setGeometry in interface NXsample
Parameters:
geometry - the geometry








getBeam
public NXbeam getBeam()
Description copied from interface: NXsample
Details of beam incident on sample - used to calculate sample/beam interaction point

Specified by:
getBeam in interface NXsample
Returns:
the value.








setBeam
public void setBeam(NXbeam beam)
Description copied from interface: NXsample
Details of beam incident on sample - used to calculate sample/beam interaction point

Specified by:
setBeam in interface NXsample
Parameters:
beam - the beam








getBeam
public NXbeam getBeam(java.lang.String name)
Description copied from interface: NXsample
Get a NXbeam node by name:
 

 

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

Specified by:
getBeam in interface NXsample
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXbeam for that node.








setBeam
public void setBeam(java.lang.String name,
                    NXbeam beam)
Description copied from interface: NXsample
Set a NXbeam node by name:
 

 

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

Specified by:
setBeam in interface NXsample
Parameters:
name - the name of the node
beam - the value to set








getAllBeam
public java.util.Map<java.lang.String,NXbeam> getAllBeam()
Description copied from interface: NXsample
Get all NXbeam nodes:
 

 

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

Specified by:
getAllBeam in interface NXsample
Returns:
a map from node names to the NXbeam for that node.








setAllBeam
public void setAllBeam(java.util.Map<java.lang.String,NXbeam> beam)
Description copied from interface: NXsample
Set multiple child nodes of a particular type.
 

 

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

Specified by:
setAllBeam in interface NXsample
Parameters:
beam - the child nodes to add








getSample_componentGroup
public NXsample_component getSample_componentGroup()
Description copied from interface: NXsample
One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays

Specified by:
getSample_componentGroup in interface NXsample
Returns:
the value.








setSample_componentGroup
public void setSample_componentGroup(NXsample_component sample_componentGroup)
Description copied from interface: NXsample
One group per sample component
 This is the perferred way of recording per component information over the n_comp arrays

Specified by:
setSample_componentGroup in interface NXsample
Parameters:
sample_componentGroup - the sample_componentGroup








getSample_componentGroup
public NXsample_component getSample_componentGroup(java.lang.String name)
Description copied from interface: NXsample
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
 

Specified by:
getSample_componentGroup in interface NXsample
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXsample_component for that node.








setSample_componentGroup
public void setSample_componentGroup(java.lang.String name,
                                     NXsample_component sample_componentGroup)
Description copied from interface: NXsample
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
 

Specified by:
setSample_componentGroup in interface NXsample
Parameters:
name - the name of the node
sample_componentGroup - the value to set








getAllSample_componentGroup
public java.util.Map<java.lang.String,NXsample_component> getAllSample_componentGroup()
Description copied from interface: NXsample
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
 

Specified by:
getAllSample_componentGroup in interface NXsample
Returns:
a map from node names to the NXsample_component for that node.








setAllSample_componentGroup
public void setAllSample_componentGroup(java.util.Map<java.lang.String,NXsample_component> sample_componentGroup)
Description copied from interface: NXsample
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
 

Specified by:
setAllSample_componentGroup in interface NXsample
Parameters:
sample_componentGroup - the child nodes to add








getComponent
public IDataset getComponent()
Description copied from interface: NXsample
Details of the component of the sample and/or can
 

 Dimensions: 1: n_comp;
 

Specified by:
getComponent in interface NXsample
Returns:
the value.








getComponentScalar
public java.lang.String getComponentScalar()
Description copied from interface: NXsample
Details of the component of the sample and/or can
 

 Dimensions: 1: n_comp;
 

Specified by:
getComponentScalar in interface NXsample
Returns:
the value.








setComponent
public DataNode setComponent(IDataset component)
Description copied from interface: NXsample
Details of the component of the sample and/or can
 

 Dimensions: 1: n_comp;
 

Specified by:
setComponent in interface NXsample
Parameters:
component - the component








setComponentScalar
public DataNode setComponentScalar(java.lang.String component)
Description copied from interface: NXsample
Details of the component of the sample and/or can
 

 Dimensions: 1: n_comp;
 

Specified by:
setComponentScalar in interface NXsample
Parameters:
component - the component








getSample_component
public IDataset getSample_component()
Description copied from interface: NXsample
Type of component
 

 Dimensions: 1: n_comp;
 
Enumeration:

 
sample 
 
can 
 
atmosphere 
 
kit 

 


Specified by:
getSample_component in interface NXsample
Returns:
the value.








getSample_componentScalar
public java.lang.String getSample_componentScalar()
Description copied from interface: NXsample
Type of component
 

 Dimensions: 1: n_comp;
 
Enumeration:

 
sample 
 
can 
 
atmosphere 
 
kit 

 


Specified by:
getSample_componentScalar in interface NXsample
Returns:
the value.








setSample_component
public DataNode setSample_component(IDataset sample_component)
Description copied from interface: NXsample
Type of component
 

 Dimensions: 1: n_comp;
 
Enumeration:

 
sample 
 
can 
 
atmosphere 
 
kit 

 


Specified by:
setSample_component in interface NXsample
Parameters:
sample_component - the sample_component








setSample_componentScalar
public DataNode setSample_componentScalar(java.lang.String sample_component)
Description copied from interface: NXsample
Type of component
 

 Dimensions: 1: n_comp;
 
Enumeration:

 
sample 
 
can 
 
atmosphere 
 
kit 

 


Specified by:
setSample_componentScalar in interface NXsample
Parameters:
sample_component - the sample_component








getConcentration
public IDataset getConcentration()
Description copied from interface: NXsample
Concentration of each component
 

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

Specified by:
getConcentration in interface NXsample
Returns:
the value.








getConcentrationScalar
public java.lang.Double getConcentrationScalar()
Description copied from interface: NXsample
Concentration of each component
 

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

Specified by:
getConcentrationScalar in interface NXsample
Returns:
the value.








setConcentration
public DataNode setConcentration(IDataset concentration)
Description copied from interface: NXsample
Concentration of each component
 

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

Specified by:
setConcentration in interface NXsample
Parameters:
concentration - the concentration








setConcentrationScalar
public DataNode setConcentrationScalar(java.lang.Double concentration)
Description copied from interface: NXsample
Concentration of each component
 

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

Specified by:
setConcentrationScalar in interface NXsample
Parameters:
concentration - the concentration








getVolume_fraction
public IDataset getVolume_fraction()
Description copied from interface: NXsample
Volume fraction of each component
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp;
 

Specified by:
getVolume_fraction in interface NXsample
Returns:
the value.








getVolume_fractionScalar
public java.lang.Double getVolume_fractionScalar()
Description copied from interface: NXsample
Volume fraction of each component
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp;
 

Specified by:
getVolume_fractionScalar in interface NXsample
Returns:
the value.








setVolume_fraction
public DataNode setVolume_fraction(IDataset volume_fraction)
Description copied from interface: NXsample
Volume fraction of each component
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp;
 

Specified by:
setVolume_fraction in interface NXsample
Parameters:
volume_fraction - the volume_fraction








setVolume_fractionScalar
public DataNode setVolume_fractionScalar(java.lang.Double volume_fraction)
Description copied from interface: NXsample
Volume fraction of each component
 

 Type: NX_FLOAT
 Dimensions: 1: n_comp;
 

Specified by:
setVolume_fractionScalar in interface NXsample
Parameters:
volume_fraction - the volume_fraction








getScattering_length_density
public IDataset getScattering_length_density()
Description copied from interface: NXsample
Scattering length density of each component
 

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

Specified by:
getScattering_length_density in interface NXsample
Returns:
the value.








getScattering_length_densityScalar
public java.lang.Double getScattering_length_densityScalar()
Description copied from interface: NXsample
Scattering length density of each component
 

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

Specified by:
getScattering_length_densityScalar in interface NXsample
Returns:
the value.








setScattering_length_density
public DataNode setScattering_length_density(IDataset scattering_length_density)
Description copied from interface: NXsample
Scattering length density of each component
 

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

Specified by:
setScattering_length_density in interface NXsample
Parameters:
scattering_length_density - the scattering_length_density








setScattering_length_densityScalar
public DataNode setScattering_length_densityScalar(java.lang.Double scattering_length_density)
Description copied from interface: NXsample
Scattering length density of each component
 

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

Specified by:
setScattering_length_densityScalar in interface NXsample
Parameters:
scattering_length_density - the scattering_length_density








getUnit_cell_class
public IDataset getUnit_cell_class()
Description copied from interface: NXsample
In case it is all we know and we want to record/document it
 

 
Enumeration:

 
triclinic 
 
monoclinic 
 
orthorhombic 
 
tetragonal 
 
rhombohedral 
 
hexagonal 
 
cubic 

 


Specified by:
getUnit_cell_class in interface NXsample
Returns:
the value.








getUnit_cell_classScalar
public java.lang.String getUnit_cell_classScalar()
Description copied from interface: NXsample
In case it is all we know and we want to record/document it
 

 
Enumeration:

 
triclinic 
 
monoclinic 
 
orthorhombic 
 
tetragonal 
 
rhombohedral 
 
hexagonal 
 
cubic 

 


Specified by:
getUnit_cell_classScalar in interface NXsample
Returns:
the value.








setUnit_cell_class
public DataNode setUnit_cell_class(IDataset unit_cell_class)
Description copied from interface: NXsample
In case it is all we know and we want to record/document it
 

 
Enumeration:

 
triclinic 
 
monoclinic 
 
orthorhombic 
 
tetragonal 
 
rhombohedral 
 
hexagonal 
 
cubic 

 


Specified by:
setUnit_cell_class in interface NXsample
Parameters:
unit_cell_class - the unit_cell_class








setUnit_cell_classScalar
public DataNode setUnit_cell_classScalar(java.lang.String unit_cell_class)
Description copied from interface: NXsample
In case it is all we know and we want to record/document it
 

 
Enumeration:

 
triclinic 
 
monoclinic 
 
orthorhombic 
 
tetragonal 
 
rhombohedral 
 
hexagonal 
 
cubic 

 


Specified by:
setUnit_cell_classScalar in interface NXsample
Parameters:
unit_cell_class - the unit_cell_class








getSpace_group
public IDataset getSpace_group()
Description copied from interface: NXsample
Crystallographic space group
 

 Dimensions: 1: n_comp;
 

Specified by:
getSpace_group in interface NXsample
Returns:
the value.








getSpace_groupScalar
public java.lang.String getSpace_groupScalar()
Description copied from interface: NXsample
Crystallographic space group
 

 Dimensions: 1: n_comp;
 

Specified by:
getSpace_groupScalar in interface NXsample
Returns:
the value.








setSpace_group
public DataNode setSpace_group(IDataset space_group)
Description copied from interface: NXsample
Crystallographic space group
 

 Dimensions: 1: n_comp;
 

Specified by:
setSpace_group in interface NXsample
Parameters:
space_group - the space_group








setSpace_groupScalar
public DataNode setSpace_groupScalar(java.lang.String space_group)
Description copied from interface: NXsample
Crystallographic space group
 

 Dimensions: 1: n_comp;
 

Specified by:
setSpace_groupScalar in interface NXsample
Parameters:
space_group - the space_group








getPoint_group
public IDataset getPoint_group()
Description copied from interface: NXsample
Crystallographic point group, deprecated if space_group present
 

 Dimensions: 1: n_comp;
 

Specified by:
getPoint_group in interface NXsample
Returns:
the value.








getPoint_groupScalar
public java.lang.String getPoint_groupScalar()
Description copied from interface: NXsample
Crystallographic point group, deprecated if space_group present
 

 Dimensions: 1: n_comp;
 

Specified by:
getPoint_groupScalar in interface NXsample
Returns:
the value.








setPoint_group
public DataNode setPoint_group(IDataset point_group)
Description copied from interface: NXsample
Crystallographic point group, deprecated if space_group present
 

 Dimensions: 1: n_comp;
 

Specified by:
setPoint_group in interface NXsample
Parameters:
point_group - the point_group








setPoint_groupScalar
public DataNode setPoint_groupScalar(java.lang.String point_group)
Description copied from interface: NXsample
Crystallographic point group, deprecated if space_group present
 

 Dimensions: 1: n_comp;
 

Specified by:
setPoint_groupScalar in interface NXsample
Parameters:
point_group - the point_group








getPath_length
public IDataset getPath_length()
Description copied from interface: NXsample
Path length through sample/can for simple case when
 it does not vary with scattering direction
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getPath_length in interface NXsample
Returns:
the value.








getPath_lengthScalar
public java.lang.Double getPath_lengthScalar()
Description copied from interface: NXsample
Path length through sample/can for simple case when
 it does not vary with scattering direction
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getPath_lengthScalar in interface NXsample
Returns:
the value.








setPath_length
public DataNode setPath_length(IDataset path_length)
Description copied from interface: NXsample
Path length through sample/can for simple case when
 it does not vary with scattering direction
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setPath_length in interface NXsample
Parameters:
path_length - the path_length








setPath_lengthScalar
public DataNode setPath_lengthScalar(java.lang.Double path_length)
Description copied from interface: NXsample
Path length through sample/can for simple case when
 it does not vary with scattering direction
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setPath_lengthScalar in interface NXsample
Parameters:
path_length - the path_length








getPath_length_window
public IDataset getPath_length_window()
Description copied from interface: NXsample
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getPath_length_window in interface NXsample
Returns:
the value.








getPath_length_windowScalar
public java.lang.Double getPath_length_windowScalar()
Description copied from interface: NXsample
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getPath_length_windowScalar in interface NXsample
Returns:
the value.








setPath_length_window
public DataNode setPath_length_window(IDataset path_length_window)
Description copied from interface: NXsample
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setPath_length_window in interface NXsample
Parameters:
path_length_window - the path_length_window








setPath_length_windowScalar
public DataNode setPath_length_windowScalar(java.lang.Double path_length_window)
Description copied from interface: NXsample
Thickness of a beam entry/exit window on the can (mm)
 - assumed same for entry and exit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setPath_length_windowScalar in interface NXsample
Parameters:
path_length_window - the path_length_window








getThickness
public IDataset getThickness()
Description copied from interface: NXsample
sample thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getThickness in interface NXsample
Returns:
the value.








getThicknessScalar
public java.lang.Double getThicknessScalar()
Description copied from interface: NXsample
sample thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getThicknessScalar in interface NXsample
Returns:
the value.








setThickness
public DataNode setThickness(IDataset thickness)
Description copied from interface: NXsample
sample thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setThickness in interface NXsample
Parameters:
thickness - the thickness








setThicknessScalar
public DataNode setThicknessScalar(java.lang.Double thickness)
Description copied from interface: NXsample
sample thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setThicknessScalar in interface NXsample
Parameters:
thickness - the thickness








getTransmission
public NXdata getTransmission()
Description copied from interface: NXsample
As a function of Wavelength

Specified by:
getTransmission in interface NXsample
Returns:
the value.








setTransmission
public void setTransmission(NXdata transmission)
Description copied from interface: NXsample
As a function of Wavelength

Specified by:
setTransmission in interface NXsample
Parameters:
transmission - the transmission








getTemperature_log
public NXlog getTemperature_log()
Description copied from interface: NXsample
temperature_log.value is a link to e.g. temperature_env.sensor1.value_log.value

Specified by:
getTemperature_log in interface NXsample
Returns:
the value.








setTemperature_log
public void setTemperature_log(NXlog temperature_log)
Description copied from interface: NXsample
temperature_log.value is a link to e.g. temperature_env.sensor1.value_log.value

Specified by:
setTemperature_log in interface NXsample
Parameters:
temperature_log - the temperature_log








getTemperature_env
public NXenvironment getTemperature_env()
Description copied from interface: NXsample
Additional sample temperature environment information

Specified by:
getTemperature_env in interface NXsample
Returns:
the value.








setTemperature_env
public void setTemperature_env(NXenvironment temperature_env)
Description copied from interface: NXsample
Additional sample temperature environment information

Specified by:
setTemperature_env in interface NXsample
Parameters:
temperature_env - the temperature_env








getMagnetic_field_log
public NXlog getMagnetic_field_log()
Description copied from interface: NXsample
magnetic_field_log.value is a link to e.g. magnetic_field_env.sensor1.value_log.value

Specified by:
getMagnetic_field_log in interface NXsample
Returns:
the value.








setMagnetic_field_log
public void setMagnetic_field_log(NXlog magnetic_field_log)
Description copied from interface: NXsample
magnetic_field_log.value is a link to e.g. magnetic_field_env.sensor1.value_log.value

Specified by:
setMagnetic_field_log in interface NXsample
Parameters:
magnetic_field_log - the magnetic_field_log








getMagnetic_field_env
public NXenvironment getMagnetic_field_env()
Description copied from interface: NXsample
Additional sample magnetic environment information

Specified by:
getMagnetic_field_env in interface NXsample
Returns:
the value.








setMagnetic_field_env
public void setMagnetic_field_env(NXenvironment magnetic_field_env)
Description copied from interface: NXsample
Additional sample magnetic environment information

Specified by:
setMagnetic_field_env in interface NXsample
Parameters:
magnetic_field_env - the magnetic_field_env








getExternal_DAC
public IDataset getExternal_DAC()
Description copied from interface: NXsample
value sent to user's sample setup
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
getExternal_DAC in interface NXsample
Returns:
the value.








getExternal_DACScalar
public java.lang.Double getExternal_DACScalar()
Description copied from interface: NXsample
value sent to user's sample setup
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
getExternal_DACScalar in interface NXsample
Returns:
the value.








setExternal_DAC
public DataNode setExternal_DAC(IDataset external_DAC)
Description copied from interface: NXsample
value sent to user's sample setup
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
setExternal_DAC in interface NXsample
Parameters:
external_DAC - the external_DAC








setExternal_DACScalar
public DataNode setExternal_DACScalar(java.lang.Double external_DAC)
Description copied from interface: NXsample
value sent to user's sample setup
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
setExternal_DACScalar in interface NXsample
Parameters:
external_DAC - the external_DAC








getExternal_ADC
public NXlog getExternal_ADC()
Description copied from interface: NXsample
logged value (or logic state) read from user's setup

Specified by:
getExternal_ADC in interface NXsample
Returns:
the value.








setExternal_ADC
public void setExternal_ADC(NXlog external_ADC)
Description copied from interface: NXsample
logged value (or logic state) read from user's setup

Specified by:
setExternal_ADC in interface NXsample
Parameters:
external_ADC - the external_ADC








getShort_title
public IDataset getShort_title()
Description copied from interface: NXsample
20 character fixed length sample description for legends

Specified by:
getShort_title in interface NXsample
Returns:
the value.








getShort_titleScalar
public java.lang.String getShort_titleScalar()
Description copied from interface: NXsample
20 character fixed length sample description for legends

Specified by:
getShort_titleScalar in interface NXsample
Returns:
the value.








setShort_title
public DataNode setShort_title(IDataset short_title)
Description copied from interface: NXsample
20 character fixed length sample description for legends

Specified by:
setShort_title in interface NXsample
Parameters:
short_title - the short_title








setShort_titleScalar
public DataNode setShort_titleScalar(java.lang.String short_title)
Description copied from interface: NXsample
20 character fixed length sample description for legends

Specified by:
setShort_titleScalar in interface NXsample
Parameters:
short_title - the short_title








getRotation_angle
public IDataset getRotation_angle()
Description copied from interface: NXsample
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
 

Specified by:
getRotation_angle in interface NXsample
Returns:
the value.








getRotation_angleScalar
public java.lang.Double getRotation_angleScalar()
Description copied from interface: NXsample
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
 

Specified by:
getRotation_angleScalar in interface NXsample
Returns:
the value.








setRotation_angle
public DataNode setRotation_angle(IDataset rotation_angle)
Description copied from interface: NXsample
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
 

Specified by:
setRotation_angle in interface NXsample
Parameters:
rotation_angle - the rotation_angle








setRotation_angleScalar
public DataNode setRotation_angleScalar(java.lang.Double rotation_angle)
Description copied from interface: NXsample
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
 

Specified by:
setRotation_angleScalar in interface NXsample
Parameters:
rotation_angle - the rotation_angle








getX_translation
public IDataset getX_translation()
Description copied from interface: NXsample
Translation of the sample along the X-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getX_translation in interface NXsample
Returns:
the value.








getX_translationScalar
public java.lang.Double getX_translationScalar()
Description copied from interface: NXsample
Translation of the sample along the X-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getX_translationScalar in interface NXsample
Returns:
the value.








setX_translation
public DataNode setX_translation(IDataset x_translation)
Description copied from interface: NXsample
Translation of the sample along the X-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setX_translation in interface NXsample
Parameters:
x_translation - the x_translation








setX_translationScalar
public DataNode setX_translationScalar(java.lang.Double x_translation)
Description copied from interface: NXsample
Translation of the sample along the X-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setX_translationScalar in interface NXsample
Parameters:
x_translation - the x_translation








getDistance
public IDataset getDistance()
Description copied from interface: NXsample
Translation of the sample along the Z-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDistance in interface NXsample
Returns:
the value.








getDistanceScalar
public java.lang.Double getDistanceScalar()
Description copied from interface: NXsample
Translation of the sample along the Z-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDistanceScalar in interface NXsample
Returns:
the value.








setDistance
public DataNode setDistance(IDataset distance)
Description copied from interface: NXsample
Translation of the sample along the Z-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDistance in interface NXsample
Parameters:
distance - the distance








setDistanceScalar
public DataNode setDistanceScalar(java.lang.Double distance)
Description copied from interface: NXsample
Translation of the sample along the Z-direction of the laboratory coordinate system
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDistanceScalar in interface NXsample
Parameters:
distance - the distance








getPositioner
public NXpositioner getPositioner()
Description copied from interface: NXsample
Any positioner (motor, PZT, ...) used to locate the sample

Specified by:
getPositioner in interface NXsample
Returns:
the value.








setPositioner
public void setPositioner(NXpositioner positioner)
Description copied from interface: NXsample
Any positioner (motor, PZT, ...) used to locate the sample

Specified by:
setPositioner in interface NXsample
Parameters:
positioner - the positioner








getPositioner
public NXpositioner getPositioner(java.lang.String name)
Description copied from interface: NXsample
Get a NXpositioner node by name:
 

 

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

Specified by:
getPositioner in interface NXsample
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXpositioner for that node.








setPositioner
public void setPositioner(java.lang.String name,
                          NXpositioner positioner)
Description copied from interface: NXsample
Set a NXpositioner node by name:
 

 

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

Specified by:
setPositioner in interface NXsample
Parameters:
name - the name of the node
positioner - the value to set








getAllPositioner
public java.util.Map<java.lang.String,NXpositioner> getAllPositioner()
Description copied from interface: NXsample
Get all NXpositioner nodes:
 

 

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

Specified by:
getAllPositioner in interface NXsample
Returns:
a map from node names to the NXpositioner for that node.








setAllPositioner
public void setAllPositioner(java.util.Map<java.lang.String,NXpositioner> positioner)
Description copied from interface: NXsample
Set multiple child nodes of a particular type.
 

 

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

Specified by:
setAllPositioner in interface NXsample
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