Class Spinnaker::IImage¶

ClassList > Spinnaker > IImage

The interface file for Image .

#include <IImage.h>

Inherited by the following classes: Spinnaker::Image

Public Functions¶

Type	Name
virtual void	CalculateStatistics (ImageStatistics & pStatistics) = 0
virtual bool	CheckCRC () const = 0
virtual void	DeepCopy (const ImagePtr pSrcImage) = 0
virtual size_t	GetBitsPerPixel () const = 0
virtual size_t	GetBufferSize () const = 0
virtual const ChunkData &	GetChunkData () const = 0
virtual uint64_t	GetChunkLayoutId () const = 0
virtual ColorProcessingAlgorithm	GetColorProcessing () const = 0
virtual void *	GetData () const = 0
virtual float	GetDataAbsoluteMax () const = 0
virtual float	GetDataAbsoluteMin () const = 0
virtual uint64_t	GetFrameID () const = 0
virtual size_t	GetHeight () const = 0
virtual uint64_t	GetID () const = 0
virtual ImagePayloadType	GetImagePayloadType () const = 0
virtual size_t	GetImageSize () const = 0
virtual ImageStatus	GetImageStatus () const = 0
virtual size_t	GetNumChannels () const = 0
virtual size_t	GetPayloadType () const = 0
virtual PixelFormatEnums	GetPixelFormat () const = 0
virtual PixelFormatIntType	GetPixelFormatIntType () const = 0
virtual GenICam::gcstring	GetPixelFormatName () const = 0
virtual void *	GetPrivateData () const = 0
virtual GenICam::gcstring	GetSerialNumber () const = 0
virtual uint64_t	GetStreamIndex () const = 0
virtual size_t	GetStride () const = 0
virtual TLPayloadType	GetTLPayloadType () const = 0
virtual uint64_t	GetTLPixelFormat () const = 0
virtual TLPixelFormatNamespace	GetTLPixelFormatNamespace () const = 0
virtual uint64_t	GetTimeStamp () const = 0
virtual size_t	GetValidPayloadSize () const = 0
virtual size_t	GetWidth () const = 0
virtual size_t	GetXOffset () const = 0
virtual size_t	GetXPadding () const = 0
virtual size_t	GetYOffset () const = 0
virtual size_t	GetYPadding () const = 0
virtual bool	HasCRC () const = 0
virtual bool	HasChunkData () const = 0
virtual bool	IsCompressed () const = 0
virtual bool	IsInUse () = 0
virtual bool	IsIncomplete () const = 0
virtual void	Release () = 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	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, GenDCOption & pOption) const = 0
virtual void	Save (const char * pFilename, SIOption & option) const = 0
virtual	~IImage ()

Protected Functions¶

Type	Name
virtual ImageData *	GetImageData () const = 0
	IImage ()
virtual void	RegisterImageReleaseEvent (EventHandler & evtHandlerToRegister, void * pData) = 0
virtual void	SaveData (void * pData, size_t dataSize) = 0

Public Functions Documentation¶

function CalculateStatistics¶

virtual void Spinnaker::IImage::CalculateStatistics (
    ImageStatistics & pStatistics
) = 0

function CheckCRC¶

virtual bool Spinnaker::IImage::CheckCRC () const = 0

function DeepCopy¶

virtual void Spinnaker::IImage::DeepCopy (
    const ImagePtr pSrcImage
) = 0

function GetBitsPerPixel¶

virtual size_t Spinnaker::IImage::GetBitsPerPixel () const = 0

function GetBufferSize¶

virtual size_t Spinnaker::IImage::GetBufferSize () const = 0

function GetChunkData¶

virtual const ChunkData & Spinnaker::IImage::GetChunkData () const = 0

function GetChunkLayoutId¶

virtual uint64_t Spinnaker::IImage::GetChunkLayoutId () const = 0

function GetColorProcessing¶

virtual ColorProcessingAlgorithm Spinnaker::IImage::GetColorProcessing () const = 0

function GetData¶

virtual void * Spinnaker::IImage::GetData () const = 0

function GetDataAbsoluteMax¶

virtual float Spinnaker::IImage::GetDataAbsoluteMax () const = 0

function GetDataAbsoluteMin¶

virtual float Spinnaker::IImage::GetDataAbsoluteMin () const = 0

function GetFrameID¶

virtual uint64_t Spinnaker::IImage::GetFrameID () const = 0

function GetHeight¶

virtual size_t Spinnaker::IImage::GetHeight () const = 0

function GetID¶

virtual uint64_t Spinnaker::IImage::GetID () const = 0

