C-style settings structure with built-in type conversion. More...

#include <dlapi.h>

Classes
struct	RBIPreflashSettings
	RBI Preflash parametrization data structure. More...

Public Attributes
struct dl::ISensor::Settings::RBIPreflashSettings	rbiPreflash
	RBI preflash settings. More...

int	fanSpeed
	controls the fan speed of the camera. Fan speeds: high = 255, medium = 200, low = 150, off = 0 (not recommended). More...

bool	useOverscan
	true to enable the sensor's overscan region, or false to disable it. Defaults to false. \seealso ISensor::UseOverscan, ISensor::setSubframe() More...

bool	useWindowHeater
	true to turn on the camera's window heater. false to turn it off. More...

bool	enableIRLEDs
	enable RBI Preflash IR LEDs for testing purposes More...

bool	useOnChipBinning
	Use on-chip binning. More...

bool	useExtTrigger
	Wait for external trigger during exposures. More...

bool	autoFanSpeed
	Use automatic fan speed control algorithm. More...

int	shutterPolarity
	controls the polarity of solenoid shutters. Only needs to be changed if shutter operation is inverted (i.e. requesting shutter open results in shutter closed, and vice versa) More...

bool	enableStatusLED
	enables/disables the status LED on the side of the camera. non-zero enables it, zero disables it. defaults to on. More...

int	partialExposureLength
	controls the length of sub-exposures during internal stacking exposures (in 1 second increments) More...

int	useFWAsShutter
	true to use the connected filter wheel as a shutter (use the index of the slot, starting from 1), 0 disables this feature More...

Detailed Description

C-style settings structure with built-in type conversion.

See also: ISensor::Setting, ISensor::querySetting(), ISensor::getSetting(), and ISensor::setSetting()

Structure is reflected by the ISensor::Setting index keys, and contains all user-controlled settings. NOTE: This strucure is deprecated. Please use the ISensor::querySetting(), ISensor::getSetting(), and ISensor::setSetting() methods instead.

Member Data Documentation

◆ autoFanSpeed

bool dl::ISensor::Settings::autoFanSpeed

Use automatic fan speed control algorithm.

See also: ISensor::AutoFanMode

◆ enableIRLEDs

bool dl::ISensor::Settings::enableIRLEDs

enable RBI Preflash IR LEDs for testing purposes

See also: ISensor::ToggleIRLEDs

◆ enableStatusLED

bool dl::ISensor::Settings::enableStatusLED

enables/disables the status LED on the side of the camera. non-zero enables it, zero disables it. defaults to on.

◆ fanSpeed

int dl::ISensor::Settings::fanSpeed

controls the fan speed of the camera. Fan speeds: high = 255, medium = 200, low = 150, off = 0 (not recommended).

See also: ISensor::FanSpeed

◆ partialExposureLength

int dl::ISensor::Settings::partialExposureLength

controls the length of sub-exposures during internal stacking exposures (in 1 second increments)

◆ rbiPreflash

struct dl::ISensor::Settings::RBIPreflashSettings dl::ISensor::Settings::rbiPreflash

RBI preflash settings.

◆ shutterPolarity

int dl::ISensor::Settings::shutterPolarity

controls the polarity of solenoid shutters. Only needs to be changed if shutter operation is inverted (i.e. requesting shutter open results in shutter closed, and vice versa)

◆ useExtTrigger

bool dl::ISensor::Settings::useExtTrigger

Wait for external trigger during exposures.

See also: ISensor::UseExtTrigger

◆ useFWAsShutter

int dl::ISensor::Settings::useFWAsShutter

true to use the connected filter wheel as a shutter (use the index of the slot, starting from 1), 0 disables this feature

◆ useOnChipBinning

bool dl::ISensor::Settings::useOnChipBinning

Use on-chip binning.

See also: ISensor::UseOnChipBinning

◆ useOverscan

bool dl::ISensor::Settings::useOverscan

true to enable the sensor's overscan region, or false to disable it. Defaults to false. \seealso ISensor::UseOverscan, ISensor::setSubframe()

◆ useWindowHeater

bool dl::ISensor::Settings::useWindowHeater

true to turn on the camera's window heater. false to turn it off.

See also: ISensor::UseWindowHeater

The documentation for this struct was generated from the following file:

C:/NightlyBuild/DL_Imaging/Aluma_Software/dlapi/src/dlapi.h

Classes

Public Attributes