ARLib::Graphics::ARImageSequence Class Reference

Class derived from std::vector for managing image sequences. More...

#include <arimagesequence.h>

List of all members.

Public Member Functions
bool	GetImage (int index, ARImage &image)
	Retrieves the specified image.
bool	Load (const char *filename)
	Initialises the ARImageSequence object from the passed filename.
int	GetCount ()
	Returns the number of files in the sequence.

---

Detailed Description

Class derived from std::vector for managing image sequences.

An image sequence is a sequence of image files that contain a sequence number in the filename. Valid file sequences are...

Sample001.tif Sample002.tif Sample003.tif etc

or

Sample1.tif Sample2.tif Sample3.tif etc

The following are invalid sequences...

2DSample001.tif 2DSample002.tif 2DSample003.tif (Two numeric elements in filename)

or

SampleA.tif SampleB.tif SampleC.tif (No numeric element)

---

Member Function Documentation

bool ARImageSequence::GetImage (  int  index, ARImage &  image )

Retrieves the specified image. Parameters: index  The index of the image to retrieve. Must be in the range 1 to size(). image  The ARImage object to be loaded. Returns: True if successfully loaded otherwise false.

bool ARImageSequence::Load (  const char *  filename  )

Initialises the ARImageSequence object from the passed filename. Parameters: filename  The first file in the sequence. Returns: True if successful otherwise false.

---

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

• arimagesequence.h
• arimagesequence.cpp

---