MeVisLab Toolbox Reference
ml::CSOModificator Class Reference

Base class for performing modifications on the CSOs of a CSOList. More...

#include <CSOModificator.h>

Inheritance diagram for ml::CSOModificator:
ml::CSOGenerator ml::CSOBaseModule ml::CSOGeneratorBase ml::Module ml::FieldContainer ml::Base

Public Member Functions

 CSOModificator (const std::string &type="CSOModificator", int numInImages=0, int numOutImages=0)
 Standard constructor. More...
 
- Public Member Functions inherited from ml::CSOGenerator
 CSOGenerator (std::string type="CSOGenerator", int numInImg=0, int numOutImg=0)
 Constructor. More...
 
std::string getType () const
 Returns the type of the CSOGenerator. More...
 
- Public Member Functions inherited from ml::CSOBaseModule
 CSOBaseModule (const std::string &type="CSOBaseModule", int numInImages=0, int numOutImages=0)
 Standard constructor. More...
 
- Public Member Functions inherited from ml::Module
MLMetaProfilePtrgetMetaProfile () const
 Returns the meta profile for the base operator. More...
 
const char * getTypeNameFast () const
 Macro to declare methods for the ML runtime type system (see mlRuntimeSubClass.h). More...
 
 Module (int numInputImages, int numOutputImages)
 Constructor: Initializes numInputImages input images and numOutputImages output images of the module. More...
 
 ~Module () override
 Destructor: Destroys this module. More...
 
InputConnectorFieldgetInputImageField (MLint i) const
 Returns the field representing input image i. i must be a valid index. More...
 
OutputConnectorFieldgetOutputImageField (MLint i=0) const
 Returns field representing output image i. i must be a valid index. More...
 
MLint getNumInputImages () const
 Returns number of input images of this module. More...
 
MLint getNumOutputImages () const
 Returns number of output images of this module. More...
 
PagedImagegetOutputImage (MLint outputIndex=0) const
 Returns output image outputIndex. The index needs to be in the range [0, getNumOutputImages()-1]. More...
 
InputConnectorFieldaddInputImage (const char *name=nullptr)
 Adds a new input image with name to the module. More...
 
OutputConnectorFieldaddOutputImage (const char *name=nullptr)
 Adds a new output image with name to the module. More...
 
PagedImagegetInputImage (MLint inputIndex, bool getReal=false) const
 Returns the output image of the module connected to input inputIndex. More...
 
PagedImagegetUpdatedInputImage (MLint inputIndex, bool getReal=false) const
 Convenience method for safe access to the input image at index inputIndex. More...
 
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. More...
 
MLErrorCode processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 Process input images with a ProcessAllPagesHandler handler on a temporary output image (which allocates no data) For details, see processAllPages(-1) above. More...
 
MLErrorCode processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 Processes all missing pages on the given output image. More...
 
void clearOutputImage (MLint i=0)
 Clear cached output image pages of output image i. More...
 
InputConnectorFieldaddInputConnector (const char *name, Module *module, MLint i) override
 
OutputConnectorFieldaddOutputConnector (const char *name, Module *module, MLint i) override
 
MLint getOutputImageInplace (MLint outputIndex=0) const
 Return optimization flag: Return index of input image whose input tile is used also as output page for output outputIndex in calculateOutputSubImage() (instead of allocating its own memory). More...
 
MLint getBypass (MLint outputIndex=0) const
 Returns the currently bypass index or -1 if bypassing is disabled (default). More...
 
THREAD_SUPPORT getThreadSupport () const
 Returns the multithreading mode supported by this module, default is NO_THREAD_SUPPORT. More...
 
bool areRecursiveHandleNotificationsPermitted () const
 Returns if recursive entries in handleNotification are permitted. More...
 
MLint getHandleNotificationEntryCounter () const
 A counter returning the current number of (recursive re)entries in handleNotification. More...
 
PERMITTED_TYPES getVoxelDataTypeSupport () const
 Returns the current state of supported voxel data types. More...
 
bool isSupportedVoxelDataType (MLDataType dt) const
 Check if a given data type is supported on the module as configured with setVoxelDataTypeSupport. More...
 
virtual INPUT_HANDLE handleInput (int, INPUT_STATE) const
 This method may be reimplemented to enable support for invalid input images on the module. More...
 
INPUT_STATE getInputState (MLint index)
 Returns the current state of the input connection. More...
 
INPUT_STATE getUpdatedInputState (MLint index)
 Returns the updated state of the input image by calling updateImageProperties(index) and returning getInputState(index) afterwards. More...
 
bool isInputImageField (Field *field) const
 Returns if the given field is an input image field. This can be used in handleNotification(), to check if one of the input images has changed. More...
 
void touchOutputImageFields () const
 Touch all output image fields to indicate that the images have changed. More...
 
FieldContainergetFieldContainer ()
 Returns a pointer to the container of all the module's fields. More...
 
const FieldContainergetFieldContainer () const
 Returns a constant pointer to the container of all the module's fields. More...
 
virtual void beginSaveFields ()
 Called before all fields data contents of this modules are saved. More...
 
virtual void endSaveFields ()
 Called after saving all field contents of this module. More...
 
- Public Member Functions inherited from ml::FieldContainer
 FieldContainer ()
 Constructor. More...
 
 ~FieldContainer () override
 Destructor: Deletes all added fields. More...
 
