WSL/SLF GitLab Repository

meteoio_1dInterpolations.xml 6.88 KB
Newer Older
1
2
<!--
/*****************************************************************************/
3
/*  Copyright 2020 WSL Institute for Snow and Avalanche Research  SLF-DAVOS  */
4
5
6
/*****************************************************************************/
/* This file is part of INIshell.
INIshell is free software: you can redistribute it and/or modify
7
it under the terms of the GNU General Public License as published by
8
9
10
11
12
13
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

INIshell 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
14
GNU General Public License for more details.
15

16
17
You should have received a copy of the GNU General Public License
along with INIshell.  If not, see <http://www.gnu.org/licenses/>.
18
19
20
21
*/
-->

<!--
22
INIshell include file for MeteoIO temporal interpolations
23
24
25
26
-->

<inishell_include>

27
	<parametergroup name="1D_INTERPOLATIONS">
28
29
30
31
32
33
34
35
36
		<parameter key="ENABLE_RESAMPLING" label="ENABLE_RESAMPLING" caption="Interpolate data" type="checkbox" default="TRUE">
			<section name="Interpolations1D"/>
			<help>Should the data be resampled to the timesteps requested from outside (it is very strongly suggested to keep it set to TRUE for most applications)</help>
		</parameter>
		<parameter key="WINDOW_SIZE" type="number" format="integer+" min="1" default="43200" unit="s">
			<section name="Interpolations1D"/>
			<help>Default width of the biggest data gap that can be filled by temporal interpolation (in seconds: 1/2 day= 43200, 1 day=86400, 1 week=604800)</help>
		</parameter>
	
37
		<parameter label="Add/Remove 1D interpolation" type="selector">
38
			<section name="Interpolations1D"/>
Michael Reisecker's avatar
Michael Reisecker committed
39
			<parameter key="%::RESAMPLE" label="Resample % with:" type="alternative" template="true">
40
41
42
43
44
45
46
47
48
49
50
51
52
53
				<reference name="RESAMPLING_NONE"/>
				<reference name="RESAMPLING_NEAREST"/>
				<reference name="RESAMPLING_LINEAR"/>
				<reference name="RESAMPLING_ACCUMULATE"/>
				<reference name="RESAMPLING_SOLAR"/>
				<reference name="RESAMPLING_DAILY_SOLAR"/>
				<reference name="RESAMPLING_DAILY_AVG"/>
			</parameter>
			<reference name="METEOPARAMETERS"/>
		</parameter>
	</parametergroup>

	<!-- 1D RESAMPLING -->
	<parametergroup name="RESAMPLING_NONE">
Michael Reisecker's avatar
Michael Reisecker committed
54
		<option caption="No Interpolation" value="NONE">
Mathias Bavay's avatar
Mathias Bavay committed
55
			<help>&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/classmio_1_1NoResampling.html&quot;&gt;No interpolation&lt;/a&gt; (can be useful to overwrite imported INIs)</help>
Michael Reisecker's avatar
Michael Reisecker committed
56
		</option>
57
58
59
60
	</parametergroup>

	<parametergroup name="RESAMPLING_NEAREST">
		<option caption="Nearest Neighbour" value="NEAREST">
Michael Reisecker's avatar
Michael Reisecker committed
61
			<parameter key="%::NEAREST::WINDOW_SIZE" label="WINDOW_SIZE" type="number" format="integer" min="1" unit="s"/>
62
63
			<parameter key="%::NEAREST::EXTRAPOLATE" caption="Extrapolate data" type="checkbox">
				<help>If "extrapolate" is added, then data outside of the original date range can be interpolated. Otherwise, a data point will only be calculated between the original date range.</help>
64
			</parameter>
Mathias Bavay's avatar
Mathias Bavay committed
65
			<help>&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/classmio_1_1NearestNeighbour.html&quot;&gt;Nearest neighbor interpolation&lt;/a&gt; between missing points</help>
66
67
68
69
70
		</option>
	</parametergroup>

	<parametergroup name="RESAMPLING_LINEAR">
		<option caption="Linear" value="LINEAR">
Michael Reisecker's avatar
Michael Reisecker committed
71
			<parameter key="%::LINEAR::WINDOW_SIZE" label="WINDOW_SIZE" type="number" format="integer" min="1" unit="s"/>
