vpBasicFeature.h

/****************************************************************************
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2017 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://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:
 * Visual feature.
 *
 * Authors:
 * Eric Marchand
 * Nicolas Mansard
 *
 *****************************************************************************/



#ifndef vpBasicFeature_H
#define vpBasicFeature_H

#include <visp3/core/vpMatrix.h>
#include <visp3/core/vpColVector.h>

// Display Issue

// Meter/pixel conversion
#include <visp3/core/vpCameraParameters.h>

//Color / image / display
#include <visp3/core/vpColor.h>
#include <visp3/core/vpImage.h>
#include <visp3/core/vpRGBa.h>

// #define FEATURE_ALL 0xff

// #define FEATURE_LINE1 0x1
// #define FEATURE_LINE2 0x2
// #define FEATURE_LINE3 0x4
// #define FEATURE_LINE4 0x8
// #define FEATURE_LINE5 0x10
// #define FEATURE_LINE6 0x20
// #define FEATURE_LINE7 0x40
// #define FEATURE_LINE8 0x80


class VISP_EXPORT vpBasicFeature
{
public: // Public constantes
  static const unsigned int FEATURE_LINE [32];

  enum {
    FEATURE_ALL = 0xffff
  };
  typedef enum
  {
    user,
    vpServo
  } vpBasicFeatureDeallocatorType;

protected:
  vpColVector s ;
  unsigned int dim_s ;
  //int featureLine[8] ;
  bool *flags;
  unsigned int nbParameters;

public:
  vpBasicFeature() ;
  vpBasicFeature(const vpBasicFeature &f) ;
  virtual ~vpBasicFeature();

  unsigned int dimension_s() { return dim_s ; }

  virtual void display(const vpCameraParameters &cam,
                       const vpImage<unsigned char> &I,
                       const vpColor &color=vpColor::green,
                       unsigned int thickness=1) const = 0;
  virtual void display(const vpCameraParameters &cam,
                       const vpImage<vpRGBa> &I,
                       const vpColor &color=vpColor::green,
                       unsigned int thickness=1) const = 0;

  virtual void init() = 0 ;

  virtual vpColVector error(const vpBasicFeature &s_star,
                            const unsigned int select= FEATURE_ALL);

  // Get the feature vector.
  vpColVector get_s(unsigned int select=FEATURE_ALL) const;
  vpBasicFeatureDeallocatorType getDeallocate() { return deallocate ; }

  // Get the feature vector dimension.
  unsigned int getDimension(const unsigned int select=FEATURE_ALL) const;
  virtual vpMatrix interaction(const unsigned int select = FEATURE_ALL) = 0;
  virtual inline double operator[](const unsigned int i) const {  return s[i]; }
  vpBasicFeature &operator=(const vpBasicFeature &f) ;
  virtual void print(const unsigned int select= FEATURE_ALL) const = 0 ;

  virtual vpBasicFeature *duplicate() const = 0 ;

  void setDeallocate(vpBasicFeatureDeallocatorType d) { deallocate = d ; }
  void setFlags();

  static  unsigned int selectAll()  { return FEATURE_ALL ; }

protected:
  void resetFlags();

protected:
  vpBasicFeatureDeallocatorType deallocate ;
} ;

#endif

/*
 * Local variables:
 * c-basic-offset: 2
 * End:
 */