NAME

Lab::Measurement::Manual - API documentation manual for Lab::Measurement

VERSION

version 3.780

OVERVIEW

Currently, the Lab::Measurement API consists of:

• "Lab::Moose", the recommended, current API, based on Modern Perl techniques

• the historical API, consisting of the Lab::Instrument virtual instruments and the high-level Lab::XPRESS interface

The Lab::Measurement package

• Lab::Measurement::Installation

• Lab::Measurement::Tutorial

• Lab::Measurement::Backends

• Lab::Measurement::Developer

• Lab::Measurement::Examples::Example1_Simple_IV

• Lab::Measurement::Examples::Example2_Gate_IV_scan

• Lab::Measurement::Roadmap

High-level tool classes

• Lab::Moose

• Lab::Moose::DataFolder

• Lab::Moose::DataFile

• Lab::Moose::DataFile::Gnuplot

• Lab::Moose::DataFile::Gnuplot::Compressed

• Lab::Moose::DataFile::Meta

• Lab::Moose::DataFile::Read

• Lab::Moose::Plot

• Lab::Moose::Countdown

• Lab::Moose::Catfile

Sweep classes

• Lab::Moose::Sweep

• Lab::Moose::Sweep::Step

• Lab::Moose::Sweep::Step::Voltage

• Lab::Moose::Sweep::Step::Frequency

• Lab::Moose::Sweep::Step::Power

• Lab::Moose::Sweep::Step::Magnet

• Lab::Moose::Sweep::Step::Temperature

• Lab::Moose::Sweep::Step::Repeat

• Lab::Moose::Sweep::Step::Pulsewidth

• Lab::Moose::Sweep::Step::Pulsedelay

• Lab::Moose::Sweep::Continuous

• Lab::Moose::Sweep::Continuous::Time

• Lab::Moose::Sweep::Continuous::Magnet

• Lab::Moose::Sweep::Continuous::Voltage

Instrument control classes

• Lab::Moose::Instrument

• Lab::Moose::Instrument::Cache

• Lab::Moose::Instrument::Zhinst

Multimeters

• Lab::Moose::Instrument::HP3458A

• Lab::Moose::Instrument::HP34410A

  alias: Lab::Moose::Instrument::Agilent34410A

• Lab::Moose::Instrument::Agilent34460A

• Lab::Moose::Instrument::Keysight34470A

• Lab::Moose::Instrument::HP34420A

Voltage sources

• Lab::Moose::Instrument::YokogawaGS200

• Lab::Moose::Instrument::Yokogawa7651

• Lab::Moose::Instrument::KeysightE3633E

• Lab::Moose::Instrument::DummySource

Source/Measure Units

• Lab::Moose::Instrument::Keithley2400

• Lab::Moose::Instrument::Keithley2450

• Lab::Moose::Instrument::KeysightB2901A

Lock-in amplifiers

• Lab::Moose::Instrument::SR830

• Lab::Moose::Instrument::ZI_MFLI

• Lab::Moose::Instrument::ZI_HF2LI

• work in progress: Lab::Moose::Instrument::SignalRecovery7265

Impedance analyzers

• Lab::Moose::Instrument::ZI_MFIA

RF generators

• Lab::Moose::Instrument::RS_SMB

Spectrum analyzers

• Lab::Moose::Instrument::RS_FSV

• Lab::Moose::Instrument::HP8596E

• Lab::Moose::Instrument::HPE4400B

• Lab::Moose::Instrument::Rigol_DSA815

Network analyzers

• Lab::Moose::Instrument::RS_ZVA

• Lab::Moose::Instrument::RS_ZNL

• Lab::Moose::Instrument::RS_ZVM

Superconducting magnet power supplies

• Lab::Moose::Instrument::OI_Mercury::Magnet

  contains support for temperature sensor and He/N2 level meters.

• Lab::Moose::Instrument::OI_IPS

Temperature control devices

• Lab::Moose::Instrument::OI_Triton

• Lab::Moose::Instrument::Lakeshore340

