Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itkTransform.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Insight Segmentation & Registration Toolkit
00004   Module:    $RCSfile: itkTransform.h,v $
00005   Language:  C++
00006   Date:      $Date: 2006/11/03 20:09:08 $
00007   Version:   $Revision: 1.50 $
00008 
00009   Copyright (c) Insight Software Consortium. All rights reserved.
00010   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
00011 
00012      This software is distributed WITHOUT ANY WARRANTY; without even 
00013      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
00014      PURPOSE.  See the above copyright notices for more information.
00015 
00016 =========================================================================*/
00017 #ifndef __itkTransform_h
00018 #define __itkTransform_h
00019 
00020 #include "itkTransformBase.h"
00021 #include "itkPoint.h"
00022 #include "itkVector.h"
00023 #include "itkCovariantVector.h"
00024 #include "vnl/vnl_vector_fixed.h"
00025 #include "itkArray.h"
00026 #include "itkArray2D.h"
00027 
00028 #include "itkObjectFactory.h"
00029 
00030 
00031 namespace itk
00032 {
00033   
00063 template <class TScalarType,
00064           unsigned int NInputDimensions=3, 
00065           unsigned int NOutputDimensions=3>
00066 class ITK_EXPORT  Transform  : public TransformBase
00067 {
00068 public:
00070   typedef Transform  Self;
00071   typedef TransformBase Superclass;
00072   typedef SmartPointer< Self >   Pointer;
00073   typedef SmartPointer< const Self >  ConstPointer;
00074 
00076   itkNewMacro(Self);
00077 
00079   itkTypeMacro( Transform, TransformBase );
00080 
00082   itkStaticConstMacro(InputSpaceDimension, unsigned int, NInputDimensions);
00083   itkStaticConstMacro(OutputSpaceDimension, unsigned int, NOutputDimensions);
00085 
00087   unsigned int GetInputSpaceDimension(void) const {return NInputDimensions;}
00088 
00090   unsigned int GetOutputSpaceDimension(void) const {return NOutputDimensions;}
00091 
00093   typedef  TScalarType     ScalarType;
00094 
00096   typedef  typename Superclass::ParametersType         ParametersType;
00097 
00099   typedef  Array2D< double >                           JacobianType;
00100 
00102   typedef Vector<TScalarType, NInputDimensions>  InputVectorType;
00103   typedef Vector<TScalarType, NOutputDimensions> OutputVectorType;
00104 
00106   typedef CovariantVector<TScalarType, NInputDimensions>  InputCovariantVectorType;
00107   typedef CovariantVector<TScalarType, NOutputDimensions> OutputCovariantVectorType;
00108 
00110   typedef vnl_vector_fixed<TScalarType, NInputDimensions>  InputVnlVectorType;
00111   typedef vnl_vector_fixed<TScalarType, NOutputDimensions> OutputVnlVectorType;
00112 
00114   typedef Point<TScalarType, NInputDimensions> InputPointType;
00115   typedef Point<TScalarType, NOutputDimensions> OutputPointType;
00116 
00118   virtual OutputPointType TransformPoint(const InputPointType  & ) const
00119     { return OutputPointType(); } 
00120 
00122   virtual OutputVectorType    TransformVector(const InputVectorType &) const
00123     { return OutputVectorType(); }
00124 
00126   virtual OutputVnlVectorType TransformVector(const InputVnlVectorType &) const
00127     { return OutputVnlVectorType(); }
00128 
00130   virtual OutputCovariantVectorType TransformCovariantVector(
00131     const InputCovariantVectorType &) const
00132     { return OutputCovariantVectorType(); } 
00133 
00141   virtual void SetParameters( const ParametersType & ) 
00142     { itkExceptionMacro( << "Subclasses should override this method" ) };
00143 
00151   virtual void SetParametersByValue ( const ParametersType & p ) 
00152     { this->SetParameters ( p ); };
00153 
00155   virtual const ParametersType& GetParameters(void) const
00156     { itkExceptionMacro( << "Subclasses should override this method" );
00157       return m_Parameters; };
00159 
00161   virtual void SetFixedParameters( const ParametersType & ) 
00162     { itkExceptionMacro( << "Subclasses should override this method" ) };
00163 
00165   virtual const ParametersType& GetFixedParameters(void) const
00166     { itkExceptionMacro( << "Subclasses should override this method" );
00167       return m_Parameters; };
00169 
00197   virtual const JacobianType & GetJacobian(const InputPointType  &) const
00198     { itkExceptionMacro( << "Subclass should override this method" );
00199       return m_Jacobian; }; 
00201 
00202 
00204   virtual unsigned int GetNumberOfParameters(void) const 
00205                       { return m_Parameters.Size(); }
00206 
00209   bool GetInverse(Self*) const {return false;}
00210 
00212   virtual std::string GetTransformTypeAsString() const;
00213 
00227   virtual bool IsLinear() const { return false; }
00228 
00229 protected:
00230   Transform(); 
00231   Transform(unsigned int Dimension, unsigned int NumberOfParameters);
00232   virtual ~Transform() {};
00233 
00234 
00235   mutable ParametersType     m_Parameters;
00236   mutable ParametersType     m_FixedParameters;
00237   mutable JacobianType       m_Jacobian;
00238 
00239 private:
00240   Transform(const Self&); //purposely not implemented
00241   void operator=(const Self&); //purposely not implemented
00242 
00243 
00244 };
00245 
00246 } // end namespace itk
00247 
00248 // Define instantiation macro for this template.
00249 #define ITK_TEMPLATE_Transform(_, EXPORT, x, y) namespace itk { \
00250   _(3(class EXPORT Transform< ITK_TEMPLATE_3 x >)) \
00251   namespace Templates { typedef Transform< ITK_TEMPLATE_3 x > Transform##y; } \
00252   }
00253 
00254 #if ITK_TEMPLATE_EXPLICIT
00255 # include "Templates/itkTransform+-.h"
00256 #endif
00257 
00258 #if ITK_TEMPLATE_TXX
00259 # include "itkTransform.txx"
00260 #endif
00261 
00262 #endif
00263 
00264 
00265 
00266 

Generated at Mon Mar 12 03:13:37 2007 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000