2.3.3.3.148. NXmanipulator

Status:

base class, extends NXobject

Description:

Extension of NXpositioner to include fields to describe the use of manipulators ...

Extension of NXpositioner to include fields to describe the use of manipulators in photoemission experiments.

Symbols:

No symbol table

Groups cited:

NXactuator, NXfabrication, NXlog, NXpid, NXpositioner, NXsensor, NXtransformations

Structure:

@default: (optional) NX_CHAR

Declares which child group contains a path leading ...

Declares which child group contains a path leading to a NXdata group.

It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion.

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.

depends_on: (optional) NX_CHAR

Refers to the last transformation specifying the positon of the manipulator in ...

Refers to the last transformation specifying the positon of the manipulator in the NXtransformations chain.

cryostat: (optional) NXactuator

Cryostat for cooling the sample.

physical_quantity: (optional) NX_CHAR ⤆

Obligatory value: temperature

PID: (optional) NXpid ⤆

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 length m 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.

physical_quantity: (optional) NX_CHAR ⤆

Obligatory value: temperature

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).

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: (optional) NXpid ⤆

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_amperemeter: (optional) NXsensor

Amperemeter 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 to sample and sample holder.

physical_quantity: (optional) NX_CHAR ⤆

Obligatory value: voltage

PID: (optional) NXpid ⤆

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

TRANSFORMATIONS: (optional) NXtransformations

Collection of axis-based translations and rotations to describe the location a ...

Collection of axis-based translations and rotations to describe the location and geometry of the manipulator as a component in the instrument. Conventions from the NXtransformations base class are used. In principle, the McStas coordinate system is used. The first transformation has to point either to another component of the system or . (for pointing to the reference frame) to relate it relative to the experimental setup. Typically, the components of a system should all be related relative to each other and only one component should relate to the reference coordinate system.

FABRICATION: (optional) NXfabrication

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