qcodes_contrib_drivers.drivers.Yokogawa package

Submodules

qcodes_contrib_drivers.drivers.Yokogawa.Yokogawa_AQ637x module

Driver for Yokogawa AQ637x Optical Spectrum Analyzers.

Provides instrument-level driver, trace/channel abstraction and data retrieval helpers.

class qcodes_contrib_drivers.drivers.Yokogawa.Yokogawa_AQ637x.YokogawaAQ637x(*args: Any, **kwargs: Any)

Bases: VisaInstrument

Driver for the Yokogawa AQ6370C/AQ6370D/AQ6373/AQ6373B/AQ6375/AQ6375B Optical Spectrum Analyzer.

align() → None

Perform the standard (internal) optical alignment adjustment.

align_external() → None

Perform optical alignment using an external light source.

align_internal() → None

Perform optical alignment using the internal reference source.

auto() → None

Equivalent to the OSA front-panel AUTO button: set sweep mode to AUTO and trigger an immediate sweep.

calibrate_bandwidth() → None

Execute the resolution-bandwidth calibration.

calibrate_bandwidth_initialize() → None

Reset the resolution-bandwidth calibration to its factory state.

calibrate_wavelength_external() → None

Execute wavelength calibration using the external reference source.

calibrate_wavelength_internal() → None

Execute wavelength calibration using the internal reference.

calibration_power_offset_table(index: int, offset: float) → None

Set an entry in the power-offset calibration table.

Parameters:

• index – Table entry index.

• offset – Level offset in dB.

calibration_wavelength_offset_table(index: int, offset: float) → None

Set an entry in the wavelength-offset calibration table.

Parameters:

• index – Table entry index.

• offset – Wavelength offset value.

clear_all_markers() → None

Turn off all manual markers (:CALCulate:MARKer:AOFF).

clear_status() → None

Clear all event status registers and queues except the output queue

delete_all_traces() → None

Delete the data of all traces.

display_position(trace: str, position: str) → None

Place trace in the upper (UP) or lower (LOW) split window.

display_text_clear() → None

Clear all display text labels

display_trace_x_initialize() → None

Initialize the display X-axis scale parameters

display_trace_x_smscale() → None

Sets parameters of the current display scale to the measurement scale

immediate() → None

Makes a sweep

line_marker_all_off() → None

Turn off all line markers (:CALCulate:LMARker:AOFF).

line_marker_set_x(marker: int, value: float) → None

Set wavelength/frequency line marker marker (1 or 2).

line_marker_set_y(marker: int, value: float) → None

Set level line marker marker (3 or 4).

line_marker_sspan() → None

Set the sweep span to the L1–L2 line-marker spacing.

line_marker_szspan() → None

Set the zoom span to the L1–L2 line-marker spacing.

marker_get_x(marker: int) → float

Query the X position of marker marker.

marker_get_y(marker: int) → float

Query the Y value (level) of marker marker.

marker_maximum() → None

Move the active marker to the peak level.

marker_maximum_left() → None

Move the active marker to the next peak to the left.

marker_maximum_next() → None

Move the active marker to the next-highest peak.

marker_maximum_right() → None

Move the active marker to the next peak to the right.

marker_maximum_scenter() → None

Set the peak wavelength to the measurement center (‘peak to center’).

marker_maximum_srlevel() → None

Set the peak level to the reference level (‘peak to reference level’).

marker_maximum_szcenter() → None

Set the peak wavelength to the display center in zoom span.

marker_minimum() → None

Move the active marker to the bottom level.

marker_minimum_left() → None

Move the active marker to the next bottom to the left.

marker_minimum_next() → None

Move the active marker to the next-lowest bottom.

marker_minimum_right() → None

Move the active marker to the next bottom to the right.

marker_scenter() → None

Set the active marker wavelength to the measurement center.

marker_set_state(marker: int, state: bool) → None

Enable or disable moving marker marker.

marker_set_x(marker: int, value: float) → None

Set the X position (wavelength/frequency) of marker marker.

marker_srlevel() → None

Set the active marker level to the reference level.

marker_szcenter() → None

Set the active marker wavelength to the display center in zoom span.

memory_clear(index: int) → None

Clear the internal trace-memory entry at index.

memory_empty(index: int) → int

Return whether the internal trace-memory entry at index is empty.

memory_load(index: int, trace: str) → None

Load internal memory index into trace (TRA–TRG).

memory_store(index: int, trace: str) → None

Store trace (TRA–TRG) into internal memory index.

mmemory_auto_name(mode: str) → None

Set the automatic file-naming scheme (NUMBer or DATE).

mmemory_catalog(medium: str | None = None) → str

Return the file catalog of the current (or given) storage medium.

mmemory_change_directory(name: str) → None

Change the current working directory.

mmemory_change_drive(drive: str) → None

Select the current drive (INTernal or EXTernal).

mmemory_copy(source: str, destination: str, source_medium: str | None = None, destination_medium: str | None = None) → None

Copy a file between locations/media.

mmemory_data(filename: str, medium: str | None = None) → str

Return the raw contents of filename.

mmemory_delete(filename: str, medium: str | None = None) → None

Delete filename from the given medium.

mmemory_load_all_trace(filename: str, medium: str | None = None) → None

Load an all-trace (.CSV/.BIN) file.

mmemory_load_data_logging(filename: str, medium: str | None = None) → None

Load a data-logging file.

mmemory_load_memory(index: int, filename: str, medium: str | None = None) → None

Load filename into internal memory index.

mmemory_load_program(index: int, filename: str, medium: str | None = None) → None

Load a program file into program slot index.

mmemory_load_setting(filename: str, medium: str | None = None) → None

Load an instrument-settings file.

mmemory_load_template(template: str, filename: str, medium: str | None = None) → None

Load a template file into the given template.

mmemory_load_trace(trace: str, filename: str, medium: str | None = None) → None

Load filename into trace (TRA–TRG).

mmemory_make_directory(name: str, medium: str | None = None) → None

Create a directory on the given medium.

mmemory_remove() → None

Safely unmount the external storage medium.

mmemory_rename(new_name: str, old_name: str, medium: str | None = None) → None

Rename old_name to new_name on the given medium.

mmemory_store_all_trace(filename: str, medium: str | None = None) → None

Store all traces to a file.

mmemory_store_analysis_result(filename: str, medium: str | None = None) → None

Store the analysis-result table to a file.

mmemory_store_data(filename: str, medium: str | None = None) → None

Store measurement data to a file (format set by mmemory_store_data_type).

mmemory_store_data_item(item: str, state: bool) → None

Enable/disable an item in stored data (DATE/LABel/DATA/CONDition/TRACe).

mmemory_store_data_logging(filename: str, medium: str | None = None) → None

Store the data-logging result to a file.

mmemory_store_data_logging_csave(state: bool) → None

Enable/disable continuous saving during data logging.

mmemory_store_data_logging_tsave(state: bool) → None

Enable/disable time-stamp saving during data logging.

mmemory_store_data_mode(mode: str) → None

