Class Spinnaker::Image¶

ClassList > Spinnaker > Image

The image object class.

#include <Image.h>

Inherits the following classes: Spinnaker::IImage

Public Functions¶

Type	Name
virtual void	CalculateStatistics (ImageStatistics & pStatistics)
virtual bool	CheckCRC () const
virtual void	DeepCopy (const ImagePtr pSrcImage)
virtual size_t	GetBitsPerPixel () const
virtual size_t	GetBufferSize () const
virtual const ChunkData &	GetChunkData () const
virtual uint64_t	GetChunkLayoutId () const
virtual ColorProcessingAlgorithm	GetColorProcessing () const
virtual void *	GetData () const
virtual float	GetDataAbsoluteMax () const
virtual float	GetDataAbsoluteMin () const
virtual uint64_t	GetFrameID () const
virtual size_t	GetHeight () const
virtual uint64_t	GetID () const
virtual ImagePayloadType	GetImagePayloadType () const
virtual size_t	GetImageSize () const
virtual ImageStatus	GetImageStatus () const
virtual size_t	GetNumChannels () const
virtual size_t	GetPayloadType () const
virtual Spinnaker::PixelFormatEnums	GetPixelFormat () const
virtual Spinnaker::PixelFormatIntType	GetPixelFormatIntType () const
virtual GenICam::gcstring	GetPixelFormatName () const
virtual void *	GetPrivateData () const
virtual GenICam::gcstring	GetSerialNumber () const
virtual uint64_t	GetStreamIndex () const
virtual size_t	GetStride () const
virtual TLPayloadType	GetTLPayloadType () const
virtual uint64_t	GetTLPixelFormat () const
virtual TLPixelFormatNamespace	GetTLPixelFormatNamespace () const
virtual uint64_t	GetTimeStamp () const
virtual size_t	GetValidPayloadSize () const
virtual size_t	GetWidth () const
virtual size_t	GetXOffset () const
virtual size_t	GetXPadding () const
virtual size_t	GetYOffset () const
virtual size_t	GetYPadding () const
virtual bool	HasCRC () const
virtual bool	HasChunkData () const
virtual bool	IsCompressed () const
virtual bool	IsInUse ()
virtual bool	IsIncomplete () const
virtual void	Release ()
virtual void	ResetImage (size_t width, size_t height, size_t offsetX, size_t offsetY, Spinnaker::PixelFormatEnums pixelFormat)
virtual void	ResetImage (size_t width, size_t height, size_t offsetX, size_t offsetY, Spinnaker::PixelFormatEnums pixelFormat, void * pData)
virtual void	ResetImage (size_t width, size_t height, size_t offsetX, size_t offsetY, PixelFormatEnums pixelFormat, void * pData, TLPayloadType dataPayloadType, size_t dataSize)
virtual void	Save (const char * pFilename, ImageFileFormat format=SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT) const
virtual void	Save (const char * pFilename, PNGOption & pOption) const
virtual void	Save (const char * pFilename, PPMOption & pOption) const
virtual void	Save (const char * pFilename, PGMOption & pOption) const
virtual void	Save (const char * pFilename, TIFFOption & pOption) const
virtual void	Save (const char * pFilename, JPEGOption & pOption) const
virtual void	Save (const char * pFilename, JPG2Option & pOption) const
virtual void	Save (const char * pFilename, BMPOption & pOption) const
virtual void	Save (const char * pFilename, GenDCOption & pOption) const
virtual void	Save (const char * pFilename, SIOption & pOption) const
virtual	~Image ()

Public Functions inherited from Spinnaker::IImage¶

See Spinnaker::IImage

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

Public Static Functions¶

Type	Name
ImagePtr	Create ()
ImagePtr	Create (const ImagePtr image)
ImagePtr	Create (size_t width, size_t height, size_t offsetX, size_t offsetY, Spinnaker::PixelFormatEnums pixelFormat, void * pData)
ImagePtr	Create (size_t width, size_t height, size_t offsetX, size_t offsetY, PixelFormatEnums pixelFormat, void * pData, TLPayloadType dataPayloadType, size_t dataSize)
const char *	GetImageStatusDescription (ImageStatus status)
ImagePtr	Load (const char * pFilename, ImageFileFormat format=SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT)

