Spinnaker C++
4.0.0.116
Public Member Functions | Protected Member Functions | Friends | List of all members
IImage Class Referenceabstract

The interface file for Image. More...

Inheritance diagram for IImage:
Image

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 ChunkDataGetChunkData () 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
 

Detailed Description

The interface file for Image.

Constructor & Destructor Documentation

virtual ~IImage ( )
inlinevirtual
IImage ( )
inlineprotected

Member Function Documentation

virtual void CalculateStatistics ( ImageStatistics pStatistics)
pure virtual

Implemented in Image.

virtual bool CheckCRC ( ) const
pure virtual

Implemented in Image.

virtual void DeepCopy ( const ImagePtr  pSrcImage)
pure virtual

Implemented in Image.

virtual size_t GetBitsPerPixel ( ) const
pure virtual

Implemented in Image.

virtual size_t GetBufferSize ( ) const
pure virtual

Implemented in Image.

virtual const ChunkData& GetChunkData ( ) const
pure virtual

Implemented in Image.

virtual uint64_t GetChunkLayoutId ( ) const
pure virtual

Implemented in Image.

virtual ColorProcessingAlgorithm GetColorProcessing ( ) const
pure virtual

Implemented in Image.

virtual void* GetData ( ) const
pure virtual

Implemented in Image.

virtual float GetDataAbsoluteMax ( ) const
pure virtual

Implemented in Image.

virtual float GetDataAbsoluteMin ( ) const
pure virtual

Implemented in Image.

virtual uint64_t GetFrameID ( ) const
pure virtual

Implemented in Image.

virtual size_t GetHeight ( ) const
pure virtual

Implemented in Image.

virtual uint64_t GetID ( ) const
pure virtual

Implemented in Image.

virtual ImageData* GetImageData ( ) const
protectedpure virtual

Implemented in Image.

virtual size_t GetImageSize ( ) const
pure virtual

Implemented in Image.

virtual ImageStatus GetImageStatus ( ) const
pure virtual

Implemented in Image.

virtual size_t GetNumChannels ( ) const
pure virtual

Implemented in Image.

virtual size_t GetPayloadType ( ) const
pure virtual

Implemented in Image.

virtual PixelFormatEnums GetPixelFormat ( ) const
pure virtual

Implemented in Image.

virtual PixelFormatIntType GetPixelFormatIntType ( ) const
pure virtual

Implemented in Image.

virtual GenICam::gcstring GetPixelFormatName ( ) const
pure virtual

Implemented in Image.

virtual void* GetPrivateData ( ) const
pure virtual

Implemented in Image.

virtual uint64_t GetStreamIndex ( ) const
pure virtual

Implemented in Image.

virtual size_t GetStride ( ) const
pure virtual

Implemented in Image.

virtual uint64_t GetTimeStamp ( ) const
pure virtual

Implemented in Image.

virtual TLPayloadType GetTLPayloadType ( ) const
pure virtual

Implemented in Image.

virtual uint64_t GetTLPixelFormat ( ) const
pure virtual

Implemented in Image.

virtual TLPixelFormatNamespace GetTLPixelFormatNamespace ( ) const
pure virtual

Implemented in Image.

virtual size_t GetValidPayloadSize ( ) const
pure virtual

Implemented in Image.

virtual size_t GetWidth ( ) const
pure virtual

Implemented in Image.

virtual size_t GetXOffset ( ) const
pure virtual

Implemented in Image.

virtual size_t GetXPadding ( ) const
pure virtual

Implemented in Image.

virtual size_t GetYOffset ( ) const
pure virtual

Implemented in Image.

virtual size_t GetYPadding ( ) const
pure virtual

Implemented in Image.

virtual bool HasChunkData ( ) const
pure virtual

Implemented in Image.

virtual bool HasCRC ( ) const
pure virtual

Implemented in Image.

virtual bool IsCompressed ( ) const
pure virtual

Implemented in Image.

virtual bool IsIncomplete ( ) const
pure virtual

Implemented in Image.

virtual bool IsInUse ( )
pure virtual

Implemented in Image.

virtual void Release ( )
pure virtual

Implemented in Image.

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

Implemented in Image.

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

Implemented in Image.

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.

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

Implemented in Image.

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

Implemented in Image.

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

Implemented in Image.

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

Implemented in Image.

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

Implemented in Image.

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

Implemented in Image.

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

Implemented in Image.

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

Implemented in Image.

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

Implemented in Image.

Friends And Related Function Documentation

friend class ImageImpl
friend
friend class ImageListImpl
friend
friend class Stream
friend

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference