Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/common/GaugeDurationValuesFinder.java @ 9195:a4121ec450d6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
'ca.'-issue ExportContextCSV+PDF separated uinfo.inundationduration url export
author gernotbelger
date Fri, 29 Jun 2018 14:52:54 +0200
parents 1614cb14308f
children b4402594213b
rev   line source
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
2 * Software engineering by
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
5 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
9 */
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
10 package org.dive4elements.river.artifacts.sinfo.common;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
11
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
12 import org.apache.commons.lang.math.DoubleRange;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
13 import org.apache.commons.math.FunctionEvaluationException;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
14 import org.apache.commons.math.analysis.UnivariateRealFunction;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
15 import org.apache.commons.math.analysis.interpolation.LinearInterpolator;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
16 import org.dive4elements.river.artifacts.model.Calculation;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
17 import org.dive4elements.river.model.Gauge;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
18 import org.dive4elements.river.model.MainValue;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
19 import org.dive4elements.river.model.MainValueType.MainValueTypeKey;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
20
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
21 import gnu.trove.TDoubleArrayList;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
22
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
23 /**
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
24 * Loading and search/interpolate the duration main values of a gauge
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
25 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
26 * @author Matthias Schäfer
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
27 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
28 */
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
29 public final class GaugeDurationValuesFinder {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
30
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
31 /***** FIELDS *****/
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
32
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
33 // private static Logger log = Logger.getLogger(GaugeDurationValuesFinder.class);
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
34
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
35 private final Gauge gauge;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
36
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
37 private Calculation problems;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
38
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
39 private UnivariateRealFunction qInterpolator;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
40
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
41 private DoubleRange qRange;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
42
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
43 private UnivariateRealFunction durInterpolator;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
44
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
45 private DoubleRange durRange;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
46
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9176
diff changeset
47 private final String approxPrefix = "\u2248";// "ca.";
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
48
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
49 /***** CONSTRUCTORS *****/
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
50
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
51 private GaugeDurationValuesFinder(final Gauge gauge, final Calculation problems) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
52 this.gauge = gauge;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
53 this.problems = problems;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
54 final TDoubleArrayList qs = new TDoubleArrayList();
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
55 final TDoubleArrayList durs = new TDoubleArrayList();
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
56 for (final MainValue v : MainValue.getValuesOfGaugeAndType(gauge, MainValueTypeKey.DURATION)) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
57 qs.add(v.getValue().doubleValue());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
58 durs.add(Integer.valueOf(v.getMainValue().getName()).doubleValue());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
59 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
60 try {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
61 this.qInterpolator = new LinearInterpolator().interpolate(qs.toNativeArray(), durs.toNativeArray());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
62 this.qRange = new DoubleRange(qs.get(0), qs.get(qs.size() - 1));
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
63 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
64 catch (final Exception e) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
65 this.qInterpolator = null;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
66 this.qRange = null;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
67 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
68 qs.clear();
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
69 durs.clear();
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
70 for (final MainValue v : MainValue.getDurationDischargesOfGauge(gauge)) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
71 durs.add(Integer.valueOf(v.getMainValue().getName()).doubleValue());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
72 qs.add(v.getValue().doubleValue());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
73 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
74 try {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
75 this.durInterpolator = new LinearInterpolator().interpolate(durs.toNativeArray(), qs.toNativeArray());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
76 this.durRange = new DoubleRange(durs.get(0), durs.get(durs.size() - 1));
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
77 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
78 catch (final Exception e) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
79 this.durInterpolator = null;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
80 this.durRange = null;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
81 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
82 if (((this.qInterpolator == null) || (this.durInterpolator == null)) && (this.problems != null)) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
83 this.problems.addProblem("gauge_duration.missing", gauge.getName());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
84 // Report only once
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
85 this.problems = null;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
86 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
87 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
88
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
89 /***** METHODS *****/
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
90
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
91 /**
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
92 * Loads the the discharge-duration table of a gauge (GAUGE.glt)
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
93 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
94 * @return The main values finder of a a gauge, or null
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
95 */
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
96 public static GaugeDurationValuesFinder loadValues(final Gauge gauge, final Calculation problems) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
97 return new GaugeDurationValuesFinder(gauge, problems);
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
98 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
99
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
100 /**
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
101 * If this provider may return valid data at all.
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
102 */
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
103 public boolean isValid() {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
104 return (this.qInterpolator != null);
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
105 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
106
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
107 /**
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
108 * Discharge for a duration
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
109 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
110 * @return Q, or NegInf for duration less than all, or PosInf for duration greater then all, or NaN in case of exception
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
111 */
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
112 public double getDischarge(final int duration) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
113 try {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
114 if (this.durInterpolator == null)
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
115 return Double.NaN;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
116 else if (duration < this.durRange.getMinimumDouble())
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
117 return Double.NEGATIVE_INFINITY;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
118 else if (duration > this.durRange.getMaximumDouble())
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
119 return Double.POSITIVE_INFINITY;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
120 else
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
121 return this.durInterpolator.value(duration);
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
122 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
123 catch (@SuppressWarnings("unused") final FunctionEvaluationException e) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
124 // ignore exception because this can/will happen regularly
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
125 return Double.NaN;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
126 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
127 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
128
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
129 /**
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
130 * Duration for a discharge
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
131 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
132 * @return duration, or 0 for Q less than all, or 365 for duration greater then all, or -1 in case of exception
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
133 */
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
134 public double getDuration(final double q) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
135 try {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
136 if (this.qInterpolator == null)
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
137 return -1;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
138 else if (q < this.qRange.getMinimumDouble())
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
139 return 0;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
140 else if (q > this.qRange.getMaximumDouble())
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
141 return 365;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
142 else
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
143 return this.qInterpolator.value(q);
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
144 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
145 catch (@SuppressWarnings("unused") final FunctionEvaluationException e) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
146 // ignore exception because this can/will happen regularly
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
147 return -1;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
148 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
149 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
150 }
http://dive4elements.wald.intevation.org