dl::TImageMetadata Struct Reference

A collection of metadata associated with an image. More...

#include <dlapi.h>

Public Attributes

unsigned int width
 Width of the image frame in pixels. More...
 
unsigned int height
 Height of the image frame in pixels. More...
 
unsigned int offsetX
 The image's x-offset from the sensor's origin in pixels. More...
 
unsigned int offsetY
 The image's y-offset from the sensor's origin in pixels. More...
 
unsigned int binX
 The image's binning in the x-direction (in pixels). More...
 
unsigned int binY
 The image's binning in the y-direction (in pixels). More...
 
float eGain
 The image's binning-dependent eGain (in e-/ADU) More...
 
float exposureDuration
 The image's exposure duration in seconds. May differ from the requested duration due to camera exposure limitations. More...
 

Detailed Description

A collection of metadata associated with an image.

See also
IImage, ISensor::getImage()

Structure containing various metadata of the image buffer. These values represent the image dimensions and sensor settings the camera used to take the image, and may differ from the parametrization passed in to ISensor::setSubframe() and ISensor::startExposure() depending on things like hardware adjustment of eGain during binned exposures, constraints due to minimum exposure durations/precision, etc.

Member Data Documentation

◆ binX

unsigned int dl::TImageMetadata::binX

The image's binning in the x-direction (in pixels).

◆ binY

unsigned int dl::TImageMetadata::binY

The image's binning in the y-direction (in pixels).

◆ eGain

float dl::TImageMetadata::eGain

The image's binning-dependent eGain (in e-/ADU)

◆ exposureDuration

float dl::TImageMetadata::exposureDuration

The image's exposure duration in seconds. May differ from the requested duration due to camera exposure limitations.

See also
ISensor::Info::minExposureDuration, ISensor::Info::exposurePrecision.

◆ height

unsigned int dl::TImageMetadata::height

Height of the image frame in pixels.

◆ offsetX

unsigned int dl::TImageMetadata::offsetX

The image's x-offset from the sensor's origin in pixels.

◆ offsetY

unsigned int dl::TImageMetadata::offsetY

The image's y-offset from the sensor's origin in pixels.

◆ width

unsigned int dl::TImageMetadata::width

Width of the image frame in pixels.


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