72
			<parameter key="%::LINEAR::EXTRAPOLATE" caption="Extrapolate data" type="checkbox">
73
				<help>If "extrapolate" is added, then data &lt;i&gt;outside&lt;/i&gt; of the original date range can be interpolated. Otherwise, a data point will only be calculated between the original date range.</help>
74
			</parameter>
Mathias Bavay's avatar
Mathias Bavay committed
75
			<help>&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/classmio_1_1LinearResampling.html&quot;&gt;Linear interpolation&lt;/a&gt; between missing points</help>
76
77
78
79
80
		</option>
	</parametergroup>

	<parametergroup name="RESAMPLING_ACCUMULATE">
		<option caption="Accumulate" value="ACCUMULATE">
81
			<parameter key="%::ACCUMULATE::PERIOD" label="Accumulation period:" type="number" format="integer+" min="1" default="900" optional="false" unit="s">
82
83
				<help>Accumulation period (in seconds). This must usually match the model time step. It is assumed that the measured accumulation period is equal to the data timesteps.</help>
			</parameter>
84
			<parameter key="%::ACCUMULATE::STRICT" caption="Strict nodatda propagation" type="checkbox">
85
86
				<help>if enabling "strict", nodatas will propagate (ie. a single nodata in the input will force the re-accumulated value to be nodata). Otherwise, all valid values are aggregated and only pure nodata intervals produce a nodata in the output.</help>
			</parameter>
Mathias Bavay's avatar
Mathias Bavay committed
87
			<help>&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/classmio_1_1Accumulate.html&quot;&gt;Accumulation&lt;/a&gt; over a user given period (filter argument, in seconds - should coincide with your calculation step!).</help>
88
89
90
91
92
		</option>
	</parametergroup>

	<parametergroup name="RESAMPLING_SOLAR">
		<option caption="Solar" value="SOLAR" type="string">
93
94
			<parameter key="%::LINEAR::WINDOW_SIZE" label="WINDOW_SIZE" type="number" format="integer" min="1" unit="s"/>
			<parameter key="%::LINEAR::EXTRAPOLATE" caption="Extrapolate data" type="checkbox">
95
				<help>If "extrapolate" is added, then data &lt;i&gt;outside&lt;/i&gt; of the original date range can be interpolated. Otherwise, a data point will only be calculated between the original date range.</help>
96
			</parameter>
Mathias Bavay's avatar
Mathias Bavay committed
97
			<help>&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/classmio_1_1Solar.html&quot;&gt;Resample solar radiation&lt;/a&gt; by interpolating an atmospheric loss factor.</help>
98
99
100
101
102
		</option>
	</parametergroup>

	<parametergroup name="RESAMPLING_DAILY_SOLAR">
		<option caption="Solar daily sum" value="DAILY_SOLAR">
Mathias Bavay's avatar
Mathias Bavay committed
103
			<help>&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/classmio_1_1Daily__solar.html&quot;&gt;Distribute a daily sum of solar radiation&lt;/a&gt; over the whole day.</help>
104
105
106
107
108
		</option>
	</parametergroup>

	<parametergroup name="RESAMPLING_DAILY_AVG">
		<option caption="Sinusoidal Daily Average" value="DAILY_AVG">
Mathias Bavay's avatar
Mathias Bavay committed
109
			<parameter key="%::DAILY_AVG::RANGE" label="DAILY_AVG Range:" type="number" format="decimal" min="0" default="10.00" optional="false">
110
111
				<help>How much should the value change around the average?</help>
			</parameter>
112
			<parameter key="%::DAILY_AVG::PHASE" label="DAILY_AVG Phase:" type="number" format="decimal" min="0" default="0.25" optional="false" unit="days">
113
114
				<help>Where should the minimum value be, from the begining of the day (in days)?</help>
			</parameter>
Mathias Bavay's avatar
Mathias Bavay committed
115
			<help>&lt;a href=&quot;https://models.slf.ch/docserver/meteoio/html/classmio_1_1DailyAverage.html&quot;&gt;This&lt;/a&gt; considers that the single daily value is the daily average of a sinusoidal variation.</help>
116
117
118
119
		</option>
	</parametergroup>

</inishell_include>