DATRW++ library: seismic data I/O with multiple formats
tsoftconfig.h
Go to the documentation of this file.
1 /*! \file tsoftconfig.h
2  * \brief tsoft configuration (prototypes)
3  * \ingroup group_tsoft
4  *
5  * ----------------------------------------------------------------------------
6  *
7  * \author Thomas Forbriger
8  * \date 02/12/2011
9  *
10  * tsoft configuration (prototypes)
11  *
12  * Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach)
13  *
14  * ----
15  * This program is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation; either version 2 of the License, or
18  * (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28  * ----
29  *
30  * REVISIONS and CHANGES
31  * - 02/12/2011 V1.0 Thomas Forbriger
32  *
33  * ============================================================================
34  */
35 
36 // include guard
37 #ifndef DATRW_TSOFTCONFIG_H_VERSION
38 
39 #define DATRW_TSOFTCONFIG_H_VERSION \
40  "DATRW_TSOFTCONFIG_H V1.0 "
41 
42 // #define DEBUG
43 
44 #ifdef DEBUG
45 #include<iostream>
46 #endif
47 
48 namespace datrw {
49 
50  namespace tsoft {
51 
52  /*! \brief config parameters for data extraction
53  * \ingroup group_tsoft
54  *
55  * These parameters control the way gaps in the input data are handled.
56  */
57  struct ReaderConfig {
58  /*!
59  * if true, read flagged (UNDETVAL) values, do not interrupt input
60  */
61  bool keepundetval;
62  /*!
63  * if true, replace UNDETVAL values by flagvalue
64  * if values are set to flagvalue and flagvalue != UNDETVAL
65  * then these sample values are read like normal sample values
66  * (i.e. setundetval usually implies keepundetval)
67  */
68  bool setundetval;
69  /*!
70  * value to replace UNDETVAL values with
71  */
72  double flagvalue;
73  /*!
74  * if true, bridge values with time bridgetime by replacing the sample
75  * time with the expected sample time
76  */
77  bool bridgesamples;
78  /*!
79  * unspecified date value which should be bridged
80  * typically: 0001 01 01 01 01 01
81  */
82  libtime::TAbsoluteTime bridgetime;
83  /*!
84  * true if bridged samples shall be flagged
85  */
86  bool flagbridged;
87  /*!
88  * flag value for bridged samples
89  */
90  double bridgeflagvalue;
91  /*!
92  * constructor to set default values
93  */
94  ReaderConfig()
95  : keepundetval(false), setundetval(false), flagvalue(9000.),
96  bridgesamples(false), bridgetime(1,1,1,1,1,1),
97  flagbridged(false), bridgeflagvalue(-9000.)
98  { } // ReaderConfig()
99  }; // struct ReaderConfig
100 
101  } // namespace tsoft
102 
103 } // namespace datrw
104 
105 #endif // DATRW_TSOFTCONFIG_H_VERSION (includeguard)
106 
107 /* ----- END OF tsoftconfig.h ----- */
datrw::tsoft::ReaderConfig
config parameters for data extractionThese parameters control the way gaps in the input data are hand...
Definition: tsoftconfig.h:57
datrw
Root namespace of library.
Definition: aalibdatrwxx.cc:16
datrw::tsoft::ReaderConfig::bridgetime
libtime::TAbsoluteTime bridgetime
Definition: tsoftconfig.h:82