Package org.eclipse.dawnsci.nexus

Interface NXsample

All Superinterfaces:
GroupNode, Iterable<NodeLink>, Node, NXcomponent, NXobject
public interface NXsample extends NXcomponent
Any information on the sample. This could include scanned variables that are associated with one of the data dimensions, e.g. the magnetic field, or logged data, e.g. monitored temperature vs elapsed time.

Symbols: symbolic array lengths to be coordinated between various fields

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

  • Field Details

  • Method Details

    • getName

      org.eclipse.january.dataset.Dataset getName()
      Descriptive name of sample
      Specified by:
      getName in interface NXcomponent
      Returns:
      the value.

    • setName

      DataNode setName(org.eclipse.january.dataset.IDataset nameDataset)
      Descriptive name of sample
      Specified by:
      setName in interface NXcomponent
      Parameters:
      nameDataset - the nameDataset

    • getNameScalar

      String getNameScalar()
      Descriptive name of sample
      Specified by:
      getNameScalar in interface NXcomponent
      Returns:
      the value.

    • setNameScalar

      DataNode setNameScalar(String nameValue)
      Descriptive name of sample
      Specified by:
      setNameScalar in interface NXcomponent
      Parameters:
      name - the name

    • getChemical_formula

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

    • setChemical_formula

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

    • getChemical_formulaScalar

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

    • setChemical_formulaScalar

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

    • getTemperature

      org.eclipse.january.dataset.Dataset getTemperature()
      Sample temperature. This could be a scanned variable

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

      Returns:
      the value.

    • setTemperature

      DataNode setTemperature(org.eclipse.january.dataset.IDataset temperatureDataset)
      Sample temperature. This could be a scanned variable

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

      Parameters:
      temperatureDataset - the temperatureDataset

    • getTemperatureScalar

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

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

      Returns:
      the value.

    • setTemperatureScalar

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

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

      Parameters:
      temperature - the temperature

    • getElectric_field

      org.eclipse.january.dataset.Dataset getElectric_field()
      Applied electric field

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

      Returns:
      the value.

    • setElectric_field

      DataNode setElectric_field(org.eclipse.january.dataset.IDataset electric_fieldDataset)
      Applied electric field

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

      Parameters:
      electric_fieldDataset - the electric_fieldDataset

    • getElectric_fieldScalar

      Double getElectric_fieldScalar()
      Applied electric field

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

      Returns:
      the value.

    • setElectric_fieldScalar

      DataNode setElectric_fieldScalar(Double electric_fieldValue)
      Applied electric field

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

      Parameters:
      electric_field - the electric_field

    • getElectric_fieldAttributeDirection

      String getElectric_fieldAttributeDirection()

      Enumeration:

      • x
      • y
      • z

      Returns:
      the value.

    • setElectric_fieldAttributeDirection

      void setElectric_fieldAttributeDirection(String directionValue)

      Enumeration:

      • x
      • y
      • z

      Parameters:
      directionValue - the directionValue

    • getMagnetic_field

      org.eclipse.january.dataset.Dataset getMagnetic_field()
      Applied magnetic field

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

      Returns:
      the value.

    • setMagnetic_field

      DataNode setMagnetic_field(org.eclipse.january.dataset.IDataset magnetic_fieldDataset)
      Applied magnetic field

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

      Parameters:
      magnetic_fieldDataset - the magnetic_fieldDataset

    • getMagnetic_fieldScalar

      Double getMagnetic_fieldScalar()
      Applied magnetic field

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

      Returns:
      the value.

    • setMagnetic_fieldScalar

      DataNode setMagnetic_fieldScalar(Double magnetic_fieldValue)
      Applied magnetic field

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

      Parameters:
      magnetic_field - the magnetic_field

    • getMagnetic_fieldAttributeDirection

      String getMagnetic_fieldAttributeDirection()

      Enumeration:

      • x
      • y
      • z

      Returns:
      the value.

    • setMagnetic_fieldAttributeDirection

      void setMagnetic_fieldAttributeDirection(String directionValue)

      Enumeration:

      • x
      • y
      • z

      Parameters:
      directionValue - the directionValue

    • getStress_field

      org.eclipse.january.dataset.Dataset getStress_field()
      Applied external stress field

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

      Returns:
      the value.

    • setStress_field

      DataNode setStress_field(org.eclipse.january.dataset.IDataset stress_fieldDataset)
      Applied external stress field

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

      Parameters:
      stress_fieldDataset - the stress_fieldDataset

    • getStress_fieldScalar

      Double getStress_fieldScalar()
      Applied external stress field

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

      Returns:
      the value.

    • setStress_fieldScalar

      DataNode setStress_fieldScalar(Double stress_fieldValue)
      Applied external stress field

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

      Parameters:
      stress_field - the stress_field

    • getStress_fieldAttributeDirection

      String getStress_fieldAttributeDirection()

      Enumeration:

      • x
      • y
      • z

      Returns:
      the value.

    • setStress_fieldAttributeDirection

      void setStress_fieldAttributeDirection(String directionValue)

      Enumeration:

      • x
      • y
      • z

      Parameters:
      directionValue - the directionValue

    • getPressure

      org.eclipse.january.dataset.Dataset getPressure()
      Applied pressure

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

      Returns:
      the value.

    • setPressure

      DataNode setPressure(org.eclipse.january.dataset.IDataset pressureDataset)
      Applied pressure

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

      Parameters:
      pressureDataset - the pressureDataset

    • getPressureScalar

      Double getPressureScalar()
      Applied pressure

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

      Returns:
      the value.

    • setPressureScalar

      DataNode setPressureScalar(Double pressureValue)
      Applied pressure

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

      Parameters:
      pressure - the pressure

    • getChanger_position

      org.eclipse.january.dataset.Dataset getChanger_position()
      Sample changer position

      Type: NX_INT Units: NX_UNITLESS

      Returns:
      the value.

    • setChanger_position

      DataNode setChanger_position(org.eclipse.january.dataset.IDataset changer_positionDataset)
      Sample changer position

      Type: NX_INT Units: NX_UNITLESS

      Parameters:
      changer_positionDataset - the changer_positionDataset

    • getChanger_positionScalar

      Long getChanger_positionScalar()
      Sample changer position

      Type: NX_INT Units: NX_UNITLESS

      Returns:
      the value.

    • setChanger_positionScalar

      DataNode setChanger_positionScalar(Long changer_positionValue)
      Sample changer position

      Type: NX_INT Units: NX_UNITLESS

      Parameters:
      changer_position - the changer_position

    • getUnit_cell_abc

      org.eclipse.january.dataset.Dataset getUnit_cell_abc()
      Crystallography unit cell parameters a, b, and c

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

      Returns:
      the value.

    • setUnit_cell_abc

      DataNode setUnit_cell_abc(org.eclipse.january.dataset.IDataset unit_cell_abcDataset)
      Crystallography unit cell parameters a, b, and c

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

      Parameters:
      unit_cell_abcDataset - the unit_cell_abcDataset

    • getUnit_cell_abcScalar

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

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

      Returns:
      the value.

    • setUnit_cell_abcScalar

      DataNode setUnit_cell_abcScalar(Double unit_cell_abcValue)
      Crystallography unit cell parameters a, b, and c

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

      Parameters:
      unit_cell_abc - the unit_cell_abc

    • getUnit_cell_alphabetagamma

      org.eclipse.january.dataset.Dataset getUnit_cell_alphabetagamma()
      Crystallography unit cell parameters alpha, beta, and gamma

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

      Returns:
      the value.

    • setUnit_cell_alphabetagamma

      DataNode setUnit_cell_alphabetagamma(org.eclipse.january.dataset.IDataset unit_cell_alphabetagammaDataset)
      Crystallography unit cell parameters alpha, beta, and gamma

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

      Parameters:
      unit_cell_alphabetagammaDataset - the unit_cell_alphabetagammaDataset

    • getUnit_cell_alphabetagammaScalar

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

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

      Returns:
      the value.

    • setUnit_cell_alphabetagammaScalar

      DataNode setUnit_cell_alphabetagammaScalar(Double unit_cell_alphabetagammaValue)
      Crystallography unit cell parameters alpha, beta, and gamma

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

      Parameters:
      unit_cell_alphabetagamma - the unit_cell_alphabetagamma

    • getUnit_cell

      org.eclipse.january.dataset.Dataset getUnit_cell()
      Unit cell parameters (lengths and angles)

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

      Returns:
      the value.

    • setUnit_cell

      DataNode setUnit_cell(org.eclipse.january.dataset.IDataset unit_cellDataset)
      Unit cell parameters (lengths and angles)

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

      Parameters:
      unit_cellDataset - the unit_cellDataset

    • getUnit_cellScalar

      Double getUnit_cellScalar()
      Unit cell parameters (lengths and angles)

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

      Returns:
      the value.

    • setUnit_cellScalar

      DataNode setUnit_cellScalar(Double unit_cellValue)
      Unit cell parameters (lengths and angles)

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

      Parameters:
      unit_cell - the unit_cell

    • getUnit_cell_volume

      org.eclipse.january.dataset.Dataset getUnit_cell_volume()
      Volume of the unit cell

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

      Returns:
      the value.

    • setUnit_cell_volume

      DataNode setUnit_cell_volume(org.eclipse.january.dataset.IDataset unit_cell_volumeDataset)
      Volume of the unit cell

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

      Parameters:
      unit_cell_volumeDataset - the unit_cell_volumeDataset

    • getUnit_cell_volumeScalar

      Double getUnit_cell_volumeScalar()
      Volume of the unit cell

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

      Returns:
      the value.

    • setUnit_cell_volumeScalar

      DataNode setUnit_cell_volumeScalar(Double unit_cell_volumeValue)
      Volume of the unit cell

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

      Parameters:
      unit_cell_volume - the unit_cell_volume

    • getSample_orientation

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

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

      Returns:
      the value.

    • setSample_orientation

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

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

      Parameters:
      sample_orientationDataset - the sample_orientationDataset

    • getSample_orientationScalar

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

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

      Returns:
      the value.

    • setSample_orientationScalar

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

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

      Parameters:
      sample_orientation - the sample_orientation

    • getOrientation_matrix

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

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

      Returns:
      the value.

    • setOrientation_matrix

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

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

      Parameters:
      orientation_matrixDataset - the orientation_matrixDataset

    • getOrientation_matrixScalar

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

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

      Returns:
      the value.

    • setOrientation_matrixScalar

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

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

      Parameters:
      orientation_matrix - the orientation_matrix

    • getUb_matrix

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

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

      Returns:
      the value.

    • setUb_matrix

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

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

      Parameters:
      ub_matrixDataset - the ub_matrixDataset

    • getUb_matrixScalar

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

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

      Returns:
      the value.

    • setUb_matrixScalar

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

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

      Parameters:
      ub_matrix - the ub_matrix

    • getMass

      org.eclipse.january.dataset.Dataset getMass()
      Mass of sample

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

      Returns:
      the value.

    • setMass

      DataNode setMass(org.eclipse.january.dataset.IDataset massDataset)
      Mass of sample

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

      Parameters:
      massDataset - the massDataset

    • getMassScalar

      Double getMassScalar()
      Mass of sample

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

      Returns:
      the value.

    • setMassScalar

      DataNode setMassScalar(Double massValue)
      Mass of sample

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

      Parameters:
      mass - the mass

    • getDensity

      org.eclipse.january.dataset.Dataset getDensity()
      Density of sample

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

      Returns:
      the value.

    • setDensity

      DataNode setDensity(org.eclipse.january.dataset.IDataset densityDataset)
      Density of sample

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

      Parameters:
      densityDataset - the densityDataset

    • getDensityScalar

      Double getDensityScalar()
      Density of sample

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

      Returns:
      the value.

    • setDensityScalar

      DataNode setDensityScalar(Double densityValue)
      Density of sample

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

      Parameters:
      density - the density

    • getRelative_molecular_mass

      org.eclipse.january.dataset.Dataset getRelative_molecular_mass()
      Relative Molecular Mass of sample

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

      Returns:
      the value.

    • setRelative_molecular_mass

      DataNode setRelative_molecular_mass(org.eclipse.january.dataset.IDataset relative_molecular_massDataset)
      Relative Molecular Mass of sample

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

      Parameters:
      relative_molecular_massDataset - the relative_molecular_massDataset

    • getRelative_molecular_massScalar

      Double getRelative_molecular_massScalar()
      Relative Molecular Mass of sample

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

      Returns:
      the value.

    • setRelative_molecular_massScalar

      DataNode setRelative_molecular_massScalar(Double relative_molecular_massValue)
      Relative Molecular Mass of sample

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

      Parameters:
      relative_molecular_mass - the relative_molecular_mass

    • getType

      org.eclipse.january.dataset.Dataset getType()

      Enumeration:

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

      Returns:
      the value.

    • setType

      DataNode setType(org.eclipse.january.dataset.IDataset typeDataset)

      Enumeration:

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

      Parameters:
      typeDataset - the typeDataset

    • getTypeScalar

      String getTypeScalar()

      Enumeration:

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

      Returns:
      the value.

    • setTypeScalar

      DataNode setTypeScalar(String typeValue)

      Enumeration:

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

      Parameters:
      type - the type

    • getSituation

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

      Enumeration:

      • air
      • vacuum
      • inert atmosphere
      • oxidising atmosphere
      • reducing atmosphere
      • sealed can
      • other

      Returns:
      the value.

    • setSituation

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

      Enumeration:

      • air
      • vacuum
      • inert atmosphere
      • oxidising atmosphere
      • reducing atmosphere
      • sealed can
      • other

      Parameters:
      situationDataset - the situationDataset

    • getSituationScalar

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

      Enumeration:

      • air
      • vacuum
      • inert atmosphere
      • oxidising atmosphere
      • reducing atmosphere
      • sealed can
      • other

      Returns:
      the value.

    • setSituationScalar

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

      Enumeration:

      • air
      • vacuum
      • inert atmosphere
      • oxidising atmosphere
      • reducing atmosphere
      • sealed can
      • other

      Parameters:
      situation - the situation

    • getDescription

      org.eclipse.january.dataset.Dataset getDescription()
      Description of the sample
      Specified by:
      getDescription in interface NXcomponent
      Returns:
      the value.

    • setDescription

      DataNode setDescription(org.eclipse.january.dataset.IDataset descriptionDataset)
      Description of the sample
      Specified by:
      setDescription in interface NXcomponent
      Parameters:
      descriptionDataset - the descriptionDataset

    • getDescriptionScalar

      String getDescriptionScalar()
      Description of the sample
      Specified by:
      getDescriptionScalar in interface NXcomponent
      Returns:
      the value.

    • setDescriptionScalar

      DataNode setDescriptionScalar(String descriptionValue)
      Description of the sample
      Specified by:
      setDescriptionScalar in interface NXcomponent
      Parameters:
      description - the description

    • getPreparation_date

      org.eclipse.january.dataset.Dataset getPreparation_date()
      Date of preparation of the sample

      Type: NX_DATE_TIME

      Returns:
      the value.

    • setPreparation_date

      DataNode setPreparation_date(org.eclipse.january.dataset.IDataset preparation_dateDataset)
      Date of preparation of the sample

      Type: NX_DATE_TIME

      Parameters:
      preparation_dateDataset - the preparation_dateDataset

    • getPreparation_dateScalar

      Date getPreparation_dateScalar()
      Date of preparation of the sample

      Type: NX_DATE_TIME

      Returns:
      the value.

    • setPreparation_dateScalar

      DataNode setPreparation_dateScalar(Date preparation_dateValue)
      Date of preparation of the sample

      Type: NX_DATE_TIME

      Parameters:
      preparation_date - the preparation_date

    • getGeometry

      @Deprecated NXgeometry getGeometry()
      Deprecated.
      Use the field `depends_on` and :ref:`NXtransformations` to position the sample and NXoff_geometry to describe its shape instead
      The position and orientation of the center of mass of the sample
      Returns:
      the value.

    • setGeometry

      @Deprecated void setGeometry(NXgeometry geometryGroup)
      Deprecated.
      Use the field `depends_on` and :ref:`NXtransformations` to position the sample and NXoff_geometry to describe its shape instead
      The position and orientation of the center of mass of the sample
      Parameters:
      geometryGroup - the geometryGroup

    • getBeam

      NXbeam getBeam()
      Details of beam incident on sample - used to calculate sample/beam interaction point
      Returns:
      the value.

    • setBeam

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

    • getBeam

      NXbeam getBeam(String name)
      Get a NXbeam node by name:
      • Details of beam incident on sample - used to calculate sample/beam interaction point
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXbeam for that node.

    • setBeam

      void setBeam(String name, NXbeam beam)
      Set a NXbeam node by name:
      • Details of beam incident on sample - used to calculate sample/beam interaction point
      Parameters:
      name - the name of the node
      beam - the value to set

    • getAllBeam

      Map<String,NXbeam> getAllBeam()
      Get all NXbeam nodes:
      • Details of beam incident on sample - used to calculate sample/beam interaction point
      Returns:
      a map from node names to the NXbeam for that node.

    • setAllBeam

      void setAllBeam(Map<String,NXbeam> beam)
      Set multiple child nodes of a particular type.
      • Details of beam incident on sample - used to calculate sample/beam interaction point
      Parameters:
      beam - the child nodes to add

    • getSample_componentGroup

      NXsample_component getSample_componentGroup()
      One group per sample component This is the preferred way of recording per component information over the n_comp arrays
      Returns:
      the value.

    • setSample_componentGroup

      void setSample_componentGroup(NXsample_component sample_componentGroupGroup)
      One group per sample component This is the preferred way of recording per component information over the n_comp arrays
      Parameters:
      sample_componentGroupGroup - the sample_componentGroupGroup

    • getSample_componentGroup

      NXsample_component getSample_componentGroup(String name)
      Get a NXsample_component node by name:
      • One group per sample component This is the preferred way of recording per component information over the n_comp arrays
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXsample_component for that node.

    • setSample_componentGroup

      void setSample_componentGroup(String name, NXsample_component sample_componentGroup)
      Set a NXsample_component node by name:
      • One group per sample component This is the preferred way of recording per component information over the n_comp arrays
      Parameters:
      name - the name of the node
      sample_componentGroup - the value to set

    • getAllSample_componentGroup

      Map<String,NXsample_component> getAllSample_componentGroup()
      Get all NXsample_component nodes:
      • One group per sample component This is the preferred way of recording per component information over the n_comp arrays
      Returns:
      a map from node names to the NXsample_component for that node.

    • setAllSample_componentGroup

      void setAllSample_componentGroup(Map<String,NXsample_component> sample_componentGroup)
      Set multiple child nodes of a particular type.
      • One group per sample component This is the preferred way of recording per component information over the n_comp arrays
      Parameters:
      sample_componentGroup - the child nodes to add

    • getComponent

      org.eclipse.january.dataset.Dataset getComponent()
      Details of the component of the sample and/or can

      Dimensions: 1: n_comp;

      Returns:
      the value.

    • setComponent

      DataNode setComponent(org.eclipse.january.dataset.IDataset componentDataset)
      Details of the component of the sample and/or can

      Dimensions: 1: n_comp;

      Parameters:
      componentDataset - the componentDataset

    • getComponentScalar

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

      Dimensions: 1: n_comp;

      Returns:
      the value.

    • setComponentScalar

      DataNode setComponentScalar(String componentValue)
      Details of the component of the sample and/or can

      Dimensions: 1: n_comp;

      Parameters:
      component - the component

    • getSample_component

      org.eclipse.january.dataset.Dataset getSample_component()
      Type of component

      Dimensions: 1: n_comp;

      Enumeration:

      • sample
      • can
      • atmosphere
      • kit

      Returns:
      the value.

    • setSample_component

      DataNode setSample_component(org.eclipse.january.dataset.IDataset sample_componentDataset)
      Type of component

      Dimensions: 1: n_comp;

      Enumeration:

      • sample
      • can
      • atmosphere
      • kit

      Parameters:
      sample_componentDataset - the sample_componentDataset

    • getSample_componentScalar

      String getSample_componentScalar()
      Type of component

      Dimensions: 1: n_comp;

      Enumeration:

      • sample
      • can
      • atmosphere
      • kit

      Returns:
      the value.

    • setSample_componentScalar

      DataNode setSample_componentScalar(String sample_componentValue)
      Type of component

      Dimensions: 1: n_comp;

      Enumeration:

      • sample
      • can
      • atmosphere
      • kit

      Parameters:
      sample_component - the sample_component

    • getConcentration

      org.eclipse.january.dataset.Dataset getConcentration()
      Concentration of each component

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

      Returns:
      the value.

    • setConcentration

      DataNode setConcentration(org.eclipse.january.dataset.IDataset concentrationDataset)
      Concentration of each component

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

      Parameters:
      concentrationDataset - the concentrationDataset

    • getConcentrationScalar

      Double getConcentrationScalar()
      Concentration of each component

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

      Returns:
      the value.

    • setConcentrationScalar

      DataNode setConcentrationScalar(Double concentrationValue)
      Concentration of each component

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

      Parameters:
      concentration - the concentration

    • getVolume_fraction

      org.eclipse.january.dataset.Dataset getVolume_fraction()
      Volume fraction of each component

      Type: NX_FLOAT Dimensions: 1: n_comp;

      Returns:
      the value.

    • setVolume_fraction

      DataNode setVolume_fraction(org.eclipse.january.dataset.IDataset volume_fractionDataset)
      Volume fraction of each component

      Type: NX_FLOAT Dimensions: 1: n_comp;

      Parameters:
      volume_fractionDataset - the volume_fractionDataset

    • getVolume_fractionScalar

      Double getVolume_fractionScalar()
      Volume fraction of each component

      Type: NX_FLOAT Dimensions: 1: n_comp;

      Returns:
      the value.

    • setVolume_fractionScalar

      DataNode setVolume_fractionScalar(Double volume_fractionValue)
      Volume fraction of each component

      Type: NX_FLOAT Dimensions: 1: n_comp;

      Parameters:
      volume_fraction - the volume_fraction

    • getScattering_length_density

      org.eclipse.january.dataset.Dataset getScattering_length_density()
      Scattering length density of each component

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

      Returns:
      the value.

    • setScattering_length_density

      DataNode setScattering_length_density(org.eclipse.january.dataset.IDataset scattering_length_densityDataset)
      Scattering length density of each component

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

      Parameters:
      scattering_length_densityDataset - the scattering_length_densityDataset

    • getScattering_length_densityScalar

      Double getScattering_length_densityScalar()
      Scattering length density of each component

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

      Returns:
      the value.

    • setScattering_length_densityScalar

      DataNode setScattering_length_densityScalar(Double scattering_length_densityValue)
      Scattering length density of each component

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

      Parameters:
      scattering_length_density - the scattering_length_density

    • getUnit_cell_class

      org.eclipse.january.dataset.Dataset getUnit_cell_class()
      In case it is all we know and we want to record/document it

      Enumeration:

      • triclinic
      • monoclinic
      • orthorhombic
      • tetragonal
      • rhombohedral
      • hexagonal
      • cubic

      Returns:
      the value.

    • setUnit_cell_class

      DataNode setUnit_cell_class(org.eclipse.january.dataset.IDataset unit_cell_classDataset)
      In case it is all we know and we want to record/document it

      Enumeration:

      • triclinic
      • monoclinic
      • orthorhombic
      • tetragonal
      • rhombohedral
      • hexagonal
      • cubic

      Parameters:
      unit_cell_classDataset - the unit_cell_classDataset

    • getUnit_cell_classScalar

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

      Enumeration:

      • triclinic
      • monoclinic
      • orthorhombic
      • tetragonal
      • rhombohedral
      • hexagonal
      • cubic

      Returns:
      the value.

    • setUnit_cell_classScalar

      DataNode setUnit_cell_classScalar(String unit_cell_classValue)
      In case it is all we know and we want to record/document it

      Enumeration:

      • triclinic
      • monoclinic
      • orthorhombic
      • tetragonal
      • rhombohedral
      • hexagonal
      • cubic

      Parameters:
      unit_cell_class - the unit_cell_class

    • getSpace_group

      org.eclipse.january.dataset.Dataset getSpace_group()
      Crystallographic space group

      Dimensions: 1: n_comp;

      Returns:
      the value.

    • setSpace_group

      DataNode setSpace_group(org.eclipse.january.dataset.IDataset space_groupDataset)
      Crystallographic space group

      Dimensions: 1: n_comp;

      Parameters:
      space_groupDataset - the space_groupDataset

    • getSpace_groupScalar

      String getSpace_groupScalar()
      Crystallographic space group

      Dimensions: 1: n_comp;

      Returns:
      the value.

    • setSpace_groupScalar

      DataNode setSpace_groupScalar(String space_groupValue)
      Crystallographic space group

      Dimensions: 1: n_comp;

      Parameters:
      space_group - the space_group

    • getPoint_group

      org.eclipse.january.dataset.Dataset getPoint_group()
      Crystallographic point group, deprecated if space_group present

      Dimensions: 1: n_comp;

      Returns:
      the value.

    • setPoint_group

      DataNode setPoint_group(org.eclipse.january.dataset.IDataset point_groupDataset)
      Crystallographic point group, deprecated if space_group present

      Dimensions: 1: n_comp;

      Parameters:
      point_groupDataset - the point_groupDataset

    • getPoint_groupScalar

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

      Dimensions: 1: n_comp;

      Returns:
      the value.

    • setPoint_groupScalar

      DataNode setPoint_groupScalar(String point_groupValue)
      Crystallographic point group, deprecated if space_group present

      Dimensions: 1: n_comp;

      Parameters:
      point_group - the point_group

    • getPath_length

      org.eclipse.january.dataset.Dataset getPath_length()
      Path length through sample/can for simple case when it does not vary with scattering direction

      Type: NX_FLOAT Units: NX_LENGTH

      Returns:
      the value.

    • setPath_length

      DataNode setPath_length(org.eclipse.january.dataset.IDataset path_lengthDataset)
      Path length through sample/can for simple case when it does not vary with scattering direction

      Type: NX_FLOAT Units: NX_LENGTH

      Parameters:
      path_lengthDataset - the path_lengthDataset

    • getPath_lengthScalar

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

      Type: NX_FLOAT Units: NX_LENGTH

      Returns:
      the value.

    • setPath_lengthScalar

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

      Type: NX_FLOAT Units: NX_LENGTH

      Parameters:
      path_length - the path_length

    • getPath_length_window

      org.eclipse.january.dataset.Dataset getPath_length_window()
      Thickness of a beam entry/exit window on the can (mm) - assumed same for entry and exit

      Type: NX_FLOAT Units: NX_LENGTH

      Returns:
      the value.

    • setPath_length_window

      DataNode setPath_length_window(org.eclipse.january.dataset.IDataset path_length_windowDataset)
      Thickness of a beam entry/exit window on the can (mm) - assumed same for entry and exit

      Type: NX_FLOAT Units: NX_LENGTH

      Parameters:
      path_length_windowDataset - the path_length_windowDataset

    • getPath_length_windowScalar

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

      Type: NX_FLOAT Units: NX_LENGTH

      Returns:
      the value.

    • setPath_length_windowScalar

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

      Type: NX_FLOAT Units: NX_LENGTH

      Parameters:
      path_length_window - the path_length_window

    • getThickness

      org.eclipse.january.dataset.Dataset getThickness()
      sample thickness

      Type: NX_FLOAT Units: NX_LENGTH

      Returns:
      the value.

    • setThickness

      DataNode setThickness(org.eclipse.january.dataset.IDataset thicknessDataset)
      sample thickness

      Type: NX_FLOAT Units: NX_LENGTH

      Parameters:
      thicknessDataset - the thicknessDataset

    • getThicknessScalar

      Double getThicknessScalar()
      sample thickness

      Type: NX_FLOAT Units: NX_LENGTH

      Returns:
      the value.

    • setThicknessScalar

      DataNode setThicknessScalar(Double thicknessValue)
      sample thickness

      Type: NX_FLOAT Units: NX_LENGTH

      Parameters:
      thickness - the thickness

    • getTransmission

      NXdata getTransmission()
      As a function of Wavelength
      Returns:
      the value.

    • setTransmission

      void setTransmission(NXdata transmissionGroup)
      As a function of Wavelength
      Parameters:
      transmissionGroup - the transmissionGroup

    • getTemperature_log

      @Deprecated NXlog getTemperature_log()
      Deprecated.
      use ``temperature``, see: https://github.com/nexusformat/definitions/issues/816
      temperature_log.value is a link to e.g. temperature_env.sensor1.value_log.value
      Returns:
      the value.

    • setTemperature_log

      @Deprecated void setTemperature_log(NXlog temperature_logGroup)
      Deprecated.
      use ``temperature``, see: https://github.com/nexusformat/definitions/issues/816
      temperature_log.value is a link to e.g. temperature_env.sensor1.value_log.value
      Parameters:
      temperature_logGroup - the temperature_logGroup

    • getTemperature_env

      NXenvironment getTemperature_env()
      Additional sample temperature environment information
      Returns:
      the value.

    • setTemperature_env

      void setTemperature_env(NXenvironment temperature_envGroup)
      Additional sample temperature environment information
      Parameters:
      temperature_envGroup - the temperature_envGroup

    • getMagnetic_fieldLog

      NXlog getMagnetic_fieldLog()
      magnetic_field.value is a link to e.g. magnetic_field_env.sensor1.value
      Returns:
      the value.

    • setMagnetic_fieldLog

      void setMagnetic_fieldLog(NXlog magnetic_fieldLogGroup)
      magnetic_field.value is a link to e.g. magnetic_field_env.sensor1.value
      Parameters:
      magnetic_fieldLogGroup - the magnetic_fieldLogGroup

    • getMagnetic_field_log

      @Deprecated NXlog getMagnetic_field_log()
      Deprecated.
      use ``magnetic_field``, see: https://github.com/nexusformat/definitions/issues/816
      magnetic_field_log.value is a link to e.g. magnetic_field_env.sensor1.value_log.value
      Returns:
      the value.

    • setMagnetic_field_log

      @Deprecated void setMagnetic_field_log(NXlog magnetic_field_logGroup)
      Deprecated.
      use ``magnetic_field``, see: https://github.com/nexusformat/definitions/issues/816
      magnetic_field_log.value is a link to e.g. magnetic_field_env.sensor1.value_log.value
      Parameters:
      magnetic_field_logGroup - the magnetic_field_logGroup

    • getMagnetic_field_env

      NXenvironment getMagnetic_field_env()
      Additional sample magnetic environment information
      Returns:
      the value.

    • setMagnetic_field_env

      void setMagnetic_field_env(NXenvironment magnetic_field_envGroup)
      Additional sample magnetic environment information
      Parameters:
      magnetic_field_envGroup - the magnetic_field_envGroup

    • getExternal_dac

      org.eclipse.january.dataset.Dataset getExternal_dac()
      value sent to user's sample setup

      Type: NX_FLOAT Units: NX_ANY

      Returns:
      the value.

    • setExternal_dac

      DataNode setExternal_dac(org.eclipse.january.dataset.IDataset external_dacDataset)
      value sent to user's sample setup

      Type: NX_FLOAT Units: NX_ANY

      Parameters:
      external_dacDataset - the external_dacDataset

    • getExternal_dacScalar

      Double getExternal_dacScalar()
      value sent to user's sample setup

      Type: NX_FLOAT Units: NX_ANY

      Returns:
      the value.

    • setExternal_dacScalar

      DataNode setExternal_dacScalar(Double external_dacValue)
      value sent to user's sample setup

      Type: NX_FLOAT Units: NX_ANY

      Parameters:
      external_dac - the external_dac

    • getExternal_adc

      NXlog getExternal_adc()
      logged value (or logic state) read from user's setup
      Returns:
      the value.

    • setExternal_adc

      void setExternal_adc(NXlog external_adcGroup)
      logged value (or logic state) read from user's setup
      Parameters:
      external_adcGroup - the external_adcGroup

    • getShort_title

      org.eclipse.january.dataset.Dataset getShort_title()
      20 character fixed length sample description for legends
      Returns:
      the value.

    • setShort_title

      DataNode setShort_title(org.eclipse.january.dataset.IDataset short_titleDataset)
      20 character fixed length sample description for legends
      Parameters:
      short_titleDataset - the short_titleDataset

    • getShort_titleScalar

      String getShort_titleScalar()
      20 character fixed length sample description for legends
      Returns:
      the value.

    • setShort_titleScalar

      DataNode setShort_titleScalar(String short_titleValue)
      20 character fixed length sample description for legends
      Parameters:
      short_title - the short_title

    • getRotation_angle

      org.eclipse.january.dataset.Dataset 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. Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_ANGLE

      Returns:
      the value.

    • setRotation_angle

      DataNode setRotation_angle(org.eclipse.january.dataset.IDataset rotation_angleDataset)
      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. Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_ANGLE

      Parameters:
      rotation_angleDataset - the rotation_angleDataset

    • getRotation_angleScalar

      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. Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_ANGLE

      Returns:
      the value.

    • setRotation_angleScalar

      DataNode setRotation_angleScalar(Double rotation_angleValue)
      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. Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_ANGLE

      Parameters:
      rotation_angle - the rotation_angle

    • getX_translation

      org.eclipse.january.dataset.Dataset getX_translation()
      Translation of the sample along the X-direction of the laboratory coordinate system Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_LENGTH

      Returns:
      the value.

    • setX_translation

      DataNode setX_translation(org.eclipse.january.dataset.IDataset x_translationDataset)
      Translation of the sample along the X-direction of the laboratory coordinate system Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_LENGTH

      Parameters:
      x_translationDataset - the x_translationDataset

    • getX_translationScalar

      Double getX_translationScalar()
      Translation of the sample along the X-direction of the laboratory coordinate system Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_LENGTH

      Returns:
      the value.

    • setX_translationScalar

      DataNode setX_translationScalar(Double x_translationValue)
      Translation of the sample along the X-direction of the laboratory coordinate system Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_LENGTH

      Parameters:
      x_translation - the x_translation

    • getDistance

      org.eclipse.january.dataset.Dataset getDistance()
      Translation of the sample along the Z-direction of the laboratory coordinate system. Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_LENGTH

      Returns:
      the value.

    • setDistance

      DataNode setDistance(org.eclipse.january.dataset.IDataset distanceDataset)
      Translation of the sample along the Z-direction of the laboratory coordinate system. Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_LENGTH

      Parameters:
      distanceDataset - the distanceDataset

    • getDistanceScalar

      Double getDistanceScalar()
      Translation of the sample along the Z-direction of the laboratory coordinate system. Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_LENGTH

      Returns:
      the value.

    • setDistanceScalar

      DataNode setDistanceScalar(Double distanceValue)
      Translation of the sample along the Z-direction of the laboratory coordinate system. Note, it is recommended to use NXtransformations instead.

      Type: NX_FLOAT Units: NX_LENGTH

      Parameters:
      distance - the distance

    • getPositioner

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

    • setPositioner

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

    • getPositioner

      NXpositioner getPositioner(String name)
      Get a NXpositioner node by name:
      • Any positioner (motor, PZT, ...) used to locate the sample
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXpositioner for that node.

    • setPositioner

      void setPositioner(String name, NXpositioner positioner)
      Set a NXpositioner node by name:
      • Any positioner (motor, PZT, ...) used to locate the sample
      Parameters:
      name - the name of the node
      positioner - the value to set

    • getAllPositioner

      Map<String,NXpositioner> getAllPositioner()
      Get all NXpositioner nodes:
      • Any positioner (motor, PZT, ...) used to locate the sample
      Returns:
      a map from node names to the NXpositioner for that node.

    • setAllPositioner

      void setAllPositioner(Map<String,NXpositioner> positioner)
      Set multiple child nodes of a particular type.
      • Any positioner (motor, PZT, ...) used to locate the sample
      Parameters:
      positioner - the child nodes to add

    • getOff_geometry

      NXoff_geometry getOff_geometry()
      This group describes the shape of the sample
      Returns:
      the value.

    • setOff_geometry

      void setOff_geometry(NXoff_geometry off_geometryGroup)
      This group describes the shape of the sample
      Parameters:
      off_geometryGroup - the off_geometryGroup

    • getOff_geometry

      NXoff_geometry getOff_geometry(String name)
      Get a NXoff_geometry node by name:
      • This group describes the shape of the sample
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXoff_geometry for that node.

    • setOff_geometry

      void setOff_geometry(String name, NXoff_geometry off_geometry)
      Set a NXoff_geometry node by name:
      • This group describes the shape of the sample
      Parameters:
      name - the name of the node
      off_geometry - the value to set

    • getAllOff_geometry

      Map<String,NXoff_geometry> getAllOff_geometry()
      Get all NXoff_geometry nodes:
      • This group describes the shape of the sample
      Returns:
      a map from node names to the NXoff_geometry for that node.

    • setAllOff_geometry

      void setAllOff_geometry(Map<String,NXoff_geometry> off_geometry)
      Set multiple child nodes of a particular type.
      • This group describes the shape of the sample
      Parameters:
      off_geometry - the child nodes to add

    • getPhysical_form

      org.eclipse.january.dataset.Dataset getPhysical_form()
      Physical form of the sample material. Examples include single crystal, foil, pellet, powder, thin film, disc, foam, gas, liquid, amorphous.
      Returns:
      the value.

    • setPhysical_form

      DataNode setPhysical_form(org.eclipse.january.dataset.IDataset physical_formDataset)
      Physical form of the sample material. Examples include single crystal, foil, pellet, powder, thin film, disc, foam, gas, liquid, amorphous.
      Parameters:
      physical_formDataset - the physical_formDataset

    • getPhysical_formScalar

      String getPhysical_formScalar()
      Physical form of the sample material. Examples include single crystal, foil, pellet, powder, thin film, disc, foam, gas, liquid, amorphous.
      Returns:
      the value.

    • setPhysical_formScalar

      DataNode setPhysical_formScalar(String physical_formValue)
      Physical form of the sample material. Examples include single crystal, foil, pellet, powder, thin film, disc, foam, gas, liquid, amorphous.
      Parameters:
      physical_form - the physical_form

    • getEnvironment

      NXenvironment getEnvironment()
      Any environmental or external stimuli/measurements. These can include, among others: applied pressure, surrounding gas phase and gas pressure, external electric/magnetic/mechanical fields, temperature, ...
      Returns:
      the value.

    • setEnvironment

      void setEnvironment(NXenvironment environmentGroup)
      Any environmental or external stimuli/measurements. These can include, among others: applied pressure, surrounding gas phase and gas pressure, external electric/magnetic/mechanical fields, temperature, ...
      Parameters:
      environmentGroup - the environmentGroup

    • getEnvironment

      NXenvironment getEnvironment(String name)
      Get a NXenvironment node by name:
      • Additional sample temperature environment information
      • Additional sample magnetic environment information
      • Any environmental or external stimuli/measurements. These can include, among others: applied pressure, surrounding gas phase and gas pressure, external electric/magnetic/mechanical fields, temperature, ...
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXenvironment for that node.

    • setEnvironment

      void setEnvironment(String name, NXenvironment environment)
      Set a NXenvironment node by name:
      • Additional sample temperature environment information
      • Additional sample magnetic environment information
      • Any environmental or external stimuli/measurements. These can include, among others: applied pressure, surrounding gas phase and gas pressure, external electric/magnetic/mechanical fields, temperature, ...
      Parameters:
      name - the name of the node
      environment - the value to set

    • getAllEnvironment

      Map<String,NXenvironment> getAllEnvironment()
      Get all NXenvironment nodes:
      • Additional sample temperature environment information
      • Additional sample magnetic environment information
      • Any environmental or external stimuli/measurements. These can include, among others: applied pressure, surrounding gas phase and gas pressure, external electric/magnetic/mechanical fields, temperature, ...
      Returns:
      a map from node names to the NXenvironment for that node.

    • setAllEnvironment

      void setAllEnvironment(Map<String,NXenvironment> environment)
      Set multiple child nodes of a particular type.
      • Additional sample temperature environment information
      • Additional sample magnetic environment information
      • Any environmental or external stimuli/measurements. These can include, among others: applied pressure, surrounding gas phase and gas pressure, external electric/magnetic/mechanical fields, temperature, ...
      Parameters:
      environment - the child nodes to add

    • getHistory

      NXhistory getHistory()
      A set of physical processes that occurred to the sample prior/during experiment.
      Returns:
      the value.

    • setHistory

      void setHistory(NXhistory historyGroup)
      A set of physical processes that occurred to the sample prior/during experiment.
      Parameters:
      historyGroup - the historyGroup