MeVisLab Toolbox Reference
Static Public Member Functions | Static Public Attributes | List of all members
ml::ModuleTools Class 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. More...
 

Static Public Attributes

static const MLint MAX_NUM_PAGES_PER_IMAGE
 The current maximum number of pages results from estimating the sizes of structures, page pointer tables, etc., and understanding that multiple modules with paged images must fit into memory simultaneously. More...
 

Detailed Description

Class containing some helper functionality for Module programming and/or for the Module class itself.

Definition at line 31 of file mlModuleTools.h.

Member Function Documentation

◆ adaptPageExtent()

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 the input image), overwritten by new page extent
  • imageType: Data type of output image
  • newImageExtent: Extent of output image
  • oldImageExtent: Extent of input image
  • pageUnit: Page extent must be a multiple of this, or ImageVector(0) if do not care
  • minPageExtent: Minimum page extent, or ImageVector(0) if do not care
  • maxPageExtent: Maximum page extent, or ImageVector(0) if do not care

Member Data Documentation

◆ MAX_NUM_PAGES_PER_IMAGE

const MLint ml::ModuleTools::MAX_NUM_PAGES_PER_IMAGE
static

The current maximum number of pages results from estimating the sizes of structures, page pointer tables, etc., and understanding that multiple modules with paged images must fit into memory simultaneously.

It should not be much larger to prevent excessive memory usage, nor much smaller to ensure a sufficient number of pages per image.

Definition at line 40 of file mlModuleTools.h.

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