Skip to content

Commit

Permalink
merging and putting NXprocess from contributed to base_classes
Browse files Browse the repository at this point in the history
  • Loading branch information
sanbrock committed Apr 26, 2023
1 parent fffc69d commit ee82bec
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 140 deletions.
80 changes: 49 additions & 31 deletions base_classes/NXprocess.nxdl.xml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="nxdlformat.xsl" ?>
<?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
<!--
# NeXus - Neutron and X-ray Common Data Format
#
# Copyright (C) 2008-2022 NeXus International Advisory Committee (NIAC)
# Copyright (C) 2014-2022 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.
# version 2 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
Expand All @@ -21,50 +21,68 @@
#
# For further information, see http://www.nexusformat.org
-->
<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" category="base"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"
name="NXprocess"
type="group" extends="NXobject">
<doc>Document an event of data processing, reconstruction, or analysis for this data.</doc>
<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXprocess" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
<doc>
Document an event of data processing, reconstruction, or analysis for this data.
</doc>
<field name="program" type="NX_CHAR">
<doc>Name of the program used</doc>
<doc>
Name of the program used
</doc>
</field>
<field name="sequence_index" type="NX_POSINT">
<doc>
Sequence index of processing,
for determining the order of multiple **NXprocess** steps.
Starts with 1.
Sequence index of processing,
for determining the order of multiple **NXprocess** steps.
Starts with 1.
</doc>
</field>
<field name="version" type="NX_CHAR">
<doc>Version of the program used</doc>
<doc>
Version of the program used
</doc>
</field>
<field name="date" type="NX_DATE_TIME">
<doc>Date and time of processing.</doc>
<doc>
Date and time of processing.
</doc>
</field>
<group type="NXregistration">
<doc>
Describes the operations of image registration
</doc>
</group>
<group type="NXdistortion">
<doc>
Describes the operations of image distortion correction
</doc>
</group>
<group type="NXcalibration">
<doc>
Describes the operations of calibration procedures, e.g. axis calibrations.
</doc>
</group>
<group type="NXnote">
<doc>
The note will contain information about how the data was processed
or anything about the data provenance.
The contents of the note can be anything that the processing code
can understand, or simple text.

The name will be numbered to allow for ordering of steps.
The note will contain information about how the data was processed
or anything about the data provenance.
The contents of the note can be anything that the processing code
can understand, or simple text.
The name will be numbered to allow for ordering of steps.
</doc>
</group>
<attribute name="default">
<doc>
.. 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.
.. 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.
</doc>
</attribute>
</definition>

10 changes: 10 additions & 0 deletions base_classes/nyaml/NXprocess.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ NXprocess(NXobject):
date(NX_DATE_TIME):
doc: |
Date and time of processing.
(NXregistration):
doc: |
Describes the operations of image registration
(NXdistortion):
doc: |
Describes the operations of image distortion correction
(NXcalibration):
doc: |
Describes the operations of calibration procedures, e.g. axis calibrations.
(NXnote):
doc: |
The note will contain information about how the data was processed
Expand Down Expand Up @@ -109,3 +118,4 @@ NXprocess(NXobject):
# </attribute>
# </definition>
#

64 changes: 0 additions & 64 deletions contributed_definitions/NXprocess.nxdl.xml

This file was deleted.

45 changes: 0 additions & 45 deletions contributed_definitions/nyaml/NXprocess.yaml

This file was deleted.

0 comments on commit ee82bec

Please sign in to comment.