-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
remove classes from contributed that have been moved to base_classes
- Loading branch information
Showing
11 changed files
with
159 additions
and
1,745 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| <?xml version='1.0' encoding='UTF-8'?> | ||
| <?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?> | ||
| <!-- | ||
| # NeXus - Neutron and X-ray Common Data Format | ||
| # | ||
| # Copyright (C) 2014-2024 NeXus International Advisory Committee (NIAC) | ||
| # | ||
| # This library is free software; you can redistribute it and/or | ||
| # modify it under the terms of the GNU Lesser General Public | ||
| # License as published by the Free Software Foundation; either | ||
| # version 3 of the License, or (at your option) any later version. | ||
| # | ||
| # This library is distributed in the hope that it will be useful, | ||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| # Lesser General Public License for more details. | ||
| # | ||
| # You should have received a copy of the GNU Lesser General Public | ||
| # License along with this library; if not, write to the Free Software | ||
| # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | ||
| # | ||
| # For further information, see http://www.nexusformat.org | ||
| --> | ||
| <definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXcoordinate_system" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"> | ||
| <doc> | ||
| Base class to detail a coordinate system (CS). | ||
|
|
||
| Whenever possible, an instance of :ref:`NXcoordinate_system` should be used as | ||
| a member in an :ref:`NXcoordinate_system_set` and the name of the instance | ||
| should be this alias. This may support a process whereby jargon when talking | ||
| about coordinate systems and conventions may become cleaner for users | ||
| because it is not evident for people outside a lab that terms like e.g. | ||
| tip space or specimen space refer to the same coordinate system. | ||
| This is an example of jargon used in e.g. the field of atom | ||
| probe tomography. | ||
| </doc> | ||
| <field name="origin" type="NX_CHAR"> | ||
| <doc> | ||
| Human-readable field telling where the origin of this CS is. | ||
| Exemplar values could be *left corner of the lab bench*, *door-handle* | ||
| *pinhole through which the electron beam exists the pole piece*. | ||
| *barycenter of the triangle*, *center of mass of the stone*. | ||
| </doc> | ||
| </field> | ||
| <!--implementing a proposal for "a common base table" along thoughts like: | ||
| https://manual.nexusformat.org/classes/base_classes/NXtransformations.html#nxtransformations | ||
| similar to a place where all transformations are stored | ||
| https://www.zenodo.org/record/3526738/files/lyso009a_0087.JF07T32V01_master.h5?download=1 | ||
| enumeration: [undefined, front_top_left, front_top_right, front_bottom_right, front_bottom_left, back_top_left, back_top_right, back_bottom_right, back_bottom_left]--> | ||
| <field name="alias" type="NX_CHAR"> | ||
| <doc> | ||
| An alternative name given to that coordinate system. | ||
| </doc> | ||
| </field> | ||
| <field name="type" type="NX_CHAR"> | ||
| <doc> | ||
| Coordinate system type. | ||
| </doc> | ||
| <enumeration> | ||
| <item value="undefined"/> | ||
| <item value="cartesian"/> | ||
| </enumeration> | ||
| </field> | ||
| <field name="handedness" type="NX_CHAR"> | ||
| <doc> | ||
| Handedness of the coordinate system if it is a Cartesian. | ||
| </doc> | ||
| <enumeration> | ||
| <item value="undefined"/> | ||
| <item value="right_handed"/> | ||
| <item value="left_handed"/> | ||
| </enumeration> | ||
| </field> | ||
| <field name="x_alias" type="NX_CHAR"> | ||
| <doc> | ||
| Possibility to define an alias for the name of the x-axis. | ||
| </doc> | ||
| </field> | ||
| <field name="x_direction" type="NX_CHAR"> | ||
| <doc> | ||
| Human-readable field telling in which direction the x-axis points if that | ||
| instance of :ref:`NXcoordinate_system` has no reference to any parent and as such | ||
| is the mighty world reference frame. | ||
|
|
||
| Exemplar values could be direction of gravity. | ||
| </doc> | ||
| </field> | ||
| <!--enumeration: [undefined, north, east, south, west, in, out]--> | ||
| <field name="x" type="NX_NUMBER" units="NX_LENGTH"> | ||
| <doc> | ||
| Base unit vector along the first axis which spans the coordinate system. | ||
| This axis is frequently referred to as the x-axis in real space and | ||
| the i-axis in reciprocal space. | ||
| </doc> | ||
| <dimensions rank="1"> | ||
| <dim index="1" value="3"/> | ||
| </dimensions> | ||
| </field> | ||
| <field name="y_alias" type="NX_CHAR"> | ||
| <doc> | ||
| Possibility to define an alias for the name of the y-axis. | ||
| </doc> | ||
| </field> | ||
| <field name="y_direction" type="NX_CHAR"> | ||
| <doc> | ||
| Human-readable field telling in which direction the y-axis points if that | ||
| instance of :ref:`NXcoordinate_system` has no reference to any parent and as such | ||
| is the mighty world reference frame. | ||
|
|
||
| See docstring of x_alias for further details. | ||
| </doc> | ||
| </field> | ||
| <field name="y" type="NX_NUMBER" units="NX_LENGTH"> | ||
| <doc> | ||
| Base unit vector along the second axis which spans the coordinate system. | ||
| This axis is frequently referred to as the y-axis in real space and | ||
| the j-axis in reciprocal space. | ||
| </doc> | ||
| <dimensions rank="1"> | ||
| <dim index="1" value="3"/> | ||
| </dimensions> | ||
| </field> | ||
| <field name="z_alias" type="NX_CHAR"> | ||
| <doc> | ||
| Possibility to define an alias for the name of the z-axis. | ||
| </doc> | ||
| </field> | ||
| <field name="z_direction" type="NX_CHAR"> | ||
| <doc> | ||
| Human-readable field telling in which direction the z-axis points if that | ||
| instance of :ref:`NXcoordinate_system` has no reference to any parent and as such | ||
| is the mighty world reference frame. | ||
|
|
||
| See docstring of x_alias for further details. | ||
| </doc> | ||
| </field> | ||
| <field name="z" type="NX_NUMBER" units="NX_LENGTH"> | ||
| <doc> | ||
| Base unit vector along the third axis which spans the coordinate system. | ||
| This axis is frequently referred to as the z-axis in real space and | ||
| the k-axis in reciprocal space. | ||
| </doc> | ||
| <dimensions rank="1"> | ||
| <dim index="1" value="3"/> | ||
| </dimensions> | ||
| </field> | ||
| <field name="depends_on" type="NX_CHAR"> | ||
| <doc> | ||
| This specificies the relation to another coordinate system by pointing to the last | ||
| transformation in the transformation chain in the NXtransformations group. | ||
| </doc> | ||
| </field> | ||
| <group type="NXtransformations"> | ||
| <doc> | ||
| Collection of axis-based translations and rotations to describe this coordinate system | ||
| with respect to another coordinate system. | ||
| </doc> | ||
| </group> | ||
| </definition> |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.