ml::CSOConvertor Class Reference
Base class for modules that convert CSOs to voxel images. More...
#include <CSOConvertor.h>
Inheritance diagram for ml::CSOConvertor:
Public Member Functions | |
| CSOConvertor (int numInImages=1, int numOutImages=1) | |
| Standard constructor. | |
Protected Member Functions | |
| virtual | ~CSOConvertor () |
| Standard destructor. | |
| virtual void | activateAttachments () |
| Initialize module after loading. | |
| virtual void | handleNotification (Field *field) |
| Called when input changes. | |
| virtual void | calculateOutputImageProperties (int outIndex) |
| Sets the properties of the output image. | |
| virtual void | _calcOutSubImageMinMaxValue (long double &minValue, long double &maxValue, MLDataType &dType) |
| Calculates the minimum and the maximum output image values, and the data type. | |
| virtual void | _clear () |
| Clears internal data and invalidates the output image. | |
| virtual void | _process () |
| Triggers the computation of the preprocessing. | |
| void | _setBoundingBoxFields (const CSOBoundingBox &voxelBB, const CSOBoundingBox &worldBB) |
| Sets the given vectors as bounding box fields to the GUI. | |
Static Protected Member Functions | |
| static void | _csoListNotifcationCB (void *userData, int notificationFlag) |
| Can be called from anywhere from within the network. | |
Protected Attributes | |
| BaseField * | _inCSOListFld |
| The input CSOList (which is to be interpolated). | |
| NotifyField * | _clearFld |
| If pressed the output image is invalidated and internal data is cleared. | |
| FloatField * | _foregroundValueFld |
| The foreground (object) image value. | |
| FloatField * | _backgroundValueFld |
| The background image value. | |
| BoolField * | _copyInputImageFld |
| Shall the input image be copied? | |
| BoolField * | _fillSurfaceFld |
| Shall the interpolated surface be filled? | |
| BoolField * | _useImageValuesFld |
| Shall the image's values be used? | |
| BoolField * | _listenInteractionNotificationsFld |
| Shall the module listen to interaction notifications? | |
| BoolField * | _listenInteractionFinishedFld |
| Shall the module listen to finished interaction notifications? | |
| IntField * | _boundingBoxMarginFld |
| The margin for the bounding box. Default is 0 (no margin). | |
| Vector3Field * | _startVoxelBoundingBoxFld |
| Start of the voxel bounding box. | |
| Vector3Field * | _endVoxelBoundingBoxFld |
| End of the voxel bounding box. | |
| Vector3Field * | _startWorldBoundingBoxFld |
| Start of the world bounding box. | |
| Vector3Field * | _endWorldBoundingBoxFld |
| End of the world bounding box. | |
| StringField * | _voxelBoundingBoxStringFld |
| A string representing the starting and the ending points (in 6D) of the voxel bounding box. | |
| CSOList * | _inCSOList |
| The input CSOList (the original one). | |
| bool | _hasValidVoxelData |
| Is the interpolation compound up to date? | |
| bool | _isInNotificationCB |
| Locking variable for the observer mechanism. | |
| bool | _canProduceOutputImage |
| Can the module produce a valid output image? | |
| bool | _shouldAugmentBoundingBoxZ |
| Should the bounding box be augmented in z-direction by 1? | |
Detailed Description
Base class for modules that convert CSOs to voxel images.Definition at line 24 of file CSOConvertor.h.
Constructor & Destructor Documentation
| ml::CSOConvertor::CSOConvertor | ( | int | numInImages = 1, |
|
| int | numOutImages = 1 | |||
| ) |
Standard constructor.
| virtual ml::CSOConvertor::~CSOConvertor | ( | ) | [protected, virtual] |
Standard destructor.
Member Function Documentation
| virtual void ml::CSOConvertor::_calcOutSubImageMinMaxValue | ( | long double & | minValue, | |
| long double & | maxValue, | |||
| MLDataType & | dType | |||
| ) | [protected, virtual] |
Calculates the minimum and the maximum output image values, and the data type.
Needs to be overwritten in child classes.
| virtual void ml::CSOConvertor::_clear | ( | ) | [protected, virtual] |
Clears internal data and invalidates the output image.
| static void ml::CSOConvertor::_csoListNotifcationCB | ( | void * | userData, | |
| int | notificationFlag | |||
| ) | [static, protected] |
Can be called from anywhere from within the network.
| virtual void ml::CSOConvertor::_process | ( | ) | [protected, virtual] |
Triggers the computation of the preprocessing.
| void ml::CSOConvertor::_setBoundingBoxFields | ( | const CSOBoundingBox & | voxelBB, | |
| const CSOBoundingBox & | worldBB | |||
| ) | [protected] |
Sets the given vectors as bounding box fields to the GUI.
| virtual void ml::CSOConvertor::activateAttachments | ( | ) | [protected, virtual] |
| virtual void ml::CSOConvertor::calculateOutputImageProperties | ( | int | outIndex | ) | [protected, virtual] |
| virtual void ml::CSOConvertor::handleNotification | ( | Field * | field | ) | [protected, virtual] |
Member Data Documentation
FloatField* ml::CSOConvertor::_backgroundValueFld [protected] |
IntField* ml::CSOConvertor::_boundingBoxMarginFld [protected] |
The margin for the bounding box. Default is 0 (no margin).
Definition at line 77 of file CSOConvertor.h.
bool ml::CSOConvertor::_canProduceOutputImage [protected] |
NotifyField* ml::CSOConvertor::_clearFld [protected] |
If pressed the output image is invalidated and internal data is cleared.
Definition at line 56 of file CSOConvertor.h.
BoolField* ml::CSOConvertor::_copyInputImageFld [protected] |
Vector3Field* ml::CSOConvertor::_endVoxelBoundingBoxFld [protected] |
Vector3Field* ml::CSOConvertor::_endWorldBoundingBoxFld [protected] |
BoolField* ml::CSOConvertor::_fillSurfaceFld [protected] |
FloatField* ml::CSOConvertor::_foregroundValueFld [protected] |
bool ml::CSOConvertor::_hasValidVoxelData [protected] |
CSOList* ml::CSOConvertor::_inCSOList [protected] |
BaseField* ml::CSOConvertor::_inCSOListFld [protected] |
bool ml::CSOConvertor::_isInNotificationCB [protected] |
BoolField* ml::CSOConvertor::_listenInteractionFinishedFld [protected] |
Shall the module listen to finished interaction notifications?
Definition at line 74 of file CSOConvertor.h.
bool ml::CSOConvertor::_shouldAugmentBoundingBoxZ [protected] |
Should the bounding box be augmented in z-direction by 1?
Definition at line 104 of file CSOConvertor.h.
Vector3Field* ml::CSOConvertor::_startVoxelBoundingBoxFld [protected] |
Vector3Field* ml::CSOConvertor::_startWorldBoundingBoxFld [protected] |
BoolField* ml::CSOConvertor::_useImageValuesFld [protected] |
StringField* ml::CSOConvertor::_voxelBoundingBoxStringFld [protected] |
A string representing the starting and the ending points (in 6D) of the voxel bounding box.
Definition at line 90 of file CSOConvertor.h.
The documentation for this class was generated from the following file:
- MeVisLab/Standard/Sources/ML/MLCSO/CSOBase/CSOModuleBase/CSOConvertor.h
