ML Reference
|
Class containing some helper functionality for Module programming and/or for the Module class itself. More...
#include <mlModuleTools.h>
Static Public Member Functions | |
static void | adaptPageExtent (ImageVector &pageExtent, MLDataType imageType, const ImageVector &newImageExtent, const ImageVector &oldImageExtent, const ImageVector &pageUnit=ImageVector(0), const ImageVector &minPageExtent=ImageVector(0), const ImageVector &maxPageExtent=ImageVector(0)) |
Adapt page extent. | |
Deprecated | |
static void | adaptPageExt (ImageVector &pageExt, MLDataType imgType, const ImageVector &newImgExt, const ImageVector &oldImgExt, const ImageVector &pageUnit=ImageVector(0), const ImageVector &minPageExt=ImageVector(0), const ImageVector &maxPageExt=ImageVector(0)) |
Static Public Attributes | |
static const MLint | MAX_NUM_PAGES_PER_IMAGE |
Currently used maximum number of pages. |
Class containing some helper functionality for Module programming and/or for the Module class itself.
Definition at line 30 of file mlModuleTools.h.
static void ml::ModuleTools::adaptPageExt | ( | ImageVector & | pageExt, |
MLDataType | imgType, | ||
const ImageVector & | newImgExt, | ||
const ImageVector & | oldImgExt, | ||
const ImageVector & | pageUnit = ImageVector(0) , |
||
const ImageVector & | minPageExt = ImageVector(0) , |
||
const ImageVector & | maxPageExt = ImageVector(0) |
||
) | [inline, static] |
Definition at line 68 of file mlModuleTools.h.
static void ml::ModuleTools::adaptPageExtent | ( | ImageVector & | pageExtent, |
MLDataType | imageType, | ||
const ImageVector & | newImageExtent, | ||
const ImageVector & | oldImageExtent, | ||
const ImageVector & | pageUnit = ImageVector(0) , |
||
const ImageVector & | minPageExtent = ImageVector(0) , |
||
const ImageVector & | maxPageExtent = ImageVector(0) |
||
) | [static] |
Adapt page extent.
Arguments are:
pageExtent:
Suggested page extent (e.g,. of input image), overwritten by new page extentimageType:
Data type of output imagenewImageExtent:
Extent of output imageoldImageExtent:
Extent of input imagepageUnit:
Page extent must be a multiple of this, or ImageVector(0) if do not careminPageExtent:
Minimum page extent, or ImageVector(0) if do not caremaxPageExtent:
Maximum page extent, or ImageVector(0) if do not care const MLint ml::ModuleTools::MAX_NUM_PAGES_PER_IMAGE [static] |
Currently used maximum number of pages.
It is a result from an estimation of currently used sizes of structures, page pointer tables etc. and the knowledge that quite a number of modules with paged images must fit into memory at the same time. Thus it should not be much larger to avoid too much memory usage and not much smaller to avoid that number of pages per image is too small.
Definition at line 41 of file mlModuleTools.h.