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>

Inheritance diagram for ml::MLImageFormatFileCache:

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 Types inherited from ml::MLImageFormatIOBase
enum	{ NumUserTags = 10 }

Public Types inherited from ml::Module
enum	PERMITTED_TYPES { ONLY_SCALAR_TYPES , ONLY_DEFAULT_TYPES , ALL_REGISTERED_TYPES }
	See documentation of setVoxelDataTypeSupport. More...

enum	INPUT_STATE { DISCONNECTED = 0 , CONNECTED_BUT_INVALID = 1 , CONNECTED_AND_VALID = 2 , CONNECTED_BUT_NEEDS_UPDATE = 3 }
	See documentation of handleInput. More...

enum	INPUT_HANDLE { INVALIDATE = 0 , ALLOW_INVALID_INPUT = 2 }
	See documentation of handleInput. More...

Public Types inherited from ml::Base
enum	PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
	This enum describes the different persistence interfaces available. More...

Public Member Functions
	MLImageFormatFileCache ()
	Constructor.

	~MLImageFormatFileCache () override
	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

Public Member Functions inherited from ml::MLImageFormatIOBase
	MLImageFormatIOBase (int numIns=0, int numOuts=0)
	Constructor for a module with numIns inputs and numOuts outputs.

	~MLImageFormatIOBase () override
	Destroy local members and this.

MLImageFormatTagList	getUserTagList () const
	Create and return a list of user tags from the userTagFlds array which is to be stored in the file.

virtual void	updateUserTagFieldsFromLoader (const MLImageFormat &loader)
	Set user tag fields to the state given by the passed loader object.

virtual void	updateTagListFieldFromLoader (const MLImageFormat &loader)
	Set tag list field to the state given by the passed loader object.

Public Member Functions inherited from ml::Module
MLMetaProfilePtr &	getMetaProfile () const
	Returns the metaprofile for the base operator.

const char *	getTypeNameFast () const
	Macro to declare methods for the ML runtime type system (see mlRuntimeSubClass.h).

	Module (int numInputImages, int numOutputImages)
	Constructor: Initializes `numInputImages` input images and `numOutputImages` output images of the module.

	~Module () override
	Destructor: Destroys this module.

InputConnectorField *	getInputImageField (MLint i) const
	Returns the field representing input image `i`. `i` must be a valid index.

OutputConnectorField *	getOutputImageField (MLint i=0) const
	Returns the field representing output image `i`. `i` must be a valid index.

MLint	getNumInputImages () const
	Returns the number of input images of this module.

MLint	getNumOutputImages () const
	Returns the number of output images of this module.

PagedImage *	getOutputImage (MLint outputIndex=0) const
	Returns the output image `outputIndex`. The index needs to be in the range [0, getNumOutputImages()-1].

InputConnectorField *	addInputImage (const char *name=nullptr)
	Adds a new input image with `name` to the module.

OutputConnectorField *	addOutputImage (const char *name=nullptr)
	Adds a new output image with `name` to the module.

PagedImage *	getInputImage (MLint inputIndex, bool getReal=false) const
	Returns the output image of the module connected to input `inputIndex`.

PagedImage *	getUpdatedInputImage (MLint inputIndex, bool getReal=false) const
	Convenience method for a safe access to the input image at index `inputIndex`.

MLErrorCode	processAllPages (int outputIndex=-1, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
	Processes all pages of a module for easy implementation of page-based image processing of complete images.

MLErrorCode	processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
	Processes input images with a ProcessAllPagesHandler `handler` on a temporary output image (which allocates no data).

MLErrorCode	processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
	Processes all missing pages on the given output image.

void	clearOutputImage (MLint i=0)
	Clears cached output image pages of output image `i`.

MLint	getOutputImageInplace (MLint outputIndex=0) const
	Returns the optimization flag: returns the index of input image whose input tile is used also as output page for output `outputIndex` in calculateOutputSubImage() (instead of allocating its own memory).

MLint	getBypass (MLint outputIndex=0) const
	Returns the currently bypass index or -1 if bypassing if disabled (default).

THREAD_SUPPORT	getThreadSupport () const
	Returns the multithreading mode supported by this module, default is NO_THREAD_SUPPORT.

bool	areRecursiveHandleNotificationsPermitted () const
	Returns whether recursive entries in handleNotification are permitted.

MLint	getHandleNotificationEntryCounter () const
	A counter returning the current number of (recursive re-)entries in handleNotification.

PERMITTED_TYPES	getVoxelDataTypeSupport () const
	Returns the current state of supported voxel datatypes.

bool	isSupportedVoxelDataType (MLDataType dt) const
	Checks whether a given data type is supported on the module as configured with setVoxelDataTypeSupport.

INPUT_STATE	getInputState (MLint index)
	Returns the current state of the input connection.

INPUT_STATE	getUpdatedInputState (MLint index)
	Returns the updated state of the input image by calling updateImageProperties(index) and returning getInputState(index) afterwards.

bool	isInputImageField (Field *field) const
	Returns whether the given field is an input image field.

void	touchOutputImageFields () const
	Touches all output image fields to indicate that the images have changed.

virtual void	beginSaveFields ()
	Called before all fields data contents of this modules are saved.

virtual void	endSaveFields ()
	Called after saving all field contents of this module.

Public Member Functions inherited from ml::FieldContainer
	FieldContainer ()
	Constructor.

	~FieldContainer () override
	Destructor: Deletes all added fields.

std::string	whoAmI (bool withInstanceName=true) const
	Returns the type and the instance name of format 'ClassTypeName(instanceName)' if the instance name is not empty and `withInstanceName` is `true`.

Field *	addField (const char name, const char type, const char *value)
	Adds a new field with name `name`, type `type`, and value `value` (encoded as string) to the container.

Field *	addField (Field *field)
	Adds a `field`, the ownership of the field is passed to the FieldContainer.

BoolField *	addBool (const char *name)
	Creates a BoolField with `name` and adds it to the container. Default value is `false`.

BoolField *	addBool (const char *name, bool value)
	Creates a BoolField with `name` and adds it to the container.

IntField *	addInt (const char *name)
	Creates an IntField with `name` and adds it to the container. Default value is 0.

IntField *	addInt (const char *name, MLint value)
	Creates an IntField with `name` and adds it to the container.

EnumField *	addEnum (const char name, const char const *enumerationItemNames, MLint numEnumerationItems)
	Creates an EnumField field with `name` and adds it to the container.

EnumField *	addEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
	Creates an EnumField field with `name` and adds it to the container.

template<typename EnumType >
TypedEnumField< EnumType > *	addEnum (const char *name, const EnumValues< EnumType > &values, EnumType initialValue)
	Creates a TypedEnumField field with `name` and adds it to the container.

FloatField *	addFloat (const char *name)
	Creates a FloatField with `name` and adds it to the container. Default value is 0.f.

FloatField *	addFloat (const char *name, float value)
	Creates a FloatField with `name` and adds it to the container.

ProgressField *	addProgress (const char *name)
	Creates a float ProgressField with `name` and adds it to the container. Default value is 0.f.

ProgressField *	addProgress (const char *name, float value)
	Creates a float ProgressField with `name` and adds it to the container.

DoubleField *	addDouble (const char *name)
	Creates a DoubleField with `name` and adds it to the container. Default value is 0.

DoubleField *	addDouble (const char *name, double value)
	Creates a DoubleField with `name` and adds it to the container.

StringField *	addString (const char *name)
	Creates a StringField with `name` and adds it to the container. Default value is empty string.

StringField *	addString (const char *name, const std::string &value)
	Creates a StringField with `name` and adds it to the container.

NotifyField *	addNotify (const char *name)
	Creates a NotifyField field with `name` and adds it to the container.

TriggerField *	addTrigger (const char *name)
	Creates a TriggerField field with `name` and adds it to the container.

BaseField *	addBase (const char *name)
	Creates a Base field with `name` and adds it to the container. Default value is NULL.

BaseField *	addBase (const char name, Base value)
	Creates a Base field with `name` and adds it to the container.

BaseField *	addBase (const char *name, const RefCountedBasePtr &value)
	Creates a Base field with `name` and adds it to the container. Sets the value from intrusive pointer.

template<typename T >
BaseField *	addBaseWithAllowedType (const char name, T value=nullptr)
	As above, but also sets the allowed type of the field.

template<typename T >
BaseField *	addBaseWithAllowedType (const char *name, const ::boost::intrusive_ptr< T > &value)
	As above, but also sets the allowed type of the field.

template<typename T >
TypedBaseField< T > *	addTypedBase (const char *name)
	Creates a TypedBaseField with `name` and adds it to the container. Default value is NULL.

template<typename T >
TypedBaseField< T > *	addTypedBase (const char name, T value)
	Creates a TypedBaseField with `name` and adds it to the container.

template<typename T >
TypedBaseField< T > *	addTypedBase (const char *name, const ::boost::intrusive_ptr< T > &value)
	Creates a TypedBaseField with `name` and adds it to the container. Sets the value from intrusive pointer.

SoNodeField *	addSoNode (const char *name)
	Creates a SoNodeField with `name` and adds it to the container. Default value is NULL.

SoNodeField *	addSoNode (const char name, SoNode value)
	Creates a SoNodeField with `name` and adds it to the container.

PointerField *	addPointer (const char *name)
	Creates a PointerField with `name` and adds it to the container.

Vector2Field *	addVector2 (const char *name)
	Creates a Vector2Field with `name` and adds it to the container.

Vector2Field *	addVector2 (const char *name, const Vector2 &value)
	Creates a Vector2Field with `name` and adds it to the container.

Vector2Field *	addVector2 (const char *name, double x, double y)
	Creates a Vector2Field with `name` and adds it to the container.

Vector3Field *	addVector3 (const char *name)
	Creates a Vector3Field with `name` and adds it to the container.

Vector3Field *	addVector3 (const char *name, const Vector3 &value)
	Creates a Vector3Field with `name` and adds it to the container.

Vector3Field *	addVector3 (const char *name, double x, double y, double z)
	Creates a Vector3Field with `name` and adds it to the container.

Vector4Field *	addVector4 (const char *name)
	Creates a Vector4Field with `name` and adds it to the container.

Vector4Field *	addVector4 (const char *name, const Vector4 &value)
	Creates a Vector4Field with `name` and adds it to the container.

Vector4Field *	addVector4 (const char *name, double x, double y, double z, double w)
	Creates a Vector4Field with `name` and adds it to the container.

Vector5Field *	addVector5 (const char *name)
	Creates a Vector5Field with `name` and adds it to the container.

Vector5Field *	addVector5 (const char *name, const Vector5 &value)
	Creates a Vector5Field with `name` and adds it to the container.

Vector6Field *	addVector6 (const char *name)
	Creates a Vector6Field with `name` and adds it to the container.

Vector6Field *	addVector6 (const char *name, const Vector6 &value)
	Creates a Vector6Field with `name` and adds it to the container.

Vector10Field *	addVector10 (const char *name)
	Creates a Vector10Field with `name` and adds it to the container.

Vector10Field *	addVector10 (const char *name, const Vector10 &value)
	Creates a Vector10Field with `name` and adds it to the container.

ImageVectorField *	addImageVector (const char *name)
	Creates a ImageVectorField with `name` and adds it to the container.

ImageVectorField *	addImageVector (const char *name, const ImageVector &value)
	Creates a ImageVectorField with `name` and adds it to the container.

ImageVectorField *	addImageVector (const char *name, MLint x, MLint y, MLint z, MLint c, MLint t, MLint u)
	Creates a ImageVectorField with `name` and adds it to the container.

SubImageBoxField *	addSubImageBox (const char *name)
	Creates a SubImageBoxField with `name` and adds it to the container.

SubImageBoxField *	addSubImageBox (const char *name, const SubImageBox &value)
	Creates a SubImageBoxField with `name` and adds it to the container.

SubImageBoxdField *	addSubImageBoxd (const char *name)
	Creates a SubImageBoxd field with `name` and adds it to the container.

SubImageBoxdField *	addSubImageBoxd (const char *name, const SubImageBoxd &value)
	Creates a SubImageBoxd field with `name` and adds it to the container.

ColorField *	addColor (const char *name)
	Creates a ColorField with `name` and adds it to the container.

ColorField *	addColor (const char *name, float r, float g, float b)
	Creates a ColorField with `name` and adds it to the container.

ColorField *	addColor (const char *name, const Vector3 &value)
	Creates a ColorField with `name` and adds it to the container.

PlaneField *	addPlane (const char *name)
	Creates a PlaneField with `name` and adds it to the container.

PlaneField *	addPlane (const char *name, double f0, double f1, double f2, double f3)
	Creates a PlaneField with `name` and adds it to the container.

PlaneField *	addPlane (const char *name, const Plane &value)
	Creates a PlaneField with `name` and adds it to the container.

RotationField *	addRotation (const char *name)
	Creates a RotationField with `name` and adds it to the container.

RotationField *	addRotation (const char *name, const Rotation &value)
	Creates a RotationField with `name` and adds it to the container.

Matrix2Field *	addMatrix2 (const char *name)
	Creates a Matrix2Field with `name` and adds it to the container.

Matrix2Field *	addMatrix2 (const char *name, const Matrix2 &value)
	Creates a Matrix2Field with `name` and adds it to the container.

Matrix3Field *	addMatrix3 (const char *name)
	Creates a Matrix3Field with `name` and adds it to the container.

Matrix3Field *	addMatrix3 (const char *name, const Matrix3 &value)
	Creates a Matrix3Field with `name` and adds it to the container.

Matrix4Field *	addMatrix4 (const char *name)
	Creates a Matrix4Field with `name` and adds it to the container.

Matrix4Field *	addMatrix4 (const char *name, const Matrix4 &value)
	Creates a Matrix4Field with `name` and adds it to the container.

Matrix5Field *	addMatrix5 (const char *name)
	Creates a Matrix5Field with `name` and adds it to the container.

Matrix5Field *	addMatrix5 (const char *name, const Matrix5 &value)
	Creates a Matrix5Field with `name` and adds it to the container.

Matrix6Field *	addMatrix6 (const char *name)
	Creates a Matrix6Field with `name` and adds it to the container.

Matrix6Field *	addMatrix6 (const char *name, const Matrix6 &value)
	Creates a Matrix6Field with `name` and adds it to the container.

MatrixField *	addMatrix (const char *name)
	Creates a MatrixField with `name` and adds it to the container.

MatrixField *	addMatrix (const char *name, const Matrix4 &value)
	Creates a MatrixField with `name` and adds it to the container.

MLDataTypeField *	addMLDataType (const char *name)
	Creates a MTDataTypeField with `name` and adds it to the container.

MLDataTypeField *	addMLDataType (const char *name, MLDataType value)
	Creates a MTDataTypeField with `name` and adds it to the container.

UniversalTypeField *	addUniversalType (const char *name)
	Creates an UniversalTypeField field with `name` and adds it to the container.

IntListField *	addIntList (const char *name)
	Creates an IntListField field with `name` and empty list value and adds it to the container.

IntListField *	addIntList (const char *name, const std::vector< MLint > &value)
	Creates an IntListField field with `name` and given list value and adds it to the container.

DoubleListField *	addDoubleList (const char *name)
	Creates an DoubleListField field with `name` and empty list value and adds it to the container.

DoubleListField *	addDoubleList (const char *name, const std::vector< double > &value)
	Creates an DoubleListField field with `name` and given list value and adds it to the container.

Vector2ListField *	addVector2List (const char *name)
	Creates an Vector2ListField field with `name` and empty list value and adds it to the container.

Vector2ListField *	addVector2List (const char *name, const std::vector< Vector2 > &value)
	Creates an Vector2ListField field with `name` and given list value and adds it to the container.

Vector3ListField *	addVector3List (const char *name)
	Creates an Vector3ListField field with `name` and empty list value and adds it to the container.

Vector3ListField *	addVector3List (const char *name, const std::vector< Vector3 > &value)
	Creates an Vector3ListField field with `name` and given list value and adds it to the container.

Vector4ListField *	addVector4List (const char *name)
	Creates an Vector4ListField field with `name` and empty list value and adds it to the container.

Vector4ListField *	addVector4List (const char *name, const std::vector< Vector4 > &value)
	Creates an Vector4ListField field with `name` and given list value and adds it to the container.

size_t	getNumFields () const
	Returns the number of added fields.

bool	hasField (const std::string &name) const
	Returns `true` if the field with name `name` exists; otherwise, `false` is returned.

Field *	getField (const std::string &name) const
	Returns the pointer to the field with name `name`.

Field *	getField (MLint index) const
	Returns pointer of field at `index` if it exists. If not, -1 is returned.

MLint	getFieldIndex (Field *field) const
	Returns index of `field` if it exists. If not, -1 is returned.

void	setFieldStringValue (const std::string &name, const std::string &value)
	Sets the `value` of the field with `name` if it exists.

std::string	getFieldStringValue (const std::string &name) const
	Returns the string value of the field with `name` if it is found.

virtual void	deactivateAttachments ()
	Disables notification handling, i.e., all fields of this module will not send notifications to attached sensors and fields anymore if their values are set or changed.

Public Member Functions inherited from ml::Base
	Base ()
	Constructor.

virtual	~Base ()
	Destructor.

virtual Base *	deepCopy () const
	Creates a deep copy of the given object.

bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Checks whether this object's type is equal to or derived from one of the types given in the argument.

virtual bool	isRefCountedBase () const
	Returns whether the instance is derived from RefCountedBase.

virtual std::string	detailString () const
	Returns a string describing this object.

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class.

virtual std::string	persistentState () const
	Returns a string describing the object's internal state.

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using persistentState().

virtual void	addStateToTree (TreeNode *) const
	Attaches the object state as children of the given parent node.

virtual void	readStateFromTree (TreeNode *)
	Reads the object state from the children of the given parent node.

virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Writes the objects state to the data stream object.

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Reads the objects state from the data stream object.

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
void	activateAttachments () override
	Update internal module state after load or clone.

void	handleNotification (Field *field) override
	Handle field changes of the field `field`.

Image processing methods.
void	calculateOutputImageProperties (int outputIndex, PagedImage *outputImage) override
	Sets properties of the output image at output `outIndex`.

Module::INPUT_HANDLE	handleInput (int, Module::INPUT_STATE) const override
	Allow invalid input images.

SubImageBox	calculateInputSubImageBox (int, const SubImageBox &outSubImgBox, int) override
	Determines the data to be loaded from input image for page processing.

void	calculateOutputSubImage (SubImage outSubImg, int outIndex, SubImage inSubImgs) override
	Calculates page `outSubImg` of output image with index `outIndex` by using `inSubimgs`.

Protected Member Functions inherited from ml::MLImageFormatIOBase
void	activateAttachments () override
	Update internal module state after (field)reload or clone.

void	handleNotification (Field *field) override
	Handle field changes of the field `field`.

MLImageFormatCompressionParams &	_getCompressorParams ()

BoolField &	_getIsSavingFld ()

const StringField &	_getTrueFileNameFld () const

const NotifyField &	_getStopFld () const

NotifyField &	_getRemoveFld () const

const StringField &	_getStatusFld () const

const ProgressField &	_getProgressFld () const

const StringField &	_getTagListFld () const

StringField const	_getUserTagFlds () const

StringField &	_getNonConstTagListFld () const

StringField **	_getNonConstUserTagFlds ()

ImageVectorField &	_getRegionOffsetFld () const

BoolField &	_getSuppressWorldPosFld () const

virtual void	_setStatus (std::string str="", float progress=0.0, MLErrorCode err=ML_RESULT_OK)
	Update the status and progress field.

virtual void	_setProgress (float progressVal)
	Sets the value of the progressFld to progressVal.

virtual void	_resetTagFields ()
	Reset tag list field and user tag fields to empty strings.

virtual bool	_setDefaultCompressor (const std::string &defaultCompName)
	Set up a default compressor with name defaultCompName if it is available in the currently registered compressors and returns true.

virtual void	_remove (const std::string &fileName, bool updateStatus)
	Remove the field specified by fileName and update the status field with success information if updateStatus is true; otherwise the status field is not changed, even on delete failure.

void	_saveCBMethod (double progress)
	Callback method called by _saveCB.

MLErrorCode	_overWriteWithInputImage (PagedImage &inImg, MLImageFormat &fileToUpdate, ImageVector voxelShift=ImageVector(0), PagedImage *imgPropsToUpdate=nullptr, bool suppressWorldCoordinateUse=false)
	Take the entire input image described in inImg and overwrite the file fileToUpdate, starting at the position given by the world origin of inImg plus voxelShift.

Protected Member Functions inherited from ml::Module
void	handleNotificationInternal (Field *field, FieldSensor::Strength strength) override
	Called from FieldContainer whenever a field changes.

virtual CalculateOutputImageHandler *	createCalculateOutputImageHandler (PagedImage *outputImage)
	Creates the CalculateOutputImageHandler for the given output image `outputImage`.

virtual void	provideCustomPage (int, const SubImageBox &, MLMemoryBlockHandle &)
	This method allows a Module to provide its own pages to the Host for the `outputIndex` output image.

void	handleNotificationOff ()
	Decreases lock counter for handleNotification calls.

void	handleNotificationOn ()
	Increases lock counter for handleNotification calls.

bool	isHandleNotificationOn ()
	Returns `true` if handleNotification calls are permitted; otherwise, it returns `false`.

void	setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0)
	Sets the optimization flag: if calculating a page in calculateOutputSubImage(), the output image page of output `outputIndex` shall use the same memory as the input page of input `inputIndex`.

