itkDiffusionTensor3D.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 itkDiffusionTensor3D_h
#define itkDiffusionTensor3D_h

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

#include "itkSymmetricSecondRankTensor.h"

namespace itk
{
template< typename TComponent >
class ITK_TEMPLATE_EXPORT DiffusionTensor3D:public SymmetricSecondRankTensor< TComponent, 3 >
{
public:
  using Self = DiffusionTensor3D;
  using Superclass = SymmetricSecondRankTensor< TComponent, 3 >;

  using ValueType = typename Superclass::ValueType;
  using ComponentType = typename Superclass::ComponentType;
  using ComponentArrayType = typename Superclass::ComponentArrayType;

  using AccumulateValueType = typename Superclass::AccumulateValueType;
  using RealValueType = typename Superclass::RealValueType;

  using EigenValuesArrayType = typename Superclass::EigenValuesArrayType;
  using EigenVectorsMatrixType = typename Superclass::EigenVectorsMatrixType;

  DiffusionTensor3D() = default;

  DiffusionTensor3D(const Superclass & r);
  DiffusionTensor3D(const ComponentType & r);
  DiffusionTensor3D(const ComponentArrayType r);

  template< typename TCoordRepB >
  DiffusionTensor3D(const DiffusionTensor3D< TCoordRepB > & pa):
    SymmetricSecondRankTensor< TComponent, 3 >(pa) {}

  Self & operator=(const Superclass & r);

  Self & operator=(const ComponentType & r);

  Self & operator=(const ComponentArrayType r);

  template< typename TCoordRepB >
  Self & operator=(const DiffusionTensor3D< TCoordRepB > & pa)
  {
    //NOTE (this != &pa ) because they are different pointer types
    //if this templated function is called
    // ComponentType 'itk::DiffusionTensor3D<double> *'
    // TCoordRepB   'const DiffusionTensor3D<float> *')
    SymmetricSecondRankTensor< TComponent, 3 >::operator=(pa);
    return *this;
  }

  AccumulateValueType GetTrace() const;

  RealValueType GetFractionalAnisotropy() const;

  RealValueType GetRelativeAnisotropy() const;

  RealValueType GetInnerScalarProduct() const;

};


template<typename T>
inline void swap( DiffusionTensor3D<T> &a, DiffusionTensor3D<T> &b )
{
  a.swap(b);
}

} // end namespace itk
#include "itkNumericTraitsDiffusionTensor3DPixel.h"

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkDiffusionTensor3D.hxx"
#endif

#endif