Computer Assited Medical Intervention Tool Kit  version 4.1
Public Slots | Public Member Functions | Protected Attributes | List of all members
PixelColorChanger Class Reference

#include <PixelColorChanger.h>

Inherits camitk::Action.

Public Slots

virtual ApplyStatus apply ()
 this method is automatically called when the action is triggered. More...
 
- Public Slots inherited from camitk::Action
virtual 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. More...
 
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. More...
 
ApplyStatus trigger (QWidget *parent=nullptr)
 This method triggers the action. More...
 

Public Member Functions

virtual QWidget * getWidget ()
 method called when the action when the action is triggered (i.e. started) More...
 
 PixelColorChanger (camitk::ActionExtension *)
 Default Constructor. More...
 
virtual ~PixelColorChanger ()
 Default Destructor. More...
 
- Public Member Functions inherited from camitk::Action
 Action (ActionExtension *)
 Default Constructor: the ActionExtension is needed. More...
 
ComponentgetOutputComponent ()
 Returns the output Components in case of only one Component. More...
 
ComponentList getOutputComponents ()
 Returns the output Component(s) More...
 
void setInputComponent (Component *input)
 Specify the input Components in case of only one Component. More...
 
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 !!! More...
 
 ~Action () override
 Destructor. More...
 
QAction * getQAction ()
 Get the corresponding QAction. More...
 
QString getName () const
 get the name of the action More...
 
QString getDescription () const
 the description of the action More...
 
QString getComponent () const
 the name of the component class that can be used by this action More...
 
QString getFamily () const
 the name of the family in which this action is associated More...
 
QString getExtensionName () const
 the name of the extension in the family in which this action is associated More...
 
QStringList getTag () const
 the name of the tag called this action More...
 
bool getEmbedded () const
 argument use to know if the widget is embedded or not More...
 
virtual QPixmap getIcon ()
 the icon to personalize the action (no icon by default) More...
 
const ComponentList getTargets () const
 the currently selected and valid (regarding the component property) components, for which this action is called More...
 
bool getAutoUpdateProperties () const
 
void setAutoUpdateProperties (bool)
 are the properties to be udpated every time the user makes a change in the widget (default is false)? More...
 
virtual Q_INVOKABLE PropertygetProperty (QString name)
 Get a Property given its name. More...
 
virtual bool addParameter (Property *)
 Add a new parameter to the action, using the CamiTK property class. More...
 
void applyTargetPosition (Component *input, Component *target)
 Change the target frame according to the default frame policy regarding the input's one. More...
 
void applyTargetPosition (Component *input, Component *target, Application::TargetPositionningPolicy policy)
 Change the target frame according to a given frame policy regarding the input's one. More...
 
ApplyStatus applyInPipeline ()
 This method encapsulates the apply() method. More...
 

Protected Attributes

bool isConnected
 is the widget automatically connected to image picking More...
 
int newColorValue
 new color given to picked pixel More...
 
int sizei
 size to draw pixels on i axis More...
 
int sizej
 size to draw pixels on j axis More...
 
int sizek
 size to draw pixels on k axis More...
 
- Protected Attributes inherited from camitk::Action
QWidget * actionWidget
 the action widget More...
 

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 More...
 
void setComponent (QString component)
 the name of the component class that can be used by this action More...
 
void setFamily (QString family)
 the name of the family in which this action is associated More...
 
void addTag (QString tag)
 add a tag to the tags list of this action More...
 
void setEmbedded (bool isEmbedded)
 set the embedded property (an action is embedded by default, unless specified otherwise by explicitly calling this method with false) More...
 
void setIcon (QPixmap)
 set the Pixmap More...
 

Constructor & Destructor Documentation

◆ PixelColorChanger()

PixelColorChanger::PixelColorChanger ( camitk::ActionExtension extension)

◆ ~PixelColorChanger()

PixelColorChanger::~PixelColorChanger ( )
virtual

Default Destructor.

Member Function Documentation

◆ apply

Action::ApplyStatus PixelColorChanger::apply ( )
virtualslot

this method is automatically called when the action is triggered.

Use getTargets() QList to get the list of component to use.

Note
getTargets() is automatically filtered so that it only contains compatible components, i.e., instances of ImageComponent (or a subclass).

References camitk::ImageComponent::getImageData(), camitk::ImageComponent::getLastPixelPicked(), camitk::ImageComponent::getLut(), camitk::Action::getTargets(), getWidget(), isConnected, newColorValue, sizei, sizej, sizek, and camitk::Action::SUCCESS.

Referenced by getWidget().

◆ getWidget()

QWidget * PixelColorChanger::getWidget ( )
virtual

method called when the action when the action is triggered (i.e. started)

Reimplemented from camitk::Action.

References apply(), and isConnected.

Referenced by apply().

Member Data Documentation

◆ isConnected

bool PixelColorChanger::isConnected
protected

is the widget automatically connected to image picking

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

◆ newColorValue

int PixelColorChanger::newColorValue
protected

new color given to picked pixel

Referenced by apply().

◆ sizei

int PixelColorChanger::sizei
protected

size to draw pixels on i axis

Referenced by apply().

◆ sizej

int PixelColorChanger::sizej
protected

size to draw pixels on j axis

Referenced by apply().

◆ sizek

int PixelColorChanger::sizek
protected

size to draw pixels on k axis

Referenced by apply().


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