vpImagePoint.cpp

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 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:
 * 2D point useful for image processing
 */
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpImagePoint.h>
#include <visp3/core/vpMath.h>
#include <visp3/core/vpRect.h>
 
#include <limits> // numeric_limits
 
BEGIN_VISP_NAMESPACE
bool vpImagePoint::inRectangle(const vpRect &rect) const
{
  return ((this->i <= rect.getBottom()) && (this->i >= rect.getTop()) && (this->j <= rect.getRight()) &&
          (this->j >= rect.getLeft()));
}

vpImagePoint &vpImagePoint::operator+=(const vpImagePoint &ip)
{
  this->i += ip.i;
  this->j += ip.j;
  return *this;
}

vpImagePoint &vpImagePoint::operator/=(double scale)
{
  this->i /= scale;
  this->j /= scale;
  return *this;
}

VISP_EXPORT bool operator==(const vpImagePoint &ip1, const vpImagePoint &ip2)
{
  // --comment: return  ip1 dot get_i() eq ip2 dot get_i() and ip1 dot get_j() eq ip2 dot get_j()
 
  double i1 = ip1.get_i();
  double j1 = ip1.get_j();
  double i2 = ip2.get_i();
  double j2 = ip2.get_j();
 
  return ((std::fabs(i1 - i2) <= (std::fabs(vpMath::maximum(i1, i2)) * std::numeric_limits<double>::epsilon())) &&
          (std::fabs(j1 - j2) <= (std::fabs(vpMath::maximum(j1, j2)) * std::numeric_limits<double>::epsilon())));
}

VISP_EXPORT bool operator!=(const vpImagePoint &ip1, const vpImagePoint &ip2)
{
// --comment: return ip1 dot get_i() diff ip2 dot get_i() or ip1 dot get_j() diff ip2 dot get_j()
  double i1 = ip1.get_i();
  double j1 = ip1.get_j();
  double i2 = ip2.get_i();
  double j2 = ip2.get_j();
 
  return ((std::fabs(i1 - i2) > (std::fabs(vpMath::maximum(i1, i2)) * std::numeric_limits<double>::epsilon())) ||
          (std::fabs(j1 - j2) > (std::fabs(vpMath::maximum(j1, j2)) * std::numeric_limits<double>::epsilon())));
}

VISP_EXPORT vpImagePoint operator+(const vpImagePoint &ip1, const vpImagePoint &ip2)
{
  return (vpImagePoint(ip1.get_i() + ip2.get_i(), ip1.get_j() + ip2.get_j()));
}

VISP_EXPORT vpImagePoint operator+=(const vpImagePoint &ip1, const vpImagePoint &ip2)
{
  return (vpImagePoint(ip1.get_i() + ip2.get_i(), ip1.get_j() + ip2.get_j()));
}

VISP_EXPORT vpImagePoint operator+(const vpImagePoint &ip1, int offset)
{
  return (vpImagePoint(ip1.get_i() + offset, ip1.get_j() + offset));
}

VISP_EXPORT vpImagePoint operator+(const vpImagePoint &ip1, unsigned int offset)
{
  return (vpImagePoint(ip1.get_i() + offset, ip1.get_j() + offset));
}

VISP_EXPORT vpImagePoint operator+(const vpImagePoint &ip1, double offset)
{
  return (vpImagePoint(ip1.get_i() + offset, ip1.get_j() + offset));
}

VISP_EXPORT vpImagePoint operator-(const vpImagePoint &ip1, const vpImagePoint &ip2)
{
  return (vpImagePoint(ip1.get_i() - ip2.get_i(), ip1.get_j() - ip2.get_j()));
}

VISP_EXPORT vpImagePoint operator-(const vpImagePoint &ip1, int offset)
{
  return (vpImagePoint(ip1.get_i() - offset, ip1.get_j() - offset));
}

VISP_EXPORT vpImagePoint operator-(const vpImagePoint &ip1, unsigned int offset)
{
  return (vpImagePoint(ip1.get_i() - offset, ip1.get_j() - offset));
}

VISP_EXPORT vpImagePoint operator-(const vpImagePoint &ip1, double offset)
{
  return (vpImagePoint(ip1.get_i() - offset, ip1.get_j() - offset));
}

VISP_EXPORT vpImagePoint operator*(const vpImagePoint &ip1, double scale)
{
  return (vpImagePoint(ip1.get_i() * scale, ip1.get_j() * scale));
}

VISP_EXPORT vpImagePoint operator/(const vpImagePoint &ip1, double scale)
{
  return (vpImagePoint(ip1.get_i() / scale, ip1.get_j() / scale));
}

VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpImagePoint &ip)
{
  os << ip.get_i() << ", " << ip.get_j();
  return os;
}

vpRect vpImagePoint::getBBox(const std::vector<vpImagePoint> &ipVec)
{
  vpRect rec(ipVec);
 
  return rec;
}

double vpImagePoint::distance(const vpImagePoint &iP1, const vpImagePoint &iP2)
{
  return sqrt(vpMath::sqr(iP1.get_i() - iP2.get_i()) + vpMath::sqr(iP1.get_j() - iP2.get_j()));
}

double vpImagePoint::sqrDistance(const vpImagePoint &iP1, const vpImagePoint &iP2)
{
  return vpMath::sqr(iP1.get_i() - iP2.get_i()) + vpMath::sqr(iP1.get_j() - iP2.get_j());
}
END_VISP_NAMESPACE