.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXsample.nxdl.xml .. index:: ! NXsample (base class) ! sample (base class) see: sample (base class); NXsample .. _NXsample: ======== NXsample ======== **Status**: base class, extends :ref:`NXobject` **Description**: 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 **Groups cited**: :ref:`NXbeam`, :ref:`NXdata`, :ref:`NXenvironment`, :ref:`NXgeometry`, :ref:`NXlog`, :ref:`NXnote`, :ref:`NXpositioner`, :ref:`NXsample_component`, :ref:`NXtransformations` .. index:: NXgeometry (base class); used in base class, NXbeam (base class); used in base class, NXsample_component (base class); used in base class, NXnote (base class); used in base class, NXdata (base class); used in base class, NXlog (base class); used in base class, NXenvironment (base class); used in base class, NXpositioner (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXsample@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. index:: plotting Declares which child group contains a path leading to a :ref:`NXdata` group. It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion. .. _/NXsample/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` Descriptive name of sample .. _/NXsample/chemical_formula-field: .. index:: chemical_formula (field) **chemical_formula**: (optional) :ref:`NX_CHAR ` 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. .. _/NXsample/temperature-field: .. index:: temperature (field) **temperature**: (optional) :ref:`NX_FLOAT ` (Rank: anyRank, Dimensions: [n_Temp]) {units=\ :ref:`NX_TEMPERATURE `} Sample temperature. This could be a scanned variable .. _/NXsample/electric_field-field: .. index:: electric_field (field) **electric_field**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_eField]) {units=\ :ref:`NX_VOLTAGE `} Applied electric field .. _/NXsample/electric_field@direction-attribute: .. index:: direction (field attribute) **@direction**: (optional) :ref:`NX_CHAR ` Any of these values: ``x`` | ``y`` | ``z`` .. _/NXsample/magnetic_field-field: .. index:: magnetic_field (field) **magnetic_field**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_mField]) {units=\ :ref:`NX_ANY `} Applied magnetic field .. _/NXsample/magnetic_field@direction-attribute: .. index:: direction (field attribute) **@direction**: (optional) :ref:`NX_CHAR ` Any of these values: ``x`` | ``y`` | ``z`` .. _/NXsample/stress_field-field: .. index:: stress_field (field) **stress_field**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_sField]) {units=\ :ref:`NX_ANY `} Applied external stress field .. _/NXsample/stress_field@direction-attribute: .. index:: direction (field attribute) **@direction**: (optional) :ref:`NX_CHAR ` Any of these values: ``x`` | ``y`` | ``z`` .. _/NXsample/pressure-field: .. index:: pressure (field) **pressure**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_pField]) {units=\ :ref:`NX_PRESSURE `} Applied pressure .. _/NXsample/changer_position-field: .. index:: changer_position (field) **changer_position**: (optional) :ref:`NX_INT ` {units=\ :ref:`NX_UNITLESS `} Sample changer position .. _/NXsample/unit_cell_abc-field: .. index:: unit_cell_abc (field) **unit_cell_abc**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_LENGTH `} Crystallography unit cell parameters a, b, and c .. _/NXsample/unit_cell_alphabetagamma-field: .. index:: unit_cell_alphabetagamma (field) **unit_cell_alphabetagamma**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_ANGLE `} Crystallography unit cell parameters alpha, beta, and gamma .. _/NXsample/unit_cell-field: .. index:: unit_cell (field) **unit_cell**: (optional) :ref:`NX_FLOAT ` (Rank: 2, Dimensions: [n_comp, 6]) {units=\ :ref:`NX_LENGTH `} Unit cell parameters (lengths and angles) .. _/NXsample/unit_cell_volume-field: .. index:: unit_cell_volume (field) **unit_cell_volume**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_VOLUME `} Volume of the unit cell .. _/NXsample/sample_orientation-field: .. index:: sample_orientation (field) **sample_orientation**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_ANGLE `} This will follow the Busing-Levy convention: W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464 .. _/NXsample/orientation_matrix-field: .. index:: orientation_matrix (field) **orientation_matrix**: (optional) :ref:`NX_FLOAT ` (Rank: 3, Dimensions: [n_comp, 3, 3]) Orientation matrix of single crystal sample using Busing-Levy convention: W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464 .. _/NXsample/ub_matrix-field: .. index:: ub_matrix (field) **ub_matrix**: (optional) :ref:`NX_FLOAT ` (Rank: 3, Dimensions: [n_comp, 3, 3]) 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. .. _/NXsample/mass-field: .. index:: mass (field) **mass**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_MASS `} Mass of sample .. _/NXsample/density-field: .. index:: density (field) **density**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_MASS_DENSITY `} Density of sample .. _/NXsample/relative_molecular_mass-field: .. index:: relative_molecular_mass (field) **relative_molecular_mass**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_MASS `} Relative Molecular Mass of sample .. _/NXsample/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` Any of these values: * ``sample`` * ``sample+can`` * ``can`` * ``sample+buffer`` * ``buffer`` * ``calibration sample`` * ``normalisation sample`` * ``simulated data`` * ``none`` * ``sample environment`` .. _/NXsample/situation-field: .. index:: situation (field) **situation**: (optional) :ref:`NX_CHAR ` 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. Any of these values: * ``air`` * ``vacuum`` * ``inert atmosphere`` * ``oxidising atmosphere`` * ``reducing atmosphere`` * ``sealed can`` * ``other`` .. _/NXsample/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` Description of the sample .. _/NXsample/preparation_date-field: .. index:: preparation_date (field) **preparation_date**: (optional) :ref:`NX_DATE_TIME ` Date of preparation of the sample .. _/NXsample/component-field: .. index:: component (field) **component**: (optional) :ref:`NX_CHAR ` (Rank: 1, Dimensions: [n_comp]) Details of the component of the sample and/or can .. _/NXsample/sample_component-field: .. index:: sample_component (field) **sample_component**: (optional) :ref:`NX_CHAR ` (Rank: 1, Dimensions: [n_comp]) Type of component Any of these values: ``sample`` | ``can`` | ``atmosphere`` | ``kit`` .. _/NXsample/concentration-field: .. index:: concentration (field) **concentration**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_MASS_DENSITY `} Concentration of each component .. _/NXsample/volume_fraction-field: .. index:: volume_fraction (field) **volume_fraction**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_comp]) Volume fraction of each component .. _/NXsample/scattering_length_density-field: .. index:: scattering_length_density (field) **scattering_length_density**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_comp]) {units=\ :ref:`NX_SCATTERING_LENGTH_DENSITY `} Scattering length density of each component .. _/NXsample/unit_cell_class-field: .. index:: unit_cell_class (field) **unit_cell_class**: (optional) :ref:`NX_CHAR ` In case it is all we know and we want to record/document it Any of these values: * ``triclinic`` * ``monoclinic`` * ``orthorhombic`` * ``tetragonal`` * ``rhombohedral`` * ``hexagonal`` * ``cubic`` .. _/NXsample/space_group-field: .. index:: space_group (field) **space_group**: (optional) :ref:`NX_CHAR ` (Rank: 1, Dimensions: [n_comp]) Crystallographic space group .. _/NXsample/point_group-field: .. index:: point_group (field) **point_group**: (optional) :ref:`NX_CHAR ` (Rank: 1, Dimensions: [n_comp]) Crystallographic point group, deprecated if space_group present .. _/NXsample/path_length-field: .. index:: path_length (field) **path_length**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Path length through sample/can for simple case when it does not vary with scattering direction .. _/NXsample/path_length_window-field: .. index:: path_length_window (field) **path_length_window**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Thickness of a beam entry/exit window on the can (mm). It is assumed to be the same for entry and exit .. _/NXsample/thickness-field: .. index:: thickness (field) **thickness**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} sample thickness .. _/NXsample/sample_id-field: .. index:: sample_id (field) **sample_id**: (optional) :ref:`NX_CHAR ` Identification number or signatures of the sample used. .. _/NXsample/state-field: .. index:: state (field) **state**: (optional) :ref:`NX_CHAR ` Physical state of the sample .. _/NXsample/purity-field: .. index:: purity (field) **purity**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_UNITLESS `} Chemical purity of the sample .. _/NXsample/orientation-field: .. index:: orientation (field) **orientation**: (optional) :ref:`NX_CHAR ` Surface termination of the sample (if crystalline) .. _/NXsample/layer-field: .. index:: layer (field) **layer**: (optional) :ref:`NX_CHAR ` Number of layers of the sample (e.g. bulk, monolayer, pentalayer, etc.) .. _/NXsample/chemical_name-field: .. index:: chemical_name (field) **chemical_name**: (optional) :ref:`NX_CHAR ` Full chemical name of the sample .. _/NXsample/chem_id_cas-field: .. index:: chem_id_cas (field) **chem_id_cas**: (optional) :ref:`NX_CHAR ` CAS registry number of the sample chemical content. .. _/NXsample/gas-field: .. index:: gas (field) **gas**: (optional) :ref:`NX_CHAR ` Gases might be fluxed on the surface for various reasons. Chemical designation, or residual. .. _/NXsample/gas_pressure-field: .. index:: gas_pressure (field) **gas_pressure**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_PRESSURE `} In the case of a fixed pressure measurement this is the scalar pressure. In the case of an experiment in which pressure changes, or anyway is recorded, this is an array of length m of pressures. .. _/NXsample/surface_dopant-field: .. index:: surface_dopant (field) **surface_dopant**: (optional) :ref:`NX_CHAR ` Element of evaporated surface dopant such as alkali or other .. _/NXsample/surface_dopant_coverage-field: .. index:: surface_dopant_coverage (field) **surface_dopant_coverage**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Nominal thickness of the evaporated dopant .. _/NXsample/bias-field: .. index:: bias (field) **bias**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_VOLTAGE `} Voltage applied to sample and sample holder. .. _/NXsample/growth_method-field: .. index:: growth_method (field) **growth_method**: (optional) :ref:`NX_CHAR ` Sample growth method (e. g. molecular beam epitaxy, chemical vapor deposition etc.) .. _/NXsample/vendor-field: .. index:: vendor (field) **vendor**: (optional) :ref:`NX_CHAR ` Name of the sample vendor (company or research group) .. _/NXsample/substrate_material-field: .. index:: substrate_material (field) **substrate_material**: (optional) :ref:`NX_CHAR ` Material of the substrate in direct contact with the sample. .. _/NXsample/substrate_state-field: .. index:: substrate_state (field) **substrate_state**: (optional) :ref:`NX_CHAR ` Physical state of the substrate, similar options to sample_state .. _/NXsample/drain_current-field: .. index:: drain_current (field) **drain_current**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_CURRENT `} Current to neutralize the photoemission current. This field may also be found in NXmanpulator if present. .. _/NXsample/bias_voltage-field: .. index:: bias_voltage (field) **bias_voltage**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_VOLTAGE `} Possible bias of the sample with respect to analyser ground. This field may also be found as sample_bias in NXmanipulator if present. .. _/NXsample/external_DAC-field: .. index:: external_DAC (field) **external_DAC**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} value sent to user's sample setup .. _/NXsample/short_title-field: .. index:: short_title (field) **short_title**: (optional) :ref:`NX_CHAR ` 20 character fixed length sample description for legends .. _/NXsample/rotation_angle-field: .. index:: rotation_angle (field) **rotation_angle**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_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 .. _/NXsample/x_translation-field: .. index:: x_translation (field) **x_translation**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Translation of the sample along the X-direction of the laboratory coordinate system .. _/NXsample/distance-field: .. index:: distance (field) **distance**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Translation of the sample along the Z-direction of the laboratory coordinate system .. _/NXsample/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` Refers to the last transformation specifying the positon of the manipulator in the NXtransformations chain. .. _/NXsample/geometry-group: **geometry**: (optional) :ref:`NXgeometry` The position and orientation of the center of mass of the sample .. _/NXsample/BEAM-group: **BEAM**: (optional) :ref:`NXbeam` Details of beam incident on sample - used to calculate sample/beam interaction point .. _/NXsample/SAMPLE_COMPONENT-group: **SAMPLE_COMPONENT**: (optional) :ref:`NXsample_component` One group per sample component This is the perferred way of recording per component information over the n_comp arrays .. _/NXsample/sample_history-group: **sample_history**: (optional) :ref:`NXnote` A descriptor to keep track of the treatment of the sample before entering the photoemission experiment. Ideally, a full report of the previous operations, in any format (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description .. _/NXsample/notes-group: **notes**: (optional) :ref:`NXnote` Further notes. .. _/NXsample/transmission-group: **transmission**: (optional) :ref:`NXdata` As a function of Wavelength .. _/NXsample/temperature-group: **temperature**: (optional) :ref:`NXlog` temperature.value is a link to e.g. temperature_env.sensor1.value .. _/NXsample/temperature_log-group: **temperature_log**: (optional) :ref:`NXlog` temperature_log.value is a link to e.g. temperature_env.sensor1.value_log.value .. _/NXsample/temperature_env-group: **temperature_env**: (optional) :ref:`NXenvironment` Additional sample temperature environment information .. _/NXsample/magnetic_field-group: **magnetic_field**: (optional) :ref:`NXlog` magnetic_field.value is a link to e.g. magnetic_field_env.sensor1.value .. _/NXsample/magnetic_field_log-group: **magnetic_field_log**: (optional) :ref:`NXlog` magnetic_field_log.value is a link to e.g. magnetic_field_env.sensor1.value_log.value .. _/NXsample/magnetic_field_env-group: **magnetic_field_env**: (optional) :ref:`NXenvironment` Additional sample magnetic environment information .. _/NXsample/external_ADC-group: **external_ADC**: (optional) :ref:`NXlog` logged value (or logic state) read from user's setup .. _/NXsample/POSITIONER-group: **POSITIONER**: (optional) :ref:`NXpositioner` Any positioner (motor, PZT, ...) used to locate the sample .. _/NXsample/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` Collection of axis-based translations and rotations to describe the location and geometry of the manipulator as a component in the instrument. Conventions from the NXtransformations base class are used. In principle, the McStas coordinate system is used. The first transformation has to point either to another component of the system or . (for pointing to the reference frame) to relate it relative to the experimental setup. Typically, the components of a system should all be related relative to each other and only one component should relate to the reference coordinate system. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXsample/BEAM-group ` * :ref:`/NXsample/bias-field ` * :ref:`/NXsample/bias_voltage-field ` * :ref:`/NXsample/changer_position-field ` * :ref:`/NXsample/chem_id_cas-field ` * :ref:`/NXsample/chemical_formula-field ` * :ref:`/NXsample/chemical_name-field ` * :ref:`/NXsample/component-field ` * :ref:`/NXsample/concentration-field ` * :ref:`/NXsample/density-field ` * :ref:`/NXsample/depends_on-field ` * :ref:`/NXsample/description-field ` * :ref:`/NXsample/distance-field ` * :ref:`/NXsample/drain_current-field ` * :ref:`/NXsample/electric_field-field ` * :ref:`/NXsample/electric_field@direction-attribute ` * :ref:`/NXsample/external_ADC-group ` * :ref:`/NXsample/external_DAC-field ` * :ref:`/NXsample/gas-field ` * :ref:`/NXsample/gas_pressure-field ` * :ref:`/NXsample/geometry-group ` * :ref:`/NXsample/growth_method-field ` * :ref:`/NXsample/layer-field ` * :ref:`/NXsample/magnetic_field-field ` * :ref:`/NXsample/magnetic_field-group ` * :ref:`/NXsample/magnetic_field@direction-attribute ` * :ref:`/NXsample/magnetic_field_env-group ` * :ref:`/NXsample/magnetic_field_log-group ` * :ref:`/NXsample/mass-field ` * :ref:`/NXsample/name-field ` * :ref:`/NXsample/notes-group ` * :ref:`/NXsample/orientation-field ` * :ref:`/NXsample/orientation_matrix-field ` * :ref:`/NXsample/path_length-field ` * :ref:`/NXsample/path_length_window-field ` * :ref:`/NXsample/point_group-field ` * :ref:`/NXsample/POSITIONER-group ` * :ref:`/NXsample/preparation_date-field ` * :ref:`/NXsample/pressure-field ` * :ref:`/NXsample/purity-field ` * :ref:`/NXsample/relative_molecular_mass-field ` * :ref:`/NXsample/rotation_angle-field ` * :ref:`/NXsample/sample_component-field ` * :ref:`/NXsample/SAMPLE_COMPONENT-group ` * :ref:`/NXsample/sample_history-group ` * :ref:`/NXsample/sample_id-field ` * :ref:`/NXsample/sample_orientation-field ` * :ref:`/NXsample/scattering_length_density-field ` * :ref:`/NXsample/short_title-field ` * :ref:`/NXsample/situation-field ` * :ref:`/NXsample/space_group-field ` * :ref:`/NXsample/state-field ` * :ref:`/NXsample/stress_field-field ` * :ref:`/NXsample/stress_field@direction-attribute ` * :ref:`/NXsample/substrate_material-field ` * :ref:`/NXsample/substrate_state-field ` * :ref:`/NXsample/surface_dopant-field ` * :ref:`/NXsample/surface_dopant_coverage-field ` * :ref:`/NXsample/temperature-field ` * :ref:`/NXsample/temperature-group ` * :ref:`/NXsample/temperature_env-group ` * :ref:`/NXsample/temperature_log-group ` * :ref:`/NXsample/thickness-field ` * :ref:`/NXsample/TRANSFORMATIONS-group ` * :ref:`/NXsample/transmission-group ` * :ref:`/NXsample/type-field ` * :ref:`/NXsample/ub_matrix-field ` * :ref:`/NXsample/unit_cell-field ` * :ref:`/NXsample/unit_cell_abc-field ` * :ref:`/NXsample/unit_cell_alphabetagamma-field ` * :ref:`/NXsample/unit_cell_class-field ` * :ref:`/NXsample/unit_cell_volume-field ` * :ref:`/NXsample/vendor-field ` * :ref:`/NXsample/volume_fraction-field ` * :ref:`/NXsample/x_translation-field ` * :ref:`/NXsample@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXsample.nxdl.xml