FCam::F2::Frame Class Reference

F2::Frame is data returned by an F2::Sensor as a result of a shot. More...

#include <Frame.h>

Inheritance diagram for FCam::F2::Frame:

Collaboration diagram for FCam::F2::Frame:

List of all members.

Public Member Functions
	Frame (_Frame *f=NULL)
	Frames are normally acquired by sensor::getFrame().
RowSkip::e	rowSkip () const
	Number of pixel rows skipped per row read out.
ColSkip::e	colSkip () const
	Number of pixel columns skipped per column read out.
RowBin::e	rowBin () const
	Number of pixel rows averaged together per row read out.
ColBin::e	colBin () const
	Number of pixel columns averaged together per column read out.
int	roiStartX () const
	If roiCentered is false, defines the top-left corner of the region read out 0 is the left edge of the active area.
int	roiStartY () const
	If roiCentered is false, defines the top-left corner of the region read out 0 is the top edge of the active area.
const FCam::F2::Shot &	shot () const
	Overriden shot getter returning a F2::Shot instead of a FCam::Shot.

---

Detailed Description

F2::Frame is data returned by an F2::Sensor as a result of a shot.

Contains additional fields compared to a base FCam::Frame. This class is a reference counted pointer type to the real data, so pass it by value.

Definition at line 49 of file Frame.h.

---

Constructor & Destructor Documentation

FCam::F2::Frame::Frame

(

_Frame *

f = NULL

)

[inline]

Frames are normally acquired by sensor::getFrame().

The Frame constructor can be used to construct dummy frames for testing purposes. The Frame takes ownership of the _Frames passed in.

Definition at line 59 of file Frame.h.

---

Member Function Documentation

RowSkip::e FCam::F2::Frame::rowSkip

(

)

const [inline]

Number of pixel rows skipped per row read out.

Definition at line 62 of file Frame.h.

ColSkip::e FCam::F2::Frame::colSkip

(

)

const [inline]

Number of pixel columns skipped per column read out.

Definition at line 65 of file Frame.h.

RowBin::e FCam::F2::Frame::rowBin

(

)

const [inline]

Number of pixel rows averaged together per row read out.

Definition at line 68 of file Frame.h.

ColBin::e FCam::F2::Frame::colBin

(

)

const [inline]

Number of pixel columns averaged together per column read out.

Definition at line 71 of file Frame.h.

int FCam::F2::Frame::roiStartX

(

)

const [inline]

If roiCentered is false, defines the top-left corner of the region read out 0 is the left edge of the active area.

Negative values result in readout of the black pixels used for black level calibration.

Definition at line 77 of file Frame.h.

int FCam::F2::Frame::roiStartY

(

)

const [inline]

If roiCentered is false, defines the top-left corner of the region read out 0 is the top edge of the active area.

Negative values result in readout of the black pixels used for black level calibration.

Definition at line 83 of file Frame.h.

---

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

• include/FCam/F2/Frame.h