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

#include <Image.h>

Collaboration diagram for tcImage:

Public Member Functions

 tcImage (void *apAddr, int anNumBytes, int32 anWidth, int32 anHeight, tcRAMStreamer::tePackingMode aePacking=tcRAMStreamer::eeMono16, bool abHasHeader=false)
 
 tcImage (void *apAddr, tcRAMStreamer::tePackingMode aePacking)
 
virtual ~tcImage ()
 
uint16_t * data ()
 
const uint16_t * data () const
 
uint8_t * data8 ()
 
const uint8_t * data8 () const
 
int32_t getWidth () const
 
int32_t getHeight () const
 
tsFrameHeader getFrameHeader () const
 

Constructor & Destructor Documentation

◆ tcImage() [1/2]

tcImage::tcImage ( void *  apAddr,
int  anNumBytes,
int32  anWidth,
int32  anHeight,
tcRAMStreamer::tePackingMode  aePacking = tcRAMStreamer::eeMono16,
bool  abHasHeader = false 
)
inline

Create an image object. Copies the data from the location given to an internal structure which can be modified later.

Parameters
[in]apAddrpointer to raw data buffer in memory to extract
[in]anNumBytes- size of the buffer to allocate (if 0, no buffer is allocated)
[in]anWidth- width of the frame in pixels
[in]anHeight- height of the frame in pixels
[in]aePacking- how the data is stored in RAM (default eeMono16)
[in]abHasHeader- when true, the 32 byte header is included in the buffer
Note
eeMono12packed data will be unpacked into an allocated buffer that is 16 bits per pixel for ease of access.

◆ tcImage() [2/2]

tcImage::tcImage ( void *  apAddr,
tcRAMStreamer::tePackingMode  aePacking 
)
inline

Create an image object. Copies the data from the location given to an internal structure which can be modified later.

Note
this method requires a valid image header

◆ ~tcImage()

virtual tcImage::~tcImage ( )
inlinevirtual

Member Function Documentation

◆ data() [1/2]

uint16_t* tcImage::data ( )
inline

Returns a pointer to the data of the image. The data can be manipulated in place.

Returns
a pointer to the data.

◆ data() [2/2]

const uint16_t* tcImage::data ( ) const
inline

◆ data8() [1/2]

uint8_t* tcImage::data8 ( )
inline

◆ data8() [2/2]

const uint8_t* tcImage::data8 ( ) const
inline

◆ getFrameHeader()

tsFrameHeader tcImage::getFrameHeader ( ) const
inline

Get the frame header of the image. If no header information is available, this will be all zeros.

◆ getHeight()

int32_t tcImage::getHeight ( ) const
inline

Get the height of the image

◆ getWidth()

int32_t tcImage::getWidth ( ) const
inline

Get the width of the image.


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