File: sitkDisplacementFieldTransform.h

package info (click to toggle)
simpleitk 1.0.1-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 75,056 kB
  • sloc: cpp: 25,403; python: 3,060; sh: 1,131; ansic: 369; java: 260; cs: 215; makefile: 51; ruby: 47; tcl: 22
file content (173 lines) | stat: -rw-r--r-- 6,554 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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*=========================================================================
*
*  Copyright Insight Software Consortium
*
*  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 sitkDisplacementFieldTransform_h
#define sitkDisplacementFieldTransform_h

#include "sitkCommon.h"
#include "sitkTransform.h"
#include "sitkInterpolator.h"

namespace itk
{
namespace simple
{

/** \brief A dense deformable transform over a bounded spatial domain
 * for 2D or 3D coordinates space.
 *
 * \sa itk::DisplacementFieldTransform
 */
class SITKCommon_EXPORT DisplacementFieldTransform
  : public Transform
{
public:
  typedef DisplacementFieldTransform Self;
  typedef Transform Superclass;

  explicit DisplacementFieldTransform( unsigned int dimensions );

  /** \brief Consume an image to construct a displacement field transform.
   *
   * \warning The input displacement image is transferred to the
   * constructed transform object. The input image is modified to be a
   * default constructed Image object.
   *
   * Image must be of sitkVectorFloat64 pixel type with the number of
   * components equal to the image dimension.
   *
   */
  explicit DisplacementFieldTransform( Image &);

  DisplacementFieldTransform( const DisplacementFieldTransform & );

  explicit DisplacementFieldTransform( const Transform & );

  DisplacementFieldTransform &operator=( const DisplacementFieldTransform & );

  /** Name of this class */
  std::string GetName() const { return std::string ("DisplacementFieldTransform"); }

  /** parameters */

  /** \brief Consume an image, and set the displacement field
   *
   * \warning The ownership of the input displacement image is
   * transferred to the constructed transform object. The input image
   * is modified to be a default constructed Image object.
   *
   * Image must be of sitkVectorFloat64 pixel type with the number of
   * components equal to the image dimension.
   *
   */
  SITK_RETURN_SELF_TYPE_HEADER SetDisplacementField(Image &);

  /** \todo The returned image should not directly modify the
   * internal displacement field.
   */
  Image GetDisplacementField() const;

  /** fixed parameter */

  /* additional methods */
  SITK_RETURN_SELF_TYPE_HEADER SetInverseDisplacementField(Image &);

  /** \todo The returned image is should not directly modify the
   * internal displacement field.
   */
  Image GetInverseDisplacementField() const;

  /** Set the interpolator used between the field voxels. */
  SITK_RETURN_SELF_TYPE_HEADER SetInterpolator(InterpolatorEnum interp);
  // InterpolatorEnum GetInterpolator() const; How to do this?

  SITK_RETURN_SELF_TYPE_HEADER SetSmoothingOff();
  SITK_RETURN_SELF_TYPE_HEADER SetSmoothingGaussianOnUpdate( double varianceForUpdateField=1.75, double varianceForTotalField=0.5 );
  SITK_RETURN_SELF_TYPE_HEADER SetSmoothingBSplineOnUpdate( const std::vector<unsigned int> &numberOfControlPointsForUpdateField = std::vector<unsigned int>(3,4),
                                     const std::vector<unsigned int> &numberOfControlPointsForTotalField = std::vector<unsigned int>(3,4),
                                     bool enforceStationaryBoundary=true,
                                     unsigned int order=3 );


protected:

  virtual void SetPimpleTransform( PimpleTransformBase *pimpleTransform );

private:

  using Superclass::AddTransform;

  struct MyVisitor
  {
    itk::TransformBase *transform;
    DisplacementFieldTransform *that;
    template< typename TransformType >
    void operator() ( void ) const
      {
        TransformType *t = dynamic_cast<TransformType*>(transform);
        if (t && (typeid(*t)==typeid(TransformType)))
          {
          that->InternalInitialization<TransformType>(t);
          }
      }
  };

  void InternalInitialization(itk::TransformBase *transform);

  template <typename TransformType>
    void InternalInitialization(TransformType *transform);

  template< typename TDisplacementFieldTransform >
    static Image InternalGetDisplacementField( const TDisplacementFieldTransform *itkDisplacementTx );
  template< typename TDisplacementFieldTransform >
    static Image InternalGetInverseDisplacementField( const TDisplacementFieldTransform *itkDisplacementTx );

  template< typename TDisplacementFieldTransform >
    void InternalSetSmoothingOff(TDisplacementFieldTransform *itkDisplacement);
  template< typename TDisplacementFieldTransform >
    void InternalSetSmoothingGaussianOnUpdate( TDisplacementFieldTransform *itkDisplacement,
                                               double varianceForUpdateField,
                                               double varianceForTotalField );
  template< typename TDisplacementFieldTransform >
    void InternalSetSmoothingBSplineOnUpdate( TDisplacementFieldTransform *itkDisplacement,
                                              const std::vector<unsigned int> &numberOfControlPointsForUpdateField,
                                              const std::vector<unsigned int> &numberOfControlPointsForTotalField,
                                              bool enforceStationaryBoundary,
                                              unsigned int order );


  static PimpleTransformBase *CreateDisplacementFieldPimpleTransform(unsigned int dimension);

  nsstd::function<void (Image &)> m_pfSetDisplacementField;
  nsstd::function<Image ()> m_pfGetDisplacementField;

  nsstd::function<void (Image &)> m_pfSetInverseDisplacementField;
  nsstd::function<Image ()> m_pfGetInverseDisplacementField;

  nsstd::function<void (InterpolatorEnum &)> m_pfSetInterpolator;
  nsstd::function<InterpolatorEnum ()> m_pfGetInterpolator;

  nsstd::function<void ()> m_pfSetSmoothingOff;
  nsstd::function<void (double, double)> m_pfSetSmoothingGaussianOnUpdate;
  nsstd::function<void (const std::vector<unsigned int> &,const std::vector<unsigned int>&, bool, unsigned int)> m_pfSetSmoothingBSplineOnUpdate;

};

}
}

#endif // sitkDisplacementFieldTransform_h