Computer Assisted Medical Intervention Tool Kit  version 5.1
 
Loading...
Searching...
No Matches
BoxVOI Class Reference

Action to crop a volumic image. More...

#include <BoxVOI.h>

Public Slots

virtual camitk::Action::ApplyStatus apply ()
 this method is automatically called when the action is triggered.
 
virtual camitk::Action::ApplyStatus apply (QList< QVector3D > *seedPoints)
 Same method to be called manually with the parameters.
 
- Public Slots inherited from camitk::Action
virtual camitk::Action::ApplyStatus apply ()=0
 This method is called when the action has to be applied on the target list (get the target lists using getTargets()) It calls the algorithm of your action on the target list of components.
 
camitk::Action::ApplyStatus applyAndRegister ()
 This method is called whenever the action has to be applied on the target list (like the apply()) method AND registered within the application history of actions.
 
camitk::Action::ApplyStatus trigger (QWidget *parent=nullptr)
 This method triggers the action.
 

Public Member Functions

 BoxVOI (camitk::ActionExtension *)
 Default Constructor.
 
virtual QWidget * getWidget ()
 Returns the widget that allows one to modify the action parameters.
 
virtual ~BoxVOI ()
 Default Destructor.
 
- Public Member Functions inherited from camitk::Action
 Action (ActionExtension *)
 Default Constructor: the ActionExtension is needed.
 
 ~Action () override
 Destructor.
 
virtual QAction * getQAction (Component *target=nullptr)
 Get the corresponding QAction.
 
QString getName () const
 get the name of the action
 
QString getDescription () const
 the description of the action
 
QString getComponentClassName () const
 the name of the component class that can be used by this action
 
QString getFamily () const
 the name of the family in which this action is associated
 
QString getExtensionName () const
 the name of the extension in the family in which this action is associated
 
QStringList getTag () const
 the name of the tag called this action
 
bool getEmbedded () const
 argument use to know if the widget is embedded or not
 
virtual QPixmap getIcon ()
 the icon to personalize the action (no icon by default)
 
const ComponentList getTargets () const
 the currently selected and valid (regarding the component property) components, for which this action is called
 
void updateTargets ()
 update the target list using the currently selected components
 
bool getAutoUpdateProperties () const
 
void setAutoUpdateProperties (bool)
 are the properties to be updated every time the user makes a change in the widget (default is false)?
 
virtual Q_INVOKABLE camitk::PropertygetProperty (QString name)
 Get a Property given its name.
 
virtual bool addParameter (Property *)
 Add a new parameter to the action, using the CamiTK property class.
 
void applyTargetPosition (Component *input, Component *target)
 Change the target frame according to the default frame policy regarding the input's one.
 
void applyTargetPosition (Component *input, Component *target, Application::TargetPositionningPolicy policy)
 Change the target frame according to a given frame policy regarding the input's one.
 
ApplyStatus applyInPipeline ()
 This method encapsulates the apply() method.
 
void setInputComponents (ComponentList inputs)
 Specify the input Component(s) Only applyInPipeline() should be called with this method (maybe apply), but not trigger() as its first intruction is to clear the target components list !!!
 
void setInputComponent (Component *input)
 Specify the input Components in case of only one Component.
 
ComponentList getOutputComponents ()
 Returns the output Component(s)
 
ComponentgetOutputComponent ()
 Returns the output Components in case of only one Component.
 

Protected Attributes

QList< QVector3D > * seedPoints
 list of seed points
 
QWidget * theWidget
 The widget will be filled with parameters.
 
- Protected Attributes inherited from camitk::Action
QWidget * actionWidget
 the action widget
 

Additional Inherited Members

- Public Types inherited from camitk::Action
enum  ApplyStatus {
  SUCCESS , ERROR , WARNING , ABORTED ,
  TRIGGERED
}
 describes what happened during the application of an algorithm (i.e. results of the apply method) More...
 
- Static Public Member Functions inherited from camitk::Action
static QString getStatusAsString (ApplyStatus)
 
- Protected Member Functions inherited from camitk::Action
void setName (QString name)
 
void setDescription (QString description)
 the description of the action
 
void setComponentClassName (QString componentClassName)
 set the name of the component class that can be used by this action
 
void setFamily (QString family)
 the name of the family in which this action is associated
 
void addTag (QString tag)
 add a tag to the tags list of this action
 
void setEmbedded (bool isEmbedded)
 set the embedded property (an action is embedded by default, unless specified otherwise by explicitly calling this method with false)
 
void setIcon (QPixmap)
 set the Pixmap
 

Detailed Description

Action to crop a volumic image.

Constructor & Destructor Documentation

◆ BoxVOI()

◆ ~BoxVOI()

BoxVOI::~BoxVOI ( )
virtual

Default Destructor.

Member Function Documentation

◆ apply [1/2]

Action::ApplyStatus BoxVOI::apply ( )
virtualslot

this method is automatically called when the action is triggered.

!!! This method works only if theWidget has been instantiated (i.e. if getWidget has been called at least once, this is the case when there is a GUI) if not, please use the apply method with the parameters...

References camitk::Action::ABORTED, CAMITK_WARNING, camitk::Action::getTargets(), seedPoints, camitk::Action::SUCCESS, and theWidget.

◆ apply [2/2]

Action::ApplyStatus BoxVOI::apply ( QList< QVector3D > *  seedPoints)
virtualslot

Same method to be called manually with the parameters.

References camitk::Action::ABORTED, CAMITK_WARNING, camitk::Action::getTargets(), seedPoints, and camitk::Action::SUCCESS.

◆ getWidget()

QWidget * BoxVOI::getWidget ( )
virtual

Returns the widget that allows one to modify the action parameters.

Reimplemented from camitk::Action.

References camitk::Action::getTargets(), theWidget, and BoxVOIWidget::updateComponent().

Member Data Documentation

◆ seedPoints

QList<QVector3D>* BoxVOI::seedPoints
protected

list of seed points

Referenced by apply(), and apply().

◆ theWidget

QWidget* BoxVOI::theWidget
protected

The widget will be filled with parameters.

Referenced by apply(), BoxVOI(), and getWidget().


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