.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXsensor_scan.nxdl.xml .. index:: ! NXsensor_scan (application definition) ! sensor_scan (application definition) see: sensor_scan (application definition); NXsensor_scan .. _NXsensor_scan: ============= NXsensor_scan ============= **Status**: application definition, extends :ref:`NXobject` **Description**: Application definition for a generic scan using sensors. In this application definition, times should be specified always together with an UTC offset. **Symbols**: No symbol table **Groups cited**: :ref:`NXdata`, :ref:`NXentry`, :ref:`NXenvironment`, :ref:`NXinstrument`, :ref:`NXpid`, :ref:`NXprocess`, :ref:`NXsample`, :ref:`NXsensor`, :ref:`NXuser` .. index:: NXentry (base class); used in application definition, NXprocess (base class); used in application definition, NXuser (base class); used in application definition, NXinstrument (base class); used in application definition, NXenvironment (base class); used in application definition, NXsensor (base class); used in application definition, NXdata (base class); used in application definition, NXpid (base class); used in application definition, NXsample (base class); used in application definition **Structure**: .. _/NXsensor_scan/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` .. _/NXsensor_scan/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` Obligatory value: ``NXsensor_scan`` .. _/NXsensor_scan/ENTRY/definition@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXsensor_scan/ENTRY/experiment_identifier-field: .. index:: experiment_identifier (field) **experiment_identifier**: (recommended) :ref:`NX_CHAR ` .. _/NXsensor_scan/ENTRY/experiment_description-field: .. index:: experiment_description (field) **experiment_description**: (required) :ref:`NX_CHAR ` .. _/NXsensor_scan/ENTRY/start_time-field: .. index:: start_time (field) **start_time**: (recommended) :ref:`NX_DATE_TIME ` .. _/NXsensor_scan/ENTRY/end_time-field: .. index:: end_time (field) **end_time**: (recommended) :ref:`NX_DATE_TIME ` .. _/NXsensor_scan/ENTRY/PROCESS-group: **PROCESS**: (required) :ref:`NXprocess` Define the program that was used to generate the results file(s) with measured data and metadata. .. _/NXsensor_scan/ENTRY/PROCESS/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` Commercial or otherwise defined given name of the program (or a link to the instrument software). .. _/NXsensor_scan/ENTRY/PROCESS/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` Either version with build number, commit hash, or description of an (online) repository where the source code of the program and build instructions can be found so that the program can be configured in such a way that result files can be created ideally in a deterministic manner. .. _/NXsensor_scan/ENTRY/PROCESS/program@program_url-attribute: .. index:: program_url (field attribute) **@program_url**: (required) :ref:`NX_CHAR ` Website of the software. .. _/NXsensor_scan/ENTRY/USER-group: **USER**: (required) :ref:`NXuser` Contact information of at least the user of the instrument or the investigator who performed this experiment. Adding multiple users if relevant is recommended. .. _/NXsensor_scan/ENTRY/USER/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` Name of the user. .. _/NXsensor_scan/ENTRY/USER/affiliation-field: .. index:: affiliation (field) **affiliation**: (recommended) :ref:`NX_CHAR ` Name of the affiliation of the user at the point in time when the experiment was performed. .. _/NXsensor_scan/ENTRY/USER/address-field: .. index:: address (field) **address**: (recommended) :ref:`NX_CHAR ` Full address (street, street number, ZIP, city, country) of the user's affiliation. .. _/NXsensor_scan/ENTRY/USER/email-field: .. index:: email (field) **email**: (recommended) :ref:`NX_CHAR ` Email address of the user. .. _/NXsensor_scan/ENTRY/USER/orcid-field: .. index:: orcid (field) **orcid**: (recommended) :ref:`NX_CHAR ` Author ID defined by https://orcid.org/. .. _/NXsensor_scan/ENTRY/USER/telephone_number-field: .. index:: telephone_number (field) **telephone_number**: (recommended) :ref:`NX_CHAR ` Official telephone number of the user. .. _/NXsensor_scan/ENTRY/INSTRUMENT-group: **INSTRUMENT**: (required) :ref:`NXinstrument` .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT-group: **ENVIRONMENT**: (required) :ref:`NXenvironment` Describes an environment setup for the experiment. All the setting values of the independently scanned controllers are listed under corresponding NXsensor groups. Similarly, seperate NXsensor groups are used to store the readings from each measurement sensor. For example, in a temperature-dependent IV measurement, the temperature and voltage must be present as independently scanned controllers and the current sensor must also be present with its readings. .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/independent_controllers-field: .. index:: independent_controllers (field) **independent_controllers**: (required) :ref:`NX_CHAR ` A list of names of NXsensor groups used as independently scanned controllers. .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/measurement_sensors-field: .. index:: measurement_sensors (field) **measurement_sensors**: (required) :ref:`NX_CHAR ` A list of names of NXsensor groups used as measurement sensors. .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR-group: **SENSOR**: (required) :ref:`NXsensor` .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/value-field: .. index:: value (field) **value**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} For each point in the scan space, either the nominal setpoint of an independently scanned controller or a representative average value of a measurement sensor is registered. In case of a full multi-dimensional scan, the length of the scan space [n] is the product of the number of setpoints along all independently scanned controllers. .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/value_timestamp-field: .. index:: value_timestamp (field) **value_timestamp**: (recommended) :ref:`NX_DATE_TIME ` Timestamp for when the values provided in the value field were registered. Individual readings can be stored with their timestamps under value_log. This is to timestamp the nominal setpoint or average reading values listed above in the value field. .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/run_control-field: .. index:: run_control (field) **run_control**: (recommended) :ref:`NX_CHAR ` .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/run_control@description-attribute: .. index:: description (field attribute) **@description**: (required) :ref:`NX_CHAR ` Free-text describing the data acquisition control: an internal sweep using the built-in functionality of the controller device, or a set/wait/read/repeat mechanism. .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/calibration_time-field: .. index:: calibration_time (field) **calibration_time**: (required) :ref:`NX_DATE_TIME ` ISO8601 datum when calibration was last performed before this measurement. UTC offset should be specified. .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/DATA-group: **DATA**: (recommended) :ref:`NXdata` Plot of measured signal as a function of the timestamp of when they have been acquired is also possible. .. _/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/PID-group: **PID**: (required) :ref:`NXpid` .. _/NXsensor_scan/ENTRY/SAMPLE-group: **SAMPLE**: (required) :ref:`NXsample` .. _/NXsensor_scan/ENTRY/SAMPLE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` .. _/NXsensor_scan/ENTRY/DATA-group: **DATA**: (required) :ref:`NXdata` A scan specific representation of the measured signals as a function of the independently controlled environment settings. Plot of every measured signal as a function of the timestamp of when they have been acquired is also possible. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXsensor_scan/ENTRY-group ` * :ref:`/NXsensor_scan/ENTRY/DATA-group ` * :ref:`/NXsensor_scan/ENTRY/definition-field ` * :ref:`/NXsensor_scan/ENTRY/definition@version-attribute ` * :ref:`/NXsensor_scan/ENTRY/end_time-field ` * :ref:`/NXsensor_scan/ENTRY/experiment_description-field ` * :ref:`/NXsensor_scan/ENTRY/experiment_identifier-field ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT-group ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT-group ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/independent_controllers-field ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/measurement_sensors-field ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/PID-group ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR-group ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/calibration_time-field ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/DATA-group ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/run_control-field ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/run_control@description-attribute ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/value-field ` * :ref:`/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/value_timestamp-field ` * :ref:`/NXsensor_scan/ENTRY/PROCESS-group ` * :ref:`/NXsensor_scan/ENTRY/PROCESS/program-field ` * :ref:`/NXsensor_scan/ENTRY/PROCESS/program@program_url-attribute ` * :ref:`/NXsensor_scan/ENTRY/PROCESS/program@version-attribute ` * :ref:`/NXsensor_scan/ENTRY/SAMPLE-group ` * :ref:`/NXsensor_scan/ENTRY/SAMPLE/name-field ` * :ref:`/NXsensor_scan/ENTRY/start_time-field ` * :ref:`/NXsensor_scan/ENTRY/USER-group ` * :ref:`/NXsensor_scan/ENTRY/USER/address-field ` * :ref:`/NXsensor_scan/ENTRY/USER/affiliation-field ` * :ref:`/NXsensor_scan/ENTRY/USER/email-field ` * :ref:`/NXsensor_scan/ENTRY/USER/name-field ` * :ref:`/NXsensor_scan/ENTRY/USER/orcid-field ` * :ref:`/NXsensor_scan/ENTRY/USER/telephone_number-field ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXsensor_scan.nxdl.xml