.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXsts.nxdl.xml -- DO NOT EDIT .. index:: ! NXsts (application definition) ! sts (application definition) see: sts (application definition); NXsts .. _NXsts: ===== NXsts ===== **Status**: *application definition* (contribution), extends :ref:`NXspm` **Description**: .. collapse:: An application definition to describe Scanning Tunneling Spectroscopy (STS). ... An application definition to describe Scanning Tunneling Spectroscopy (STS). NXsts is an extension of NXspm. **Symbols**: No symbol table **Groups cited**: :ref:`NXcollection`, :ref:`NXentry`, :ref:`NXenvironment`, :ref:`NXinstrument`, :ref:`NXlockin`, :ref:`NXpid_controller`, :ref:`NXsensor`, :ref:`NXspm_bias_spectroscopy`, :ref:`NXspm_positioner`, :ref:`NXspm_scan_control` .. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXlockin (base class); used in application definition, NXsensor (base class); used in application definition, NXenvironment (base class); used in application definition, NXspm_scan_control (base class); used in application definition, NXspm_bias_spectroscopy (base class); used in application definition, NXspm_positioner (base class); used in application definition, NXpid_controller (base class); used in application definition, NXcollection (base class); used in application definition **Structure**: .. _/NXsts/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` :ref:`⤆ ` .. _/NXsts/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Name of the definition that is used for the application. ... Name of the definition that is used for the application. Obligatory value: ``NXsts`` .. _/NXsts/ENTRY/experiment_technique-field: .. index:: experiment_technique (field) **experiment_technique**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: The specific to STM experiment. ... The specific to STM experiment. Obligatory value: ``STS`` .. _/NXsts/ENTRY/scan_mode-field: .. index:: scan_mode (field) **scan_mode**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: The mode between the tip and sample of the tunneling spectroscopy experiment ... The mode between the tip and sample of the tunneling spectroscopy experiment. Any of these values or a custom value (if you use a custom value, also set @custom=True): * ``constant height`` * ``constant current`` * ``constant spacing`` .. _/NXsts/ENTRY/INSTRUMENT-group: :bolditalic:`INSTRUMENT`: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXsts/ENTRY/INSTRUMENT/lockin_amplifier-group: **lockin_amplifier**: (recommended) :ref:`NXlockin` :ref:`⤆ ` The lock-in amplifier information. .. _/NXsts/ENTRY/INSTRUMENT/current_sensorTAG-group: **current_sensor**\ :bolditalic:`TAG`: (recommended) :ref:`NXsensor` :ref:`⤆ ` Information for current sensor. .. _/NXsts/ENTRY/INSTRUMENT/SCAN_ENVIRONMENT-group: :bolditalic:`SCAN_ENVIRONMENT`: (optional) :ref:`NXenvironment` :ref:`⤆ ` .. _/NXsts/ENTRY/INSTRUMENT/SCAN_ENVIRONMENT/SPM_SCAN_CONTROL-group: :bolditalic:`SPM_SCAN_CONTROL`: (recommended) :ref:`NXspm_scan_control` :ref:`⤆ ` .. _/NXsts/ENTRY/INSTRUMENT/bias_spectroscopy_environment-group: **bias_spectroscopy_environment**: (required) :ref:`NXenvironment` :ref:`⤆ ` To explain bias (sweep measurement) voltage applied to the sample. .. _/NXsts/ENTRY/INSTRUMENT/bias_spectroscopy_environment/SPM_BIAS_SPECTROSCOPY-group: :bolditalic:`SPM_BIAS_SPECTROSCOPY`: (required) :ref:`NXspm_bias_spectroscopy` :ref:`⤆ ` .. collapse:: Setup and scan data for continuous measurement of bias-voltage on the su ... Setup and scan data for continuous measurement of bias-voltage on the subject of experiment vs tunneling current from probe. .. _/NXsts/ENTRY/INSTRUMENT/bias_spectroscopy_environment/SPM_BIAS_SPECTROSCOPY/SPM_POSITIONER-group: :bolditalic:`SPM_POSITIONER`: (recommended) :ref:`NXspm_positioner` :ref:`⤆ ` .. _/NXsts/ENTRY/INSTRUMENT/bias_spectroscopy_environment/SPM_BIAS_SPECTROSCOPY/SPM_POSITIONER/z_controller-group: **z_controller**: (recommended) :ref:`NXpid_controller` :ref:`⤆ ` .. _/NXsts/ENTRY/reproducibility_indicators-group: **reproducibility_indicators**: (optional) :ref:`NXcollection` :ref:`⤆ ` .. collapse:: The group's concepts hold the link to the related concepts that define the ... The group's concepts hold the link to the related concepts that define the reproducibility of the STM experiment. .. _/NXsts/ENTRY/reproducibility_indicators/current-field: .. index:: current (field) **current**: (optional) :ref:`NX_NUMBER ` .. collapse:: The tunneling current between tip and sample after application of bias vol ... The tunneling current between tip and sample after application of bias voltage. This should be a link to /ENTRY[*]/INSTRUMENT[*]/current_sensorTAG/current Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. .. _/NXsts/ENTRY/reproducibility_indicators/current_offset-field: .. index:: current_offset (field) **current_offset**: (optional) :ref:`NX_NUMBER ` .. collapse:: The offset in tunneling current between tip and sample after application o ... The offset in tunneling current between tip and sample after application of bias voltage. This should be a link to /ENTRY[*]/INSTRUMENT[*]/current_sensorTAG[current_sensor*]/current_offset Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. .. _/NXsts/ENTRY/reproducibility_indicators/current_gain-field: .. index:: current_gain (field) **current_gain**: (optional) :ref:`NX_NUMBER ` .. collapse:: Proportional relationship between the probe output voltage and the actual ... Proportional relationship between the probe output voltage and the actual tunneling current when measuring the tunneling current. This should be a link to /ENTRY[*]/INSTRUMENT[*]/current_sensorTAG[current_sensor*]/amplifier/current_gain Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. .. _/NXsts/ENTRY/reproducibility_indicators/modulation_signal_type-field: .. index:: modulation_signal_type (field) **modulation_signal_type**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: This is the signal on which the modulation voltage or current will be adde ... This is the signal on which the modulation voltage or current will be added. This should be a link to /ENTRY[*]/INSTRUMENT[*]/lockin_amplifier/modulation_signal_type Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. .. _/NXsts/ENTRY/reproducibility_indicators/reference_frequency-field: .. index:: reference_frequency (field) **reference_frequency**: (optional) :ref:`NX_NUMBER ` .. collapse:: The frequency of the sine modulation that is used as carrier signal of inp ... The frequency of the sine modulation that is used as carrier signal of input signal in lock-in. This should be a link to /ENTRY[*]/INSTRUMENT[*]/lockin_amplifier/reference_frequency Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. .. _/NXsts/ENTRY/reproducibility_indicators/BIAS_SWEEP-group: :bolditalic:`BIAS_SWEEP`: (optional) :ref:`NXspm_scan_control` .. collapse:: Bias sweep measurement in bias spectroscopy. ... Bias sweep measurement in bias spectroscopy. This should be a link to /ENTRY[*]/INSTRUMENT[*]/bias_spectroscopy_environment/BIAS_SPECTROSCOPY[bias_spectroscopy]/bias_sweep Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. .. _/NXsts/ENTRY/resolution_indicators-group: **resolution_indicators**: (optional) :ref:`NXcollection` :ref:`⤆ ` .. collapse:: The group's concepts hold the link to the related concepts that define the ... The group's concepts hold the link to the related concepts that define the resolution of the STM experiment. .. _/NXsts/ENTRY/resolution_indicators/head_temperature-field: .. index:: head_temperature (field) **head_temperature**: (optional) :ref:`NX_NUMBER ` .. collapse:: This should be a link to ... This should be a link to /entry/instrument/scan_environment/head_temperature Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. .. _/NXsts/ENTRY/resolution_indicators/cryo_bottom_temperature-field: .. index:: cryo_bottom_temperature (field) **cryo_bottom_temperature**: (optional) :ref:`NX_NUMBER ` .. collapse:: This should be a link to ... This should be a link to /entry/instrument/scan_environment/cryo_bottom_temperature Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. .. _/NXsts/ENTRY/resolution_indicators/cryo_shield_temperature-field: .. index:: cryo_shield_temperature (field) **cryo_shield_temperature**: (optional) :ref:`NX_NUMBER ` .. collapse:: This should be a link to ... This should be a link to /entry/instrument/scan_environment/cryo_shield_temperature Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. .. _/NXsts/ENTRY/resolution_indicators/modulation_signal_type-field: .. index:: modulation_signal_type (field) **modulation_signal_type**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: This is the signal on which the modulation voltage or current will be adde ... This is the signal on which the modulation voltage or current will be added. This should be a link to /ENTRY[*]/INSTRUMENT[*]/lockin_amplifier/modulation_signal_type Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. .. _/NXsts/ENTRY/resolution_indicators/modulation_frequency-field: .. index:: modulation_frequency (field) **modulation_frequency**: (optional) :ref:`NX_NUMBER ` .. collapse:: The frequency of the sine modulation that is used to modulate the signal i ... The frequency of the sine modulation that is used to modulate the signal in lock-in. This should be a link to /ENTRY[*]/INSTRUMENT[*]/lockin_amplifier/modulation_frequency Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the .. _/NXsts/ENTRY/resolution_indicators/BIAS_SWEEP-group: :bolditalic:`BIAS_SWEEP`: (optional) :ref:`NXspm_scan_control` .. collapse:: This should be a link to ... This should be a link to /ENTRY[*]/INSTRUMENT[*]/bias_spectroscopy_environment/SPM_BIAS_SPECTROSCOPY[bias_spectroscopy]/bias_sweep Note: group name (could be any meaningful and relevant name e.g. entry in ENTRY[entry]) inside the square bracket would be the `exact` name of the NXentry group. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXsts/ENTRY-group ` * :ref:`/NXsts/ENTRY/definition-field ` * :ref:`/NXsts/ENTRY/experiment_technique-field ` * :ref:`/NXsts/ENTRY/INSTRUMENT-group ` * :ref:`/NXsts/ENTRY/INSTRUMENT/bias_spectroscopy_environment-group ` * :ref:`/NXsts/ENTRY/INSTRUMENT/bias_spectroscopy_environment/SPM_BIAS_SPECTROSCOPY-group ` * :ref:`/NXsts/ENTRY/INSTRUMENT/bias_spectroscopy_environment/SPM_BIAS_SPECTROSCOPY/SPM_POSITIONER-group ` * :ref:`/NXsts/ENTRY/INSTRUMENT/bias_spectroscopy_environment/SPM_BIAS_SPECTROSCOPY/SPM_POSITIONER/z_controller-group ` * :ref:`/NXsts/ENTRY/INSTRUMENT/current_sensorTAG-group ` * :ref:`/NXsts/ENTRY/INSTRUMENT/lockin_amplifier-group ` * :ref:`/NXsts/ENTRY/INSTRUMENT/SCAN_ENVIRONMENT-group ` * :ref:`/NXsts/ENTRY/INSTRUMENT/SCAN_ENVIRONMENT/SPM_SCAN_CONTROL-group ` * :ref:`/NXsts/ENTRY/reproducibility_indicators-group ` * :ref:`/NXsts/ENTRY/reproducibility_indicators/BIAS_SWEEP-group ` * :ref:`/NXsts/ENTRY/reproducibility_indicators/current-field ` * :ref:`/NXsts/ENTRY/reproducibility_indicators/current_gain-field ` * :ref:`/NXsts/ENTRY/reproducibility_indicators/current_offset-field ` * :ref:`/NXsts/ENTRY/reproducibility_indicators/modulation_signal_type-field ` * :ref:`/NXsts/ENTRY/reproducibility_indicators/reference_frequency-field ` * :ref:`/NXsts/ENTRY/resolution_indicators-group ` * :ref:`/NXsts/ENTRY/resolution_indicators/BIAS_SWEEP-group ` * :ref:`/NXsts/ENTRY/resolution_indicators/cryo_bottom_temperature-field ` * :ref:`/NXsts/ENTRY/resolution_indicators/cryo_shield_temperature-field ` * :ref:`/NXsts/ENTRY/resolution_indicators/head_temperature-field ` * :ref:`/NXsts/ENTRY/resolution_indicators/modulation_frequency-field ` * :ref:`/NXsts/ENTRY/resolution_indicators/modulation_signal_type-field ` * :ref:`/NXsts/ENTRY/scan_mode-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXsts.nxdl.xml