ImageList Class Reference

Used to hold a list of image objects. More...

#include <ImageList.h>

Inheritance diagram for ImageList:

Public Member Functions
	ImageList (void)
	Default constructor.
virtual	~ImageList (void)
	Virtual destructor.
	ImageList (const ImageList &iface)
	Copy constructor.
ImageList &	operator= (const ImageList &iface)
	Assignment operator.
ImagePtr	operator[] (unsigned int index)
	Array subscription operators.
const ImagePtr	operator[] (unsigned int index) const
void	Release ()
unsigned int	GetSize () const
	Returns the size of the image list.
ImagePtr	GetByIndex (unsigned int index) const
	Returns a pointer to an image object at the "index".
ImagePtr	GetByPixelFormat (PixelFormatEnums pixelFormat) const
	Returns a pointer to the first image object with the pixel format from the list.
ImagePtr	GetByStreamIndex (const uint64_t streamIndex) const
	Returns a pointer to an image object with the specified stream index.
ImagePtr	GetByPayloadType (const ImagePayloadType payloadType) const
	Returns a pointer to an image object with the specified image payload type.
void	Clear ()
	Clears the list of images and destroys their corresponding reference counted objects.
void	Add (ImagePtr image)
	Adds a copy of an image object.
void	RemoveByIndex (unsigned int index)
	Removes an image at "index" and destroys its corresponding reference counted object.
void	RemoveByPixelFormat (PixelFormatEnums pixelFormat)
	Removes an image object with the image pixel format from the list.
void	RemoveByStreamIndex (const uint64_t streamIndex)
	Removes an image object with the stream index from the list.
void	RemoveByPayloadType (const ImagePayloadType payloadType)
	Removes an image object with the specified payload type from the list.
void	Append (const ImageList &list)
	Appends a copy of the image list.
void	Save (const char *filename)
	Saves an image list as an object to a file.
Public Member Functions inherited from IImageList
virtual	~IImageList (void)
virtual ImagePtr	operator[] (unsigned int index)=0
virtual unsigned int	GetSize () const =0
virtual ImagePtr	GetByIndex (unsigned int index) const =0
virtual ImagePtr	GetByPixelFormat (PixelFormatEnums pixelFormat) const =0
virtual ImagePtr	GetByStreamIndex (const uint64_t streamIndex) const =0
virtual ImagePtr	GetByPayloadType (const ImagePayloadType payloadType) const =0
virtual void	Clear ()=0
virtual void	RemoveByIndex (unsigned int index)=0
virtual void	RemoveByPixelFormat (PixelFormatEnums pixelFormat)=0
virtual void	RemoveByStreamIndex (const uint64_t streamIndex)=0
virtual void	RemoveByPayloadType (const ImagePayloadType payloadType)=0
virtual void	Append (const ImageList &list)=0
virtual void	Add (ImagePtr image)=0
virtual void	Release ()=0
virtual void	Save (const char *filename)=0

Static Public Member Functions
static ImageList	Load (const char *filename)
	Creates an image list object from file.

Additional Inherited Members
Protected Member Functions inherited from IImageList
	IImageList ()
	IImageList (const IImageList &)
IImageList &	operator= (const IImageList &)
Protected Attributes inherited from IImageList
ImageListData *	m_pImageListData

Detailed Description

Used to hold a list of image objects.

Examples

StereoAcquisition.cpp, StereoAcquisition_QuickSpin.cpp, and StereoGPIO.cpp.

Constructor & Destructor Documentation

ImageList() [1/2]

ImageList

(

void

)

Default constructor.

~ImageList()

virtual ~ImageList ( void  )

virtual

Virtual destructor.

ImageList() [2/2]

ImageList

(

const ImageList &

iface

)

Copy constructor.

Member Function Documentation

Add()

void Add ( ImagePtr  image )

virtual

Adds a copy of an image object.

Parameters

image

An image object to be added to this list.

Implements IImageList.

Append()

void Append ( const ImageList &  list )

virtual

Appends a copy of the image list.

Parameters

