vpImageCircle.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:
 * Image circle, i.e. circle in the image space.
 */

 
#ifndef VP_IMAGE_CIRCLE_H
#define VP_IMAGE_CIRCLE_H
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpColor.h>
#include <visp3/core/vpImage.h>
#include <visp3/core/vpImagePoint.h>
#include <visp3/core/vpRect.h>
 
#if defined(VISP_HAVE_OPENCV)
#include <opencv2/core/core.hpp>
#endif
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpImageCircle
{
public:
  vpImageCircle();

  vpImageCircle(const vpImagePoint &center, const float &radius);
 
#ifdef HAVE_OPENCV_CORE
  vpImageCircle(const cv::Vec3f &vec);
#endif

  float computeAngularCoverageInRoI(const vpRect &roi, const float &roundingTolerance = 0.001f) const;

  float computeArcLengthInRoI(const vpRect &roi, const float &roundingTolerance = 0.001f) const;

  unsigned int computePixelsInMask(const vpImage<bool> &mask) const;

  vpImagePoint getCenter() const;

  float getRadius() const;

  vpRect getBBox() const;

  float get_n20() const;

  float get_n02() const;

  float get_n11() const;

  inline bool isInside(const vpImagePoint &ip) const
  {
    double radius = static_cast<double>(m_radius);
    double squaredRadius = radius * radius;
    double distance = vpImagePoint::sqrDistance(m_center, ip);
    return (distance <= squaredRadius);
  }
 
private:
  vpImagePoint m_center;
  float m_radius;
};

VISP_EXPORT bool operator==(const vpImageCircle &a, const vpImageCircle &b);

VISP_EXPORT bool operator!=(const vpImageCircle &a, const vpImageCircle &b);
 
END_VISP_NAMESPACE
#endif