void	unsetOutputImageInplace (MLint outputIndex=0)
	Clears the optimization flag: output page of output at `outputIndex` and input tile shall use different memory buffers in calculateOutputSubImage().

void	setBypass (MLint outputIndex=0, MLint inputIndex=0)
	Sets the input image whose pages can also be used instead of output pages for the output image at `outputIndex` to avoid recalculations.

void	setClampPagesToImageExtent (bool flag=true)
	Enables/disables page clamping on all output images.

void	setThreadSupport (THREAD_SUPPORT supportMode)
	Passes any THREAD_SUPPORT `supportMode` to decide whether and what type of multithreading is supported by this module.

void	permitRecursiveHandleNotifications (bool enable)
	If this flag is set to `enable` =true, recursive entries in handleNotification are permitted.

void	setVoxelDataTypeSupport (PERMITTED_TYPES permTypes)
	Specifies which types this module supports.

Additional Inherited Members
Static Public Member Functions inherited from ml::Module
static MLErrorCode	getTile (PagedImage image, SubImageBox loc, MLDataType datatype, void data, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB progressCallback=nullptr, void *progressCallbackUserData=nullptr)
	For documentation see Host::getTile() function with same signature.

static MLErrorCode	getTile (PagedImage image, SubImage &subimg, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB progressCallback=nullptr, void *progressCallbackUserData=nullptr)
	For documentation see Host::getTile() function with same signature and Module passed as reference.

