The interface file for Image. More...

#include <IImage.h>

Inheritance diagram for IImage:

Public Member Functions
virtual	~IImage ()

virtual ColorProcessingAlgorithm	GetColorProcessing () const =0

virtual void	ResetImage (size_t width, size_t height, size_t offsetX, size_t offsetY, PixelFormatEnums pixelFormat)=0

virtual void	ResetImage (size_t width, size_t height, size_t offsetX, size_t offsetY, PixelFormatEnums pixelFormat, void *pData)=0

virtual void	ResetImage (size_t width, size_t height, size_t offsetX, size_t offsetY, PixelFormatEnums pixelFormat, void *pData, TLPayloadType dataPayloadType, size_t dataSize)=0

virtual void	Release ()=0

virtual uint64_t	GetID () const =0

virtual uint64_t	GetStreamIndex () const =0

virtual void *	GetData () const =0

virtual void *	GetPrivateData () const =0

virtual float	GetDataAbsoluteMax () const =0

virtual float	GetDataAbsoluteMin () const =0

virtual size_t	GetBufferSize () const =0

virtual void	DeepCopy (const ImagePtr pSrcImage)=0

virtual size_t	GetWidth () const =0

virtual size_t	GetHeight () const =0

virtual size_t	GetStride () const =0

virtual size_t	GetBitsPerPixel () const =0

virtual size_t	GetNumChannels () const =0

virtual size_t	GetXOffset () const =0

virtual size_t	GetYOffset () const =0

virtual size_t	GetXPadding () const =0

virtual size_t	GetYPadding () const =0

virtual uint64_t	GetFrameID () const =0

virtual size_t	GetPayloadType () const =0

virtual TLPayloadType	GetTLPayloadType () const =0

virtual uint64_t	GetTLPixelFormat () const =0

virtual TLPixelFormatNamespace	GetTLPixelFormatNamespace () const =0

virtual GenICam::gcstring	GetPixelFormatName () const =0

virtual PixelFormatEnums	GetPixelFormat () const =0

virtual PixelFormatIntType	GetPixelFormatIntType () const =0

virtual bool	IsIncomplete () const =0

virtual size_t	GetValidPayloadSize () const =0

virtual uint64_t	GetChunkLayoutId () const =0

virtual uint64_t	GetTimeStamp () const =0

virtual void	Save (const char *pFilename, ImageFileFormat format=SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT) const =0

virtual void	Save (const char *pFilename, PNGOption &pOption) const =0

virtual void	Save (const char *pFilename, PPMOption &pOption) const =0

virtual void	Save (const char *pFilename, PGMOption &pOption) const =0

virtual void	Save (const char *pFilename, TIFFOption &pOption) const =0

virtual void	Save (const char *pFilename, JPEGOption &pOption) const =0

virtual void	Save (const char *pFilename, JPG2Option &pOption) const =0

virtual void	Save (const char *pFilename, BMPOption &pOption) const =0

virtual void	Save (const char *pFilename, SIOption &option) const =0

virtual const ChunkData &	GetChunkData () const =0

virtual void	CalculateStatistics (ImageStatistics &pStatistics)=0

virtual bool	HasCRC () const =0

virtual bool	HasChunkData () const =0

virtual bool	CheckCRC () const =0

virtual size_t	GetImageSize () const =0

virtual bool	IsInUse ()=0

virtual ImageStatus	GetImageStatus () const =0

virtual bool	IsCompressed () const =0

Protected Member Functions
	IImage ()

virtual ImageData *	GetImageData () const =0

Friends
class	Stream

class	ImageImpl

class	ImageListImpl

class	SpinnakerGPUImpl

Detailed Description

The interface file for Image.

Constructor & Destructor Documentation

◆ ~IImage()

virtual ~IImage ( )

inlinevirtual

◆ IImage()

IImage ( )

inlineprotected

Member Function Documentation

◆ CalculateStatistics()

virtual void CalculateStatistics ( ImageStatistics & pStatistics )

pure virtual

Implemented in Image.

◆ CheckCRC()

virtual bool CheckCRC ( ) const

pure virtual

Implemented in Image.

◆ DeepCopy()

virtual void DeepCopy ( const ImagePtr pSrcImage )

pure virtual

Implemented in Image.

◆ GetBitsPerPixel()

virtual size_t GetBitsPerPixel ( ) const

pure virtual

Implemented in Image.

◆ GetBufferSize()

