vpKeyPointSurf.h

/****************************************************************************
 *
 * $Id: vpKeyPointSurf.h 4201 2013-04-08 08:20:47Z fspindle $
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2013 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:
 * Key point Surf.
 *
 * Authors:
 * Nicolas Melchior
 *
 *****************************************************************************/


#ifndef vpKeyPointSurf_H
#define vpKeyPointSurf_H

#include <visp/vpBasicKeyPoint.h>
#ifdef VISP_BUILD_DEPRECATED_FUNCTIONS
#  include <visp/vpList.h>
#endif

#include <list>
#include <vector>

#if defined (VISP_HAVE_OPENCV_NONFREE)


#if (VISP_HAVE_OPENCV_VERSION >= 0x020400) // Require opencv >= 2.4.0
#  include <opencv2/features2d/features2d.hpp>
#  include <opencv2/legacy/compat.hpp>
#  include <opencv2/nonfree/nonfree.hpp>
#elif (VISP_HAVE_OPENCV_VERSION >= 0x020101) // Require opencv >= 2.1.1
#  include <opencv2/features2d/features2d.hpp>
#elif (VISP_HAVE_OPENCV_VERSION >= 0x010100) // Require opencv >= 1.1.0
#  include <cxcore.h>
#  include <cv.h>
#endif

class VISP_EXPORT vpKeyPointSurf : public vpBasicKeyPoint
{
  public:
    typedef enum
    {
      basicDescriptor,   /*<! basicDescriptor means that the descriptors are
               composed by 64 elements floating-point vector. */
      extendedDescriptor /*<! Means that the descriptors are composed by
               128 elements floating-point vector. */
    } vpDescriptorType;

  public:
    vpKeyPointSurf();

    virtual ~vpKeyPointSurf(); 

    unsigned int buildReference(const vpImage<unsigned char> &I);
    unsigned int buildReference(const vpImage<unsigned char> &I,
                       const vpImagePoint &iP,
               const unsigned int height, const unsigned int width);
    unsigned int buildReference(const vpImage<unsigned char> &I,
               const vpRect& rectangle);
    unsigned int matchPoint(const vpImage<unsigned char> &I);
    unsigned int matchPoint(const vpImage<unsigned char> &I,
                   const vpImagePoint &iP, const unsigned int height, const unsigned int width);
    unsigned int matchPoint(const vpImage<unsigned char> &I, const vpRect& rectangle);
    void display(const vpImage<unsigned char> &Iref,
                 const vpImage<unsigned char> &Icurrent, unsigned int size=3);
    void display(const vpImage<unsigned char> &Icurrent, unsigned int size=3,
                 const vpColor &color=vpColor::green);
    std::list<int*>* matchPoint(std::list<float*> descriptorList, std::list<int> laplacianList);
    float* getDescriptorReferencePoint (const int index);
    int getLaplacianReferencePoint (const int index);
    void getDescriptorParamReferencePoint (const int index, int& size, float& dir);
    void setHessianThreshold (double hessianThreshold) {
            this->hessianThreshold = hessianThreshold;
            params = cvSURFParams(this->hessianThreshold, this->descriptorType);
    } ;

    void setDescriptorType (vpDescriptorType descriptorType) {
            this->descriptorType = descriptorType;
            params = cvSURFParams(this->hessianThreshold, this->descriptorType);
    } ;

    double getHessianThreshold () {return hessianThreshold;} ;

    vpDescriptorType getDescriptorType () {return descriptorType;} ;

#ifdef VISP_BUILD_DEPRECATED_FUNCTIONS

    vp_deprecated vpList<int*>* matchPoint(vpList<float*> descriptorList, vpList<int> laplacianList);
#endif

  private:
    void init();

  private:
    //OpenCV Parameters
    CvMemStorage* storage;
    CvSURFParams params;
    CvMemStorage* storage_cur;

    CvSeq* image_keypoints;
    CvSeq* image_descriptors;

    CvSeq* ref_keypoints;
    CvSeq* ref_descriptors;

    double hessianThreshold;
    vpDescriptorType descriptorType;

};


#endif

#endif