Application: gvSIG desktop » gvSIG legends: base legends

package org.gvsig.legend.heatmap.lib.impl;

import java.awt.Color;

import java.awt.Graphics2D;

import java.awt.Image;

import java.awt.image.BufferedImage;

import java.util.Map;

import org.apache.commons.lang3.StringUtils;

import org.cresques.cts.ICoordTrans;

import org.gvsig.compat.print.PrintAttributes;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.fmap.dal.feature.FeatureQuery;

import org.gvsig.fmap.dal.feature.FeatureSelection;

import org.gvsig.fmap.dal.feature.FeatureSet;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.dal.feature.FeatureType;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.GeometryUtils;

import org.gvsig.fmap.geom.primitive.Point;

import org.gvsig.fmap.mapcontext.MapContextException;

import org.gvsig.fmap.mapcontext.ViewPort;

import org.gvsig.fmap.mapcontext.layers.operations.IHasImageLegend;

import org.gvsig.fmap.mapcontext.rendering.legend.LegendException;

import org.gvsig.fmap.mapcontext.rendering.legend.events.SymbolLegendEvent;

import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol;

import org.gvsig.gui.ColorTablePainter;

import org.gvsig.gui.DefaultColorTablePainter;

import org.gvsig.legend.heatmap.lib.api.HeatmapLegend;

import org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend;

import org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.DefaultFeatureDrawnNotification;

import org.gvsig.symbology.fmap.mapcontext.rendering.symbol.text.impl.SimpleTextSymbol;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.exception.PersistenceException;

import org.gvsig.tools.swing.api.ToolsSwingLocator;

import org.gvsig.tools.swing.api.ToolsSwingManager;

import org.gvsig.tools.task.Cancellable;

import org.gvsig.tools.visitor.VisitCanceledException;

import org.gvsig.tools.visitor.Visitor;

public class DefaultHeatmapLegend extends AbstractVectorialLegend implements HeatmapLegend, IHasImageLegend {

    private class DensityAlgorithm {

        private double[][] grid;

        private double[][] kernel;

        private int distance;

        private int height;

        private int with;

        private double maxValue;

        private double minValue;

        public DensityAlgorithm(int distance) {

            this.setDistance(distance);

        }

        public void setDistance(int distance) {

            if( this.distance == distance ) {

                return;

            }

            this.distance = distance;

            this.kernel = new double[2 * this.distance + 1][2 * this.distance + 1];

            for( int y = -this.distance; y < this.distance + 1; y++ ) {

                for( int x = -this.distance; x < this.distance + 1; x++ ) {

                    final double dDist = Math.sqrt(x * x + y * y);

                    if( dDist < this.distance ) {

                        this.kernel[x + this.distance][y + this.distance] = Math.pow(1 - (dDist * dDist) / (this.distance * this.distance), 2);

                    } else {

                        this.kernel[x + this.distance][y + this.distance] = 0;

                    }

                }

            }

        }

        public int getDistance() {

            return this.distance;

        }

        public void init(int with, int height) {

            this.with = with;

            this.height = height;

            this.grid = new double[with][height];

            this.maxValue = 0;

            this.minValue = 0;

        }

        public void add(int px, int py) {

            add(px, py, 1);

        }

        public void add(int px, int py, double value) {

            for( int y = -this.distance; y < this.distance + 1; y++ ) {

                for( int x = -this.distance; x < this.distance + 1; x++ ) {

                    if( this.kernel[x + this.distance][y + this.distance] != 0 ) {

                        addValue(px + x, py + y, value * this.kernel[x + this.distance][y + this.distance]);

                    }

                }

            }

        }

        private void addValue(int px, int py, double value) {

            if( px < 0 || py < 0 || px >= with || py >= height ) {

                return;

            }

            value += this.grid[px][py];

            this.grid[px][py] = value;

            if( value > this.maxValue ) {

                this.maxValue = value;

            }

            if( value < this.minValue ) {

                this.minValue = value;

            }

        }

