File: itkEigenAnalysis2DImageFilter.h

package info (click to toggle)
insighttoolkit5 5.4.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 704,384 kB
  • sloc: cpp: 783,592; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 464; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (149 lines) | stat: -rw-r--r-- 4,998 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkEigenAnalysis2DImageFilter_h
#define itkEigenAnalysis2DImageFilter_h

#include "itkImageToImageFilter.h"

namespace itk
{
/** \class EigenAnalysis2DImageFilter
 * \brief Computes pixel-wise the eigen values and eigen vectors
 *        of a 2D symmetrical matrix.
 *
 * The filter expects three inputs images { A, B, C } representing
 * the component of the matrix
 *
 *                    | A  B |
 *                    | B  c |
 *
 * The eigen values are stored in two output images, and the eigen
 * vector associated with the maximum eigenvalue is stored in an
 * image using vector as pixel type.
 *
 * \ingroup ShouldBeThreaded IntensityImageFilters
 * \ingroup ITKEigen
 */

template <typename TInputImage, typename TEigenValueImage, typename TEigenVectorImage>
class ITK_TEMPLATE_EXPORT EigenAnalysis2DImageFilter : public ImageToImageFilter<TInputImage, TEigenValueImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(EigenAnalysis2DImageFilter);

  /** Standard class type aliases. */
  using Self = EigenAnalysis2DImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TEigenValueImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(EigenAnalysis2DImageFilter);

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** Typedef for the vector type representing the eigen vectors */
  using EigenVectorType = typename TEigenVectorImage::PixelType;
  using VectorComponentType = typename EigenVectorType::ValueType;

  /** Superclass type alias. */
  using typename Superclass::OutputImageRegionType;

  /** Some convenient type alias. */
  using EigenValueImageType = TEigenValueImage;
  using EigenValueImagePointer = typename EigenValueImageType::Pointer;
  using EigenValueImageRegionType = typename EigenValueImageType::RegionType;
  using EigenValueImagePixelType = typename EigenValueImageType::PixelType;
  using EigenVectorImageType = TEigenVectorImage;
  using EigenVectorImagePointer = typename EigenVectorImageType::Pointer;
  using EigenVectorImageRegionType = typename EigenVectorImageType::RegionType;
  using EigenVectorImagePixelType = typename EigenVectorImageType::PixelType;

  /** Image dimension. */
  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  /** Connect the image containing the elements [0,0]
   * of the input 2D matrix. */
  void
  SetInput1(TInputImage * image);

  /** Connect the image containing the elements [0,1]
   * of the input 2D matrix. This is the same [1,0]
   * element given that the input matrix is expected
   * to be symmetric. */
  void
  SetInput2(TInputImage * image);

  /** Connect the image containing the elements [1,1]
   * of the input 2D matrix. */
  void
  SetInput3(TInputImage * image);

  /** Get the output image with the largest eigenvalue.
   *
   * The sign is taken into account in the computation.
   */
  EigenValueImageType *
  GetMaxEigenValue();

  /** Get the output image with the smallest eigenvalue.
   *
   * The sign is taken into account in the computation.
   */
  EigenValueImageType *
  GetMinEigenValue();

  /** Get the output image with the eigenvector associated with
   * the greatest eigenvalue
   *
   * The sign is taken into account in the computation.
   */
  EigenVectorImageType *
  GetMaxEigenVector();

  /**  Create the output.
   *
   * \todo Verify that MakeOutput is creating the right type of objects
   * this could be the cause of the reinterpret_cast bug in this class.
   */
  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObject::Pointer
  MakeOutput(DataObjectPointerArraySizeType idx) override;

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro(VectorComponentHasNumericTraitsCheck, (Concept::HasNumericTraits<VectorComponentType>));
  // End concept checking
#endif

protected:
  EigenAnalysis2DImageFilter();
  ~EigenAnalysis2DImageFilter() override = default;

  void
  GenerateData() override;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkEigenAnalysis2DImageFilter.hxx"
#endif

#endif