Spinnaker SDK C++
4.1.0.157
 
 

 
Loading...
Searching...
No Matches

The image object class. More...

#include <Image.h>

Inheritance diagram for Image:
IImage

Public Member Functions

virtual ~Image ()
 Virtual destructor.
 
ColorProcessingAlgorithm GetColorProcessing () const
 Gets the color algorithm used to produce the image.
 
void 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.
 
void 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.
 
void 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.
 
void Release ()
 
uint64_t GetID () const
 Gets a unique ID for this image that is associated with a stream.
 
uint64_t GetStreamIndex () const
 Gets the stream channel index of where the image is received.
 
void * GetData () const
 Gets a pointer to the data associated with the image.
 
float GetDataAbsoluteMax () const
 Get the value for which no image data will exceed.
 
float GetDataAbsoluteMin () const
 Get the value for which no image data will be less than.
 
void * GetPrivateData () const
 Gets a pointer to the user passed data associated with the image.
 
size_t GetBufferSize () const
 Gets the size of the buffer associated with the image in bytes.
 
void DeepCopy (const ImagePtr pSrcImage)
 Performs a deep copy of the Image.
 
size_t GetWidth () const
 Gets the width of the image in pixels.
 
size_t GetHeight () const
 Gets the height of the image in pixels.
 
size_t GetStride () const
 Gets the stride of the image in bytes.
 
size_t GetBitsPerPixel () const
 Gets the number of bits used per pixel in the image.
 
size_t GetNumChannels () const
 Gets the number of channels (depth) used in the image.
 
size_t GetXOffset () const
 Gets the ROI x offset in pixels for this image.
 
size_t GetYOffset () const
 Gets the ROI y offset in pixels for this image.
 
size_t GetXPadding () const
 Gets the x padding in bytes for this image.
 
size_t GetYPadding () const
 Gets the y padding in bytes for this image.
 
uint64_t GetFrameID () const
 Gets the frame ID for this image.
 
size_t GetPayloadType () const
 Gets the payload type that was transmitted.
 
TLPayloadType GetTLPayloadType () const
 Gets the GenTL specific payload type that was transmitted.
 
uint64_t GetTLPixelFormat () const
 Gets the pixel format of the image.
 
TLPixelFormatNamespace GetTLPixelFormatNamespace () const
 Returns an enum value that represents the namespace in which this image's TL specific pixel format resides.
 
GenICam::gcstring GetPixelFormatName () const
 Returns a string value that represents this image's pixel format.
 
Spinnaker::PixelFormatEnums GetPixelFormat () const
 Returns an enum value that represents the pixel format of this image.
 
Spinnaker::PixelFormatIntType GetPixelFormatIntType () const
 Returns an enum value that represents the integer type used in the pixel format of this image.
 
bool IsIncomplete () const
 Returns a boolean value indicating if this image was incomplete.
 
size_t GetValidPayloadSize () const
 Returns the size of valid data in the image payload.
 
uint64_t GetChunkLayoutId () const
 Returns the id of the chunk data layout.
 
uint64_t GetTimeStamp () const
 Gets the time stamp for the image in nanoseconds.
 
void 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.
 
void Save (const char *pFilename, PNGOption &pOption) const
 Saves the image to the specified file name with the options specified.
 
void Save (const char *pFilename, PPMOption &pOption) const
 Saves the image to the specified file name with the options specified.
 
void Save (const char *pFilename, PGMOption &pOption) const
 Saves the image to the specified file name with the options specified.
 
void Save (const char *pFilename, TIFFOption &pOption) const
 Saves the image to the specified file name with the options specified.
 
void Save (const char *pFilename, JPEGOption &pOption) const
 Saves the image to the specified file name with the options specified.
 
void Save (const char *pFilename, JPG2Option &pOption) const
 Saves the image to the specified file name with the options specified.
 
void Save (const char *pFilename, BMPOption &pOption) const
 Saves the image to the specified file name with the options specified.
 
void Save (const char *pFilename, SIOption &pOption) const
 Saves the image to the specified file name with the options specified.
 
bool HasChunkData () const
 Checks if the image contains chunk data.
 
const ChunkDataGetChunkData () const
 Returns a pointer to a chunk data interface.
 
void CalculateStatistics (ImageStatistics &pStatistics)
 Retrieves a number of pixel statistics for an image including a histogram array of the range of pixel values.
 
bool HasCRC () const
 Checks if the image contains ImageCRC checksum from chunk data.
 
bool CheckCRC () const
 Checks if the computed checksum matches with chunk data's ImageCRC.
 
size_t GetImageSize () const
 Returns the size of the image.
 
bool IsInUse ()
 Returns true if the image is still in use by the stream.
 
ImageStatus GetImageStatus () const
 Returns data integrity status of the image returned from GetNextImage()
 
