ml::KernelEditor Class Reference
The class to edit a 6D kernel. More...
#include <mlKernelEditor.h>
Public Member Functions | |
| KernelEditor () | |
| Constructor. | |
Method(s) to access fields. Refer to field documentation for more infos. | |
| IntField * | getKernelXFld () const |
| IntField * | getKernelYFld () const |
| IntField * | getKernelZFld () const |
| IntField * | getKernelCFld () const |
| IntField * | getKernelTFld () const |
| IntField * | getKernelUFld () const |
| IntField * | getFieldWidthFld () const |
| IntField * | getPrecisionFld () const |
| DoubleField * | getValueFld () const |
| NotifyField * | getSetExtFld () const |
| NotifyField * | getSetElementValuesFld () const |
| NotifyField * | getFillFld () const |
| NotifyField * | getAddFld () const |
| NotifyField * | getSubFld () const |
| NotifyField * | getMultFld () const |
| NotifyField * | getDivFld () const |
| NotifyField * | getSqrFld () const |
| NotifyField * | getSqrtFld () const |
| NotifyField * | getInvDivFld () const |
| NotifyField * | getInvSubFld () const |
| NotifyField * | getPowFld () const |
| NotifyField * | getLogFld () const |
| NotifyField * | getGaussFld () const |
| NotifyField * | getNormalizeFld () const |
| NotifyField * | getSphereFld () const |
| NotifyField * | getMirrorFld () const |
| NotifyField * | getMirrorXFld () const |
| NotifyField * | getMirrorYFld () const |
| NotifyField * | getMirrorZFld () const |
| NotifyField * | getMirrorCFld () const |
| NotifyField * | getMirrorTFld () const |
| NotifyField * | getMirrorUFld () const |
| NotifyField * | getUndoFld () const |
| NotifyField * | getRedoFld () const |
| IntField * | getNumElementsFld () const |
| DoubleField * | getElementSumFld () const |
| StringField * | getInfoFld () const |
| StringField * | getKernelStringFld () const |
Protected Member Functions | |
| virtual void | activateAttachments () |
| Called when field settings are finished after load. | |
| virtual void | handleNotification (Field *field) |
| Called when a parameter field is changed. | |
| virtual void | _stringToKernel (bool addToUndo=true) |
Converts current editor string to a kernel and append it to the undo list if addToUndo is true. | |
| virtual void | _kernelToString (bool addToUndo=true) |
Converts the current kernel to the editor string and append it to the undo list if addToUndo is true. | |
| virtual void | _updateInfo (std::string errString="") |
| Update the kernel information line with kernel infos or error lines. | |
Parameter declaration of image processing parameters. | |
| Kernel | _kernel |
| Copy of the kernel currently defined by the application. | |
| MLint | _recEntries |
| Counter for recursive entries in handleNotifications. | |
| std::vector< std::string > | _undoList |
| List of strings to push recent kernels. | |
| std::vector< std::string > | _redoList |
| List of strings to redo recent kernels. | |
| SubImageBox | calculateInputSubImageBox (int, const SubImageBox &, int) |
| We don't need any input image to calculate the output. So return an empty box. | |
| void | calculateOutputImageProperties (int) |
| Return kernel size as output image size. Set page size to 64x64x1x1x1x1. | |
| void | calculateOutputSubImage (SubImage *outSubImg, int, SubImage *) |
Implements the call of calculateOutputSubImage() for all data types. | |
| template<typename DATATYPE > | |
| void | calculateOutputSubImage (TSubImage< DATATYPE > *outSubImg, int outIndex) |
| Return kernel as output image. | |
| ML_MODULE_CLASS_HEADER (KernelEditor) | |
| Macro to declare methods for the runtime system, defined in mlRuntimeSubClass.h. | |
Detailed Description
The class to edit a 6D kernel.This class implements a simple 6d editor for kernels.
For related code and more information see mlKernelExample.h, mlKernel.h, mlKernelBaseModule.h, mlKernelModule.h, mlKernelEditor.h, mlRankFilter.h, mlExtConvolutionFilter.h, mlKernelMacros, mlKernelTools.h and mlConvolutionFilter.h.
Definition at line 34 of file mlKernelEditor.h.
Constructor & Destructor Documentation
| ml::KernelEditor::KernelEditor | ( | ) |
Constructor.
Initializes the fields, the members and the field connections with the field container.
Member Function Documentation
| virtual void ml::KernelEditor::_kernelToString | ( | bool | addToUndo = true |
) | [protected, virtual] |
Converts the current kernel to the editor string and append it to the undo list if addToUndo is true.
| virtual void ml::KernelEditor::_stringToKernel | ( | bool | addToUndo = true |
) | [protected, virtual] |
Converts current editor string to a kernel and append it to the undo list if addToUndo is true.
| virtual void ml::KernelEditor::_updateInfo | ( | std::string | errString = "" |
) | [protected, virtual] |
Update the kernel information line with kernel infos or error lines.
| virtual void ml::KernelEditor::activateAttachments | ( | ) | [protected, virtual] |
Called when field settings are finished after load.
It's necessary to update the kernel then to the current state of the fields.
Reimplemented from ml::FieldContainer.
| SubImageBox ml::KernelEditor::calculateInputSubImageBox | ( | int | , | |
| const SubImageBox & | , | |||
| int | ||||
| ) | [inline, protected, virtual] |
We don't need any input image to calculate the output. So return an empty box.
Reimplemented from ml::Module.
Definition at line 185 of file mlKernelEditor.h.
| void ml::KernelEditor::calculateOutputImageProperties | ( | int | ) | [protected, virtual] |
Return kernel size as output image size. Set page size to 64x64x1x1x1x1.
Reimplemented from ml::Module.
| void ml::KernelEditor::calculateOutputSubImage | ( | TSubImage< DATATYPE > * | outSubImg, | |
| int | outIndex | |||
| ) | [inline, protected] |
Return kernel as output image.
| NotifyField* ml::KernelEditor::getAddFld | ( | ) | const [inline] |
Definition at line 60 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getDivFld | ( | ) | const [inline] |
Definition at line 63 of file mlKernelEditor.h.
| DoubleField* ml::KernelEditor::getElementSumFld | ( | ) | const [inline] |
Definition at line 83 of file mlKernelEditor.h.
| IntField* ml::KernelEditor::getFieldWidthFld | ( | ) | const [inline] |
Definition at line 54 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getFillFld | ( | ) | const [inline] |
Definition at line 59 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getGaussFld | ( | ) | const [inline] |
Definition at line 70 of file mlKernelEditor.h.
| StringField* ml::KernelEditor::getInfoFld | ( | ) | const [inline] |
Definition at line 84 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getInvDivFld | ( | ) | const [inline] |
Definition at line 66 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getInvSubFld | ( | ) | const [inline] |
Definition at line 67 of file mlKernelEditor.h.
| IntField* ml::KernelEditor::getKernelCFld | ( | ) | const [inline] |
Definition at line 51 of file mlKernelEditor.h.
| StringField* ml::KernelEditor::getKernelStringFld | ( | ) | const [inline] |
Definition at line 85 of file mlKernelEditor.h.
| IntField* ml::KernelEditor::getKernelTFld | ( | ) | const [inline] |
Definition at line 52 of file mlKernelEditor.h.
| IntField* ml::KernelEditor::getKernelUFld | ( | ) | const [inline] |
Definition at line 53 of file mlKernelEditor.h.
| IntField* ml::KernelEditor::getKernelXFld | ( | ) | const [inline] |
Definition at line 48 of file mlKernelEditor.h.
| IntField* ml::KernelEditor::getKernelYFld | ( | ) | const [inline] |
Definition at line 49 of file mlKernelEditor.h.
| IntField* ml::KernelEditor::getKernelZFld | ( | ) | const [inline] |
Definition at line 50 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getLogFld | ( | ) | const [inline] |
Definition at line 69 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getMirrorCFld | ( | ) | const [inline] |
Definition at line 77 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getMirrorFld | ( | ) | const [inline] |
Definition at line 73 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getMirrorTFld | ( | ) | const [inline] |
Definition at line 78 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getMirrorUFld | ( | ) | const [inline] |
Definition at line 79 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getMirrorXFld | ( | ) | const [inline] |
Definition at line 74 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getMirrorYFld | ( | ) | const [inline] |
Definition at line 75 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getMirrorZFld | ( | ) | const [inline] |
Definition at line 76 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getMultFld | ( | ) | const [inline] |
Definition at line 62 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getNormalizeFld | ( | ) | const [inline] |
Definition at line 71 of file mlKernelEditor.h.
| IntField* ml::KernelEditor::getNumElementsFld | ( | ) | const [inline] |
Definition at line 82 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getPowFld | ( | ) | const [inline] |
Definition at line 68 of file mlKernelEditor.h.
| IntField* ml::KernelEditor::getPrecisionFld | ( | ) | const [inline] |
Definition at line 55 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getRedoFld | ( | ) | const [inline] |
Definition at line 81 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getSetElementValuesFld | ( | ) | const [inline] |
Definition at line 58 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getSetExtFld | ( | ) | const [inline] |
Definition at line 57 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getSphereFld | ( | ) | const [inline] |
Definition at line 72 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getSqrFld | ( | ) | const [inline] |
Definition at line 64 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getSqrtFld | ( | ) | const [inline] |
Definition at line 65 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getSubFld | ( | ) | const [inline] |
Definition at line 61 of file mlKernelEditor.h.
| NotifyField* ml::KernelEditor::getUndoFld | ( | ) | const [inline] |
Definition at line 80 of file mlKernelEditor.h.
| DoubleField* ml::KernelEditor::getValueFld | ( | ) | const [inline] |
Definition at line 56 of file mlKernelEditor.h.
| virtual void ml::KernelEditor::handleNotification | ( | Field * | field | ) | [protected, virtual] |
| ml::KernelEditor::ML_MODULE_CLASS_HEADER | ( | KernelEditor | ) | [protected] |
Macro to declare methods for the runtime system, defined in mlRuntimeSubClass.h.
Moreover this class must be registered in the initialization file mlInitDllExampleOps.h.
Member Data Documentation
Kernel ml::KernelEditor::_kernel [protected] |
Copy of the kernel currently defined by the application.
Definition at line 169 of file mlKernelEditor.h.
MLint ml::KernelEditor::_recEntries [protected] |
Counter for recursive entries in handleNotifications.
Definition at line 172 of file mlKernelEditor.h.
std::vector<std::string> ml::KernelEditor::_redoList [protected] |
std::vector<std::string> ml::KernelEditor::_undoList [protected] |
The documentation for this class was generated from the following file:
- MeVisLab/Standard/Sources/ML/MLKernel/mlKernelEditor.h
