RTK  2.0.1
Reconstruction Toolkit
rtkConjugateGradientImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright RTK Consortium
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 
19 #ifndef rtkConjugateGradientImageFilter_h
20 #define rtkConjugateGradientImageFilter_h
21 
22 #include <itkSubtractImageFilter.h>
24 #include <itkTimeProbe.h>
25 
27 
32 
33 namespace rtk
34 {
35 
45 template< typename OutputImageType>
46 class ConjugateGradientImageFilter : public itk::InPlaceImageFilter< OutputImageType, OutputImageType>
47 {
48 public:
49  ITK_DISALLOW_COPY_AND_ASSIGN(ConjugateGradientImageFilter);
50 
57  using OutputImagePointer = typename OutputImageType::Pointer;
58 
60  itkNewMacro(Self)
61 
62 
64 
66  itkGetMacro(NumberOfIterations, int)
67  itkSetMacro(NumberOfIterations, int)
68 
70  itkGetMacro(IterationCosts, bool)
71  itkSetMacro(IterationCosts, bool)
72 
74 
76  void SetX(const OutputImageType* OutputImage);
77 
79  void SetB(const OutputImageType* OutputImage);
80 
82  void SetC(const double _arg);
83  double GetC();
85 
87  const std::vector<double> &GetResidualCosts();
88 
89 protected:
90  ConjugateGradientImageFilter();
91  ~ConjugateGradientImageFilter() override = default;
92 
95 
97  void GenerateData() override;
98 
100  void GenerateInputRequestedRegion() override;
101  void GenerateOutputInformation() override;
103 
105 
108  std::vector<double> m_ResidualCosts;
109  double m_C;
110 };
111 } //namespace RTK
112 
113 
114 #ifndef ITK_MANUAL_INSTANTIATION
115 #include "rtkConjugateGradientImageFilter.hxx"
116 #endif
117 
118 #endif
typename OutputImageType::Pointer OutputImagePointer
void SetC(const double _arg)
void SetA(ConjugateGradientOperatorPointerType _arg)
void GenerateOutputInformation() override
STL namespace.
typename ConjugateGradientOperatorType::Pointer ConjugateGradientOperatorPointerType
void GenerateInputRequestedRegion() override
TOutputImage OutputImageType
void SetB(const OutputImageType *OutputImage)
void SetX(const OutputImageType *OutputImage)
ConjugateGradientOperatorPointerType m_A
const std::vector< double > & GetResidualCosts()
Solves AX = B by conjugate gradient.
#define itkSetMacro(name, type)