Commit 90e86a67 authored by thomas.forbriger's avatar thomas.forbriger Committed by thomas.forbriger
Browse files

added documentation groups

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: 3917
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 503283c8
......@@ -62,4 +62,28 @@ $Id$
* time series samples as passed to ::initstfinvengine() become invalid.
*/
/*======================================================================*/
/*! \brief C++ interface to libstfinv
*
* \defgroup cxxinterface C++ interface (API) to libstfinv
*
*/
/*======================================================================*/
/*! \brief Engines implemented in libstfinv
*
* \defgroup engines libstfinv engines
*
*/
/*======================================================================*/
/*! \brief Tools and utilities used by the libstfinv engines
*
* \defgroup tools libstfinv internal tools and utilities
*
*/
// ----- END OF README -----
......@@ -47,6 +47,8 @@
namespace stfinv {
/*! \brief Class to access any engine in the library
*
* \ingroup cxxinterface
*
* The interface of this class is identical to the interface defined by the
* abstract base class stfinv::STFBaseEngine except that the first prefix
......
......@@ -50,12 +50,14 @@
namespace stfinv {
/*! \brief Type of sample values.
* \ingroup cxxinterface
*/
typedef aff::Series<Tvalue> Tseries;
/*----------------------------------------------------------------------*/
/*! \brief A class to store the time series for a waveform triple.
* \ingroup cxxinterface
*/
class WaveformTriple {
/*! \brief The header is expected to be the same for all three time series.
......@@ -81,6 +83,7 @@ namespace stfinv {
/*! \brief A class to store a single waveform.
* This will be used to pass the source time function.
* \ingroup cxxinterface
*/
class Waveform {
/*! \brief Temporal sampling
......@@ -94,6 +97,7 @@ namespace stfinv {
/*----------------------------------------------------------------------*/
/*! \brief List of triples.
* \ingroup cxxinterface
*/
typedef std::list<stfinv::WaveformTriple> Tlistoftriples;
......@@ -105,6 +109,7 @@ namespace stfinv {
/*----------------------------------------------------------------------*/
/*! \brief Abstract base class for engines to derive source time functions
* \ingroup cxxinterface
*/
class STFBaseEngine {
public:
......
......@@ -47,6 +47,7 @@
namespace stfinv {
/*! \brief Blind deconvolution engine
* \ingroup engines
*/
class STFEngineBlindDeconvolution: private stfinv::STFBaseEngine {
public:
......
......@@ -47,6 +47,7 @@
namespace stfinv {
/*! \brief Engine to provide a fixed wavelet
* \ingroup engines
*/
class STFEngineFixedWavelet: private stfinv::STFBaseEngine {
public:
......
......@@ -44,6 +44,24 @@
namespace stfinv {
/*! \brief Engine to apply a scalar factor
* \ingroup engines
*/
class STFEngineIdentity: private stfinv::STFBaseEngine {
public:
typedef stfinv::STFBaseEngine Tbase;
/*! \brief Constructor.
*/
STFEngineIdentity(const stfinv::Tlistoftriples& triples,
const stfinv::Waveform& stf,
const std::string& parameters)
:Tbase(triples, stf, parameters) { }
//! \brief abstract base requires virtual destructor
virtual ~STFEngineIdentity() { }
//! \brief Start engine and return source time function.
virtual stfinv::Waveform run();
}; // class STFEngineIdentity
} // namespace stfinv
#endif // STFINV_STFINVIDENTITY_H_VERSION (includeguard)
......
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