F2::Shot collects parameters for capturing a frame with support for all the parameters of the F2 Frankencamera. More...

#include <Shot.h>

Inheritance diagram for FCam::F2::Shot:

Collaboration diagram for FCam::F2::Shot:

[legend]

Public Member Functions
void	roiRegionSmaller (const Rect &maxRegion, bool useBinning=true)
	Convenience function for setting skip/bin and roiStart.
void	roiRegionSmaller (const Size &maxSize, bool useBinning=true)
	Convenience function for setting skip/bin and roiStart.
void	roiRegionLarger (const Rect &minRegion, bool useBinning=true)
	Convenience function for setting skip/bin and roiStart.
void	roiRegionLarger (const Size &minSize, bool useBinning=true)
	Convenience function for setting skip/bin and roiStart.
	Shot (const FCam::Shot &shot)
	Copying a shot results in a very deep copy.
const Shot &	operator= (const FCam::Shot &)
	Copying a shot results in a very deep copy.
Public Attributes
RowSkip::e	rowSkip
	Number of pixel rows skipped per row read out.
ColSkip::e	colSkip
	Number of pixel columns skipped per column read out.
RowBin::e	rowBin
	Number of pixel rows averaged together per row read out.
ColBin::e	colBin
	Number of pixel columns average together per column read out.
bool	roiCentered
	Flag to indicate that the region of interest should be centered on the sensor's active pixel area.
int	roiStartX
	If roiCentered is false, defines the top-left corner of the region read out.
int	roiStartY
	If roiCentered is false, defines the top-left corner of the region read out.

Detailed Description

F2::Shot collects parameters for capturing a frame with support for all the parameters of the F2 Frankencamera.

Most machinery inherited from FCam::Shot

Definition at line 63 of file Shot.h.

Constructor & Destructor Documentation

FCam::F2::Shot::Shot ( const FCam::Shot & other )

Copying a shot results in a very deep copy.

This assigns a freshly generated shot id to the result.

Reimplemented from FCam::Shot.

Definition at line 19 of file Shot.cpp.

Member Function Documentation

void FCam::F2::Shot::roiRegionSmaller	(	const Rect &	maxRegion,
		bool	useBinning = `true`
	)

Convenience function for setting skip/bin and roiStart.

Sets the region to be as close as possible to the requested region while being smaller than the requested region. Defaults to turning on binning, which reduces frame rate but reduces image artifacts

Definition at line 61 of file Shot.cpp.

void FCam::F2::Shot::roiRegionSmaller	(	const Size &	maxSize,
		bool	useBinning = `true`
	)

Convenience function for setting skip/bin and roiStart.

Sets the region to be as close as possible to the requested size while being smaller than the requested size, with the top corner at (0,0) Defaults to turning on binning, which reduces frame rate but reduces image artifacts

Definition at line 91 of file Shot.cpp.

void FCam::F2::Shot::roiRegionLarger	(	const Rect &	minRegion,
		bool	useBinning = `true`
	)

Convenience function for setting skip/bin and roiStart.

Sets the region to be as close as possible to the requested region while being larger than the requested region. Defaults to turning on binning, which reduces frame rate but reduces image artifacts

Definition at line 96 of file Shot.cpp.

void FCam::F2::Shot::roiRegionLarger	(	const Size &	minSize,
		bool	useBinning = `true`
	)

Convenience function for setting skip/bin and roiStart.

Sets the region to be as close as possible to the requested size while being larger than the requested size, with the top corner at (0,0) Defaults to turning on binning, which reduces frame rate but reduces image artifacts

Definition at line 129 of file Shot.cpp.

const Shot & FCam::F2::Shot::operator= ( const FCam::Shot & other )

Copying a shot results in a very deep copy.

This assigns a freshly generated shot id to the result.

Reimplemented from FCam::Shot.

Definition at line 38 of file Shot.cpp.