MeVisLab Toolbox Reference
Public Member Functions | List of all members
ml::PageIDIterator Class Reference

A class that allows to incrementally iterate over all ids of pages have an intersection with a given box on a given PagedImage. More...

#include <mlPageIDIterator.h>

Public Member Functions

MLEXPORT PageIDIterator ()
 Default Constructor.
 
MLEXPORT PageIDIterator (PagedImage &image, const SubImageBox &box)
 Constructor which calls setup() with given parameters.
 
MLEXPORT ~PageIDIterator ()
 Destructor.
 
MLEXPORT void setup (PagedImage &image, const SubImageBox &box)
 Sets up the iterator from the given image and box.
 
MLint getNextPageID ()
 Returns the next page id, may only be called as often as getNumPages() returns.
 
MLint getNumPages () const
 Returns the number of pages that are part of the box.
 

Detailed Description

A class that allows to incrementally iterate over all ids of pages have an intersection with a given box on a given PagedImage.

Definition at line 29 of file mlPageIDIterator.h.

Constructor & Destructor Documentation

◆ PageIDIterator() [1/2]

MLEXPORT ml::PageIDIterator::PageIDIterator ( )

Default Constructor.

◆ PageIDIterator() [2/2]

MLEXPORT ml::PageIDIterator::PageIDIterator ( PagedImage & image,
const SubImageBox & box )

Constructor which calls setup() with given parameters.

◆ ~PageIDIterator()

MLEXPORT ml::PageIDIterator::~PageIDIterator ( )

Destructor.

Member Function Documentation

◆ getNextPageID()

MLint ml::PageIDIterator::getNextPageID ( )
inline

Returns the next page id, may only be called as often as getNumPages() returns.

Definition at line 47 of file mlPageIDIterator.h.

References mlrange_cast().

◆ getNumPages()

MLint ml::PageIDIterator::getNumPages ( ) const
inline

Returns the number of pages that are part of the box.

Definition at line 97 of file mlPageIDIterator.h.

◆ setup()

MLEXPORT void ml::PageIDIterator::setup ( PagedImage & image,
const SubImageBox & box )

Sets up the iterator from the given image and box.

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