1.4. OceanOptics Spectrometers

Summary:

Ocean Optics Spectrometers

Type:

DataIO

License:

LGPL

Platforms:

Windows, Linux ready but not tested

Devices:

Ocean Optics Spectrometers

Author:

J. Drozella, ITO, University Stuttgart

1.4.1. Overview

This DLL integrates the OceanOptics spectrometers which use the Ocean Byte Protocol (OBP) into itom. This includes series: STS, QE Pro, Ocean FX, and Ocean HDX (and probably future releases) It uses the libUSB interface to communicate with the devices. !This was ONLY fully implemented for the STS series! Others most likely won’t work properly yet. Tested with: * OceanOptics STS-UV (25 um slit)

1.4.2. Initialization

The following parameters are mandatory or optional for initializing an instance of this plugin:

  • VendorID: int

    VendorID of spectrometer, 0x2457 for OceanOptics STS

    Value range: [0x0, inf], Default: 0x2457

  • ProductID: int

    ProductID of spectrometer, 0x4000 for STS

    Value range: [0x0, inf], Default: 0x4000

1.4.3. Parameters

An instance of this plugin has the following internal parameters:

average: {int}

Number of averages for every frame

bpp: {int}, read-only

Bit depth. The output object is float32 for all cases but uint16 only if no averaging is enabled and the dark_correction is disabled or no dark correction pixels are available for this sensor.

detector_name: {str}, read-only

Name of the detector.

integration_time: {float}

Integration time of CCD programmed in s, some devices do not accept the full range of allowed values (see AvaSpec for real minimum value of your device).

lambda_coeffs: {seq. of float}, read-only

Coefficients for polynom that determines lambda_table (lambda_table[idx] = c[0] + c[1]*idx + c[2]*idx^2 + c[3]*idx^3)

lambda_table: {seq. of float}, read-only

Vector with the wavelength of all active pixels

name: {str}, read-only

plugin name

roi: {int rect [x0,y0,width,height]}

ROI (x,y,width,height)

serial_number: {str}, read-only

Serial number of spectrometer. Same as identifier.

sizex: {int}, read-only

current width of ROI

sizey: {int}, read-only

current height

1.4.4. Timestamp

Every acquired image will have a tag ‘timestamp’ defined. It contains the timestamp of the acquisition in seconds based on QDateTime::currentMSecsSinceEpoch(). If data is averaged, the timestamp of the latest acquisition is used.

1.4.5. Changelog

  • itom setup 4.1.0: This plugin has been compiled using the libUSB Plugin

  • ONLY fully implemented for STS series, other spectrometers using OBP won’t fully work.