std::string whoAmI (bool withInstanceName=true) const
 Returns type and instance name of format "ClassTypeName(instanceName)" if the instance name is not empty and withInstanceName is true. More...
 
FieldaddField (const char *name, const char *type, const char *value)
 Adds a new field with name name, type type and value value (coded as string) to the container. More...
 
FieldaddField (Field *field)
 Adds a field, the ownership of the field is passed to the FieldContainer. More...
 
BoolFieldaddBool (const char *name)
 Creates a BoolField with name and adds it to the container. Default value is false. More...
 
BoolFieldaddBool (const char *name, bool value)
 Creates a BoolField with name and adds it to the container. More...
 
IntFieldaddInt (const char *name)
 Creates an IntField with name and adds it to the container. Default value is 0. More...
 
IntFieldaddInt (const char *name, MLint value)
 Creates an IntField with name and adds it to the container. More...
 
EnumFieldaddEnum (const char *name, const char *const *enumerationItemNames, MLint numEnumerationItems)
 Creates an EnumField field with name and adds it to the container. More...
 
EnumFieldaddEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
 Creates an EnumField field with name and adds it to the container. More...
 
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. More...
 
FloatFieldaddFloat (const char *name)
 Creates a FloatField with name and adds it to the container. Default value is 0.f. More...
 
FloatFieldaddFloat (const char *name, float value)
 Creates a FloatField with name and adds it to the container. More...
 
ProgressFieldaddProgress (const char *name)
 Creates a float ProgressField with name and adds it to the container. Default value is 0.f. More...
 
ProgressFieldaddProgress (const char *name, float value)
 Creates a float ProgressField with name and adds it to the container. More...
 
DoubleFieldaddDouble (const char *name)
 Creates a DoubleField with name and adds it to the container. Default value is 0. More...
 
DoubleFieldaddDouble (const char *name, double value)
 Creates a DoubleField with name and adds it to the container. More...
 
StringFieldaddString (const char *name)
 Creates a StringField with name and adds it to the container. Default value is empty string. More...
 
StringFieldaddString (const char *name, const std::string &value)
 Creates a StringField with name and adds it to the container. More...
 
NotifyFieldaddNotify (const char *name)
 Creates a NotifyField field with name and adds it to the container. More...
 
TriggerFieldaddTrigger (const char *name)
 Creates a TriggerField field with name and adds it to the container. More...
 
BaseFieldaddBase (const char *name)
 Creates a Base field with name and adds it to the container. Default value is NULL. More...
 
BaseFieldaddBase (const char *name, Base *value)
 Creates a Base field with name and adds it to the container. More...
 
BaseFieldaddBase (const char *name, const RefCountedBasePtr &value)
 Creates a Base field with name and adds it to the container. Sets the value from intrusive pointer. More...
 
template<typename T >
BaseFieldaddBaseWithAllowedType (const char *name, T *value=nullptr)
 As above, but also sets the allowed type of the field. More...
 
template<typename T >
BaseFieldaddBaseWithAllowedType (const char *name, const ::boost::intrusive_ptr< T > &value)
 As above, but also sets the allowed type of the field. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name)
 Creates a TypedBaseField with name and adds it to the container. Default value is NULL. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name, T *value)
 Creates a TypedBaseField with name and adds it to the container. More...
 
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. More...
 
SoNodeFieldaddSoNode (const char *name)
 Creates a SoNodeField with name and adds it to the container. Default value is NULL. More...
 
SoNodeFieldaddSoNode (const char *name, SoNode *value)
 Creates a SoNodeField with name and adds it to the container. More...
 
PointerFieldaddPointer (const char *name)
 Creates a PointerField with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name, const Vector2 &value)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name, double x, double y)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name, const Vector3 &value)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name, double x, double y, double z)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name, const Vector4 &value)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name, double x, double y, double z, double w)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector5FieldaddVector5 (const char *name)
 Creates a Vector5Field with name and adds it to the container. More...
 
Vector5FieldaddVector5 (const char *name, const Vector5 &value)
 Creates a Vector5Field with name and adds it to the container. More...
 
Vector6FieldaddVector6 (const char *name)
 Creates a Vector6Field with name and adds it to the container. More...
 
Vector6FieldaddVector6 (const char *name, const Vector6 &value)
 Creates a Vector6Field with name and adds it to the container. More...
 
Vector10FieldaddVector10 (const char *name)
 Creates a Vector10Field with name and adds it to the container. More...
 
Vector10FieldaddVector10 (const char *name, const Vector10 &value)
 Creates a Vector10Field with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name)
 Creates a ImageVectorField with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name, const ImageVector &value)
 Creates a ImageVectorField with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (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. More...
 
SubImageBoxFieldaddSubImageBox (const char *name)
 Creates a SubImageBoxField with name and adds it to the container. More...
 
SubImageBoxFieldaddSubImageBox (const char *name, const SubImageBox &value)
 Creates a SubImageBoxField with name and adds it to the container. More...
 
SubImageBoxdFieldaddSubImageBoxd (const char *name)
 Creates a SubImageBoxd field with name and adds it to the container. More...
 
SubImageBoxdFieldaddSubImageBoxd (const char *name, const SubImageBoxd &value)
 Creates a SubImageBoxd field with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name)
 Creates a ColorField with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name, float r, float g, float b)
 Creates a ColorField with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name, const Vector3 &value)
 Creates a ColorField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name)
 Creates a PlaneField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name, double f0, double f1, double f2, double f3)
 Creates a PlaneField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name, const Plane &value)
 Creates a PlaneField with name and adds it to the container. More...
 
