Computer Assited Medical Intervention Tool Kit  version 5.0
Derivative.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2021 Univ. Grenoble Alpes, CNRS, Grenoble INP, TIMC, 38000 Grenoble, France
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 #ifndef DERIVATIVE_H
26 #define DERIVATIVE_H
27 
28 #include <QObject>
29 #include <Action.h>
30 #include <ImageComponent.h>
31 #include <ActionWidget.h>
32 
33 #include "ITKFilterAPI.h"
34 
44  Q_OBJECT
45 
46 public:
48  enum derivativeOrder { ORDER_0, ORDER_1, ORDER_2 };
49  Q_ENUM(derivativeOrder)
50 
51 
52  enum derivativeDirection { DIRECTION_X, DIRECTION_Y, DIRECTION_Z };
53  Q_ENUM(derivativeDirection)
54 
55 
57 
59  virtual ~Derivative();
60 
61 public slots:
68 
69 private:
71  virtual void process(camitk::ImageComponent*);
72 
73 private:
74  vtkSmartPointer<vtkImageData> implementProcess(vtkSmartPointer<vtkImageData> img);
75 
76  template <class InputPixelType, class OutputPixelType, const int dim>
77  vtkSmartPointer<vtkImageData> itkProcess(vtkSmartPointer<vtkImageData> img);
78 
79 
80 protected:
81 
86  bool keepOrgVoxelType;
87 
93  int direction;
94 
96  int order;
97 };
98 
99 #endif // DERIVATIVE_H
camitk::Action::setFamily
void setFamily(QString family)
the name of the family in which this action is associated
Definition: Action.cpp:136
camitk::Action::SUCCESS
@ SUCCESS
everything went according to plan
Definition: Action.h:248
ITKFilterAPI.h
camitk::Property::setEnumTypeName
void setEnumTypeName(QString)
if the property's type is an enum, set the name of the registered Qt Enum.
Definition: Property.cpp:108
camitk::Action::ApplyStatus
ApplyStatus
Definition: Action.h:247
camitk::Action::setName
void setName(QString name)
Definition: Action.cpp:120
camitk::Action::setComponent
void setComponent(QString component)
the name of the component class that can be used by this action
Definition: Action.cpp:131
camitk::ItkProgressObserver::Pointer
itk::SmartPointer< Self > Pointer
Definition: ItkProgressObserver.h:96
camitk::ImageComponent
The manager of the Image Volume data. An image volume data has no concrete 3D representation,...
Definition: ImageComponent.h:77
camitk::Action::getTargets
const ComponentList getTargets() const
the currently selected and valid (regarding the component property) components, for which this action...
Definition: Action.cpp:166
Action.h
itkImageToVTKImageFilter.h
Derivative::Derivative
Derivative(camitk::ActionExtension *)
Default Constructor.
Definition: Derivative.cpp:42
camitk::Property
This class describes a property that can be used in components and actions or any class that needs to...
Definition: Property.h:303
ActionWidget.h
Derivative
Perform a derivative filter on the ImageComponent.
Definition: Derivative.h:43
camitk::Action::addTag
void addTag(QString tag)
add a tag to the tags list of this action
Definition: Action.cpp:141
Derivative::derivativeOrder
derivativeOrder
The 3 different possible derivative orders.
Definition: Derivative.h:71
camitk::Action
Action class is an abstract class that enables you to build a action (generally on a component)....
Definition: Action.h:231
Derivative::~Derivative
virtual ~Derivative()
Default Destructor.
Definition: Derivative.cpp:88
Property.h
camitk::Property::setAttribute
void setAttribute(const QString &attribute, const QVariant &value)
Set a given property for this attribute.
Definition: Property.cpp:183
camitk::Action::apply
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 usin...
Derivative::implementProcess
vtkSmartPointer< vtkImageData > implementProcess(vtkSmartPointer< vtkImageData > img)
Derivative::apply
virtual camitk::Action::ApplyStatus apply()
this method is automatically called when the action is triggered.
Definition: Derivative.cpp:93
Derivative::itkProcess
vtkSmartPointer< vtkImageData > itkProcess(vtkSmartPointer< vtkImageData > img)
Definition: Derivative.cpp:123
camitk::Action::setDescription
void setDescription(QString description)
the description of the action
Definition: Action.cpp:126
Derivative::process
virtual void process(camitk::ImageComponent *)
helper method to simplify the target component processing
Definition: Derivative.cpp:101
camitk::Component::getName
QString getName() const override
get the name to be displayed
Definition: sdk/libraries/core/component/Component.h:907
Derivative::DIRECTION_X
@ DIRECTION_X
Definition: Derivative.h:75
itk::ImageToVTKImageFilter
Converts an ITK image into a VTK image and plugs a itk data pipeline to a VTK datapipeline.
Definition: itkImageToVTKImageFilter.h:81
Derivative::keepOrgVoxelType
bool keepOrgVoxelType
The derivation requires a signed type for voxel.
Definition: Derivative.h:109
Derivative::derivativeDirection
derivativeDirection
The direction of the derivative.
Definition: Derivative.h:75
camitk::Action::addParameter
virtual bool addParameter(Property *)
Add a new parameter to the action, using the CamiTK property class.
Definition: Action.cpp:440
ITKFILTER_API
#define ITKFILTER_API
Definition: ITKFilterAPI.h:8
camitk::ActionExtension
This class describes what is a generic Action extension. To add a ActionExtension to CamiTK core,...
Definition: ActionExtension.h:80
Derivative::ORDER_0
@ ORDER_0
Definition: Derivative.h:94
camitk::ImageComponent::getImageData
vtkSmartPointer< vtkImageData > getImageData() const override
get the image volume managed by this Component
Definition: ImageComponent.h:123
itkVTKImageToImageFilter.h
camitk::refresh
void refresh()
refresh the display
itk::VTKImageToImageFilter
Converts a VTK image into an ITK image and plugs a vtk data pipeline to an ITK datapipeline.
Definition: itkVTKImageToImageFilter.h:58
ItkProgressObserver.h
Derivative::direction
int direction
The direction of the derivative 0-> derivate along x axis, 1-> derivate along y axis,...
Definition: Derivative.h:116
Derivative.h
ImageComponent.h
Derivative::order
int order
The order of the derivative.
Definition: Derivative.h:119
camitk::Component
A Component represents something that could be included in the explorer view, the interactive 3D view...
Definition: sdk/libraries/core/component/Component.h:302
Application.h
camitk
Definition: Action.cpp:35