Set the data-store mode (ADD or OVER).

mmemory_store_data_type(data_type: str) → None

Set the data-store file type (CSV or DT).

mmemory_store_graphics(color: str, image_format: str, filename: str, medium: str | None = None) → None

Store a screenshot (color: B&W/COLor/PCOLor; format: BMP/TIFF).

mmemory_store_memory(index: int, data_format: str, filename: str, medium: str | None = None) → None

Store internal memory index to a file (format BI or CSV).

mmemory_store_program(index: int, filename: str, medium: str | None = None) → None

Store program slot index to a file.

mmemory_store_setting(filename: str, medium: str | None = None) → None

Store the current instrument settings to a file.

mmemory_store_template(template: str, filename: str, medium: str | None = None) → None

Store the given template to a file.

mmemory_store_trace(trace: str, data_format: str, filename: str, medium: str | None = None) → None

Store trace (TRA–TRG) to a file (format BIN or CSV).

program_execute(index: int) → None

Execute the stored program at index.

repeat() → None

Equivalent to the OSA front-panel REPEAT button: set sweep mode to REPEAT and trigger continuous sweeps.

reset() → None

Reset the instrument to its default state

single() → None

Equivalent to the OSA front-panel SINGLE button: set sweep mode to SINGLE and perform one sweep.

status_operation_preset() → None

Preset the operation status enable/transition registers.

stop() → None

Stops operations such as measurements and calibration

system_grid_custom_clear_all() → None

Clear all custom WDM grid entries.

system_grid_custom_delete(grid_number: int) → None

Delete a custom WDM grid entry by number.

system_grid_custom_insert(value: float) → None

Insert a wavelength into the custom WDM grid (m).

system_information(kind: int = 0) → str

Return system information (kind 0 or 1).

system_operator_lock(state: bool, password: str) → None

Enable/disable the operator lock using password.

system_preset() → None

Reset the instrument to its preset (initialized) state.

template_all_delete(template: str) → None

Delete all points of template.

template_data(template: str, wavelength: float, level: float) → None

Append a (wavelength, level) point to template.

template_display(template: str, state: bool) → None

Show or hide template on screen.

template_edit_type(template: str, edit_type: str) → None

Set the edit type of template (NONE, A or B).

template_mode(template: str, mode: str) → None

Set the level mode of template (ABSolute or RELative).

trace_copy(source: str, destination: str) → None

Copy trace source to destination (TRA–TRG).

trace_power_density(trace: str, bandwidth: float) → str

Query the power spectral density of trace normalized to bandwidth (m).

trigger() → None

Force a single trigger sweep regardless of trigger mode

wait() → None

Wait until all previously issued commands have completed

zero_once() → None

Perform a single monitor-zeroing operation now (:CALibration:ZERO ONCE).

MODELS = ['AQ6370C', 'AQ6370D', 'AQ6373', 'AQ6373B', 'AQ6375', 'AQ6375B']

List of support Optical Spectrum Analyzer

amarkers = ChannelTuple( self, "amarkers", YokogawaAQ637xAutoMarker, (self.amarker1, self.amarker2, self.amarker3, self.amarker4), snapshotable=False, )

Advanced/auto markers (AMARker1–AMARker4)

calibration_bandwidth_wavelength: Parameter = self.add_parameter( "calibration_bandwidth_wavelength", get_cmd=":CALibration:BANDwidth:WAVelength?", get_parser=float, unit="m", )

Wavelength at which the resolution-bandwidth calibration was performed (m)

calibration_wavelength_external_source: Parameter = self.add_parameter( "calibration_wavelength_external_source", set_cmd=":CALibration:WAVelength:EXTernal:SOURce {}", get_cmd=":CALibration:WAVelength:EXTernal:SOURce?", val_mapping={ "LASER": 0, "GASCELL": 1, "EMISSION": 2, }, )

External wavelength-calibration reference source (laser, gas cell or emission line)

calibration_wavelength_external_wavelength: Parameter = self.add_parameter( "calibration_wavelength_external_wavelength", set_cmd=":CALibration:WAVelength:EXTernal:WAVelength {}M", get_cmd=":CALibration:WAVelength:EXTernal:WAVelength?", get_parser=float, unit="m", )

Reference wavelength used for external wavelength calibration (m)

