Mercurial > dive4elements > river
annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/collision/GaugeDischargeZoneFinder.java @ 9202:b4402594213b
More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
author | mschaefer |
---|---|
date | Mon, 02 Jul 2018 07:33:53 +0200 |
parents | a4121ec450d6 |
children |
rev | line source |
---|---|
9157
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
2 * Software engineering by |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
3 * Björnsen Beratende Ingenieure GmbH |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
5 * |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
6 * This file is Free Software under the GNU AGPL (>=v3) |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
8 * documentation coming with Dive4Elements River for details. |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
9 */ |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
10 package org.dive4elements.river.artifacts.sinfo.collision; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
11 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
12 import java.util.Map.Entry; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
13 import java.util.NavigableMap; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
14 import java.util.TreeMap; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
15 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
16 import org.dive4elements.river.artifacts.model.Calculation; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
17 import org.dive4elements.river.model.Gauge; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
18 import org.dive4elements.river.model.MainValue; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
19 import org.dive4elements.river.model.MainValueType.MainValueTypeKey; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
20 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
21 /** |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
22 * Loading and search the discharge zones of a gauge |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
23 * |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
24 * @author Matthias Schäfer |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
25 * |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
26 */ |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
27 public final class GaugeDischargeZoneFinder { |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
28 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
29 /***** FIELDS *****/ |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
30 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
31 // private static Logger log = Logger.getLogger(GaugeDischargeZoneFinder.class); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
32 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
33 private final Gauge gauge; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
34 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
35 private final Calculation problems; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
36 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
37 private final NavigableMap<Double, MainValue> qZones; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
38 |
9195 | 39 private final String approxPrefix = "\u2248";// "ca."; |
9157
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
40 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
41 /***** CONSTRUCTORS *****/ |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
42 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
43 private GaugeDischargeZoneFinder(final Gauge gauge, final Calculation problems) { |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
44 this.gauge = gauge; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
45 this.problems = problems; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
46 this.qZones = new TreeMap<>(); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
47 for (final MainValue mainValue : MainValue.getValuesOfGaugeAndType(gauge, MainValueTypeKey.Q)) |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
48 this.qZones.put(Double.valueOf(mainValue.getValue().doubleValue()), mainValue); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
49 } |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
50 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
51 /***** METHODS *****/ |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
52 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
53 /** |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
54 * Loads the the main discharge table of a gauge (GAUGE.at) |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
55 * |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
56 * @return The discharge table values finder of the gauge, or null |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
57 */ |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
58 public static GaugeDischargeZoneFinder loadValues(final Gauge gauge, final Calculation problems) { |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
59 return new GaugeDischargeZoneFinder(gauge, problems); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
60 } |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
61 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
62 /** |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
63 * If this provider may return valid data at all. |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
64 */ |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
65 public boolean isValid() { |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
66 return (this.qZones != null); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
67 } |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
68 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
69 /** |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
70 * Discharge zone for a Q. |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
71 */ |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
72 public String getDischargeZone(final double q) { |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
73 if (Double.isNaN(q)) |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
74 return ""; |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
75 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
76 // Exact match |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
77 if (this.qZones.containsKey(Double.valueOf(q))) |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
78 return this.qZones.get(Double.valueOf(q)).getMainValue().getName(); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
79 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
80 // Clearly below or just (max. 10%) below lowest named discharge |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
81 final Entry<Double, MainValue> lowerZone = this.qZones.floorEntry(Double.valueOf(q)); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
82 if (lowerZone == null) { |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
83 if (q >= this.qZones.firstKey().doubleValue() * 0.9) |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
84 return this.approxPrefix + this.qZones.firstEntry().getValue().getMainValue().getName(); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
85 else |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
86 return "<" + this.qZones.firstEntry().getValue().getMainValue().getName(); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
87 } |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
88 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
89 // Clearly above or just (max. 10%) above highest named discharge |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
90 final Entry<Double, MainValue> higherZone = this.qZones.ceilingEntry(Double.valueOf(q)); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
91 if (higherZone == null) { |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
92 if (q <= this.qZones.lastKey().doubleValue() * 1.1) |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
93 return this.approxPrefix + this.qZones.lastEntry().getValue().getMainValue().getName(); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
94 else |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
95 return ">" + this.qZones.lastEntry().getValue().getMainValue().getName(); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
96 } |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
97 |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
98 // Near (10%) one of the borders of a zone interval, or clearly within a zone |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
99 if (q <= lowerZone.getKey().doubleValue() * 1.1) |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
100 return this.approxPrefix + lowerZone.getValue().getMainValue().getName(); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
101 else if (q >= higherZone.getKey().doubleValue() * 0.9) |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
102 return this.approxPrefix + higherZone.getValue().getMainValue().getName(); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
103 else |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
104 return lowerZone.getValue().getMainValue().getName() + "-" + higherZone.getValue().getMainValue().getName(); |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
105 } |
f9bb5d0a6ff3
Added the S-Info collision calculation and chart output
mschaefer
parents:
diff
changeset
|
106 } |