        public void drawWithOpaqueColors(BufferedImage img, Graphics2D g, Color[] colorTable, Cancellable cancel, Geometry roi) {

            try {

                ToolsSwingManager toolsSwingManager = ToolsSwingLocator.getToolsSwingManager();

                Color c;

                int maxIndexColor = colorTable.length-1;

                for( int x = 0; x < with; x++ ) {

                    for( int y = 0; y < height; y++ ) {

                        if( cancel.isCanceled() ) {

                            return;

                        }

                        if (roi!=null) {

                            Point point = GeometryUtils.createPoint(x, y);

                            if (!roi.intersects(point)) {

                                continue;

                            }

                        }

                        double value = this.grid[x][y];

                        if( value > 0 ) {

                            int icolor = (int) (value * maxIndexColor / maxValue);

                            c = toolsSwingManager.alphaBlendingWithOpaqueBackground(

                                    new Color(img.getRGB(x, y)),

                                    colorTable[icolor]

                            );

                            img.setRGB(x, y, c.getRGB());

                        }

                    }

                }

            } catch (Exception ex) {

                LOG.warn("Problems drawing heatmap", ex);

            }

        }

        public void drawWithAlphaColors(BufferedImage img, Graphics2D g, Color[] colorTable, Cancellable cancel, Geometry roi) {

            try {

                Color c;

                int maxIndexColor = colorTable.length-1;

                for( int x = 0; x < with; x++ ) {

                    for( int y = 0; y < height; y++ ) {

                        if( cancel.isCanceled() ) {

                            return;

                        }

                        if (roi!=null) {

                            Point point = GeometryUtils.createPoint(x, y);

                            if (!roi.intersects(point)) {

                                continue;

                            }

                        }

                        double value = this.grid[x][y];

                        if( value > 0 ) {

                            int icolor = (int) (value * maxIndexColor / maxValue);

                            c = colorTable[icolor];

                            img.setRGB(x, y, c.getRGB());

                        }

                    }

                }

            } catch (Exception ex) {

                LOG.warn("Problems drawing heatmap", ex);

            }

        }

    }

    private ISymbol defaultSymbol;

    private DensityAlgorithm algorithm;

    private boolean isRamp;

    private Color[] sourceColorTable;

    private int colorTableHotColorAlpha;

    private int colorTableColdColorAlpha;

    private boolean useAlphaInColorTable;

    private String fieldName;

    private Image imageLegend;

    private HeatmapColorTable hmColorTable;

    private Color rampColdColor;

    private Color rampHotColor;

    private int rampNumColors;

    private Geometry roi;

    public DefaultHeatmapLegend() {

        this.defaultSymbol = new SimpleTextSymbol();

        this.algorithm = new DensityAlgorithm(30);

        this.colorTableHotColorAlpha = 255;

        this.colorTableColdColorAlpha = 0;

        this.useAlphaInColorTable = false;

        this.setColorTable(100, new Color(0, 0, 255, 0), new Color(255, 0, 0, 255));

        this.imageLegend = null;

        this.hmColorTable = null;

        this.fieldName = null;

    }

    @Override

    protected String[] getRequiredFeatureAttributeNames(FeatureStore featureStore) throws DataException {

        FeatureType ftype = featureStore.getDefaultFeatureType();

        if( StringUtils.isEmpty(this.fieldName) ) {

            return new String[]{

                ftype.getDefaultGeometryAttributeName()

            };

        }

        return new String[]{

            ftype.getDefaultGeometryAttributeName(),

            this.fieldName

        };

    }

    @Override

    public ISymbol getDefaultSymbol() {

        return this.defaultSymbol;

    }

    @Override

    public void setDefaultSymbol(ISymbol is) {

    }

    @Override

    public ISymbol getSymbolByFeature(Feature ftr) throws MapContextException {

        return this.defaultSymbol;

    }

    @Override

    public int getShapeType() {

        return Geometry.TYPES.GEOMETRY;

    }

    @Override

    public void setShapeType(int i) {

    }

    @Override

    public boolean isUseDefaultSymbol() {

        return true;

    }

    @Override

    public void useDefaultSymbol(boolean bln) {

    }

    @Override

    public boolean isSuitableForShapeType(int shapeType) {

        return true;

    }

    @Override

