2.3.3.3.52. NXbias_spectroscopy

Status:

base class, extends NXobject

Description:

Base classes definition for bias spectroscopy. ...

Base classes definition for bias spectroscopy.

Bias sweeps while measuring arbitrary channels with I(V) curves.

Symbols:

No symbol table

Groups cited:

none

Structure:

channels: (optional) NX_CHAR

Select the channels to record.

reset_bias: (optional) NX_BOOLEAN

If chosen, the Bias voltage resets to its initial value (before the sweep init ...

If chosen, the Bias voltage resets to its initial value (before the sweep initiation) at the conclusion of the spectroscopy measurement. When this option is not selected, the Bias voltage maintains the last value acquired during the sweep. This functionality proves beneficial, especially when combining multiple sweep segments. As an illustration of an automated measurement: turn off the z-Controller, commence spectroscopy sweep segments ( forward sweep only, without resetting the bias), restore the bias to its initial value, and then turn on the z-Controller.

record_final_z: (optional) NX_BOOLEAN

Select whether to record the Z position during Z averaging time at the end of ...

Select whether to record the Z position during Z averaging time at the end of the sweep (after Z control time) and store the average value in the header of the file when saving. Using this option increases the sweep time by Z averaging time.

lock_in_run: (optional) NX_BOOLEAN

Select whether to set the Lock-In to run during the measurement. When using th ...

Select whether to set the Lock-In to run during the measurement. When using this feature, make sure the Lock-In is configured correctly and settling times are set to twice the Lock-In period at least. This option is ignored when Lock-In is already running. This option is disabled if the Sweep Mode is MLS and the flag to configure the Lock-In per segment in the Multiline segment editor is set.

integration_time: (optional) NX_NUMBER {units=NX_TIME}

Time during which the spectroscopy data are acquired and averaged.

number_of_sweeps: (optional) NX_NUMBER

Number of sweeps to measure and average.

sweep_start: (optional) NX_NUMBER {units=NX_VOLTAGE}

The first bias values of the sweep.

sweep_end: (optional) NX_NUMBER {units=NX_VOLTAGE}

The last bias values of the sweep.

num_pixel: (optional) NX_NUMBER

Define the sweep number of points, that is, the maximum spectrum resolution eq ...

Define the sweep number of points, that is, the maximum spectrum resolution eq. Bias window divide by Num Pixel.

z_avg_time: (optional) NX_NUMBER {units=NX_TIME}

Duration over which the Z position is recorded and averaged before and after t ...

Duration over which the Z position is recorded and averaged before and after the sweep (the latter only if Record final Z position is selected in the Advanced section). After the initial z averaging time, if Z-Controller to Hold is selected in the Advanced section, the z-Controller is set to hold and the tip is placed at the previously averaged z position (plus z offset).

sw_filter_type: (optional) NX_CHAR

Select a filter to smooth the displayed data. When saving, if any filter is se ...

Select a filter to smooth the displayed data. When saving, if any filter is selected, filtered data are saved to file along with the unfiltered data.

sw_filter_order: (optional) NX_NUMBER

Filter order of a dynamic filter or width (in number of points) for the Gaussi ...

Filter order of a dynamic filter or width (in number of points) for the Gaussian filter.

sw_filter_cutoff_frq: (optional) NX_NUMBER

Cutoff frequency for dynamic filters.

z_offset: (optional) NX_NUMBER {units=NX_LENGTH}

Offset added to the initial averaged position Zaver before starting to sweep. ...

Offset added to the initial averaged position Zaver before starting to sweep. This parameter is disabled when Z-Controller to Hold is deselected in the Advanced section. The LED “Alt” next to the Z offset indicates if an alternate Z-controller setpoint is enabled.

settling_time: (optional) NX_NUMBER {units=NX_TIME}

Time to wait after changing the bias to the next level and before ...

Time to wait after changing the bias to the next level and before starting to acquire data.

first_settling_time: (optional) NX_NUMBER

No doc yet.

end_settling_time: (optional) NX_NUMBER {units=NX_TIME}

Time to wait after the sweep has finished and the bias is ramped to ...

Time to wait after the sweep has finished and the bias is ramped to the initial value.

z_control_time: (optional) NX_NUMBER {units=NX_TIME}

Time during which the Z-Controller is enabled once a sweep has finished. ...

Time during which the Z-Controller is enabled once a sweep has finished. When averaging multiple sweeps (i.e. Sweeps>1), the Z-Controller is enabled for this duration between each sweep. After the last sweep, it will wait the specified time before continuing a running scan. This ensures each sweep reliably starts from the same position. This parameter is disabled when Z-Controller to Hold is deselected in the Advanced section.

max_slew_rate: (optional) NX_NUMBER

Maximum rate at which the bias changes (before, during and after sweeping). ...

Maximum rate at which the bias changes (before, during and after sweeping). (V/s)

backward_sweep: (optional) NX_BOOLEAN

Select whether to measure the backward (return) sweep or the forward only.

z_ccontroller_hold: (optional) NX_BOOLEAN

Select whether to set the Z-Controller on hold (i.e. disabled) during the swee ...

Select whether to set the Z-Controller on hold (i.e. disabled) during the sweep. It is selected by default. When deselected, Z-offset and Z control time parameters are disabled.

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/NXbias_spectroscopy.nxdl.xml