Skip to content

Commit 517740d

Browse files
authored
Merge pull request nexpy#251 from rayosborn:update-definitions
Update NeXus definitions
2 parents c61244b + b616619 commit 517740d

260 files changed

Lines changed: 19280 additions & 30314 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/nexusformat/definitions/applications/NXapm.nxdl.xml

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
<symbol name="p">
4545
<doc>
4646
Number of pulses collected in between start_time and end_time resolved by an
47-
instance of :ref:`NXevent_data_apm`. If this is not defined, p is the number of
47+
instance of :ref:`NXapm_event_data`. If this is not defined, p is the number of
4848
ions included in the reconstructed volume if the application definition is used
4949
to store results of an already reconstructed dataset.
5050
</doc>
@@ -84,7 +84,7 @@
8484
is considered as a narrow synonym for crystal defects.
8585

8686
The aim of the NXapm application definition is to provide a general yet specific enough
87-
solution to serialize artifacts for virtually all atom probe and field-ion microcopy experiments.
87+
solution to serialize artifacts for virtually all atom probe and field-ion microscopy experiments.
8888

8989
Before summarizing the design of the base classes and the parts of the NXapm application definition,
9090
it is worthwhile to recall and distinguish concepts that are related to atom extraction
@@ -149,7 +149,7 @@
149149
or a new file. Removing the specimen from the instrument is an interruption. Changing evaporation conditions
150150
while the specimen is remains in the analysis_chamber and resuming thereafter the measurement
151151
is not considered as an interruption. It is a common strategy to probe the evaporation process for different
152-
instrument parameters. Each individual collection should then though be stored in an own NXevent_data_apm
152+
instrument parameters. Each individual collection should then though be stored in an own NXapm_event_data
153153
group. Parking the specimen to the buffer_chamber and resuming the measurement at a later stage is an interruption.
154154
During a run, the microscope is used for a certain amount of time to characterize a single specimen.
155155
- The groups ``sample`` and ``specimen`` provide concepts for storing metadata about the sample and the specimen,
@@ -187,7 +187,7 @@
187187
NXapm defines constraints on the existence and cardinality of concepts and its concept branches but seeks to
188188
offer a compromise. The key design pattern followed is that most branches are made optional or at most recommended
189189
but their child concepts are conditionally required. Thereby, NXapm can cover a variety of simple but also complex
190-
use cases. An example of this parent-optional-but-childs-stronger-restricted design is the combination of the
190+
use cases. An example of this parent-optional-but-children-stronger-restricted design is the combination of the
191191
optional group ``measurement`` with its required child ``measurement/instrument``:
192192
Users which report simulations are not forced to document the instrument but users which have characterized
193193
a specimen are motivated to report about the instrument. They are though not necessarily required to report all
@@ -203,7 +203,7 @@
203203
events that can be time-stamped individually.
204204
Each instance of a group ``measurement/eventID`` contains ``measurement/instrument`` whose purpose is to
205205
store those specific state and settings of the instrument that was present during the collection of the event.
206-
Thereby, changing conditions such as compaigns with different target detection rate can be stored.
206+
Thereby, changing conditions such as campaigns with different target detection rate can be stored.
207207

208208
Noteworthy, such an approach of the atom probe detecting groups of events and storing these as groups has also
209209
been in use in the proprietary software via CamecaRoot, a set of customized data structures and file formats that use
@@ -215,7 +215,7 @@
215215
considered best practice by AMETEK/Cameca, ``raw_data`` for delay-line timing data, ``hit_finding`` for details of the
216216
hit finding algorithm, ``hit_spatial_filtering`` a process that filters hits of too low quality and those laying outside the about
217217
to be computed reconstruction volume. Furthermore, group ``voltage_and_bowl`` offers a place for documenting calibrations
218-
and processing non-linearities. Group ``mass_to_charge_conversion`` is used to document the mass calibration and the
218+
and processing nonlinearities. Group ``mass_to_charge_conversion`` is used to document the mass calibration and the
219219
conversion from time-of-flight to mass-to-charge-state-ratio values.
220220

221221
Finally, the groups ``reconstruction`` and ``ranging`` were designed to match and document the classical approaches how
@@ -340,7 +340,7 @@
340340

341341
More detailed timing data over the course of the experiment have to be
342342
collected to compute this event chain during the experiment. For this
343-
purpose the :ref:`NXevent_data_apm` instance should be used.
343+
purpose the :ref:`NXapm_event_data` instance should be used.
344344
</doc>
345345
</field>
346346
<field name="end_time" type="NX_DATE_TIME" recommended="true">
@@ -361,6 +361,11 @@
361361
</doc>
362362
</field>
363363
<group name="citeID" type="NXcite" minOccurs="0" maxOccurs="unbounded" nameType="partial">
364+
<field name="author" type="NX_CHAR" optional="true">
365+
<doc>
366+
The author(s) of that reference.
367+
</doc>
368+
</field>
364369
<field name="doi" type="NX_CHAR"/>
365370
</group>
366371
<group name="noteID" type="NXnote" minOccurs="0" maxOccurs="unbounded" nameType="partial">
@@ -673,7 +678,7 @@
673678
</enumeration>
674679
</field>
675680
</group>
676-
<group name="NAMED_reference_frame" type="NXcoordinate_system" minOccurs="1" maxOccurs="unbounded" nameType="partial">
681+
<group name="NAMED_reference_frameID" type="NXcoordinate_system" minOccurs="1" maxOccurs="unbounded" nameType="partial">
677682
<doc>
678683
A coordinate system. Multiple instances require unique names.
679684

@@ -740,7 +745,7 @@
740745
<group name="measurement" type="NXapm_measurement" optional="true">
741746
<field name="status" type="NX_CHAR" recommended="true"/>
742747
<field name="quality" type="NX_CHAR" recommended="true"/>
743-
<group name="instrument" type="NXinstrument_apm">
748+
<group name="instrument" type="NXapm_instrument">
744749
<field name="type" type="NX_CHAR" recommended="true"/>
745750
<field name="location" type="NX_CHAR" recommended="true"/>
746751
<field name="flight_path" type="NX_FLOAT" recommended="true"/>
@@ -752,7 +757,7 @@
752757
<group name="reflectron" type="NXcomponent" optional="true">
753758
<field name="applied" type="NX_BOOLEAN"/>
754759
</group>
755-
<group name="local_electrode" type="NXlens_em" recommended="true">
760+
<group name="local_electrode" type="NXelectromagnetic_lens" recommended="true">
756761
<field name="name" type="NX_CHAR"/>
757762
<group name="fabrication" type="NXfabrication" optional="true">
758763
<field name="vendor" type="NX_CHAR"/>
@@ -832,14 +837,14 @@
832837
</group>
833838
</group>
834839
</group>
835-
<group name="eventID" type="NXevent_data_apm" nameType="partial" minOccurs="0" maxOccurs="unbounded">
840+
<group name="eventID" type="NXapm_event_data" nameType="partial" minOccurs="0" maxOccurs="unbounded">
836841
<field name="start_time" type="NX_DATE_TIME" recommended="true"/>
837842
<field name="end_time" type="NX_DATE_TIME" recommended="true"/>
838-
<group name="instrument" type="NXinstrument_apm" recommended="true">
843+
<group name="instrument" type="NXapm_instrument" recommended="true">
839844
<group name="reflectron" type="NXcomponent" recommended="true">
840845
<field name="voltage" type="NX_FLOAT"/>
841846
</group>
842-
<group name="local_electrode" type="NXlens_em" recommended="true">
847+
<group name="local_electrode" type="NXelectromagnetic_lens" recommended="true">
843848
<field name="voltage" type="NX_FLOAT"/>
844849
</group>
845850
<group name="pulser" type="NXcomponent" recommended="true">
@@ -979,7 +984,7 @@
979984

980985
In the case of an open-source instrument, like P. Felfer's Oxcart or G. Schmitz's
981986
M-TAP instruments, also use program1, program2, ... with program1 representing
982-
the control software e.g. `M. Monajem and P. Felfer pyCCAPT &lt;https://pyccapt.readthedocs.io/en/latest/&gt;`_.
987+
the control software e.g. `M. Monajem and P. Felfer PYCCAPT &lt;https://pyccapt.readthedocs.io/en/latest/&gt;`_.
983988
Further instances (program2, ...) can be used to list the dependencies, the
984989
python virtual environment.
985990
</doc>
@@ -1260,7 +1265,7 @@
12601265
<field name="checksum" type="NX_CHAR" recommended="true"/>
12611266
<field name="algorithm" type="NX_CHAR" recommended="true"/>
12621267
</group>
1263-
<group name="config" type="NXparameters">
1268+
<group name="config" type="NXparameters" recommended="true">
12641269
<field name="mass_calibration" type="NX_FLOAT" recommended="true" units="NX_ANY">
12651270
<doc>
12661271
Mass calibration with unit peaks/interp. as mentioned by `T. Blum et al.
@@ -1308,7 +1313,7 @@
13081313
<field name="name" type="NX_CHAR"/>
13091314
</group>
13101315
</group>
1311-
<field name="mass_to_charge" type="NX_FLOAT">
1316+
<field name="mass_to_charge" type="NX_FLOAT" units="NX_ANY">
13121317
<dimensions rank="1">
13131318
<dim index="1" value="n"/>
13141319
</dimensions>

src/nexusformat/definitions/applications/NXarchive.nxdl.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!--
44
# NeXus - Neutron and X-ray Common Data Format
55
#
6-
# Copyright (C) 2008-2024 NeXus International Advisory Committee (NIAC)
6+
# Copyright (C) 2008-2025 NeXus International Advisory Committee (NIAC)
77
#
88
# This library is free software; you can redistribute it and/or
99
# modify it under the terms of the GNU Lesser General Public
@@ -85,7 +85,7 @@
8585
<field name="role" type="NX_CHAR">
8686
<doc>role of the user</doc></field>
8787
<field name="facility_user_id" type="NX_CHAR">
88-
<doc>ID of the user in the facility burocracy database</doc>
88+
<doc>ID of the user in the facility bureaucracy database</doc>
8989
</field>
9090
</group>
9191
<group type="NXinstrument" name="instrument">

0 commit comments

Comments
 (0)