Class Spinnaker::ImageList¶

ClassList > Spinnaker > ImageList

Used to hold a list of image objects.

#include <ImageList.h>

Inherits the following classes: Spinnaker::IImageList

Public Functions¶

Type	Name
virtual void	Add (ImagePtr image)
virtual void	Append (const ImageList & list)
virtual void	Clear ()
virtual ImagePtr	GetByIndex (unsigned int index) const
virtual ImagePtr	GetByPayloadType (const ImagePayloadType payloadType) const
virtual ImagePtr	GetByPixelFormat (PixelFormatEnums pixelFormat) const
virtual ImagePtr	GetByStreamIndex (const uint64_t streamIndex) const
virtual ImageList	GetImagesByPayloadType (const ImagePayloadType payloadType) const
virtual ImageList	GetImagesByPixelFormat (PixelFormatEnums pixelFormat) const
virtual unsigned int	GetSize () const
	ImageList (void)
	ImageList (const ImageList & iface)
virtual void	Release ()
virtual void	RemoveByIndex (unsigned int index)
virtual void	RemoveByPayloadType (const ImagePayloadType payloadType)
virtual void	RemoveByPixelFormat (PixelFormatEnums pixelFormat)
virtual void	RemoveByStreamIndex (const uint64_t streamIndex)
virtual void	Save (const char * filename)
ImageList &	operator= (const ImageList & iface)
virtual ImagePtr	operator[] (unsigned int index)
const ImagePtr	operator[] (unsigned int index) const
virtual	~ImageList (void)

Public Functions inherited from Spinnaker::IImageList¶

See Spinnaker::IImageList

Type	Name
virtual void	Add (ImagePtr image) = 0
virtual void	Append (const ImageList & list) = 0
virtual void	Clear () = 0
virtual ImagePtr	GetByIndex (unsigned int index) const = 0
virtual ImagePtr	GetByPayloadType (const ImagePayloadType payloadType) const = 0
virtual ImagePtr	GetByPixelFormat (PixelFormatEnums pixelFormat) const = 0
virtual ImagePtr	GetByStreamIndex (const uint64_t streamIndex) const = 0
virtual ImageList	GetImagesByPayloadType (const ImagePayloadType payloadType) const = 0
virtual ImageList	GetImagesByPixelFormat (PixelFormatEnums pixelFormat) const = 0
virtual unsigned int	GetSize () const = 0
virtual void	Release () = 0
virtual void	RemoveByIndex (unsigned int index) = 0
virtual void	RemoveByPayloadType (const ImagePayloadType payloadType) = 0
virtual void	RemoveByPixelFormat (PixelFormatEnums pixelFormat) = 0
virtual void	RemoveByStreamIndex (const uint64_t streamIndex) = 0
virtual void	Save (const char * filename) = 0
virtual ImagePtr	operator[] (unsigned int index) = 0
virtual	~IImageList (void)

Public Static Functions¶

Type	Name
ImageList	Load (const char * filename)

Protected Attributes inherited from Spinnaker::IImageList¶

See Spinnaker::IImageList

Type	Name
ImageListData *	m_pImageListData

Protected Functions inherited from Spinnaker::IImageList¶

See Spinnaker::IImageList

Type	Name
	IImageList ()
	IImageList (const IImageList &)
IImageList &	operator= (const IImageList &)

Public Functions Documentation¶

function Add¶

virtual void Spinnaker::ImageList::Add (
    ImagePtr image
)

Adds a copy of an image object.

Parameters:

image An image object to be added to this list.

Implements Spinnaker::IImageList::Add

function Append¶

virtual void Spinnaker::ImageList::Append (
    const ImageList & list
)

Appends a copy of the image list.

Parameters:

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

Implements Spinnaker::IImageList::Append

function Clear¶

virtual void Spinnaker::ImageList::Clear ()

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 Spinnaker::IImageList::Clear

function GetByIndex¶