RotationFieldaddRotation (const char *name)
 Creates a RotationField with name and adds it to the container. More...
 
RotationFieldaddRotation (const char *name, const Rotation &value)
 Creates a RotationField with name and adds it to the container. More...
 
Matrix2FieldaddMatrix2 (const char *name)
 Creates a Matrix2Field with name and adds it to the container. More...
 
Matrix2FieldaddMatrix2 (const char *name, const Matrix2 &value)
 Creates a Matrix2Field with name and adds it to the container. More...
 
Matrix3FieldaddMatrix3 (const char *name)
 Creates a Matrix3Field with name and adds it to the container. More...
 
Matrix3FieldaddMatrix3 (const char *name, const Matrix3 &value)
 Creates a Matrix3Field with name and adds it to the container. More...
 
Matrix4FieldaddMatrix4 (const char *name)
 Creates a Matrix4Field with name and adds it to the container. More...
 
Matrix4FieldaddMatrix4 (const char *name, const Matrix4 &value)
 Creates a Matrix4Field with name and adds it to the container. More...
 
Matrix5FieldaddMatrix5 (const char *name)
 Creates a Matrix5Field with name and adds it to the container. More...
 
Matrix5FieldaddMatrix5 (const char *name, const Matrix5 &value)
 Creates a Matrix5Field with name and adds it to the container. More...
 
Matrix6FieldaddMatrix6 (const char *name)
 Creates a Matrix6Field with name and adds it to the container. More...
 
Matrix6FieldaddMatrix6 (const char *name, const Matrix6 &value)
 Creates a Matrix6Field with name and adds it to the container. More...
 
MatrixFieldaddMatrix (const char *name)
 Creates a MatrixField with name and adds it to the container. More...
 
MatrixFieldaddMatrix (const char *name, const Matrix4 &value)
 Creates a MatrixField with name and adds it to the container. More...
 
MLDataTypeFieldaddMLDataType (const char *name)
 Creates a MTDataTypeField with name and adds it to the container. More...
 
MLDataTypeFieldaddMLDataType (const char *name, MLDataType value)
 Creates a MTDataTypeField with name and adds it to the container. More...
 
UniversalTypeFieldaddUniversalType (const char *name)
 Creates an UniversalTypeField field with name and adds it to the container. More...
 
IntListFieldaddIntList (const char *name)
 Creates an IntListField field with name and empty list value and adds it to the container. More...
 
IntListFieldaddIntList (const char *name, const std::vector< MLint > &value)
 Creates an IntListField field with name and given list value and adds it to the container. More...
 
DoubleListFieldaddDoubleList (const char *name)
 Creates an DoubleListField field with name and empty list value and adds it to the container. More...
 
DoubleListFieldaddDoubleList (const char *name, const std::vector< double > &value)
 Creates an DoubleListField field with name and given list value and adds it to the container. More...
 
Vector2ListFieldaddVector2List (const char *name)
 Creates an Vector2ListField field with name and empty list value and adds it to the container. More...
 
Vector2ListFieldaddVector2List (const char *name, const std::vector< Vector2 > &value)
 Creates an Vector2ListField field with name and given list value and adds it to the container. More...
 
Vector3ListFieldaddVector3List (const char *name)
 Creates an Vector3ListField field with name and empty list value and adds it to the container. More...
 
Vector3ListFieldaddVector3List (const char *name, const std::vector< Vector3 > &value)
 Creates an Vector3ListField field with name and given list value and adds it to the container. More...
 
Vector4ListFieldaddVector4List (const char *name)
 Creates an Vector4ListField field with name and empty list value and adds it to the container. More...
 
Vector4ListFieldaddVector4List (const char *name, const std::vector< Vector4 > &value)
 Creates an Vector4ListField field with name and given list value and adds it to the container. More...
 
size_t getNumFields () const
 Returns the number of added fields. More...
 
bool hasField (const std::string &name) const
 Returns true if the field with name name exists; otherwise false is returned. More...
 
FieldgetField (const std::string &name) const
 Returns the pointer to the field with name name. More...
 
FieldgetField (MLint index) const
 Returns pointer of field at index if it exists. If not, -1 is returned. More...
 
MLint getFieldIndex (Field *field) const
 Returns index of field if it exists. If not, -1 is returned. More...
 
void setFieldStringValue (const std::string &name, const std::string &value)
 Sets the value of the field with name if it exists. More...
 
std::string getFieldStringValue (const std::string &name) const
 Returns the string value of the field with name if it is found. More...
 
virtual void deactivateAttachments ()
 Disables notification handling, i.e., all fields of this module will not send notifications to attached sensors and fields any more if their values are set or changed. More...
 
- Public Member Functions inherited from ml::Base
 Base ()
 Constructor. More...
 
virtual ~Base ()
 Destructor. More...
 
virtual BasedeepCopy () const
 Set addStateToTree version number that can be accessed via getAddStateVersion() More...
 
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
 Check if this object's type is equal to or derived from one of the types given in the argument. More...
 
virtual bool isRefCountedBase () const
 Returns if the instance is derived from RefCountedBase. More...
 
virtual std::string detailString () const
 Return a string describing this object. More...
 
