elastixlib.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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;
 
  ELASTIX();
  virtual ~ELASTIX();
 
  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);
 
  ConstImagePointer
  GetResultImage() const;
 
  ImagePointer
  GetResultImage();
 
  ParameterMapType
  GetTransformParameterMap() const;
 
  ParameterMapListType
  GetTransformParameterMapList() const;
 
private:
  /* the result images */
  ImagePointer m_ResultImage;
 
  /* Final transformation*/
  ParameterMapListType m_TransformParametersList;
};
 
// end class ELASTIX
 
} // end namespace elastix
 
#endif