virtual size_t GetBufferSize ( ) const

pure virtual

Implemented in Image.

◆ GetChunkData()

virtual const ChunkData & GetChunkData ( ) const

pure virtual

Implemented in Image.

◆ GetChunkLayoutId()

virtual uint64_t GetChunkLayoutId ( ) const

pure virtual

Implemented in Image.

◆ GetColorProcessing()

virtual ColorProcessingAlgorithm GetColorProcessing ( ) const

pure virtual

Implemented in Image.

◆ GetData()

virtual void * GetData ( ) const

pure virtual

Implemented in Image.

◆ GetDataAbsoluteMax()

virtual float GetDataAbsoluteMax ( ) const

pure virtual

Implemented in Image.

◆ GetDataAbsoluteMin()

virtual float GetDataAbsoluteMin ( ) const

pure virtual

Implemented in Image.

◆ GetFrameID()

virtual uint64_t GetFrameID ( ) const

pure virtual

Implemented in Image.

◆ GetHeight()

virtual size_t GetHeight ( ) const

pure virtual

Implemented in Image.

◆ GetID()

virtual uint64_t GetID ( ) const

pure virtual

Implemented in Image.

◆ GetImageData()

virtual ImageData * GetImageData ( ) const

protectedpure virtual

Implemented in Image.

◆ GetImageSize()

virtual size_t GetImageSize ( ) const

pure virtual

Implemented in Image.

◆ GetImageStatus()

virtual ImageStatus GetImageStatus ( ) const

pure virtual

Implemented in Image.

◆ GetNumChannels()

virtual size_t GetNumChannels ( ) const

pure virtual

Implemented in Image.

◆ GetPayloadType()

virtual size_t GetPayloadType ( ) const

pure virtual

Implemented in Image.

◆ GetPixelFormat()

virtual PixelFormatEnums GetPixelFormat ( ) const

pure virtual

Implemented in Image.

◆ GetPixelFormatIntType()

virtual PixelFormatIntType GetPixelFormatIntType ( ) const

pure virtual

Implemented in Image.

◆ GetPixelFormatName()

virtual GenICam::gcstring GetPixelFormatName ( ) const

pure virtual

Implemented in Image.

◆ GetPrivateData()

virtual void * GetPrivateData ( ) const

pure virtual

Implemented in Image.

◆ GetStreamIndex()

virtual uint64_t GetStreamIndex ( ) const

pure virtual

Implemented in Image.

◆ GetStride()

virtual size_t GetStride ( ) const

pure virtual

Implemented in Image.

◆ GetTimeStamp()

virtual uint64_t GetTimeStamp ( ) const

pure virtual

Implemented in Image.

◆ GetTLPayloadType()

virtual TLPayloadType GetTLPayloadType ( ) const

pure virtual

Implemented in Image.

◆ GetTLPixelFormat()

virtual uint64_t GetTLPixelFormat ( ) const

pure virtual

Implemented in Image.

◆ GetTLPixelFormatNamespace()

virtual TLPixelFormatNamespace GetTLPixelFormatNamespace ( ) const

pure virtual

Implemented in Image.

◆ GetValidPayloadSize()

virtual size_t GetValidPayloadSize ( ) const

pure virtual

Implemented in Image.

◆ GetWidth()

virtual size_t GetWidth ( ) const

pure virtual

Implemented in Image.

◆ GetXOffset()

virtual size_t GetXOffset ( ) const

pure virtual

Implemented in Image.

◆ GetXPadding()

virtual size_t GetXPadding ( ) const

pure virtual

Implemented in Image.

◆ GetYOffset()

virtual size_t GetYOffset ( ) const

pure virtual

Implemented in Image.

◆ GetYPadding()

virtual size_t GetYPadding ( ) const

pure virtual

Implemented in Image.

◆ HasChunkData()

virtual bool HasChunkData ( ) const

pure virtual

Implemented in Image.

◆ HasCRC()

virtual bool HasCRC ( ) const

pure virtual

Implemented in Image.

◆ IsCompressed()

virtual bool IsCompressed ( ) const

pure virtual

Implemented in Image.

◆ IsIncomplete()

virtual bool IsIncomplete ( ) const

pure virtual

Implemented in Image.

◆ IsInUse()

virtual bool IsInUse ( )

pure virtual

Implemented in Image.

◆ Release()

virtual void Release ( )

pure virtual

Implemented in Image.

◆ ResetImage() [1/3]