virtual bool implementsPersistence (PersistenceInterface) const
 Override this method to declare which persistence interfaces are implemented by your derived class. More...
 
virtual std::string persistentState () const
 Returns a string describing the object's internal state. More...
 
virtual void setPersistentState (const std::string &state)
 Restores the object's internal state from a string that had been previously generated using persistentState(). More...
 
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node. More...
 
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node. More...
 
virtual void writeTo (AbstractPersistenceOutputStream *) const
 Write the objects state to the data stream object. More...
 
virtual void readFrom (AbstractPersistenceInputStream *, int)
 Read the objects state from the data stream object. More...
 
- Public Member Functions inherited from ml::CSOGeneratorBase
 CSOGeneratorBase ()
 Default constructor. More...
 
virtual ~CSOGeneratorBase ()=default
 
CSOgeneratorAddCSO (CSOList *csoList, bool useUndoRedo=true)
 Adds a new CSO to the CSOList. More...
 
CSOgeneratorAddCSONoEvent (CSOList *csoList, bool useUndoRedo=true, bool sendEvent=false)
 See generatorAddCSO, but no group scope event is emitted. (So this method is faster!) More...
 
CSOGroupgeneratorGetParentGroup (CSOList *csoList, bool useUndoRedo=false, bool generate=false)
 Returns the parent group according to current group settings. More...
 
void generatorEmptyGroupOnDemand (CSOList *csoList)
 Empties a group on demand of the given CSOList with the set label. More...
 

Protected Member Functions

 ~CSOModificator () override
 Standard destructor. More...
 
void activateAttachments () override
 Initialize module after loading. More...
 
void handleNotification (Field *field) override
 Called when input changes. More...
 
virtual void resetParsedIds ()
 Resets parameteres of the modificator. More...
 
virtual void process ()
 Sets up the CSOList, applies the modificator to the CSOList and notifies other modules that processing has finished. More...
 
virtual void clearOutput ()
 Clears all outputs (used by auto clear mode) More...
 
virtual std::vector< CSO * > getCSOsToBeProcessed (const std::vector< CSO * > &csosFromIdList)
 may be overwritten to filter out CSOs that are processed by this modificator, by default returns the input parameter which holds the CSOs that are in the inputList and that are included by the idList filter field More...
 
virtual bool shouldUseUndoRedo () const
 Whether undo/Redo should be used. More...
 
virtual bool canProcessInput ()
 returns whether the current input can be processed, i.e. More...
 
virtual void _setupCSOList ()
 Sets the _outCSOList correctly. More...
 
virtual void _applyModificator ()
 Applies the modification to the CSOs of the attached list. More...
 
virtual void _applyModificatorOnCSOs (const std::vector< CSO * > &csosToBeProcessed)
 may be overwritten by subclasses if, for example, CSOs should be processed in parallel More...
 
virtual void _applyModificatorOn (CSO &outputCSO)
 may be overwritten by subclasses if CSOs are processed one by one More...
 
virtual void _updateCSOType (CSO &outputCSO)
 Updates the CSO's type. Most modules change the type to the modificators name, but not all do it. More...
 
virtual void _notifyObservers (bool didSomething)
 Notifies other modules that processing has finished. More...
 
virtual bool shouldTriggerInputChanged (Field *field) const
 returns whether a field notification triggers auto update. More...
 
virtual bool shouldTriggerParameterApplied (Field *field) const
 This method exists only for legacy reasons and shoult not be overwritten when writing new CSOModificators! More...
 
bool _isChangeSettingField (Field *field) const
 
virtual void _onInputChanged ()
 helper functions called by handleNotification, may be overwritten in very special cases More...
 
virtual void _onParameterApplied ()
 
virtual void _onCSOIdListChanged ()
 
virtual void _onWorkDirectlyOnInputChanged ()
 
virtual void _onApply ()
 
bool _isInIdList (CSO *cso)
 Checks if the given CSO is in the list of IDs given by _csoIdListFld. More...
 
void _parseCSOIds (std::set< unsigned int > &ids)
 Parse the CSO id field into the given vector of ids. More...
 
std::vector< CSO * > _getModifyCSOsFromIdList ()
 
void _storeCurrentStateInUndoManager (std::vector< CSO * > csosToBeProcessed)
 
void _applyChangedSettings (CSO &cso) const
 Changes the settings of the given CSO (only if _changeSettingsForModifiedCSOsFld is true). More...
 
 ML_ABSTRACT_MODULE_CLASS_HEADER (CSOModificator)
 
- Protected Member Functions inherited from ml::CSOGenerator
CSO_addCSO (CSOList *csoList, bool useUndoRedo=true)
 Adds a new CSO to the CSOList. More...
 
CSO_addCSONoEvent (CSOList *csoList, bool useUndoRedo=true)
 See _addCSO, but without group event. (This method is faster!). More...
 
CSOGroup_getParentGroup (CSOList *csoList, bool useUndoRedo=false, bool generate=false)
 Returns the parent group according to current group settings. More...
 
void _emptyGroupOnDemand (CSOList *csoList)
 Empties a group on demand of the given CSOList with the set label. More...
 
int getModuleCreatorId () const override
 Returns the module's creator id. More...
 
std::string getModuleType () const override
 Returns the module's type string. More...
 
bool getShouldEmptyBeforeGeneration () const override
 Returns whether the module should empty a group before generating CSOs into it. More...
 
int getAddCSOToGroupMode () const override
 Returns the group generation mode. More...
 
