Commit 7b080f3a authored by thomas.forbriger's avatar thomas.forbriger Committed by thomas.forbriger
Browse files

extend documentation

This is a legacy commit from before 2015-03-01.
It may be incomplete as well as inconsistent.
See COPYING.legacy and README.history for details.

SVN Path:     http://gpitrsvn.gpi.uni-karlsruhe.de/repos/TFSoftware/trunk
SVN Revision: 3794
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent c6cc22b0
......@@ -47,6 +47,25 @@
* Provided are recursive filters (i.e. an interface to seife), FIR decimating
* filters, interpolation filters, tapers, containers for time series data
* together with header data, and more.
\section mainpage_sec_header Header Files
- anyfilter.h
- convolve.h
- correlate.h
- dropcontainer.h
- filterbase.h
- filter.h
- firfilters.h
- innerproduct.h
- ipo.h
- ipolin.h
- random.h
- seifeclass.h
- seifexx.h
- sffheaders.h
- tapers.h
- tsxx.h
*/
/* ----- END OF README.cc ----- */
......@@ -64,6 +64,8 @@ namespace ts {
namespace filter {
/*! \brief remove trend
*
* \ingroup filter
*
* We calculate the linear trend over the first \p n samples by a linear
* regression.
......@@ -81,7 +83,11 @@ namespace ts {
int Mn;
}; // class RemoveTrend
/*----------------------------------------------------------------------*/
/*! \brief remove average
*
* \ingroup filter
*
* Calculate average over first \p n samples and remove this value from
* the whole time series.
......@@ -98,7 +104,11 @@ namespace ts {
int Mn;
}; // class RemoveAverage
/*! \breif hanning taper.
/*----------------------------------------------------------------------*/
/*! \brief hanning taper.
*
* \ingroup filter
*
* \note
* There is a Hanning taper available in the taper collection too.
......@@ -110,7 +120,11 @@ namespace ts {
const bool& debug=false) const;
}; // class HanningTaper
//! scale with factor
/*----------------------------------------------------------------------*/
/*! scale with factor
* \ingroup filter
*/
class Scale: public ts::filter::BasicFilter {
public:
Scale(const double& v): Mv(v) { }
......@@ -120,7 +134,11 @@ namespace ts {
double Mv;
}; // class Scale
//! add a constant
/*----------------------------------------------------------------------*/
/*! add a constant
* \ingroup filter
*/
class Add: public ts::filter::BasicFilter {
public:
Add(const double& v): Mv(v) { }
......@@ -130,7 +148,10 @@ namespace ts {
double Mv;
}; // class Add
/*----------------------------------------------------------------------*/
/*! \brief force signal to a baseline.
* \ingroup filter
*
* The filter removes a linear trend from the time series.
* After this operation the average in the index ranges [i1,i2] and
......@@ -158,14 +179,22 @@ namespace ts {
int Mn1, Mn2, Mne;
}; // class ForceToBase
//! reverse time series
/*----------------------------------------------------------------------*/
/*! reverse time series
* \ingroup filter
*/
class Reverse: public ts::filter::BasicFilter {
public:
Ttimeseries operator()(const Ttimeseries& s,
const bool& debug=false) const;
}; // class Reverse
//! delay time series by linear interpolation
/*----------------------------------------------------------------------*/
/*! delay time series by linear interpolation
* \ingroup filter
*/
class Delay: public ts::filter::BasicFilter {
public:
Delay(const double& v): Mv(v) { }
......@@ -177,7 +206,9 @@ namespace ts {
/*----------------------------------------------------------------------*/
//! take square of signal
/*! take square of signal
* \ingroup filter
*/
class Square: public ts::filter::BasicFilter {
public:
Ttimeseries operator()(const Ttimeseries& s,
......@@ -186,7 +217,9 @@ namespace ts {
/*----------------------------------------------------------------------*/
//! take square root of signal
/*! take square root of signal
* \ingroup filter
*/
class SquareRoot: public ts::filter::BasicFilter {
public:
Ttimeseries operator()(const Ttimeseries& s,
......@@ -195,7 +228,9 @@ namespace ts {
/*----------------------------------------------------------------------*/
//! rectify signal (take absolute value)
/*! rectify signal (take absolute value)
* \ingroup filter
*/
class Rectifier: public ts::filter::BasicFilter {
public:
Ttimeseries operator()(const Ttimeseries& s,
......@@ -204,11 +239,15 @@ namespace ts {
/*----------------------------------------------------------------------*/
//! create a filter
/*! create a filter
* \ingroup filter
*/
ts::filter::Tfilterhandle make_filter(std::string s,
const bool& debug=false);
//! print information on available filters
/*! print information on available filters
* \ingroup filter
*/
void print_help(std::ostream& os);
} // namespace filter
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment