|
44 | 44 | <symbol name="p"> |
45 | 45 | <doc> |
46 | 46 | 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 |
48 | 48 | ions included in the reconstructed volume if the application definition is used |
49 | 49 | to store results of an already reconstructed dataset. |
50 | 50 | </doc> |
|
84 | 84 | is considered as a narrow synonym for crystal defects. |
85 | 85 |
|
86 | 86 | 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. |
88 | 88 |
|
89 | 89 | Before summarizing the design of the base classes and the parts of the NXapm application definition, |
90 | 90 | it is worthwhile to recall and distinguish concepts that are related to atom extraction |
|
149 | 149 | or a new file. Removing the specimen from the instrument is an interruption. Changing evaporation conditions |
150 | 150 | while the specimen is remains in the analysis_chamber and resuming thereafter the measurement |
151 | 151 | 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 |
153 | 153 | group. Parking the specimen to the buffer_chamber and resuming the measurement at a later stage is an interruption. |
154 | 154 | During a run, the microscope is used for a certain amount of time to characterize a single specimen. |
155 | 155 | - The groups ``sample`` and ``specimen`` provide concepts for storing metadata about the sample and the specimen, |
|
187 | 187 | NXapm defines constraints on the existence and cardinality of concepts and its concept branches but seeks to |
188 | 188 | offer a compromise. The key design pattern followed is that most branches are made optional or at most recommended |
189 | 189 | 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 |
191 | 191 | optional group ``measurement`` with its required child ``measurement/instrument``: |
192 | 192 | Users which report simulations are not forced to document the instrument but users which have characterized |
193 | 193 | a specimen are motivated to report about the instrument. They are though not necessarily required to report all |
|
203 | 203 | events that can be time-stamped individually. |
204 | 204 | Each instance of a group ``measurement/eventID`` contains ``measurement/instrument`` whose purpose is to |
205 | 205 | 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. |
207 | 207 |
|
208 | 208 | Noteworthy, such an approach of the atom probe detecting groups of events and storing these as groups has also |
209 | 209 | been in use in the proprietary software via CamecaRoot, a set of customized data structures and file formats that use |
|
215 | 215 | considered best practice by AMETEK/Cameca, ``raw_data`` for delay-line timing data, ``hit_finding`` for details of the |
216 | 216 | hit finding algorithm, ``hit_spatial_filtering`` a process that filters hits of too low quality and those laying outside the about |
217 | 217 | 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 |
219 | 219 | conversion from time-of-flight to mass-to-charge-state-ratio values. |
220 | 220 |
|
221 | 221 | Finally, the groups ``reconstruction`` and ``ranging`` were designed to match and document the classical approaches how |
|
340 | 340 |
|
341 | 341 | More detailed timing data over the course of the experiment have to be |
342 | 342 | 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. |
344 | 344 | </doc> |
345 | 345 | </field> |
346 | 346 | <field name="end_time" type="NX_DATE_TIME" recommended="true"> |
|
361 | 361 | </doc> |
362 | 362 | </field> |
363 | 363 | <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> |
364 | 369 | <field name="doi" type="NX_CHAR"/> |
365 | 370 | </group> |
366 | 371 | <group name="noteID" type="NXnote" minOccurs="0" maxOccurs="unbounded" nameType="partial"> |
|
673 | 678 | </enumeration> |
674 | 679 | </field> |
675 | 680 | </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"> |
677 | 682 | <doc> |
678 | 683 | A coordinate system. Multiple instances require unique names. |
679 | 684 |
|
|
740 | 745 | <group name="measurement" type="NXapm_measurement" optional="true"> |
741 | 746 | <field name="status" type="NX_CHAR" recommended="true"/> |
742 | 747 | <field name="quality" type="NX_CHAR" recommended="true"/> |
743 | | - <group name="instrument" type="NXinstrument_apm"> |
| 748 | + <group name="instrument" type="NXapm_instrument"> |
744 | 749 | <field name="type" type="NX_CHAR" recommended="true"/> |
745 | 750 | <field name="location" type="NX_CHAR" recommended="true"/> |
746 | 751 | <field name="flight_path" type="NX_FLOAT" recommended="true"/> |
|
752 | 757 | <group name="reflectron" type="NXcomponent" optional="true"> |
753 | 758 | <field name="applied" type="NX_BOOLEAN"/> |
754 | 759 | </group> |
755 | | - <group name="local_electrode" type="NXlens_em" recommended="true"> |
| 760 | + <group name="local_electrode" type="NXelectromagnetic_lens" recommended="true"> |
756 | 761 | <field name="name" type="NX_CHAR"/> |
757 | 762 | <group name="fabrication" type="NXfabrication" optional="true"> |
758 | 763 | <field name="vendor" type="NX_CHAR"/> |
|
832 | 837 | </group> |
833 | 838 | </group> |
834 | 839 | </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"> |
836 | 841 | <field name="start_time" type="NX_DATE_TIME" recommended="true"/> |
837 | 842 | <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"> |
839 | 844 | <group name="reflectron" type="NXcomponent" recommended="true"> |
840 | 845 | <field name="voltage" type="NX_FLOAT"/> |
841 | 846 | </group> |
842 | | - <group name="local_electrode" type="NXlens_em" recommended="true"> |
| 847 | + <group name="local_electrode" type="NXelectromagnetic_lens" recommended="true"> |
843 | 848 | <field name="voltage" type="NX_FLOAT"/> |
844 | 849 | </group> |
845 | 850 | <group name="pulser" type="NXcomponent" recommended="true"> |
|
979 | 984 |
|
980 | 985 | In the case of an open-source instrument, like P. Felfer's Oxcart or G. Schmitz's |
981 | 986 | M-TAP instruments, also use program1, program2, ... with program1 representing |
982 | | - the control software e.g. `M. Monajem and P. Felfer pyCCAPT <https://pyccapt.readthedocs.io/en/latest/>`_. |
| 987 | + the control software e.g. `M. Monajem and P. Felfer PYCCAPT <https://pyccapt.readthedocs.io/en/latest/>`_. |
983 | 988 | Further instances (program2, ...) can be used to list the dependencies, the |
984 | 989 | python virtual environment. |
985 | 990 | </doc> |
|
1260 | 1265 | <field name="checksum" type="NX_CHAR" recommended="true"/> |
1261 | 1266 | <field name="algorithm" type="NX_CHAR" recommended="true"/> |
1262 | 1267 | </group> |
1263 | | - <group name="config" type="NXparameters"> |
| 1268 | + <group name="config" type="NXparameters" recommended="true"> |
1264 | 1269 | <field name="mass_calibration" type="NX_FLOAT" recommended="true" units="NX_ANY"> |
1265 | 1270 | <doc> |
1266 | 1271 | Mass calibration with unit peaks/interp. as mentioned by `T. Blum et al. |
|
1308 | 1313 | <field name="name" type="NX_CHAR"/> |
1309 | 1314 | </group> |
1310 | 1315 | </group> |
1311 | | - <field name="mass_to_charge" type="NX_FLOAT"> |
| 1316 | + <field name="mass_to_charge" type="NX_FLOAT" units="NX_ANY"> |
1312 | 1317 | <dimensions rank="1"> |
1313 | 1318 | <dim index="1" value="n"/> |
1314 | 1319 | </dimensions> |
|
0 commit comments