NXsensor_scan¶
Status:
application definition, extends 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:
NXdata, NXentry, NXenvironment, NXinstrument, NXpid, NXprocess, NXsample, NXsensor, NXuser
Structure:
ENTRY: (required) NXentry
definition: (required) NX_CHAR
Obligatory value:
NXsensor_scan
@version: (required) NX_CHAR
experiment_identifier: (recommended) NX_CHAR
experiment_description: (required) NX_CHAR
start_time: (recommended) NX_DATE_TIME
end_time: (recommended) NX_DATE_TIME
PROCESS: (required) NXprocess
Define the program that was used to generate the results file(s) with measured data and metadata.
program: (required) NX_CHAR
Commercial or otherwise defined given name of the program (or a link to the instrument software).
@version: (required) 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.
@program_url: (required) NX_CHAR
Website of the software.
USER: (required) 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.
name: (required) NX_CHAR
Name of the user.
affiliation: (recommended) NX_CHAR
Name of the affiliation of the user at the point in time when the experiment was performed.
address: (recommended) NX_CHAR
Full address (street, street number, ZIP, city, country) of the user’s affiliation.
email: (recommended) NX_CHAR
Email address of the user.
orcid: (recommended) NX_CHAR
Author ID defined by https://orcid.org/.
telephone_number: (recommended) NX_CHAR
Official telephone number of the user.
INSTRUMENT: (required) NXinstrument
ENVIRONMENT: (required) 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.
independent_controllers: (required) NX_CHAR
A list of names of NXsensor groups used as independently scanned controllers.
measurement_sensors: (required) NX_CHAR
A list of names of NXsensor groups used as measurement sensors.
SENSOR: (required) NXsensor
value: (required) NX_FLOAT {units=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.
value_timestamp: (recommended) 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.
run_control: (recommended) NX_CHAR
@description: (required) 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.
calibration_time: (required) NX_DATE_TIME
ISO8601 datum when calibration was last performed before this measurement. UTC offset should be specified.
DATA: (recommended) NXdata
Plot of measured signal as a function of the timestamp of when they have been acquired is also possible.
PID: (required) NXpid
SAMPLE: (required) NXsample
name: (required) NX_CHAR
DATA: (required) 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.
/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/independent_controllers-field
/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/measurement_sensors-field
/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/calibration_time-field
/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/DATA-group
/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/run_control-field
/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/run_control@description-attribute
/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/value-field
/NXsensor_scan/ENTRY/INSTRUMENT/ENVIRONMENT/SENSOR/value_timestamp-field