SocCamera::tcPixelBinner Class Reference

#include <PixelBinner.h>

Collaboration diagram for SocCamera::tcPixelBinner:

Public Member Functions
	tcPixelBinner (uint32 anBaseAddress)
	~tcPixelBinner ()
bool	initialized ()
int32	reset (bool abOn)
int32	setBinningFactor (uint32 anBinFactor, uint32 anShiftFactor)
int32	setBinningFactor (uint32 anBinFactor)
int32	setShiftFactor (uint32 anShiftFactor)
uint32	getBinningFactor ()
uint32	getShiftFactor ()

Constructor & Destructor Documentation

tcPixelBinner()

SocCamera::tcPixelBinner::tcPixelBinner

(

uint32

anBaseAddress

)

Construct a new PixelBinner core (both horizontal and vertical)

Parameters

anBaseAddress

- the memory mapped location of the binner.

~tcPixelBinner()

SocCamera::tcPixelBinner::~tcPixelBinner

(

)

Member Function Documentation

getBinningFactor()

uint32 SocCamera::tcPixelBinner::getBinningFactor

(

)

Returns the currently set binning factor.

Returns

the current binning factor.

getShiftFactor()

uint32 SocCamera::tcPixelBinner::getShiftFactor

(

)

Returns the currently set shift factor.

Returns

the current shift factor.

initialized()

bool SocCamera::tcPixelBinner::initialized

(

)

Ensures the component is initialized and can talk to it.

Returns

0 for success; non-zero for error

reset()

int32 SocCamera::tcPixelBinner::reset

(

bool

abOn

)

Sets the reset state of the core.

Parameters

abOn	- true to place in reset; false to take out of reset

Returns

0 for success; non-zero for error

setBinningFactor() [1/2]

int32 SocCamera::tcPixelBinner::setBinningFactor

(

uint32

anBinFactor

)

Set just the binning factor.

Parameters

anBinFactor

- the number of pixels to bin.

Returns

0 for success; non-zero for error

setBinningFactor() [2/2]

int32 SocCamera::tcPixelBinner::setBinningFactor	(	uint32	anBinFactor,
		uint32	anShiftFactor
	)

Set the binning factor.

Parameters

anBinFactor	- the number of pixels to bin
anShiftFactor	- the amount to right shift the resultant binning by.

Returns

0 for success; non-zero for error.

setShiftFactor()

int32 SocCamera::tcPixelBinner::setShiftFactor

(

uint32

anShiftFactor

)

Sets just the shift factor.

Parameters

anShiftFactor

- the amount to right shift the binned result bu.

Returns

0 for success; non-zero for error.

---

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

• /tmp/mitycam_sdk/ARM/camera_software/src/Utility/PixelBinner.h
• /tmp/mitycam_sdk/ARM/camera_software/src/Utility/PixelBinner.cpp