std::string getAddCSOToGroupLabel () const override
 Returns the label string of a target group. More...
 
int getAddCSOToGroupId () const override
 Returns the id of a target group. More...
 
int getDefaultPathPointStyle () const override
 Returns the set default path point style for a new CSO. More...
 
float getDefaultPathPointWidth () const override
 Returns the set default path point width for a new CSO. More...
 
Vector3 getDefaultPathPointColor () const override
 Returns the set default path point color for a new CSO. More...
 
float getDefaultPathPointAlpha () const override
 Returns the set default path point alpha for a new CSO. More...
 
int getDefaultSeedPointStyle () const override
 Returns the set default seed point style for a new CSO. More...
 
float getDefaultSeedPointSize () const override
 Returns the set default seed point size for a new CSO. More...
 
Vector3 getDefaultSeedPointColor () const override
 Returns the set default seed point color for a new CSO. More...
 
float getDefaultSeedPointAlpha () const override
 Returns the set default seed point alpha for a new CSO. More...
 
int getDefaultVoxelWriteMode () const override
 Returns the set default voxel write mode for a new CSO. More...
 
float getDefaultVoxelWriteValue () const override
 Returns the set default voxel write value for a new CSO. More...
 
 ~CSOGenerator () override
 Destructor. More...
 
- Protected Member Functions inherited from ml::CSOBaseModule
 ~CSOBaseModule () override
 Standard destructor. More...
 
virtual bool _useLegacyAutoApplyMode () const
 Controls whether update behaviour on parameter field changes should depend on the autoApply field (legacy mode, don't use it when adding your new subclasses) or if it should depend on the updateMode (recommended) More...
 
void _setIsProcessingFlag (bool newProcessingState)
 Sets the isProcessing field if the processing state has changed. More...
 
 ML_MODULE_CLASS_HEADER (CSOBaseModule)
 
- Protected Member Functions inherited from ml::Module
void handleNotificationInternal (Field *field, FieldSensor::Strength strength) override
 Called from FieldContainer whenever a field changes. More...
 
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. More...
 
void handleNotificationOff ()
 Decreases lock counter for handleNotification calls. More...
 
void handleNotificationOn ()
 Increases lock counter for handleNotification calls. More...
 
bool isHandleNotificationOn ()
 Returns true if handleNotification calls are permitted, otherwise false. More...
 
void setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0)
 Set 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. More...
 
void unsetOutputImageInplace (MLint outputIndex=0)
 Clear optimization flag: output page of output at outputIndex and input tile shall use different memory buffers in calculateOutputSubImage(). More...
 
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. More...
 
void setClampPagesToImageExtent (bool flag=true)
 Enables/disables page clamping on all output images. More...
 
void setThreadSupport (THREAD_SUPPORT supportMode)
 Pass any THREAD_SUPPORT supportMode to decide whether and what type of multithreading is supported by this module. More...
 
void permitRecursiveHandleNotifications (bool enable)
 If this flag is set to enable =true, recursive entries in handleNotification are permitted. More...
 
void setVoxelDataTypeSupport (PERMITTED_TYPES permTypes)
 Specifies which types this module supports. More...
 
virtual CalculateOutputImageHandlercreateCalculateOutputImageHandler (PagedImage *outputImage)
 Creates the CalculateOutputImageHandler for the given output image outputImage. More...
 
virtual void calculateOutputImageProperties (int outputIndex, PagedImage *)
 Set properties of output image outputImage with output index outputIndex. More...
 
virtual SubImageBox calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox, int)
 Called by the Host to determine which input image region (tile) of input inputIndex is required to calculate a certain output image region (page) of output outputIndex. More...
 
virtual void calculateOutputSubImage (SubImage *outputSubImage, int outputIndex, SubImage *inputSubImages)
 Calculate page outputSubImage of output image with index outputIndex given the input image tiles in array inputSubImages. More...
 
- Protected Member Functions inherited from ml::Base
virtual char * getPersistentState () const
 Returns a C string describing the object's internal state. More...
 
virtual void setPersistentState (const char *)
 Restores the object's internal state from a string that had been previously generated using getPersistentState(). More...
 
virtual void clearPersistentState (char *) const
 Disposes a string previously allocated by getPersistentState(). More...
 

Static Protected Member Functions

static void _csoListNotifyObserverCB (void *userData, int notificationFlag)
 Can be called from anywhere from the network. More...
 

Protected Attributes

BaseField_inputCSOListFld
 The input CSOList. More...
 
BaseField_outputCSOListFld
 The filtered output CSOList. More...
 
StringField_csoIdListFld
 The list of ids of the CSOs to be transformed; if this list is empty, all CSOs are transformed. More...
 
BoolField_workDirectlyOnInputListFld
 Shall the module work directly on the input CSOList? Otherwise, it would work on a copy which is returned by the output field. More...
 
BoolField_useUndoRedoFld
 Shall undo/redo be used? The value is ignored if workDirectlyOnInputList is disabled. More...
 
BoolField_listenToFinishingNotificationsFld
 Shall the module listen to finishing events? More...
 
BoolField_listenToSelectionNotificationsFld
 Shall the module listen to selection change notifications? More...
 
BoolField_changeSettingsForModifiedCSOsFld
 Shall the module's user settings be used for modified CSOs? More...
 
CSOListPtr _inCSOList
 A pointer to the input CSOList. More...
 
