SimpleITK  
sitkTransformToDisplacementFieldFilter.h
Go to the documentation of this file.
1/*=========================================================================
2*
3* Copyright NumFOCUS
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#ifndef sitkTransformToDisplacementFieldFilter_h
19#define sitkTransformToDisplacementFieldFilter_h
20
21/*
22 * WARNING: DO NOT EDIT THIS FILE!
23 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
24 * Please look at sitkImageSourceTemplate.h.in to make changes.
25 */
26
27#include <memory>
28
29#include "sitkBasicFilters.h"
30#include "sitkImageFilter.h"
31
32namespace itk::simple {
33
51 public:
53
56
60
63
64
65
66\
67
71 SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }
72
77
81 SITK_RETURN_SELF_TYPE_HEADER SetSize ( std::vector<unsigned int> Size ) { this->m_Size = std::move(Size); return *this; }
82
86 std::vector<unsigned int> GetSize() const { return this->m_Size; }\
87
91 SITK_RETURN_SELF_TYPE_HEADER SetOutputOrigin ( std::vector<double> OutputOrigin ) { this->m_OutputOrigin = std::move(OutputOrigin); return *this; }
92
96 std::vector<double> GetOutputOrigin() const { return this->m_OutputOrigin; }\
97
101 SITK_RETURN_SELF_TYPE_HEADER SetOutputSpacing ( std::vector<double> OutputSpacing ) { this->m_OutputSpacing = std::move(OutputSpacing); return *this; }
102
106 std::vector<double> GetOutputSpacing() const { return this->m_OutputSpacing; }\
107
111 SITK_RETURN_SELF_TYPE_HEADER SetOutputDirection ( std::vector<double> OutputDirection ) { this->m_OutputDirection = OutputDirection; return *this; }
112
116 std::vector<double> GetOutputDirection() const { return this->m_OutputDirection; }
117
119 std::string GetName() const { return std::string ("TransformToDisplacementFieldFilter"); }
120
122 std::string ToString() const;
123
124
126
127 Image Execute ( const Transform & transform );
128
129
131 void SetReferenceImage(const Image & refImage );
132
133
134 private:
135
137
138 using MemberFunctionType = Image (Self::*)( const Transform * transform );
139 template <class TImageType> Image ExecuteInternal ( const Transform * transform );
140
141
143
144 std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
145
146
147 PixelIDValueEnum m_OutputPixelType{itk::simple::sitkVectorFloat64};
148
149 std::vector<unsigned int> m_Size{std::vector<unsigned int>(3, 64)};
150
151 std::vector<double> m_OutputOrigin{std::vector<double>(3, 0.0)};
152
153 std::vector<double> m_OutputSpacing{std::vector<double>(3, 1.0)};
154
155 /* Passing a zero sized array, defaults to identiy matrix. The size of the array must exactly match the direction matrix for the dimension of the image. */
156 std::vector<double> m_OutputDirection{std::vector<double>()};
157
158
159
160
161
162 };
163
164
165
174SITKBasicFilters_EXPORT Image TransformToDisplacementField ( const Transform & transform, PixelIDValueEnum outputPixelType = itk::simple::sitkVectorFloat64, std::vector<unsigned int> size = std::vector<unsigned int>(3, 64), std::vector<double> outputOrigin = std::vector<double>(3, 0.0), std::vector<double> outputSpacing = std::vector<double>(3, 1.0), std::vector<double> outputDirection = std::vector<double>() );
175}
176#endif
The Image class for SimpleITK.
Definition sitkImage.h:77
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Self & SetOutputDirection(std::vector< double > OutputDirection)
Image ExecuteInternal(const Transform *transform)
void SetReferenceImage(const Image &refImage)
PixelIDValueEnum GetOutputPixelType() const
Get the ouput pixel type.
Image Execute(const Transform &transform)
Self & SetOutputPixelType(PixelIDValueEnum OutputPixelType)
Set the output pixel type, only sitkVectorFloat32 and sitkVectorFloat64 are supported.
A simplified wrapper around a variety of ITK transforms.
typelist2::typelist< VectorPixelID< float >, VectorPixelID< double > > RealVectorPixelIDTypeList
Image TransformToDisplacementField(const Transform &transform, PixelIDValueEnum outputPixelType=itk::simple::sitkVectorFloat64, std::vector< unsigned int > size=std::vector< unsigned int >(3, 64), std::vector< double > outputOrigin=std::vector< double >(3, 0.0), std::vector< double > outputSpacing=std::vector< double >(3, 1.0), std::vector< double > outputDirection=std::vector< double >())
Generate a displacement field from a coordinate transform.
PixelIDValueEnum
Enumerated values of pixelIDs.
#define SITKBasicFilters_EXPORT