File: elxBaseComponentSE.h

package info (click to toggle)
elastix 5.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 42,480 kB
  • sloc: cpp: 68,403; lisp: 4,118; python: 1,013; xml: 182; sh: 177; makefile: 33
file content (155 lines) | stat: -rw-r--r-- 4,224 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
150
151
152
153
154
155
/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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
 *
 *        http://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 elxBaseComponentSE_h
#define elxBaseComponentSE_h

#include "elxBaseComponent.h"
#include "elxConfiguration.h"

// ITK header files:
#include <itkMacro.h> // For ITK_DISALLOW_COPY_AND_MOVE.
#include <itkWeakPointer.h>

namespace elastix
{

/**
 * \class BaseComponentSE
 *
 * \brief The BaseComponentSE class is a base class for elastix
 * components that provides some basic functionality.
 *
 * Most elastix component will not directly inherit from the
 * elx::BaseComponent class but from this one, since it adds
 * some methods that most methods need anyway, such as
 * Set/GetElastix, Set/GetConfiguration.
 *
 * \sa BaseComponent
 * \ingroup Install
 */

template <class TElastix>
class ITK_TEMPLATE_EXPORT BaseComponentSE : public BaseComponent
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BaseComponentSE);

  /** Standard stuff. */
  using Self = BaseComponentSE;
  using Superclass = BaseComponent;

  /** Elastix typedef. */
  using ElastixType = TElastix;

  /** RegistrationType; NB: this is the elx::RegistrationBase
   * not an itk::Object or something like that.
   */
  using RegistrationType = typename ElastixType::RegistrationBaseType;

  /**
   * Get/Set functions for Elastix.
   * The Set-functions cannot be defined with the itkSetObjectMacro,
   * since this class does not derive from itk::Object and
   * thus does not have a Modified() method.
   *
   * This method checks if this instance of the class can be casted
   * (dynamically) to an itk::Object. If yes, it calls Modified()
   *
   * Besides setting m_Elastix, this method also sets m_Configuration
   * and m_Registration.
   */
  void
  SetElastix(ElastixType * _arg);

  /** itkGetModifiableObjectMacro( Elastix, ElastixType );
   * without the itkDebug call.
   */
  ElastixType *
  GetElastix() const
  {
    return this->m_Elastix.GetPointer();
  }

  void
  RemoveTargetCellFromIterationInfo(const char * const name)
  {
    this->m_Elastix->GetIterationInfo().RemoveTargetCell(name);
  }

  auto &
  GetIterationInfoAt(const char * const name)
  {
    return this->m_Elastix->GetIterationInfoAt(name);
  }

  void
  AddTargetCellToIterationInfo(const char * const name)
  {
    return this->m_Elastix->AddTargetCellToIterationInfo(name);
  }

  /** itkGetModifiableObjectMacro(Configuration, Configuration);
   * The configuration object provides functionality to
   * read parameters and command line arguments.
   */
  const Configuration *
  GetConfiguration() const
  {
    return this->m_Configuration.GetPointer();
  }


  /** Set the configuration. Added for transformix. */
  void
  SetConfiguration(const Configuration * _arg);

  /** Get a pointer to the Registration component.
   * This is a convenience function, since the registration
   * component is needed often by other components.
   * It could be accessed also via GetElastix->GetElxRegistrationBase().
   */
  RegistrationType *
  GetRegistration() const
  {
    return this->m_Registration;
  }


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

  itk::WeakPointer<TElastix>  m_Elastix{};
  Configuration::ConstPointer m_Configuration{};
  RegistrationType *          m_Registration{};

private:
  virtual const itk::Object &
  GetSelf() const = 0;

  virtual itk::Object &
  GetSelf() = 0;
};

} // end namespace elastix

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

#endif // end #ifndef elxBaseComponentSE_h