static MLErrorCode	updateImageProperties (PagedImage *image)
	For documentation see Host::updateImageProperties() function with same signature.

static void	freeTile (void *data)
	For documentation see Host::freeTile().

static void	updateProgress (const char info1, const char info2)
	For documentation see Host::updateProgress().

static bool	shouldTerminate ()
	For documentation see Host::shouldTerminate().

static Field *	getPressedNotifyField ()
	For documentation see Host::getPressedNotifyField().

static void	adaptPageExtent (ImageVector &pageExtent, MLDataType imageType, const ImageVector &newImgExtent, const ImageVector &oldImgExtent, const ImageVector &pageUnit=ImageVector(0), const ImageVector &minPageExtent=ImageVector(0), const ImageVector &maxPageExtent=ImageVector(0))
	Adapt page size.

static std::string	getVoxelValueAsString (PagedImage image, const ImageVector &position, MLErrorCode errorCode=nullptr, const std::string &errorResult="")
	Returns the voxel value at position `position` of the image `image`.

static size_t	getNumModules ()
	Returns the number of instantiated modules.

static Module *	getModule (size_t index)
	Returns a pointer to instantiated module `index`.

static MLint	findModuleIndex (Module &module)
	Returns the index of Module `module`. If not found, -1 is returned.

static void	destroyModule ()
	Destroys static allocated tables to avoid memory leaks.