list	Another ImageList object, whose elements are added to this list.

Implements IImageList.

Clear()

void Clear ( )

virtual

Clears the list of images and destroys their corresponding reference counted objects.

This is necessary in order to clean up the parent interface. It is important that the camera list is destroyed or is cleared before calling system->ReleaseInstance() or else the call to system->ReleaseInstance() will result in an error message thrown that a reference to the camera is still held.

See also

System::ReleaseInstance()

Implements IImageList.

GetByIndex()

ImagePtr GetByIndex ( unsigned int  index ) const

virtual

Returns a pointer to an image object at the "index".

This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.

Parameters

index

The index at which to retrieve the Image object

Returns

A pointer to an image object.

Implements IImageList.

GetByPayloadType()

ImagePtr GetByPayloadType ( const ImagePayloadType  payloadType ) const

virtual

Returns a pointer to an image object with the specified image payload type.

This function will return a NULL ImagePtr if no image with matching image payload type is found.

Parameters

payloadType

The stream index of the Image object to retrieve

Returns

A pointer to a image object.

Implements IImageList.

Examples

StereoAcquisition.cpp, and StereoAcquisition_QuickSpin.cpp.

GetByPixelFormat()

ImagePtr GetByPixelFormat ( PixelFormatEnums  pixelFormat ) const

virtual

Returns a pointer to the first image object with the pixel format from the list.

This function will return a NULL ImagePtr if no image with matching pixel format is found.

Parameters

pixelFormat

The pixel format of the Image object to retrieve

Returns

A pointer to an image object.

Implements IImageList.

GetByStreamIndex()

ImagePtr GetByStreamIndex ( const uint64_t  streamIndex ) const

virtual

Returns a pointer to an image object with the specified stream index.

This function will return a NULL ImagePtr if no image with matching stream index is found.

Parameters

streamIndex

The stream index of the Image object to retrieve

Returns

A pointer to a image object.

Implements IImageList.

GetSize()

unsigned int GetSize ( ) const

virtual

Returns the size of the image list.

The size is the number of Image objects stored in the list.

Returns

An integer that represents the list size.

Implements IImageList.

Load()

static ImageList Load ( const char *  filename )

static

Creates an image list object from file.

Parameters

filename

Name of the file to load an image object from.

See also

Save()

operator=()

ImageList & operator=

(

const ImageList &

iface

)

Assignment operator.

operator[]() [1/2]

ImagePtr operator[] ( unsigned int  index )

virtual

Array subscription operators.

Implements IImageList.

operator[]() [2/2]

const ImagePtr operator[]

(

unsigned int

index

)

const

Release()

void Release ( )

virtual

Implements IImageList.

RemoveByIndex()

void RemoveByIndex ( unsigned int  index )

virtual

Removes an image at "index" and destroys its corresponding reference counted object.

This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.

Parameters

index

The index at which to remove the Image object

Implements IImageList.

RemoveByPayloadType()

void RemoveByPayloadType ( const ImagePayloadType  payloadType )

virtual

Removes an image object with the specified payload type from the list.

This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the list does not have any image with the specified payload type.

Parameters

payloadType

The payload type of the Image object to retrieve

Implements IImageList.

RemoveByPixelFormat()

void RemoveByPixelFormat ( PixelFormatEnums  pixelFormat )

virtual

Removes an image object with the image pixel format from the list.

This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the list does not have any image with the specified pixel format.

Parameters

pixelFormat

The pixel format of the image object to remove

Implements IImageList.

RemoveByStreamIndex()

void RemoveByStreamIndex ( const uint64_t  streamIndex )

virtual

Removes an image object with the stream index from the list.

This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the list does not have any image with the specified stream index.

Parameters

streamIndex

The stream index of the Image object to retrieve

Implements IImageList.

Save()

void Save ( const char *  filename )

virtual

Saves an image list as an object to a file.

Parameters

filename

Name of the file to save the current image list object to. It is recommended to use the file extension 'sil'.

See also

Load()

Implements IImageList.

---

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

• include/ImageList.h