Protected Functions¶

Type	Name
ImagePtr	CreateShared () const
void	DeepCopy (const Image & pSrcImage)
virtual ImageData *	GetImageData () const
	Image ()
	Image (const ImagePtr image)
	Image (size_t width, size_t height, size_t offsetX, size_t offsetY, PixelFormatEnums pixelFormat, void * pData)
	Image (size_t width, size_t height, size_t offsetX, size_t offsetY, PixelFormatEnums pixelFormat, void * pData, TLPayloadType payloadType, size_t payloadSize)
virtual void	RegisterImageReleaseEvent (EventHandler & evtHandlerToRegister, void * pData)
virtual void	SaveData (void * pData, size_t dataSize)

Protected Functions inherited from Spinnaker::IImage¶

See Spinnaker::IImage

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

Protected Static Functions¶

Type	Name
ImagePtr	LoadData (void * pData, size_t dataSize)

Public Functions Documentation¶

function CalculateStatistics¶

virtual void Spinnaker::Image::CalculateStatistics (
    ImageStatistics & pStatistics
)

Retrieves a number of pixel statistics for an image including a histogram array of the range of pixel values.

Parameters:

pStatistics The statistics of an image.

Implements Spinnaker::IImage::CalculateStatistics

function CheckCRC¶

virtual bool Spinnaker::Image::CheckCRC () const

Checks if the computed checksum matches with chunk data's ImageCRC

Returns:

Returns true if computed checksum matches with the chunk data's CRC and false otherwise.

Implements Spinnaker::IImage::CheckCRC

function DeepCopy [1/2]¶

virtual void Spinnaker::Image::DeepCopy (
    const ImagePtr pSrcImage
)

Performs a deep copy of the Image. After this operation, the image contents and member variables will be the same. The Images will not share a buffer. The Image's current buffer will not be released.

Parameters:

pSrcImage The Image to copy the data from.

Implements Spinnaker::IImage::DeepCopy

function GetBitsPerPixel¶

virtual size_t Spinnaker::Image::GetBitsPerPixel () const

Gets the number of bits used per pixel in the image. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.

Returns:

The number of bits used per pixel.

Implements Spinnaker::IImage::GetBitsPerPixel

function GetBufferSize¶

virtual size_t Spinnaker::Image::GetBufferSize () const

Gets the size of the buffer associated with the image in bytes.

For user created images, this function returns the size of the user provided data if the data size was provided. If the data size was not provided, the buffer size is calculated based on the image dimensions and pixel format.

See also: GetImageSize()

See also: GetValidPayloadSize()

Returns:

The size of the buffer, in bytes.

Implements Spinnaker::IImage::GetBufferSize

function GetChunkData¶

virtual const ChunkData & Spinnaker::Image::GetChunkData () const

Returns a pointer to a chunk data interface. No ownership is transfered, the chunk data interface reference is valid until Image::Release() is called on this image.

Returns:

ChunkData interface that provides access to image chunks.

Implements Spinnaker::IImage::GetChunkData

function GetChunkLayoutId¶

virtual uint64_t Spinnaker::Image::GetChunkLayoutId () const

Returns the id of the chunk data layout.

Returns:

uint64_t value representing the id of the chunk data layout.

Implements Spinnaker::IImage::GetChunkLayoutId

function GetColorProcessing¶

virtual ColorProcessingAlgorithm Spinnaker::Image::GetColorProcessing () const

Gets the color algorithm used to produce the image.

See also: ImageProcessor::Convert()

Returns:

The color processing algorithm used to produce the image.

Implements Spinnaker::IImage::GetColorProcessing

function GetData¶

virtual void * Spinnaker::Image::GetData () const

Gets a pointer to the data associated with the image. This function is considered unsafe. The pointer returned could be invalidated if the buffer is released. The pointer may also be invalidated if the Image object is passed to Image::Release().

Returns:

A pointer to the image data.

Implements Spinnaker::IImage::GetData

function GetDataAbsoluteMax¶

virtual float Spinnaker::Image::GetDataAbsoluteMax () const

Get the value for which no image data will exceed.

Returns:

the maximim theoretical image data value

Implements Spinnaker::IImage::GetDataAbsoluteMax

function GetDataAbsoluteMin¶

virtual float Spinnaker::Image::GetDataAbsoluteMin () const

Get the value for which no image data will be less than

Returns:

the minimum theoretical image data value

Implements Spinnaker::IImage::GetDataAbsoluteMin

function GetFrameID¶

virtual uint64_t Spinnaker::Image::GetFrameID () const

Gets the frame ID for this image.

Returns:

The frame ID.

Implements Spinnaker::IImage::GetFrameID

function GetHeight¶

virtual size_t Spinnaker::Image::GetHeight () const

Gets the height of the image in pixels. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.

Returns:

The height in pixels.

Implements Spinnaker::IImage::GetHeight

function GetID¶

virtual uint64_t Spinnaker::Image::GetID () const

Gets a unique ID for this image that is associated with a stream. Note that an ID of 0 indicates that the image is no longer associated with a stream or is a copy of the original image.

See also: GetFrameID()

Returns:

The 64 bit unique id for this image.

Implements Spinnaker::IImage::GetID

function GetImagePayloadType¶

virtual ImagePayloadType Spinnaker::Image::GetImagePayloadType () const

Gets the image specific payload type.

Returns:

Image payload type

Implements Spinnaker::IImage::GetImagePayloadType

function GetImageSize¶

virtual size_t Spinnaker::Image::GetImageSize () const

Returns the size of the image

If the image is compressed, the value returned represents the size of the compressed image data in bytes. For chunk enabled data transmissions, only the size of the image chunk is reported here. If the image chunk is compressed, the value returned represents the size of the compressed image data in bytes. The entire chunk data payload including the image chunk and other optional data chunks can be queried by GetValidPayloadSize().

See also: GetBufferSize()

See also: GetValidPayloadSize()

Returns:

The image size in bytes.

Implements Spinnaker::IImage::GetImageSize

function GetImageStatus¶

virtual ImageStatus Spinnaker::Image::GetImageStatus () const

Returns data integrity status of the image returned from GetNextImage()

Returns:

Returns whether image has any data integrity issues.

Implements Spinnaker::IImage::GetImageStatus

function GetNumChannels¶

virtual size_t Spinnaker::Image::GetNumChannels () const

Gets the number of channels (depth) used in the image. Returns 0 if the number of channels for the given pixel format is unknown.

Returns:

The number of channels per pixel.

Implements Spinnaker::IImage::GetNumChannels

function GetPayloadType¶

virtual size_t Spinnaker::Image::GetPayloadType () const

Gets the device specific payload type that was transmitted. This is a Transport Layer specific value that identifies how the image was transmitted. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.

Returns:

Transport Layer device specific payload type.

Implements Spinnaker::IImage::GetPayloadType

function GetPixelFormat¶

virtual Spinnaker::PixelFormatEnums Spinnaker::Image::GetPixelFormat () const

Returns an enum value that represents the pixel format of this image. The enum can be used with the easy access GenICam features available through the Camera.h header file. This easy access enum can also be used in the ImageProcessor::Convert() function.

See also: ImageProcessor::Convert()

Returns:

enum value representing the PixelFormat.

Implements Spinnaker::IImage::GetPixelFormat

function GetPixelFormatIntType¶

virtual Spinnaker::PixelFormatIntType Spinnaker::Image::GetPixelFormatIntType () const

Returns an enum value that represents the integer type used in the pixel format of this image.

Returns:

enum value representing the integer type used.

Implements Spinnaker::IImage::GetPixelFormatIntType

function GetPixelFormatName¶

virtual GenICam::gcstring Spinnaker::Image::GetPixelFormatName () const

Returns a string value that represents this image's pixel format. The string is a valid SFNC name that maps to the underlying TL specific pixel format. This is the most generic way to identify the pixel format of the image.

Returns:

string value representing the PixelFormat.

Implements Spinnaker::IImage::GetPixelFormatName

function GetPrivateData¶

virtual void * Spinnaker::Image::GetPrivateData () const

Gets a pointer to the user passed data associated with the image. This function is considered unsafe. The pointer returned could be invalidated if the buffer is released. The pointer may also be invalidated if the Image object is passed to Image::Release().

TODO: no way to set private data for image yet.

Returns:

A pointer to the user passed data pointer.

Implements Spinnaker::IImage::GetPrivateData

function GetSerialNumber¶

virtual GenICam::gcstring Spinnaker::Image::GetSerialNumber () const

Gets the serial number of the camera that captured the image. Note that an empty string indicates that the image is not associated with a camera

Returns:

The serial number of the camera that captured the image.

Implements Spinnaker::IImage::GetSerialNumber

function GetStreamIndex¶

virtual uint64_t Spinnaker::Image::GetStreamIndex () const

Gets the stream channel index of where the image is received.

Returns:

The stream channel index of where this image is received.

Implements Spinnaker::IImage::GetStreamIndex

function GetStride¶

virtual size_t Spinnaker::Image::GetStride () const

Gets the stride of the image in bytes. The stride of an image is how many bytes are in each row. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.

Returns:

The stride in bytes.

Implements Spinnaker::IImage::GetStride

function GetTLPayloadType¶

virtual TLPayloadType Spinnaker::Image::GetTLPayloadType () const

Gets the GenTL payload type that was transmitted. This is a generic Transport agnostic value that identifies how the image was transmitted. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.

Returns:

Transport Layer agnostic GenTL payload type.

Implements Spinnaker::IImage::GetTLPayloadType

function GetTLPixelFormat¶

virtual uint64_t Spinnaker::Image::GetTLPixelFormat () const

Gets the pixel format of the image. This is a Transport Layer specific pixel format that identifies how the pixels in the image should be interpreted. To understand how to interpret this value it is necessary to know what the transport layer namespace is. This can be retrieved through a call to GetTLPixelFormatNamespace(). This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.

See also: GetTLPixelFormatNamespace()

Returns:

Transport Layer specific pixel format.

Implements Spinnaker::IImage::GetTLPixelFormat

function GetTLPixelFormatNamespace¶

virtual TLPixelFormatNamespace Spinnaker::Image::GetTLPixelFormatNamespace () const

Returns an enum value that represents the namespace in which this image's TL specific pixel format resides. This information is important to properly interpret the value returned by GetTLPixelFormat()

See also: GetTLPixelFormat()

Returns:

enum value representing the PixelFormatNamespace.

Implements Spinnaker::IImage::GetTLPixelFormatNamespace

function GetTimeStamp¶

virtual uint64_t Spinnaker::Image::GetTimeStamp () const

Gets the time stamp for the image in nanoseconds.

Returns:

The time stamp of the image.

Implements Spinnaker::IImage::GetTimeStamp

function GetValidPayloadSize¶

virtual size_t Spinnaker::Image::GetValidPayloadSize () const

Returns the size of valid data in the image payload.

This is the actual amount of data read from the device. For non-chunk images, the value returned here is equal to the value returned by GetImageSize(). For chunk enabled data transmissions, the sum of the image chunk, other optional data chunks (e.g. ExposureTime) and their associated chunk headers is returned here. Note that GetBufferSize() returns the total size of bytes allocated for the image and could be equal to or greater than the size returned by this function.

See also: GetBufferSize()

See also: GetImageSize()

Returns:

size_t value representing valid payload.

Implements Spinnaker::IImage::GetValidPayloadSize

function GetWidth¶

virtual size_t Spinnaker::Image::GetWidth () const

Gets the width of the image in pixels. This information is retrieved from the Transport Layer image format headers. It is retrieved on a per image basis.

Returns:

The width in pixels.

Implements Spinnaker::IImage::GetWidth

function GetXOffset¶

virtual size_t Spinnaker::Image::GetXOffset () const

Gets the ROI x offset in pixels for this image. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.

Returns:

The x offset in pixels.