Protected Types inherited from ml::Module
enum	THREAD_SUPPORT { NO_THREAD_SUPPORT = PagedImage::NO_THREAD_SUPPORT , MULTITHREADED = PagedImage::MULTITHREADED , IO_THREAD = PagedImage::IO_THREAD }
	Enumerator deciding whether and which type of multithreading is supported by this module. More...

Static Protected Member Functions inherited from ml::MLImageFormatIOBase
static void	_saveCB (double progress, void *usrData)
	Static callback function registered in the save module to get information and interrupt feature.

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 37 of file mlImageFormatFileCache.h.

Member Enumeration Documentation

◆ UPDATE_MODE

enum ml::MLImageFormatFileCache::UPDATE_MODE

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 42 of file mlImageFormatFileCache.h.

Constructor & Destructor Documentation

◆ MLImageFormatFileCache()

ml::MLImageFormatFileCache::MLImageFormatFileCache ( )

Constructor.

◆ ~MLImageFormatFileCache()

ml::MLImageFormatFileCache::~MLImageFormatFileCache ( )

override

Destructor.

Member Function Documentation

◆ activateAttachments()

void ml::MLImageFormatFileCache::activateAttachments ( )

overrideprotectedvirtual

Update internal module state after load or clone.

Reimplemented from ml::FieldContainer.

