cvrBoundaryType.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998 - 2004
 * 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   cvrBoundaryType.h
 *         Contains the enum eBoundaryType which provides global
 *         constants for differnt boudary conditions. The appropriate
 *         read and write functions are also defined.
 * \author Peter Doerfler
 * \date   02.04.2003
 * $Id: cvrBoundaryType.h,v 1.2 2007/04/18 21:13:40 alvarado Exp $
 */

#ifndef _CVR_BOUNDARYTYPE_H_
#define _CVR_BOUNDARYTYPE_H_

#include "cvrIoHandler.h"

namespace cvr {

  /**
   * boundary condition type.  This type indicates how to
   * consider/interpret the boundaries of an image or matrix.
   *
   * For this type the methods read(ioHandler&, eBoundaryType&) and
   * write(ioHandler&, const eBoundaryType&) are implemented. Note
   * that template functions read(ioHandler&, const std::string&, T&)
   * and write(ioHandler&, const std::string&, const T&) exist. (see
   * Developer's Guide for further information).
   *
   * @ingroup gTypes
   */
  enum eBoundaryType {
    Zero,      /**< The boundary does not exist (only 0-value) */
    Mirror,    /**< The signal/image/vector is mirrored */
    Periodic , /**< A periodic continuation of the signal is assumed */
    Constant,  /**< The last value of the border will be assumed */
    NoBoundary /**< The boundary will be ignored. The effect is
                  an unitialized border in those parts of the vector,
                  matrix or image, where a complete filter kernel cannot
                  be applied due to its size.
                  Please note that the border will be left UNinitialized.
                  It is up to you to set some value at this border,
                  which will have a maximum height or width of the size
                  of the filter kernel minus one.  The reason for this
                  option to exist is that some algorithms will ignore
                  this border anyway and all other border types will
                  spend some time calculating it */
  };

  /**
   * read function for eBoundaryType.
   *
   * @ingroup gStorable
   */
  bool read(ioHandler& handler,eBoundaryType& data);

  /**
   * write function for eBoundaryType.
   *
   * @ingroup gStorable
   */
  bool write(ioHandler& handler,const eBoundaryType& data);


}
#endif