ClusterHandler that is used to provide slice-by-slice data to the cluster algorithm. More...
#include <mlClusterAlgorithm.h>
Public Member Functions | |
| ClusterHandler (ClusterAlgorithm< CLUSTERVOXELTYPE, DerivedAlgorithm > *algorithm) | |
| void | setParameters (bool useMask, MLDataType type) |
| Stores all parameters that are needed to call the algorithm. More... | |
| void | calculateOutputImageProperties (PagedImage *image) override |
| Re-implement this method to specify the virtual output image's datatype/size/page extent. More... | |
| SubImageBox | calculateInputSubImageBox (int inputIndex, const SubImageBox &outputSubImageBox) override |
| Re-implement this method to specify the input image box for the input images By default, it returns outputSubImageBox for all inputs. More... | |
| MLErrorCode | processTiles (SubImage *images) override |
| Re-implement this method to do the processing, return ML_RESULT_OK if processing should go on, otherwise return the appropriate error code. More... | |
| MLErrorCode | getErrorCode () const |
 Public Member Functions inherited from ml::OrderedProcessAllPagesHandler | |
| OrderedProcessAllPagesHandler () | |
| void | calculateOutputSubImage (SubImage *outputSubImage, SubImage *inputSubImages, UserThreadData *) override |
| internal method, do not re-implement More... | |
| Public Member Functions inherited from ml::ProcessAllPagesHandler | |
| virtual bool | wantsProgressUpdates () |
| Returns if the handler want to receive progress updates via updateProgress() More... | |
| virtual void | updateProgress (double) |
| Called in regular intervals when wantsProgressUpdates() == true. More... | |
| void | install (PagedImage *outImg) |
| Installs the handler on the PagedImage (which is typically called by the ML Host, do not call it yourself!) More... | |
| virtual const char * | getName () |
| Returns the name of the handler. More... | |
| Public Member Functions inherited from ml::CalculateOutputImageHandler | |
| virtual | ~CalculateOutputImageHandler () |
| Destructor. More... | |
| virtual UserThreadData * | createUserThreadData () |
| Create the thread local user data for a thread. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from ml::OrderedProcessAllPagesHandler | |
| PagedImage * | _image |
Detailed Description
template<typename CLUSTERVOXELTYPE, typename DerivedAlgorithm>
class ml::ClusterHandler< CLUSTERVOXELTYPE, DerivedAlgorithm >
ClusterHandler that is used to provide slice-by-slice data to the cluster algorithm.
Definition at line 65 of file mlClusterAlgorithm.h.
Constructor & Destructor Documentation
◆ ClusterHandler()
|
inline |
Definition at line 70 of file mlClusterAlgorithm.h.
References ML_RESULT_OK.
Member Function Documentation
◆ calculateInputSubImageBox()
|
inlineoverridevirtual |
Re-implement this method to specify the input image box for the input images By default, it returns outputSubImageBox for all inputs.
Reimplemented from ml::OrderedProcessAllPagesHandler.
Definition at line 105 of file mlClusterAlgorithm.h.
◆ calculateOutputImageProperties()
|
inlineoverridevirtual |
Re-implement this method to specify the virtual output image's datatype/size/page extent.
Make sure to call the base class method at the beginning of your method.
Reimplemented from ml::OrderedProcessAllPagesHandler.
Definition at line 85 of file mlClusterAlgorithm.h.
References ml::TVector6DBase< CompIntType >::c, ml::ImageProperties::getImageExtent(), MLint8Type, ml::PagedImage::setDataType(), ml::PagedImage::setImageExtent(), ml::PagedImage::setInputSubImageDataType(), ml::PagedImage::setInputSubImagesAreReadOnly(), ml::PagedImage::setPageExtent(), ml::TVector6DBase< CompIntType >::t, ml::TVector6DBase< CompIntType >::u, and ml::TVector6DBase< CompIntType >::z.
◆ getErrorCode()
|
inline |
Definition at line 129 of file mlClusterAlgorithm.h.
Referenced by ml::ClusterAlgorithm< CLUSTERVOXELTYPE, DerivedAlgorithm >::calcClustersForSlices().
◆ processTiles()
|
inlineoverridevirtual |
Re-implement this method to do the processing, return ML_RESULT_OK if processing should go on, otherwise return the appropriate error code.
Implements ml::OrderedProcessAllPagesHandler.
Definition at line 117 of file mlClusterAlgorithm.h.
◆ setParameters()
|
inline |
Stores all parameters that are needed to call the algorithm.
Definition at line 79 of file mlClusterAlgorithm.h.
Referenced by ml::ClusterAlgorithm< CLUSTERVOXELTYPE, DerivedAlgorithm >::calcClustersForSlices().
The documentation for this class was generated from the following file:
- MeVisLab/Standard/Sources/Shared/MLClusterAlgorithm/mlClusterAlgorithm.h