◆ calculateInputSubImageBox()

SubImageBox ml::MLImageFormatFileCache::calculateInputSubImageBox	(	int	,
		const SubImageBox &	outSubImgBox,
		int	)

overrideprotectedvirtual

Determines the data to be loaded from input image for page processing.

Reimplemented from ml::Module.

◆ calculateOutputImageProperties()

void ml::MLImageFormatFileCache::calculateOutputImageProperties	(	int	outputIndex,
		PagedImage *	outputImage )

overrideprotectedvirtual

Sets properties of the output image at output outIndex.

Reimplemented from ml::Module.

◆ calculateOutputSubImage()

void ml::MLImageFormatFileCache::calculateOutputSubImage	(	SubImage *	outSubImg,
		int	outIndex,
		SubImage *	inSubImgs )

overrideprotectedvirtual

Calculates page outSubImg of output image with index outIndex by using inSubimgs.

Parameters

outSubImg	The subimage of output image `outIndex` calculated from `inSubImgs`.
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 by `getNumInputImages()`.

Reimplemented from ml::Module.

◆ getAutoLoadFld()

EnumField & ml::MLImageFormatFileCache::getAutoLoadFld ( ) const

inline

Definition at line 64 of file mlImageFormatFileCache.h.

◆ getClearFld()

