svlSampleImage Class Reference

#include <svlSampleImage.h>

Inheritance diagram for svlSampleImage:

Public Member Functions
	svlSampleImage ()
	svlSampleImage (const svlSampleImage &other)
virtual	~svlSampleImage ()
virtual svlPixelType	GetPixelType () const
virtual int	GetAlphaChannel () const
virtual svlSample *	GetNewInstance () const =0
virtual svlStreamType	GetType () const =0
virtual int	SetSize (const svlSample *sample)=0
virtual int	SetSize (const svlSample &sample)=0
virtual int	CopyOf (const svlSample *sample)=0
virtual int	CopyOf (const svlSample &sample)=0
virtual bool	IsInitialized () const =0
virtual unsigned char *	GetUCharPointer ()=0
virtual const unsigned char *	GetUCharPointer () const =0
virtual unsigned int	GetDataSize () const =0
virtual void	SerializeRaw (std::ostream &outputStream) const =0
virtual void	DeSerializeRaw (std::istream &inputStream)=0
virtual IplImage *	IplImageRef (const unsigned int videochannel=0) const =0
virtual cv::Mat	CvMatRef (const unsigned int videochannel=0) const =0
virtual unsigned char *	GetUCharPointer (const unsigned int videochannel)=0
virtual const unsigned char *	GetUCharPointer (const unsigned int videochannel) const =0
virtual unsigned char *	GetUCharPointer (const unsigned int videochannel, const unsigned int x, const unsigned int y)=0
virtual const unsigned char *	GetUCharPointer (const unsigned int videochannel, const unsigned int x, const unsigned int y) const =0
virtual void	SetSize (const unsigned int width, const unsigned int height)=0
virtual void	SetSize (const unsigned int videochannel, const unsigned int width, const unsigned int height)=0
virtual int	SetSize (const IplImage *ipl_image, const unsigned int videochannel=0)=0
virtual int	SetSize (const cv::Mat &cv_mat, const unsigned int videochannel=0)=0
virtual int	CopyOf (const IplImage *ipl_image, const unsigned int videochannel=0)=0
virtual int	CopyOf (const cv::Mat &cv_mat, const unsigned int videochannel=0)=0
virtual unsigned int	GetVideoChannels () const =0
virtual unsigned int	GetDataChannels () const =0
virtual unsigned int	GetBPP () const =0
virtual unsigned int	GetWidth (const unsigned int videochannel=0) const =0
virtual unsigned int	GetHeight (const unsigned int videochannel=0) const =0
virtual unsigned int	GetRowStride (const unsigned int videochannel=0) const =0
virtual unsigned int	GetDataSize (const unsigned int videochannel) const =0
virtual svlSampleImage *	GetSubImage (const unsigned int top, const unsigned int height, const unsigned int videochannel=0)=0
virtual svlSampleImage *	GetSubImage (svlProcInfo *procInfo, const unsigned int videochannel=0)=0
int	ImportData (unsigned char *input, const unsigned int size, const int param=0, const unsigned int videoch=SVL_LEFT)
int	ImportData (unsigned short *input, const unsigned int size, const int param=0, const unsigned int videoch=SVL_LEFT)
int	ImportData (unsigned int *input, const unsigned int size, const int param=0, const unsigned int videoch=SVL_LEFT)
int	ImportData (float *input, const unsigned int size, const int param=0, const unsigned int videoch=SVL_LEFT)
int	ImportImage (const svlSampleImage *image, const int param=0)
int	ImportImage (const svlSampleImage &image, const int param=0)
int	ImportImage (const svlSampleImage *image, const unsigned int src_channel, const unsigned int dest_channel, const int param=0)
int	ImportImage (const svlSampleImage &image, const unsigned int src_channel, const unsigned int dest_channel, const int param=0)
int	ImportMatrix (const svlSampleMatrix *matrix, const int param=0, const unsigned int videoch=SVL_LEFT)
int	ImportSample (const svlSample *sample)
int	ImportSample (const svlSample *sample, const unsigned int videoch)
Public Member Functions inherited from svlSample
	svlSample ()
	svlSample (const svlSample &other)