    protected void draw(BufferedImage image, Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore, FeatureQuery featureQuery, double dpi) throws LegendException {

        int saved_distance = this.algorithm.getDistance();

        try {

            int distance = (int) (this.algorithm.getDistance() * (dpi / 72));

            Geometry theROI = null;

            if (this.roi!=null) {

                theROI = this.roi.cloneGeometry();

                theROI.transform(viewPort.getAffineTransform());

            }

            this.algorithm.setDistance(distance);

            this.algorithm.init(image.getWidth(), image.getHeight());

            super.draw(image, g, viewPort, cancel, scale, queryParameters, coordTrans, featureStore, featureQuery, dpi);

            if( !cancel.isCanceled() ) {

                this.algorithm.drawWithOpaqueColors(image, g, this.getHeatMapColorTable().getColorTable(), cancel, theROI);

            }

        } finally {

            this.algorithm.setDistance(saved_distance);

        }

    }

    @Override

    public void print(Graphics2D g, ViewPort viewPort, Cancellable cancel,

            double scale, Map queryParameters, ICoordTrans coordTrans,

            FeatureStore featureStore, FeatureQuery featureQuery, PrintAttributes properties)

            throws LegendException {

        int saved_distance = this.algorithm.getDistance();

        try {

            double dpi = viewPort.getDPI();

            // Ver CartographicSupportToolkit.getCartographicLength

            int distance = (int) (this.algorithm.getDistance() * (dpi / 72));

            Geometry theROI = null;

            if (this.roi!=null) {

                theROI = this.roi.cloneGeometry();

                theROI.transform(viewPort.getAffineTransform());

            }

            this.algorithm.setDistance(distance);

            this.algorithm.init(viewPort.getImageWidth(), viewPort.getImageHeight());

            BufferedImage image = new BufferedImage(viewPort.getImageWidth(), viewPort.getImageHeight(), BufferedImage.TYPE_INT_ARGB);

            super.draw(image, g, viewPort, cancel, scale, queryParameters, coordTrans, featureStore, featureQuery, dpi);

            if (!cancel.isCanceled()) {

                this.algorithm.drawWithAlphaColors(image, g, this.getHeatMapColorTable().getColorTable(), cancel, theROI);

                g.drawImage(image, 0, 0, null);

            }

        } finally {

            this.algorithm.setDistance(saved_distance);

        }

    }

    @Override

    protected void drawFeatures(

        BufferedImage image,

        Graphics2D g,

        final ViewPort viewPort,

        final Cancellable cancel,

        final ICoordTrans coordTrans,

        double dpi,

        DefaultFeatureDrawnNotification drawnNotification,

        FeatureSet featureSet,

        FeatureSelection selection

    ) throws BaseException {

        int x = -1;

        if( !StringUtils.isEmpty(this.fieldName) ) {

            x = featureSet.getDefaultFeatureType().getIndex(this.fieldName);

        }

        final int n = x;

        featureSet.accept(new Visitor() {

            @Override

            public void visit(Object o) throws VisitCanceledException, BaseException {

                if( cancel.isCanceled() ) {

                    throw new VisitCanceledException();

                }

                Feature feature = (Feature) o;

                Geometry geom = feature.getDefaultGeometry();

                if( geom != null ) {

                    Point pointGeo = geom.centroid();

                    if( coordTrans != null ) {

                        pointGeo.reProject(coordTrans);

                    }

                    Point pointPixels = (Point) pointGeo.cloneGeometry();

                    pointPixels.transform(viewPort.getAffineTransform());

                    if( n >= 0 ) {

                        double value = 0;

                        try {

                            value = feature.getDouble(n);

                        } catch(Exception ex) {

                        }

                        if( value >0 ) {

                            algorithm.add((int) pointPixels.getX(), (int) pointPixels.getY(), value);

                        }

                    } else {

                        algorithm.add((int) pointPixels.getX(), (int) pointPixels.getY());

                    }

                }

            }

        });

    }

    /**

     * @return the distance

     */

    @Override

    public int getDistance() {

        return this.algorithm.getDistance();

    }

    /**

     * @param distance the distance to set

     */

    @Override

    public void setDistance(int distance) {

        this.algorithm.setDistance(distance);

    }

    @Override