bool IsCompressed () const
 Returns a boolean value indicating whether this image is compressed.
 
- Public Member Functions inherited from IImage
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
 

Static Public Member Functions

static ImagePtr Create ()
 Create an image object.
 
static ImagePtr Create (const ImagePtr image)
 Create an image object that is a deep copy of the input image.
 
static ImagePtr Create (size_t width, size_t height, size_t offsetX, size_t offsetY, Spinnaker::PixelFormatEnums pixelFormat, void *pData)
 Create an image object with the specified parameters.
 
static ImagePtr Create (size_t width, size_t height, size_t offsetX, size_t offsetY, PixelFormatEnums pixelFormat, void *pData, TLPayloadType dataPayloadType, size_t dataSize)
 Create an image object with the specified parameters.
 
static ImagePtr Load (const char *pFilename, ImageFileFormat format=SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT)
 Loads the image from the specified file name with the options specified.
 
static const char * GetImageStatusDescription (ImageStatus status)
 Returns a string describing the meaning of the status enum.
 

Protected Member Functions

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)
 
ImagePtr CreateShared () const
 
void DeepCopy (const Image &pSrcImage)
 
- Protected Member Functions inherited from IImage
 IImage ()
 
virtual ImageData * GetImageData () const =0
 

Friends

class IDataStream
 
class Stream
 
class ImageConverter
 
class ImageConverterIpp
 
class ImageImpl
 
class ImageListImpl
 
class ImageFiler
 
class ImageProcessorImpl
 
class ImageStatsCalculator
 
class ImageUtilityImpl
 
class ImageUtilityPolarizationImpl
 
class ImageUtilityPlanarImpl
 
class SpinnakerGPUImpl
 

Detailed Description

The image object class.

Constructor & Destructor Documentation

◆ ~Image()

virtual ~Image ( )
virtual

Virtual destructor.

◆ Image() [1/4]

Image ( )
protected

◆ Image() [2/4]

Image ( const ImagePtr  image)
protected

◆ Image() [3/4]

Image ( size_t  width,
size_t  height,
size_t  offsetX,
size_t  offsetY,
PixelFormatEnums  pixelFormat,
void *  pData 
)
protected

◆ Image() [4/4]

Image ( size_t  width,
size_t  height,
size_t  offsetX,
size_t  offsetY,
PixelFormatEnums  pixelFormat,
void *  pData,
TLPayloadType  payloadType,
size_t  payloadSize 
)
protected

Member Function Documentation

◆ CalculateStatistics()

void CalculateStatistics ( ImageStatistics pStatistics)
virtual

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

Parameters
pStatisticsThe statistics of an image.

Implements IImage.

◆ CheckCRC()

bool CheckCRC ( ) const
virtual

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 IImage.

◆ Create() [1/4]

static ImagePtr Create ( )
static

Create an image object.

◆ Create() [2/4]

static ImagePtr Create ( const ImagePtr  image)
static

Create an image object that is a deep copy of the input image.

Parameters
imageThe input image to copy

◆ Create() [3/4]

static ImagePtr Create ( size_t  width,
size_t  height,
size_t  offsetX,
size_t  offsetY,
PixelFormatEnums  pixelFormat,
void *  pData,
TLPayloadType  dataPayloadType,
size_t  dataSize 
)
static

Create an image object with the specified parameters.

This function is used to create an image from existing image data with a specific payload type, such as a compressed image.

Note that images with chunk payload types are saved with only the image data preserved. Remember to specify the non-chunk equivalent payload type when creating images with these chunk payload types. For example, images need to be created with PAYLOAD_TYPE_IMAGE payload type if the original image had PAYLOAD_TYPE_EXTENDED_CHUNK payload type.

Parameters
widthThe image width in pixels
heightThe image height in pixels
offsetXThe image X offset
offsetYThe image Y offset
pixelFormatThe image pixel format
pDataThe compressed image data
dataPayloadTypeThe payload type of the data. This value can be retrieved from an existing image by using the GetTLPayloadType() function call.
dataSizeThe size of the provided data in bytes
See also
GetTLPayloadType()

◆ Create() [4/4]

static ImagePtr Create ( size_t  width,
size_t  height,
size_t  offsetX,
size_t  offsetY,
Spinnaker::PixelFormatEnums  pixelFormat,
void *  pData 
)
static

Create an image object with the specified parameters.

Parameters
widthThe image width in pixels
heightThe image height in pixels
offsetXThe image X offset
offsetYThe image Y offset
pixelFormatThe image pixel format
pDataThe image data

◆ CreateShared()

ImagePtr CreateShared ( ) const
protected

◆ DeepCopy() [1/2]

void DeepCopy ( const Image pSrcImage)
protected

◆ DeepCopy() [2/2]

