vpMe.h

/****************************************************************************
 *
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2019 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 as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 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://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * 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
 *
 *****************************************************************************/

#ifndef vpMe_H
#define vpMe_H

#include <visp3/core/vpImage.h>
#include <visp3/core/vpMath.h>
#include <visp3/core/vpMatrix.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();

  vpMe &operator=(const vpMe &me);
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  vpMe &operator=(const vpMe &&me);
#endif

  void checkSamplestep(double &a)
  {
    if (a < min_samplestep)
      a = min_samplestep;
  }
  inline unsigned int getAngleStep() const { return anglestep; }
  inline vpMatrix *getMask() const { return mask; }
  inline unsigned int getMaskNumber() const { return n_mask; }
  inline int getMaskSign() const { return mask_sign; }
  inline unsigned int getMaskSize() const { return mask_size; }
  inline double getMinSampleStep() const { return min_samplestep; }
  inline double getMu1() const { return mu1; }
  inline double getMu2() const { return mu2; }
  inline int getNbTotalSample() const { return ntotal_sample; }
  inline int getPointsToTrack() const { return points_to_track; }
  inline unsigned int getRange() const { return range; }
  inline int getStrip() const { return strip; }

  inline double getThreshold() const { return threshold; }

  void initMask(); // convolution masks - offset computation
  void print();

  void setAngleStep(const unsigned int &a) { anglestep = a; }
  void setMaskNumber(const unsigned int &a);

  void setMaskSign(const int &a) { mask_sign = a; }

  void setMaskSize(const unsigned int &a);
  void setMinSampleStep(const double &min) { min_samplestep = min; }

  void setMu1(const double &mu_1) { this->mu1 = mu_1; }

  void setMu2(const double &mu_2) { this->mu2 = mu_2; }

  void setNbTotalSample(const int &nb) { ntotal_sample = nb; }

  void setPointsToTrack(const int &n) { points_to_track = n; }

  void setRange(const unsigned int &r) { range = r; }

  void setSampleStep(const double &s) { sample_step = s; }

  inline double getSampleStep() const { return sample_step; }

  void setStrip(const int &a) { strip = a; }

  void setThreshold(const double &t) { threshold = t; }
};

#endif