virtual ImagePtr Spinnaker::ImageList::GetByIndex (
    unsigned int index
) const

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 Spinnaker::IImageList::GetByIndex

function GetByPayloadType¶

virtual ImagePtr Spinnaker::ImageList::GetByPayloadType (
    const ImagePayloadType payloadType
) const

Returns a pointer to an image object with the specified image payload type. This function will return a null image pointer 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 Spinnaker::IImageList::GetByPayloadType

function GetByPixelFormat¶

virtual ImagePtr Spinnaker::ImageList::GetByPixelFormat (
    PixelFormatEnums pixelFormat
) const

Returns a pointer to the first image object with the pixel format from the list. This function will return a null image pointer 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 Spinnaker::IImageList::GetByPixelFormat

function GetByStreamIndex¶

virtual ImagePtr Spinnaker::ImageList::GetByStreamIndex (
    const uint64_t streamIndex
) const

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 Spinnaker::IImageList::GetByStreamIndex

function GetImagesByPayloadType¶

virtual ImageList Spinnaker::ImageList::GetImagesByPayloadType (
    const ImagePayloadType payloadType
) const

Returns an ImageList containing all the images matching the specified image payload type. This function will return an empty list 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 Spinnaker::IImageList::GetImagesByPayloadType

function GetImagesByPixelFormat¶

virtual ImageList Spinnaker::ImageList::GetImagesByPixelFormat (
    PixelFormatEnums pixelFormat
) const

Returns an ImageList containing all imageList objects that match the pixel format provided. This function will return an empty list if no image with matching pixel format is found.

Parameters:

pixelFormat The pixel format of the Image object to retrieve

Returns:

An ImageList containing all matching image objects.

Implements Spinnaker::IImageList::GetImagesByPixelFormat

function GetSize¶

virtual unsigned int Spinnaker::ImageList::GetSize () const

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 Spinnaker::IImageList::GetSize

function ImageList [1/2]¶

Spinnaker::ImageList::ImageList (
    void
)

Default constructor.

function ImageList [2/2]¶

Spinnaker::ImageList::ImageList (
    const ImageList & iface
)

Copy constructor

function Release¶

virtual void Spinnaker::ImageList::Release ()

Implements Spinnaker::IImageList::Release

function RemoveByIndex¶

virtual void Spinnaker::ImageList::RemoveByIndex (
    unsigned int index
)

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 Spinnaker::IImageList::RemoveByIndex

function RemoveByPayloadType¶

virtual void Spinnaker::ImageList::RemoveByPayloadType (
    const ImagePayloadType payloadType
)

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 Spinnaker::IImageList::RemoveByPayloadType

function RemoveByPixelFormat¶

virtual void Spinnaker::ImageList::RemoveByPixelFormat (
    PixelFormatEnums pixelFormat
)

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 Spinnaker::IImageList::RemoveByPixelFormat

function RemoveByStreamIndex¶

virtual void Spinnaker::ImageList::RemoveByStreamIndex (
    const uint64_t streamIndex
)

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 Spinnaker::IImageList::RemoveByStreamIndex

function Save¶

virtual void Spinnaker::ImageList::Save (
    const char * filename
)

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 Spinnaker::IImageList::Save

function operator=¶

ImageList & Spinnaker::ImageList::operator= (
    const ImageList & iface
)

Assignment operator.

function operator[]¶

virtual ImagePtr Spinnaker::ImageList::operator[] (
    unsigned int index
)

Array subscription operators.

Implements Spinnaker::IImageList::operator[]

function operator[]¶

const ImagePtr Spinnaker::ImageList::operator[] (
    unsigned int index
) const

function ~ImageList¶

virtual Spinnaker::ImageList::~ImageList (
    void
)

Virtual destructor.

Public Static Functions Documentation¶

function Load¶

static ImageList Spinnaker::ImageList::Load (
    const char * filename
)

Creates an image list object from file.

Parameters:

filename Name of the file to load an image object from.

See also: Save()

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