stfinvblinddeconv.h 2.54 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/*! \file stfinvblinddeconv.h
 * \brief blind deconvolution in the frequency domain (prototypes)
 * 
 * ----------------------------------------------------------------------------
 * 
 * $Id$
 * \author Thomas Forbriger
 * \date 06/05/2011
 * 
 * blind deconvolution in the frequency domain (prototypes)
 * 
 * Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 *
 * ----
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version. 
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ----
 *
 * 
 * REVISIONS and CHANGES 
 *  - 06/05/2011   V1.0   Thomas Forbriger
 * 
 * ============================================================================
 */

// include guard
#ifndef STFINV_STFINVBLINDDECONV_H_VERSION

#define STFINV_STFINVBLINDDECONV_H_VERSION \
  "STFINV_STFINVBLINDDECONV_H   V1.0   "
#define STFINV_STFINVBLINDDECONV_H_CVSID \
  "$Id$"

#include<stfinv/stfinvbase.h>

namespace stfinv {

  /*! \brief Blind deconvolution engine
thomas.forbriger's avatar
thomas.forbriger committed
50
   * \ingroup engines
51
52
53
   */
  class STFEngineBlindDeconvolution: private stfinv::STFBaseEngine {
    public:
54
      //! \brief typedef to refer to base class
55
      typedef stfinv::STFBaseEngine Tbase;
56
57
58
59
      //! \brief ID used to select thsi engine
      static const char* const ID;
      //! \brief short description of this engine
      static const char* const description;
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
      /*! \brief Constructor.
       */
      STFEngineBlindDeconvolution(const stfinv::Tlistoftriples& triples,
                                  const stfinv::Waveform& stf,
                                  const std::string& parameters)
        :Tbase(triples, stf, parameters) { }
      //! \brief abstract base requires virtual destructor
      virtual ~STFEngineBlindDeconvolution() { }
      //! \brief Start engine and return source time function.
      virtual stfinv::Waveform run();
  }; // class STFEngineBlindDeconvolution

} // namespace stfinv

#endif // STFINV_STFINVBLINDDECONV_H_VERSION (includeguard)

/* ----- END OF stfinvblinddeconv.h ----- */