Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/common/GaugeDischargeValuesFinder.java @ 9176:1614cb14308f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Work on calculations for S-Info flood duration workflow
author mschaefer
date Mon, 25 Jun 2018 19:21:11 +0200
parents
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.DischargeTable;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
18 import org.dive4elements.river.model.DischargeTableValue;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
19 import org.dive4elements.river.model.Gauge;
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/interpolation of a gauge's discharge table (.at)
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 GaugeDischargeValuesFinder {
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(GaugeDischargeValuesFinder.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 final UnivariateRealFunction wInterpolator;
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 final DoubleRange wRange;
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
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
44 /***** CONSTRUCTORS *****/
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
45
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
46 private GaugeDischargeValuesFinder(final Gauge gauge, final Calculation problems, final DischargeTable dischargeTable) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
47 this.gauge = gauge;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
48 this.problems = problems;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
49 final TDoubleArrayList ws = new TDoubleArrayList();
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
50 final TDoubleArrayList qs = new TDoubleArrayList();
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
51 for (final DischargeTableValue v : DischargeTable.getValuesSortedByW(dischargeTable)) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
52 ws.add(v.getW().doubleValue());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
53 qs.add(v.getQ().doubleValue());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
54 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
55 if (ws.size() >= 2) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
56 this.wInterpolator = new LinearInterpolator().interpolate(ws.toNativeArray(), qs.toNativeArray());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
57 this.wRange = new DoubleRange(ws.get(0), ws.get(ws.size() - 1));
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
58 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
59 else {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
60 this.wInterpolator = null;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
61 this.wRange = null;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
62 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
63 if ((this.wInterpolator == null) && (this.problems != null)) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
64 this.problems.addProblem("gauge_discharge_table.missing", gauge.getName());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
65 // Report only once
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
66 this.problems = 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 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
69
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
70
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
71 /***** METHODS *****/
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
72
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 * Loads the the main discharge table of a gauge (GAUGE.at)
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
75 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
76 * @return The discharge table values finder of the gauge, or null
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 public static GaugeDischargeValuesFinder loadValues(final Gauge gauge, final Calculation problems) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
79 final DischargeTable table = DischargeTable.getGaugeMainDischargeTable(gauge);
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
80 if ((table == null) || (table.getDischargeTableValues().size() == 0)) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
81 problems.addProblem("gauge_discharge_table.missing", gauge.getName());
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
82 return null;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
83 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
84 else
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
85 return new GaugeDischargeValuesFinder(gauge, problems, table);
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 * If this provider may return valid data at all.
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 public boolean isValid() {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
92 return (this.wInterpolator != null);
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
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 * Discharge for a W
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
97 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
98 * @param w
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
99 * W in cm above gauge datum
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
100 * @return Q, or NegInf for w less than all, or PosInf for w greater then all, or NaN in case of exception
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
101 */
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
102 public double getDischarge(final double w) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
103 try {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
104 if (this.wInterpolator == null)
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
105 return Double.NaN;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
106 else if (w < this.wRange.getMinimumDouble())
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
107 return Double.NEGATIVE_INFINITY;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
108 else if (w > this.wRange.getMaximumDouble())
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
109 return Double.POSITIVE_INFINITY;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
110 else
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
111 return this.wInterpolator.value(w);
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
112 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
113 catch (@SuppressWarnings("unused") final FunctionEvaluationException e) {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
114 // ignore exception because this can/will happen regularly
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 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
117 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
118 }
http://dive4elements.wald.intevation.org