void DeepCopy ( const ImagePtr  pSrcImage)
virtual

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
pSrcImageThe Image to copy the data from.

Implements IImage.

◆ GetBitsPerPixel()

size_t GetBitsPerPixel ( ) const
virtual

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 IImage.

◆ GetBufferSize()

size_t GetBufferSize ( ) const
virtual

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()
GetValidPayloadSize()
Returns
The size of the buffer, in bytes.

Implements IImage.

◆ GetChunkData()

const ChunkData & GetChunkData ( ) const
virtual

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 IImage.

◆ GetChunkLayoutId()

uint64_t GetChunkLayoutId ( ) const
virtual

Returns the id of the chunk data layout.

Returns
uint64_t value representing the id of the chunk data layout.

Implements IImage.

◆ GetColorProcessing()

ColorProcessingAlgorithm GetColorProcessing ( ) const
virtual

Gets the color algorithm used to produce the image.

See also
ImageProcessor::Convert()
Returns
The color processing algorithm used to produce the image.

Implements IImage.

◆ GetData()

void * GetData ( ) const
virtual

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 IImage.

◆ GetDataAbsoluteMax()

float GetDataAbsoluteMax ( ) const
virtual

Get the value for which no image data will exceed.

Returns
the maximim theoretical image data value

Implements IImage.

◆ GetDataAbsoluteMin()

float GetDataAbsoluteMin ( ) const
virtual

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

Returns
the minimum theoretical image data value

Implements IImage.

◆ GetFrameID()

uint64_t GetFrameID ( ) const
virtual

Gets the frame ID for this image.

Returns
The frame ID.

Implements IImage.

◆ GetHeight()

size_t GetHeight ( ) const
virtual

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 IImage.

◆ GetID()

uint64_t GetID ( ) const
virtual

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 IImage.

◆ GetImageData()

ImageData * GetImageData ( ) const
protectedvirtual

Implements IImage.

◆ GetImageSize()

size_t GetImageSize ( ) const
virtual

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()
GetValidPayloadSize()
Returns
The image size in bytes.

Implements IImage.

◆ GetImageStatus()

ImageStatus GetImageStatus ( ) const
virtual

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

Returns
Returns whether image has any data integrity issues.

Implements IImage.

◆ GetImageStatusDescription()

static const char * GetImageStatusDescription ( ImageStatus  status)
static

Returns a string describing the meaning of the status enum.

Returns
Returns the meaning of the status enum.

◆ GetNumChannels()

size_t GetNumChannels ( ) const
virtual

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 IImage.

◆ GetPayloadType()

size_t GetPayloadType ( ) const
virtual

Gets the payload type that was transmitted.

This is a device types 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
Device types specific payload type.

Implements IImage.

◆ GetPixelFormat()

Spinnaker::PixelFormatEnums GetPixelFormat ( ) const
virtual

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 IImage.

◆ GetPixelFormatIntType()

Spinnaker::PixelFormatIntType GetPixelFormatIntType ( ) const
virtual

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 IImage.

◆ GetPixelFormatName()

GenICam::gcstring GetPixelFormatName ( ) const
virtual

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 IImage.

◆ GetPrivateData()

void * GetPrivateData ( ) const
virtual

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 IImage.

◆ GetStreamIndex()

uint64_t GetStreamIndex ( ) const
virtual

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

Returns
The stream channel index of where this image is received.

Implements IImage.

◆ GetStride()

size_t GetStride ( ) const
virtual

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 IImage.

◆ GetTimeStamp()

uint64_t GetTimeStamp ( ) const
virtual

Gets the time stamp for the image in nanoseconds.

Returns
The time stamp of the image.

Implements IImage.

◆ GetTLPayloadType()

TLPayloadType GetTLPayloadType ( ) const
virtual

Gets the GenTL 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 specific payload type.

Implements IImage.

◆ GetTLPixelFormat()

uint64_t GetTLPixelFormat ( ) const
virtual

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 IImage.

◆ GetTLPixelFormatNamespace()

TLPixelFormatNamespace GetTLPixelFormatNamespace ( ) const
virtual

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 IImage.

◆ GetValidPayloadSize()

size_t GetValidPayloadSize ( ) const
virtual

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()
GetImageSize()
Returns
size_t value representing valid payload.

Implements IImage.

◆ GetWidth()

size_t GetWidth ( ) const
virtual

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 IImage.

◆ GetXOffset()

size_t GetXOffset ( ) const
virtual

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 IImage.

◆ GetXPadding()

size_t GetXPadding ( ) const
virtual

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 IImage.

◆ GetYOffset()

size_t GetYOffset ( ) const
virtual

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 IImage.

◆ GetYPadding()

size_t GetYPadding ( ) const
virtual

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 IImage.

