geo/tcSpectrum.h

   1 /***************************************************************************
   2  *   This file is part of Tecorrec.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   Tecorrec is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   Tecorrec is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with Tecorrec.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 #ifndef _tcSpectrum_h_
  21 #define _tcSpectrum_h_
  22
  23 /**
  24  * @file tcSpectrum.h
  25  * @brief Frequency spectrum.
  26  */
  27
  28 /// Frequency spectrum.
  29 class tcSpectrum
  30 {
  31   public:
  32
  33     /*
  34      * Constructors + destructor
  35      */
  36
  37     /// Default constructor.
  38     tcSpectrum();
  39
  40     /// Destructor.
  41     virtual ~tcSpectrum();
  42
  43     /*
  44      * Virtual interface
  45      */
  46
  47     /// Get the mean input value.
  48     virtual float mean() const = 0;
  49
  50     /// Full integral (-inf, inf).
  51     virtual float integrate() const = 0;
  52
  53     /// Partial integral (-inf, @p x).
  54     virtual float integrate(float x) const = 0;
  55
  56     /// Range integral (@p x, @p y).
  57     virtual float integrate(float x, float y) const;
  58 };
  59
  60 #endif
  61