.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXiv_temp.nxdl.xml .. index:: ! NXiv_temp (application definition) ! iv_temp (application definition) see: iv_temp (application definition); NXiv_temp .. _NXiv_temp: ========= NXiv_temp ========= **Status**: application definition, extends :ref:`NXobject` **Description**: Application definition for temperature-dependent IV curve measurements. In this application definition, times should be specified always together with an UTC offset. This is the application definition describing temperature dependent IV curve measurements. For this a temperature is set. After reaching the temperature, a voltage sweep is performed. For each voltage a current is measured. Then, the next desired temperature is set and an IV measurement is performed. The application definition defines: - elements of the experimental instrument - calibration information if available - parameters used to tune the state of the sample - sample description **Symbols**: Variables used throughout the document, e.g. dimensions and important parameters **N_data_points**: Number of elements in the scanned voltage array **N_variables**: Number of additional variables that are changed with the temperature (can be understood as columns next to the temperature) **N_different_temperatures**: Number of different temperatures that are set **Groups cited**: :ref:`NXdata`, :ref:`NXentry`, :ref:`NXenvironment`, :ref:`NXinstrument`, :ref:`NXprocess`, :ref:`NXsample`, :ref:`NXsensor`, :ref:`NXsubentry`, :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, NXsensor (base class); used in application definition, NXsubentry (base class); used in application definition, NXenvironment (base class); used in application definition, NXsample (base class); used in application definition, NXdata (base class); used in application definition **Structure**: .. _/NXiv_temp/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` .. _/NXiv_temp/ENTRY@version-attribute: .. index:: version (group attribute) **@version**: (required) :ref:`NX_CHAR ` Version number to identify which definition of this application definition was used for this entry/data. .. _/NXiv_temp/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` NeXus NXDL schema to which this file conforms. Obligatory value: ``NXiv_temp`` .. _/NXiv_temp/ENTRY/definition@url-attribute: .. index:: url (field attribute) **@url**: (optional) :ref:`NX_CHAR ` URL where to find further material (documentation, examples) relevant to the application definition .. _/NXiv_temp/ENTRY/experiment_identifier-field: .. index:: experiment_identifier (field) **experiment_identifier**: (required) :ref:`NX_CHAR ` Unique identifier of the experiment, such as a (globally persistent) unique identifier. The identifier is usually defined by the facility or principle investigator. The identifier enables to link experiments to e.g. proposals. .. _/NXiv_temp/ENTRY/experiment_description-field: .. index:: experiment_description (field) **experiment_description**: (required) :ref:`NX_CHAR ` Description of the exact experiment performed. .. _/NXiv_temp/ENTRY/start_time-field: .. index:: start_time (field) **start_time**: (recommended) :ref:`NX_DATE_TIME ` UTC offset should be specifiec. .. _/NXiv_temp/ENTRY/PROCESS-group: **PROCESS**: (optional) :ref:`NXprocess` Define the program that was used to generate the results file(s) with measured data and metadata. .. _/NXiv_temp/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). .. _/NXiv_temp/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. .. _/NXiv_temp/ENTRY/PROCESS/program@program_url-attribute: .. index:: program_url (field attribute) **@program_url**: (recommended) :ref:`NX_CHAR ` Website of the software. .. _/NXiv_temp/ENTRY/operator-group: **operator**: (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. .. _/NXiv_temp/ENTRY/operator/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` Name of the user. .. _/NXiv_temp/ENTRY/operator/affiliation-field: .. index:: affiliation (field) **affiliation**: (required) :ref:`NX_CHAR ` Name of the affiliation of the user at the point in time when the experiment was performed. .. _/NXiv_temp/ENTRY/operator/address-field: .. index:: address (field) **address**: (required) :ref:`NX_CHAR ` Full address (street, street number, ZIP, city, country) of the user's affiliation. .. _/NXiv_temp/ENTRY/operator/email-field: .. index:: email (field) **email**: (required) :ref:`NX_CHAR ` Email address of the user. .. _/NXiv_temp/ENTRY/operator/orcid-field: .. index:: orcid (field) **orcid**: (recommended) :ref:`NX_CHAR ` Author ID defined by https://orcid.org/. .. _/NXiv_temp/ENTRY/operator/telephone_number-field: .. index:: telephone_number (field) **telephone_number**: (recommended) :ref:`NX_CHAR ` Official telephone number of the user. .. _/NXiv_temp/ENTRY/INSTRUMENT-group: **INSTRUMENT**: (required) :ref:`NXinstrument` General properties of the temperature dependent IV curve measurements equipment .. _/NXiv_temp/ENTRY/INSTRUMENT/IVvoltage_source-group: **IVvoltage_source**: (required) :ref:`NXsensor` Specify the used voltage source used in the voltage sweep for the IV measurement. .. _/NXiv_temp/ENTRY/INSTRUMENT/IVvoltage_source/model-field: .. index:: model (field) **model**: (optional) :ref:`NX_CHAR ` Free-text desribing the model and make of the voltage source which is used for the IV sweep measurement. .. _/NXiv_temp/ENTRY/INSTRUMENT/IVvoltage_source/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` Custom name of the voltage source for the IV sweep given by the user/institution. .. _/NXiv_temp/ENTRY/INSTRUMENT/IVvoltage_source/measurement-field: .. index:: measurement (field) **measurement**: (optional) :ref:`NX_CHAR ` Free-text describing the measurement performed in a few words. .. _/NXiv_temp/ENTRY/INSTRUMENT/IVvoltage_source/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` Free-text describing the type of voltage setting: an internal sweep using the functionality of the voltage supply, or a set/wait/read/repeat mechanism. .. _/NXiv_temp/ENTRY/INSTRUMENT/IVcurrent_source-group: **IVcurrent_source**: (required) :ref:`NXsensor` Specify the used current source used in the voltage sweep for the IV measurement." .. _/NXiv_temp/ENTRY/INSTRUMENT/IVcurrent_source/model-field: .. index:: model (field) **model**: (optional) :ref:`NX_CHAR ` Free-text desribing the model and make of the current source which is used for the IV sweep measurement. .. _/NXiv_temp/ENTRY/INSTRUMENT/IVcurrent_source/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` Custom name of the current source for the IV sweep given by the user/institution .. _/NXiv_temp/ENTRY/INSTRUMENT/IVcurrent_source/measurement-field: .. index:: measurement (field) **measurement**: (optional) :ref:`NX_CHAR ` Free-text describing the measurement performed in a few words .. _/NXiv_temp/ENTRY/INSTRUMENT/IVcurrent_source/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` Free-text describing the type of current measuring: an internal sweep using the functionality of the voltage supply, or a set/wait/read/repeat mechanism. .. _/NXiv_temp/ENTRY/INSTRUMENT/calibration-group: **calibration**: (optional) :ref:`NXsubentry` Calibration of the temperature sensor is possible .. _/NXiv_temp/ENTRY/INSTRUMENT/calibration/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. .. _/NXiv_temp/ENTRY/INSTRUMENT/temperature_control-group: **temperature_control**: (optional) :ref:`NXsubentry` Describes the system for controlling the temperature if temperature control was used. .. _/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` What kind of temperature control was used? PID, custom temp control? .. _/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/temp_sensor_type-field: .. index:: temp_sensor_type (field) **temp_sensor_type**: (required) :ref:`NX_CHAR ` Specify the temperature sensor that was used Any of these values: ``thermocouple`` | ``thermistor`` | ``RTD`` | ``other`` .. _/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/other_temp_sensor-field: .. index:: other_temp_sensor (field) **other_temp_sensor**: (optional) :ref:`NX_CHAR ` If you specified 'other' as temperature sensor, please write down what it is. .. _/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/raw_temp_data-field: .. index:: raw_temp_data (field) **raw_temp_data**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [N_raw_temp_data]) Data of the most principal measurement of the temperature. For example resistance of a Pt1000. .. _/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/conversion_function-field: .. index:: conversion_function (field) **conversion_function**: (optional) :ref:`NX_CHAR ` Algebraic function that is used to determine temperature from the raw_temp_data. All values should be given in SI units. .. _/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/PID_settings-group: **PID_settings**: (optional) :ref:`NXenvironment` Specify the settings of the PID temperature controller: K_p, K_i, and K_d values used for the temperature control .. _/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/PID_settings/K_p_value-field: .. index:: K_p_value (field) **K_p_value**: (required) :ref:`NX_NUMBER ` Proportional term. The proportional term produces an output value that is proportional to the current error value. The proportional response can be adjusted by multiplying the error by a constant Kp, called the proportional gain constant. .. _/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/PID_settings/K_i_value-field: .. index:: K_i_value (field) **K_i_value**: (required) :ref:`NX_NUMBER ` The contribution from the integral term is proportional to both the magnitude of the error and the duration of the error. The integral in a PID controller is the sum of the instantaneous error over time and gives the accumulated offset that should have been corrected previously. The accumulated error is then multiplied by the integral gain (Ki) and added to the controller output. .. _/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/PID_settings/K_d_value-field: .. index:: K_d_value (field) **K_d_value**: (required) :ref:`NX_NUMBER ` The derivative of the process error is calculated by determining the slope of the error over time and multiplying this rate of change by the derivative gain K_d. The magnitude of the contribution of the derivative term to the overall control action is termed the derivative gain, K_d .. _/NXiv_temp/ENTRY/SAMPLE-group: **SAMPLE**: (required) :ref:`NXsample` Properties of the sample, its history, the sample environment and experimental conditions (e.g. surrounding medium, temperature, pressure etc.), along with the data (data type, wavelength array, measured data). .. _/NXiv_temp/ENTRY/SAMPLE/sample_name-field: .. index:: sample_name (field) **sample_name**: (required) :ref:`NX_CHAR ` Descriptive name of the sample .. _/NXiv_temp/ENTRY/SAMPLE/sample_history-field: .. index:: sample_history (field) **sample_history**: (required) :ref:`NX_CHAR ` Ideally, a reference to the location or a unique (globally persistent) identifier (e.g.) of e.g. another file which gives as many as possible details of the material, its microstructure. In the case that such a detailed history of the sample is not available, use this field as a free-text description to specify details of the sample and its preparation. .. _/NXiv_temp/ENTRY/SAMPLE/preparation_date-field: .. index:: preparation_date (field) **preparation_date**: (recommended) :ref:`NX_DATE_TIME ` ISO 8601 date with time zone specified. UTC offset should be specified. .. _/NXiv_temp/ENTRY/SAMPLE/data_identifier-field: .. index:: data_identifier (field) **data_identifier**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_UNITLESS `} An identifier to correlate data to the experimental conditions, if several were used in this measurement; typically an index of 0 - N .. _/NXiv_temp/ENTRY/SAMPLE/measured_data-field: .. index:: measured_data (field) **measured_data**: (required) :ref:`NX_NUMBER ` (Rank: 3, Dimensions: [N_data_points, N_variables, N_different_temperatures]) Resulting data from the measurement, described by data type. .. _/NXiv_temp/ENTRY/SAMPLE/environment_conditions-field: .. index:: environment_conditions (field) **environment_conditions**: (optional) :ref:`NX_CHAR ` Information about external parameters that have influenced the sample. .. _/NXiv_temp/ENTRY/SAMPLE/varied_parameters-field: .. index:: varied_parameters (field) **varied_parameters**: (optional) :ref:`NX_CHAR ` Indicates which parameter was changed. Its definition must exist below. The specified variable has to be number_of_runs long, providing the parameters for each data set. Obligatory value: ``temperature`` .. _/NXiv_temp/ENTRY/plot-group: **plot**: (optional) :ref:`NXdata` A default view of the data. The current (y-axis) should be plotted against the voltage (x-axis) with color coding for the temperature of each IV-curve. .. _/NXiv_temp/ENTRY/plot@long_name-attribute: .. index:: long_name (group attribute) **@long_name**: (required) :ref:`NX_CHAR ` IV curve. .. _/NXiv_temp/ENTRY/plot/voltage-field: .. index:: voltage (field) **voltage**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [N_data_points]) {units=\ :ref:`NX_VOLTAGE `} Array of voltage values on the independent axis supporting the curve. .. _/NXiv_temp/ENTRY/plot/current-field: .. index:: current (field) **current**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} Array of current values on the dependent axis of the curve. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXiv_temp/ENTRY-group ` * :ref:`/NXiv_temp/ENTRY/definition-field ` * :ref:`/NXiv_temp/ENTRY/definition@url-attribute ` * :ref:`/NXiv_temp/ENTRY/experiment_description-field ` * :ref:`/NXiv_temp/ENTRY/experiment_identifier-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT-group ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/calibration-group ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/calibration/calibration_time-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/IVcurrent_source-group ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/IVcurrent_source/measurement-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/IVcurrent_source/model-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/IVcurrent_source/name-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/IVcurrent_source/type-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/IVvoltage_source-group ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/IVvoltage_source/measurement-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/IVvoltage_source/model-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/IVvoltage_source/name-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/IVvoltage_source/type-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/temperature_control-group ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/conversion_function-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/other_temp_sensor-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/PID_settings-group ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/PID_settings/K_d_value-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/PID_settings/K_i_value-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/PID_settings/K_p_value-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/raw_temp_data-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/temp_sensor_type-field ` * :ref:`/NXiv_temp/ENTRY/INSTRUMENT/temperature_control/type-field ` * :ref:`/NXiv_temp/ENTRY/operator-group ` * :ref:`/NXiv_temp/ENTRY/operator/address-field ` * :ref:`/NXiv_temp/ENTRY/operator/affiliation-field ` * :ref:`/NXiv_temp/ENTRY/operator/email-field ` * :ref:`/NXiv_temp/ENTRY/operator/name-field ` * :ref:`/NXiv_temp/ENTRY/operator/orcid-field ` * :ref:`/NXiv_temp/ENTRY/operator/telephone_number-field ` * :ref:`/NXiv_temp/ENTRY/plot-group ` * :ref:`/NXiv_temp/ENTRY/plot/current-field ` * :ref:`/NXiv_temp/ENTRY/plot/voltage-field ` * :ref:`/NXiv_temp/ENTRY/plot@long_name-attribute ` * :ref:`/NXiv_temp/ENTRY/PROCESS-group ` * :ref:`/NXiv_temp/ENTRY/PROCESS/program-field ` * :ref:`/NXiv_temp/ENTRY/PROCESS/program@program_url-attribute ` * :ref:`/NXiv_temp/ENTRY/PROCESS/program@version-attribute ` * :ref:`/NXiv_temp/ENTRY/SAMPLE-group ` * :ref:`/NXiv_temp/ENTRY/SAMPLE/data_identifier-field ` * :ref:`/NXiv_temp/ENTRY/SAMPLE/environment_conditions-field ` * :ref:`/NXiv_temp/ENTRY/SAMPLE/measured_data-field ` * :ref:`/NXiv_temp/ENTRY/SAMPLE/preparation_date-field ` * :ref:`/NXiv_temp/ENTRY/SAMPLE/sample_history-field ` * :ref:`/NXiv_temp/ENTRY/SAMPLE/sample_name-field ` * :ref:`/NXiv_temp/ENTRY/SAMPLE/varied_parameters-field ` * :ref:`/NXiv_temp/ENTRY/start_time-field ` * :ref:`/NXiv_temp/ENTRY@version-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXiv_temp.nxdl.xml