CSOListPtr _outCSOList
 A pointer to the output CSOList. More...
 
bool _isInNotificationCB
 Locking variable for removing/adding a notification observer. More...
 
bool _isNotifyingMyself
 Is this module notifying itself? Locking variable to avoid infinite loops. More...
 
std::set< unsigned int > _parsedIDs
 The IDs of the CSOs that should be processed according to the _csoIdListFld. More...
 
bool _parsedIDsValid
 Flag that indicates if _parsedIDs is valid. More...
 
bool _outCSOListChanged
 Flag that indicates that _outCSOList has been changed and thus that _outputCSOListFld has to be updated. More...
 
bool _isOutputCSOListOwner
 Flag that indicates whether this module is the owner of the output CSO list. More...
 
bool _isWorkingDirectlyOnInputCSOList
 Flag that indicates whether this module should work on its input CSO list directly. More...
 
- Protected Attributes inherited from ml::CSOGenerator
BoolField_emptyGroupBeforeGenerationFld
 If checked and a group name is provided, the group is emptied before a new generation. More...
 
TypedEnumField< CSOAddToGroupModes > * _addCSOToGroupMode
 Defines if the CSOs are added to a group and how the group is identified. More...
 
StringField_addCSOToGroupWithLabelFld
 This label defines the group the generator should add its created CSOs to. More...
 
IntField_addCSOToGroupWithIdFld
 This id defines the group the generator should add its created CSOs to. More...
 
IntField_idFld
 The id of this processor. More...
 
TypedEnumField< CSOPathPointsStyle > * _pathPointStyleFld
 The path point's line style (none, solid, dashed, dotted). Default is 'solid'. More...
 
FloatField_pathPointWidthFld
 The path point's line width. Default is 1. More...
 
ColorField_pathPointColorFld
 The path point's color. Default is yellow. More...
 
FloatField_pathPointAlphaFld
 The path point's alpha value. Default is 1. More...
 
TypedEnumField< CSOSeedPointStyle > * _seedPointStyleFld
 The marker's mode (none, rect, circle). Default is 'rect'. More...
 
FloatField_seedPointSizeFld
 The marker's size. Default is 3. More...
 
ColorField_seedPointColorFld
 The marker's color. Default is green. More...
 
FloatField_seedPointAlphaFld
 The marker's alpha value. Default is 1. More...
 
TypedEnumField< CSOVoxelWriteModes > * _voxelWriteModeFld
 The CSO's voxel write mode (module, const, const plus id, id). Default is 'module'. More...
 
FloatField_voxelWriteValueFld
 The CSO's voxel write value. Default is 1024. More...
 
- Protected Attributes inherited from ml::CSOBaseModule
TypedEnumField< CSOUpdateModes > * _updateModeFld
 Enumeration field for update modes. More...
 
BoolField_autoApplyFld
 Shall changes lead to an apply? Field value is only considered when useLegacyAutoApplyMode is enabled. More...
 
NotifyField_applyFld
 Applies changes. More...
 
BoolField_isProcessingFld
 Field reflects whether the module is currently processing. More...
 
NotifyField_doneFld
 Notifies the application or other modules that the processing has ended. More...
 
std::string _type
 The processor type as a string. More...
 

Additional Inherited Members

