vpBasicKeyPoint.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 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 https://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:
 * Key point used in matching algorithm.
 */
 
#ifndef VP_BASIC_KEYPOINT_H
#define VP_BASIC_KEYPOINT_H

 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpDebug.h>
#include <visp3/core/vpColor.h>
#include <visp3/core/vpImage.h>
#include <visp3/core/vpImagePoint.h>
#include <visp3/core/vpRect.h>
 
#include <vector>
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpBasicKeyPoint
{
public:
  vpBasicKeyPoint()
    : m_referenceImagePointsList(), m_currentImagePointsList(), m_matchedReferencePoints(), m_reference_computed(false)
  { }

  virtual ~vpBasicKeyPoint();

  virtual unsigned int buildReference(const vpImage<unsigned char> &I) = 0;

  virtual unsigned int buildReference(const vpImage<unsigned char> &I, const vpImagePoint &iP, unsigned int height,
  unsigned int width) = 0;

  virtual unsigned int buildReference(const vpImage<unsigned char> &I, const vpRect &rectangle) = 0;

  virtual unsigned int matchPoint(const vpImage<unsigned char> &I) = 0;

  virtual unsigned int matchPoint(const vpImage<unsigned char> &I, const vpImagePoint &iP, unsigned int height,
    unsigned int width) = 0;

  virtual unsigned int matchPoint(const vpImage<unsigned char> &I, const vpRect &rectangle) = 0;

  virtual void display(const vpImage<unsigned char> &Iref, const vpImage<unsigned char> &Icurrent, unsigned int size = 3) = 0;

  virtual void display(const vpImage<unsigned char> &Icurrent, unsigned int size = 3, const vpColor &color = vpColor::green) = 0;

  bool referenceBuilt() const { return m_reference_computed; }

  inline const vpImagePoint *getAllPointsInReferenceImage() { return &m_referenceImagePointsList[0]; }

  inline void getReferencePoint(unsigned int index, vpImagePoint &referencePoint)
  {
    if (index >= m_referenceImagePointsList.size()) {
      vpTRACE("Index of the reference point out of range");
      throw(vpException(vpException::fatalError, "Index of the reference point out of range"));
    }
 
    referencePoint.set_ij(m_referenceImagePointsList[index].get_i(), m_referenceImagePointsList[index].get_j());
  }

  inline void getMatchedPoints(unsigned int index, vpImagePoint &referencePoint, vpImagePoint &currentPoint)
  {
    if (index >= m_matchedReferencePoints.size()) {
      vpTRACE("Index of the matched points out of range");
      throw(vpException(vpException::fatalError, "Index of the matched points out of range"));
    }
    referencePoint.set_ij(m_referenceImagePointsList[m_matchedReferencePoints[index]].get_i(),
      m_referenceImagePointsList[m_matchedReferencePoints[index]].get_j());
    currentPoint.set_ij(m_currentImagePointsList[index].get_i(), m_currentImagePointsList[index].get_j());
  }

  inline unsigned int getIndexInAllReferencePointList(unsigned int indexInMatchedPointList)
  {
    if (indexInMatchedPointList >= m_matchedReferencePoints.size()) {
      vpTRACE("Index of the matched reference point out of range");
      throw(vpException(vpException::fatalError, "Index of the matched reference point out of range"));
    }
    return m_matchedReferencePoints[indexInMatchedPointList];
  }

  inline unsigned int getReferencePointNumber() const { return static_cast<unsigned int>(m_referenceImagePointsList.size()); }

  inline unsigned int getMatchedPointNumber() const { return static_cast<unsigned int>(m_matchedReferencePoints.size()); }

  const std::vector<vpImagePoint> &getReferenceImagePointsList() const { return m_referenceImagePointsList; }

  const std::vector<vpImagePoint> &getCurrentImagePointsList() const { return m_currentImagePointsList; }

  const std::vector<unsigned int> &getMatchedReferencePoints() const { return m_matchedReferencePoints; }
 
protected:
  std::vector<vpImagePoint> m_referenceImagePointsList;

  std::vector<vpImagePoint> m_currentImagePointsList;

  std::vector<unsigned int> m_matchedReferencePoints;

  bool m_reference_computed;
 
private:
  virtual void init() = 0;
};
END_VISP_NAMESPACE
#endif