File: elastixlib.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 (135 lines) | stat: -rw-r--r-- 4,823 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
/*=========================================================================
 *
 *  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 elastixlib_h
#define elastixlib_h

/*
 *  Includes
 */
#include <itkDataObject.h>
#include "itkParameterFileParser.h"
#include "elxMacro.h"
#include "elxElastixMain.h"


/********************************************************************************
 *                          *
 *      Class definition    *
 *                          *
 ********************************************************************************/

namespace elastix
{

class ELASTIXLIB_API ELASTIX
{
public:
  // typedefs for images
  using Image = itk::DataObject;
  using ImagePointer = Image::Pointer;
  using ConstImagePointer = Image::ConstPointer;

  // typedefs for parameter map
  using ParameterValuesType = itk::ParameterFileParser::ParameterValuesType;
  using ParameterMapType = itk::ParameterFileParser::ParameterMapType;
  using ParameterMapListType = std::vector<itk::ParameterFileParser::ParameterMapType>;

  // typedefs for ObjectPointer
  using ObjectPointer = elastix::ElastixMain::ObjectPointer;

  /**
   *  Constructor and destructor
   */
  ELASTIX();
  virtual ~ELASTIX();

  /**
   *  The image registration interface functionality
   *  Note:
   *    - itk::Image::PixelType must be the same as specified in ParameterMap
   *      ('Fixed/MovingInternalImagePixelType')
   *    - Direction cosines are taken from fixed image (always set UseDirectionCosines TRUE)
   *  Params:
   *    fixedImage  itk::Image note type should be the same as specified in the Parameterfile
   *      FixedInternalImagePixelType and dimensions!
   *    movingImage itk::Image note type should be the same as specified in the Parameterfile
   *      MovingInternalImagePixelType and dimensions!
   *    ParameterMap
   *    outputPath
   *    performLogging  boolean indicating wether logging should be performed.
   *      NOTE: in case of logging also give a valid outputPath!
   *    performCout boolean indicating wether output should be send to command window
   *    fixedMask default no Mask present
   *    movingMask  default no Mask present
   *  return value: 0 is success in case not 0 an error occurred
   *     0 = success
   *     1 = error
   *    -2 = output folder does not exist
   *    \todo generate file elastix_errors.h containing error codedefines
   *      (e.g. \#define ELASTIX_NO_ERROR 0)
   */
  int
  RegisterImages(ImagePointer             fixedImage,
                 ImagePointer             movingImage,
                 const ParameterMapType & parameterMap,
                 const std::string &      outputPath,
                 bool                     performLogging,
                 bool                     performCout,
                 ImagePointer             fixedMask = nullptr,
                 ImagePointer             movingMask = nullptr);

  int
  RegisterImages(ImagePointer                          fixedImage,
                 ImagePointer                          movingImage,
                 const std::vector<ParameterMapType> & parameterMaps,
                 const std::string &                   outputPath,
                 bool                                  performLogging,
                 bool                                  performCout,
                 ImagePointer                          fixedMask = nullptr,
                 ImagePointer                          movingMask = nullptr,
                 ObjectPointer                         transform = nullptr);

  /** Getter for result image. */
  ConstImagePointer
  GetResultImage() const;

  /** Getter for result image. Non-const overload */
  ImagePointer
  GetResultImage();

  /** Get transform parameters of last registration step. */
  ParameterMapType
  GetTransformParameterMap() const;

  /** Get transform parameters of all registration steps. */
  ParameterMapListType
  GetTransformParameterMapList() const;

private:
  /* the result images */
  ImagePointer m_ResultImage;

  /* Final transformation*/
  ParameterMapListType m_TransformParametersList;
};

// end class ELASTIX

} // end namespace elastix

#endif