2.3.3.3.115. NXmanipulator

Status:

base class (contribution), extends NXcomponent

Description:

Base class to describe the use of manipulators and sample stages.

Symbols:

No symbol table

Groups cited:

NXactuator, NXlog, NXpid_controller, NXpositioner, NXsensor

Structure:

name: (optional) NX_CHAR ⤆

Name of the manipulator.

description: (optional) NX_CHAR ⤆

A description of the manipulator.

type: (optional) NX_CHAR

Type of manipulator, Hexapod, Rod, etc.

cryostat: (optional) NXactuator

Cryostat for cooling the sample (and, potentially, the whole manipulator).

actuation_target: (optional) NX_CHAR ⤆

Obligatory value: temperature

PID_CONTROLLER: (optional) NXpid_controller ⤆

setpoint: (optional) NX_FLOAT {units=NX_TEMPERATURE} ⤆

In case of a fixed or averaged cooling temperature, this is the scalar tem ...

In case of a fixed or averaged cooling temperature, this is the scalar temperature setpoint. It can also be a 1D array of temperature setpoints (without time stamps).

setpoint_log: (optional) NXlog ⤆

value: (optional) NX_FLOAT {units=NX_TEMPERATURE}

In the case of an experiment in which the temperature is changed and the ...

In the case of an experiment in which the temperature is changed and the setpoints are recorded with time stamps, this is an array of temperature setpoints.

temperature_sensor: (optional) NXsensor

Temperature sensor measuring the sample temperature.

measurement: (optional) NX_CHAR ⤆

Obligatory value: temperature

value: (optional) NX_FLOAT {units=NX_TEMPERATURE} ⤆

In case of a single or averaged temperature measurement, this is the scalar ...

In case of a single or averaged temperature measurement, this is the scalar temperature measured by the sample temperature sensor. It can also be a 1D array of measured temperatures (without time stamps).

value_log: (optional) NXlog ⤆

value: (optional) NX_FLOAT {units=NX_TEMPERATURE}

In the case of an experiment in which the temperature changes and is recor ...

In the case of an experiment in which the temperature changes and is recorded with time stamps, this is an array of length m of temperatures.

sample_heater: (optional) NXactuator

Device to heat the sample.

actuation_target: (optional) NX_CHAR ⤆

Obligatory value: temperature

output_heater_power: (optional) NX_FLOAT {units=NX_POWER}

In case of a fixed or averaged heating power, this is the scalar heater powe ...

In case of a fixed or averaged heating power, this is the scalar heater power. It can also be a 1D array of heater powers (without time stamps).

output_heater_power_log: (optional) NXlog ⤆

value: (optional) NX_FLOAT {units=NX_POWER}

In the case of an experiment in which the heater power is changed and reco ...

In the case of an experiment in which the heater power is changed and recorded with time stamps, this is an array of length m of temperature setpoints.

PID_CONTROLLER: (optional) NXpid_controller ⤆

setpoint: (optional) NX_FLOAT {units=NX_TEMPERATURE} ⤆

In case of a fixed or averaged temperature, this is the scalar temperature ...

In case of a fixed or averaged temperature, this is the scalar temperature setpoint. It can also be a 1D array of temperature setpoints (without time stamps).

setpoint_log: (optional) NXlog ⤆

value: (optional) NX_FLOAT {units=NX_TEMPERATURE}

In the case of an experiment in which the temperature is changed and the ...

In the case of an experiment in which the temperature is changed and the setpoints are recorded with time stamps, this is an array of length m of temperature setpoints.

drain_current_ammeter: (optional) NXsensor

Ammeter measuring the drain current of the sample and sample holder.

measurement: (optional) NX_CHAR ⤆

Obligatory value: current

value: (optional) NX_FLOAT {units=NX_CURRENT} ⤆

In case of a single or averaged drain current measurement, this is the scala ...

In case of a single or averaged drain current measurement, this is the scalar drain current measured between the sample and sample holder. It can also be an 1D array of measured currents (without time stamps).

value_log: (optional) NXlog ⤆

value: (optional) NX_FLOAT {units=NX_CURRENT}

In the case of an experiment in which the current changes and is recorded ...

In the case of an experiment in which the current changes and is recorded with time stamps, this is an array of length m of currents.

sample_bias_potentiostat: (optional) NXactuator

Actuator applying a voltage between sample holder and sample.

actuation_target: (optional) NX_CHAR ⤆

Obligatory value: voltage

PID_CONTROLLER: (optional) NXpid_controller ⤆

setpoint: (optional) NX_FLOAT {units=NX_VOLTAGE} ⤆

In case of a fixed or averaged applied bias, this is the scalar voltage ap ...

In case of a fixed or averaged applied bias, this is the scalar voltage applied between sample and sample holder. It can also be an 1D array of voltage setpoints (without time stamps).

setpoint_log: (optional) NXlog ⤆

value: (optional) NX_FLOAT {units=NX_VOLTAGE}

In the case of an experiment in which the bias is changed and the setpoi ...

In the case of an experiment in which the bias is changed and the setpoints are recorded with time stamps, this is an array of length m of voltage setpoints.

sample_bias_voltmeter: (optional) NXsensor

Sensor measuring the voltage applied to sample and sample holder.

measurement: (optional) NX_CHAR ⤆

Obligatory value: voltage

value: (optional) NX_FLOAT {units=NX_VOLTAGE} ⤆

In case of a single or averaged bias measurement, this is the scalar voltage ...

In case of a single or averaged bias measurement, this is the scalar voltage measured between sample and sample holder. It can also be an 1D array of measured voltages (without time stamps).

value_log: (optional) NXlog ⤆

value: (optional) NX_FLOAT {units=NX_VOLTAGE}

In the case of an experiment in which the bias changes and is recorded wit ...

In the case of an experiment in which the bias changes and is recorded with time stamps, this is an array of length m of voltages.

ACTUATOR: (optional) NXactuator

Any additional actuator on the manipulator used to control an external ...

Any additional actuator on the manipulator used to control an external condition.

SENSOR: (optional) NXsensor

Any additional sensors on the manipulator used to monitor an external condition.

POSITIONER: (optional) NXpositioner

Class to describe the motors that are used in the manipulator.

Hypertext Anchors

List of hypertext anchors for all groups, fields, attributes, and links defined in this class.

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXmanipulator.nxdl.xml