- Public Types inherited from ml::Module
enum  PERMITTED_TYPES {
  ONLY_SCALAR_TYPES , ONLY_DEFAULT_TYPES , ALL_REGISTERED_TYPES , ONLY_STANDARD_TYPES = ONLY_SCALAR_TYPES ,
  FULLY_OPERATIONAL = ONLY_DEFAULT_TYPES , MINIMUM_OPERATIONAL = 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...
 
- 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. More...
 
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. More...
 
static MLErrorCode updateImageProperties (PagedImage *image)
 For documentation see Host::updateImageProperties() function with same signature. More...
 
static void freeTile (void *data)
 For documentation see Host::freeTile(). More...
 
static void updateProgress (const char *info1, const char *info2)
 For documentation see Host::updateProgress(). More...
 
static bool shouldTerminate ()
 For documentation see Host::shouldTerminate(). More...
 
static FieldgetPressedNotifyField ()
 For documentation see Host::getPressedNotifyField(). More...
 
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. More...
 
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. More...
 
static size_t getNumModules ()
 Returns number of instantiated modules. More...
 
static ModulegetModule (size_t index)
 Returns pointer to instantiated module index. More...
 
static MLint findModuleIndex (Module &module)
 Returns index of Module module. If not found -1 is returned. More...
 
static void destroyModule ()
 Destroys static allocated tables to avoid memory leaks. More...
 
- Protected Types inherited from ml::Module
enum  THREAD_SUPPORT {
  NO_THREAD_SUPPORT = PagedImage::NO_THREAD_SUPPORT , MULTITHREADED = PagedImage::MULTITHREADED , IO_THREAD = PagedImage::IO_THREAD , ML_CALCULATEOUTPUTSUBIMAGE_ON_STD_TYPES = PagedImage::MULTITHREADED ,
  ML_CALCULATEOUTPUTSUBIMAGE_ON_ALL_TYPES = PagedImage::MULTITHREADED
}
 Enumerator deciding whether and which type of multithreading is supported by this module. More...
 

Detailed Description

Base class for performing modifications on the CSOs of a CSOList.

Definition at line 28 of file CSOModificator.h.

Constructor & Destructor Documentation

◆ CSOModificator()

ml::CSOModificator::CSOModificator ( const std::string &  type = "CSOModificator",
int  numInImages = 0,
int  numOutImages = 0 
)

Standard constructor.

◆ ~CSOModificator()

ml::CSOModificator::~CSOModificator ( )
overrideprotected

Standard destructor.

Member Function Documentation

◆ _applyChangedSettings()

void ml::CSOModificator::_applyChangedSettings ( CSO cso) const
protected

Changes the settings of the given CSO (only if _changeSettingsForModifiedCSOsFld is true).

◆ _applyModificator()

virtual void ml::CSOModificator::_applyModificator ( )
protectedvirtual

Applies the modification to the CSOs of the attached list.

by default it calls _applyModificatorOn() for each cso that should be procesed.

May be overwritten if it's not suitable to overwrite the applyModificatorOn(CSO&) method, e.g. when sets of CSOs are processed in batches Use _outCSOList to access the CSO list that should be modified here.

◆ _applyModificatorOn()

virtual void ml::CSOModificator::_applyModificatorOn ( CSO outputCSO)
protectedvirtual

may be overwritten by subclasses if CSOs are processed one by one

Parameters
outputCSOthe CSO from the _outCSOList on which the modification is to be applied

◆ _applyModificatorOnCSOs()

virtual void ml::CSOModificator::_applyModificatorOnCSOs ( const std::vector< CSO * > &  csosToBeProcessed)
protectedvirtual

may be overwritten by subclasses if, for example, CSOs should be processed in parallel

Parameters
csosToBeProcessedall CSOs from the _outCSOList on which the modification is to be applied

◆ _csoListNotifyObserverCB()

static void ml::CSOModificator::_csoListNotifyObserverCB ( void *  userData,
int  notificationFlag 
)
staticprotected

Can be called from anywhere from the network.

◆ _getModifyCSOsFromIdList()

std::vector<CSO *> ml::CSOModificator::_getModifyCSOsFromIdList ( )
protected

◆ _isChangeSettingField()

bool ml::CSOModificator::_isChangeSettingField ( Field field) const
protected

◆ _isInIdList()

bool ml::CSOModificator::_isInIdList ( CSO cso)
protected

Checks if the given CSO is in the list of IDs given by _csoIdListFld.

If _csoIdListFld is empty this function always returns true.

◆ _notifyObservers()

virtual void ml::CSOModificator::_notifyObservers ( bool  didSomething)
protectedvirtual

Notifies other modules that processing has finished.

◆ _onApply()

virtual void ml::CSOModificator::_onApply ( )
protectedvirtual

◆ _onCSOIdListChanged()

virtual void ml::CSOModificator::_onCSOIdListChanged ( )
protectedvirtual

◆ _onInputChanged()

virtual void ml::CSOModificator::_onInputChanged ( )
protectedvirtual

helper functions called by handleNotification, may be overwritten in very special cases

◆ _onParameterApplied()

virtual void ml::CSOModificator::_onParameterApplied ( )
protectedvirtual

◆ _onWorkDirectlyOnInputChanged()

virtual void ml::CSOModificator::_onWorkDirectlyOnInputChanged ( )
protectedvirtual

◆ _parseCSOIds()

void ml::CSOModificator::_parseCSOIds ( std::set< unsigned int > &  ids)
protected

Parse the CSO id field into the given vector of ids.

◆ _setupCSOList()

virtual void ml::CSOModificator::_setupCSOList ( )
protectedvirtual

Sets the _outCSOList correctly.

◆ _storeCurrentStateInUndoManager()

void ml::CSOModificator::_storeCurrentStateInUndoManager ( std::vector< CSO * >  csosToBeProcessed)
protected

◆ _updateCSOType()

virtual void ml::CSOModificator::_updateCSOType ( CSO outputCSO)
protectedvirtual

Updates the CSO's type. Most modules change the type to the modificators name, but not all do it.

◆ activateAttachments()

void ml::CSOModificator::activateAttachments ( )
overrideprotectedvirtual

Initialize module after loading.

Reimplemented from ml::CSOBaseModule.

◆ canProcessInput()

virtual bool ml::CSOModificator::canProcessInput ( )
protectedvirtual

returns whether the current input can be processed, i.e.

there's a non-empty list attached. Subclasses may add additional conditions. (See CSOMerge as an example).

◆ clearOutput()

virtual void ml::CSOModificator::clearOutput ( )
protectedvirtual

Clears all outputs (used by auto clear mode)

◆ getCSOsToBeProcessed()

virtual std::vector<CSO*> ml::CSOModificator::getCSOsToBeProcessed ( const std::vector< CSO * > &  csosFromIdList)
protectedvirtual

may be overwritten to filter out CSOs that are processed by this modificator, by default returns the input parameter which holds the CSOs that are in the inputList and that are included by the idList filter field

◆ handleNotification()

void ml::CSOModificator::handleNotification ( Field field)
overrideprotectedvirtual

Called when input changes.

Reimplemented from ml::CSOBaseModule.

◆ ML_ABSTRACT_MODULE_CLASS_HEADER()

ml::CSOModificator::ML_ABSTRACT_MODULE_CLASS_HEADER ( CSOModificator  )
protected

◆ process()

virtual void ml::CSOModificator::process ( )
protectedvirtual

Sets up the CSOList, applies the modificator to the CSOList and notifies other modules that processing has finished.

Call this function in handle notification when the modificator should be applied to the CSOList. A derived module does not have to override this function.

◆ resetParsedIds()

virtual void ml::CSOModificator::resetParsedIds ( )
protectedvirtual

Resets parameteres of the modificator.

◆ shouldTriggerInputChanged()

virtual bool ml::CSOModificator::shouldTriggerInputChanged ( Field field) const
protectedvirtual

returns whether a field notification triggers auto update.

Overwrite this method if your subclass adds it's own input fields. These may be input connector fields or input parameter fields. Note that the result may not only depend on the passed field but also on the modules state. E.g. the creation parameters defined in CSOGeneratorBase are ignored in modificators when changeSettingsForModifiedCSOs is disabled.

legacy note: modules that support different update mechanisms for input parameter fields and input connector fields (currently these are a lot of modules) should not add their input parameter fields to this method but to the shouldTriggerParameterApplied method

◆ shouldTriggerParameterApplied()

virtual bool ml::CSOModificator::shouldTriggerParameterApplied ( Field field) const
protectedvirtual

This method exists only for legacy reasons and shoult not be overwritten when writing new CSOModificators!

returns whether a field notification triggers the legacy auto apply. This method is only overwritten by classes that use the autoApplyLegacyMode The classes with legacy mode enabled have to add their parameter input fields to this method.

◆ shouldUseUndoRedo()

virtual bool ml::CSOModificator::shouldUseUndoRedo ( ) const
protectedvirtual

Whether undo/Redo should be used.

Member Data Documentation

◆ _changeSettingsForModifiedCSOsFld

BoolField* ml::CSOModificator::_changeSettingsForModifiedCSOsFld
protected

Shall the module's user settings be used for modified CSOs?

Definition at line 158 of file CSOModificator.h.

◆ _csoIdListFld

StringField* ml::CSOModificator::_csoIdListFld
protected

The list of ids of the CSOs to be transformed; if this list is empty, all CSOs are transformed.

Definition at line 143 of file CSOModificator.h.

◆ _inCSOList

CSOListPtr ml::CSOModificator::_inCSOList
protected

A pointer to the input CSOList.

Definition at line 163 of file CSOModificator.h.

◆ _inputCSOListFld

BaseField* ml::CSOModificator::_inputCSOListFld
protected

The input CSOList.

Definition at line 137 of file CSOModificator.h.

◆ _isInNotificationCB

bool ml::CSOModificator::_isInNotificationCB
protected

Locking variable for removing/adding a notification observer.

Definition at line 167 of file CSOModificator.h.

◆ _isNotifyingMyself

bool ml::CSOModificator::_isNotifyingMyself
protected

Is this module notifying itself? Locking variable to avoid infinite loops.

Definition at line 169 of file CSOModificator.h.

◆ _isOutputCSOListOwner

bool ml::CSOModificator::_isOutputCSOListOwner
protected

Flag that indicates whether this module is the owner of the output CSO list.

Definition at line 182 of file CSOModificator.h.

◆ _isWorkingDirectlyOnInputCSOList

bool ml::CSOModificator::_isWorkingDirectlyOnInputCSOList
protected

Flag that indicates whether this module should work on its input CSO list directly.

Definition at line 184 of file CSOModificator.h.

◆ _listenToFinishingNotificationsFld

BoolField* ml::CSOModificator::_listenToFinishingNotificationsFld
protected

Shall the module listen to finishing events?

Definition at line 153 of file CSOModificator.h.

◆ _listenToSelectionNotificationsFld

BoolField* ml::CSOModificator::_listenToSelectionNotificationsFld
protected

Shall the module listen to selection change notifications?

Definition at line 155 of file CSOModificator.h.

◆ _outCSOList

CSOListPtr ml::CSOModificator::_outCSOList
protected

A pointer to the output CSOList.

Definition at line 165 of file CSOModificator.h.

◆ _outCSOListChanged

bool ml::CSOModificator::_outCSOListChanged
protected

Flag that indicates that _outCSOList has been changed and thus that _outputCSOListFld has to be updated.

Because new might assign the same memory block (i.e. the same pointer value) it is not enough to compare _outCSOList with _outputCSOListFld->getBaseValue() (see _notifyObservers()).

Definition at line 179 of file CSOModificator.h.

◆ _outputCSOListFld

BaseField* ml::CSOModificator::_outputCSOListFld
protected

The filtered output CSOList.

Definition at line 139 of file CSOModificator.h.

◆ _parsedIDs

std::set<unsigned int> ml::CSOModificator::_parsedIDs
protected

The IDs of the CSOs that should be processed according to the _csoIdListFld.

Definition at line 172 of file CSOModificator.h.

◆ _parsedIDsValid

bool ml::CSOModificator::_parsedIDsValid
protected

Flag that indicates if _parsedIDs is valid.

Definition at line 174 of file CSOModificator.h.

◆ _useUndoRedoFld

BoolField* ml::CSOModificator::_useUndoRedoFld
protected

Shall undo/redo be used? The value is ignored if workDirectlyOnInputList is disabled.

Definition at line 150 of file CSOModificator.h.

◆ _workDirectlyOnInputListFld

BoolField* ml::CSOModificator::_workDirectlyOnInputListFld
protected

Shall the module work directly on the input CSOList? Otherwise, it would work on a copy which is returned by the output field.

Definition at line 147 of file CSOModificator.h.


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