The image object class. More...

Inheritance diagram for Image:

Public Member Functions
virtual	~Image ()
	Virtual destructor. More...

ColorProcessingAlgorithm	GetColorProcessing () const
	Gets the color algorithm used to produce the image. More...

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

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

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

void	Release ()

uint64_t	GetID () const
	Gets a unique ID for this image that is associated with a stream. More...

uint64_t	GetStreamIndex () const
	Gets the stream channel index of where the image is received. More...

void *	GetData () const
	Gets a pointer to the data associated with the image. More...

float	GetDataAbsoluteMax () const
	Get the value for which no image data will exceed. More...

float	GetDataAbsoluteMin () const
	Get the value for which no image data will be less than. More...

void *	GetPrivateData () const
	Gets a pointer to the user passed data associated with the image. More...

size_t	GetBufferSize () const
	Gets the size of the buffer associated with the image in bytes. More...

void	DeepCopy (const ImagePtr pSrcImage)
	Performs a deep copy of the Image. More...

size_t	GetWidth () const
	Gets the width of the image in pixels. More...

size_t	GetHeight () const
	Gets the height of the image in pixels. More...

size_t	GetStride () const
	Gets the stride of the image in bytes. More...

size_t	GetBitsPerPixel () const
	Gets the number of bits used per pixel in the image. More...

size_t	GetNumChannels () const
	Gets the number of channels (depth) used in the image. More...

size_t	GetXOffset () const
	Gets the ROI x offset in pixels for this image. More...

size_t	GetYOffset () const
	Gets the ROI y offset in pixels for this image. More...

size_t	GetXPadding () const
	Gets the x padding in bytes for this image. More...

size_t	GetYPadding () const
	Gets the y padding in bytes for this image. More...

uint64_t	GetFrameID () const
	Gets the frame ID for this image. More...

size_t	GetPayloadType () const
	Gets the payload type that was transmitted. More...

TLPayloadType	GetTLPayloadType () const
	Gets the GenTL specific payload type that was transmitted. More...

uint64_t	GetTLPixelFormat () const
	Gets the pixel format of the image. More...

TLPixelFormatNamespace	GetTLPixelFormatNamespace () const
	Returns an enum value that represents the namespace in which this image's TL specific pixel format resides. More...

GenICam::gcstring	GetPixelFormatName () const
	Returns a string value that represents this image's pixel format. More...

Spinnaker::PixelFormatEnums	GetPixelFormat () const
	Returns an enum value that represents the pixel format of this image. More...

Spinnaker::PixelFormatIntType	GetPixelFormatIntType () const
	Returns an enum value that represents the integer type used in the pixel format of this image. More...

bool	IsIncomplete () const
	Returns a boolean value indicating if this image was incomplete. More...

size_t	GetValidPayloadSize () const
	Returns the size of valid data in the image payload. More...

uint64_t	GetChunkLayoutId () const
	Returns the id of the chunk data layout. More...

uint64_t	GetTimeStamp () const
	Gets the time stamp for the image in nanoseconds. More...

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

void	Save (const char *pFilename, PNGOption &pOption) const
	Saves the image to the specified file name with the options specified. More...

void	Save (const char *pFilename, PPMOption &pOption) const
	Saves the image to the specified file name with the options specified. More...

void	Save (const char *pFilename, PGMOption &pOption) const
	Saves the image to the specified file name with the options specified. More...

void	Save (const char *pFilename, TIFFOption &pOption) const
	Saves the image to the specified file name with the options specified. More...

void	Save (const char *pFilename, JPEGOption &pOption) const
	Saves the image to the specified file name with the options specified. More...

void	Save (const char *pFilename, JPG2Option &pOption) const
	Saves the image to the specified file name with the options specified. More...

void	Save (const char *pFilename, BMPOption &pOption) const
	Saves the image to the specified file name with the options specified. More...

void	Save (const char *pFilename, SIOption &option) const
	Saves the image to the specified file name with the options specified. More...

