sitkTransformToDisplacementFieldFilter.h

Go to the documentation of this file.

/*=========================================================================
*
*  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 sitkTransformToDisplacementFieldFilter_h
#define sitkTransformToDisplacementFieldFilter_h

/*
 * WARNING: DO NOT EDIT THIS FILE!
 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
 * Please look at sitkImageSourceTemplate.h.in to make changes.
 */

#include <memory>

#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"

namespace itk {
  namespace simple {

    class SITKBasicFilters_EXPORT TransformToDisplacementFieldFilter : public ImageFilter<0> {
    public:
      typedef TransformToDisplacementFieldFilter Self;

      virtual ~TransformToDisplacementFieldFilter();

      TransformToDisplacementFieldFilter();

      typedef RealVectorPixelIDTypeList  PixelIDTypeList;





      SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }

        PixelIDValueEnum GetOutputPixelType() const { return this->m_OutputPixelType; }

      SITK_RETURN_SELF_TYPE_HEADER SetSize ( const std::vector<unsigned int> & Size ) { this->m_Size = Size; return *this; }

        std::vector<unsigned int> GetSize() const { return this->m_Size; }

      SITK_RETURN_SELF_TYPE_HEADER SetOutputOrigin ( const std::vector<double> & OutputOrigin ) { this->m_OutputOrigin = OutputOrigin; return *this; }

        std::vector<double> GetOutputOrigin() const { return this->m_OutputOrigin; }

      SITK_RETURN_SELF_TYPE_HEADER SetOutputSpacing ( const std::vector<double> & OutputSpacing ) { this->m_OutputSpacing = OutputSpacing; return *this; }

        std::vector<double> GetOutputSpacing() const { return this->m_OutputSpacing; }

      SITK_RETURN_SELF_TYPE_HEADER SetOutputDirection ( std::vector<double> OutputDirection ) { this->m_OutputDirection = OutputDirection; return *this; }

        std::vector<double> GetOutputDirection() const { return this->m_OutputDirection; }
      std::string GetName() const { return std::string ("TransformToDisplacementFieldFilter"); }

      std::string ToString() const;


      Image Execute ( const Transform & transform );


      Image Execute ( const Transform & transform, PixelIDValueEnum outputPixelType, const std::vector<unsigned int> & size, const std::vector<double> & outputOrigin, const std::vector<double> & outputSpacing, std::vector<double> outputDirection );


      void SetReferenceImage(const Image & refImage );


    private:

      typedef Image (Self::*MemberFunctionType)( const Transform * transform );
      template <class TImageType> Image ExecuteInternal ( const Transform * transform );


      friend struct detail::MemberFunctionAddressor<MemberFunctionType>;

      nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;


      PixelIDValueEnum  m_OutputPixelType;
      std::vector<unsigned int>  m_Size;
      std::vector<double>  m_OutputOrigin;
      std::vector<double>  m_OutputSpacing;
      /* 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. */
      std::vector<double>  m_OutputDirection;



    };



SITKBasicFilters_EXPORT Image TransformToDisplacementField ( const Transform & transform, PixelIDValueEnum outputPixelType = itk::simple::sitkVectorFloat64, const std::vector<unsigned int> & size = std::vector<unsigned int>(3, 64), const std::vector<double> & outputOrigin = std::vector<double>(3, 0.0), const std::vector<double> & outputSpacing = std::vector<double>(3, 1.0), std::vector<double> outputDirection = std::vector<double>() );
  }
}
#endif