dl::TExposureOptions Struct Reference

A collection of exposure parameters required for starting an exposure. More...

#include <dlapi.h>

Public Attributes

float duration
 Duration of the exposure in seconds. More...
 
unsigned int readoutMode
 The index of the readout mode to use in the exposure. This is the index of the readout mode chosen from ISensor::getReadoutModes(). More...
 
char binX
 [[deprecated]] Binning of the exposure in the x-direction in pixels. Is unused, and will go away in future versions of DLAPI. More...
 
char binY
 [[deprecated]] Binning of the exposure in the y-direction in pixels. Is unused, and will go away in future versions of DLAPI. More...
 
bool isLightFrame
 true if the exposure is a light frame, false otherwise. More...
 
bool useRBIPreflash
 true to perform an RBI Preflash operation (if the camera supports it) before the exposure. Preflash duration and flush count are set via the ISensor::Settings structure. More...
 
bool useExtTrigger
 true to wait for an external trigger before executing the exposure. Consult your camera's user manual for more details on external trigger operation. More...
 

Detailed Description

A collection of exposure parameters required for starting an exposure.

See also
ICamera::startExposure()

Structure containing all contextual information for starting an exposure.

Member Data Documentation

◆ binX

char dl::TExposureOptions::binX

[[deprecated]] Binning of the exposure in the x-direction in pixels. Is unused, and will go away in future versions of DLAPI.

◆ binY

char dl::TExposureOptions::binY

[[deprecated]] Binning of the exposure in the y-direction in pixels. Is unused, and will go away in future versions of DLAPI.

◆ duration

float dl::TExposureOptions::duration

Duration of the exposure in seconds.

◆ isLightFrame

bool dl::TExposureOptions::isLightFrame

true if the exposure is a light frame, false otherwise.

◆ readoutMode

unsigned int dl::TExposureOptions::readoutMode

The index of the readout mode to use in the exposure. This is the index of the readout mode chosen from ISensor::getReadoutModes().

See also
ISensor::getReadoutModes()

◆ useExtTrigger

bool dl::TExposureOptions::useExtTrigger

true to wait for an external trigger before executing the exposure. Consult your camera's user manual for more details on external trigger operation.

◆ useRBIPreflash

bool dl::TExposureOptions::useRBIPreflash

true to perform an RBI Preflash operation (if the camera supports it) before the exposure. Preflash duration and flush count are set via the ISensor::Settings structure.

See also
ISensor::Setting::RBIPreflashDuration, ISensor::Setting::RBIPreflashFlushCount, ISensor::Settings::RBIPreflashSettings

The documentation for this struct was generated from the following file:
  • C:/NightlyBuild/DL_Imaging/Aluma_Software/dlapi/src/dlapi.h