diff --git a/contributed_definitions/NXexperiment.nxdl.xml b/contributed_definitions/NXexperiment.nxdl.xml new file mode 100644 index 0000000000..65098af113 --- /dev/null +++ b/contributed_definitions/NXexperiment.nxdl.xml @@ -0,0 +1,83 @@ + + + + + + A general description of any experiment. + + + + + + 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 0000000000..5590748a91 --- /dev/null +++ b/contributed_definitions/nyaml/NXexperiment.yaml @@ -0,0 +1,41 @@ +category: application +doc: | + A general description of any experiment. +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 0000000000..78f9886fd4 --- /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