tcColumnAdjuster Class Reference

The tcColumnAdjuster class interfaces to the FPGA column_cal core. More...

#include <ColumnAdjuster.h>

Collaboration diagram for tcColumnAdjuster:

Public Member Functions
	tcColumnAdjuster (uint32 anAddress, uint32 anBiasAddr, uint32 anGainAddr, uint32 anDepth, uint32 anOffset=0)
	tcColumnAdjuster::tcColumnAdjuster More...
virtual	~tcColumnAdjuster ()
	tcColumnAdjuster::~tcColumnAdjuster More...
bool	initialized ()
	tcColumnAdjuster::initialized More...
int32	reset (bool abOn)
	tcColumnAdjuster::reset More...
int32	setBias (const char *apFilename)
	tcColumnAdjuster::setBias More...
int32	setBias (int16 *apBias, int32 anLength)
	tcColumnAdjuster::setBias More...
int32	setMultiplier (const char *apFilename)
	tcColumnAdjuster::setMultiplier More...
int32	setMultiplier (uint16 *apMultiplier, int32 anLength)
	tcColumnAdjuster::setMultiplier More...

Detailed Description

The tcColumnAdjuster class interfaces to the FPGA column_cal core.

Constructor & Destructor Documentation

tcColumnAdjuster()

tcColumnAdjuster::tcColumnAdjuster	(	uint32	anAddress,
		uint32	anBiasAddr,
		uint32	anGainAddr,
		uint32	anDepth,
		uint32	anOffset = 0
	)

tcColumnAdjuster::tcColumnAdjuster

Create a new column adjuster component.

Parameters

anAddress
anBiasAddr
anGainAddr
anDepth
anOffset

~tcColumnAdjuster()

tcColumnAdjuster::~tcColumnAdjuster ( )

virtual

tcColumnAdjuster::~tcColumnAdjuster

Member Function Documentation

initialized()

bool tcColumnAdjuster::initialized

(

)

tcColumnAdjuster::initialized

Returns true if the core is ready to use. false otherwise.

Returns

true if the core is ready to use

reset()

int32 tcColumnAdjuster::reset

(

bool

abOn

)

tcColumnAdjuster::reset

Reset the component or take it out of reset.

Parameters

abOn	- the state of the reset bit; true to turn it on, false to turn it off

Returns

zero for success; non-zero for error.

Parameters

abOn

Returns

setBias() [1/2]

int32 tcColumnAdjuster::setBias

(

const char *

apFilename

)

tcColumnAdjuster::setBias

Convenience function to open a file where each line is the 16 bit data to be applied, read it in and call setBias() with the data.

Parameters

apFilename

- the name of the input file to read.

Returns

zero if successful; non-zero if error.

Parameters

apFilename

Returns

setBias() [2/2]

int32 tcColumnAdjuster::setBias	(	int16 *	apBias,
		int32	anLength
	)

tcColumnAdjuster::setBias

Sets the bias portion of the column adjuster.

Out = In * apMultiplier[i]/(2^15) + apBias[i]

Parameters

apBias	- the array of biases to apply
anLength	- the length of the array

Returns

zero if successful; non-zero for error.

Parameters

apBias
anLength

Returns

setMultiplier() [1/2]

int32 tcColumnAdjuster::setMultiplier

(

const char *

apFilename

)

tcColumnAdjuster::setMultiplier

Convenience function to open a file where each line is the 16 bit data to be applied, read it in and call setMultiplier() with the data.

Parameters

apFilename

- the name of the input file to read.

Returns

zero if successful; non-zero if error.

Parameters

apFilename

Returns

setMultiplier() [2/2]

int32 tcColumnAdjuster::setMultiplier	(	uint16 *	apMultiplier,
		int32	anLength
	)

tcColumnAdjuster::setMultiplier

Sets the multiplier portion of the column adjuster.

Out = In * apMultiplier[i]/(2^15) + apBias[i]

Parameters

apMultiplier	- the array of multipliers to apply
anLength	- the length of the array

Returns

zero if successful; non-zero for error.

Parameters

apMultiplier
anLength

Returns

---

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

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