• Lab::Moose::Instrument::Lakeshore372

• Lab::Moose::Instrument::OI_ITC503

• Lab::Moose::Instrument::ABB_TRMC2

Oscilloscopes

• Lab::Moose::Instrument::TBS1000C

• Lab::Moose::Instrument::KeysightDSOS604A

Function/Waveform Generators

• Lab::Moose::Instrument::Rigol_DG5000

Moose::Instrument Roles

• Lab::Moose::Instrument::AdjustRange

• Lab::Moose::Instrument::Common

• Lab::Moose::Instrument::LinearStepSweep

• Lab::Moose::Instrument::Log

• Lab::Moose::Instrument::SCPIBlock

• Lab::Moose::Instrument::VNASweep

• Lab::Moose::Instrument::SpectrumAnalyzer

• Lab::Moose::Instrument::OI_Common

• Lab::Moose::Instrument::DisplayXY

• Lab::Moose::Instrument::SCPI::Display::Window

• Lab::Moose::Instrument::SCPI::Format

• Lab::Moose::Instrument::SCPI::Initiate

• Lab::Moose::Instrument::SCPI::Instrument

• Lab::Moose::Instrument::SCPI::Output::State

• Lab::Moose::Instrument::SCPI::Sense::Average

• Lab::Moose::Instrument::SCPI::Sense::Bandwidth

• Lab::Moose::Instrument::SCPI::Sense::Frequency

• Lab::Moose::Instrument::SCPI::Sense::Function

• Lab::Moose::Instrument::SCPI::Sense::Function::Concurrent

• Lab::Moose::Instrument::SCPI::Sense::Impedance

• Lab::Moose::Instrument::SCPI::Sense::NPLC

• Lab::Moose::Instrument::SCPI::Sense::Null

• Lab::Moose::Instrument::SCPI::Sense::Power

• Lab::Moose::Instrument::SCPI::Sense::Protection

• Lab::Moose::Instrument::SCPI::Sense::Range

• Lab::Moose::Instrument::SCPI::Sense::Sweep

• Lab::Moose::Instrument::SCPI::Source::Function

• Lab::Moose::Instrument::SCPI::Source::Level

• Lab::Moose::Instrument::SCPI::Source::Power

• Lab::Moose::Instrument::SCPI::Source::Range

• Lab::Moose::Instrument::SCPI::Unit

Connecting instruments

• Lab::Moose::Connection

• Lab::Moose::Connection::Mock

• Lab::Moose::Connection::Debug

National Instruments VISA base class

• Lab::Moose::Connection::VISA

GPIB (IEEE 488.2)

• Lab::Moose::Connection::LinuxGPIB

• Lab::Moose::Connection::VISA::GPIB

  alias: Lab::Moose::Connection::VISA_GPIB

USB Test & Measurement

• Lab::Moose::Connection::USB

• Lab::Moose::Connection::VISA::USB

Network socket

• Lab::Moose::Connection::Socket

VXI-11

• Lab::Moose::Connection::VXI11

• Lab::Moose::Connection::VISA::VXI11

Zurich Instruments LabONE API

• Lab::Moose::Connection::Zhinst

Legacy Lab::Measurement API

• Lab::Measurement::Legacy::Tutorial

• Lab::Measurement::Legacy::Developer::Testing

High-level tool classes

• Lab::Measurement

• Lab::SCPI

• Lab::Data::Analysis

XPRESS

Examples

• Lab::XPRESS::Examples::Example1_Simple_IV

• Lab::XPRESS::Examples::Example2_Gate_IV_scan

• Lab::XPRESS::Examples::Example3_2samples_2files

• Lab::XPRESS::Examples::Example4_3d_scan

General classes

• Lab::XPRESS::Sweep

• Lab::XPRESS::Sweep::Frame

• Lab::Moose::Stabilizer

Dedicated Sweep Classes

• Lab::XPRESS::Sweep::Magnet

• Lab::XPRESS::Sweep::Voltage

