Medical Imaging Interaction Toolkit
2024.12.99-d991a09f
Medical Imaging Interaction Toolkit
|
MonaiLabel segmentation tool base class. More...
#include <mitkMonaiLabelTool.h>
Public Member Functions | |
mitkClassMacro (MonaiLabelTool, SegWithPreviewTool) | |
Pointer | Clone () const |
void | Activated () override |
Called when the tool gets activated. More... | |
void | Deactivated () override |
Called when the tool gets deactivated. More... | |
void | UpdatePrepare () override |
void | FetchOverallInfo (const std::string &hostName, const int &port) |
Method does the GET Rest call to fetch MonaiLabel server metadata including all models' info. More... | |
const std::vector< MonaiModelInfo > | GetAutoSegmentationModels (const int dim=-1) const |
Get the Auto Segmentation Models info for the given dimension. More... | |
const std::vector< MonaiModelInfo > | GetInteractiveSegmentationModels (const int dim=-1) const |
Get the Interactive Segmentation Models info for the given dimension. More... | |
const std::vector< MonaiModelInfo > | GetScribbleSegmentationModels (const int dim=-1) const |
Get the Scribble Segmentation Models info for the given dimension. More... | |
MonaiModelInfo | GetModelInfoFromName (const std::string) const |
Helper function to get full model info object from model name. More... | |
virtual void | SetModelName (std::string _arg) |
virtual std::string | GetModelName () const |
virtual void | SetURL (std::string _arg) |
virtual std::string | GetURL () const |
virtual void | SetTempDir (std::string _arg) |
virtual std::string | GetTempDir () const |
virtual void | SetTimeout (unsigned int _arg) |
virtual unsigned int | GetTimeout () const |
const MonaiAppMetadata * | GetInfoParameters () const |
void | ClearPicks () |
Clears all picks and updates the preview. More... | |
bool | HasPicks () const |
Checks if any point exists in the either of the PointSetPositive or PointSetNegative. More... | |
![]() | |
mitkClassMacro (SegWithPreviewTool, Tool) | |
void | Activated () override |
Called when the tool gets activated. More... | |
void | Deactivated () override |
Called when the tool gets deactivated. More... | |
void | ConfirmSegmentation () |
virtual void | SetCreateAllTimeSteps (bool _arg) |
virtual bool | GetCreateAllTimeSteps () |
virtual void | CreateAllTimeStepsOn () |
virtual void | CreateAllTimeStepsOff () |
virtual void | SetKeepActiveAfterAccept (bool _arg) |
virtual bool | GetKeepActiveAfterAccept () |
virtual void | KeepActiveAfterAcceptOn () |
virtual void | KeepActiveAfterAcceptOff () |
virtual void | SetIsTimePointChangeAware (bool _arg) |
virtual bool | GetIsTimePointChangeAware () |
virtual void | IsTimePointChangeAwareOn () |
virtual void | IsTimePointChangeAwareOff () |
virtual void | SetResetsToEmptyPreview (bool _arg) |
virtual bool | GetResetsToEmptyPreview () |
virtual void | ResetsToEmptyPreviewOn () |
virtual void | ResetsToEmptyPreviewOff () |
virtual void | SetUseSpecialPreviewColor (bool _arg) |
virtual bool | GetUseSpecialPreviewColor () |
virtual void | UseSpecialPreviewColorOn () |
virtual void | UseSpecialPreviewColorOff () |
virtual void | SetRequestDeactivationConfirmation (bool _arg) |
virtual bool | GetRequestDeactivationConfirmation () |
virtual void | RequestDeactivationConfirmationOn () |
virtual void | RequestDeactivationConfirmationOff () |
void | SetMergeStyle (MultiLabelSegmentation::MergeStyle mergeStyle) |
virtual MultiLabelSegmentation::MergeStyle | GetMergeStyle () |
void | SetOverwriteStyle (MultiLabelSegmentation::OverwriteStyle overwriteStyle) |
virtual MultiLabelSegmentation::OverwriteStyle | GetOverwriteStyle () |
void | SetLabelTransferScope (LabelTransferScope labelTransferScope) |
virtual LabelTransferScope | GetLabelTransferScope () |
void | SetSelectedLabels (const SelectedLabelVectorType &labelsToTransfer) |
virtual SelectedLabelVectorType | GetSelectedLabels () |
void | SetLabelTransferMode (LabelTransferMode labelTransferMode) |
virtual LabelTransferMode | GetLabelTransferMode () |
bool | CanHandle (const BaseData *referenceData, const BaseData *workingData) const override |
void | UpdatePreview (bool ignoreLazyPreviewSetting=false) |
bool | IsUpdating () const |
std::string | GetCurrentSegmentationName () |
Gets the name of the currently selected segmentation node. More... | |
virtual DataNode * | GetTargetSegmentationNode () const |
Returns the currently selected segmentation node. More... | |
LabelSetImage * | GetTargetSegmentation () const |
LabelSetImage * | GetPreviewSegmentation () |
const LabelSetImage * | GetPreviewSegmentation () const |
DataNode * | GetPreviewSegmentationNode () |
![]() | |
mitkClassMacro (Tool, EventStateMachine) | |
virtual const char ** | GetXPM () const =0 |
Returns an icon in the XPM format. More... | |
virtual std::string | GetIconPath () const |
Returns the path of an icon. More... | |
virtual us::ModuleResource | GetCursorIconResource () const |
Returns the path of a cursor icon. More... | |
virtual us::ModuleResource | GetIconResource () const |
Returns the tool button icon of the tool wrapped by a usModuleResource. More... | |
virtual const char * | GetName () const =0 |
Returns the name of this tool. Make it short! More... | |
virtual void | InitializeStateMachine () |
virtual itk::Object::Pointer | GetGUI (const std::string &toolkitPrefix, const std::string &toolkitPostfix) |
Interface for GUI creation. More... | |
virtual NodePredicateBase::ConstPointer | GetReferenceDataPreference () const |
virtual NodePredicateBase::ConstPointer | GetWorkingDataPreference () const |
DataNode::Pointer | CreateEmptySegmentationNode (const Image *original, const std::string &organName, const mitk::Color &color) const |
DataNode::Pointer | CreateSegmentationNode (Image *image, const std::string &organName, const mitk::Color &color) const |
![]() | |
virtual std::vector< std::string > | GetClassHierarchy () const override |
virtual const char * | GetClassName () const |
bool | LoadStateMachine (const std::string &filename, const us::Module *module=nullptr) |
Loads XML resource. More... | |
bool | HandleEvent (InteractionEvent *event, DataNode *dataNode) |
void | EnableUndo (bool enable) |
Enables or disabled Undo. More... | |
void | EnableInteraction (bool enable) |
Enables/disables the state machine. In un-enabled state it won't react to any events. More... | |
![]() | |
bool | SetEventConfig (const std::string &filename, const us::Module *module=nullptr) |
Loads a configuration from an XML resource. More... | |
bool | SetEventConfig (const EventConfig &config) |
Loads a configuration from an EventConfig object. More... | |
EventConfig | GetEventConfig () const |
Returns the current configuration. More... | |
bool | AddEventConfig (const std::string &filename, const us::Module *module=nullptr) |
This method extends the configuration. More... | |
bool | AddEventConfig (const EventConfig &config) |
This method extends the configuration. The configuration from the EventConfig object is loaded and only the ones conflicting are replaced by the new one. This way several configurations can be combined. More... | |
![]() | |
InteractionEventObserver () | |
virtual | ~InteractionEventObserver () |
void | Disable () |
void | Enable () |
bool | IsEnabled () const |
Public Attributes | |
std::unique_ptr< MonaiLabelRequest > | m_RequestParameters |
Variable to set selected model's and other data needed for the POST call. More... | |
Message1< const bool > | MonaiStatusEvent |
![]() | |
Message | GUIProcessEventsMessage |
To let GUI process new events (e.g. qApp->processEvents() ) More... | |
Message1< std::string > | ErrorMessage |
To send error messages (to be shown by some GUI) More... | |
Message1< bool > | CurrentlyBusy |
To send whether the tool is busy (to be shown by some GUI) More... | |
Message1< std::string > | GeneralMessage |
To send general messages (to be shown by some GUI) More... | |
Protected Member Functions | |
MonaiLabelTool () | |
~MonaiLabelTool () | |
void | DoUpdatePreview (const Image *inputAtTimeStep, const Image *oldSegAtTimeStep, LabelSetImage *previewImage, TimeStepType timeStep) override |
void | ConnectActionsAndFunctions () override |
virtual void | WriteImage (const Image *, const std::string &) const =0 |
Writes image to disk as the tool desires. Default implementation does nothing. More... | |
virtual void | OnAddPositivePoint (StateMachineAction *, InteractionEvent *interactionEvent) |
virtual void | OnAddNegativePoint (StateMachineAction *, InteractionEvent *interactionEvent) |
virtual void | OnDelete (StateMachineAction *, InteractionEvent *) |
void | OnMove (StateMachineAction *, InteractionEvent *) |
void | OnRelease (StateMachineAction *, InteractionEvent *) |
void | OnPrimaryButtonPressed (StateMachineAction *, InteractionEvent *) |
void | ClearSeeds () |
virtual std::string | ConvertPointsAsListString (const mitk::BaseGeometry *baseGeometry, const PointSet::Pointer pointSet) const |
Get the Points from given pointset as csv string. More... | |
virtual void | WriteBackResults (LabelSetImage *, LabelSetImage *, TimeStepType) const =0 |
Writes back segmentation results in 3D or 2D shape to preview LabelSetImage. More... | |
![]() | |
SegWithPreviewTool (bool lazyDynamicPreviews=false) | |
SegWithPreviewTool (bool lazyDynamicPreviews, const char *interactorType, const us::Module *interactorModule=nullptr) | |
~SegWithPreviewTool () override | |
const char * | GetGroup () const override |
Name of a group. More... | |
void | EnsureTargetSegmentationNodeInDataStorage () const |
virtual void | InitiateToolByInput () |
virtual void | UpdateCleanUp () |
virtual void | ConfirmCleanUp () |
virtual void | PreparePreviewToResultTransfer (const LabelMappingType &labelMapping) |
const Image * | GetSegmentationInput () const |
const Image * | GetReferenceData () const |
void | ResetPreviewNode () |
void | ResetPreviewContent () |
void | ResetPreviewContentAtTimeStep (unsigned int timeStep) |
TimePointType | GetLastTimePointOfUpdate () const |
LabelSetImage::LabelValueType | GetActiveLabelValueOfPreview () const |
virtual Label::PixelType | GetUserDefinedActiveLabel () const |
virtual void | SetWorkingPlaneGeometry (PlaneGeometry *_arg) |
virtual const PlaneGeometry * | GetWorkingPlaneGeometry () |
bool | ConfirmBeforeDeactivation () override |
Method call to invoke a dialog box just before exiting. The method can be reimplemented in the respective tool class with business logic on when there should be a confirmation dialog from the user before the tool exits. More... | |
![]() | |
virtual void | SetToolManager (ToolManager *) |
ToolManager * | GetToolManager () const |
mitk::DataStorage * | GetDataStorage () const |
void | ConnectActionsAndFunctions () override |
Tool (const char *, const us::Module *interactorModule=nullptr) | |
~Tool () override | |
void | Notify (InteractionEvent *interactionEvent, bool isHandled) override |
bool | FilterEvents (InteractionEvent *, DataNode *) override |
![]() | |
EventStateMachine () | |
~EventStateMachine () override | |
void | AddActionFunction (const std::string &action, TActionFunctor *functor) |
void | AddActionFunction (const std::string &action, const ActionFunctionDelegate &delegate) |
void | AddConditionFunction (const std::string &condition, const ConditionFunctionDelegate &delegate) |
StateMachineState * | GetCurrentState () const |
void | ResetToStartState () |
ResetToStartState Reset state machine to it initial starting state. More... | |
virtual bool | CheckCondition (const StateMachineCondition &condition, const InteractionEvent *interactionEvent) |
virtual void | ExecuteAction (StateMachineAction *action, InteractionEvent *interactionEvent) |
void | SetMouseCursor (const char *xpm[], int hotspotX, int hotspotY) |
Sets the specified mouse cursor. More... | |
void | ResetMouseCursor () |
Resets the mouse cursor to its original state. More... | |
StateMachineTransition * | GetExecutableTransition (InteractionEvent *event) |
Returns the executable transition for the given event. More... | |
![]() | |
InteractionEventHandler () | |
~InteractionEventHandler () override | |
PropertyList::Pointer | GetAttributes () const |
std::string | MapToEventVariant (InteractionEvent *interactionEvent) |
virtual void | ConfigurationChanged () |
Protected Attributes | |
PointSet::Pointer | m_PointSetPositive |
PointSet::Pointer | m_PointSetNegative |
DataNode::Pointer | m_PointSetNodePositive |
DataNode::Pointer | m_PointSetNodeNegative |
int | m_PointSetCount |
![]() | |
ToolCommand::Pointer | m_ProgressCommand |
![]() | |
std::string | m_EventConfig |
Let subclasses change their event configuration. More... | |
![]() | |
bool | m_IsActive |
UndoController * | m_UndoController |
bool | m_UndoEnabled |
MonaiLabel segmentation tool base class.
Definition at line 104 of file mitkMonaiLabelTool.h.
|
protected |
|
protected |
|
overridevirtual |
Called when the tool gets activated.
Derived tools should call their parents implementation at the beginning of the overriding function.
Reimplemented from mitk::Tool.
void mitk::MonaiLabelTool::ClearPicks | ( | ) |
Clears all picks and updates the preview.
|
protected |
Pointer mitk::MonaiLabelTool::Clone | ( | ) | const |
|
overrideprotectedvirtual |
Is called after loading a statemachine. Overwrite this function in specific interactor implementations. Connect actions and functions using the CONNECT_FUNCTION macro within this function.
Reimplemented from mitk::EventStateMachine.
|
protectedvirtual |
Get the Points from given pointset as csv string.
|
overridevirtual |
Called when the tool gets deactivated.
Derived tools should call their parents implementation at the end of the overriding function.
Reimplemented from mitk::Tool.
|
overrideprotectedvirtual |
This function does the real work. Here the preview for a given input image should be computed and stored in the also passed preview image at the passed time step. It also provides the current/old segmentation at the time point, which can be used, if the preview depends on the the segmentation so far.
Implements mitk::SegWithPreviewTool.
void mitk::MonaiLabelTool::FetchOverallInfo | ( | const std::string & | hostName, |
const int & | port | ||
) |
Method does the GET Rest call to fetch MonaiLabel server metadata including all models' info.
const std::vector<MonaiModelInfo> mitk::MonaiLabelTool::GetAutoSegmentationModels | ( | const int | dim = -1 | ) | const |
Get the Auto Segmentation Models info for the given dimension.
const MonaiAppMetadata* mitk::MonaiLabelTool::GetInfoParameters | ( | ) | const |
const std::vector<MonaiModelInfo> mitk::MonaiLabelTool::GetInteractiveSegmentationModels | ( | const int | dim = -1 | ) | const |
Get the Interactive Segmentation Models info for the given dimension.
MonaiModelInfo mitk::MonaiLabelTool::GetModelInfoFromName | ( | const std::string | ) | const |
Helper function to get full model info object from model name.
|
virtual |
const std::vector<MonaiModelInfo> mitk::MonaiLabelTool::GetScribbleSegmentationModels | ( | const int | dim = -1 | ) | const |
Get the Scribble Segmentation Models info for the given dimension.
|
virtual |
|
virtual |
|
virtual |
bool mitk::MonaiLabelTool::HasPicks | ( | ) | const |
Checks if any point exists in the either of the PointSetPositive or PointSetNegative.
mitk::MonaiLabelTool::mitkClassMacro | ( | MonaiLabelTool | , |
SegWithPreviewTool | |||
) |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protected |
|
protected |
|
protected |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
overridevirtual |
This member function offers derived classes the possibility to alter what should happen directly before the update of the preview is performed. It is called by UpdatePreview. Default implementation does nothing.
Reimplemented from mitk::SegWithPreviewTool.
|
protectedpure virtual |
Writes back segmentation results in 3D or 2D shape to preview LabelSetImage.
Implemented in mitk::MonaiLabel2DTool, and mitk::MonaiLabel3DTool.
|
protectedpure virtual |
Writes image to disk as the tool desires. Default implementation does nothing.
Implemented in mitk::MonaiLabel2DTool, and mitk::MonaiLabel3DTool.
|
protected |
Definition at line 225 of file mitkMonaiLabelTool.h.
|
protected |
Definition at line 222 of file mitkMonaiLabelTool.h.
|
protected |
Definition at line 224 of file mitkMonaiLabelTool.h.
|
protected |
Definition at line 223 of file mitkMonaiLabelTool.h.
|
protected |
Definition at line 221 of file mitkMonaiLabelTool.h.
std::unique_ptr<MonaiLabelRequest> mitk::MonaiLabelTool::m_RequestParameters |
Variable to set selected model's and other data needed for the POST call.
Definition at line 123 of file mitkMonaiLabelTool.h.
Message1<const bool> mitk::MonaiLabelTool::MonaiStatusEvent |
Definition at line 171 of file mitkMonaiLabelTool.h.