virtual void ResetImage	(	size_t	width,
		size_t	height,
		size_t	offsetX,
		size_t	offsetY,
		PixelFormatEnums	pixelFormat
	)

pure virtual

Implemented in Image.

◆ ResetImage() [2/3]

virtual void ResetImage	(	size_t	width,
		size_t	height,
		size_t	offsetX,
		size_t	offsetY,
		PixelFormatEnums	pixelFormat,
		void *	pData
	)

pure virtual

Implemented in Image.

◆ ResetImage() [3/3]

virtual void ResetImage	(	size_t	width,
		size_t	height,
		size_t	offsetX,
		size_t	offsetY,
		PixelFormatEnums	pixelFormat,
		void *	pData,
		TLPayloadType	dataPayloadType,
		size_t	dataSize
	)

pure virtual

Implemented in Image.

◆ Save() [1/9]

virtual void Save	(	const char *	pFilename,
		BMPOption &	pOption
	)		const

pure virtual

Implemented in Image.

◆ Save() [2/9]

virtual void Save	(	const char *	pFilename,
		ImageFileFormat	format = `SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT`
	)		const

pure virtual

Implemented in Image.

◆ Save() [3/9]

virtual void Save	(	const char *	pFilename,
		JPEGOption &	pOption
	)		const

pure virtual

Implemented in Image.

◆ Save() [4/9]

virtual void Save	(	const char *	pFilename,
		JPG2Option &	pOption
	)		const

pure virtual

Implemented in Image.

◆ Save() [5/9]

virtual void Save	(	const char *	pFilename,
		PGMOption &	pOption
	)		const

pure virtual

Implemented in Image.

◆ Save() [6/9]

virtual void Save	(	const char *	pFilename,
		PNGOption &	pOption
	)		const

pure virtual

Implemented in Image.

◆ Save() [7/9]

virtual void Save	(	const char *	pFilename,
		PPMOption &	pOption
	)		const

pure virtual

Implemented in Image.

◆ Save() [8/9]

virtual void Save	(	const char *	pFilename,
		SIOption &	option
	)		const

pure virtual

Implemented in Image.

◆ Save() [9/9]

virtual void Save	(	const char *	pFilename,
		TIFFOption &	pOption
	)		const

pure virtual

Implemented in Image.

Friends And Related Symbol Documentation

◆ ImageImpl

friend class ImageImpl

friend

◆ ImageListImpl

friend class ImageListImpl

friend

◆ SpinnakerGPUImpl

friend class SpinnakerGPUImpl

friend

◆ Stream

friend class Stream

friend

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

include/Interface/IImage.h

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~IImage()

◆ IImage()

Member Function Documentation

◆ CalculateStatistics()

◆ CheckCRC()

◆ DeepCopy()

◆ GetBitsPerPixel()

◆ GetBufferSize()

◆ GetChunkData()

◆ GetChunkLayoutId()

◆ GetColorProcessing()

◆ GetData()

◆ GetDataAbsoluteMax()

◆ GetDataAbsoluteMin()

◆ GetFrameID()

◆ GetHeight()

◆ GetID()

◆ GetImageData()

◆ GetImageSize()

◆ GetImageStatus()

◆ GetNumChannels()

◆ GetPayloadType()

◆ GetPixelFormat()

◆ GetPixelFormatIntType()

◆ GetPixelFormatName()

◆ GetPrivateData()

◆ GetStreamIndex()

◆ GetStride()

◆ GetTimeStamp()

◆ GetTLPayloadType()

◆ GetTLPixelFormat()

◆ GetTLPixelFormatNamespace()

◆ GetValidPayloadSize()

◆ GetWidth()

◆ GetXOffset()

◆ GetXPadding()

◆ GetYOffset()

◆ GetYPadding()

◆ HasChunkData()

◆ HasCRC()

◆ IsCompressed()

◆ IsIncomplete()

◆ IsInUse()

◆ Release()

◆ ResetImage() [1/3]

◆ ResetImage() [2/3]

◆ ResetImage() [3/3]

◆ Save() [1/9]

◆ Save() [2/9]

◆ Save() [3/9]

◆ Save() [4/9]

◆ Save() [5/9]

◆ Save() [6/9]

◆ Save() [7/9]

◆ Save() [8/9]

◆ Save() [9/9]

Friends And Related Symbol Documentation

◆ ImageImpl

◆ ImageListImpl

◆ SpinnakerGPUImpl

◆ Stream