photons.equipment.highfinesse_sdk module

Wrapper around the 32-bit wlmData.dll library from HighFinesse.

photons.equipment.highfinesse_sdk.check(r)

Check the result for an error.

Returns the result if there is no error.

Return type:

bool | int | float

photons.equipment.highfinesse_sdk.check_set(r)

Check the result of a “Set*” function for an error.

Returns the result if there is no error.

Return type:

int | float

class photons.equipment.highfinesse_sdk.WLMData32(host, port)

Bases: Server32

Wrapper around the 32-bit wlmData.dll library from HighFinesse.

convert_unit(value, frm, to)

Convert a value into a representation of another unit.

Parameters:

• value (float) – The value to convert. Must be >= 0.

• frm (int) – The unit index of that value is currently in.

• to (int) – The unit index to convert value to.

Return type:

float

get_analysis_mode()

Whether analysis mode is enabled or disabled.

Return type:

bool

get_auto_exposure_mode()

Whether auto-exposure mode is enabled or disabled.

Return type:

bool

get_exposure_time(channel=1, index=1)

Returns the exposure time (in ms).

Parameters:

• channel (int) – The signal channel for devices with a multichannel switcher. Should be set to 1 for devices that do not have this option.

• index (int) – The CCD array index for devices with more than one CCD array. Can be 1 or 2. For devices with only one CCD array set the value to be 1.

Return type:

int

get_linewidth(index)

Returns the linewidth in the specified unit.

Parameters:

index (int) – The unit to return the linewidth in.

Return type:

float

get_linewidth_mode()

Whether linewidth mode is enabled or disabled.

Return type:

bool

get_pattern_data(index, channel=1)

Returns the interferometer pattern data.

Parameters:

• index (int) –

  The index of the data type to receive.

  • 0 - Fizeau interferometers or diffraction grating

  • 1 - Additional long interferometer or grating analyzing versions (spectrum analysis)

  • 2 - Fizeau interferometers that support double pulses

  • 3 - Additional interferometer for second pulse

• channel (int) – Identifies the switcher channel number. Versions without a switcher must use 1.

Return type:

list[int]

Returns:

The interferometer pattern data.

get_pulse_mode()

Returns the pulse mode.

Return type:

int

get_range()

Returns the wavelength range that is selected.

Return type:

int

get_wide_mode()

Returns the measurement precision mode.

Return type:

int

get_wlm_count()

Returns the number of wavemeter and spectrum-analyser applications that are running.

Return type:

int

get_wlm_version()

Returns version information about the device.

Return type:

dict[str, int]

instantiate(rfc, mode, p1, p2)

Checks whether the Wavelength Meter or Laser Spectrum Analyser server application is running, changes the return mode of the measurement values, installs/removes an extended exporting mechanism, changes the appearance of the server application window or starts/terminates the server application.

See the manual for more details about the input parameters.

Return type:

int

Returns:

If the function succeeds and at least one Wavelength Meter or Laser Spectrum Analyser is active or terminated due to this instantiating operation the function returns a value greater than 0, else 0.

operation(mode)

Set the operation mode.

Parameters:

mode (int) – Controls how a measurement or file accessing activity will be started or stopped. See manual for more details.

Return type:

int

set_analysis_mode(mode)

Set the analysis mode.

Parameters:

mode (bool) – Whether to enable (True) or disable (False) analysis mode.

Return type:

None

set_auto_exposure_mode(mode)

Set the auto-exposure mode.

Parameters:

mode (bool) – Whether to enable (True) or disable (False) auto-exposure mode.

Return type:

None

set_exposure_time(ms, channel=1, index=1)

Set the exposure time.

Parameters:

• ms (int) – The exposure time, in ms.

• channel (int) – The signal channel for devices with a multichannel switcher. Should be set to 1 for devices that do not have this option.

• index (int) – The CCD array index for devices with more than one CCD array. Can be 1 or 2. For devices with only one CCD array set the value to be 1.

set_linewidth_mode(mode)

Set the linewidth mode.

Parameters:

mode (bool) – Whether to enable (True) or disable (False) linewidth mode.

Return type:

None

set_pulse_mode(mode)

Set the pulse mode.

Parameters:

mode (int) – The pulse mode (e.g., 0=CW, 1=Pulsed).

Return type:

None

set_range(value)

Set the wavelength range.

Parameters:

value (int) – The enum value of the wavelength range.

Return type:

None

set_wide_mode(mode)

Set the measurement precision mode.

Parameters:

mode (int) – The precision mode (e.g., 0=fine, 1=wide, 2=grating analysis).

Return type:

None

temperature()

Returns the temperature of the device, in Celsius.

Return type:

float

wait(duration, timeout=30)

Wait for a valid wavelength to be measured and for the exposure time to be stable.

Parameters:

• duration (float) – The number of seconds the device must be stable for.

• timeout (float) – The maximum number of seconds to wait.

Return type:

None

wavelength(number=0)

Returns the wavelength (in nm)

Parameters:

number (int) – The signal number (1 to 8) if the wavemeter has a multichannel switcher or contains the double-pulse option. For wavemeters without these options set to 0.

Return type:

float