Critical Link MityCam SoC Firmware  1.0
Critical Link MityCam SoC Firmware
tcBadPixelReplacement Class Reference

#include <BadPixelReplacement.h>

Collaboration diagram for tcBadPixelReplacement:

Public Member Functions

 tcBadPixelReplacement (uint32_t anAddress, uint32_t anReadMasterAddr, uint32_t anReadMasterDescriptors, uint32_t anMapAddress, SocCamera::ROI asMaxROI)
 
virtual ~tcBadPixelReplacement ()
 
bool initialize ()
 
void reset (bool abReset)
 
bool readReset ()
 
void setData (std::string acFile)
 
void setRoi (SocCamera::ROI acROI)
 
void setMapState (bool abOn)
 setMapState Enable debug black and white mode Allows for changing all pixel values to be all 0’s or all 1’s depending on whether pixel is marked as bad or not. Used for debug to ensure Bad Pixel map is set appropriately. More...
 
bool mapState ()
 mapState Is map state enabled More...
 
bool onState ()
 onState Is core running More...
 
void setColor (bool abColor)
 setColor Enable bayer mode Active high enable for handling data from sensor with Bayer filter. More...
 
bool readColorMode ()
 
std::string defaultData ()
 defaultData Get data filename More...
 
void setExtension (uint8_t anExtension)
 setExtension Set Flush Cycles Allows for adjusting number of cycles required to data from Pixel Processing Window between frames. Should be left to default value. More...
 
uint8_t readExtension ()
 
bool readHeaderDecodeErr ()
 readHeaderDecodeErr Returns logic high if error occurred in decoding incoming frame packet. Write ‘1’ followed by ‘0’ to reset. More...
 
bool readConsecutiveFrameDelayErr ()
 readConsecutiveFrameDelayErr Returns logic high if not enough time was present between two consecutive frames. This time should be three rows worth of data at a minimum. Write ‘1’ followed by ‘0’ to reset. More...
 
bool readBadPixelUnderflowErr ()
 
uint8_t readRowFifoAlmostFull ()
 readRowFifoAlmostFull Returns logic high if FIFO used to buffer row data almost fills. Indicates g_max_row_num_pixels may have been set incorrectly. Write ‘1’ followed by ‘0’ to reset. Each bit corresponds to a different Row FIFO. More...
 
uint8_t readRowFifoFull ()
 readRowFifoFull Returns logic high if FIFO used to buffer row data fills. Indicates g_max_row_num_pixels may have been set incorrectly. Write ‘1’ followed by ‘0’ to reset. Each bit corresponds to a different Row FIFO. More...
 
void dumpRegisters ()
 

Constructor & Destructor Documentation

◆ tcBadPixelReplacement()

tcBadPixelReplacement::tcBadPixelReplacement ( uint32_t  anAddress,
uint32_t  anReadMasterAddr,
uint32_t  anReadMasterDescriptors,
uint32_t  anMapAddress,
SocCamera::ROI  asMaxROI 
)
Parameters
anAddress- core location
anReadMasterAddr- SGDMA Control and Status register address
anReadMasterDescriptors- SGDMA Descriptors address
anMapAddress- location of the bad pixel map in RAM
asMaxROI- Set bad pix map size

◆ ~tcBadPixelReplacement()

tcBadPixelReplacement::~tcBadPixelReplacement ( )
virtual

Member Function Documentation

◆ defaultData()

std::string tcBadPixelReplacement::defaultData ( )

defaultData Get data filename

Returns
filename for bad pixelmap file

◆ dumpRegisters()

void tcBadPixelReplacement::dumpRegisters ( )

Print fpga core registers to std::out for debug purposes

◆ initialize()

bool tcBadPixelReplacement::initialize ( )

Check if the sensor is core ready/initialized

◆ mapState()

bool tcBadPixelReplacement::mapState ( )

mapState Is map state enabled

Returns

◆ onState()

bool tcBadPixelReplacement::onState ( )

onState Is core running

Returns

◆ readBadPixelUnderflowErr()

bool tcBadPixelReplacement::readBadPixelUnderflowErr ( )
   @brief readBadPixelUnderflowErr Returns logic high if data from Bad Pixel Map could not be streamed into core quickly enough from

SDRAM. Write ‘1’ followed by ‘0’ to reset.

Returns

◆ readColorMode()

bool tcBadPixelReplacement::readColorMode ( )

◆ readConsecutiveFrameDelayErr()

bool tcBadPixelReplacement::readConsecutiveFrameDelayErr ( )

readConsecutiveFrameDelayErr Returns logic high if not enough time was present between two consecutive frames. This time should be three rows worth of data at a minimum. Write ‘1’ followed by ‘0’ to reset.

Returns

◆ readExtension()

uint8_t tcBadPixelReplacement::readExtension ( )

◆ readHeaderDecodeErr()

bool tcBadPixelReplacement::readHeaderDecodeErr ( )

readHeaderDecodeErr Returns logic high if error occurred in decoding incoming frame packet. Write ‘1’ followed by ‘0’ to reset.

Returns

◆ readReset()

bool tcBadPixelReplacement::readReset ( )

◆ readRowFifoAlmostFull()

uint8_t tcBadPixelReplacement::readRowFifoAlmostFull ( )

readRowFifoAlmostFull Returns logic high if FIFO used to buffer row data almost fills. Indicates g_max_row_num_pixels may have been set incorrectly. Write ‘1’ followed by ‘0’ to reset. Each bit corresponds to a different Row FIFO.

Returns

◆ readRowFifoFull()

uint8_t tcBadPixelReplacement::readRowFifoFull ( )

readRowFifoFull Returns logic high if FIFO used to buffer row data fills. Indicates g_max_row_num_pixels may have been set incorrectly. Write ‘1’ followed by ‘0’ to reset. Each bit corresponds to a different Row FIFO.

Returns

◆ reset()

void tcBadPixelReplacement::reset ( bool  abReset)

Resets and takes out of reset this core.

◆ setColor()

void tcBadPixelReplacement::setColor ( bool  abColor)

setColor Enable bayer mode Active high enable for handling data from sensor with Bayer filter.

Parameters
abColor

◆ setData()

void tcBadPixelReplacement::setData ( std::string  acFile)

Configuration file for the bad pixel map.

This loads the file into RAM.

File format is space delimited x and y per line. A y of -1 means the entire column bad.

◆ setExtension()

void tcBadPixelReplacement::setExtension ( uint8_t  anExtension)

setExtension Set Flush Cycles Allows for adjusting number of cycles required to data from Pixel Processing Window between frames. Should be left to default value.

Parameters
anExtension

◆ setMapState()

void tcBadPixelReplacement::setMapState ( bool  abOn)

setMapState Enable debug black and white mode Allows for changing all pixel values to be all 0’s or all 1’s depending on whether pixel is marked as bad or not. Used for debug to ensure Bad Pixel map is set appropriately.

Parameters
abOn

◆ setRoi()

void tcBadPixelReplacement::setRoi ( SocCamera::ROI  acROI)

Configure the ROI (reduced rows taken into account when programming from the file).


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