vpMe.h

/****************************************************************************
 *
 * $Id: vpMe.h 4649 2014-02-07 14:57:11Z fspindle $
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2014 by INRIA. All rights reserved.
 * 
 * This software is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * ("GPL") version 2 as published by the Free Software Foundation.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact INRIA about acquiring a ViSP Professional 
 * Edition License.
 *
 * See http://www.irisa.fr/lagadic/visp/visp.html for more information.
 * 
 * This software was developed at:
 * INRIA Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 * http://www.irisa.fr/lagadic
 *
 * If you have questions regarding the use of this file, please contact
 * INRIA at visp@inria.fr
 * 
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 *
 * Description:
 * Moving edges.
 *
 * Authors:
 * Eric Marchand
 * Andrew Comport
 * Aurelien Yol
 *
 *****************************************************************************/

// ====================================================================
// ====================================================================
//  Andrew Comport added functionality - replaced points_to_track with
//  sample step.

#ifndef vpMe_H
#define vpMe_H

#include <visp/vpMatrix.h>
#include <visp/vpMath.h>
#include <visp/vpImage.h>


class VISP_EXPORT vpMe
{
#ifdef VISP_BUILD_DEPRECATED_FUNCTIONS
public:
#else
private:
#endif
  double threshold ;
  double mu1; 
  double mu2; 
  double min_samplestep;
  unsigned int anglestep;
  int mask_sign;
  unsigned int range; 
  double sample_step; 
  int ntotal_sample;
  int points_to_track;
  unsigned int mask_size;
  unsigned int n_mask;
  //strip: defines a "security strip" such that Seek_Extremities()
  //cannot return a new extremity which is too close to the
  //frame borders which may cause Get_Sampling_Grid to refuse
  //the that extremity
  int strip;
  //int graph ;
  vpMatrix *mask ; 

public:
  vpMe() ;
  vpMe(const vpMe &me) ;
  virtual ~vpMe() ;
  
  const vpMe& operator=(const vpMe &me);


  void initMask() ;// convolution masks - offset computation
  void checkSamplestep(double &a) { if(a < min_samplestep) a = min_samplestep ; }
  void print( ) ;
  
  inline vpMatrix* getMask() const { return mask; }

  void setMaskNumber(const unsigned int &a) ;
  
  inline unsigned int getMaskNumber() const { return n_mask; }
  
  void setMaskSign(const int &a){ mask_sign = a ; }
  
  inline int getMaskSign() const { return mask_sign; }
  
  void setMaskSize(const unsigned int &a);
  
  inline unsigned int getMaskSize() const { return mask_size; }
  
  void setMu1(const double &mu_1) { this->mu1 = mu_1  ; }
  
  inline double getMu1() const { return mu1; }
  
  void setMu2(const double &mu_2) { this->mu2 = mu_2  ; }
  
  inline double getMu2() const { return mu2; }
  
  void setNbTotalSample(const int &nb) { ntotal_sample = nb; }
  
  inline int getNbTotalSample() const { return ntotal_sample; }
  
  void setPointsToTrack(const int &n) { points_to_track = n; }
  
  inline int getPointsToTrack() const { return points_to_track ; }
  
  void setRange(const unsigned int &r) { range = r  ; }
  
  inline unsigned int getRange() const { return range; }
  
  void setAngleStep(const unsigned int &a) { anglestep = a ; }
  
  inline unsigned int getAngleStep() const { return anglestep; }
  
  void setMinSampleStep(const double &min) { min_samplestep = min ; }
  
  inline double getMinSampleStep() const { return min_samplestep; }
  
  void setSampleStep(const double &s) { sample_step = s ; }
  
  inline double getSampleStep() const { return sample_step ; }
  
  void setStrip(const int &a) { strip = a ; }
  
  inline int getStrip() const { return strip; }
  
  void setThreshold(const double &t) { threshold = t ; }
  
  inline double getThreshold() const { return threshold; }
  
#ifdef VISP_BUILD_DEPRECATED_FUNCTIONS

public: 
  double aberration;
  double init_aberration;
  
  vp_deprecated void setAberration(const double &a) { aberration = a ; }
  
  vp_deprecated void setInitAberration(const double &a) { init_aberration = a ; }
  
  vp_deprecated void setMinSamplestep(const double &min) { min_samplestep = min ; } //Little mistake in the method name "step" should be "Step" 
#endif
};


#endif