msl.equipment.resources.optronic_laboratories.ol756ocx_32 module

Load the 32-bit OL756SDKActiveXCtrl library using MSL-LoadLib.

class msl.equipment.resources.optronic_laboratories.ol756ocx_32.OL756(host, port, **kwargs)

Bases: Server32

Communicates with the 32-bit OL756SDKActiveXCtrl library.

accumulate_signals(meas_type)

Function needs to be called after a measurement was performed.

This essentially accumulates the data together until the user is ready to average out the data. This function is used in combination with reset_averaging() and do_averaging().

Parameters:

meas_type (int) –

The measurement type wanted.

• 0 - Irradiance

• 1 - Radiance

• 2 - Transmittance

• 3 - Irradiance Calibration

• 4 - Radiance Calibration

• 5 - Transmittance Calibration

connect_to_ol756(mode, com_port=1)

Desired mode to connect to OL756. If attempting to connect in RS232 or USB mode, and OL756 is not detected, then a dialog box will appear to prompt user to select either to retry, cancel or switch to DEMO.

Parameters:

• mode (int) –

  Valid modes are:

  • -1: Disconnect. Call this before quitting the application.

  • 0: RS232

  • 1: USB

  • 2: DEMO mode

• com_port (int, optional) – If connecting through RS232 then port is the COM port number to use.

Returns:

int – The mode that was actually used for the connection.

do_averaging(meas_type, num_to_average)

Function divides the accumulated signal by the number of scans performed. It then sets the array containing the data with the averaged data. This function is used in combination with reset_averaging() and accumulate_signals().

Parameters:

• meas_type (int) –

  The measurement type wanted.

  • 0 - Irradiance

  • 1 - Radiance

  • 2 - Transmittance

  • 3 - Irradiance Calibration

  • 4 - Radiance Calibration

  • 5 - Transmittance Calibration

• num_to_average (int) – The number of scans to average.

do_calculations(meas_type)

Function needs to be called after each measurement to update the calculations.

Parameters:

meas_type (int) –

The measurement type wanted.

• 0 - Irradiance

• 1 - Radiance

• 2 - Transmittance

• 3 - Irradiance Calibration

• 4 - Radiance Calibration

• 5 - Transmittance Calibration

enable_calibration_file(meas_type, enable)

Enables or disables the use of a calibration file.

Use this option to generate calibrated results. To open a standard file used to create a calibration, use enable_standard_file() instead.

The user should call load_calibration_file() first to load the calibration file before enabling it.

Parameters:

• meas_type (int) –

  The measurement type wanted.

  • 0 - Irradiance

  • 1 - Radiance

  • 2 - Transmittance

• enable (bool) – Whether to enable or disable the use of a calibration file.

enable_dark_current(enable)

Turn the dark current on or off.

Enable this feature if you want the dark current automatically acquired and subtracted before each measurement. If you wish to take a dark current manually, see the get_dark_current() function.

The parameters for the dark current will need to be set using set_dark_current_params().

Parameters:

enable (bool) – Whether to turn the dark current on or off.

enable_pmt_protection_mode(enable)

Turn the PMT protection routines on or off.

Enable this feature if you want the PMT to be shielded while traveling through high intensity spikes. This feature will make the scan slower since the wavelength and filter drive will move asynchronously.

The PMT is still protected by the hardware. This function prevents exposure of the PMT while traveling.

Parameters:

enable (bool) – Whether to turn the PMT protection routines on or off.

enable_standard_file(meas_type, enable)

Function enables standard files to be used.

To open a calibration file used to create a measurement, use enable_calibration_file() instead.

The user should call load_standard_file() first to load the standard file before enabling it.

Parameters:

• meas_type (int) –

  The calibration measurement type wanted.

  • 3 - Irradiance Calibration

  • 4 - Radiance Calibration

  • 5 - Transmittance Calibration

• enable (bool) – Whether to turn the application of the standard file on or off.

export_config_file(file_path)

Exports the config file into a OL756 compatible configuration file.

Not all settings used will be applicable.

Parameters:

file_path (str) – A valid path to save the file at.

export_registry()

Save data out to the Windows registry.

Make sure that a read was done at some point using import_registry(). Does not create a configuration file that can be loaded into another computer. For that particular function, call export_config_file().

