geo/tcRangeSpectrum.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 _tcRangeSpectrum_h_
  21 #define _tcRangeSpectrum_h_
  22
  23 /**
  24  * @file tcRangeSpectrum.h
  25  * @brief Frequency spectrum of a uniform value in a range.
  26  */
  27
  28 #include "tcSpectrum.h"
  29
  30 /// Frequency spectrum.
  31 class tcRangeSpectrum : public tcSpectrum
  32 {
  33   public:
  34
  35     /*
  36      * Constructors + destructor
  37      */
  38
  39     /// Default constructor.
  40     tcRangeSpectrum(float max, float x, float y);
  41
  42     /// Destructor.
  43     virtual ~tcRangeSpectrum();
  44
  45     /*
  46      * Virtual interface
  47      */
  48
  49     // Reimplemented
  50     virtual float mean() const;
  51
  52     // Reimplemented
  53     virtual float integrate() const;
  54
  55     // Reimplemented
  56     virtual float integrate(float x) const;
  57
  58   private:
  59
  60     /*
  61      * Variables
  62      */
  63
  64     /// Value for the range.
  65     float m_max;
  66
  67     /// Start and end of the value.
  68     float m_x, m_y;
  69 };
  70
  71 #endif
  72