waveformheader.h 2.77 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
/*! \file waveformheader.h
 * \brief definition of waveform header to be used in C and C++ (prototypes)
 * 
 * ----------------------------------------------------------------------------
 * 
 * $Id$
 * \author Thomas Forbriger
 * \date 06/05/2011
 * 
 * definition of waveform header to be used in C and C++ (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_WAVEFORMHEADER_H_VERSION

#define STFINV_WAVEFORMHEADER_H_VERSION \
  "STFINV_WAVEFORMHEADER_H   V1.0   "
#define STFINV_WAVEFORMHEADER_H_CVSID \
  "$Id$"

#ifdef __cplusplus
extern "C" {
#endif

49
50
51
52
53
54
55
56
  /*! \brief Value type of samples.
   *
   * \ingroup cinterface
   */
  typedef float Tvalue;

/*----------------------------------------------------------------------*/

thomas.forbriger's avatar
thomas.forbriger committed
57
  /*! \brief Structure to hold header information for a time series array
58
59
   *
   * \ingroup cinterface
60
   */
61
  struct CWaveformHeader {
thomas.forbriger's avatar
thomas.forbriger committed
62
    /*! \brief Sampling interval in seconds.
63
64
     */
    double dt;
thomas.forbriger's avatar
thomas.forbriger committed
65
    /*! \brief Number of samples in time series array.
66
     */
67
    unsigned int n;
68
  }; // struct CWaveformHeader
69
70
71

  /*----------------------------------------------------------------------*/

thomas.forbriger's avatar
thomas.forbriger committed
72
  /*! \brief Structure to hold header information for a triple of waveforms
73
74
   *
   * \ingroup cinterface
75
   */
76
  struct CTripleHeader {
thomas.forbriger's avatar
thomas.forbriger committed
77
    /*! \brief Source coordinates in meters.
78
79
80
81
82
83
     *
     * - \c sx: x-coordinate
     * - \c sy: y-coordinate
     * - \c sz: z-coordinate
     */
    double sx, sy, sz;
thomas.forbriger's avatar
thomas.forbriger committed
84
    /*! \brief Receiver coordinates in meters.
85
86
87
88
89
90
     *
     * - \c rx: x-coordinate
     * - \c ry: y-coordinate
     * - \c rz: z-coordinate
     */
    double rx, ry, rz;
thomas.forbriger's avatar
thomas.forbriger committed
91
    /*! \brief Temporal sampling of all three waveforms.
92
     */
93
94
    struct CWaveformHeader sampling;
  }; // struct CTripleHeader
95
96
97
98
99
100
101
102
103

#ifdef __cplusplus
} // extern "C"
#endif


#endif // STFINV_WAVEFORMHEADER_H_VERSION (includeguard)

/* ----- END OF waveformheader.h ----- */