Mercurial > dive4elements > river
annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flowdepthminmax/FlowDepthMinMaxCalculation.java @ 8964:45f1ad66560e
Code cleanup concerning calculations: improved error handling; improved interpolation; bed heights are now always used for spatial discretisation
author | gernotbelger |
---|---|
date | Thu, 29 Mar 2018 15:48:17 +0200 |
parents | 322b0e6298ea |
children | b5600453bb8f |
rev | line source |
---|---|
8946 | 1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde |
2 * Software engineering by | |
3 * Björnsen Beratende Ingenieure GmbH | |
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt | |
5 * | |
6 * This file is Free Software under the GNU AGPL (>=v3) | |
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the | |
8 * documentation coming with Dive4Elements River for details. | |
9 */ | |
10 package org.dive4elements.river.artifacts.sinfo.flowdepthminmax; | |
11 | |
12 import java.util.ArrayList; | |
13 import java.util.Collection; | |
14 | |
15 import org.apache.commons.lang.math.DoubleRange; | |
16 import org.dive4elements.artifacts.CallContext; | |
17 import org.dive4elements.river.artifacts.model.Calculation; | |
18 import org.dive4elements.river.artifacts.model.CalculationResult; | |
19 import org.dive4elements.river.artifacts.model.WKms; | |
20 import org.dive4elements.river.artifacts.resources.Resources; | |
21 import org.dive4elements.river.artifacts.sinfo.SINFOArtifact; | |
22 import org.dive4elements.river.artifacts.sinfo.common.RiverInfoProvider; | |
8948 | 23 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultRow; |
24 import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType; | |
8946 | 25 import org.dive4elements.river.artifacts.sinfo.flowdepth.FlowDepthUtils; |
26 import org.dive4elements.river.artifacts.sinfo.flowdepthminmax.FlowDepthMinMaxAccess.MinMaxIdPair; | |
27 import org.dive4elements.river.artifacts.sinfo.tkhcalculation.DischargeValuesFinder; | |
28 import org.dive4elements.river.artifacts.sinfo.tkhcalculation.WaterlevelValuesFinder; | |
29 import org.dive4elements.river.artifacts.sinfo.tkhstate.BedHeightsFinder; | |
30 import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo; | |
31 import org.dive4elements.river.artifacts.sinfo.util.CalculationUtils; | |
32 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo; | |
33 import org.dive4elements.river.artifacts.sinfo.util.WstInfo; | |
34 import org.dive4elements.river.artifacts.states.WaterlevelData; | |
35 import org.dive4elements.river.artifacts.states.WaterlevelFetcher; | |
36 import org.dive4elements.river.model.River; | |
37 | |
38 /** | |
39 * @author Gernot Belger | |
40 */ | |
41 final class FlowDepthMinMaxCalculation { | |
42 | |
43 private final CallContext context; | |
44 | |
45 public FlowDepthMinMaxCalculation(final CallContext context) { | |
46 this.context = context; | |
47 } | |
48 | |
49 public CalculationResult calculate(final SINFOArtifact sinfo) { | |
50 | |
51 final String user = CalculationUtils.findArtifactUser(this.context, sinfo); | |
52 | |
53 /* access input data */ | |
54 final FlowDepthMinMaxAccess access = new FlowDepthMinMaxAccess(sinfo); | |
55 final River river = access.getRiver(); | |
56 final RiverInfo riverInfo = new RiverInfo(river); | |
57 | |
58 final Collection<MinMaxIdPair> minMaxPairs = access.getMinMaxPairs(); | |
59 | |
60 final DoubleRange calcRange = access.getRange(); | |
61 | |
62 /* calculate results for each diff pair */ | |
63 final Calculation problems = new Calculation(); | |
64 | |
65 final RiverInfoProvider infoProvider = RiverInfoProvider.forRange(this.context, river, calcRange); | |
66 | |
67 final String calcModeLabel = Resources.getMsg(this.context.getMeta(), sinfo.getCalculationMode().name()); | |
68 | |
69 final FlowDepthMinMaxCalculationResults results = new FlowDepthMinMaxCalculationResults(calcModeLabel, user, riverInfo, calcRange); | |
70 | |
71 for (final MinMaxIdPair minMaxPair : minMaxPairs) { | |
72 final FlowDepthMinMaxCalculationResult result = calculateResult(calcRange, minMaxPair, problems, infoProvider); | |
73 if (result != null) | |
74 results.addResult(result); | |
75 } | |
76 | |
77 return new CalculationResult(results, problems); | |
78 } | |
79 | |
80 /** | |
81 * Calculates one W-MSH differences pair. | |
82 * | |
83 * @param infoProvider | |
84 */ | |
85 private FlowDepthMinMaxCalculationResult calculateResult(final DoubleRange calcRange, final MinMaxIdPair minMaxPair, final Calculation problems, | |
86 final RiverInfoProvider infoProvider) { | |
87 | |
88 /* access real input data from database */ | |
89 final String wstId = minMaxPair.getWstId(); | |
8964
45f1ad66560e
Code cleanup concerning calculations: improved error handling; improved interpolation; bed heights are now always used for spatial discretisation
gernotbelger
parents:
8951
diff
changeset
|
90 |
45f1ad66560e
Code cleanup concerning calculations: improved error handling; improved interpolation; bed heights are now always used for spatial discretisation
gernotbelger
parents:
8951
diff
changeset
|
91 // FIXME: bfg überzeugen dass man immer nur pärchen auswählen kann --> min/max id ist gleich! |
45f1ad66560e
Code cleanup concerning calculations: improved error handling; improved interpolation; bed heights are now always used for spatial discretisation
gernotbelger
parents:
8951
diff
changeset
|
92 |
8946 | 93 final String minSoundingId = minMaxPair.getMinSoundingId(); |
8948 | 94 final String maxSoundingId = minMaxPair.getMaxSoundingId(); |
8946 | 95 |
96 final BedHeightsFinder minBedHeight = minSoundingId == null ? null : BedHeightsFinder.forId(this.context, minSoundingId, calcRange, problems); | |
97 final BedHeightsFinder maxBedHeight = maxSoundingId == null ? null : BedHeightsFinder.forId(this.context, maxSoundingId, calcRange, problems); | |
98 if (minBedHeight == null && maxBedHeight == null) | |
99 return null; | |
100 | |
101 /* REMARK: fetch ALL wst kms, because we want to determine the original reference gauge */ | |
8964
45f1ad66560e
Code cleanup concerning calculations: improved error handling; improved interpolation; bed heights are now always used for spatial discretisation
gernotbelger
parents:
8951
diff
changeset
|
102 final WaterlevelData waterlevel = new WaterlevelFetcher().findWaterlevel(this.context, wstId, calcRange, problems); |
8946 | 103 if (waterlevel == null) |
104 return null; | |
105 | |
106 final String label = createLabel(waterlevel, minBedHeight, maxBedHeight); | |
107 | |
108 final WKms wstKms = waterlevel.getWkms(); | |
109 | |
110 final int soundingYear = checkSoundingYear(minBedHeight, maxBedHeight, problems); | |
8951 | 111 FlowDepthUtils.checkYearDifference(label, waterlevel.getYear(), soundingYear, problems); |
8946 | 112 |
113 /* re-determine the reference gauge, in the same way as the WaterlevelArtifact would do it */ | |
114 final RiverInfoProvider riverInfoProvider = infoProvider.forWaterlevel(waterlevel); | |
115 | |
116 final int wspYear = waterlevel.getYear(); | |
117 final WstInfo wstInfo = new WstInfo(waterlevel.getName(), wspYear, riverInfoProvider.getReferenceGauge()); | |
118 | |
8964
45f1ad66560e
Code cleanup concerning calculations: improved error handling; improved interpolation; bed heights are now always used for spatial discretisation
gernotbelger
parents:
8951
diff
changeset
|
119 final WaterlevelValuesFinder waterlevelProvider = WaterlevelValuesFinder.fromKms(problems, wstKms); |
8946 | 120 final DischargeValuesFinder dischargeProvider = DischargeValuesFinder.fromKms(wstKms); |
121 | |
122 final String waterlevelLabel = waterlevel.getName(); | |
123 final String soundingLabel = buildSoundingLabel(minBedHeight, maxBedHeight); | |
124 | |
125 /* real calculation loop */ | |
8948 | 126 final Collection<SInfoResultRow> rows = new ArrayList<>(); |
8946 | 127 |
8964
45f1ad66560e
Code cleanup concerning calculations: improved error handling; improved interpolation; bed heights are now always used for spatial discretisation
gernotbelger
parents:
8951
diff
changeset
|
128 // FIXME: we use the stations of one of the bed heights atm, because we probably will later use only data from one bed heights datasets! |
45f1ad66560e
Code cleanup concerning calculations: improved error handling; improved interpolation; bed heights are now always used for spatial discretisation
gernotbelger
parents:
8951
diff
changeset
|
129 final Collection<Double> stations = minBedHeight == null ? maxBedHeight.getStations() : minBedHeight.getStations(); |
45f1ad66560e
Code cleanup concerning calculations: improved error handling; improved interpolation; bed heights are now always used for spatial discretisation
gernotbelger
parents:
8951
diff
changeset
|
130 for (final double station : stations) { |
8946 | 131 if (calcRange.containsDouble(station)) { |
132 | |
133 final double wst = waterlevelProvider.getWaterlevel(station); | |
134 final double discharge = dischargeProvider.getDischarge(station); | |
135 | |
136 final double minBedHeightValue = minBedHeight == null ? Double.NaN : minBedHeight.getMeanBedHeight(station); | |
137 final double maxBedHeightValue = maxBedHeight == null ? Double.NaN : maxBedHeight.getMeanBedHeight(station); | |
138 | |
139 final double minFlowDepth = wst - minBedHeightValue; | |
140 final double maxFlowDepth = wst - maxBedHeightValue; | |
141 | |
142 // FIXME: unclear what is meant here... | |
8964
45f1ad66560e
Code cleanup concerning calculations: improved error handling; improved interpolation; bed heights are now always used for spatial discretisation
gernotbelger
parents:
8951
diff
changeset
|
143 // FIXME: this will simply the bed height of 'the' bed height if we reduce this to simply using one sounding dataset |
8946 | 144 final double meanBedHeight = Double.NaN; |
145 | |
146 // REMARK: access the location once only during calculation | |
147 final String location = riverInfoProvider.getLocation(station); | |
148 | |
149 // REMARK: access the gauge once only during calculation | |
150 final String gaugeLabel = riverInfoProvider.findGauge(station); | |
151 | |
8948 | 152 final SInfoResultRow row = SInfoResultRow.create().// |
153 putValue(SInfoResultType.station, station). // | |
154 putValue(SInfoResultType.flowdepthmin, minFlowDepth). // | |
155 putValue(SInfoResultType.flowdepthmax, maxFlowDepth). // | |
156 putValue(SInfoResultType.waterlevel, wst). // | |
157 putValue(SInfoResultType.discharge, discharge). // | |
158 putValue(SInfoResultType.waterlevelLabel, waterlevelLabel). // | |
159 putValue(SInfoResultType.gaugeLabel, gaugeLabel). // | |
160 putValue(SInfoResultType.meanBedHeight, meanBedHeight). // | |
161 putValue(SInfoResultType.soundingLabel, soundingLabel). // | |
162 putValue(SInfoResultType.location, location); | |
163 rows.add(row); | |
8946 | 164 } |
165 } | |
166 | |
167 final BedHeightInfo minBedHeightInfo = minBedHeight == null ? null : minBedHeight.getInfo(); | |
168 final BedHeightInfo maxBedHeightInfo = maxBedHeight == null ? null : maxBedHeight.getInfo(); | |
8948 | 169 |
8946 | 170 return new FlowDepthMinMaxCalculationResult(label, wstInfo, minBedHeightInfo, maxBedHeightInfo, rows); |
171 } | |
172 | |
173 private String buildSoundingLabel(final BedHeightsFinder minBedHeight, final BedHeightsFinder maxBedHeight) { | |
174 | |
175 if (minBedHeight == null) | |
176 return maxBedHeight.getInfo().getDescription(); | |
177 | |
178 if (maxBedHeight == null) | |
179 return minBedHeight.getInfo().getDescription(); | |
180 | |
181 return String.format("%s / %s", minBedHeight.getInfo().getDescription(), maxBedHeight.getInfo().getDescription()); | |
182 } | |
183 | |
184 private String createLabel(final WaterlevelData waterlevel, final BedHeightsFinder minBedHeight, final BedHeightsFinder maxBedHeight) { | |
185 | |
186 final StringBuilder buffer = new StringBuilder(waterlevel.getName()); | |
187 | |
188 if (minBedHeight != null) | |
189 buffer.append(" - "). // | |
190 append(minBedHeight.getInfo().getDescription()); | |
191 | |
192 if (maxBedHeight != null) | |
193 buffer.append(" - "). // | |
194 append(maxBedHeight.getInfo().getDescription()); | |
195 | |
196 return buffer.toString(); | |
197 } | |
198 | |
199 private int checkSoundingYear(final BedHeightsFinder minBedHeight, final BedHeightsFinder maxBedHeight, final Calculation problems) { | |
200 | |
201 if (maxBedHeight == null) | |
202 return minBedHeight.getInfo().getYear(); | |
203 | |
204 if (minBedHeight == null) | |
205 return maxBedHeight.getInfo().getYear(); | |
206 | |
207 final int minYear = minBedHeight.getInfo().getYear(); | |
208 final int maxYear = minBedHeight.getInfo().getYear(); | |
209 | |
210 if (minYear != maxYear) | |
211 problems.addProblem("sinfo.flowdepthminmaxcalculation.soundingyear.different"); | |
212 | |
213 return minYear; | |
214 } | |
215 } |