Commit 47c0799e authored by thomas.forbriger's avatar thomas.forbriger Committed by thomas.forbriger
Browse files

provide usage information

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: 1843
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent c7533f78
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: anyfilter.cc,v 1.3 2005-07-08 07:07:58 tforb Exp $
* $Id: anyfilter.cc,v 1.4 2005-07-11 14:56:39 tforb Exp $
* \author Thomas Forbriger
* \date 05/07/2005
*
......@@ -19,7 +19,7 @@
#define TF_ANYFILTER_CC_VERSION \
"TF_ANYFILTER_CC V1.0 "
#define TF_ANYFILTER_CC_CVSID \
"$Id: anyfilter.cc,v 1.3 2005-07-08 07:07:58 tforb Exp $"
"$Id: anyfilter.cc,v 1.4 2005-07-11 14:56:39 tforb Exp $"
#include <sstream>
#include <tsxx/anyfilter.h>
......@@ -87,6 +87,14 @@ namespace ts {
return(fh);
}
//! print information on available filters
void print_any_help(std::ostream& os)
{
ts::filter::print_help(os);
os << std::endl;
ts::seife::print_help(os);
}
} // namespace filter
} // namespace ts
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: anyfilter.h,v 1.2 2005-07-08 07:07:58 tforb Exp $
* $Id: anyfilter.h,v 1.3 2005-07-11 14:56:39 tforb Exp $
* \author Thomas Forbriger
* \date 05/07/2005
*
......@@ -23,7 +23,7 @@
#define TF_ANYFILTER_H_VERSION \
"TF_ANYFILTER_H V1.0 "
#define TF_ANYFILTER_H_CVSID \
"$Id: anyfilter.h,v 1.2 2005-07-08 07:07:58 tforb Exp $"
"$Id: anyfilter.h,v 1.3 2005-07-11 14:56:39 tforb Exp $"
#include<string>
#include<tsxx/filterbase.h>
......@@ -36,6 +36,9 @@ namespace ts {
Tfilterhandle make_any_filter(const std::string& s,
const bool& debug=false);
//! print information on available filters
void print_any_help(std::ostream& os);
} // namespace filter
} // namespace ts
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: filter.cc,v 1.10 2005-07-08 07:07:59 tforb Exp $
* $Id: filter.cc,v 1.11 2005-07-11 14:56:40 tforb Exp $
* \author Thomas Forbriger
* \date 05/07/2005
*
......@@ -13,13 +13,14 @@
*
* REVISIONS and CHANGES
* - 05/07/2005 V1.0 Thomas Forbriger
* - 11/07/2005 V1.1 provide usage information
*
* ============================================================================
*/
#define TF_FILTER_CC_VERSION \
"TF_FILTER_CC V1.0 "
"TF_FILTER_CC V1.1"
#define TF_FILTER_CC_CVSID \
"$Id: filter.cc,v 1.10 2005-07-08 07:07:59 tforb Exp $"
"$Id: filter.cc,v 1.11 2005-07-11 14:56:40 tforb Exp $"
#include <cmath>
#include <sstream>
......@@ -193,6 +194,30 @@ namespace ts {
return(fh);
}
//! print usage information
void print_help(std::ostream& os)
{
os << TF_FILTER_CC_VERSION << std::endl;
os << "available filters:" << std::endl;
os << "tre n remove trend found in first n samples" << std::endl;
os << " (n=0: use all samples)" << std::endl;
os << "avg n remove average found in first n samples" << std::endl;
os << " (n=0: use all samples)" << std::endl;
os << "han apply hanning taper" << std::endl;
os << "fac f scale with factor f" << std::endl;
os << "add v add v" << std::endl;
os << "fbl n1 n2 n3" << std::endl
<< " force to baseline such that the averages in the range"
<< std::endl
<< " to n1 and the range from n2 to n3 vanish"
<< std::endl;
os << " (n1=0: sets n1=1)" << std::endl;
os << " (n2=0: sets n2=n1)" << std::endl;
os << " (n3=0: sets n3 to the last sample)" << std::endl;
os << "rev reverse time series" << std::endl;
os << TF_FILTER_CC_CVSID << std::endl;
}
} // namespace filter
} // namespace ts
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: filter.h,v 1.12 2005-07-08 07:07:59 tforb Exp $
* $Id: filter.h,v 1.13 2005-07-11 14:56:40 tforb Exp $
* \author Thomas Forbriger
* \date 05/07/2005
*
......@@ -23,7 +23,7 @@
#define TF_FILTER_H_VERSION \
"TF_FILTER_H V1.0 "
#define TF_FILTER_H_CVSID \
"$Id: filter.h,v 1.12 2005-07-08 07:07:59 tforb Exp $"
"$Id: filter.h,v 1.13 2005-07-11 14:56:40 tforb Exp $"
#include<tsxx/filterbase.h>
......@@ -125,6 +125,9 @@ namespace ts {
ts::filter::Tfilterhandle make_filter(const std::string& s,
const bool& debug=false);
//! print information on available filters
void print_help(std::ostream& os);
} // namespace filter
} // namespace ts
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: seifeclass.cc,v 1.6 2005-07-11 09:04:08 tforb Exp $
* $Id: seifeclass.cc,v 1.7 2005-07-11 14:56:40 tforb Exp $
* \author Thomas Forbriger
* \date 04/07/2005
*
......@@ -13,14 +13,16 @@
*
* REVISIONS and CHANGES
* - 04/07/2005 V1.0 Thomas Forbriger
* - 11/07/2005 V1.1 support debug mode
* - 11/07/2005 V1.1
* - support debug mode
* - provide usage information
*
* ============================================================================
*/
#define TF_SEIFECLASS_CC_VERSION \
"TF_SEIFECLASS_CC V1.1"
#define TF_SEIFECLASS_CC_CVSID \
"$Id: seifeclass.cc,v 1.6 2005-07-11 09:04:08 tforb Exp $"
"$Id: seifeclass.cc,v 1.7 2005-07-11 14:56:40 tforb Exp $"
#include<sstream>
#include<tsxx/seifexx.h>
......@@ -158,6 +160,33 @@ namespace ts {
return(fh);
}
//! print usage information
void print_help(std::ostream& os)
{
os << TF_SEIFECLASS_CC_VERSION << std::endl;
os << "available filters (see seife.f by Erhard Wielandt):" << std::endl;
os << "lpb t0 o Butterworth low-pass of order o" << std::endl;
os << "hpb t0 o Butterworth high-pass of order o" << std::endl;
os << "lp2 t0 h 2nd order low-pass" << std::endl;
os << "hp2 t0 h 2nd order high-pass" << std::endl;
os << "bp2 t0 h 2nd order band-pass" << std::endl;
os << "lp1 t0 1st order low-pass" << std::endl;
os << "hp1 t0 1st order high-pass" << std::endl;
os << "le2 t0s hs t0 h" << std::endl;
os << " 2nd order low-pass equalizer" << std::endl;
os << "he2 t0s hs t0 h" << std::endl;
os << " 2nd order high-pass equalizer" << std::endl;
os << "le1 t0s t0 1st order low-pass equalizer" << std::endl;
os << "he1 t0s t0 1st order high-pass equalizer" << std::endl;
os << "int t0 integrate with time constant t0" << std::endl;
os << " (t0=0.: sets t0=1.)" << std::endl;
os << "dif t0 differentiate with time constant t0" << std::endl;
os << " (t0=0.: sets t0=1.)" << std::endl;
os << "tid n remove tides (including n tidal waves)" << std::endl;
os << "first remove value of first sample" << std::endl;
os << TF_SEIFECLASS_CC_CVSID << std::endl;
}
} // namespace seife
} // namespace ts
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: seifeclass.h,v 1.5 2005-07-05 11:07:29 tforb Exp $
* $Id: seifeclass.h,v 1.6 2005-07-11 14:56:40 tforb Exp $
* \author Thomas Forbriger
* \date 04/07/2005
*
......@@ -23,7 +23,7 @@
#define TF_SEIFECLASS_H_VERSION \
"TF_SEIFECLASS_H V1.0 "
#define TF_SEIFECLASS_H_CVSID \
"$Id: seifeclass.h,v 1.5 2005-07-05 11:07:29 tforb Exp $"
"$Id: seifeclass.h,v 1.6 2005-07-11 14:56:40 tforb Exp $"
#include<string>
#include<tsxx/filterbase.h>
......@@ -189,6 +189,9 @@ namespace ts {
//! create a seife filter
ts::filter::Tfilterhandle make_seife_filter(const std::string& s);
//! print information on available filters
void print_help(std::ostream& os);
} // namespace seife
} // namespace ts
......
Markdown is supported
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