cvrConvexHull.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */



/**
 * \file   cvrConvexHull.h
 *         Contains the functor convexHull
 * \author Pablo Alvarado
 * \date   16.11.2002
 *
 * $Id: cvrConvexHull.h,v 1.5 2006/01/18 12:05:43 doerfler Exp $
 */

#ifndef _CVR_CONVEX_HULL_H_
#define _CVR_CONVEX_HULL_H_

#include "cvrFunctor.h"
#include "cvrPolygonPoints.h"

namespace cvr {
  /**
   * Computes the convex hull of a set of points.
   *
   * The algorithm used is similar to the one explained in:
   *
   * M. de Berg, et. al. Computational Geometry. Algorithms and
   * Applications, 2nd. edition. Springer, 2000
   */
  class convexHull : public functor {
  public:
    /**
     * the parameters for the class convexHull
     */
    class parameters : public functor::parameters {
    public:
      /**
       * default constructor
       */
      parameters();

      /**
       * copy constructor
       * @param other the parameters object to be copied
       */
      parameters(const parameters& other);

      /**
       * destructor
       */
      ~parameters();

      /**
       * returns name of this type
       */
      const std::string& name() const;

      /**
       * copy the contents of a parameters object
       * @param other the parameters object to be copied
       * @return a reference to this parameters object
       */
      parameters& copy(const parameters& other);

      /**
       * copy the contents of a parameters object
       * @param other the parameters object to be copied
       * @return a reference to this parameters object
       */
      parameters& operator=(const parameters& other);


      /**
       * returns a pointer to a clone of the parameters
       */
      virtual parameters* clone() const;

      /**
       * returns a pointer to a new instance of the parameters
       */
      virtual parameters* newInstance() const;

      /**
       * write the parameters in the given ioHandler
       * @param handler the ioHandler to be used
       * @param complete if true (the default) the enclosing begin/end will
       *        be also written, otherwise only the data block will be written.
       * @return true if write was successful
       */
      virtual bool write(ioHandler& handler,const bool complete=true) const;

      /**
       * read the parameters from the given ioHandler
       * @param handler the ioHandler to be used
       * @param complete if true (the default) the enclosing begin/end will
       *        be also written, otherwise only the data block will be written.
       * @return true if write was successful
       */
      virtual bool read(ioHandler& handler,const bool complete=true);

      // ------------------------------------------------
      // the parameters
      // ------------------------------------------------

      //TODO: comment the parameters of your functor
      // If you add more parameters manually, do not forget to do following:
      // 1. indicate in the default constructor the default values
      // 2. make sure that the copy member also copy your new parameters
      // 3. make sure that the read and write members also read and
      //    write your parameters


    };

    /**
     * default constructor
     */
    convexHull();

    /**
     * Construct a functor using the given parameters
     */
    convexHull(const parameters& par);

    /**
     * copy constructor
     * @param other the object to be copied
     */
    convexHull(const convexHull& other);

    /**
     * destructor
     */
    virtual ~convexHull();

    /**
     * returns the name of this type
     */
    virtual const std::string& name() const;

    /**
     * operates on a copy of the given %parameters.
     * @param src pointList with the source data.
     * @param dest pointList where the result will be left.
     * @return true if apply successful or false otherwise.
     */
    bool apply(const ipointList& src,ipolygonPoints& dest) const;

    /**
     * operates on a copy of the given %parameters.
     * @param src pointList with the source data.
     * @param dest pointList where the result will be left.
     * @return true if apply successful or false otherwise.
     */
    bool apply(const ioPoints& src,ipolygonPoints& dest) const;

    /**
     * operates on a copy of the given %parameters.
     * @param src pointList with the source data.
     * @param dest pointList where the result will be left.
     * @return true if apply successful or false otherwise.
     */
    bool apply(const pointList<float>& src,polygonPoints<float>& dest) const;

    /**
     * operates on a copy of the given %parameters.
     * @param src pointList with the source data.
     * @param dest pointList where the result will be left.
     * @return true if apply successful or false otherwise.
     */
    bool apply(const pointList<double>& src,
                     polygonPoints<double>& dest) const;

    /**
     * copy data of "other" functor.
     * @param other the functor to be copied
     * @return a reference to this functor object
     */
    convexHull& copy(const convexHull& other);

    /**
     * alias for copy member
     * @param other the functor to be copied
     * @return a reference to this functor object
     */
    convexHull& operator=(const convexHull& other);

    /**
     * returns a pointer to a clone of this functor.
     */
    virtual convexHull* clone() const;

    /**
     * returns a pointer to a new instance of this functor.
     */
    virtual convexHull* newInstance() const;

    /**
     * returns used parameters
     */
    const parameters& getParameters() const;

    //TODO: comment the attributes of your functor
    // If you add more attributes manually, do not forget to do following:
    // 1. indicate in the default constructor the default values
    // 2. make sure that the copy member also copy your new attributes, or
    //    to ensure there, that these attributes are properly initialized.

    /**
     * Creates the smallest convex polygon that contains all points
     * in the given point list.
     *
     * The list of points \b must be a set, i.e. the same point is not
     * allowed to be twice in the list.  (This usually is not the case
     * in cvr::ioPoints lists, see castFrom(const ioPoints&)).
     *
     * For more information on the algorithm used here see:
     *
     * M. de Berg, et.al. Computational Geometry, Algorithms and Applications.
     * 2nd. edition, Springer, 2000, pp. 6ff
     *
     * @param thePointList a set of points (the same point is not allowed to
     *                     be twice in the list).
     * @param thePolygonPoints the resulting polygon
     * @return a reference to the result
     */
    template<typename T>
    polygonPoints<T>& computeConvexHull(const pointList<T>& thePointList,
                                        polygonPoints<T>& thePolygonPoints) const;

  };
}

#endif