ILImageList Interface Reference

This interface defines a list of images. More...

Inheritance diagram for ILImageList:

Public Member Functions
void	Add (ILImage *img, ILRectRegion *region)
void	Adds (LArray< ILImage * > images)
ILImage *	Item (int imgIndex)
Public Member Functions inherited from ILObjects
int	Count ()
BOOL	Empty ()
ILObject *	ItemObject (int objIndex)
Public Member Functions inherited from ILObject
ILObject *	Copy ()
LPVErrorCode	Load (LString filename)
void	Reset ()
LPVErrorCode	Save (LString filename)
BOOL	Valid ()

Properties
int	MaxCount [get, set]
	The maximum number of the images, in 0 ~ 256. For example, if set to 16, it means we maintain a image cache of 16 size in the list. If more than the setting number of images are pushed into the list, the earlier ones will be popped. By default, it's 0, means no limitation.
BOOL	SameSize [get, set]
	Whether to uniform the image size in the list. By default, it's on. Using the first input size as baseline, we'll check the size of every subsequent inputs. If the size does not match, crop the input with the center aligned. The entire list is cleaned up, when the option is changed.
BOOL	UseCache [get, set]
	Whether to maintain a size-fixed image cache, which makes a copy of the input LImage object's data block. It is useful when you don't want to take care of the image data's life cycle. By default, it's off. The entire list is cleaned up, when the option is changed.

Detailed Description

This interface defines a list of images.

The list of images are usually used in multi-frame blending, HRD or image stitching tasks. It may also maintain a size-fixed cache to the store grabbed frames.

To use this interface, you should create a LImageList object.

Example Code

C++

ILImageListPtr img_list = LImageList::Create();
img_list->MaxCount = 3;
img_list->Add(frame1);
img_list->Add(frame2);
img_list->Add(frame3);
img_list->Add(frame4); // frame 1 is popped

C#

LImageList img_list = new LImageList();
img_list.MaxCount = 3;
img_list.Add(frame1);
img_list.Add(frame2);
img_list.Add(frame3);
img_list.Add(frame4); // frame 1 is popped

COM

ILImageListPtr img_list = LImageList::Create();
// or, ILImageListPtr img_list(__uuidof(LImageList)), for absence of built-in Create functions (before 2.2.0)
img_list->MaxCount = 3;
img_list->Add(frame1);
img_list->Add(frame2);
img_list->Add(frame3);
img_list->Add(frame4); // frame 1 is popped

Member Function Documentation

Add()

void Add	(	ILImage *	img,
		ILRectRegion *	region
	)

Push the supplied image to the end of the list.

Parameters

[in]	img	The input image.
[in]	region	The input region.

Adds()

void Adds

(

LArray< ILImage * >

images

)

Push the collection of images to the end of the list.

Parameters

[in]

images

The input images, should be a collection of LImage objects.

Item()

ILImage* Item

(

int

imgIndex

)

Fetch one image with the given index.

Parameters

[in]

imgIndex

The input index, it should be a 0-based number smaller than total count.

Return values

img	Return the image of given index.