Package jisa.devices.interfaces

Interface DPLockIn

All Superinterfaces:

FMeter, Instrument, LockIn

All Known Implementing Classes:

SR830

public interface DPLockIn
extends LockIn

Extension of the LockIn class for lock-in amplifiers with dual-phase capabilities

Nested Class Summary

Nested classes/interfaces inherited from interface jisa.devices.interfaces.Instrument

Instrument.AutoQuantity<S>, Instrument.OptionalQuantity<S>, Instrument.Parameter<S>, Instrument.Setter<S>, Instrument.TableQuantity

Nested classes/interfaces inherited from interface jisa.devices.interfaces.LockIn

LockIn.RefMode, LockIn.TrigMode

Method Summary

Modifier and Type	Method	Description
default void	autoOffset()	Instruct the lock-in to automatically determine the offset to use.
void	autoOffsetAmplitude()
void	autoOffsetX()
void	autoOffsetY()
static java.lang.String	getDescription()
double	getLockedPhase()	Returns of the phase of the locked-on signal (relative to the reference)
double	getLockedX()	Returns the amplitude of the component of the signal in-phase with the reference signal
double	getLockedY()	Returns the amplitude of the component of the signal 90 degrees out of phase with the reference signal

Methods inherited from interface jisa.devices.interfaces.FMeter

getFrequencyRange, setFrequencyRange

Methods inherited from interface jisa.devices.interfaces.Instrument

close, getAddress, getConfigurationParameters, getIDN, getLockObject, getName, setTimeout

Methods inherited from interface jisa.devices.interfaces.LockIn

autoRange, autoRange, getConfigurationParameters, getCoupling, getExpansion, getExternalTriggerMode, getFilterRollOff, getFrequency, getImpedanceMode, getInput, getLineFilterHarmonics, getLockedAmplitude, getOffset, getRange, getRefAmplitude, getRefMode, getRefPhase, getShielding, getSource, getTimeConstant, isSyncFilterEnabled, setCoupling, setExpansion, setExternalTriggerMode, setFilterRollOff, setImpedanceMode, setInput, setLineFilterHarmonics, setOffset, setOscAmplitude, setOscFrequency, setOscPhase, setRange, setRefMode, setShielding, setSource, setSyncFilterEnabled, setTimeConstant, waitForStableLock, waitForStableLock

Method Detail

getDescription

static java.lang.String getDescription()

getLockedX

double getLockedX()
           throws java.io.IOException,
                  DeviceException

Returns the amplitude of the component of the signal in-phase with the reference signal

Returns:

Amplitude, in volts

Throws:

java.io.IOException - Upon communication error

DeviceException - Upon compatibility error

getLockedY

double getLockedY()
           throws java.io.IOException,
                  DeviceException

Returns the amplitude of the component of the signal 90 degrees out of phase with the reference signal

Returns:

Amplitude, in volts

Throws:

java.io.IOException - Upon communication error

DeviceException - Upon compatibility error

getLockedPhase

double getLockedPhase()
               throws java.io.IOException,
                      DeviceException

Returns of the phase of the locked-on signal (relative to the reference)

Returns:

Phase, in degrees

Throws:

java.io.IOException - Upon communication error

DeviceException - Upon compatibility error

autoOffsetX

void autoOffsetX()
          throws java.io.IOException,
                 DeviceException

Throws:

java.io.IOException

DeviceException

autoOffsetY

void autoOffsetY()
          throws java.io.IOException,
                 DeviceException

Throws:

java.io.IOException

DeviceException

autoOffsetAmplitude

void autoOffsetAmplitude()
                  throws java.io.IOException,
                         DeviceException

Throws:

java.io.IOException

DeviceException

autoOffset

default void autoOffset()
                 throws java.io.IOException,
                        DeviceException

Description copied from interface: LockIn

Instruct the lock-in to automatically determine the offset to use.

Specified by:

autoOffset in interface LockIn

Throws:

java.io.IOException - Upon communication error

DeviceException - Upon compatibility error