.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXfilter.nxdl.xml -- DO NOT EDIT .. index:: ! NXfilter (base class) ! filter (base class) see: filter (base class); NXfilter .. _NXfilter: ======== NXfilter ======== .. Contributors List .. |contrib_name| replace:: Aaron Brewster|phyy-nx|https://avatars.githubusercontent.com/u/13471434?v=4|2022-06-15 .. |contrib_name| replace:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2022-03-07 .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 .. |contrib_name| replace:: Joachim Wuttke (l)|jwuttke|https://avatars.githubusercontent.com/u/5262000?v=4|2014-08-26 **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: For band pass beam filters. ... For band pass beam filters. If uncertain whether to use :ref:`NXfilter` (band-pass filter) or :ref:`NXattenuator` (reduces beam intensity), then use :ref:`NXattenuator`. **Symbols**: No symbol table **Groups cited**: :ref:`NXdata`, :ref:`NXgeometry`, :ref:`NXlog`, :ref:`NXoff_geometry`, :ref:`NXsensor`, :ref:`NXtransformations` .. index:: NXgeometry (base class); used in base class, NXdata (base class); used in base class, NXlog (base class); used in base class, NXsensor (base class); used in base class, NXoff_geometry (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXfilter@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. .. _/NXfilter/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` .. collapse:: Composition of the filter. Chemical formula can be specified separately. ... Composition of the filter. Chemical formula can be specified separately. This field was changed (2010-11-17) from an enumeration to a string since common usage showed a wider variety of use than a simple list. These are the items in the list at the time of the change: Beryllium | Pyrolytic Graphite | Graphite | Sapphire | Silicon | Supermirror. .. _/NXfilter/status-field: .. index:: status (field) **status**: (optional) :ref:`NX_CHAR ` .. collapse:: position with respect to in or out of the beam (choice of only "in" or "out") ... position with respect to in or out of the beam (choice of only "in" or "out") Any of these values: * ``in``: in the beam * ``out``: out of the beam .. _/NXfilter/temperature-field: .. index:: temperature (field) **temperature**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TEMPERATURE `} average/nominal filter temperature .. _/NXfilter/thickness-field: .. index:: thickness (field) **thickness**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Thickness of the filter .. _/NXfilter/density-field: .. index:: density (field) **density**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_MASS_DENSITY `} mass density of the filter .. _/NXfilter/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. .. _/NXfilter/unit_cell_a-field: .. index:: unit_cell_a (field) **unit_cell_a**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Unit cell lattice parameter: length of side a .. _/NXfilter/unit_cell_b-field: .. index:: unit_cell_b (field) **unit_cell_b**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Unit cell lattice parameter: length of side b .. _/NXfilter/unit_cell_c-field: .. index:: unit_cell_c (field) **unit_cell_c**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Unit cell lattice parameter: length of side c .. _/NXfilter/unit_cell_alpha-field: .. index:: unit_cell_alpha (field) **unit_cell_alpha**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Unit cell lattice parameter: angle alpha .. _/NXfilter/unit_cell_beta-field: .. index:: unit_cell_beta (field) **unit_cell_beta**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Unit cell lattice parameter: angle beta .. _/NXfilter/unit_cell_gamma-field: .. index:: unit_cell_gamma (field) **unit_cell_gamma**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Unit cell lattice parameter: angle gamma .. _/NXfilter/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 `} Unit cell .. _/NXfilter/orientation_matrix-field: .. index:: orientation_matrix (field) **orientation_matrix**: (optional) :ref:`NX_FLOAT ` (Rank: 3, Dimensions: [n_comp, 3, 3]) .. collapse:: Orientation matrix of single crystal filter using Busing-Levy convention: ... Orientation matrix of single crystal filter using Busing-Levy convention: W. R. Busing and H. A. Levy (1967). Acta Cryst. 22, 457-464 .. _/NXfilter/m_value-field: .. index:: m_value (field) **m_value**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_DIMENSIONLESS `} m value of supermirror filter .. _/NXfilter/substrate_material-field: .. index:: substrate_material (field) **substrate_material**: (optional) :ref:`NX_CHAR ` substrate material of supermirror filter .. _/NXfilter/substrate_thickness-field: .. index:: substrate_thickness (field) **substrate_thickness**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} substrate thickness of supermirror filter .. _/NXfilter/coating_material-field: .. index:: coating_material (field) **coating_material**: (optional) :ref:`NX_CHAR ` coating material of supermirror filter .. _/NXfilter/substrate_roughness-field: .. index:: substrate_roughness (field) **substrate_roughness**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} substrate roughness (RMS) of supermirror filter .. _/NXfilter/coating_roughness-field: .. index:: coating_roughness (field) **coating_roughness**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nsurf]) {units=\ :ref:`NX_LENGTH `} coating roughness (RMS) of supermirror filter .. _/NXfilter/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` .. collapse:: NeXus positions components by applying a set of translations and rotations ... NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere. .. todo:: Add a definition for the reference point of a filter. .. _/NXfilter/GEOMETRY-group: **GEOMETRY**: (optional) :ref:`NXgeometry` .. index:: deprecated **DEPRECATED**: Use the field `depends_on` and :ref:`NXtransformations` to filter the beamstop and NXoff_geometry to describe its shape instead Geometry of the filter .. _/NXfilter/transmission-group: **transmission**: (optional) :ref:`NXdata` Wavelength transmission profile of filter .. _/NXfilter/temperature_log-group: **temperature_log**: (optional) :ref:`NXlog` Linked temperature_log for the filter .. _/NXfilter/sensor_type-group: **sensor_type**: (optional) :ref:`NXsensor` Sensor(s)used to monitor the filter temperature .. _/NXfilter/OFF_GEOMETRY-group: **OFF_GEOMETRY**: (optional) :ref:`NXoff_geometry` This group describes the shape of the beam line component .. _/NXfilter/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` .. collapse:: This is the group recommended for holding the chain of translation ... This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXfilter/chemical_formula-field ` * :ref:`/NXfilter/coating_material-field ` * :ref:`/NXfilter/coating_roughness-field ` * :ref:`/NXfilter/density-field ` * :ref:`/NXfilter/depends_on-field ` * :ref:`/NXfilter/description-field ` * :ref:`/NXfilter/GEOMETRY-group ` * :ref:`/NXfilter/m_value-field ` * :ref:`/NXfilter/OFF_GEOMETRY-group ` * :ref:`/NXfilter/orientation_matrix-field ` * :ref:`/NXfilter/sensor_type-group ` * :ref:`/NXfilter/status-field ` * :ref:`/NXfilter/substrate_material-field ` * :ref:`/NXfilter/substrate_roughness-field ` * :ref:`/NXfilter/substrate_thickness-field ` * :ref:`/NXfilter/temperature-field ` * :ref:`/NXfilter/temperature_log-group ` * :ref:`/NXfilter/thickness-field ` * :ref:`/NXfilter/TRANSFORMATIONS-group ` * :ref:`/NXfilter/transmission-group ` * :ref:`/NXfilter/unit_cell_a-field ` * :ref:`/NXfilter/unit_cell_alpha-field ` * :ref:`/NXfilter/unit_cell_b-field ` * :ref:`/NXfilter/unit_cell_beta-field ` * :ref:`/NXfilter/unit_cell_c-field ` * :ref:`/NXfilter/unit_cell_gamma-field ` * :ref:`/NXfilter/unit_cell_volume-field ` * :ref:`/NXfilter@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXfilter.nxdl.xml