    public void setColorTable(Color[] colorTable) {

        this.isRamp = false;

        this.sourceColorTable = colorTable;

        this.imageLegend = null;

        this.hmColorTable = null;

        this.fireDefaultSymbolChangedEvent(new SymbolLegendEvent(null,null));

    }

    @Override

    public void setColorTable(int numColors, Color coldColor, Color hotColor) {

        this.isRamp = true;

        this.rampColdColor = coldColor;

        this.rampHotColor = hotColor;

        this.rampNumColors = numColors;

        this.imageLegend = null;

        this.hmColorTable = null;

        this.fireDefaultSymbolChangedEvent(new SymbolLegendEvent(null,null));

    }

    @Override

    public Color[] getSourceColorTable() {

        return this.sourceColorTable;

    }

    @Override

    public Color[] getTargetColorTable() {

        return this.getHeatMapColorTable().getColorTable();

    }

    private HeatmapColorTable getHeatMapColorTable() {

        if (this.hmColorTable == null) {

            if (this.useRamp()) {

                this.hmColorTable = new HeatmapColorTable(this.rampColdColor, this.rampHotColor, this.rampNumColors);

            } else {

                if(useAlphaInColorTable) {

                    this.hmColorTable = new HeatmapColorTable(this.getSourceColorTable(), colorTableColdColorAlpha, colorTableHotColorAlpha);

                } else {

                this.hmColorTable =

                    this.hmColorTable = new HeatmapColorTable(this.getSourceColorTable());

                }

            }

        }

        return this.hmColorTable;

    }

    @Override

    public boolean useRamp() {

        return this.isRamp;

    }

    @Override

    public String getFieldName() {

        return this.fieldName;

    }

    @Override

    public void setFieldName(String fieldName) {

        this.fieldName = fieldName;

    }

    @Override

    public int getColorTableHotColorAlpha() {

        return colorTableHotColorAlpha;

    }

    @Override

    public void setColorTableHotColorAlpha(int colorTableHotColorAlpha) {

        this.colorTableHotColorAlpha = colorTableHotColorAlpha;

        this.imageLegend = null;

        this.hmColorTable = null;

    }

    @Override

    public int getColorTableColdColorAlpha() {

        return colorTableColdColorAlpha;

    }

    @Override

    public void setColorTableColdColorAlpha(int colorTableColdColorAlpha) {

        this.colorTableColdColorAlpha = colorTableColdColorAlpha;

        this.imageLegend = null;

        this.hmColorTable = null;

    }

    @Override

    public boolean useAlphaInColorTable() {

        return this.useAlphaInColorTable;

    }

    @Override

    public boolean setUseAlphaInColorTable(boolean use) {

        boolean x = this.useAlphaInColorTable;

        this.useAlphaInColorTable = use;

        this.hmColorTable = null;

        return x;

    }

    @Override

    public void setROI(Geometry roi) {

        this.roi = roi;

    }

    @Override

    public Geometry getROI() {

        return this.roi;

    }

    @Override

    public Image getImageLegend() {

        if( this.imageLegend==null ) {

            BufferedImage img = new BufferedImage(80, 20, BufferedImage.TYPE_INT_RGB);

            ColorTablePainter painter = new DefaultColorTablePainter(this.getTargetColorTable(),"");

            Graphics2D g = img.createGraphics();

            g.setClip(0, 0, 80, 20);

            g.setBackground(Color.WHITE);

            g.fillRect(0, 0, 80, 20);

            painter.paint(g, false);

            this.imageLegend = img;

        }

        return this.imageLegend;

    }

    @Override

    public String getPathImage() {

        return null;

    }

    @Override

    public void loadFromState(PersistentState state) throws PersistenceException {

        this.defaultSymbol = new SimpleTextSymbol();

        this.imageLegend = null;

        this.hmColorTable = null;

        super.loadFromState(state);

        this.isRamp = state.getBoolean("isRamp");

        this.sourceColorTable = (Color[]) state.getArray("sourceColorTable",Color.class);

        this.colorTableHotColorAlpha = state.getInt("colorTableHotColorAlpha");

        this.colorTableColdColorAlpha = state.getInt("colorTableColdColorAlpha");

        this.useAlphaInColorTable = state.getBoolean("useAlphaInColorTable");

        this.fieldName = state.getString("fieldName");

        this.rampNumColors = state.getInt("rampNumColors");

        this.rampColdColor = (Color)state.get("rampColdColor");

        this.rampHotColor = (Color)state.get("rampHotColor");

        this.algorithm = new DensityAlgorithm(state.getInt("distance"));

    }

