From 2c5b3abf5e3eace166c9861dd14e11b0b30553db Mon Sep 17 00:00:00 2001 From: domna Date: Wed, 27 Sep 2023 09:26:30 +0200 Subject: [PATCH 1/2] Adds NXexperiment and NXmeasurement --- contributed_definitions/NXexperiment.nxdl.xml | 84 +++++++++++++++++++ .../nyaml/NXexperiment.yaml | 42 ++++++++++ .../nyaml/NXmeasurement.yaml | 57 +++++++++++++ 3 files changed, 183 insertions(+) create mode 100644 contributed_definitions/NXexperiment.nxdl.xml create mode 100644 contributed_definitions/nyaml/NXexperiment.yaml create mode 100644 contributed_definitions/nyaml/NXmeasurement.yaml diff --git a/contributed_definitions/NXexperiment.nxdl.xml b/contributed_definitions/NXexperiment.nxdl.xml new file mode 100644 index 000000000..065cb65b9 --- /dev/null +++ b/contributed_definitions/NXexperiment.nxdl.xml @@ -0,0 +1,84 @@ + + + + + + This is the most general application definition for multidimensional + photoelectron spectroscopy. + + + + + + Start datetime of the measurement. + + + + + Stop datetime of the measurement + + + + + + + Name of the user + + + + + Name of the affiliation of the user at the + point in time when + the experiment was performed. + + + + + Full address of the user's affiliation, + i.e. street, street number, zip, city, country + + + + + Email address of the user. + + + + + Digital id of the operatore, e.g. orcid. + + + + + + + A unique sample id + + + + + + + + + diff --git a/contributed_definitions/nyaml/NXexperiment.yaml b/contributed_definitions/nyaml/NXexperiment.yaml new file mode 100644 index 000000000..804779f32 --- /dev/null +++ b/contributed_definitions/nyaml/NXexperiment.yaml @@ -0,0 +1,42 @@ +category: application +doc: | + This is the most general application definition for multidimensional + photoelectron spectroscopy. +type: group +NXexperiment: + (NXentry): + title: + start_time(NX_DATE_TIME): + doc: Start datetime of the measurement. + end_time(NX_DATE_TIME): + exists: recommended + doc: Stop datetime of the measurement + definition: + (NXuser): + exists: recommended + name: + doc: Name of the user + affiliation: + exists: recommended + doc: | + Name of the affiliation of the user at the + point in time when + the experiment was performed. + address: + exists: recommended + doc: | + Full address of the user's affiliation, + i.e. street, street number, zip, city, country + email: + doc: Email address of the user. + digital_id(NX_CHAR): + exists: recommended + doc: Digital id of the operatore, e.g. orcid. + (NXsample): + sample_id(NX_CHAR): + doc: A unique sample id + (NXmeasurement): + (NXinstrument): + (NXprocess): + exists: recommended + data(NXdata): \ No newline at end of file diff --git a/contributed_definitions/nyaml/NXmeasurement.yaml b/contributed_definitions/nyaml/NXmeasurement.yaml new file mode 100644 index 000000000..78f9886fd --- /dev/null +++ b/contributed_definitions/nyaml/NXmeasurement.yaml @@ -0,0 +1,57 @@ +category: base +symbols: + N_parameters: The number of parameters which got scanned. +(NXmeasurement): + scan_names(NX_CHAR): + doc: Names of the scanned values + # enumeration: In an appdef this should be further specified with an + # enumeration, i.e. which scans are allowed. + dimensions: + rank: 1 + dim: [[1, N_parameters]] + scan_indices(NX_NUMBER): + doc: | + An relation to which data index the data at a certain array + position belongs. + dimensions: + rank: 1 + dim: [[1, N_parameters]] + scan_length(NX_NUMBER): + doc: The length of a scan axis + dimensions: + rank: 1 + dim: [[1, N_parameters]] + scan_unit(NX_CHAR): + doc: The unit of a scan axis + dimensions: + rank: 1 + dim: [[1, N_parameters]] + scan_values(NX_CHAR): + doc: Description of the scanned values + dimensions: + rank: N_parameters + alternate_axis_SCANNAME(NX_NUMBER): + original_entry(NX_CHAR): + doc: Pointer to where the original measurement data is stored. + derived_from(NX_CHAR): + doc: A pointer to the axis this alternate axis is derived from. + dimensions: + rank: 1 + dim: [[1, scan_length[N]]] + # axisN has to exist for every value of scan_names + axis_SCANNAME(NX_NUMBER): + doc: | + The scan axis values. This should contain actually measured values. + If you want to store set parameters as well please use the + alternate_axis field. + original_entry(NX_CHAR): + doc: Pointer to where the original measurement data is stored. + dimensions: + rank: 1 + dim: [[1, scan_length[N]]] + signal(NX_NUMBER): + original_entry(NX_CHAR): + doc: Pointer to where the original measurement data is stored. + dimensions: + rank: N_parameters + dim: [[1, scan_length1], [2, scan_length2], ...]] \ No newline at end of file From a3cd17f0f6ed624a814497054e4bb493b1991198 Mon Sep 17 00:00:00 2001 From: domna Date: Wed, 27 Sep 2023 11:26:04 +0200 Subject: [PATCH 2/2] Updates NXexperiment docstring --- contributed_definitions/NXexperiment.nxdl.xml | 3 +-- contributed_definitions/nyaml/NXexperiment.yaml | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/contributed_definitions/NXexperiment.nxdl.xml b/contributed_definitions/NXexperiment.nxdl.xml index 065cb65b9..65098af11 100644 --- a/contributed_definitions/NXexperiment.nxdl.xml +++ b/contributed_definitions/NXexperiment.nxdl.xml @@ -23,8 +23,7 @@ --> - This is the most general application definition for multidimensional - photoelectron spectroscopy. + A general description of any experiment. diff --git a/contributed_definitions/nyaml/NXexperiment.yaml b/contributed_definitions/nyaml/NXexperiment.yaml index 804779f32..5590748a9 100644 --- a/contributed_definitions/nyaml/NXexperiment.yaml +++ b/contributed_definitions/nyaml/NXexperiment.yaml @@ -1,7 +1,6 @@ category: application doc: | - This is the most general application definition for multidimensional - photoelectron spectroscopy. + A general description of any experiment. type: group NXexperiment: (NXentry):