An ML module class for file caching and modification of a whole ML PagedImage volume as MLImageFormat file which is changed only if load, clear or auto load is activated. More...
#include <mlImageFormatFileCache.h>
Public Types | |
| enum | UPDATE_MODE { UPDATE_OFF = 0, UPDATE_AUTOUPDATE, UPDATE_AUTOCLEAR, UPDATE_MODE_NUM } |
| Enum to controls how input and parameter changes influence/update the result image. More... | |
Public Member Functions | |
| MLImageFormatFileCache () | |
| Constructor. | |
| virtual | ~MLImageFormatFileCache () |
| Destructor. | |
Provide access to module parameters, see documentation of corresponding members. | |
| BoolField & | getValidFld () const |
| NotifyField & | getLoadFld () const |
| NotifyField & | getUpdateRegionFld () const |
| NotifyField & | getClearFld () const |
| EnumField & | getAutoLoadFld () const |
| StringField & | getTmpFileNamePrefixFld () const |
Static Public Attributes | |
| static const char *const | UPDATE_MODE_NAMES [UPDATE_MODE_NUM] |
String constants corresponding to the UPDATE_MODE constants. | |
Protected Member Functions | |
Field and parameter handling | |
| virtual void | activateAttachments () |
| Update internal module state after load or clone. | |
| virtual void | handleNotification (Field *field) |
Handle field changes of the field field. | |
Image processing methods. | |
| virtual void | calculateOutputImageProperties (int outIndex) |
Sets properties of the output image at output outIndex. | |
| virtual Module::INPUT_HANDLE | handleInput (int, Module::INPUT_STATE) const |
| Enables usage of open or closed & undefined inputs by redirecting all accesses to open and undefined inputs to the dummy module. | |
| virtual SubImageBox | calculateInputSubImageBox (int, const SubImageBox &outSubImgBox, int) |
| Determines the data to be loaded from input image for page processing. | |
| virtual void | calculateOutputSubImage (SubImage *outSubImg, int outIndex, SubImage *inSubImgs) |
Calculates page outSubImg of output image with index outIndex by using inSubimgs. | |
Detailed Description
An ML module class for file caching and modification of a whole ML PagedImage volume as MLImageFormat file which is changed only if load, clear or auto load is activated.
Input changes can be hidden so that the volume can survive even if input changes.
Definition at line 40 of file mlImageFormatFileCache.h.
Member Enumeration Documentation
Enum to controls how input and parameter changes influence/update the result image.
- Enumerator:
UPDATE_OFF Do nothing on input changes.
UPDATE_AUTOUPDATE Update cached image and output (if possible) if input changes.
UPDATE_AUTOCLEAR Invalidate cached image if input changes.
UPDATE_MODE_NUM
Definition at line 45 of file mlImageFormatFileCache.h.
Constructor & Destructor Documentation
| ml::MLImageFormatFileCache::MLImageFormatFileCache | ( | ) |
Constructor.
| virtual ml::MLImageFormatFileCache::~MLImageFormatFileCache | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual void ml::MLImageFormatFileCache::activateAttachments | ( | ) | [protected, virtual] |
Update internal module state after load or clone.
Reimplemented from ml::MLImageFormatIOBase.
| virtual SubImageBox ml::MLImageFormatFileCache::calculateInputSubImageBox | ( | int | , |
| const SubImageBox & | outSubImgBox, | ||
| int | |||
| ) | [protected, virtual] |
Determines the data to be loaded from input image for page processing.
Reimplemented from ml::Module.
| virtual void ml::MLImageFormatFileCache::calculateOutputImageProperties | ( | int | outIndex | ) | [protected, virtual] |
Sets properties of the output image at output outIndex.
Reimplemented from ml::Module.
| virtual void ml::MLImageFormatFileCache::calculateOutputSubImage | ( | SubImage * | outSubImg, |
| int | outIndex, | ||
| SubImage * | inSubImgs | ||
| ) | [protected, virtual] |
Calculates page outSubImg of output image with index outIndex by using inSubimgs.
- Parameters:
-
outSubImg The subimage of output image outIndexcalculated frominSubImgs.outIndex The index of the output the subimage is calculated for. inSubImgs Array of subimage(s) of the input(s) whose extents were specified by calculateInputSubImageBox. Array size is given bygetNumInputImages().
Reimplemented from ml::Module.
| EnumField& ml::MLImageFormatFileCache::getAutoLoadFld | ( | ) | const [inline] |
Definition at line 67 of file mlImageFormatFileCache.h.
| NotifyField& ml::MLImageFormatFileCache::getClearFld | ( | ) | const [inline] |
Definition at line 66 of file mlImageFormatFileCache.h.
| NotifyField& ml::MLImageFormatFileCache::getLoadFld | ( | ) | const [inline] |
Definition at line 64 of file mlImageFormatFileCache.h.
| StringField& ml::MLImageFormatFileCache::getTmpFileNamePrefixFld | ( | ) | const [inline] |
Definition at line 68 of file mlImageFormatFileCache.h.
| NotifyField& ml::MLImageFormatFileCache::getUpdateRegionFld | ( | ) | const [inline] |
Definition at line 65 of file mlImageFormatFileCache.h.
| BoolField& ml::MLImageFormatFileCache::getValidFld | ( | ) | const [inline] |
Definition at line 63 of file mlImageFormatFileCache.h.
| virtual Module::INPUT_HANDLE ml::MLImageFormatFileCache::handleInput | ( | int | , |
| Module::INPUT_STATE | |||
| ) | const [protected, virtual] |
Enables usage of open or closed & undefined inputs by redirecting all accesses to open and undefined inputs to the dummy module.
Test for equality to DummyOp::getGlobalInstance() or its output image to check for invalid inputs.
Reimplemented from ml::Module.
| virtual void ml::MLImageFormatFileCache::handleNotification | ( | Field * | field | ) | [protected, virtual] |
Handle field changes of the field field.
Reimplemented from ml::MLImageFormatIOBase.
Member Data Documentation
const char* const ml::MLImageFormatFileCache::UPDATE_MODE_NAMES[UPDATE_MODE_NUM] [static] |
String constants corresponding to the UPDATE_MODE constants.
Definition at line 53 of file mlImageFormatFileCache.h.
The documentation for this class was generated from the following file:
- MeVisLab/Standard/Sources/ML/MLImageFormat/mlImageFormatFileCache.h
