ORIEL module

This module contains the driver for ORIEL Luminator monochromated light sources.

Examples

Below is a minimum working example showing how to use the ORIEL Luminator.

import pyvisa
from Devices.ORIEL import Luminator

rm = pyvisa.ResourceManager()
device = Luminator(rm, 'GPIB0::4::INSTR')

device.wavelength = 532 # By default, the first-order wavelength calibration is applied
print(f'Wavelength: {device.wavelength} nm') # Read back actual wavelength

# The timeout will prevent new commands from being sent while the monochromator is moving
device.wavelength = 400
device.wavelength = 900

# Everything outside the configured bounds in clamped
device.wavelength = 0
device.wavelength = 10000

class ORIEL.Luminator(rm, address, config=PosixPath('Config/Luminator.json'))

Bases: object

Driver class for the ORIEL Luminator monochromated light source.

Handles instrument communication via PyVISA and applies an optional linear wavelength calibration based on a provided configuration file.

Parameters:

• rm (pyvisa.ResourceManager) – The VISA resource manager instance.

• address (str) – The VISA resource address for the device.

• config (Path, default: "Config/Luminator.json") – Path to the JSON configuration file containing calibration data with ‘c0’ and ‘c1’ coefficients, ‘lower’ and ‘upper’ limits and ‘speed’ value.

actual2internal(actual)

Converts a desired actual output wavelength to the required internal setpoint.

Parameters:

actual (float) – The desired actual output wavelength in nm.

Returns:

internal – The necessary internal setpoint in nm to achieve the actual wavelength.

Return type:

float

getWavelength(convert=True)

Retrieves the current operating wavelength of the monochromator.

Parameters:

convert (bool, default: True) – If True, returns the calibrated actual wavelength. If False, returns the raw internal setpoint.

Returns:

wavelength – The current wavelength in nm.

Return type:

float

internal2actual(internal)

Converts the internal monochromator setpoint to the actual output wavelength.

Parameters:

internal (float) – The internal wavelength setpoint in nm.

Returns:

actual – The calibrated actual output wavelength in nm.

Return type:

float

setWavelength(target, convert=True)

Sets the operating wavelength of the monochromator.

Parameters:

• target (float) – The target wavelength in nm.

• convert (bool, default: True) – If True, applies the linear calibration to the target before sending.

property wavelength

Get or set the wavelength of the monochromator in nm. Applies calibration if available.

Type:

float