.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXafm.nxdl.xml -- DO NOT EDIT .. index:: ! NXafm (application definition) ! afm (application definition) see: afm (application definition); NXafm .. _NXafm: ===== NXafm ===== **Status**: *application definition* (contribution), extends :ref:`NXspm` **Description**: An application definition to describe atomic force microscopy (AFM). **Symbols**: No symbol table **Groups cited**: :ref:`NXcollection`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXenvironment`, :ref:`NXinstrument`, :ref:`NXphase_lock_loop`, :ref:`NXpositioner`, :ref:`NXsensor`, :ref:`NXspm_cantilever_oscillator`, :ref:`NXspm_cantilever`, :ref:`NXspm_piezo_sensor` .. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXdetector (base class); used in application definition, NXsensor (base class); used in application definition, NXspm_cantilever (base class); used in application definition, NXspm_cantilever_oscillator (base class); used in application definition, NXpositioner (base class); used in application definition, NXphase_lock_loop (base class); used in application definition, NXenvironment (base class); used in application definition, NXspm_piezo_sensor (base class); used in application definition, NXcollection (base class); used in application definition **Structure**: .. _/NXafm/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` :ref:`⤆ ` .. _/NXafm/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: ``NXafm`` .. _/NXafm/ENTRY/experiment_technique-field: .. index:: experiment_technique (field) **experiment_technique**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: The AFM technique. ... The AFM technique. Obligatory value: ``AFM`` .. _/NXafm/ENTRY/scan_mode-field: .. index:: scan_mode (field) **scan_mode**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: The mode of the scan. ... The mode of the scan. contact mode: Cantilever attempts to move on the sample surface in very close contact with the sample. The cantilever deflection is usually employed to control the cantilever position using a PID feedback loop. non-contact mode: Cantilever attempts to oscillate above the sample surface. Cantilever attempts to stay in the interaction (atomic force) zone therefore cantilever oscillator amplitude and frequency are deformed. The cantilever frequency or oscillation amplitude is usually employed to control the cantilever position using a PID feedback loop. tapping mode: Resembles to the non-contact mode, but at every point of scan the cantilever tip comes closer to the sample surface ("taps it"). The cantilever oscillation amplitude is usually employed to control the cantilever position using a PID feedback loop. peak force tapping mode: Like the tapping mode, but at each point of the scan force-distance curve is recorded. The maximum force is usually employed to control the cantilever position using a PID feedback loop. Any of these values or a custom value (if you use a custom value, also set @custom=True): * ``contact mode`` * ``tapping mode`` * ``non-contact mode`` * ``peak force tapping mode`` .. _/NXafm/ENTRY/INSTRUMENT-group: :bolditalic:`INSTRUMENT`: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXafm/ENTRY/INSTRUMENT/photo_detector-group: **photo_detector**: (optional) :ref:`NXdetector` :ref:`⤆ ` Information about the quadrant photodiode deflection detector or interferometer. .. _/NXafm/ENTRY/INSTRUMENT/photo_detector/SENSOR-group: :bolditalic:`SENSOR`: (optional) :ref:`NXsensor` The sensor information for the photodiode or interferometer. .. _/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER-group: :bolditalic:`SPM_CANTILEVER`: (recommended) :ref:`NXspm_cantilever` The cantilever information. .. _/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/cantilever_oscillator-group: **cantilever_oscillator**: (recommended) :ref:`NXspm_cantilever_oscillator` :ref:`⤆ ` .. collapse:: When a cantilever is oscillated close to its resonance, this describes t ... When a cantilever is oscillated close to its resonance, this describes the oscillator properties. A cantilever can be used in direct contact mode to detect interaction forces or oscillated close to its resonance frequency. Changes in the oscillation amplitude, phase (between oscillated tail and moving tip) or resonance frequency are very sensitive to changes in the interaction potential field, giving rise of various measurement modes, such as non-contact or intermittent-contact (tapping) modes. .. _/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/cantilever_oscillator/reference_amplitude-field: .. index:: reference_amplitude (field) **reference_amplitude**: (recommended) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/cantilever_oscillator/reference_frequency-field: .. index:: reference_frequency (field) **reference_frequency**: (recommended) :ref:`NX_NUMBER ` {units=\ :ref:`NX_FREQUENCY `} :ref:`⤆ ` .. _/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/cantilever_oscillator/reference_phase-field: .. index:: reference_phase (field) **reference_phase**: (recommended) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/phase_positioner-group: **phase_positioner**: (recommended) :ref:`NXpositioner` :ref:`⤆ ` The phase positioner of the cantilever. .. _/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/amplitude_positioner-group: **amplitude_positioner**: (recommended) :ref:`NXpositioner` :ref:`⤆ ` The amplitude positioner of the cantilever. .. _/NXafm/ENTRY/INSTRUMENT/phase_lock_loop-group: **phase_lock_loop**: (recommended) :ref:`NXphase_lock_loop` Phase locked loop for cantilever lock-in device. .. _/NXafm/ENTRY/INSTRUMENT/SCAN_ENVIRONMENT-group: :bolditalic:`SCAN_ENVIRONMENT`: (required) :ref:`NXenvironment` :ref:`⤆ ` The environment information. .. _/NXafm/ENTRY/INSTRUMENT/SCAN_ENVIRONMENT/XYpiezo_sensor-group: :bolditalic:`XY`\ **piezo_sensor**: (optional) :ref:`NXspm_piezo_sensor` :ref:`⤆ ` .. collapse:: This should be a link to the concept ... This should be a link to the concept entry/instrument/xy_piezo_sensor. .. _/NXafm/ENTRY/INSTRUMENT/SCAN_ENVIRONMENT/head_temperature_sensor-group: **head_temperature_sensor**: (optional) :ref:`NXsensor` :ref:`⤆ ` .. collapse:: This should be a link to the concept ... This should be a link to the concept entry/instrument/head_temperature_sensor. .. _/NXafm/ENTRY/INSTRUMENT/head_temperature_sensor-group: **head_temperature_sensor**: (optional) :ref:`NXsensor` The temperature of the scan environment or head of the cantilever. .. _/NXafm/ENTRY/reproducibility_indicators-group: **reproducibility_indicators**: (optional) :ref:`NXcollection` :ref:`⤆ ` .. collapse:: The group of indicators (links to the existing fields in different groups) t ... The group of indicators (links to the existing fields in different groups) that measure the reproducibility of the experiment. .. _/NXafm/ENTRY/reproducibility_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 .. _/NXafm/ENTRY/reproducibility_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 .. _/NXafm/ENTRY/reproducibility_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 .. _/NXafm/ENTRY/reproducibility_indicators/cantilever_oscillator-group: **cantilever_oscillator**: (optional) :ref:`NXspm_cantilever_oscillator` .. collapse:: This should be a link to ... This should be a link to /entry/instrument/cantilever_spm/cantilever_oscillator .. _/NXafm/ENTRY/resolution_indicators-group: **resolution_indicators**: (optional) :ref:`NXcollection` :ref:`⤆ ` The group of indicators (links to the existing fields in different groups) that .. _/NXafm/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 .. _/NXafm/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 .. _/NXafm/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 .. _/NXafm/ENTRY/resolution_indicators/cantilever_config-field: .. index:: cantilever_config (field) **cantilever_config**: (optional) :ref:`NX_NUMBER ` .. collapse:: This should be a link to ... This should be a link to /entry/instrument/cantilever_spm/cantilever_config .. _/NXafm/ENTRY/resolution_indicators/amplitude_excitation-field: .. index:: amplitude_excitation (field) **amplitude_excitation**: (optional) :ref:`NX_NUMBER ` .. collapse:: This should be a link to ... This should be a link to /entry/instrument/phase_lock_loop/amplitude_excitation Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXafm/ENTRY-group ` * :ref:`/NXafm/ENTRY/definition-field ` * :ref:`/NXafm/ENTRY/experiment_technique-field ` * :ref:`/NXafm/ENTRY/INSTRUMENT-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/head_temperature_sensor-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/phase_lock_loop-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/photo_detector-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/photo_detector/SENSOR-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/SCAN_ENVIRONMENT-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/SCAN_ENVIRONMENT/head_temperature_sensor-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/SCAN_ENVIRONMENT/XYpiezo_sensor-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/amplitude_positioner-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/cantilever_oscillator-group ` * :ref:`/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/cantilever_oscillator/reference_amplitude-field ` * :ref:`/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/cantilever_oscillator/reference_frequency-field ` * :ref:`/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/cantilever_oscillator/reference_phase-field ` * :ref:`/NXafm/ENTRY/INSTRUMENT/SPM_CANTILEVER/phase_positioner-group ` * :ref:`/NXafm/ENTRY/reproducibility_indicators-group ` * :ref:`/NXafm/ENTRY/reproducibility_indicators/cantilever_oscillator-group ` * :ref:`/NXafm/ENTRY/reproducibility_indicators/cryo_bottom_temperature-field ` * :ref:`/NXafm/ENTRY/reproducibility_indicators/cryo_shield_temperature-field ` * :ref:`/NXafm/ENTRY/reproducibility_indicators/head_temperature-field ` * :ref:`/NXafm/ENTRY/resolution_indicators-group ` * :ref:`/NXafm/ENTRY/resolution_indicators/amplitude_excitation-field ` * :ref:`/NXafm/ENTRY/resolution_indicators/cantilever_config-field ` * :ref:`/NXafm/ENTRY/resolution_indicators/cryo_bottom_temperature-field ` * :ref:`/NXafm/ENTRY/resolution_indicators/cryo_shield_temperature-field ` * :ref:`/NXafm/ENTRY/resolution_indicators/head_temperature-field ` * :ref:`/NXafm/ENTRY/scan_mode-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXafm.nxdl.xml