gernotbelger@8854: /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8884:  * Software engineering by
gernotbelger@8884:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8854:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8854:  *
gernotbelger@8854:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8854:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8854:  * documentation coming with Dive4Elements River for details.
gernotbelger@8854:  */
gernotbelger@8854: 
gernotbelger@8854: package org.dive4elements.river.artifacts.sinfo.flowdepth;
gernotbelger@8854: 
gernotbelger@8884: import java.util.HashSet;
gernotbelger@8886: import java.util.Map;
gernotbelger@8884: import java.util.Set;
gernotbelger@8854: 
gernotbelger@8886: import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
gernotbelger@8890: import org.dive4elements.artifacts.Artifact;
gernotbelger@8886: import org.dive4elements.artifacts.CallContext;
gernotbelger@8890: import org.dive4elements.river.artifacts.D4EArtifact;
gernotbelger@8890: import org.dive4elements.river.artifacts.access.RiverAccess;
gernotbelger@8890: import org.dive4elements.river.artifacts.context.RiverContext;
gernotbelger@8890: import org.dive4elements.river.artifacts.math.MovingAverage;
gernotbelger@8890: import org.dive4elements.river.artifacts.model.ZoomScale;
gernotbelger@8916: import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoProcessor;
gernotbelger@8886: import org.dive4elements.river.exports.DiagramGenerator;
gernotbelger@8886: import org.dive4elements.river.exports.StyledSeriesBuilder;
gernotbelger@8886: import org.dive4elements.river.jfree.StyledXYSeries;
gernotbelger@8886: import org.dive4elements.river.themes.ThemeDocument;
gernotbelger@8886: 
gernotbelger@8884: public final class FlowDepthProcessor extends AbstractSInfoProcessor {
gernotbelger@8854: 
gernotbelger@8884:     /* Theme name, usually defined in 'FacetTypes', but that is soooo bad dependencies... */
gernotbelger@8884:     // REMARK: these mustend with 'filtered' so extra handling happens in chart: point are always recalculated, because data
gernotbelger@8884:     // changes depending on zoom state
gernotbelger@8854:     static String FACET_FLOW_DEPTH_FILTERED = "sinfo_flow_depth.filtered";
gernotbelger@8854: 
gernotbelger@8884:     static String FACET_FLOW_DEPTH_TKH_FILTERED = "sinfo_flow_depth.tkh.filtered";
gernotbelger@8884: 
gernotbelger@8884:     private static final Set<String> HANDLED_FACET_TYPES = new HashSet<>();
gernotbelger@8884: 
gernotbelger@8884:     static {
gernotbelger@8884:         HANDLED_FACET_TYPES.add(FACET_FLOW_DEPTH_FILTERED);
gernotbelger@8884:         HANDLED_FACET_TYPES.add(FACET_FLOW_DEPTH_TKH_FILTERED);
gernotbelger@8884:     }
gernotbelger@8854: 
gernotbelger@8854:     private static final String I18N_AXIS_LABEL = "sinfo.chart.flow_depth.section.yaxis.label";
gernotbelger@8854: 
gernotbelger@8884:     public FlowDepthProcessor() {
gernotbelger@8884:         super(I18N_AXIS_LABEL, HANDLED_FACET_TYPES);
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8886:     @Override
gernotbelger@8886:     protected final String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
gernotbelger@8886: 
gernotbelger@8886:         final CallContext context = generator.getCallContext();
gernotbelger@8886:         final Map<String, String> metaData = bundle.getFacet().getMetaData();
gernotbelger@8886: 
gernotbelger@8890:         final Artifact artifact = bundle.getArtifact();
gernotbelger@8890: 
gernotbelger@8886:         final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme);
gernotbelger@8890:         series.putMetaData(metaData, artifact, context);
gernotbelger@8886: 
gernotbelger@8886:         final String facetName = bundle.getFacetName();
gernotbelger@8886:         final FlowDepthCalculationResult data = (FlowDepthCalculationResult) bundle.getData(context);
gernotbelger@8886:         if (data == null) {
gernotbelger@8886:             // Check has been here before so we keep it for security reasons
gernotbelger@8886:             // this should never happen though.
gernotbelger@8886:             throw new IllegalStateException("Data is null for facet: " + facetName);
gernotbelger@8886:         }
gernotbelger@8886: 
gernotbelger@8890:         final Double radius = findRadius(context, artifact);
gernotbelger@8890: 
gernotbelger@8890:         final double[][] points = generatePoints(radius, data, facetName);
gernotbelger@8886: 
gernotbelger@8886:         StyledSeriesBuilder.addPoints(series, points, true);
gernotbelger@8886:         generator.addAxisSeries(series, getAxisName(), visible);
gernotbelger@8886: 
gernotbelger@8886:         return metaData.get("Y");
gernotbelger@8886:     }
gernotbelger@8886: 
gernotbelger@8890:     private Double findRadius(final CallContext context, final Artifact artifact) {
gernotbelger@8890:         final Double start = (Double) context.getContextValue("startkm");
gernotbelger@8890:         final Double end = (Double) context.getContextValue("endkm");
gernotbelger@8890: 
gernotbelger@8890:         if (start == null || end == null)
gernotbelger@8890:             return null;
gernotbelger@8890: 
gernotbelger@8890:         final RiverContext fc = (RiverContext) context.globalContext();
gernotbelger@8890:         final ZoomScale scales = (ZoomScale) fc.get("zoomscale");
gernotbelger@8890:         final RiverAccess access = new RiverAccess((D4EArtifact) artifact);
gernotbelger@8890:         final String river = access.getRiverName();
gernotbelger@8890: 
gernotbelger@8890:         return scales.getRadius(river, start, end);
gernotbelger@8890:     }
gernotbelger@8890: 
gernotbelger@8890:     private double[][] generatePoints(final Double radius, final FlowDepthCalculationResult data, final String facetName) {
gernotbelger@8854: 
gernotbelger@8884:         if (FACET_FLOW_DEPTH_FILTERED.contentEquals(facetName))
gernotbelger@8890:             return movingAverage(radius, data.getFlowDepthPoints());
gernotbelger@8854: 
gernotbelger@8884:         if (FACET_FLOW_DEPTH_TKH_FILTERED.contentEquals(facetName))
gernotbelger@8890:             return movingAverage(radius, data.getFlowDepthTkhPoints());
gernotbelger@8854: 
gernotbelger@8886:         final String error = String.format("Unknown facet name: %s", facetName);
gernotbelger@8886:         throw new UnsupportedOperationException(error);
gernotbelger@8854:     }
gernotbelger@8890: 
gernotbelger@8890:     private double[][] movingAverage(final Double radius, final double[][] points) {
gernotbelger@8890: 
gernotbelger@8890:         if (radius == null)
gernotbelger@8890:             return points;
gernotbelger@8890: 
gernotbelger@8890:         return MovingAverage.weighted(points, radius);
gernotbelger@8890:     }
gernotbelger@8854: }