bool	HasChunkData () const
	Checks if the image contains chunk data. More...

const ChunkData &	GetChunkData () const
	Returns a pointer to a chunk data interface. More...

void	CalculateStatistics (ImageStatistics &pStatistics)
	Retrieves a number of pixel statistics for an image including a histogram array of the range of pixel values. More...

bool	HasCRC () const
	Checks if the image contains ImageCRC checksum from chunk data. More...

bool	CheckCRC () const
	Checks if the computed checksum matches with chunk data's ImageCRC. More...

size_t	GetImageSize () const
	Returns the size of the image. More...

bool	IsInUse ()
	Returns true if the image is still in use by the stream. More...

ImageStatus	GetImageStatus () const
	Returns data integrity status of the image returned from GetNextImage() More...

bool	IsCompressed () const
	Returns a boolean value indicating whether this image is compressed. More...

Public Member Functions inherited from IImage
virtual	~IImage ()

Static Public Member Functions
static ImagePtr	Create ()
	Create an image object. More...

static ImagePtr	Create (const ImagePtr image)
	Create an image object that is a deep copy of the input image. More...

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

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

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

static const char *	GetImageStatusDescription (ImageStatus status)
	Returns a string describing the meaning of the status enum. More...

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

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

Detailed Description

The image object class.

Constructor & Destructor Documentation

virtual ~Image ( )

virtual

Virtual destructor.

Image ( )

protected

Image ( const ImagePtr image )

protected

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

protected

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

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

pStatistics The statistics of an image.

Implements IImage.

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.

static ImagePtr Create ( )

static

Create an image object.

Examples:: Compression.cpp, and FileAccess_Quickspin.cpp.

static ImagePtr Create ( const ImagePtr image )

static

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

Parameters

image The input image to copy

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

width	The image width in pixels
height	The image height in pixels
offsetX	The image X offset
offsetY	The image Y offset
pixelFormat	The image pixel format
pData	The image data

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

width	The image width in pixels
height	The image height in pixels
offsetX	The image X offset
offsetY	The image Y offset
pixelFormat	The image pixel format
pData	The compressed image data
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()

ImagePtr CreateShared ( ) const

protected

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

pSrcImage The Image to copy the data from.

Implements IImage.

void DeepCopy ( const Image & pSrcImage )

protected

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.

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.

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.

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.

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.

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.

float GetDataAbsoluteMax ( ) const

virtual

Get the value for which no image data will exceed.

Returns: the maximim theoretical image data value

Implements IImage.

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.

uint64_t GetFrameID ( ) const

virtual

Gets the frame ID for this image.

Returns: The frame ID.

Implements IImage.

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.

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.

ImageData* GetImageData ( ) const

protectedvirtual

Implements IImage.

size_t GetImageSize ( ) const

virtual

Returns the size of the image.

For non-chunk images, the value returned by this function represents the size of the image based on its resolution and pixel size.

For chunk images, only the size of chunk image portion is reported here. If the chunk image is compressed, the value returned represents the size of the compressed image data in bytes.

The entire chunk data payload can be queried by GetValidPayloadSize().

See Also: GetBufferSize(); GetValidPayloadSize()

Returns: The image size in bytes.

Implements IImage.

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.

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.

Examples:: Acquisition.cpp, and Compression.cpp.

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.

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.

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.

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.

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.

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.

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.

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.

uint64_t GetTimeStamp ( ) const

virtual

Gets the time stamp for the image in nanoseconds.

Returns: The time stamp of the image.

Implements IImage.

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.

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.

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.

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. The value returned here can be equal to the value returned by GetImageSize() if image data is the only payload. 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.

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.

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.

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.

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.

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.

bool HasChunkData ( ) const

virtual

Checks if the image contains chunk data.

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

Implements IImage.

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.

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.

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.

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.

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

pFilename	Filename to load image with.
pOption	Options to use while loading image.

void Release ( )

virtual

Implements IImage.

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

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

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

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

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

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

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

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

Implements IImage.

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

virtual