itkCovariantVector.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkCovariantVector.h,v $
  Language:  C++
  Date:      $Date: 2005/10/24 18:33:32 $
  Version:   $Revision: 1.34 $

  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);

  CovariantVector(const Self& r): BaseArray(r) {}
  CovariantVector(const ValueType r[Dimension]): BaseArray(r) {}  
    
  CovariantVector& operator= (const Self& r);
  CovariantVector& operator= (const ValueType r[NVectorDimension]);
    
  const Self& operator*=(const ValueType &value);

  const Self& operator/=(const ValueType &value);

  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;
  
  Self operator*(const ValueType& val) const;

  ValueType operator*(const Self &vec) const;

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

  Self operator/(const ValueType& val) const;

  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] );
      }
  }


};


} // end namespace itk
  

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkCovariantVector.txx"
#endif


#endif 

---