mahos.inst.piezo.AnalogPiezo3Axes#

class mahos.inst.piezo.AnalogPiezo3Axes(name, conf, prefix=None)#

Generic Piezo Driver using DAQ AnalogIn and AnalogOut.

AnalogOut is used to output position command to Piezo Driver (amplifier), and AnalogIn is used to read the sensor value from Piezo Driver (amplifier).

Parameters:

  • lines (list[str]) – list of strings to designate DAQ AnalogOut physical channels. Order them as [x, y, z].

  • ai_lines (list[str]) – list of strings to designate DAQ AnalogIn physical channels. Order them as [x, y, z].

  • scale_volt_per_um (float) – the AnalogOut voltage scale in V / um. the output voltage is determined by: (pos_um - offset_um) * scale_volt_per_um.

  • offset_um (float) – the AnalogOut voltage offset in um. see scale_volt_per_um too.

  • ai_scale_volt_per_um (float) – (default: scale_volt_per_um) the AnalogIn voltage scale in V / um. the input voltage is considered as: (pos_um - ai_offset_um) * ai_scale_volt_per_um.

  • ai_offset_um (float) – (default: offset_um) the AnalogIn voltage offset in um. see ai_scale_volt_per_um too.

  • ont_error (float) – (default: 0.010) Threshold error in um to determine current position is on target or not.

  • ai_oversample (int) – (default: 1000) Number of sampling points to read current position.

  • ai_clock (str) – Clock source (counter name of DAQ) for AnalogIn. If (not) given, AnalogIn is used in clock_mode (on-demand mode).

  • ai_time_window (float) – (default: 10e-3) time window for AnalogIn sampling. Used only if ai_clock is given. AnalogIn sampling rate is given by: 1 / ai_time_window * ai_oversample.

  • ai_buffer_size (int) – (default: 200) buffer size for AnalogIn sampling. Used only if ai_clock is given.

  • samples_margin (int) – (has preset, default: 0) margin of samples for AnalogOut.

  • write_and_start (bool) – (has preset, default: True) if False, DAQ Task is started and then scan data is written in start_scan(). True reverses this order.

__init__(name, conf, prefix=None)#

Methods

__init__(name, conf[, prefix])

ai_um_to_volt(pos_um)

ai_um_to_volt_raw(pos_um)

ai_volt_to_um(volt)

close_resources()

Close instrument resources.

configure(params[, label])

Configure the instrument settings.

get(key[, args, label])

Get an instrument setting or measurement data.

get_pos()

get_pos_ont()

get_scan_buffer_size()

init_ai_clock(name, prefix)

init_ai_on_demand(name, prefix)

init_target_pos()

initialize self.target using current position.

join(timeout_sec)

load_conf_preset(dev_type)

move()

set(key[, value, label])

Set an instrument setting or commanding value.

start([label])

Start the instrument operation.

start_scan(scan_array)

start the configured scan with scan_array.

stop([label])

Stop the instrument operation.

um_to_volt(pos_um)

um_to_volt_raw(pos_um)

write_scan_array(scan_array)

Attributes