svlSample &	operator= (const svlSample &other)
virtual	~svlSample ()
void	SetTimestamp (double ts)
double	GetTimestamp () const
void	SetEncoder (const std::string &codec, const int parameter)
void	GetEncoder (std::string &codec, int &parameter) const
Public Member Functions inherited from mtsGenericObject
	mtsGenericObject (void)
	mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
	mtsGenericObject (const mtsGenericObject &other)
virtual	~mtsGenericObject (void)
bool	SetTimestampIfAutomatic (double timestamp)
virtual void	ToStream (std::ostream &outputStream) const
virtual void	ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
size_t	ScalarNumber (void) const
bool	ScalarNumberIsFixed (void) const
double	Scalar (const size_t index) const throw (std::out_of_range)
std::string	ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)
Public Member Functions inherited from cmnGenericObject
virtual	~cmnGenericObject (void)
virtual const cmnClassServicesBase *	Services (void) const =0
bool	ReconstructFrom (const cmnGenericObject &other)
std::string	ToString (void) const
virtual cmnLogger::StreamBufType *	GetLogMultiplexer (void) const
virtual double	Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Additional Inherited Members
Static Public Member Functions inherited from svlSample
static svlSample *	GetNewFromType (svlStreamType type)

Constructor & Destructor Documentation

svlSampleImage::svlSampleImage

(

)

svlSampleImage::svlSampleImage

(

const svlSampleImage &

other

)

virtual svlSampleImage::~svlSampleImage ( )

virtual

Member Function Documentation

virtual int svlSampleImage::CopyOf ( const svlSample *  sample )

pure virtual

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual int svlSampleImage::CopyOf ( const svlSample &  sample )

pure virtual

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual int svlSampleImage::CopyOf ( const IplImage *  ipl_image, const unsigned int  videochannel = 0  )

pure virtual

Implemented in svlSampleCUDAImage.

virtual int svlSampleImage::CopyOf ( const cv::Mat &  cv_mat, const unsigned int  videochannel = 0  )

pure virtual

virtual cv::Mat svlSampleImage::CvMatRef ( const unsigned int  videochannel = 0 ) const

pure virtual

virtual void svlSampleImage::DeSerializeRaw ( std::istream &  inputStream )

pure virtual

Binary deserialization

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, and svlSampleCUDAImage.

virtual int svlSampleImage::GetAlphaChannel ( ) const

virtual

virtual unsigned int svlSampleImage::GetBPP ( ) const

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual unsigned int svlSampleImage::GetDataChannels ( ) const

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual unsigned int svlSampleImage::GetDataSize ( ) const

pure virtual

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual unsigned int svlSampleImage::GetDataSize ( const unsigned int  videochannel ) const

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual unsigned int svlSampleImage::GetHeight ( const unsigned int  videochannel = 0 ) const

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual svlSample* svlSampleImage::GetNewInstance ( ) const

pure virtual

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual svlPixelType svlSampleImage::GetPixelType ( ) const

virtual

virtual unsigned int svlSampleImage::GetRowStride ( const unsigned int  videochannel = 0 ) const

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual svlSampleImage* svlSampleImage::GetSubImage ( const unsigned int  top, const unsigned int  height, const unsigned int  videochannel = 0  )

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, and svlSampleCUDAImage.

virtual svlSampleImage* svlSampleImage::GetSubImage ( svlProcInfo *  procInfo, const unsigned int  videochannel = 0  )

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, and svlSampleCUDAImage.

virtual svlStreamType svlSampleImage::GetType ( ) const

pure virtual

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual unsigned char* svlSampleImage::GetUCharPointer ( )

pure virtual

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, and svlSampleCUDAImage.

virtual const unsigned char* svlSampleImage::GetUCharPointer ( ) const

pure virtual

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, and svlSampleCUDAImage.

