mitkPlaneFit.h

Go to the documentation of this file.

/*=========================================================================
 
Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date$
Version:   $Revision$
 
Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html 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.
 
=========================================================================*/


#if !defined(MITK_PLANEFIT_H__INCLUDED_)
#define MITK_PLANEFIT_H__INCLUDED_

#include "mitkPointSet.h"
#include "MitkExtExports.h"
#include "mitkTimeSlicedGeometry.h"
#include "mitkPlaneGeometry.h"
#include "mitkGeometryDataSource.h"

namespace mitk {

  //  kind regards to dr. math!
  // function [x0, a, d, normd] = lsplane(X)
  // ---------------------------------------------------------------------
  // LSPLANE.M   Least-squares plane (orthogonal distance
  //             regression).
  //
  // Version 1.0    
  // Last amended   I M Smith 27 May 2002. 
  // Created        I M Smith 08 Mar 2002
  // ---------------------------------------------------------------------
  // Input    
  // X        Array [x y z] where x = vector of x-coordinates, 
  //          y = vector of y-coordinates and z = vector of 
  //          z-coordinates. 
  //          Dimension: m x 3. 
  // 
  // Output   
  // x0       Centroid of the data = point on the best-fit plane.
  //          Dimension: 3 x 1. 
  // 
  // a        Direction cosines of the normal to the best-fit 
  //          plane. 
  //          Dimension: 3 x 1.
  // 
  // <Optional... 
  // d        Residuals. 
  //          Dimension: m x 1. 
  // 
  // normd    Norm of residual errors. 
  //          Dimension: 1 x 1. 
  // ...>
  //
  // [x0, a <, d, normd >] = lsplane(X)
  // ---------------------------------------------------------------------

  class MitkExt_EXPORT PlaneFit : public GeometryDataSource
  {
    public:

      mitkClassMacro( PlaneFit, GeometryDataSource);
      itkNewMacro(Self);

      typedef mitk::PointSet::PointDataType PointDataType;
      typedef mitk::PointSet::PointDataIterator PointDataIterator;

      virtual void GenerateOutputInformation();

      virtual void GenerateData();

      const mitk::PointSet *GetInput();

      virtual void SetInput( const mitk::PointSet *ps );

      virtual const mitk::Point3D &GetCentroid( int t = 0 ) const;

      virtual mitk::PlaneGeometry::Pointer GetPlaneGeometry( int t = 0 );

      virtual const mitk::Vector3D &GetPlaneNormal( int t = 0 ) const;

    protected:
      PlaneFit();
      virtual ~PlaneFit();

      void CalculateCentroid( int t = 0 );

      void ProcessPointSet( int t = 0 );

      void InitializePlane( int t = 0 );


    private:

      const mitk::PointSet* m_PointSet;
      
      /* output object - a time sliced geometry.*/
      mitk::TimeSlicedGeometry::Pointer m_TimeSlicedGeometry;

      std::vector< mitk::PlaneGeometry::Pointer > m_Planes;
      
      std::vector< mitk::Point3D > m_Centroids;
      
      /* the normal vector to descrie a plane gemoetry.*/
      std::vector< mitk::Vector3D > m_PlaneVectors;
  };
}//namespace mitk
#endif //MITK_PLANFIT_INCLUDE_