Skip to content

Commit

Permalink
Preparation for example in nomad.
Browse files Browse the repository at this point in the history
  • Loading branch information
@RubelMozumder
RubelMozumder committed Dec 1, 2024
1 parent 8f67f0f commit 70ff59c
Show file tree
Hide file tree
Showing 18 changed files with 213 additions and 174 deletions.
14 changes: 7 additions & 7 deletions contributed_definitions/NXbias_spectroscopy.nxdl.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,18 @@
<!--how these time specifications relate to the later time values, like
scan_time?-->
<group type="NXcircuit" optional="true">
<field name="acquisition_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
<field name="acquisition_time" type="NX_NUMBER" optional="true" units="NX_TIME">
<doc>
The time or period is taken by a bias sweep to acquire the data for
a single bias sweep point (when the given point or whole sweep is started.).
</doc>
</field>
<field name="animation_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
<field name="animation_time" type="NX_NUMBER" optional="true" units="NX_TIME">
<doc>
The time or period is taken by a bias sweep to be displayed.
</doc>
</field>
<field name="measurement_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
<field name="measurement_time" type="NX_NUMBER" optional="true" units="NX_TIME">
<doc>
The time or period is taken by the circuit to measure a full bias sweep voltage or
bias current. (duration of the measurement)
Expand Down Expand Up @@ -113,14 +113,14 @@ each other (e.g. spiral)-->
The number of sweeps taken during the bias spectroscopy.
</doc>
</field>
<field name="first_settling_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
<field name="first_settling_time" type="NX_NUMBER" optional="true" units="NX_TIME">
<doc>
The initial time is taken to settle the bias voltage at the desired value.
On each sweep usually, the system takes time to settle to the bias voltage
at the next value.
</doc>
</field>
<field name="end_settling_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
<field name="end_settling_time" type="NX_NUMBER" optional="true" units="NX_TIME">
<doc>
The time is taken to settle the bias voltage at the desired value.
The time (at the last sweep) to settle for the last value of the sweep.
Expand All @@ -138,7 +138,7 @@ each other (e.g. spiral)-->
The z position after the sweeps are done.
</doc>
</field>
<field name="total_spectroscopy_time" type="NX_DATE_TIME" recommended="true" units="NX_TIME">
<field name="total_spectroscopy_time" type="NX_NUMBER" recommended="true" units="NX_TIME">
<doc>
The total time needed for the entire voltage sweep.
</doc>
Expand Down Expand Up @@ -177,7 +177,7 @@ each other (e.g. spiral)-->
The speed of the scanner or the probe during the scan.
</doc>
</field>
<field name="scan_time" type="NX_DATE_TIME" units="NX_TIME">
<field name="scan_time" type="NX_NUMBER" units="NX_TIME">
<doc>
The time taken by the scanner to scan the entire area.
</doc>
Expand Down
4 changes: 2 additions & 2 deletions contributed_definitions/NXcalibration.nxdl.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@
A description of the procedures employed.
</doc>
</field>
<field name="start_time" type="NX_DATE_TIME">
<field name="start_time" type="NX_NUMBER">
<doc>
The start time of the calibration.
</doc>
</field>
<field name="end_time" type="NX_DATE_TIME">
<field name="end_time" type="NX_NUMBER">
<doc>
The end time of the calibration.
</doc>
Expand Down
5 changes: 5 additions & 0 deletions contributed_definitions/NXpiezo_config_spm.nxdl.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,11 @@ Discussion: No need to create this base class rather we can define in spm applic
such the second-order correction is (V/m^2).
</doc>
</field>
<field name="drift_correction_status" type="NX_BOOLEAN">
<doc>
The drift correction status (true / false) in calibration step of piezo.
</doc>
</field>
<field name="drift_N" type="NX_NUMBER" units="NX_ANY">
<doc>
The N (substring) denotes X, Y and Z directions. Define the
Expand Down
19 changes: 16 additions & 3 deletions contributed_definitions/NXsensor_scan.nxdl.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,19 @@
with an UTC offset.
</doc>
<group type="NXentry">
<attribute name="default" recommended="true">
<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 visualised upon entry.
See https://www.nexusformat.org/2014_How_to_find_default_data.html
for a summary of the discussion.
</doc>
</attribute>
<field name="definition" type="NX_CHAR">
<attribute name="version"/>
<enumeration>
Expand All @@ -59,8 +72,8 @@
</doc>
</group>
<field name="experiment_description" recommended="true"/>
<field name="start_time" type="NX_DATE_TIME" units="NX_TIME" recommended="true"/>
<field name="end_time" type="NX_DATE_TIME" units="NX_TIME" recommended="true"/>
<field name="start_time" type="NX_NUMBER" units="NX_TIME" recommended="true"/>
<field name="end_time" type="NX_NUMBER" units="NX_TIME" recommended="true"/>
<group type="NXprocess">
<doc>
Define the program that was used to generate the results file(s)
Expand Down Expand Up @@ -183,7 +196,7 @@
</doc>
</attribute>
</field>
<field name="calibration_time" type="NX_DATE_TIME">
<field name="calibration_time" type="NX_NUMBER" units="NX_TIME">
<doc>
ISO8601 datum when calibration was last performed
before this measurement. UTC offset should be specified.
Expand Down
21 changes: 4 additions & 17 deletions contributed_definitions/NXspm.nxdl.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,6 @@
for specific SPM sub-techniques such as STM, STS, AFM etc.
</doc>
<group type="NXentry">
<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 visualised upon entry.
See https://www.nexusformat.org/2014_How_to_find_default_data.html
for a summary of the discussion.
</doc>
</attribute>
<field name="definition">
<doc>
Name of the definition that is used for the application.
Expand Down Expand Up @@ -337,12 +324,12 @@
<doc>
The PID controller information for the z-axis.
</doc>
<field name="z_average_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
<field name="z_average_time" type="NX_NUMBER" optional="true" units="NX_TIME">
<doc>
The average time taken by the z-controller to stabilize the tip.
</doc>
</field>
<field name="z_controller_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
<field name="z_controller_time" type="NX_NUMBER" optional="true" units="NX_TIME">
<doc>
The time taken by the z-controller to measure physical properties.
</doc>
Expand Down Expand Up @@ -443,7 +430,7 @@
<doc>
Calibration of the bias voltage measurement (V/V).
</doc>
<field name="calibration_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
<field name="calibration_time" type="NX_NUMBER" optional="true" units="NX_TIME">
<doc>
The time or period is taken by the calibration to setup to acquire the data for
the calibration.
Expand Down Expand Up @@ -483,7 +470,7 @@
the reproducibility of the experiment.
</doc>
</group>
<group name="resolution_indicators" type="NXobject">
<group name="resolution_indicators" type="NXobject" optional="true">
<doc>
The group of indicators (links to the existing fields in different groups) that
are used to measure the resolution of the experiment results.
Expand Down
14 changes: 7 additions & 7 deletions contributed_definitions/NXstm.nxdl.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ TODO: Replace rename NXenvironment to experiment_environment in NXstm, NXspm and
<doc>
Calibration of the current measurement.
</doc>
<field name="calibration_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
<field name="calibration_time" type="NX_NUMBER" optional="true" units="NX_TIME">
<doc>
The time or period is taken by the calibration to setup to acquire the data for
the calibration.
Expand Down Expand Up @@ -288,7 +288,7 @@ TODO: Replace rename NXenvironment to experiment_environment in NXstm, NXspm and
</group>
</group>
</group>
<group name="reproducibility_indicators" type="NXobject">
<group name="reproducibility_indicators" type="NXobject" optional="true">
<doc>
The group's concepts hold the link to the related concepts that define the
reproducibility of the STM experiment.
Expand Down Expand Up @@ -331,29 +331,29 @@ TODO: Replace rename NXenvironment to experiment_environment in NXstm, NXspm and
</doc>
</field>
</group>
<group name="resolution_indicators" type="NXobject">
<group name="resolution_indicators" type="NXobject" optional="true">
<doc>
The group's concepts hold the link to the related concepts that define the
resolution of the STM experiment.
</doc>
<group name="stm_head_temp" type="NXsensor">
<group name="stm_head_temp" type="NXsensor" optional="true">
<doc>
Link to target: /ENTRY[entry]/experiment_instrument/scan_environment/tip_temp
</doc>
</group>
<group name="cryo_bottom_temp" type="NXsensor">
<group name="cryo_bottom_temp" type="NXsensor" optional="true">
<doc>
Link to target:
/ENTRY[entry]/experiment_instrument/scan_environment/cryo_bottom_temp
</doc>
</group>
<group name="cryo_shield_temp" type="NXsensor">
<group name="cryo_shield_temp" type="NXsensor" optional="true">
<doc>
Link to target:
/ENTRY[entry]/experiment_instrument/scan_environment/cryo_shield_temperature
</doc>
</group>
<group name="bias_sweep" type="NXobject">
<group name="bias_sweep" type="NXobject" optional="true">
<doc>
Link to target:
/ENTRY[entry]/experiment_instrument/bias_spectroscopy_environment/BIAS_SPECTROSCOPY[bias_spectroscopy]/BIAS_SWEEP[bias_sweep]
Expand Down
30 changes: 15 additions & 15 deletions contributed_definitions/nyaml/NXbias_spectroscopy.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,18 @@ NXbias_spectroscopy(NXobject):
# scan_time?
(NXcircuit):
exists: optional
acquisition_time(NX_DATE_TIME):
acquisition_time(NX_NUMBER):
exists: optional
unit: NX_TIME
doc: |
The time or period is taken by a bias sweep to acquire the data for
a single bias sweep point (when the given point or whole sweep is started.).
animation_time(NX_DATE_TIME):
animation_time(NX_NUMBER):
exists: optional
unit: NX_TIME
doc: |
The time or period is taken by a bias sweep to be displayed.
measurement_time(NX_DATE_TIME):
measurement_time(NX_NUMBER):
exists: optional
unit: NX_TIME
doc: |
Expand Down Expand Up @@ -79,14 +79,14 @@ NXbias_spectroscopy(NXobject):
sweep_number(NX_NUMBER):
doc: |
The number of sweeps taken during the bias spectroscopy.
first_settling_time(NX_DATE_TIME):
first_settling_time(NX_NUMBER):
exists: optional
unit: NX_TIME
doc: |
The initial time is taken to settle the bias voltage at the desired value.
On each sweep usually, the system takes time to settle to the bias voltage
at the next value.
end_settling_time(NX_DATE_TIME):
end_settling_time(NX_NUMBER):
exists: optional
unit: NX_TIME
doc: |
Expand All @@ -103,7 +103,7 @@ NXbias_spectroscopy(NXobject):
exists: recommended
doc: |
The z position after the sweeps are done.
total_spectroscopy_time(NX_DATE_TIME):
total_spectroscopy_time(NX_NUMBER):
exists: recommended
unit: NX_TIME
doc: |
Expand Down Expand Up @@ -136,7 +136,7 @@ NXbias_spectroscopy(NXobject):
unit: NX_ANY
doc: |
The speed of the scanner or the probe during the scan.
scan_time(NX_DATE_TIME):
scan_time(NX_NUMBER):
unit: NX_TIME
doc: |
The time taken by the scanner to scan the entire area.
Expand All @@ -153,7 +153,7 @@ NXbias_spectroscopy(NXobject):
The data that comes from scanning the area.
# ++++++++++++++++++++++++++++++++++ SHA HASH ++++++++++++++++++++++++++++++++++
# 52bd177dcba0a77279ff6cfc95840d6216cefde09209d2b6f4ec5e9425588aa1
# 5b49dd5999a0c8838e232a3bfd90ce43f173d07395f56231de1be8e67bd7151b
# <?xml version='1.0' encoding='UTF-8'?>
# <?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
# <!--
Expand Down Expand Up @@ -218,18 +218,18 @@ NXbias_spectroscopy(NXobject):
# <!--how these time specifications relate to the later time values, like
# scan_time?-->
# <group type="NXcircuit" optional="true">
# <field name="acquisition_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
# <field name="acquisition_time" type="NX_NUMBER" optional="true" units="NX_TIME">
# <doc>
# The time or period is taken by a bias sweep to acquire the data for
# a single bias sweep point (when the given point or whole sweep is started.).
# </doc>
# </field>
# <field name="animation_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
# <field name="animation_time" type="NX_NUMBER" optional="true" units="NX_TIME">
# <doc>
# The time or period is taken by a bias sweep to be displayed.
# </doc>
# </field>
# <field name="measurement_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
# <field name="measurement_time" type="NX_NUMBER" optional="true" units="NX_TIME">
# <doc>
# The time or period is taken by the circuit to measure a full bias sweep voltage or
# bias current. (duration of the measurement)
Expand Down Expand Up @@ -269,14 +269,14 @@ NXbias_spectroscopy(NXobject):
# The number of sweeps taken during the bias spectroscopy.
# </doc>
# </field>
# <field name="first_settling_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
# <field name="first_settling_time" type="NX_NUMBER" optional="true" units="NX_TIME">
# <doc>
# The initial time is taken to settle the bias voltage at the desired value.
# On each sweep usually, the system takes time to settle to the bias voltage
# at the next value.
# </doc>
# </field>
# <field name="end_settling_time" type="NX_DATE_TIME" optional="true" units="NX_TIME">
# <field name="end_settling_time" type="NX_NUMBER" optional="true" units="NX_TIME">
# <doc>
# The time is taken to settle the bias voltage at the desired value.
# The time (at the last sweep) to settle for the last value of the sweep.
Expand All @@ -294,7 +294,7 @@ NXbias_spectroscopy(NXobject):
# The z position after the sweeps are done.
# </doc>
# </field>
# <field name="total_spectroscopy_time" type="NX_DATE_TIME" recommended="true" units="NX_TIME">
# <field name="total_spectroscopy_time" type="NX_NUMBER" recommended="true" units="NX_TIME">
# <doc>
# The total time needed for the entire voltage sweep.
# </doc>
Expand Down Expand Up @@ -333,7 +333,7 @@ NXbias_spectroscopy(NXobject):
# The speed of the scanner or the probe during the scan.
# </doc>
# </field>
# <field name="scan_time" type="NX_DATE_TIME" units="NX_TIME">
# <field name="scan_time" type="NX_NUMBER" units="NX_TIME">
# <doc>
# The time taken by the scanner to scan the entire area.
# </doc>
Expand Down
10 changes: 5 additions & 5 deletions contributed_definitions/nyaml/NXcalibration.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ NXcalibration(NXobject):
description(NX_CHAR):
doc: |
A description of the procedures employed.
start_time(NX_DATE_TIME):
start_time(NX_NUMBER):
doc: |
The start time of the calibration.
end_time(NX_DATE_TIME):
end_time(NX_NUMBER):
doc: |
The end time of the calibration.
calibration_interval(NX_FLOAT):
Expand Down Expand Up @@ -168,7 +168,7 @@ NXcalibration(NXobject):
for a summary of the discussion.
# ++++++++++++++++++++++++++++++++++ SHA HASH ++++++++++++++++++++++++++++++++++
# 0637e042803449160e95d45786d186382342ce32958d181cfbd42830ffb145c2
# 43ca2db5ea4eeb4af5d70b9d78e32cc291cf755de199c0cc2538369b87ebed91
# <?xml version='1.0' encoding='UTF-8'?>
# <?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
# <!--
Expand Down Expand Up @@ -216,12 +216,12 @@ NXcalibration(NXobject):
# A description of the procedures employed.
# </doc>
# </field>
# <field name="start_time" type="NX_DATE_TIME">
# <field name="start_time" type="NX_NUMBER">
# <doc>
# The start time of the calibration.
# </doc>
# </field>
# <field name="end_time" type="NX_DATE_TIME">
# <field name="end_time" type="NX_NUMBER">
# <doc>
# The end time of the calibration.
# </doc>
Expand Down
Loading

0 comments on commit 70ff59c

Please sign in to comment.