Implements Spinnaker::IImage::GetXOffset

function GetXPadding¶

virtual size_t Spinnaker::Image::GetXPadding () const

Gets the x padding in bytes for this image. This is the number of bytes at the end of each line to facilitate alignment in buffers. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.

Returns:

The x padding in bytes.

Implements Spinnaker::IImage::GetXPadding

function GetYOffset¶

virtual size_t Spinnaker::Image::GetYOffset () const

Gets the ROI y offset in pixels for this image. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.

Returns:

The y offset in pixels.

Implements Spinnaker::IImage::GetYOffset

function GetYPadding¶

virtual size_t Spinnaker::Image::GetYPadding () const

Gets the y padding in bytes for this image. This is the number of bytes at the end of each image to facilitate alignment in buffers. This information is retrieved from the Transport Layer Image format headers. It is retrieved on a per image basis.

Returns:

The y padding in bytes.

Implements Spinnaker::IImage::GetYPadding

function HasCRC¶

virtual bool Spinnaker::Image::HasCRC () const

Checks if the image contains ImageCRC checksum from chunk data

Returns:

Returns true if image contains ImageCRC checksum from chunk data and false otherwise.

Implements Spinnaker::IImage::HasCRC

function HasChunkData¶

virtual bool Spinnaker::Image::HasChunkData () const

Checks if the image contains chunk data

Returns:

Returns true if image contains chunk data and false otherwise.

Implements Spinnaker::IImage::HasChunkData

function IsCompressed¶

virtual bool Spinnaker::Image::IsCompressed () const

Returns a boolean value indicating whether this image is compressed.

Returns:

Returns true if image is compressed, false otherwise.

Implements Spinnaker::IImage::IsCompressed

function IsInUse¶

virtual bool Spinnaker::Image::IsInUse ()

Returns true if the image is still in use by the stream

Returns:

Returns true if the image is in use and false otherwise.

Implements Spinnaker::IImage::IsInUse

function IsIncomplete¶

virtual bool Spinnaker::Image::IsIncomplete () const

Returns a boolean value indicating if this image was incomplete. An image is marked as incomplete if the transport layer received less data then it requested.

Returns:

Returns true if image is incomplete, false otherwise.

Implements Spinnaker::IImage::IsIncomplete

function Release¶

virtual void Spinnaker::Image::Release ()

Implements Spinnaker::IImage::Release

function ResetImage [1/3]¶

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

Sets new dimensions of the image object and allocates memory.

Parameters:

width The width of image in pixels to set.
height The height of image in pixels to set.
offsetX The x offset in pixels to set.
offsetY The y offset in pixels to set.
pixelFormat Pixel format to set.

Implements Spinnaker::IImage::ResetImage

function ResetImage [2/3]¶

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

Sets new dimensions of the image object.

Parameters:

width The width of image in pixels to set.
height The height of image in pixels to set.
offsetX The x offset in pixels to set.
offsetY The y offset in pixels to set.
pixelFormat Pixel format to set.
pData Pointer to the image buffer.

Implements Spinnaker::IImage::ResetImage

function ResetImage [3/3]¶

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

Sets new dimensions of the image object. This function is used to create an image from existing image data with a specific payload type, such as a compressed image.

Parameters:

width The width of image in pixels to set.
height The height of image in pixels to set.
offsetX The x offset in pixels to set.
offsetY The y offset in pixels to set.
pixelFormat Pixel format to set.
pData Pointer to the image buffer.
dataPayloadType The payload type of the data. This value can be retrieved from an existing image by using the GetTLPayloadType() function call.
dataSize The size of the provided data in bytes

See also: GetTLPayloadType()

Implements Spinnaker::IImage::ResetImage

function Save [1/10]¶

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

Saves the image to the specified file name with the file format specified. Note that only the image data is saved regardless of the payload type used to transmit the image from camera to host. Saving a RAW image that was transmitted using the chunk image payload type will only contain the image data portion and none of the other chunks are preserved.

Parameters:

pFilename Filename to save image with.
format File format to save in.

Implements Spinnaker::IImage::Save