virtual unsigned char* svlSampleImage::GetUCharPointer ( const unsigned int  videochannel )

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, and svlSampleCUDAImage.

virtual const unsigned char* svlSampleImage::GetUCharPointer ( const unsigned int  videochannel ) const

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, and svlSampleCUDAImage.

virtual unsigned char* svlSampleImage::GetUCharPointer ( const unsigned int  videochannel, const unsigned int  x, const unsigned int  y  )

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, and svlSampleCUDAImage.

virtual const unsigned char* svlSampleImage::GetUCharPointer ( const unsigned int  videochannel, const unsigned int  x, const unsigned int  y  ) const

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, and svlSampleCUDAImage.

virtual unsigned int svlSampleImage::GetVideoChannels ( ) const

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual unsigned int svlSampleImage::GetWidth ( const unsigned int  videochannel = 0 ) const

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

int svlSampleImage::ImportData	(	unsigned char *	input,
		const unsigned int	size,
		const int	param = 0,
		const unsigned int	videoch = SVL_LEFT
	)

int svlSampleImage::ImportData	(	unsigned short *	input,
		const unsigned int	size,
		const int	param = 0,
		const unsigned int	videoch = SVL_LEFT
	)

int svlSampleImage::ImportData	(	unsigned int *	input,
		const unsigned int	size,
		const int	param = 0,
		const unsigned int	videoch = SVL_LEFT
	)

int svlSampleImage::ImportData	(	float *	input,
		const unsigned int	size,
		const int	param = 0,
		const unsigned int	videoch = SVL_LEFT
	)

int svlSampleImage::ImportImage	(	const svlSampleImage *	image,
		const int	param = 0
	)

int svlSampleImage::ImportImage	(	const svlSampleImage &	image,
		const int	param = 0
	)

int svlSampleImage::ImportImage	(	const svlSampleImage *	image,
		const unsigned int	src_channel,
		const unsigned int	dest_channel,
		const int	param = 0
	)

int svlSampleImage::ImportImage	(	const svlSampleImage &	image,
		const unsigned int	src_channel,
		const unsigned int	dest_channel,
		const int	param = 0
	)

int svlSampleImage::ImportMatrix	(	const svlSampleMatrix *	matrix,
		const int	param = 0,
		const unsigned int	videoch = SVL_LEFT
	)

int svlSampleImage::ImportSample

(

const svlSample *

sample

)

int svlSampleImage::ImportSample	(	const svlSample *	sample,
		const unsigned int	videoch
	)

virtual IplImage* svlSampleImage::IplImageRef ( const unsigned int  videochannel = 0 ) const

pure virtual

Implemented in svlSampleCUDAImage.

virtual bool svlSampleImage::IsInitialized ( ) const

pure virtual

Reimplemented from svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual void svlSampleImage::SerializeRaw ( std::ostream &  outputStream ) const

pure virtual

Binary serialization

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, and svlSampleCUDAImage.

virtual int svlSampleImage::SetSize ( const svlSample *  sample )

pure virtual

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual int svlSampleImage::SetSize ( const svlSample &  sample )

pure virtual

Implements svlSample.

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual void svlSampleImage::SetSize ( const unsigned int  width, const unsigned int  height  )

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual void svlSampleImage::SetSize ( const unsigned int  videochannel, const unsigned int  width, const unsigned int  height  )

pure virtual

Implemented in svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleImageCustom< float, 3, 1 >, svlSampleImageCustom< unsigned char, 3, 1 >, svlSampleCUDAImageCustom< _ValueType, _DataChannels, _VideoChannels >, and svlSampleCUDAImage.

virtual int svlSampleImage::SetSize ( const IplImage *  ipl_image, const unsigned int  videochannel = 0  )

pure virtual

Implemented in svlSampleCUDAImage.

virtual int svlSampleImage::SetSize ( const cv::Mat &  cv_mat, const unsigned int  videochannel = 0  )

pure virtual

---

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

• /home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstStereoVision/svlSampleImage.h