calibration_zero_auto: Parameter = self.add_parameter( "calibration_zero_auto", set_cmd=":CALibration:ZERO:AUTO {}", get_cmd=":CALibration:ZERO:AUTO?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Enable or disable automatic zeroing of the monitor (on/off). See also zero_once()

calibration_zero_interval: Parameter = self.add_parameter( "calibration_zero_interval", set_cmd=":CALibration:ZERO:INTerval {}", get_cmd=":CALibration:ZERO:INTerval?", vals=Ints(), get_parser=int, )

Interval between automatic zeroing operations

calibration_zero_status: Parameter = self.add_parameter( "calibration_zero_status", get_cmd=":CALibration:ZERO:STATus?", get_parser=int, )

Status of the most recent zeroing operation

default_terminator = '\n'

The default terminator to use if the terminator is not specified when creating the instrument. None means use the default terminator from PyVisa.

display_color: Parameter = self.add_parameter( "display_color", set_cmd=":DISPlay:COLor {}", get_cmd=":DISPlay:COLor?", vals=Ints(0, 5), get_parser=int, )

Screen color mode (0 = B/W, 1–5 = color modes)

display_enabled: Parameter = self.add_parameter( "display_enabled", set_cmd=":DISPlay {}", get_cmd=":DISPlay?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Enable or disable the display (on/off)

display_overview_position: Parameter = self.add_parameter( "display_overview_position", set_cmd=":DISPlay:OVIew:POSition {}", get_cmd=":DISPlay:OVIew:POSition?", val_mapping={ "OFF": 0, "LEFT": 1, "RIGHT": 2, }, )

Overview display position (off, left, right) (position)

display_overview_size: Parameter = self.add_parameter( "display_overview_size", set_cmd=":DISPlay:OVIew:SIZE {}", get_cmd=":DISPlay:OVIew:SIZE?", val_mapping={ "LARGE": 0, "SMALL": 1, }, )

Overview display size (large or small) (size)

display_split: Parameter = self.add_parameter( "display_split", set_cmd=":DISPlay:SPLit {}", get_cmd=":DISPlay:SPLit?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Enable or disable split screen display (on/off)

display_split_hold_lower: Parameter = self.add_parameter( "display_split_hold_lower", set_cmd=":DISPlay:SPLit:HOLD:LOWer {}", get_cmd=":DISPlay:SPLit:HOLD:LOWer?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Hold the lower trace in split-screen mode (on/off)

display_split_hold_upper: Parameter = self.add_parameter( "display_split_hold_upper", set_cmd=":DISPlay:SPLit:HOLD:UPPer {}", get_cmd=":DISPlay:SPLit:HOLD:UPPer?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Hold the upper trace in split-screen mode (on/off)

display_text_data: Parameter = self.add_parameter( "display_text_data", set_cmd=':DISPlay:TEXT:DATA "{}"', get_cmd=":DISPlay:TEXT:DATA?", vals=Strings(max_length=56), )

Display text label (max 56 characters)

display_trace_x_center: Parameter = self.add_parameter( "display_trace_x_center", set_cmd=":DISPlay:TRACe:X:SCALe:CENTer {}M", get_cmd=":DISPlay:TRACe:X:SCALe:CENTer?", get_parser=float, unit="m", )

Center value of the display X-axis (m)

display_trace_x_span: Parameter = self.add_parameter( "display_trace_x_span", set_cmd=":DISPlay:TRACe:X:SCALe:SPAN {}M", get_cmd=":DISPlay:TRACe:X:SCALe:SPAN?", get_parser=float, unit="m", )

Span of the display X-axis (m)

display_trace_x_srange: Parameter = self.add_parameter( "display_trace_x_srange", set_cmd=":DISPlay:TRACe:X:SCALe:SRANge {}", get_cmd=":DISPlay:TRACe:X:SCALe:SRANge?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Limit analytical range to the display X-axis scale (on/off)

display_trace_x_start: Parameter = self.add_parameter( "display_trace_x_start", set_cmd=":DISPlay:TRACe:X:SCALe:STARt {}M", get_cmd=":DISPlay:TRACe:X:SCALe:STARt?", get_parser=float, unit="m", )

Start value of the display X-axis (m)

display_trace_x_stop: Parameter = self.add_parameter( "display_trace_x_stop", set_cmd=":DISPlay:TRACe:X:SCALe:STOP {}M", get_cmd=":DISPlay:TRACe:X:SCALe:STOP?", get_parser=float, unit="m", )

Stop value of the display X-axis (m)

display_trace_y1_blevel: Parameter = self.add_parameter( "display_trace_y1_blevel", set_cmd=":DISPlay:TRACe:Y1:SCALe:BLEVel {}", get_cmd=":DISPlay:TRACe:Y1:SCALe:BLEVel?", get_parser=float, unit="W", )

Y1-axis base level for linear scale (W)

display_trace_y1_pdivision: Parameter = self.add_parameter( "display_trace_y1_pdivision", set_cmd=":DISPlay:TRACe:Y1:SCALe:PDIVision {}", get_cmd=":DISPlay:TRACe:Y1:SCALe:PDIVision?", get_parser=float, unit="dB", )

Y1-axis level scale per division (dB)

display_trace_y1_rlevel: Parameter = self.add_parameter( "display_trace_y1_rlevel", set_cmd=":DISPlay:TRACe:Y1:SCALe:RLEVel {}DBM", get_cmd=":DISPlay:TRACe:Y1:SCALe:RLEVel?", get_parser=float, unit="dBm", )

Y1-axis reference level (dBm)

display_trace_y1_rposition: Parameter = self.add_parameter( "display_trace_y1_rposition", set_cmd=":DISPlay:TRACe:Y1:SCALe:RPOSition {}", get_cmd=":DISPlay:TRACe:Y1:SCALe:RPOSition?", vals=Ints(0, 12), get_parser=int, unit="DIV", )

Y1-axis reference level position (DIV)

display_trace_y1_spacing: Parameter = self.add_parameter( "display_trace_y1_spacing", set_cmd=":DISPlay:TRACe:Y1:SCALe:SPACing {}", get_cmd=":DISPlay:TRACe:Y1:SCALe:SPACing?", val_mapping={ "LOG": 0, "LINEAR": 1, }, )

Y1-axis scale spacing (logarithmic or linear) (type)

display_trace_y1_unit: Parameter = self.add_parameter( "display_trace_y1_unit", set_cmd=":DISPlay:TRACe:Y1:SCALe:UNIT {}", get_cmd=":DISPlay:TRACe:Y1:SCALe:UNIT?", val_mapping={ "DBM": 0, "W": 1, "DBM_PER_NM": 2, "W_PER_NM": 3, }, )

Y1-axis unit (dBm, W, dBm/nm, or W/nm) (unit)

display_trace_y2_auto: Parameter = self.add_parameter( "display_trace_y2_auto", set_cmd=":DISPlay:TRACe:Y2:SCALe:AUTO {}", get_cmd=":DISPlay:TRACe:Y2:SCALe:AUTO?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Enable or disable automatic scaling of the Y2-axis (on/off)

display_trace_y2_length: Parameter = self.add_parameter( "display_trace_y2_length", set_cmd=":DISPlay:TRACe:Y2:SCALe:LENGth {}KM", get_cmd=":DISPlay:TRACe:Y2:SCALe:LENGth?", get_parser=float, unit='km', )

Optical fiber length for Y2-axis when unit is dB/km (km)

display_trace_y2_olevel: Parameter = self.add_parameter( "display_trace_y2_olevel", set_cmd=":DISPlay:TRACe:Y2:SCALe:OLEVel {}DB", get_cmd=":DISPlay:TRACe:Y2:SCALe:OLEVel?", get_parser=float, unit="dB", )

Y2-axis offset level (dB or dB/km, unit depends on subscale)

display_trace_y2_pdivision: Parameter = self.add_parameter( "display_trace_y2_pdivision", set_cmd=":DISPlay:TRACe:Y2:SCALe:PDIVision {}DB", get_cmd=":DISPlay:TRACe:Y2:SCALe:PDIVision?", get_parser=float, unit="dB", )

Y2-axis scale per division (unit depends on subscale)

display_trace_y2_rposition: Parameter = self.add_parameter( "display_trace_y2_rposition", set_cmd=":DISPlay:TRACe:Y2:SCALe:RPOSition {}", get_cmd=":DISPlay:TRACe:Y2:SCALe:RPOSition?", vals=Ints(0, 12), get_parser=int, unit="DIV", )

Y2-axis reference level position (DIV)

display_trace_y2_sminimum: Parameter = self.add_parameter( "display_trace_y2_sminimum", set_cmd=":DISPlay:TRACe:Y2:SCALe:SMINimum {}%", get_cmd=":DISPlay:TRACe:Y2:SCALe:SMINimum?", get_parser=float, unit="%", )

Y2-axis scale minimum value (linear or % mode)

display_trace_y2_unit: Parameter = self.add_parameter( "display_trace_y2_unit", set_cmd=":DISPlay:TRACe:Y2:SCALe:UNIT {}", get_cmd=":DISPlay:TRACe:Y2:SCALe:UNIT?", val_mapping={ "DB": 0, "LINEAR": 1, "DB_PER_KM": 2, "PERCENT": 3, }, )

Y2-axis unit (dB, linear, dB/km, or %) (unit)

display_trace_y_dnumber: Parameter = self.add_parameter( "display_trace_y_dnumber", set_cmd=":DISPlay:TRACe:Y:SCALe:DNUMber {}", get_cmd=":DISPlay:TRACe:Y:SCALe:DNUMber?", vals=Enum(8, 10, 12), get_parser=int, )

Number of Y-axis display divisions (8, 10, or 12) (divisions)

display_trace_y_nmask: Parameter = self.add_parameter( "display_trace_y_nmask", set_cmd=":DISPlay:TRACe:Y:NMASk {}", get_cmd=":DISPlay:TRACe:Y:NMASk?", get_parser=float, unit="dB", )

Y-axis display mask threshold (-999 disables masking) (dB)

display_trace_y_nmask_type: Parameter = self.add_parameter( "display_trace_y_nmask_type", set_cmd=":DISPlay:TRACe:Y:NMASk:TYPE {}", get_cmd=":DISPlay:TRACe:Y:NMASk:TYPE?", val_mapping={ "VERTICAL": 0, "HORIZONTAL": 1, }, )

Y-axis mask display type (vertical or horizontal) (type)

dlog_elapsed_time: Parameter = self.add_parameter( "dlog_elapsed_time", get_cmd=":APPLication:DLOGging:ETIMe?", get_parser=int, unit="s", )

Elapsed data-logging time (s)

dlog_interval: Parameter = self.add_parameter( "dlog_interval", set_cmd=":APPLication:DLOGging:LPARameter:INTerval {}", get_cmd=":APPLication:DLOGging:LPARameter:INTerval?", vals=Ints(), get_parser=int, )

Data-logging sampling interval

dlog_item: Parameter = self.add_parameter( "dlog_item", set_cmd=":APPLication:DLOGging:LPARameter:ITEM {}", get_cmd=":APPLication:DLOGging:LPARameter:ITEM?", vals=Ints(0, 3), get_parser=int, )

Data-logging item selection

dlog_lmode: Parameter = self.add_parameter( "dlog_lmode", set_cmd=":APPLication:DLOGging:LPARameter:LMODe {}", get_cmd=":APPLication:DLOGging:LPARameter:LMODe?", vals=Ints(1, 2), get_parser=int, )

Data-logging mode

dlog_memory: Parameter = self.add_parameter( "dlog_memory", set_cmd=":APPLication:DLOGging:LPARameter:MEMory {}", get_cmd=":APPLication:DLOGging:LPARameter:MEMory?", val_mapping={ "INTERNAL": "INT", "EXTERNAL": "EXT", }, )

Data-logging storage location (internal or external)

dlog_mthresh: Parameter = self.add_parameter( "dlog_mthresh", set_cmd=":APPLication:DLOGging:LPARameter:MTHResh {}", get_cmd=":APPLication:DLOGging:LPARameter:MTHResh?", get_parser=float, )

Data-logging measurement threshold

dlog_pdetect_athresh: Parameter = self.add_parameter( "dlog_pdetect_athresh", set_cmd=":APPLication:DLOGging:LPARameter:PDETect:ATHResh {}", get_cmd=":APPLication:DLOGging:LPARameter:PDETect:ATHResh?", get_parser=float, )

Peak-detection absolute threshold

dlog_pdetect_rthresh: Parameter = self.add_parameter( "dlog_pdetect_rthresh", set_cmd=":APPLication:DLOGging:LPARameter:PDETect:RTHResh {}", get_cmd=":APPLication:DLOGging:LPARameter:PDETect:RTHResh?", get_parser=float, )

Peak-detection relative threshold

dlog_pdetect_ttype: Parameter = self.add_parameter( "dlog_pdetect_ttype", set_cmd=":APPLication:DLOGging:LPARameter:PDETect:TTYPe {}", get_cmd=":APPLication:DLOGging:LPARameter:PDETect:TTYPe?", val_mapping={ "ABSOLUTE": "ABS", "RELATIVE": "REL", }, )

Peak-detection threshold type (absolute or relative)

dlog_state: Parameter = self.add_parameter( "dlog_state", set_cmd=":APPLication:DLOGging:STATe {}", get_cmd=":APPLication:DLOGging:STATe?", val_mapping={ "STOP": 0, "START": 1, }, )

Data-logging run state (start/stop)

dlog_tduration: Parameter = self.add_parameter( "dlog_tduration", set_cmd=":APPLication:DLOGging:LPARameter:TDURation {}", get_cmd=":APPLication:DLOGging:LPARameter:TDURation?", vals=Ints(), get_parser=int, )

Data-logging total duration

dlog_tlogging: Parameter = self.add_parameter( "dlog_tlogging", set_cmd=":APPLication:DLOGging:LPARameter:TLOGging {}", get_cmd=":APPLication:DLOGging:LPARameter:TLOGging?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Time-based logging (on/off)

event_status_enable: Parameter = self.add_parameter( "event_status_enable", set_cmd="*ESE {}", get_cmd="*ESE?", vals=Ints(0, 255), get_parser=int, )

Standard event status enable register (0–255)

event_status_register: Parameter = self.add_parameter( "event_status_register", get_cmd="*ESR?", get_parser=int, )

Standard event status register (read and clear)

format_data: Parameter = self.add_parameter( "format_data", set_cmd=":FORMat:DATA {}", get_cmd=":FORMat:DATA?", val_mapping={ "ASCII": "ASCII", "REAL64": "REAL,64", "REAL32": "REAL,32", }, )

Data transfer format (ASCII, REAL 64-bit, or REAL 32-bit) (format)

line_marker_srange: Parameter = self.add_parameter( "line_marker_srange", set_cmd=":CALCulate:LMARker:SRANge {}", get_cmd=":CALCulate:LMARker:SRANge?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Limit the analysis range to line markers L1–L2 (on/off)

marker_auto: Parameter = self.add_parameter( "marker_auto", set_cmd=":CALCulate:MARKer:AUTO {}", get_cmd=":CALCulate:MARKer:AUTO?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Automatic marker placement (on/off)

marker_function_format: Parameter = self.add_parameter( "marker_function_format", set_cmd=":CALCulate:MARKer:FUNCtion:FORMat {}", get_cmd=":CALCulate:MARKer:FUNCtion:FORMat?", val_mapping={ "OFFSET": 0, "SPACING": 1, }, )

Marker readout format (offset or spacing)

marker_function_update: Parameter = self.add_parameter( "marker_function_update", set_cmd=":CALCulate:MARKer:FUNCtion:UPDate {}", get_cmd=":CALCulate:MARKer:FUNCtion:UPDate?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Continuous marker-function value update (on/off)

marker_maximum_scenter_auto: Parameter = self.add_parameter( "marker_maximum_scenter_auto", set_cmd=":CALCulate:MARKer:MAXimum:SCENter:AUTO {}", get_cmd=":CALCulate:MARKer:MAXimum:SCENter:AUTO?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Automatic ‘peak to center’ after each sweep (on/off)

marker_maximum_srlevel_auto: Parameter = self.add_parameter( "marker_maximum_srlevel_auto", set_cmd=":CALCulate:MARKer:MAXimum:SRLevel:AUTO {}", get_cmd=":CALCulate:MARKer:MAXimum:SRLevel:AUTO?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Automatic ‘peak to reference level’ after each sweep (on/off)

marker_msearch: Parameter = self.add_parameter( "marker_msearch", set_cmd=":CALCulate:MARKer:MSEarch {}", get_cmd=":CALCulate:MARKer:MSEarch?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Multi-peak/bottom marker search mode (on/off)

marker_msearch_sort: Parameter = self.add_parameter( "marker_msearch_sort", set_cmd=":CALCulate:MARKer:MSEarch:SORT {}", get_cmd=":CALCulate:MARKer:MSEarch:SORT?", val_mapping={ "WAVELENGTH": 0, "LEVEL": 1, }, )

Sort order for multi-marker search (by wavelength or level)

marker_msearch_threshold: Parameter = self.add_parameter( "marker_msearch_threshold", set_cmd=":CALCulate:MARKer:MSEarch:THResh {}", get_cmd=":CALCulate:MARKer:MSEarch:THResh?", get_parser=float, unit="dB", )

Threshold for multi-marker search (dB)

marker_unit: Parameter = self.add_parameter( "marker_unit", set_cmd=":CALCulate:MARKer:UNIT {}", get_cmd=":CALCulate:MARKer:UNIT?", val_mapping=self._x_unit_val_mapping(), )

Marker X-axis unit (wavelength or frequency; wavenumber on AQ6375/AQ6375B)

operation_complete: Parameter = self.add_parameter( "operation_complete", set_cmd="*OPC", get_cmd="*OPC?", get_parser=int, )

Operation complete flag (sets/queries OPC bit in ESR)

self_test: Parameter = self.add_parameter( "self_test", get_cmd=self._get_self_test, snapshot_value=False, # Exclude from snapshot as it takes time to execute )

Run instrument self-test and return status code

sense_average_count: Parameter = self.add_parameter( "sense_average_count", set_cmd=":SENSe:AVERage:COUNt {}", get_cmd=":SENSe:AVERage:COUNt?", vals=Ints(), get_parser=int, )

Number of averages per measured point

sense_bandwidth_resolution: Parameter = self.add_parameter( "sense_bandwidth_resolution", set_cmd=":SENSe:BANDwidth:RESolution {}M", get_cmd=":SENSe:BANDwidth:RESolution?", get_parser=float, unit="m", )

Measurement resolution (bandwidth)

sense_chopper: Parameter = self.add_parameter( "sense_chopper", set_cmd=":SENSe:CHOPper {}", get_cmd=":SENSe:CHOPper?", val_mapping={ "OFF": 0, "SWITCH": 2, }, )

Chopper mode (off or switch) (mode)

sense_correction_level_shift: Parameter = self.add_parameter( "sense_correction_level_shift", set_cmd=":SENSe:CORRection:LEVel:SHIFt {}", get_cmd=":SENSe:CORRection:LEVel:SHIFt?", get_parser=float, unit="dB", )

Level correction offset (dB)

sense_correction_rvelocity_medium: Parameter = self.add_parameter( "sense_correction_rvelocity_medium", set_cmd=":SENSe:CORRection:RVELocity:MEDium {}", get_cmd=":SENSe:CORRection:RVELocity:MEDium?", val_mapping={ "AIR": 0, "VACUUM": 1, }, )

Wavelength reference medium (air or vacuum) (medium)

sense_correction_wavelength_shift: Parameter = self.add_parameter( "sense_correction_wavelength_shift", set_cmd=":SENSe:CORRection:WAVelength:SHIFt {}", get_cmd=":SENSe:CORRection:WAVelength:SHIFt?", get_parser=float, unit="m", )

Wavelength correction offset (m)

sense_sensitivity: Parameter = self.add_parameter( "sense_sensitivity", set_cmd=":SENSe:SENSe {}", get_cmd=":SENSe:SENSe?", val_mapping={ "NORMAL_HOLD": 0, "NORMAL_AUTO": 1, "MID": 2, "HIGH1": 3, "HIGH2": 4, "HIGH3": 5, "NORMAL": 6, }, )

Measurement sensitivity setting (setting)

sense_setting_correction: Parameter = self.add_parameter( "sense_setting_correction", set_cmd=":SENSe:SETTing:CORRection {}", get_cmd=":SENSe:SETTing:CORRection?", val_mapping={ "OFF": 0, "ON_MODE1": 1, "ON_MODE2": 2, }, )

Resolution correction function setting (mode)

sense_setting_fconnector: Parameter = self.add_parameter( "sense_setting_fconnector", set_cmd=":SENSe:SETTing:FCONnector {}", get_cmd=":SENSe:SETTing:FCONnector?", val_mapping={ "NORMAL": 0, "ANGLED": 1, }, )

Fiber connector mode (normal or angled) (mode)

sense_setting_fiber: Parameter

Fiber core size mode (small or large) (mode)

sense_setting_smoothing: Parameter = self.add_parameter( "sense_setting_smoothing", set_cmd=":SENSe:SETTing:SMOothing {}", get_cmd=":SENSe:SETTing:SMOothing?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Enable or disable smoothing (on/off)

sense_sweep_points: Parameter = self.add_parameter( "sense_sweep_points", set_cmd=":SENSe:SWEep:POINts {}", get_cmd=":SENSe:SWEep:POINts?", vals=Ints(), get_parser=int, )

Number of samples measured per sweep (points)

sense_sweep_points_auto: Parameter = self.add_parameter( "sense_sweep_points_auto", set_cmd=":SENSe:SWEep:POINts:AUTO {}", get_cmd=":SENSe:SWEep:POINts:AUTO?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Automatically set the number of sweep points (on/off)

sense_sweep_segment_points: Parameter = self.add_parameter( "sense_sweep_segment_points", set_cmd=":SENSe:SWEep:SEGMent:POINts {}", get_cmd=":SENSe:SWEep:SEGMent:POINts?", vals=Ints(1, 2 ** 31 - 1), get_parser=int, )

Number of sampling points per segment sweep (points)

sense_sweep_speed: Parameter = self.add_parameter( "sense_sweep_speed", set_cmd=":SENSe:SWEep:SPEed {}", get_cmd=":SENSe:SWEep:SPEed?", val_mapping={ "1X": 0, "2X": 1, }, )

Sweep speed (1x = standard, 2x = fast) (ratio)

sense_sweep_step: Parameter = self.add_parameter( "sense_sweep_step", set_cmd=":SENSe:SWEep:STEP {}M", get_cmd=":SENSe:SWEep:STEP?", get_parser=float, unit="m", )

Sampling interval for sweep measurements (m)

sense_sweep_time_0nm: Parameter = self.add_parameter( "sense_sweep_time_0nm", set_cmd=":SENSe:SWEep:TIME:0NM {}", get_cmd=":SENSe:SWEep:TIME:0NM?", vals=Ints(0, 2 ** 31 - 1), get_parser=int, unit="s", )

Measurement time for 0-nm sweep mode (s)

sense_sweep_time_interval: Parameter = self.add_parameter( "sense_sweep_time_interval", set_cmd=":SENSe:SWEep:TIME:INTerval {}", get_cmd=":SENSe:SWEep:TIME:INTerval?", vals=Ints(0, 2 ** 31 - 1), get_parser=int, unit="s", )

Time between consecutive sweeps (s)

sense_sweep_tlssync: Parameter

Enable or disable synchronous TLS sweep (on/off)

sense_wavelength_center: Parameter = self.add_parameter( "sense_wavelength_center", set_cmd=":SENSe:WAVelength:CENTer {}M", get_cmd=":SENSe:WAVelength:CENTer?", get_parser=float, unit="m", )

Measurement center wavelength (m)

sense_wavelength_span: Parameter = self.add_parameter( "sense_wavelength_span", set_cmd=":SENSe:WAVelength:SPAN {}M", get_cmd=":SENSe:WAVelength:SPAN?", get_parser=float, unit="m", )

Measurement wavelength span (m)

sense_wavelength_srange: Parameter = self.add_parameter( "sense_wavelength_srange", set_cmd=":SENSe:WAVelength:SRANge {}", get_cmd=":SENSe:WAVelength:SRANge?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Limit wavelength sweep range to marker L1–L2 spacing (on/off)

sense_wavelength_start: Parameter = self.add_parameter( "sense_wavelength_start", set_cmd=":SENSe:WAVelength:STARt {}M", get_cmd=":SENSe:WAVelength:STARt?", get_parser=float, unit="m", )

Measurement start wavelength (m)

sense_wavelength_stop: Parameter = self.add_parameter( "sense_wavelength_stop", set_cmd=":SENSe:WAVelength:STOP {}M", get_cmd=":SENSe:WAVelength:STOP?", get_parser=float, unit="m", )

Measurement stop wavelength (m)

service_request_enable: Parameter = self.add_parameter( "service_request_enable", set_cmd="*SRE {}", get_cmd="*SRE?", vals=Ints(0, 255), get_parser=int, )

Service request enable register (0–255)

status_byte: Parameter = self.add_parameter( "status_byte", get_cmd="*STB?", get_parser=int, )

Status byte register (read-only)

status_operation_condition: Parameter = self.add_parameter( "status_operation_condition", get_cmd=":STATus:OPERation:CONDition?", get_parser=int, )

Operation status condition register

status_operation_enable: Parameter = self.add_parameter( "status_operation_enable", set_cmd=":STATus:OPERation:ENABle {}", get_cmd=":STATus:OPERation:ENABle?", vals=Ints(0, 65535), get_parser=int, )

Operation status enable register

status_operation_event: Parameter = self.add_parameter( "status_operation_event", get_cmd=":STATus:OPERation:EVENt?", get_parser=int, )

Operation status event register (read and clear)

status_questionable_condition: Parameter = self.add_parameter( "status_questionable_condition", get_cmd=":STATus:QUEStionable:CONDition?", get_parser=int, )

Questionable status condition register

status_questionable_enable: Parameter = self.add_parameter( "status_questionable_enable", set_cmd=":STATus:QUEStionable:ENABle {}", get_cmd=":STATus:QUEStionable:ENABle?", vals=Ints(0, 65535), get_parser=int, )

Questionable status enable register

status_questionable_event: Parameter = self.add_parameter( "status_questionable_event", get_cmd=":STATus:QUEStionable:EVENt?", get_parser=int, )

Questionable status event register (read and clear)

sweep_mode: Parameter = self.add_parameter( "sweep_mode", set_cmd=":INITiate:SMODe {}", get_cmd=":INITiate:SMODe?", val_mapping={ "SINGLE": 1, "REPEAT": 2, "AUTO": 3, "SEGMENT": 4 } )

Sets/queries the sweep mode (mode)

system_buzzer_click: Parameter = self.add_parameter( "system_buzzer_click", set_cmd=":SYSTem:BUZZer:CLIC {}", get_cmd=":SYSTem:BUZZer:CLIC?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Key-click buzzer (on/off)

system_buzzer_warning: Parameter = self.add_parameter( "system_buzzer_warning", set_cmd=":SYSTem:BUZZer:WARNing {}", get_cmd=":SYSTem:BUZZer:WARNing?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Warning buzzer (on/off)

system_communicate_gpib2_address: Parameter = self.add_parameter( "system_communicate_gpib2_address", set_cmd=":SYSTem:COMMunicate:GP-IB2:ADDRess {}", get_cmd=":SYSTem:COMMunicate:GP-IB2:ADDRess?", vals=Ints(0, 30), get_parser=int, )

GP-IB2 (device) address

system_communicate_gpib2_scontroller: Parameter = self.add_parameter( "system_communicate_gpib2_scontroller", set_cmd=":SYSTem:COMMunicate:GP-IB2:SCONtroller {}", get_cmd=":SYSTem:COMMunicate:GP-IB2:SCONtroller?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

GP-IB2 system-controller mode (on/off)

system_communicate_gpib2_tls_address: Parameter = self.add_parameter( "system_communicate_gpib2_tls_address", set_cmd=":SYSTem:COMMunicate:GP-IB2:TLS:ADDRess {}", get_cmd=":SYSTem:COMMunicate:GP-IB2:TLS:ADDRess?", vals=Ints(0, 30), get_parser=int, )

GP-IB2 address of the tunable laser source used for synchronized sweeps

system_communicate_lockout: Parameter = self.add_parameter( "system_communicate_lockout", set_cmd=":SYSTem:COMMunicate:LOCKout {}", get_cmd=":SYSTem:COMMunicate:LOCKout?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Remote lockout of the front panel (on/off)

system_communicate_rmonitor: Parameter = self.add_parameter( "system_communicate_rmonitor", set_cmd=":SYSTem:COMMunicate:RMONitor {}", get_cmd=":SYSTem:COMMunicate:RMONitor?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Remote-monitor (network) mode (on/off)

system_date: Parameter = self.add_parameter( "system_date", set_cmd=":SYSTem:DATE {}", get_cmd=":SYSTem:DATE?", )

System date as yyyy,mm,dd

system_display_transparent: Parameter = self.add_parameter( "system_display_transparent", set_cmd=":SYSTem:DISPlay:TRANsparent {}", get_cmd=":SYSTem:DISPlay:TRANsparent?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Transparent dialog windows (on/off)

system_display_uncal: Parameter = self.add_parameter( "system_display_uncal", set_cmd=":SYSTem:DISPlay:UNCal {}", get_cmd=":SYSTem:DISPlay:UNCal?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Display of the ‘UNCAL’ warning (on/off)

system_error: Parameter = self.add_parameter( "system_error", get_cmd=":SYSTem:ERRor?", snapshot_value=False, )

Oldest entry in the instrument error queue (code and message)

system_fspeed: Parameter = self.add_parameter( "system_fspeed", get_cmd=":SYSTem:FSPeed?", )

Sampling/measurement front-end speed grade

system_grid: Parameter = self.add_parameter( "system_grid", set_cmd=":SYSTem:GRID {}", get_cmd=":SYSTem:GRID?", val_mapping={ "12.5GHZ": 0, "25GHZ": 1, "50GHZ": 2, "100GHZ": 3, "200GHZ": 4, "CUSTOM": 5, }, )

WDM ITU grid spacing

system_grid_custom_spacing: Parameter = self.add_parameter( "system_grid_custom_spacing", set_cmd=":SYSTem:GRID:CUSTom:SPACing {}GHZ", get_cmd=":SYSTem:GRID:CUSTom:SPACing?", get_parser=float, unit="GHz", )

Custom WDM grid spacing (GHz)

system_grid_custom_start: Parameter = self.add_parameter( "system_grid_custom_start", set_cmd=":SYSTem:GRID:CUSTom:STARt {}M", get_cmd=":SYSTem:GRID:CUSTom:STARt?", get_parser=float, unit="m", )

Custom WDM grid start wavelength (m)

system_grid_custom_stop: Parameter = self.add_parameter( "system_grid_custom_stop", set_cmd=":SYSTem:GRID:CUSTom:STOP {}M", get_cmd=":SYSTem:GRID:CUSTom:STOP?", get_parser=float, unit="m", )

Custom WDM grid stop wavelength (m)

system_grid_reference: Parameter = self.add_parameter( "system_grid_reference", set_cmd=":SYSTem:GRID:REFerence {}M", get_cmd=":SYSTem:GRID:REFerence?", get_parser=float, unit="m", )

WDM grid reference wavelength (m)

system_time: Parameter = self.add_parameter( "system_time", set_cmd=":SYSTem:TIME {}", get_cmd=":SYSTem:TIME?", )

System time as hh,mm,ss

system_version: Parameter = self.add_parameter( "system_version", get_cmd=":SYSTem:VERSion?", )

Instrument firmware version

template_gonogo: Parameter = self.add_parameter( "template_gonogo", set_cmd=":TRACe:TEMPlate:GONogo {}", get_cmd=":TRACe:TEMPlate:GONogo?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Template GO/NO-GO judgement (on/off)

template_level_shift: Parameter = self.add_parameter( "template_level_shift", set_cmd=":TRACe:TEMPlate:LEVel:SHIFt {}", get_cmd=":TRACe:TEMPlate:LEVel:SHIFt?", get_parser=float, unit="dB", )

Template level shift (dB)

template_result: Parameter = self.add_parameter( "template_result", get_cmd=":TRACe:TEMPlate:RESult?", )

Template GO/NO-GO judgement result

template_ttype: Parameter = self.add_parameter( "template_ttype", set_cmd=":TRACe:TEMPlate:TTYPe {}", get_cmd=":TRACe:TEMPlate:TTYPe?", val_mapping={ "UPPER": 0, "LOWER": 1, "UPPER_AND_LOWER": 2, }, )

Template limit type (upper, lower, or both)

template_wavelength_shift: Parameter = self.add_parameter( "template_wavelength_shift", set_cmd=":TRACe:TEMPlate:WAVelength:SHIFt {}M", get_cmd=":TRACe:TEMPlate:WAVelength:SHIFt?", get_parser=float, unit="m", )

Template wavelength shift (m)

traces = ChannelTuple( self, "traces", YokogawaAQ637xChannel, (self.TRA, self.TRB, self.TRC, self.TRD, self.TRE, self.TRF, self.TRG), snapshotable=False, )

Instrument traces (aka channels)

trigger_delay: Parameter = self.add_parameter( "trigger_delay", set_cmd=":TRIGger:DELay {}", get_cmd=":TRIGger:DELay?", get_parser=float, unit="s", )

Delay between the trigger event and the start of the sweep (s)

trigger_gate_logic: Parameter = self.add_parameter( "trigger_gate_logic", set_cmd=":TRIGger:GATE:LOGic {}", get_cmd=":TRIGger:GATE:LOGic?", val_mapping={ "POSITIVE": 0, "NEGATIVE": 1, }, )

Gate signal logic polarity (positive or negative)

trigger_gate_slope: Parameter = self.add_parameter( "trigger_gate_slope", set_cmd=":TRIGger:GATE:SLOPe {}", get_cmd=":TRIGger:GATE:SLOPe?", val_mapping={ "RISE": 0, "FALL": 1, }, )

Gate trigger edge (rising or falling)

trigger_gate_state: Parameter = self.add_parameter( "trigger_gate_state", set_cmd=":TRIGger:GATE:STATe {}", get_cmd=":TRIGger:GATE:STATe?", val_mapping={ "OFF": 0, "ON": 1, "PEAK_HOLD": 2, }, )

Gated-sweep mode (off, on, or peak-hold)

trigger_gate_time: Parameter = self.add_parameter( "trigger_gate_time", set_cmd=":TRIGger:GATE:TIMe {}", get_cmd=":TRIGger:GATE:TIMe?", get_parser=float, unit="s", )

Gate open time in gated-sweep mode (s)

trigger_input: Parameter = self.add_parameter( "trigger_input", set_cmd=":TRIGger:INPut {}", get_cmd=":TRIGger:INPut?", val_mapping={ "EXTERNAL_TRIGGER": 0, "SAMPLE_TRIGGER": 1, "SWEEP_ENABLE": 2, }, )

External input mode (external trigger, sampling trigger or sweep enable)

trigger_output: Parameter = self.add_parameter( "trigger_output", set_cmd=":TRIGger:OUTPut {}", get_cmd=":TRIGger:OUTPut?", val_mapping={ "OFF": 0, "SWEEP_STATUS": 1, }, )

Trigger output mode (off or sweep-status)

trigger_phold_htime: Parameter = self.add_parameter( "trigger_phold_htime", set_cmd=":TRIGger:PHOLd:HTIMe {}", get_cmd=":TRIGger:PHOLd:HTIMe?", get_parser=float, unit="s", )

Peak-hold time in peak-hold gate mode (s)

unit_power_digit: Parameter = self.add_parameter( "unit_power_digit", set_cmd=":UNIT:POWer:DIGit {}", get_cmd=":UNIT:POWer:DIGit?", vals=Ints(1, 3), get_parser=int, )

Number of significant digits for power readouts (1–3)

unit_x: Parameter = self.add_parameter( "unit_x", set_cmd=":UNIT:X {}", get_cmd=":UNIT:X?", val_mapping=self._x_unit_val_mapping(), )

X-axis unit (wavelength or frequency; wavenumber on AQ6375/AQ6375B)

class qcodes_contrib_drivers.drivers.Yokogawa.Yokogawa_AQ637x.YokogawaAQ637xAutoMarker(parent: Instrument, name: str, index: int, **kwargs: Unpack[InstrumentBaseKWArgs])

Bases: InstrumentChannel

One of the four advanced (auto) markers AMARker1–AMARker4.

Exposes marker state/position/readout and the integral and power-density (noise) marker functions, plus peak/bottom search actions.

function_preset() → None

Reset this marker’s analysis function to its default.

maximum() → None

Move the marker to the peak (maximum) level.

maximum_left() → None

Move the marker to the next peak to the left.

maximum_next() → None

Move the marker to the next-highest peak.

maximum_right() → None

Move the marker to the next peak to the right.

minimum() → None

Move the marker to the bottom (minimum) level.

minimum_left() → None

Move the marker to the next bottom to the left.

minimum_next() → None

Move the marker to the next-lowest bottom.

minimum_right() → None

Move the marker to the next bottom to the right.

off() → None

Turn this auto marker off.

integral_range: Parameter = self.add_parameter( "integral_range", set_cmd=f"{base}:FUNCtion:INTegral:IRANge {{}}", get_cmd=f"{base}:FUNCtion:INTegral:IRANge?", get_parser=float, unit="Hz", )

Integration frequency range for the integral marker function (Hz)

integral_result: Parameter = self.add_parameter( "integral_result", get_cmd=f"{base}:FUNCtion:INTegral:RESult?", get_parser=float, )

Result of the integral marker function

integral_state: Parameter = self.add_parameter( "integral_state", set_cmd=f"{base}:FUNCtion:INTegral:STATe {{}}", get_cmd=f"{base}:FUNCtion:INTegral:STATe?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Enable or disable the integral marker function (on/off)

pdensity_bandwidth: Parameter = self.add_parameter( "pdensity_bandwidth", set_cmd=f"{base}:FUNCtion:PDENsity:BWIDth {{}}M", get_cmd=f"{base}:FUNCtion:PDENsity:BWIDth?", get_parser=float, unit="m", )

Normalization bandwidth for the power-density marker function (m)

pdensity_result: Parameter = self.add_parameter( "pdensity_result", get_cmd=f"{base}:FUNCtion:PDENsity:RESult?", get_parser=float, )

Result of the power-density/noise marker function

pdensity_state: Parameter = self.add_parameter( "pdensity_state", set_cmd=f"{base}:FUNCtion:PDENsity:STATe {{}}", get_cmd=f"{base}:FUNCtion:PDENsity:STATe?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Enable or disable the power-density/noise marker function (on/off)

state: Parameter = self.add_parameter( "state", set_cmd=f"{base}:STATe {{}}", get_cmd=f"{base}:STATe?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Enable or disable this auto marker (on/off)

trace: Parameter = self.add_parameter( "trace", set_cmd=f"{base}:TRACe {{}}", get_cmd=f"{base}:TRACe?", vals=Enum("TRA", "TRB", "TRC", "TRD", "TRE", "TRF", "TRG"), )

Trace this marker is attached to (TRA–TRG)

x: Parameter = self.add_parameter( "x", set_cmd=f"{base}:X {{}}", get_cmd=f"{base}:X?", get_parser=float, )

Marker X position (wavelength or frequency, per marker_unit)

y: Parameter = self.add_parameter( "y", get_cmd=f"{base}:Y?", get_parser=float, )

Marker Y value (level readout)

class qcodes_contrib_drivers.drivers.Yokogawa.Yokogawa_AQ637x.YokogawaAQ637xChannel(parent: Instrument, name: str, trace: str, **kwargs: Unpack[InstrumentBaseKWArgs])

Bases: InstrumentChannel

Channel representing a single trace on the Yokogawa OSA.

Exposes trace-specific parameters (state, attribute, trace_axis, data, etc.) and convenience commands for trace operations (activate, delete, set modes).

active() → None

Set trace in ACTIVE mode

delete() → None

Delete the data of this trace.

fix() → None

Set trace in FIX mode

max_hold() → None

Set trace in MAX HOLD mode

min_hold() → None

Set trace in MIN HOLD mode

write_mode() → None

Set trace in WRITE mode

attribute: Parameter = self.add_parameter( "attribute", set_cmd=f":TRACe:ATTRibute:{trace} {{}}", get_cmd=f":TRACe:ATTRibute:{trace}?", val_mapping={ "WRITE": 0, "FIX": 1, "MAX_HOLD": 2, "MIN_HOLD": 3, "ROLLING_AVERAGE": 4, "CALCULATE": 5 }, )

Trace Attribute

data: YokogawaDataWithSetpoints = self.add_parameter( "data", get_cmd=f":TRACe:DATA:Y? {trace}", parameter_class=YokogawaDataWithSetpoints, unit="dBm", label=f"{trace} level", setpoints=(self.trace_axis,), vals=Arrays(shape=(self._sample_count,)), snapshot_value=False, )

Level data for this trace, with trace_axis as its setpoint axis.

data_sample_number: Parameter = self.add_parameter( "data_sample_number", get_cmd=f":TRACe:DATA:SNUMber? {trace}", get_parser=int, )

Number of sampled data points for this trace.

roll_avg: Parameter = self.add_parameter( "roll_avg", set_cmd=f":TRACe:ATTRibute:RAVG:{trace} {{}}", get_cmd=f":TRACe:ATTRibute:RAVG:{trace}?", vals=Ints(2, 100), get_parser=int, )

ROLL AVG averaging count for the specified trace

state: Parameter = self.add_parameter( "state", set_cmd=f":TRACe:STATe:{trace} {{}}", get_cmd=f":TRACe:STATe:{trace}?", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Sets/queries the display status of the specified trace

trace_axis: YokogawaData = self.add_parameter( "trace_axis", get_cmd=f":TRACe:DATA:X? {trace}", parameter_class=YokogawaData, unit="m", label=f"{trace} axis", vals=Arrays(shape=(self._sample_count,)), snapshot_value=False, )

X-axis data for this trace, the setpoints for data.

The unit follows unit_x: wavelength (m, the default and the declared unit here), frequency (Hz) or wavenumber (1/m) on the AQ6375/AQ6375B.

class qcodes_contrib_drivers.drivers.Yokogawa.Yokogawa_AQ637x.YokogawaData(name: str, *, data_format: str = 'REAL64', **kwargs: Unpack[ParameterKWArgs])

Bases: Parameter

Parameter reading a binary trace block from the instrument.

Supports REAL64 and REAL32 formats and returns a NumPy array. Used for the wavelength (setpoint) axis; the level data that carries this axis as its setpoints is read by YokogawaDataWithSetpoints.

get_raw() → Any

Retrieve raw binary data for this parameter and return as numpy.ndarray.

Sets the instrument data format, then queries and parses the IEEE-488.2 definite-length binary block via pyvisa’s query_binary_values. The AQ637x transmits low-order bytes first, i.e. little-endian (is_big_endian=False).

class qcodes_contrib_drivers.drivers.Yokogawa.Yokogawa_AQ637x.YokogawaDataWithSetpoints(name: str, *, data_format: str = 'REAL64', **kwargs: Unpack[ParameterKWArgs])

Bases: YokogawaData, ParameterWithSetpoints

Trace level (y) data that carries its wavelength axis as setpoints.

Reads the same IEEE-488.2 binary block as YokogawaData but, being a ParameterWithSetpoints, it declares its wavelength setpoint axis and an Arrays shape, so the data integrates with the QCoDeS measurement/dataset system (the associated wavelength axis is recorded automatically).

Module contents