.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXdetector_module.nxdl.xml -- DO NOT EDIT .. index:: ! NXdetector_module (base class) ! detector_module (base class) see: detector_module (base class); NXdetector_module .. _NXdetector_module: ================= NXdetector_module ================= .. Contributors List .. |contrib_name| replace:: Aaron Brewster|phyy-nx|https://avatars.githubusercontent.com/u/13471434?v=4|2022-06-15 .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2020-10-20 .. |contrib_name| replace:: Herbert J. Bernstein|yayahjb|https://avatars.githubusercontent.com/u/4448769?v=4|2020-01-27 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 .. |contrib_name| replace:: Freddie Akeroyd|FreddieAkeroyd|https://avatars.githubusercontent.com/u/1132753?v=4|2015-11-22 **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: Geometry and logical description of a detector module. When used, child group to ... Geometry and logical description of a detector module. When used, child group to NXdetector. Many detectors consist of multiple smaller modules. Sometimes it is important to know the exact position of such modules. This is the purpose of this group. It is a child group to NXdetector. Note, the pixel size is given as values in the array fast_pixel_direction and slow_pixel_direction. **Symbols**: No symbol table **Groups cited**: none **Structure**: .. _/NXdetector_module@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. .. _/NXdetector_module/data_origin-field: .. index:: data_origin (field) **data_origin**: (optional) :ref:`NX_INT ` .. collapse:: A dimension-2 or dimension-3 field which gives the indices ... A dimension-2 or dimension-3 field which gives the indices of the origin of the hyperslab of data for this module in the main area detector image in the parent NXdetector module. The data_origin is 0-based. The frame number dimension (np) is omitted. Thus the data_origin field for a dimension-2 dataset with indices (np, i, j) will be an array with indices (i, j), and for a dimension-3 dataset with indices (np, i, j, k) will be an array with indices (i, j, k). The :ref:`order ` of indices (i, j or i, j, k) is slow to fast. .. _/NXdetector_module/data_size-field: .. index:: data_size (field) **data_size**: (optional) :ref:`NX_INT ` .. collapse:: Two or three values for the size of the module in pixels in ... Two or three values for the size of the module in pixels in each direction. Dimensionality and order of indices is the same as for data_origin. .. _/NXdetector_module/module_offset-field: .. index:: module_offset (field) **module_offset**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} .. collapse:: Offset of the module in regards to the origin of the detector in an ... Offset of the module in regards to the origin of the detector in an arbitrary direction. .. _/NXdetector_module/module_offset@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (optional) :ref:`NX_CHAR ` Obligatory value: ``translation`` .. _/NXdetector_module/module_offset@vector-attribute: .. index:: vector (field attribute) **@vector**: (optional) :ref:`NX_NUMBER ` Three values that define the axis for this transformation .. _/NXdetector_module/module_offset@offset-attribute: .. index:: offset (field attribute) **@offset**: (optional) :ref:`NX_NUMBER ` A fixed offset applied before the transformation (three vector components). .. _/NXdetector_module/module_offset@offset_units-attribute: .. index:: offset_units (field attribute) **@offset_units**: (optional) :ref:`NX_CHAR ` Units of the offset. .. _/NXdetector_module/module_offset@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (optional) :ref:`NX_CHAR ` Points to the path of the next element in the geometry chain. .. _/NXdetector_module/fast_pixel_direction-field: .. index:: fast_pixel_direction (field) **fast_pixel_direction**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} .. collapse:: Values along the direction of :ref:`fastest varying ... Values along the direction of :ref:`fastest varying ` :index:`pixel direction`. Each value in this array is the size of a pixel in the units specified. Alternatively, if only one value is given, all pixels in this direction have the same value. The direction itself is given through the vector attribute. .. _/NXdetector_module/fast_pixel_direction@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (optional) :ref:`NX_CHAR ` Obligatory value: ``translation`` .. _/NXdetector_module/fast_pixel_direction@vector-attribute: .. index:: vector (field attribute) **@vector**: (optional) :ref:`NX_NUMBER ` Three values that define the axis for this transformation .. _/NXdetector_module/fast_pixel_direction@offset-attribute: .. index:: offset (field attribute) **@offset**: (optional) :ref:`NX_NUMBER ` A fixed offset applied before the transformation (three vector components). .. _/NXdetector_module/fast_pixel_direction@offset_units-attribute: .. index:: offset_units (field attribute) **@offset_units**: (optional) :ref:`NX_CHAR ` Units of the offset. .. _/NXdetector_module/fast_pixel_direction@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (optional) :ref:`NX_CHAR ` Points to the path of the next element in the geometry chain. .. _/NXdetector_module/slow_pixel_direction-field: .. index:: slow_pixel_direction (field) **slow_pixel_direction**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} .. collapse:: Values along the direction of :ref:`slowest varying` ... Values along the direction of :ref:`slowest varying` :index:`pixel direction`. Each value in this array is the size of a pixel in the units specified. Alternatively, if only one value is given, all pixels in this direction have the same value. The direction itself is given through the vector attribute. .. _/NXdetector_module/slow_pixel_direction@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (optional) :ref:`NX_CHAR ` Obligatory value: ``translation`` .. _/NXdetector_module/slow_pixel_direction@vector-attribute: .. index:: vector (field attribute) **@vector**: (optional) :ref:`NX_NUMBER ` Three values that define the axis for this transformation .. _/NXdetector_module/slow_pixel_direction@offset-attribute: .. index:: offset (field attribute) **@offset**: (optional) :ref:`NX_NUMBER ` A fixed offset applied before the transformation (three vector components). .. _/NXdetector_module/slow_pixel_direction@offset_units-attribute: .. index:: offset_units (field attribute) **@offset_units**: (optional) :ref:`NX_CHAR ` Units of the offset. .. _/NXdetector_module/slow_pixel_direction@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (optional) :ref:`NX_CHAR ` Points to the path of the next element in the geometry chain. .. _/NXdetector_module/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` Points to the start of the dependency chain for this module. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXdetector_module/data_origin-field ` * :ref:`/NXdetector_module/data_size-field ` * :ref:`/NXdetector_module/depends_on-field ` * :ref:`/NXdetector_module/fast_pixel_direction-field ` * :ref:`/NXdetector_module/fast_pixel_direction@depends_on-attribute ` * :ref:`/NXdetector_module/fast_pixel_direction@offset-attribute ` * :ref:`/NXdetector_module/fast_pixel_direction@offset_units-attribute ` * :ref:`/NXdetector_module/fast_pixel_direction@transformation_type-attribute ` * :ref:`/NXdetector_module/fast_pixel_direction@vector-attribute ` * :ref:`/NXdetector_module/module_offset-field ` * :ref:`/NXdetector_module/module_offset@depends_on-attribute ` * :ref:`/NXdetector_module/module_offset@offset-attribute ` * :ref:`/NXdetector_module/module_offset@offset_units-attribute ` * :ref:`/NXdetector_module/module_offset@transformation_type-attribute ` * :ref:`/NXdetector_module/module_offset@vector-attribute ` * :ref:`/NXdetector_module/slow_pixel_direction-field ` * :ref:`/NXdetector_module/slow_pixel_direction@depends_on-attribute ` * :ref:`/NXdetector_module/slow_pixel_direction@offset-attribute ` * :ref:`/NXdetector_module/slow_pixel_direction@offset_units-attribute ` * :ref:`/NXdetector_module/slow_pixel_direction@transformation_type-attribute ` * :ref:`/NXdetector_module/slow_pixel_direction@vector-attribute ` * :ref:`/NXdetector_module@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXdetector_module.nxdl.xml