Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flood_duration/FloodDurationCalculation.java @ 9376:f318359b81a2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
S-Info flood duration theme rename, and more infrastructure themes in the duration curve
author mschaefer
date Fri, 03 Aug 2018 17:02:38 +0200
parents 83ebeb620b5a
children 929d645691ae
rev   line source
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
2 * Software engineering by
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
5 *
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
9 */
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
10 package org.dive4elements.river.artifacts.sinfo.flood_duration;
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
11
9266
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
12 import java.util.List;
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
13
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
14 import org.apache.commons.lang.math.DoubleRange;
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
15 import org.dive4elements.artifacts.CallContext;
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9195
diff changeset
16 import org.dive4elements.river.artifacts.WINFOArtifact;
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
17 import org.dive4elements.river.artifacts.model.Calculation;
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
18 import org.dive4elements.river.artifacts.model.CalculationResult;
9266
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
19 import org.dive4elements.river.artifacts.model.WQDay;
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
20 import org.dive4elements.river.artifacts.resources.Resources;
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
21 import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
22 import org.dive4elements.river.artifacts.sinfo.common.RiverInfoProvider;
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
23 import org.dive4elements.river.artifacts.sinfo.flood_duration.RiversideRadioChoice.RiversideChoiceKey;
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9195
diff changeset
24 import org.dive4elements.river.artifacts.sinfo.tkhstate.WinfoArtifactWrapper;
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
25 import org.dive4elements.river.artifacts.sinfo.util.CalculationUtils;
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9195
diff changeset
26 import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
9266
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
27 import org.dive4elements.river.jfree.StickyAxisAnnotation;
9376
f318359b81a2 S-Info flood duration theme rename, and more infrastructure themes in the duration curve
mschaefer
parents: 9269
diff changeset
28 import org.dive4elements.river.model.Attribute.AttributeKey;
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
29 import org.dive4elements.river.model.River;
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
30
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
31 /**
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
32 * Calculation of the flood durations of the infrastructures of the km range of a river
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
33 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
34 * @author Matthias Schäfer
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
35 */
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
36 final class FloodDurationCalculation {
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
37
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
38 private final CallContext context;
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
39
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
40 public FloodDurationCalculation(final CallContext context) {
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
41 this.context = context;
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
42 }
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
43
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
44 public CalculationResult calculate(final SINFOArtifact sinfo) {
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
45
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
46 final String user = CalculationUtils.findArtifactUser(this.context, sinfo);
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
47
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
48 /* access input data */
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
49 final FloodDurationAccess access = new FloodDurationAccess(sinfo);
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
50 final River river = access.getRiver();
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9195
diff changeset
51 final RiverInfo riverInfo = new RiverInfo(river);
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
52 final DoubleRange calcRange = access.getRange();
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
53
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
54 final RiverInfoProvider infoProvider = RiverInfoProvider.forRange(this.context, river, calcRange);
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
55 final String calcModeLabel = Resources.getMsg(this.context.getMeta(), sinfo.getCalculationMode().name());
9236
b515ed950d39 S-Info flood durations with automatic km step width
mschaefer
parents: 9229
diff changeset
56 final String label = Resources.getMsg(this.context.getMeta(), access.getRiverside().getKey());
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
57
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
58 final Calculation problems = new Calculation();
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
59
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9195
diff changeset
60 // Calculate the selected main values, if any
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9195
diff changeset
61 /* misuse winfo-artifact to calculate waterlevels in the same way */
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9195
diff changeset
62 final WINFOArtifact winfo = new WinfoArtifactWrapper(sinfo);
9236
b515ed950d39 S-Info flood durations with automatic km step width
mschaefer
parents: 9229
diff changeset
63 winfo.addStringData("ld_mode", "distance");
b515ed950d39 S-Info flood durations with automatic km step width
mschaefer
parents: 9229
diff changeset
64 winfo.addStringData("ld_step", "100");
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9195
diff changeset
65
9215
0fc9c82e744e work on collison, flood_duration
gernotbelger
parents: 9205
diff changeset
66 final FloodDurationCalculationResults results = new FloodDurationCalculationResults(calcModeLabel, user, riverInfo, calcRange);
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9195
diff changeset
67
9252
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9236
diff changeset
68 calculateResult(label, calcRange, infoProvider, access.getRiverside(), problems, winfo, results);
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
69
9145
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9070
diff changeset
70 return new CalculationResult(results, problems);
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9070
diff changeset
71 }
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9070
diff changeset
72
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9070
diff changeset
73 /**
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
74 * Calculates the flood durations of the infrastructures of a km range of a river
9145
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9070
diff changeset
75 */
9252
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9236
diff changeset
76 private void calculateResult(final String label, final DoubleRange calcRange, final RiverInfoProvider riverInfoProvider,
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9236
diff changeset
77 final RiversideChoiceKey riverside, final Calculation problems, final WINFOArtifact winfo, final FloodDurationCalculationResults results) {
9145
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9070
diff changeset
78
9150
23945061daec gigantic refactoring: exporter, result, results
gernotbelger
parents: 9145
diff changeset
79 final FloodDurationCalculator calculator = new FloodDurationCalculator(this.context, riverInfoProvider);
9252
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9236
diff changeset
80 calculator.execute(problems, label, calcRange, riverside, winfo, results);
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
81 }
9266
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
82
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
83 /**
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
84 * Calculates the flood duration curve of a station
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
85 */
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
86 public WQDay calcStationCurve(final double station, final SINFOArtifact sinfo) {
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
87
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
88 /* access input data */
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
89 final FloodDurationAccess access = new FloodDurationAccess(sinfo);
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
90 final River river = access.getRiver();
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
91 final DoubleRange calcRange = access.getRange();
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
92 final RiverInfoProvider infoProvider = RiverInfoProvider.forRange(this.context, river, calcRange);
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
93
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
94 final Calculation problems = new Calculation();
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
95
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
96 // Calculate the selected main values, if any
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
97 /* misuse winfo-artifact to calculate waterlevels in the same way */
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
98 final WINFOArtifact winfo = new WinfoArtifactWrapper(sinfo);
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
99 winfo.addStringData("ld_locations", Double.toString(station));
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
100
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
101 final FloodDurationCalculator calculator = new FloodDurationCalculator(this.context, infoProvider);
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
102 if (!Double.isNaN(station))
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
103 return calculator.calcWQDays(problems, station, winfo);
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
104 else
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
105 return calculator.calcWQDays(problems, calcRange.getMinimumFloat(), winfo);
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
106 }
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
107
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
108 /**
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
109 * Calculates the annotations of the infrastructure(s) of a station for a flood duration calculation
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
110 */
9376
f318359b81a2 S-Info flood duration theme rename, and more infrastructure themes in the duration curve
mschaefer
parents: 9269
diff changeset
111 public List<StickyAxisAnnotation> calcInfrastructureAnnotations(final double station, final AttributeKey riverside, final boolean isW,
f318359b81a2 S-Info flood duration theme rename, and more infrastructure themes in the duration curve
mschaefer
parents: 9269
diff changeset
112 final FloodDurationCalculationResult result) {
9266
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
113
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
114 final Calculation problems = new Calculation();
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
115
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
116 final FloodDurationCalculator calculator = new FloodDurationCalculator(this.context, null);
9376
f318359b81a2 S-Info flood duration theme rename, and more infrastructure themes in the duration curve
mschaefer
parents: 9269
diff changeset
117 return calculator.calcInfrastructureAnnotations(problems, station, riverside, isW, result);
9266
465347d12990 Station specific calculation of flood duration curve and infrastructure annotations
mschaefer
parents: 9252
diff changeset
118 }
9269
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
119
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
120 /**
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
121 * Calculates the annotations of the W main values of a station
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
122 */
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
123 public List<StickyAxisAnnotation> calcMainValueWAnnotations(final double station, final FloodDurationCalculationResult result) {
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
124
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
125 final Calculation problems = new Calculation();
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
126
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
127 final FloodDurationCalculator calculator = new FloodDurationCalculator(this.context, null);
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
128 return calculator.calcMainValueWAnnotations(problems, station, result);
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
129 }
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
130
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
131 /**
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
132 * Calculates the annotations of the Q main values of a station
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
133 */
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
134 public List<StickyAxisAnnotation> calcMainValueQAnnotations(final double station, final FloodDurationCalculationResult result) {
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
135
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
136 final Calculation problems = new Calculation();
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
137
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
138 final FloodDurationCalculator calculator = new FloodDurationCalculator(this.context, null);
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
139 return calculator.calcMainValueQAnnotations(problems, station, result);
83ebeb620b5a Station specific main value annotations in S-Info flood duration curve, corrected infrastructure flood duration calculation
mschaefer
parents: 9266
diff changeset
140 }
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents:
diff changeset
141 }
http://dive4elements.wald.intevation.org