Skip to content

Commit

Permalink
Fix xrd category to fairmat (#298)
Browse files Browse the repository at this point in the history 
* update NXxrd.yaml

* update NXxrd.nxdl
  • Loading branch information
@RubelMozumder
RubelMozumder authored Sep 20, 2024
1 parent 08c4fcb commit ad008ad
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 19 deletions.
12 changes: 6 additions & 6 deletions contributed_definitions/NXxrd.nxdl.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<!--
! : additions
? : could or should be modified?-->
<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXxrd" extends="NXmonopd" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="application" type="group" name="NXxrd" extends="NXmonopd" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
<doc>
NXxrd on top of NXmonopd
</doc>
Expand All @@ -46,7 +46,7 @@
<doc>
raw detector signal (usually counts) as colected
it can be a multi-dimensional dataset depending on
the detector type (faster axes) and
the detector type (faster axes) and
the scanning method (slower axes)
</doc>
</group>
Expand Down Expand Up @@ -87,11 +87,11 @@
</group>
<group type="NXprocess" optional="true">
<doc>
Description of a processing or analysis step, such as the
Description of a processing or analysis step, such as the
baseline extraction or azimuth integration.
Add additional fields as needed to describe value(s) of
any variable, parameter, or term related to
the NXprocess step. Be sure to include units attributes
Add additional fields as needed to describe value(s) of
any variable, parameter, or term related to
the NXprocess step. Be sure to include units attributes
for all numerical fields.
</doc>
</group>
Expand Down
128 changes: 115 additions & 13 deletions contributed_definitions/nyaml/NXxrd.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
category: base
category: application
doc: |
NXxrd on top of NXmonopd
# ! : additions
# ? : could or should be modified?
type: group
Expand All @@ -18,18 +19,18 @@ NXxrd(NXmonopd):
(NXdetector):
raw_data(NXdata):
exists: optional
doc: |
doc: |
raw detector signal (usually counts) as colected
it can be a multi-dimensional dataset depending on
the detector type (faster axes) and
the detector type (faster axes) and
the scanning method (slower axes)
polar_angle(NX_FLOAT):
dimensions:
rank: 1
dim: [[1, nDet]]
unit: NX_ANGLE
doc: |
The 2-theta range of the difractogram
dimensions:
rank: 1
dim: (nDet,)
\@units:
enumeration: [deg]
(NXdata):
Expand All @@ -39,21 +40,122 @@ NXxrd(NXmonopd):
Link to ponglar ale in /NXentry/NXinstrument/NXdetector
dimensions:
rank: 1
dim: [[1, nDet]]
dim: (nDet,)
data(NX_NUMBER):
doc: |
link (suggested target:/NXentry/NXinstrument/NXdetector/data)
Link to data in /Nxentry/Nxinstrument/Nxdetector
dimensions:
rank: 1
dim: [[1, nDet]]
(NXprocess):
dim: (nDet,)
(NXprocess):
exists: optional
doc: |
Description of a processing or analysis step, such as the
Description of a processing or analysis step, such as the
baseline extraction or azimuth integration.
Add additional fields as needed to describe value(s) of
any variable, parameter, or term related to
the NXprocess step. Be sure to include units attributes
Add additional fields as needed to describe value(s) of
any variable, parameter, or term related to
the NXprocess step. Be sure to include units attributes
for all numerical fields.
# ++++++++++++++++++++++++++++++++++ SHA HASH ++++++++++++++++++++++++++++++++++
# 4f2ea4ee6a66e3c162fccfc9a20a793590853e1d1577142e20f73699cfc792ab
# <?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
# -->
# <!--
# ! : additions
# ? : could or should be modified?-->
# <definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="application" type="group" name="NXxrd" extends="NXmonopd" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
# <doc>
# NXxrd on top of NXmonopd
# </doc>
# <group type="NXentry">
# <field name="definition">
# <doc>
# Official NeXus NXDL schema to which this file conforms
# </doc>
# <enumeration>
# <item value="NXxrd"/>
# </enumeration>
# </field>
# <group type="NXinstrument" optional="true">
# <group type="NXbeam">
# <field name="incident_energy" type="NX_FLOAT" units="NX_ENERGY"/>
# </group>
# <group type="NXdetector">
# <group name="raw_data" type="NXdata" optional="true">
# <doc>
# raw detector signal (usually counts) as colected
# it can be a multi-dimensional dataset depending on
# the detector type (faster axes) and
# the scanning method (slower axes)
# </doc>
# </group>
# <field name="polar_angle" type="NX_FLOAT" units="NX_ANGLE">
# <doc>
# The 2-theta range of the difractogram
# </doc>
# <dimensions rank="1">
# <dim index="1" value="nDet"/>
# </dimensions>
# <attribute name="units">
# <enumeration>
# <item value="deg"/>
# </enumeration>
# </attribute>
# </field>
# </group>
# </group>
# <group type="NXdata">
# <field name="polar_angle" type="NX_FLOAT">
# <doc>
# link (suggested target:/NXentry/NXinstrument/NXdetector/polar_angle)
# Link to ponglar ale in /NXentry/NXinstrument/NXdetector
# </doc>
# <dimensions rank="1">
# <dim index="1" value="nDet"/>
# </dimensions>
# </field>
# <field name="data" type="NX_NUMBER">
# <doc>
# link (suggested target:/NXentry/NXinstrument/NXdetector/data)
# Link to data in /Nxentry/Nxinstrument/Nxdetector
# </doc>
# <dimensions rank="1">
# <dim index="1" value="nDet"/>
# </dimensions>
# </field>
# </group>
# <group type="NXprocess" optional="true">
# <doc>
# Description of a processing or analysis step, such as the
# baseline extraction or azimuth integration.
# Add additional fields as needed to describe value(s) of
# any variable, parameter, or term related to
# the NXprocess step. Be sure to include units attributes
# for all numerical fields.
# </doc>
# </group>
# </group>
# </definition>

0 comments on commit ad008ad

Please sign in to comment.