◆ HasChunkData()

bool HasChunkData ( ) const
virtual

Checks if the image contains chunk data.

Returns
Returns true if image contains chunk data and false otherwise.

Implements IImage.

◆ HasCRC()

bool HasCRC ( ) const
virtual

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 IImage.

◆ IsCompressed()

bool IsCompressed ( ) const
virtual

Returns a boolean value indicating whether this image is compressed.

Returns
Returns true if image is compressed, false otherwise.

Implements IImage.

◆ IsIncomplete()

bool IsIncomplete ( ) const
virtual

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 IImage.

◆ IsInUse()

bool IsInUse ( )
virtual

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 IImage.

◆ Load()

static ImagePtr Load ( const char *  pFilename,
ImageFileFormat  format = SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT 
)
static

Loads the image from the specified file name with the options specified.

Parameters
pFilenameFilename to load image with.
formatFile format to save in.

◆ Release()

void Release ( )
virtual

Implements IImage.

◆ ResetImage() [1/3]

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

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
widthThe width of image in pixels to set.
heightThe height of image in pixels to set.
offsetXThe x offset in pixels to set.
offsetYThe y offset in pixels to set.
pixelFormatPixel format to set.
pDataPointer to the image buffer.
dataPayloadTypeThe payload type of the data. This value can be retrieved from an existing image by using the GetTLPayloadType() function call.
dataSizeThe size of the provided data in bytes
See also
GetTLPayloadType()

Implements IImage.

◆ ResetImage() [2/3]

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

Sets new dimensions of the image object and allocates memory.

Parameters
widthThe width of image in pixels to set.
heightThe height of image in pixels to set.
offsetXThe x offset in pixels to set.
offsetYThe y offset in pixels to set.
pixelFormatPixel format to set.

Implements IImage.

◆ ResetImage() [3/3]

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

Sets new dimensions of the image object.

Parameters
widthThe width of image in pixels to set.
heightThe height of image in pixels to set.
offsetXThe x offset in pixels to set.
offsetYThe y offset in pixels to set.
pixelFormatPixel format to set.
pDataPointer to the image buffer.

Implements IImage.

◆ Save() [1/9]

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

Saves the image to the specified file name with the options specified.

Parameters
pFilenameFilename to save image with.
pOptionOptions to use while saving image.

Implements IImage.

◆ Save() [2/9]

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

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
pFilenameFilename to save image with.
formatFile format to save in.

Implements IImage.

◆ Save() [3/9]

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

Saves the image to the specified file name with the options specified.

Parameters
pFilenameFilename to save image with.
pOptionOptions to use while saving image.

Implements IImage.

◆ Save() [4/9]

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

Saves the image to the specified file name with the options specified.

Parameters
pFilenameFilename to save image with.
pOptionOptions to use while saving image.

Implements IImage.

◆ Save() [5/9]

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

Saves the image to the specified file name with the options specified.

Parameters
pFilenameFilename to save image with.
pOptionOptions to use while saving image.

Implements IImage.

◆ Save() [6/9]

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

Saves the image to the specified file name with the options specified.

Parameters
pFilenameFilename to save image with.
pOptionOptions to use while saving image.

Implements IImage.

◆ Save() [7/9]

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

Saves the image to the specified file name with the options specified.

Parameters
pFilenameFilename to save image with.
pOptionOptions to use while saving image.

Implements IImage.

◆ Save() [8/9]

void Save ( const char *  pFilename,
SIOption pOption 
) const
virtual

Saves the image to the specified file name with the options specified.

Parameters
pFilenameFilename to save image with.
pOptionOptions to use while saving image.

Implements IImage.

◆ Save() [9/9]

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

Saves the image to the specified file name with the options specified.

Parameters
pFilenameFilename to save image with.
pOptionOptions to use while saving image.

Implements IImage.

Friends And Related Symbol Documentation

◆ IDataStream

friend class IDataStream
friend

◆ ImageConverter

friend class ImageConverter
friend

◆ ImageConverterIpp

friend class ImageConverterIpp
friend

◆ ImageFiler

friend class ImageFiler
friend

◆ ImageImpl

friend class ImageImpl
friend

◆ ImageListImpl

friend class ImageListImpl
friend

◆ ImageProcessorImpl

friend class ImageProcessorImpl
friend

◆ ImageStatsCalculator

friend class ImageStatsCalculator
friend

◆ ImageUtilityImpl

friend class ImageUtilityImpl
friend

◆ ImageUtilityPlanarImpl

friend class ImageUtilityPlanarImpl
friend

◆ ImageUtilityPolarizationImpl

friend class ImageUtilityPolarizationImpl
friend

◆ SpinnakerGPUImpl

friend class SpinnakerGPUImpl
friend

◆ Stream

friend class Stream
friend

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