• Lab::XPRESS::Sweep::Time

• Lab::XPRESS::Sweep::Motor

• Lab::XPRESS::Sweep::Repeater

• Lab::XPRESS::Sweep::Temperature

• Lab::XPRESS::Sweep::PulseLength

• Lab::XPRESS::Sweep::Amplitude

• Lab::XPRESS::Sweep::Level

• Lab::XPRESS::Sweep::LogBlock

• Lab::XPRESS::Sweep::SignalRecoveryPhase

• Lab::XPRESS::Sweep::SignalRecoveryOscOut

Instrument control classes

• Lab::Instrument

Multimeters

• Lab::Instrument::Multimeter

• Lab::Instrument::HP34401A

• Lab::Instrument::HP34420A

• Lab::Instrument::HP3458A

• Lab::Instrument::Agilent34410A

• Lab::Instrument::Keithley2000

Voltage sources

• Lab::Instrument::Source

• Lab::Instrument::DummySource

• Lab::Instrument::Yokogawa7651

• Lab::Instrument::YokogawaGS200

• Lab::Instrument::Keithley2400

Lock-in amplifiers

• Lab::Instrument::SR830

• Lab::Instrument::SR830::AuxIn

• Lab::Instrument::SR830::AuxOut

• Lab::Instrument::SignalRecovery726x

RF generators

• Lab::Instrument::HP33120A

• Lab::Instrument::HP83732A

• Lab::Instrument::MG369xB

RF detectors

• Lab::Instrument::U2000

Oscilloscopes

• Lab::Instrument::TDS2024B

• Lab::Instrument::WR640

Superconducting magnet power supplies

• Lab::Instrument::IPS

Temperature control devices

• Lab::Instrument::TRMC2

• Lab::Instrument::OI_ITC503

• Lab::Instrument::ITC

• Lab::Instrument::TCD

• Lab::Instrument::OI_Triton

• Lab::Instrument::TemperatureControl::TLK43

• Lab::Instrument::Lakeshore33x

• Lab::Instrument::Lakeshore340

Cryoliquid level meters

• Lab::Instrument::OI_ILM210

Stepper motors

• Lab::Instrument::PD11042

Connecting instruments with Buses and Connections

Base classes

• Lab::Connection

• Lab::Bus

• Lab::Bus::DEBUG

VISA

• Lab::Connection::VISA

• Lab::Bus::VISA

GPIB (IEEE 488.2)

• Lab::Connection::GPIB

• Lab::Connection::LinuxGPIB

• Lab::Connection::VISA_GPIB

• Lab::Bus::LinuxGPIB

RS232 (serial port)

• Lab::Connection::RS232

• Lab::Connection::VISA_RS232

• Lab::Bus::RS232

USB Test & Measurement (Linux kernel driver)

• Lab::Connection::USBtmc

• Lab::Bus::USBtmc

Oxford Instruments ISOBUS

• Lab::Connection::IsoBus

• Lab::Bus::IsoBus

MODBUS

• Lab::Connection::MODBUS_RS232

• Lab::Bus::MODBUS_RS232

CITING Lab::Measurement

If you use Lab::Measurement in your work, we would appreciate very much a citation in the resulting publications. Please cite us as follows:

"Lab::Measurement — a portable and extensible framework for controlling lab equipment and conducting measurements", S. Reinhardt, C. Butschkow, S. Geissler, A. Dirnaichner, F. Olbrich, C. Lane, D. Schröer, and A. K. Hüttel, Computer Physics Communications 234, 216 (2019); doi:10.1016/j.cpc.2018.07.024

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by the Lab::Measurement team; in detail:

Copyright 2017       Simon Reinhardt
          2018       Andreas K. Huettel, Simon Reinhardt
          2019       Simon Reinhardt
          2020       Andreas K. Huettel, Sam Bingner, Simon Reinhardt
          2021       Andreas K. Huettel, Fabian Weinelt, Simon Reinhardt

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm Lab::Measurement

perl -MCPAN -e shell
install Lab::Measurement