function GetImagePayloadType¶

virtual ImagePayloadType Spinnaker::IImage::GetImagePayloadType () const = 0

function GetImageSize¶

virtual size_t Spinnaker::IImage::GetImageSize () const = 0

function GetImageStatus¶

virtual ImageStatus Spinnaker::IImage::GetImageStatus () const = 0

function GetNumChannels¶

virtual size_t Spinnaker::IImage::GetNumChannels () const = 0

function GetPayloadType¶

virtual size_t Spinnaker::IImage::GetPayloadType () const = 0

function GetPixelFormat¶

virtual PixelFormatEnums Spinnaker::IImage::GetPixelFormat () const = 0

function GetPixelFormatIntType¶

virtual PixelFormatIntType Spinnaker::IImage::GetPixelFormatIntType () const = 0

function GetPixelFormatName¶

virtual GenICam::gcstring Spinnaker::IImage::GetPixelFormatName () const = 0

function GetPrivateData¶

virtual void * Spinnaker::IImage::GetPrivateData () const = 0

function GetSerialNumber¶

virtual GenICam::gcstring Spinnaker::IImage::GetSerialNumber () const = 0

function GetStreamIndex¶

virtual uint64_t Spinnaker::IImage::GetStreamIndex () const = 0

function GetStride¶

virtual size_t Spinnaker::IImage::GetStride () const = 0

function GetTLPayloadType¶

virtual TLPayloadType Spinnaker::IImage::GetTLPayloadType () const = 0

function GetTLPixelFormat¶

virtual uint64_t Spinnaker::IImage::GetTLPixelFormat () const = 0

function GetTLPixelFormatNamespace¶

virtual TLPixelFormatNamespace Spinnaker::IImage::GetTLPixelFormatNamespace () const = 0

function GetTimeStamp¶

virtual uint64_t Spinnaker::IImage::GetTimeStamp () const = 0

function GetValidPayloadSize¶

virtual size_t Spinnaker::IImage::GetValidPayloadSize () const = 0

function GetWidth¶

virtual size_t Spinnaker::IImage::GetWidth () const = 0

function GetXOffset¶

virtual size_t Spinnaker::IImage::GetXOffset () const = 0

function GetXPadding¶

virtual size_t Spinnaker::IImage::GetXPadding () const = 0

function GetYOffset¶

virtual size_t Spinnaker::IImage::GetYOffset () const = 0

function GetYPadding¶

virtual size_t Spinnaker::IImage::GetYPadding () const = 0

function HasCRC¶

virtual bool Spinnaker::IImage::HasCRC () const = 0

function HasChunkData¶

virtual bool Spinnaker::IImage::HasChunkData () const = 0

function IsCompressed¶

virtual bool Spinnaker::IImage::IsCompressed () const = 0

function IsInUse¶

virtual bool Spinnaker::IImage::IsInUse () = 0

function IsIncomplete¶

virtual bool Spinnaker::IImage::IsIncomplete () const = 0

function Release¶

virtual void Spinnaker::IImage::Release () = 0

function ResetImage [1/3]¶

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

function ResetImage [2/3]¶

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

function ResetImage [3/3]¶

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

function Save [1/10]¶

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

function Save [2/10]¶

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

function Save [3/10]¶

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

function Save [4/10]¶

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

function Save [5/10]¶

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

function Save [6/10]¶

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

function Save [7/10]¶

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

function Save [8/10]¶

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

function Save [9/10]¶

virtual void Spinnaker::IImage::Save (
    const char * pFilename,
    GenDCOption & pOption
) const = 0

function Save [10/10]¶

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

function ~IImage¶

inline virtual Spinnaker::IImage::~IImage ()

Protected Functions Documentation¶

function GetImageData¶

virtual ImageData * Spinnaker::IImage::GetImageData () const = 0

function IImage¶

inline Spinnaker::IImage::IImage ()

function RegisterImageReleaseEvent¶

virtual void Spinnaker::IImage::RegisterImageReleaseEvent (
    EventHandler & evtHandlerToRegister,
    void * pData
) = 0

function SaveData¶

virtual void Spinnaker::IImage::SaveData (
    void * pData,
    size_t dataSize
) = 0

Friends Documentation¶

friend SpinRelayReceiver¶

class Spinnaker::IImage::SpinRelayReceiver (
    Relay::SpinRelayReceiver
)

friend SpinRelaySender¶

class Spinnaker::IImage::SpinRelaySender (
    Relay::SpinRelaySender
)

The documentation for this class was generated from the following file C:/workspace/include/Interface/IImage.h