Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::AutoCropTool Class Reference

Crops selected segmentations to the smallest bounding box enclosing non-zero pixels. More...

#include <mitkAutoCropTool.h>

Inheritance diagram for mitk::AutoCropTool:
Collaboration diagram for mitk::AutoCropTool:

Public Member Functions

 mitkClassMacro (AutoCropTool, SegmentationsProcessingTool)
 
Pointer Clone () const
 
const char * GetName () const override
 Return the human-readable name of this tool ("Crop"). More...
 
- Public Member Functions inherited from mitk::SegmentationsProcessingTool
 mitkClassMacro (SegmentationsProcessingTool, Tool)
 
- Public Member Functions inherited from mitk::Tool
 mitkClassMacro (Tool, EventStateMachine)
 
virtual us::ModuleResource GetCursorIconResource () const
 Returns the cursor icon of the tool wrapped by a usModuleResource. More...
 
virtual us::ModuleResource GetIconResource () const
 Returns the tool button icon of the tool wrapped by a usModuleResource. More...
 
virtual mitk::Label::AlgorithmType GetAlgorithmType () const
 Returns the intrinsic algorithm type of this tool, used to stamp label provenance. More...
 
virtual bool IsEligibleForAutoInit () const
 Returns whether this tool is eligible for auto-initialization by ToolManager. More...
 
virtual void InitializeStateMachine ()
 Initializes the state machine for this tool based on the interaction type. More...
 
virtual itk::Object::Pointer GetGUI (const std::string &toolkitPrefix, const std::string &toolkitPostfix)
 Interface for GUI creation. More...
 
virtual NodePredicateBase::ConstPointer GetReferenceDataPreference () const
 Returns a predicate describing valid reference data for this tool. More...
 
virtual NodePredicateBase::ConstPointer GetWorkingDataPreference () const
 Returns a predicate describing valid working data for this tool. More...
 
virtual bool CanHandle (const BaseData *referenceData, const BaseData *workingData) const
 Checks if a tool can handle the given reference data and optional working data. More...
 
virtual bool ConfirmBeforeDeactivation ()
 Method call to invoke a dialog box just before exiting. More...
 
- Public Member Functions inherited from mitk::EventStateMachine
 mitkClassMacro (EventStateMachine, InteractionEventHandler)
 
bool LoadStateMachine (const std::string &filename, const us::Module *module=nullptr)
 Load a state machine pattern from an XML resource file. More...
 
bool HandleEvent (InteractionEvent *event, DataNode *dataNode)
 Process an incoming interaction event. More...
 
void EnableUndo (bool enable)
 Enable or disable the undo mechanism for this state machine. More...
 
void EnableInteraction (bool enable)
 Enable or disable the state machine. More...
 
- Public Member Functions inherited from mitk::InteractionEventHandler
 mitkClassMacroItkParent (InteractionEventHandler, itk::Object)
 
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...
 
- Public Member Functions inherited from mitk::InteractionEventObserver
 InteractionEventObserver ()
 
virtual ~InteractionEventObserver ()
 
void Disable ()
 Disable this observer so it no longer receives notifications. More...
 
void Enable ()
 Enable this observer so it receives notifications. More...
 
bool IsEnabled () const
 Check whether this observer is currently enabled. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

bool ProcessOneWorkingData (DataNode *node) override
 Crop a single working data node to its foreground bounding box. More...
 
std::string GetErrorMessage () override
 Return a user-facing error message prefix for failed crop operations. More...
 
 AutoCropTool ()
 
 ~AutoCropTool () override
 
- Protected Member Functions inherited from mitk::SegmentationsProcessingTool
 SegmentationsProcessingTool ()
 
 ~SegmentationsProcessingTool () override
 
const char * GetGroup () const override
 Name of a group. More...
 
void Activated () override
 Called when the tool gets activated. More...
 
void Deactivated () override
 Called when the tool gets deactivated. More...
 
virtual void ProcessAllObjects ()
 Loop over all working data items. More...
 
virtual void StartProcessingAllData ()
 Subclasses should override this method. More...
 
virtual void FinishProcessingAllData ()
 Subclasses should override this method. More...
 
virtual void SendErrorMessageIfAny ()
 Sends an error message if there was an error during processing. More...
 
- Protected Member Functions inherited from mitk::Tool
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
 Called by the Dispatcher to notify this observer about an InteractionEvent. More...
 
bool FilterEvents (InteractionEvent *, DataNode *) override
 
- Protected Member Functions inherited from mitk::EventStateMachine
 EventStateMachine ()
 
 ~EventStateMachine () override
 
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...
 
- Protected Member Functions inherited from mitk::InteractionEventHandler
 InteractionEventHandler ()
 
 ~InteractionEventHandler () override
 
PropertyList::Pointer GetAttributes () const
 
std::string MapToEventVariant (InteractionEvent *interactionEvent)
 
virtual void ConfigurationChanged ()
 

Additional Inherited Members

- Public Types inherited from mitk::Tool
typedef mitk::Label::PixelType DefaultSegmentationDataType
 
- Public Types inherited from mitk::EventStateMachine
typedef itk::SmartPointer< StateMachineState > StateMachineStateType
 
- Public Attributes inherited from mitk::Tool
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 Types inherited from mitk::EventStateMachine
typedef MessageAbstractDelegate2< StateMachineAction *, InteractionEvent *, void > ActionFunctionDelegate
 
typedef MessageAbstractDelegate1< const InteractionEvent *, bool > ConditionFunctionDelegate
 
- Protected Attributes inherited from mitk::SegmentationsProcessingTool
std::string m_FailedNodes
 
- Protected Attributes inherited from mitk::Tool
std::string m_EventConfig
 Let subclasses change their event configuration. More...
 
- Protected Attributes inherited from mitk::EventStateMachine
bool m_IsActive
 
UndoController * m_UndoController
 
bool m_UndoEnabled
 

Detailed Description

Crops selected segmentations to the smallest bounding box enclosing non-zero pixels.

See also
mitk::Tool
QmitkInteractiveSegmentation

Uses AutoCropImageFilter internally to determine the minimal bounding box around the foreground region (non-zero pixels) and replaces the node data with the cropped result.

Definition at line 33 of file mitkAutoCropTool.h.

Constructor & Destructor Documentation

◆ AutoCropTool()

mitk::AutoCropTool::AutoCropTool ( )
protected

◆ ~AutoCropTool()

mitk::AutoCropTool::~AutoCropTool ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::AutoCropTool::Clone ( ) const

◆ GetErrorMessage()

std::string mitk::AutoCropTool::GetErrorMessage ( )
overrideprotectedvirtual

Return a user-facing error message prefix for failed crop operations.

Reimplemented from mitk::SegmentationsProcessingTool.

◆ GetName()

const char* mitk::AutoCropTool::GetName ( ) const
overridevirtual

Return the human-readable name of this tool ("Crop").

Implements mitk::Tool.

◆ mitkClassMacro()

mitk::AutoCropTool::mitkClassMacro ( AutoCropTool  ,
SegmentationsProcessingTool   
)

◆ New()

static Pointer mitk::AutoCropTool::New ( )
static

◆ ProcessOneWorkingData()

bool mitk::AutoCropTool::ProcessOneWorkingData ( DataNode *  node)
overrideprotectedvirtual

Crop a single working data node to its foreground bounding box.

Returns
True on success, false if the node is null or processing fails.

Reimplemented from mitk::SegmentationsProcessingTool.


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