NotifyField & ml::MLImageFormatFileCache::getClearFld ( ) const

inline

Definition at line 63 of file mlImageFormatFileCache.h.

◆ getLoadFld()

NotifyField & ml::MLImageFormatFileCache::getLoadFld ( ) const

inline

Definition at line 61 of file mlImageFormatFileCache.h.

◆ getTmpFileNamePrefixFld()

StringField & ml::MLImageFormatFileCache::getTmpFileNamePrefixFld ( ) const

inline

Definition at line 65 of file mlImageFormatFileCache.h.

◆ getUpdateRegionFld()

NotifyField & ml::MLImageFormatFileCache::getUpdateRegionFld ( ) const

inline

Definition at line 62 of file mlImageFormatFileCache.h.

◆ getValidFld()

BoolField & ml::MLImageFormatFileCache::getValidFld ( ) const

inline

Definition at line 60 of file mlImageFormatFileCache.h.

◆ handleInput()

Module::INPUT_HANDLE ml::MLImageFormatFileCache::handleInput	(	int	,
		Module::INPUT_STATE	) const

overrideprotectedvirtual

Allow invalid input images.

Reimplemented from ml::Module.

◆ handleNotification()

void ml::MLImageFormatFileCache::handleNotification ( Field * field )

overrideprotectedvirtual

Handle field changes of the field field.

Reimplemented from ml::Module.

Member Data Documentation

◆ UPDATE_MODE_NAMES

const char* const ml::MLImageFormatFileCache::UPDATE_MODE_NAMES[UPDATE_MODE_NUM]

static

String constants corresponding to the UPDATE_MODE constants.

Definition at line 50 of file mlImageFormatFileCache.h.

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

MeVisLab/Standard/Sources/ML/MLImageFormat/mlImageFormatFileCache.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ UPDATE_MODE

Constructor & Destructor Documentation

◆ MLImageFormatFileCache()

◆ ~MLImageFormatFileCache()

Member Function Documentation

◆ activateAttachments()

◆ calculateInputSubImageBox()

◆ calculateOutputImageProperties()

◆ calculateOutputSubImage()

◆ getAutoLoadFld()

◆ getClearFld()

◆ getLoadFld()

◆ getTmpFileNamePrefixFld()

◆ getUpdateRegionFld()

◆ getValidFld()

◆ handleInput()

◆ handleNotification()

Member Data Documentation

◆ UPDATE_MODE_NAMES