NumericStatisticalComplexSummary.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib 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 Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/statistics/NumericStatisticsComplexSummary.h
22 
23  \brief A structure to hold the set of statistics from a set of numerical values.
24 */
25 
26 #ifndef __TERRALIB_STATISTICAL_CORE_INTERNAL_NUMERICSTATISTICALCOMPLEXSUMMARY_H
27 #define __TERRALIB_STATISTICAL_CORE_INTERNAL_NUMERICSTATISTICALCOMPLEXSUMMARY_H
28 
29 // TerraLib
30 #include "Config.h"
31 
32 // STL
33 #include <complex>
34 #include <map>
35 #include <vector>
36 
37 namespace te
38 {
39  namespace stat
40  {
41  /*!
42  \struct NumericStatisticalSummary
43 
44  \brief A structure to hold the set of statistics from a set of numerical values.
45  */
47  {
48  public :
49 
51  {
52  bool operator()(const std::complex<double> s1, const std::complex<double> s2) const
53  {
54  return ( ( s1.real() < s2.real() ) && ( s1.imag() < s2.imag() ) );
55  }
56  };
57 
58  typedef std::map < std::complex< double >, std::complex< double >, ClassesPercentLess > ClassesPercentT;
59 
60  std::complex< double > m_minVal;
61  std::complex< double > m_maxVal;
62  std::complex< double > m_mean;
63  std::complex< double > m_sum;
64  int m_count;
66  std::complex< double > m_stdDeviation;
67  std::complex< double > m_kernel;
68  std::complex< double > m_variance;
69  std::complex< double > m_skewness;
70  std::complex< double > m_kurtosis;
71  std::complex< double > m_amplitude;
72  std::complex< double > m_median;
73  std::complex< double > m_varCoeff;
74  std::vector<std::complex< double > > m_mode;
75  ClassesPercentT m_percentEachClass;
76 
77  /*! \brief Constructor. */
79 
80  /*!
81  \brief Copy constructor.
82 
83  \param rhs The right-hand-side copy used to copy from.
84  */
86 
87  /*! \brief Destructor. */
89 
90  /*!
91  \brief Assignment operator.
92 
93  \param rhs The right-hand-side copy used to copy from.
94 
95  \return A reference to this object.
96  */
98 
99  /*! \brief Clear the structure. */
100  void clear();
101  };
102 
103  } // end namespace stat
104 } // end namespace te
105 
106 #endif // #define __TERRALIB_STATISTICAL_CORE_INTERNAL_NUMERICSTATISTICALCOMPLEXSUMMARY_H
107 
bool operator()(const std::complex< double > s1, const std::complex< double > s2) const
URI C++ Library.
#define TESTATEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:61
std::map< std::complex< double >, std::complex< double >, ClassesPercentLess > ClassesPercentT
Configuration flags for the Terrralib Statistic module.