tcBlackLevelGainCorrect Class Reference

#include <BlackLevelGainCorrect.h>

Collaboration diagram for tcBlackLevelGainCorrect:

Public Types
enum	tePosition { EvenRowEvenCol = 0, EvenRowOddCol = 1, OddRowEvenCol = 2, OddRowOddCol = 3 }

Public Member Functions
	tcBlackLevelGainCorrect (int anBaseAddress)
	~tcBlackLevelGainCorrect ()
bool	initialized ()
void	reset (bool abReset)
void	setBlackOffset (int16_t offset)
int16_t	getBlackOffset (void)
void	setGain (tePosition pos, float gain)
float	getGain (tePosition pos)

Protected Attributes
bool	mbInitialized
	true when the core has been initialized More...
tcFPGARegister< uint32_t >	mhBLGC
	memory mapped FPGA access class More...

Detailed Description

The tcBlackLevelGainCorrect manages the blc_gain FPGA core from Critical Link.

Member Enumeration Documentation

tePosition

enum tcBlackLevelGainCorrect::tePosition

Enumerator
EvenRowEvenCol
EvenRowOddCol
OddRowEvenCol
OddRowOddCol

Constructor & Destructor Documentation

tcBlackLevelGainCorrect()

tcBlackLevelGainCorrect::tcBlackLevelGainCorrect

(

int

anBaseAddress

)

Class constructor.

Parameters

anBaseAddress

Physical Address of the core, typically in the 0xFF20xxxx range

~tcBlackLevelGainCorrect()

tcBlackLevelGainCorrect::~tcBlackLevelGainCorrect

(

)

Class Destructor

Member Function Documentation

getBlackOffset()

int16_t tcBlackLevelGainCorrect::getBlackOffset

(

void

)

getGain()

float tcBlackLevelGainCorrect::getGain

(

tePosition

pos

)

Get the programmed gain of the output channel

Parameters

pos	the position of the gain coefficient

Returns

the gain.

initialized()

bool tcBlackLevelGainCorrect::initialized

(

)

Returns

true when the core has been propely initialized

reset()

void tcBlackLevelGainCorrect::reset

(

bool

abReset

)

Request the core reset. When reset, the integrated background estimate is reset and will be re-initialized to the black level computed from the next completed frame.

Parameters

abReset

true to hold reset state, false to enable computation

setBlackOffset()

void tcBlackLevelGainCorrect::setBlackOffset

(

int16_t

offset

)

Set the black level offset

Parameters

offset

the signed level offset to add

setGain()

void tcBlackLevelGainCorrect::setGain	(	tePosition	pos,
		float	gain
	)

Set the gain of the output channel

Parameters

pos	the position of the gain coefficient
gain	the desired gain. Must be in range of 0.0 to 2^12-1 (4095)

Member Data Documentation

mbInitialized

bool tcBlackLevelGainCorrect::mbInitialized

protected

true when the core has been initialized

mhBLGC

tcFPGARegister<uint32_t> tcBlackLevelGainCorrect::mhBLGC

protected

memory mapped FPGA access class

---

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

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