.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXshape.nxdl.xml -- DO NOT EDIT .. index:: ! NXshape (base class) ! shape (base class) see: shape (base class); NXshape .. _NXshape: ======= NXshape ======= .. Contributors List .. |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:: 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:: legacy class - (used by :ref:`NXgeometry`) - the shape and size of a component. ... legacy class - (used by :ref:`NXgeometry`) - the shape and size of a component. This is the description of the general shape and size of a component, which may be made up of ``numobj`` separate elements - it is used by the :ref:`NXgeometry` class **Symbols**: No symbol table **Groups cited**: none **Structure**: .. _/NXshape@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. .. _/NXshape/shape-field: .. index:: shape (field) **shape**: (optional) :ref:`NX_CHAR ` .. collapse:: general shape of a component ... general shape of a component Any of these values: * ``nxflat`` * ``nxcylinder`` * ``nxbox`` * ``nxsphere`` * ``nxcone`` * ``nxelliptical`` * ``nxtoroidal`` * ``nxparabolic`` * ``nxpolynomial`` .. _/NXshape/size-field: .. index:: size (field) **size**: (optional) :ref:`NX_FLOAT ` (Rank: 2, Dimensions: [numobj, nshapepar]) {units=\ :ref:`NX_LENGTH `} .. collapse:: physical extent of the object along its local axes (after NXorientation) ... physical extent of the object along its local axes (after NXorientation) with the center of mass at the local origin (after NXtranslation). The meaning and location of these axes will vary according to the value of the "shape" variable. ``nshapepar`` defines how many parameters: - For "nxcylinder" type the parameters are (diameter,height) and a three value orientation vector of the cylinder. - For the "nxbox" type the parameters are (length,width,height). - For the "nxsphere" type the parameters are (diameter). - For nxcone cone half aperture - For nxelliptical, semi-major axis, semi-minor-axis, angle of major axis and pole - For nxtoroidal, major radius, minor radius - For nxparabolic, parabolic parameter a - For nxpolynomial, an array of polynom coefficients, the dimension of the array encodes the degree of the polynom .. _/NXshape/direction-field: .. index:: direction (field) **direction**: (optional) :ref:`NX_CHAR ` Any of these values: ``concave`` | ``convex`` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXshape/direction-field ` * :ref:`/NXshape/shape-field ` * :ref:`/NXshape/size-field ` * :ref:`/NXshape@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXshape.nxdl.xml