itkCovariantVector.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkCovariantVector.h,v $
  Language:  C++
  Date:      $Date: 2008-11-14 05:09:25 $
  Version:   $Revision: 1.55 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkCovariantVector_h
#define __itkCovariantVector_h


#include "itkFixedArray.h"
#include "vnl/vnl_vector_ref.h"
#include "itkIndent.h"
#include "itkVector.h"


namespace itk
{

template<class T, unsigned int NVectorDimension=3>
class ITK_EXPORT CovariantVector : public FixedArray<T,NVectorDimension>
{

public:
  typedef CovariantVector                 Self;
  typedef FixedArray<T,NVectorDimension>  Superclass;

  typedef T                                              ValueType;
  typedef typename NumericTraits< ValueType >::RealType  RealValueType;

  itkStaticConstMacro(Dimension, unsigned int, NVectorDimension);

  typedef Self CovariantVectorType;

  typedef FixedArray<T, NVectorDimension>                BaseArray;

  static unsigned int GetCovariantVectorDimension() 
    { return NVectorDimension; }  

  void SetVnlVector( const vnl_vector<T> & );

  vnl_vector_ref<T> GetVnlVector( void );

  vnl_vector<T> GetVnlVector( void ) const;


  void Set_vnl_vector( const vnl_vector<T> & );

  vnl_vector_ref<T> Get_vnl_vector( void );

  vnl_vector<T> Get_vnl_vector( void ) const;

  CovariantVector(): BaseArray() {}
  CovariantVector(const ValueType& r);

  template< class TVectorValueType >
  CovariantVector(const CovariantVector< TVectorValueType, 
                        NVectorDimension>& r): BaseArray(r) {}
  CovariantVector(const ValueType r[Dimension]): BaseArray(r) {}  

  template< class Tt >
  Self & operator= (const Tt & v )
    {
    BaseArray::operator=(v);
    return *this;
    }

  CovariantVector& operator= (const Self& r);
  CovariantVector& operator= (const ValueType r[NVectorDimension]);

  template< class Tt > inline const Self& operator*=(const Tt &value)
    {
    for( unsigned int i=0; i<NVectorDimension; i++)
      {
      (*this)[i] = static_cast< ValueType >((*this)[i] * value);
      }
    return *this;
    }

  template< class Tt > const Self& operator/=(const Tt &value)
    {
    for( unsigned int i=0; i<NVectorDimension; i++)
      {
      (*this)[i] = static_cast< ValueType >((*this)[i] / value);
      }
    return *this;
    }

  const Self& operator+=(const Self &vec);

  const Self& operator-=(const Self &vec);

  Self operator-() const;

  Self operator+(const Self &vec) const;

  Self operator-(const Self &vec) const;

  ValueType operator*(const Self &vec) const;

  ValueType operator*(const Vector<T,NVectorDimension> &vec) const;

  inline Self operator*(const ValueType& val) const
    {
    Self result;
    for( unsigned int i=0; i<NVectorDimension; i++) 
      {
      result[i] = static_cast< ValueType >((*this)[i] * val);
      }
    return result;
    }

  template< class Tt > inline Self operator/(const Tt& val) const
    {
    Self result;
    for( unsigned int i=0; i<NVectorDimension; i++) 
      {
      result[i] = static_cast< ValueType >((*this)[i] / val);
      }
    return result;
    }

  RealValueType GetNorm( void ) const;

  static unsigned int GetNumberOfComponents() { return NVectorDimension; }

  void Normalize(void);

  RealValueType GetSquaredNorm( void ) const;

  template < typename TCoordRepB >
  void CastFrom( const CovariantVector<TCoordRepB,NVectorDimension> & pa )
    {
    for(unsigned int i=0; i<NVectorDimension; i++ )
      {
      (*this)[i] = static_cast<T>( pa[i] );
      }
    }

};

template< class T, unsigned int NVectorDimension >
inline
CovariantVector<T,NVectorDimension>
operator*(const T &scalar, const  CovariantVector<T,NVectorDimension> & v)
{
  return v * scalar;
}

ITKCommon_EXPORT void CrossProduct(  CovariantVector<double,3> &,
                                     const Vector<double,3> &,
                                     const Vector<double,3> &  );

ITKCommon_EXPORT void CrossProduct(  CovariantVector<float,3> &,
                                     const Vector<float,3> &,
                                     const Vector<float,3> &  );

ITKCommon_EXPORT void CrossProduct(  CovariantVector<int,3>,
                                     const Vector<int,3> &,
                                     const Vector<int,3> &  );


} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_CovariantVector(_, EXPORT, x, y) namespace itk { \
  _(2(class EXPORT CovariantVector< ITK_TEMPLATE_2 x >)) \
  namespace Templates { typedef CovariantVector< ITK_TEMPLATE_2 x > \
                        CovariantVector##y; } \
  }

#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkCovariantVector+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkNumericTraitsCovariantVectorPixel.h"
# include "itkCovariantVector.txx"
#endif

#endif