itkSymmetricSecondRankTensor.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSymmetricSecondRankTensor.h,v $
  Language:  C++
  Date:      $Date: 2010-04-09 21:25:10 $
  Version:   $Revision: 1.29 $

  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 __itkSymmetricSecondRankTensor_h
#define __itkSymmetricSecondRankTensor_h

// Undefine an eventual SymmetricSecondRankTensor macro
#ifdef SymmetricSecondRankTensor
#undef SymmetricSecondRankTensor
#endif

#include "itkIndent.h"
#include "itkFixedArray.h"
#include "itkMatrix.h"
#include "itkSymmetricEigenAnalysis.h"

namespace itk
{

template < typename TComponent, unsigned int NDimension=3 >
class SymmetricSecondRankTensor: public 
        FixedArray<TComponent,NDimension*(NDimension+1)/2>
{
public:
  typedef SymmetricSecondRankTensor  Self;
  typedef FixedArray<TComponent,NDimension*(NDimension+1)/2> Superclass;

  itkStaticConstMacro(Dimension, unsigned int, NDimension);
  itkStaticConstMacro(InternalDimension, unsigned int, NDimension*(NDimension+1)/2);

  typedef FixedArray<TComponent,
          itkGetStaticConstMacro(InternalDimension)> BaseArray;

  typedef FixedArray<TComponent, NDimension> EigenValuesArrayType;

  typedef Matrix<TComponent, NDimension, NDimension> MatrixType;
  typedef Matrix<TComponent, NDimension, NDimension> EigenVectorsMatrixType;

  typedef TComponent                                  ComponentType;
  typedef typename Superclass::ValueType              ValueType;
  typedef typename NumericTraits<ValueType>::RealType AccumulateValueType;
  typedef typename NumericTraits<ValueType>::RealType RealValueType;

  typedef SymmetricEigenAnalysis< MatrixType, 
            EigenValuesArrayType, EigenVectorsMatrixType >  SymmetricEigenAnalysisType;

  SymmetricSecondRankTensor() {this->Fill(0);}

  SymmetricSecondRankTensor (const ComponentType& r) { this->Fill(r); }
  
  template < typename TCoordRepB >
  SymmetricSecondRankTensor( const SymmetricSecondRankTensor<TCoordRepB,NDimension> & pa ):
    BaseArray(pa) { }

  typedef ComponentType ComponentArrayType[ itkGetStaticConstMacro(InternalDimension) ];

  SymmetricSecondRankTensor(const ComponentArrayType r): BaseArray(r) {}

  template < typename TCoordRepB >
  Self& operator= ( const SymmetricSecondRankTensor<TCoordRepB,NDimension> & pa )
  {
    BaseArray::operator=(pa);
    return *this;
  }

  Self& operator= (const ComponentType& r);
  Self& operator= (const ComponentArrayType r);

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

  Self operator*(const RealValueType & scalar ) const;
  Self operator/(const RealValueType & scalar ) const;
  const Self & operator*=(const RealValueType & scalar );
  const Self & operator/=(const RealValueType & scalar );

  static unsigned int GetNumberOfComponents() 
    { 
    return itkGetStaticConstMacro(InternalDimension);
    }

  ComponentType GetNthComponent(int c) const
    { return this->operator[](c); }

  void SetNthComponent(int c, const ComponentType& v)  
    {  this->operator[](c) = v; }

  ValueType & operator()( unsigned int row, unsigned int col );
  const ValueType & operator()( unsigned int row, unsigned int col ) const;

  void SetIdentity();

  AccumulateValueType GetTrace() const;

  void ComputeEigenValues( EigenValuesArrayType & eigenValues ) const;

  void ComputeEigenAnalysis( EigenValuesArrayType & eigenValues,
                             EigenVectorsMatrixType & eigenVectors ) const;

  Self PreMultiply( const MatrixType & m ) const;

  Self PostMultiply( const MatrixType & m ) const;

private:

  
};


typedef std::ostream               OutputStreamType;
typedef std::istream               InputStreamType;

template< typename TComponent, unsigned int NDimension  >  
ITK_EXPORT OutputStreamType& operator<<(OutputStreamType& os, 
              const SymmetricSecondRankTensor<TComponent,NDimension> & c); 
template< typename TComponent, unsigned int NDimension  >  
ITK_EXPORT InputStreamType& operator>>(InputStreamType& is, 
                    SymmetricSecondRankTensor<TComponent,NDimension> & c); 

   

} // end namespace itk

#include "itkNumericTraitsTensorPixel.h"


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

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

#if ITK_TEMPLATE_TXX
# include "itkSymmetricSecondRankTensor.txx"
#endif


#endif