get_adaptive_int_time_index(gain_index)

Get the adaptive integration time index.

Parameters:

gain_index (int) –

The index of the gain to use to get the integration time.

• 0 - 1.0E-5

• 1 - 1.0E-6

• 2 - 1.0E-7

• 3 - 1.0E-8

• 4 - 1.0E-9

• 5 - 1.0E-10

• 6 - 1.0E-11

Returns:

int – The adaptive integration time index.

get_cri(meas_type, index)

Get the color-rendering information.

The user should call do_calculations() at least once before calling this function.

Parameters:

• meas_type (int) –

  The measurement type wanted.

  • 0 - Irradiance

  • 1 - Radiance

  • 2 - Transmittance

  • 3 - Irradiance Calibration

  • 4 - Radiance Calibration

  • 5 - Transmittance Calibration

• index (int) –

  The color-rendering index.

  • 0 - General CRI

  • 1 - Light Greyish Red (CRI#1)

  • 2 - Dark Greyish Yellow (CRI#2)

  • 3 - Strong Yellow Green (CRI#3)

  • 4 - Moderate Yellowish Green (CRI#4)

  • 5 - Light Bluish Green (CRI#5)

  • 6 - Light Blue (CRI#6)

  • 7 - Light Violet (CRI#7)

  • 8 - Light Reddish Purple (CRI#8)

  • 9 - Strong Red (CRI#9)

  • 10 - Strong Yellow (CRI#10)

  • 11 - Strong Green (CRI#11)

  • 12 - Strong Blue (CRI#12)

  • 13 - Light Yellowish Pink (CRI#13)

  • 14 - Moderate Olive Green (CRI#14)

Returns:

float – The color-rendering information.

get_cal_array()

This method allows user to get the spectral data of a calibration after it is made. The data allows the user to take the data and create their own data files.

Returns:

• int – A pointer to an array of signals.

• int – The number of points acquired.

get_cal_file_enabled(meas_type)

Checks to see if the calibration file is enabled.

The user should call load_calibration_file() first to load the calibration file before enabling it.

Parameters:

meas_type (int) –

The measurement type wanted.

• 0 - Irradiance

• 1 - Radiance

• 2 - Transmittance

Returns:

bool – Whether the calibration file is enabled.

get_calculated_data(meas_type, index)

Gets data calculated from the intensities.

The user should call do_calculations() at least once before calling this function.

Parameters:

• meas_type (int) –

  The measurement type wanted.

  • 0 - Irradiance

  • 1 - Radiance

  • 2 - Transmittance

  • 3 - Irradiance Calibration

  • 4 - Radiance Calibration

  • 5 - Transmittance Calibration

• index (int) –

  The index to retrieve data of.

  • 0 - Color Temperature

  • 1 - Dominant Wavelength

  • 2 - LED Half Bandwidth

  • 3 - Left Half Bandwidth

  • 4 - Right Half Bandwidth

  • 5 - Peak Spectral Value

  • 6 - LEDPeakWavelength

  • 7 - Radiometric Value

  • 8 - Purity

  • 9 - Center Wavelength

  • 10 - Photometric Value

Returns:

float – Pointer to a double to hold the data.

get_calibration_file(meas_type)

Get a calibration file that is loaded.

Parameters:

meas_type (int) –

The measurement type wanted.

• 0 - Irradiance

• 1 - Radiance

• 2 - Transmittance

Returns:

str – String containing the name and path of the calibration file that is loaded for a particular measurement type.

get_chromaticity_data(meas_type, index)

Get the calculated chromaticity values requested.

Must have called do_calculations() at least once.

Parameters:

• meas_type (int) –

  The measurement type wanted.

  • 0 - Irradiance

  • 1 - Radiance

  • 2 - Transmittance

  • 3 - Irradiance Calibration

  • 4 - Radiance Calibration

  • 5 - Transmittance Calibration

• index (int) – The chromaticity index value [0..70]. See the SDK manual for more details.

Returns:

float – Pointer to a double to hold the data.

get_dark_current(use_compensation)

Takes a manual dark current.

User will have to subtract from data array by retrieving this array via a get_cal_array() or get_signal_array(). This is a special function and most users will want to use enable_dark_current() instead because it automatically does the subtraction.

Function if called externally by user program will not have result saved out to data file. If the enable_dark_current() was enabled, then this function need should not be called.

Parameters:

use_compensation (int) – Adjusts dark current for more dynamic ranging using reverse current.

Returns:

float – The dark current.

get_dark_current_enable()

Returns whether the dark-current mode is enabled.

Returns:

bool – Whether the dark-current mode is enabled or disabled.

get_dark_current_mode()

Returns whether the dark current is taken at a wavelength or in shutter mode.

Returns:

int – The dark-current mode

• 0 - Dark current in wavelength mode (taken at a particular wavelength designated by the user).

• 1 - Dark current in shutter mode

get_dark_current_wavelength()

Get the dark current wavelength.

Returns:

float – Wavelength that the dark current will be taken at.

get_ending_wavelength()

Get the ending wavelength of the scan range.

Returns:

float – The ending wavelength, in nanometers, of the scan range.

get_gain_index()

Get the index of the gain that will be applied when the parameters are to be sent down.

Applies to both quick scan and point to point scans.

Returns:

int – The gain index.

• 0 - 1.0E-5

• 1 - 1.0E-6

• 2 - 1.0E-7

• 3 - 1.0E-8

• 4 - 1.0E-9

• 5 - 1.0E-10 (Point to Point mode only)

• 6 - 1.0E-11 (Point to Point mode only)

• 7 - Auto Gain Ranging (Point to Point mode only)

get_increment()

Get the wavelength increment that is used for a scan.

Returns:

float – The wavelength increment, in nanometers.

get_increment_index()

Get the index of the wavelength increment that is used for a scan.

Applies to both quick scan and point to point scans.

Returns:

int – Index of the wavelength increment of a scan.

• 0 - 0.025 nm

• 1 - 0.05 nm

• 2 - 0.1 nm

• 3 - 0.2 nm

• 4 - 0.5 nm

• 5 - 1.0 nm

• 6 - 2.0 nm

• 7 - 5.0 nm

• 8 - 10.0 nm

get_integration_time_index(scan_mode)

Get the index into the integration time array.

Applies to both quick scan and point to point scans. In quick scan, the speed will vary based on the scan range and increments.

Parameters:

scan_mode (int) – The scan mode to use to get the index of.

Returns:

int – Point to Point mode

• 0 - 1.000 sec

• 1 - 0.500 sec

• 2 - 0.200 sec

• 3 - 0.100 sec

• 4 - 0.050 sec

• 5 - 0.020 sec

• 6 - 0.010 sec

• 7 - 0.005 sec

• 8 - 0.002 sec

• 9 - 0.001 sec

• 10 - Adaptive (Point To Point mode only)

Quick Scan mode

• 0 - slowest

• 10 - fastest

get_ocx_version()

Get the version of the OL756 SDK ActiveX control.

Returns:

str – The software version.

get_pmt_flux_overload()

Get the voltage of the photomultiplier tube flux overload.

Returns:

float – Voltage that the PMT will determine to be at the overload point.

get_pmt_voltage()

Returns the voltage that will sent or has been sent down to the PMT.

Returns:

float – Voltage value, in volts, of the photomultiplier tube.

get_quick_scan_rate()

Returns the rate at the quick scan index.

Returns:

float – Rate of the quick scan at the current index in nm/s.

get_quick_scan_rate_index()

Returns the index of the quick scan rate.

Returns:

int – Index of the quick scan rate.

get_scan_mode()

Get the mode the scan will be done in.

Returns:

int – The scan mode

• 0 - Point to Point mode

• 1 - Quick Scan mode

get_settling_time()

Gte the settling time.

Settling time is time where the wavelength drive pauses once it reaches its target wavelength.

Returns:

float – Settling time, in seconds, to be sent down or has already been sent to the system.

get_signal_array()

Get the spectral data of a measurement after it is made.

Returns:

tuple – The spectral data.

get_standard_file(meas_type)

Retrieves the name of standard file.

Parameters:

meas_type (int) –

The measurement type wanted.

• 3 - Irradiance calibration

• 4 - Radiance calibration

• 5 - Transmittance calibration

Returns:

str – String containing the name and path of the standard file that is loaded for a particular calibration type.

get_start_wavelength()

Get the starting wavelength of a scan.

Applies to both quick scan and point to point scans.

Returns:

float – The wavelength, in nanometers, that the scan will start from.

get_std_file_enabled(meas_type)

Checks to see if the standard file is enabled.

The user should call load_standard_file() first to load the standard file before enabling it.

Parameters:

meas_type (int) –

The calibration type wanted.

• 0 - Irradiance

• 1 - Radiance

• 2 - Transmittance

Returns:

bool – Whether a standard file is enabled.

import_config_file(path)

The file is a standard OL756 configuration file.

Not all settings used will be applicable. Measurement type is not used because in the SDK, the take_point_to_point_measurement() function has as an input the measurement type. The user should select the type and not have it based on the configuration file.

Parameters:

path (str) – A valid path to load the file at.

import_registry()

Loads data from the registry.

Loads default if no registry exists. To import the configuration from another computer, use import_config_file() instead.

Not all settings used will be applicable. Measurement type is not used because in the SDK, the take_point_to_point_measurement() function has as an input the measurement type. The user should select the type and not have it based on the configuration file.

load_calibration_file(path, meas_type)

Load a calibration file.

Parameters:

• path (str) – The path of a calibration file.

• meas_type (int) –

  The measurement type.

  • 0 - Irradiance

  • 1 - Radiance

  • 2 - Transmittance

load_standard_file(path, meas_type)

Load a standard file.

Parameters:

• path (str) – The path of a standard file.

• meas_type (int) –

  The measurement type.

  • 3 - Irradiance Calibration

  • 4 - Radiance Calibration

  • 5 - Transmittance Calibration

manual_filter_drive_connect(connect)

Used to connect or disconnect the filter drive.

Disconnecting essentially acquires scans without the filter.

Parameters:

connect (bool) – Connect or disconnect the filter drive. Reconnecting will home the wavelength and filter drive.

manual_get_gain()

The index of the gain that will be applied when the parameters are to be sent down.

Returns:

int – The gain index.

• 0 - 1.0E-5

• 1 - 1.0E-6

• 2 - 1.0E-7

• 3 - 1.0E-8

• 4 - 1.0E-9

• 5 - 1.0E-10 (Point to Point mode only)

• 6 - 1.0E-11 (Point to Point mode only)

• 7 - Auto Gain Ranging (Point to Point mode only)

manual_get_integration_time()

Returns the integration time set in the system.

Only applies to the integration time used for Point to Point scans.

Returns:

float – The integration time in seconds.

manual_get_pmt_overload()

Returns the PMT overload voltage set in the system.

Returns:

float – Overload voltage, in volts, of the photomultiplier tube.

manual_get_pmt_voltage()

Returns the PMT high voltage set in the system.

Returns:

float – Voltage, in volts, of the photomultiplier tube.

manual_get_settling_time()

Returns the settling time of the instrument.

Returns:

float – Settling time of the system in seconds.

manual_get_signal()

Returns the signal at the current position of the wavelength drive.

Returns:

float – The signal, in amperes.

manual_home_ol756()

Homes the wavelength and filter drive.

Will reconnect the filter drive if it was disconnected

manual_move_to_wavelength(wavelength)

Moves the wavelength drive to a particular location.

Parameters:

wavelength (float) – The wavelength to move the wavelength drive to.

manual_set_gain(gain_index, mode)

Set the gain.

Parameters:

• gain_index (int) –

  The gain index.

  • 0 - 1.0E-5

  • 1 - 1.0E-6

  • 2 - 1.0E-7

  • 3 - 1.0E-8

  • 4 - 1.0E-9

  • 5 - 1.0E-10 (Point to Point mode only)

  • 6 - 1.0E-11 (Point to Point mode only)

  • 7 - Auto Gain Ranging (Point to Point mode only)

• mode (int) –

  The scan mode

  • 0 - point to point

  • 1 - quick scan

manual_set_integration_time(time)

Sets the integration time set in the system.

Only applies to the integration time used for Point to Point scans.

Parameters:

time (float) – The integration time in seconds.

manual_set_pmt_overload(overload)

Sets the PMT overload voltage set in the system.

Parameters:

overload (float) – Overload voltage, in volts, of the photomultiplier tube in Volts.

manual_set_pmt_voltage(voltage)

Sets the PMT high voltage set in the system.

Parameters:

voltage (float) – Voltage, in volts, of the photomultiplier tube.

manual_set_settling_time(time)

Sets the settling time of the instrument.

Parameters:

time (float) – Settling time of the system.

move_to_wavelength(wavelength)

Moves the wavelength drive to a particular location.

Parameters:

wavelength (float) – The wavelength, in nanometers, to move the wavelength drive to.

read_ol756_flash_settings()

Reads the saved settings from the flash memory.

Reads the settings such as the grating alignment factor, filter skew and wavelength skew. Loads these values into the ActiveX control memory.

reset_averaging(meas_type)

Resets the accumulated signal array for the specified measurement type.

This function is used in combination with do_averaging() and accumulate_signals().

Parameters:

meas_type (int) –

The measurement type.

• 0 - Irradiance

• 1 - Radiance

• 2 - Transmittance

• 3 - Irradiance Calibration

• 4 - Radiance Calibration

• 5 - Transmittance Calibration

save_calibration_file(meas_type, path)

Create a OL756-compatible calibration file.

Parameters:

• meas_type (int) –

  The measurement type.

  • 3 - Irradiance Calibration

  • 4 - Radiance Calibration

  • 5 - Transmittance Calibration

• path (str) – The path to save the calibration file to.

save_measurement_data(meas_type, path)

Save the measurement data to a OL756-compatible data file.

Parameters:

• meas_type (int) –

  The measurement type.

  • 0 - Irradiance

  • 1 - Radiance

  • 2 - Transmittance

• path (str) – The path to save the data to.

send_down_parameters(scan_mode)

Sends down the parameters to the system.

This needs to be called whenever parameters dealing with the PMT or integration time and gain has changed. Needs to be called once before doing any measurements or other signal acquisition including dark current.

The following methods affect the parameters: set_pmt_flux_overload_voltage() set_gain() set_integration_time() set_pmt_hi_voltage() set_settling_time() set_scan_range() set_adaptive_integration_time()

Parameters:

scan_mode (int) –

The scan mode.

• 0 - Point to point

• 1 - Quick scan

set_adaptive_integration_time(gain_index, speed_index)

Sets the scan speed of the scan at a particular gain range.

Adaptive integration time is used solely for point to point scans in auto-gain ranging.

Parameters:

• gain_index (int) –

  The index of the gain to use to set the integration time.

  • 0 - 1.0E-5

  • 1 - 1.0E-6

  • 2 - 1.0E-7

  • 3 - 1.0E-8

  • 4 - 1.0E-9

  • 5 - 1.0E-10

  • 6 - 1.0E-11

• speed_index (int) – The scan speed index [0..12] – 0=Slowest, 12=Fastest.

set_averaging_number_of_scan(num_avg_scans)

Set the number of scans to average.

Parameters:

num_avg_scans (int) – The number of scans to average.

set_dark_current_params(mode, wavelength)

Sets the mode and the wavelength to use for a dark-current measurement.

Parameters:

• mode (int) –

  The mode to use to acquire a dark-current measurement

  • 0 - wavelength

  • 1 - shutter

• wavelength (float) – The wavelength, in nanometers, to use for a dark-current measurement.

set_gain(scan_mode, gain_index)

Sets the index of the gain that will be applied when the parameters are to be sent down.

Applies to both quick scan and point to point scans.

Parameters:

• scan_mode (int) –

  The scan mode

  • 0 - Point to Point

  • 1 - Quick Scan

• gain_index (int) –

  The gain index

  • 0 - 1.0E-5

  • 1 - 1.0E-6

  • 2 - 1.0E-7

  • 3 - 1.0E-8

  • 4 - 1.0E-9

  • 5 - 1.0E-10 (available only in Point to Point mode)

  • 6 - 1.0E-11 (available only in Point to Point mode)

  • 7 - Auto Gain Ranging (available only in Point to Point mode)

set_integration_time(scan_mode, scan_speed)

Sets the index of the scan speed used.

Applies to both quick scan and point to point scans. In quick scan, the speed will vary based on the scan range and increments.

Parameters:

• scan_mode (int) –

  The scan mode

  • 0 - Point to Point

  • 1 - Quick Scan

• scan_speed (int) –

  Index to the integration time array

  Point to Point mode

  • 0 - 1.000 sec

  • 1 - 0.500 sec

  • 2 - 0.200 sec

  • 3 - 0.100 sec

  • 4 - 0.050 sec

  • 5 - 0.020 sec

  • 6 - 0.010 sec

  • 7 - 0.005 sec

  • 8 - 0.002 sec

  • 9 - 0.001 sec

  • 10 - Adaptive (Point To Point mode only)

  • 11 - User defined (Point To Point mode only)

  Quick Scan mode

  • 0 - slowest

  • 10 - fastest

set_pmt_flux_overload_voltage(overload_voltage)

Sets the value to use for the photomultiplier tube flux overload.

Parameters:

overload_voltage (float) – Voltage that the PMT will determine to be at the overload point. Software only, because PMT has built-in protection also.

set_pmt_hi_voltage(hi_voltage)

Sets the value to be determined to be a flux overload by the software.

Parameters:

hi_voltage (float) – Voltage, in volts, that the PMT will determine to be overload point.

set_reference_white_point(white, user_def_x, user_def_y)

Sets the value of the reference illuminant.

Parameters:

• white (int) –

  The reference white point

  • 0 - Incandescent(A)

  • 1 - Direct Sunlight(B)

  • 2 - Indirect Sunlight(C)

  • 3 - Natural Daylight(D65)

  • 4 - Normalized Reference(E)

  • 5 - User Defined

• user_def_x (float) – User defined x on CIE chart.

• user_def_y (float) – User defined y on CIE chart.

set_scan_range(start, end, inc_index)

Sets the wavelength scan range.

Parameters:

• start (float) – Starting wavelength, in nanometers.

• end (float) – Ending wavelength, in nanometers.

• inc_index (int) – Increment index, in nanometers.

set_settling_time(time)

Set the settling time.

Settling time is the time that the wavelength drive pauses once it reaches its target wavelength.

Parameters:

time (float) – Settling Time in seconds to be sent down or has already been sent to the system.

set_tab_delimited_mode(enable)

Purpose of function is to set what mode to write the data files as.

Setting the tab delimited to true will write the data in a tab delimited format, else a false will write in a comma delimited format. Tab delimited files will not be compatible with some versions of the software. If you want data files to be compatible with v1.32 software and below, leave the mode to False.

Parameters:

enable (bool) – Whether to use the new file format using TABs as a delimited or the old file format compatible with v1.32 and below.

set_user_defined_integration_time(time)

Sets the user defined integration time to be used only in point to point scans and only if the user sets the integration time mode.

Parameters:

time (float) – Integration time in seconds.

stop_measurement()

Stops a measurement.

Applies only to Point to Point measurements. Quick scans are done so quickly that there is no need to stop a measurement once it starts.

take_point_to_point_calibration(meas_type)

Takes a calibration in point to point mode.

Need to have called send_down_parameters() at least once before calling any of the measurement functions or data acquisition functions.

Parameters:

meas_type (int) –

The measurement type.

• 3 - Irradiance Calibration

• 4 - Radiance Calibration

• 5 - Transmittance Calibration

take_point_to_point_measurement(meas_type)

Takes a measurement in point to point mode.

Need to have called send_down_parameters() at least once before calling any of the measurement functions or data acquisition functions.

Parameters:

meas_type (int) –

The measurement type.

• 0 - Irradiance

• 1 - Radiance

• 2 - Transmittance

take_quick_scan_calibration(meas_type)

Takes a calibration in quick scan mode.

Need to have called send_down_parameters() at least once before calling any of the measurement functions or data acquisition functions.

Parameters:

meas_type (int) –

The measurement type.

• 3 - Irradiance Calibration

• 4 - Radiance Calibration

• 5 - Transmittance Calibration

take_quick_scan_measurement(meas_type)

Takes a measurement in quick scan mode.

Need to have called send_down_parameters() at least once before calling any of the measurement functions or data acquisition functions.

Parameters:

meas_type (int) –

The measurement type.

• 0 - Irradiance

• 1 - Radiance

• 2 - Transmittance