vpImagePoint.h

/****************************************************************************
 *
 * $Id: vpImagePoint.h 4056 2013-01-05 13:04:42Z 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:
 * 2D point useful for image processing
 *
 * Authors:
 * Nicolas Melchior
 * Fabien Spindler
 *
 *****************************************************************************/

#ifndef vpImagePoint_H
#define vpImagePoint_H

#include <visp/vpConfig.h>
#include <visp/vpMath.h>

#include <ostream>
#include <cmath>    // std::fabs
#include <limits>   // numeric_limits

class vpHomography;
class vpRect;

class VISP_EXPORT vpImagePoint
{
 public:
  inline vpImagePoint() {
    i = 0;
    j = 0;
  }
  inline vpImagePoint(double i, double j) {
    this->i = i;
    this->j = j;
  }
  inline vpImagePoint(const vpImagePoint &ip) {
    this->i = ip.i;
    this->j = ip.j;
  }
  inline virtual ~vpImagePoint() { ; }

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

  inline void set_i(const double i) {  this->i = i ; }

  inline void set_j(const double j) {  this->j = j ; }

  inline void set_ij(const double i, const double j) {
    this->i = i ;
    this->j = j ;
  }

  inline double get_i()  const { return i ; }

  inline double get_j()  const { return j ; }

  inline void set_u(const double u) {  j = u ; }

  inline void set_v(const double v) {  i = v ; }

  inline void set_uv(const double u, const double v) {
    this->i = v ;
    this->j = u ;
  }

  inline double get_u()  const { return j ; }

  inline double get_v()  const { return i; }

  static double 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())));}
    
  static double sqrDistance (const vpImagePoint &iP1, const vpImagePoint &iP2) {
    return(vpMath::sqr(iP1.get_i()-iP2.get_i())+vpMath::sqr(iP1.get_j()-iP2.get_j()));}
  
  
  bool inRectangle( const vpRect &rect ) const;

  vpImagePoint projection(const vpHomography& aHb);

 private:
  double i,j;
};

VISP_EXPORT inline bool operator==( const vpImagePoint &ip1, 
                    const vpImagePoint &ip2 ) {
  //return ( ( ip1.get_i() == ip2.get_i() ) && ( ip1.get_j() == ip2.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 inline bool operator!=( const vpImagePoint &ip1, 
                    const vpImagePoint &ip2 ) {
  //return ( ( ip1.get_i() != ip2.get_i() ) || ( ip1.get_j() != ip2.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 inline vpImagePoint operator+( const vpImagePoint &ip1, 
                           const vpImagePoint &ip2 ) {
  return ( vpImagePoint(ip1.get_i()+ip2.get_i(), ip1.get_j()+ip2.get_j()));
}
VISP_EXPORT inline vpImagePoint operator+( const vpImagePoint &ip1, 
                           const int offset ) {
  return ( vpImagePoint(ip1.get_i()+offset, ip1.get_j()+offset));
}
VISP_EXPORT inline vpImagePoint operator+( const vpImagePoint &ip1, 
                           const double offset ) {
  return ( vpImagePoint(ip1.get_i()+offset, ip1.get_j()+offset));
}

VISP_EXPORT inline vpImagePoint operator-( const vpImagePoint &ip1, 
                           const vpImagePoint &ip2 ) {
  return ( vpImagePoint(ip1.get_i()-ip2.get_i(), ip1.get_j()-ip2.get_j()));
}
VISP_EXPORT inline vpImagePoint operator-( const vpImagePoint &ip1, 
                           const int offset ) {
  return ( vpImagePoint(ip1.get_i()-offset, ip1.get_j()-offset));
}
VISP_EXPORT inline vpImagePoint operator-( const vpImagePoint &ip1, 
                           const double offset ) {
  return ( vpImagePoint(ip1.get_i()-offset, ip1.get_j()-offset));
}
VISP_EXPORT inline vpImagePoint operator*( const vpImagePoint &ip1, 
                           const double scale ) {
  return ( vpImagePoint(ip1.get_i()*scale, ip1.get_j()*scale));
}
VISP_EXPORT inline vpImagePoint operator/( const vpImagePoint &ip1, 
                           const double scale ) {
  return ( vpImagePoint(ip1.get_i()/scale, ip1.get_j()/scale));
}

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


#endif

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