.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXsample_component.nxdl.xml -- DO NOT EDIT .. index:: ! NXsample_component (base class) ! sample_component (base class) see: sample_component (base class); NXsample_component .. _NXsample_component: ================== NXsample_component ================== **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: One group like this per component can be recorded For a sample consisting of ... One group like this per component can be recorded For a sample consisting of multiple components. **Symbols**: symbolic array lengths to be coordinated between various fields **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:`NXdata`, :ref:`NXfabrication`, :ref:`NXhistory`, :ref:`NXsample_component_set`, :ref:`NXsingle_crystal`, :ref:`NXsubstance` .. index:: NXdata (base class); used in base class, NXsingle_crystal (base class); used in base class, NXsample_component_set (base class); used in base class, NXsubstance (base class); used in base class, NXfabrication (base class); used in base class, NXhistory (base class); used in base class **Structure**: .. _/NXsample_component@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. collapse:: Declares which child group contains a path leading ... .. 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_component/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` Descriptive name of sample component .. _/NXsample_component/sample_id-field: .. index:: sample_id (field) **sample_id**: (optional) :ref:`NX_CHAR ` Identification number or signatures of the sample component used. .. _/NXsample_component/chemical_formula-field: .. index:: chemical_formula (field) **chemical_formula**: (optional) :ref:`NX_CHAR ` .. collapse:: The chemical formula specified using CIF conventions. ... 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_component/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_component/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_component/unit_cell_volume-field: .. index:: unit_cell_volume (field) **unit_cell_volume**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_VOLUME `} Volume of the unit cell .. _/NXsample_component/sample_orientation-field: .. index:: sample_orientation (field) **sample_orientation**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_ANGLE `} .. collapse:: This will follow the Busing and Levy convention from Acta.Crysta v22, p457 ... This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967) .. _/NXsample_component/orientation_matrix-field: .. index:: orientation_matrix (field) **orientation_matrix**: (optional) :ref:`NX_FLOAT ` (Rank: 2, Dimensions: [3, 3]) .. collapse:: Orientation matrix of single crystal sample component. ... Orientation matrix of single crystal sample component. This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967) .. _/NXsample_component/mass-field: .. index:: mass (field) **mass**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_MASS `} Mass of sample component .. _/NXsample_component/density-field: .. index:: density (field) **density**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_MASS_DENSITY `} Density of sample component .. _/NXsample_component/relative_molecular_mass-field: .. index:: relative_molecular_mass (field) **relative_molecular_mass**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_MASS `} Relative Molecular Mass of sample component .. _/NXsample_component/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` Description of the sample component .. _/NXsample_component/volume_fraction-field: .. index:: volume_fraction (field) **volume_fraction**: (optional) :ref:`NX_FLOAT ` Volume fraction of component .. _/NXsample_component/scattering_length_density-field: .. index:: scattering_length_density (field) **scattering_length_density**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_SCATTERING_LENGTH_DENSITY `} Scattering length density of component .. _/NXsample_component/unit_cell_class-field: .. index:: unit_cell_class (field) **unit_cell_class**: (optional) :ref:`NX_CHAR ` .. collapse:: In case it is all we know and we want to record/document it ... 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_component/space_group-field: .. index:: space_group (field) **space_group**: (optional) :ref:`NX_CHAR ` Crystallographic space group .. _/NXsample_component/point_group-field: .. index:: point_group (field) **point_group**: (optional) :ref:`NX_CHAR ` Crystallographic point group, deprecated if space_group present .. _/NXsample_component/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` .. collapse:: Any NXsample_component depends on the instance of NXsample_component_set, at t ... Any NXsample_component depends on the instance of NXsample_component_set, at the same level of description granularity where the component is located. .. _/NXsample_component/transmission-group: **transmission**: (optional) :ref:`NXdata` As a function of Wavelength .. _/NXsample_component/SINGLE_CRYSTAL-group: **SINGLE_CRYSTAL**: (optional) :ref:`NXsingle_crystal` .. collapse:: If the component is a single crystal, add description of single crystal and un ... If the component is a single crystal, add description of single crystal and unit cell. .. _/NXsample_component/SAMPLE_COMPONENT_SET-group: **SAMPLE_COMPONENT_SET**: (optional) :ref:`NXsample_component_set` .. collapse:: Set of sub-components and their configuration. ... Set of sub-components and their configuration. There can only be one NXsample_component_set in one component. .. _/NXsample_component/SUBSTANCE-group: **SUBSTANCE**: (optional) :ref:`NXsubstance` .. collapse:: If the component is made from a pure substance and cannot be further divided ... If the component is made from a pure substance and cannot be further divided using NXsample_component. .. _/NXsample_component/FABRICATION-group: **FABRICATION**: (optional) :ref:`NXfabrication` Details about the sample component vendor (company or research group) .. _/NXsample_component/history-group: **history**: (optional) :ref:`NXhistory` .. collapse:: A set of physical processes that occurred to the sample component prior/during ... A set of physical processes that occurred to the sample component prior/during experiment. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXsample_component/chemical_formula-field ` * :ref:`/NXsample_component/density-field ` * :ref:`/NXsample_component/depends_on-field ` * :ref:`/NXsample_component/description-field ` * :ref:`/NXsample_component/FABRICATION-group ` * :ref:`/NXsample_component/history-group ` * :ref:`/NXsample_component/mass-field ` * :ref:`/NXsample_component/name-field ` * :ref:`/NXsample_component/orientation_matrix-field ` * :ref:`/NXsample_component/point_group-field ` * :ref:`/NXsample_component/relative_molecular_mass-field ` * :ref:`/NXsample_component/SAMPLE_COMPONENT_SET-group ` * :ref:`/NXsample_component/sample_id-field ` * :ref:`/NXsample_component/sample_orientation-field ` * :ref:`/NXsample_component/scattering_length_density-field ` * :ref:`/NXsample_component/SINGLE_CRYSTAL-group ` * :ref:`/NXsample_component/space_group-field ` * :ref:`/NXsample_component/SUBSTANCE-group ` * :ref:`/NXsample_component/transmission-group ` * :ref:`/NXsample_component/unit_cell_abc-field ` * :ref:`/NXsample_component/unit_cell_alphabetagamma-field ` * :ref:`/NXsample_component/unit_cell_class-field ` * :ref:`/NXsample_component/unit_cell_volume-field ` * :ref:`/NXsample_component/volume_fraction-field ` * :ref:`/NXsample_component@default-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXsample_component.nxdl.xml