    @Override

    public int getRampNumColors() {

        return this.rampNumColors;

    }

    @Override

    public Color getRampColdColor() {

        return this.rampColdColor;

    }

    @Override

    public Color getRampHotColor() {

        return this.rampHotColor;

    }

    @Override

    public void saveToState(PersistentState state) throws PersistenceException {

        super.saveToState(state);

        state.set("isRamp", isRamp);

        state.set("sourceColorTable", sourceColorTable);

        state.set("colorTableHotColorAlpha", colorTableHotColorAlpha);

        state.set("colorTableColdColorAlpha", colorTableColdColorAlpha);

        state.set("useAlphaInColorTable", useAlphaInColorTable);

        state.set("fieldName", fieldName);

        state.set("distance", algorithm.distance);

        state.set("rampNumColors", rampNumColors);

        state.set("rampColdColor", rampColdColor);

        state.set("rampHotColor", rampHotColor);

    }

    private static class HeatmapColorTable {

        private Color[] sourceColorTable = null;

        private int coldAlpha = -1;

        private int hotAlpha = -1;

        private Color coldColor = null;

        private Color hotColor = null;

        private Color[] targetColorTable = null;

        private int length = -1;

        public HeatmapColorTable(Color[] sourceColorTable){

            this.sourceColorTable  = sourceColorTable;

        }

        public HeatmapColorTable(Color[] sourceColorTable, int coldAlpha, int hotAlpha){

            this.sourceColorTable  = sourceColorTable;

            this.coldAlpha = coldAlpha;

            this.hotAlpha = hotAlpha;

        }

        public HeatmapColorTable(Color coldColor, Color hotColor, int length){

            this.coldColor = coldColor;

            this.hotColor = hotColor;

            this.length = length;

        }

        public Color[] getColorTable(){

            if(targetColorTable==null){

                if(sourceColorTable!=null){ //Tenemos tabla de color

                    if (coldAlpha >= 0 || hotAlpha >= 0) { //Se usa alpha para la tabla de color

                        double alphaDelta = getDelta(coldAlpha, hotAlpha, sourceColorTable.length);

                        targetColorTable = new Color[sourceColorTable.length];

                        for (int i = 0; i < sourceColorTable.length; i++) {

                            Color sourceColor = sourceColorTable[i];

                            if (coldAlpha >= 0 && hotAlpha >= 0) {

                                targetColorTable[i] =

                                    new Color(sourceColor.getRed(), sourceColor.getGreen(), sourceColor.getBlue(),

                                        coldAlpha + (int) (i * alphaDelta));

                            } else {

                                targetColorTable[i] = sourceColor;

                            }

                        }

                    } else { //No se usa alpha para la tabla de color

                        targetColorTable = sourceColorTable;

                    }

                } else { // Tenemos gradiente

                    targetColorTable = new Color[length];

                    double deltaRed = (hotColor.getRed() - coldColor.getRed()) / length;

                    double deltaGreen = (hotColor.getGreen() - coldColor.getGreen()) / length;

                    double deltaBlue = (hotColor.getBlue() - coldColor.getBlue()) / length;

                    double deltaAlpha = (hotColor.getAlpha() - coldColor.getAlpha()) / length;

                    for (int i = 0; i < length; i++) {

                        targetColorTable[i] =

                            new Color(

                                (int) (coldColor.getRed() + i * deltaRed),

                                (int) (coldColor.getGreen() + i * deltaGreen),

                                (int) (coldColor.getBlue() + i * deltaBlue),

                                (int) (coldColor.getAlpha() + i * deltaAlpha));

                    }

                }

            }

            return targetColorTable;

        }

        private double getDelta(int x1, int x2, int lenght){

            return (x2-x1)/((double)lenght-1);

        }

    }

}