cvrGroups.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998-2006
 * 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 cvrGroups.h
 *
 * This file contains all documentation groups for classes and data structures
 * in the CVR-Lib.
 */

#ifndef _CVR_GROUPS
#define _CVR_GROUPS

/**
 * @defgroup gCVR-LibFormatRequired Classes imported from the LTI-Lib-1.
 *
 * Please review this classes as soon as possible, since they have
 * still the old LTI-Lib-1 workarounds and format styles (template in
 * the class.h file or similar atrocities) which were required for the old
 * MS Visual compilers but are now not accepted!
 */

/**
 * @defgroup gUnassigned Unassigned Classes and Data Structures
 *
 * Please assign this classes to one of the functionality groups of the
 * CVR-Lib.  If your class does not fit into any of the current groups, please
 * insert a new one in <code>cvrlib/doc/src/cvrGroups.h</code>
 */

/**
 * @defgroup gDataStruct Data Structures
 *
 * Data Structures in the CVR-Lib
 */

/**
 * @defgroup gTypes Types
 *
 * Types defined in the CVR-Lib
 */


/**
 * @defgroup gMath Math
 *
 * Classes and Functions related with mathematical operations
 */

/**
 * @defgroup gGeomData Geometry Data Structures
 *
 * Data primitives for geometric algorithms
 * @ingroup gDataStruct
 * @ingroup gGeometry
 */

/**
 * @defgroup gAggregate Aggregate Data Types
 *
 * This group contains aggregate classes, which besides some data also provide
 * some functionality to manipulate it.
 *
 * @ingroup gDataStruct
 */

/**
 * @defgroup gImageProcessing Image Processing and Analysis
 *
 * This group contains all groups of functors and other classes related
 * with image processing.
 */

/**
 * @defgroup gLinearFilters Linear filtering
 *
 * Linear filtering kernels and functors
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gNonLinearFilters Non-linear filtering
 *
 * Non-linear filtering functors
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gDenoising Denoising filters
 *
 * Denoising filters are non-linear filters used to reduce the amount of noise
 * present in images.
 *
 * @ingroup gNonLinearFilters
 */

/**
 * @defgroup gContrastEnhancement Contrast Enhancement Algorithms
 *
 * Contrast enhancement algorithms improve the use of the available dynamic
 * range in an image.
 *
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gSharpening Sharpening Algorithms
 *
 * Sharpening algorithms improve the definition of the image, in the sense
 * that borders between objects are visually enhanced.
 *
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gEdgeCorner Edge and Corner Detectors
 *
 * Edge and Corner Detectors
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gSegmentation Segmentation Algorithms and related tools
 *
 * Segmentation algorithms and related tools
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gRegionAnalysis Region analysis
 *
 * Algorithms used to generate and used labeled masks denoting regions.
 * @ingroup gSegmentation
 */

/**
 * @defgroup gShape Shape Analysis
 *
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gGeometry Simple geometry classes and functions
 *
 * @ingroup gMath
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gMorphology Morphology operators
 *
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gColor Color Analysis
 *
 * Classes and Data Structures used for color analysis or color representation
 *
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gColorQuantization Color Quantization
 *
 * Classes and Data Structures used for color quantization
 *
 * @ingroup gColor
 */

/**
 * @defgroup gFeatureExtr Feature Extraction
 *
 * Classes and Data Structures used to extract descriptors from images
 * or image regions.
 *
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gImageTrans Image Transformations
 *
 * Classes and Data Structures used to transform images between different
 * domains, or within a domain.
 *
 * @ingroup gImageProcessing
 */

/**
 * @defgroup gGeometricTrans Geometric Image Transformations
 *
 * Classes and Data Structures used to transform images geometrically.
 *
 * @ingroup gImageTrans
 */


/**
 * @defgroup gLinearAlgebra Linear Algebra
 *
 * @ingroup gMath
 */

/**
 * @defgroup gBasicMathFunc Basic Math Functions
 *
 * @ingroup gMath
 */

/**
 * @defgroup gRandom Random numbers
 *
 * Classes and Functions related with random number generation.
 *
 * @ingroup gMath
 */

/**
 * @defgroup gRandomContinuous Continuous random distributions
 *
 * Classes and Functions related with random number generation continuously
 * distributed.
 *
 * @ingroup gRandom
 */

/**
 * @defgroup gRandomDiscrete Discrete random distributions
 *
 * Classes and Functions related with random number generation of discrete, and
 * finite elements.
 *
 * @ingroup gRandom
 */

/**
 * @defgroup gStatistics Statistics
 *
 * Classes to compute mean values, median, variances, etc.
 *
 * @ingroup gMath
 */

/**
 * @defgroup gIO Input and Output
 *
 * Classes and Functions used to read and write data.
 */

/**
 * @defgroup gStorable Storable Interface
 *
 * Methods using cvr::ioHandler objects to read and write data.
 *
 * @ingroup gIO
 */

/**
 * @defgroup gIOImage Image I/O Classes
 *
 * Classes to read and write image files.
 *
 * @ingroup gIO
 */

/**
 * @defgroup gVisualization Visualization Tools
 *
 * In this group belong not only the viewer and drawing classes, but all
 * functors used to "paint" data structures on images, in order to simplify
 * their interpretation and analysis.
 */

/**
 * @defgroup gAcquisition Acquisition Tools
 *
 * Mostly cameras and framegrabbers belong in this group. But also
 * classes that coordinate and facilitate the acquisition of images
 * via hardware.
*/

/**
 * @defgroup gLocalFeatures Local Feature Processing
 *
 * Classes that deal with the detection, description, classification,
 * and visualization of local features.
 *
 * @ingroup gFeatureExtr
 */

/**
 * @defgroup gInterfaces Programming interfaces
 *
 * In this group are located classes that provide some interface, like
 * cvr::parametersManager, cvr::status, and so on.
 */

/**
 * @defgroup gAlgorithm Classic Algorithms
 *
 * This group holds classical algorithms for searching, sorting, and the like.
 */

/**
 * @defgroup gSorting Sorting and scrambling algorithms
 *
 * This group holds sort algorithms and their opposite ones.
 */

#endif