001    //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/processing/raster/interpolation/Interpolation.java $
002    /*----------------    FILE HEADER  ------------------------------------------
003    
004     This file is part of deegree.
005     Copyright (C) 2001-2008 by:
006     EXSE, Department of Geography, University of Bonn
007     http://www.giub.uni-bonn.de/deegree/
008     lat/lon GmbH
009     http://www.lat-lon.de
010    
011     This library is free software; you can redistribute it and/or
012     modify it under the terms of the GNU Lesser General Public
013     License as published by the Free Software Foundation; either
014     version 2.1 of the License, or (at your option) any later version.
015    
016     This library is distributed in the hope that it will be useful,
017     but WITHOUT ANY WARRANTY; without even the implied warranty of
018     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
019     Lesser General Public License for more details.
020    
021     You should have received a copy of the GNU Lesser General Public
022     License along with this library; if not, write to the Free Software
023     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
024    
025     Contact:
026    
027     Andreas Poth
028     lat/lon GmbH
029     Aennchenstr. 19
030     53177 Bonn
031     Germany
032     E-Mail: poth@lat-lon.de
033    
034     Prof. Dr. Klaus Greve
035     Department of Geography
036     University of Bonn
037     Meckenheimer Allee 166
038     53115 Bonn
039     Germany
040     E-Mail: greve@giub.uni-bonn.de
041    
042     ---------------------------------------------------------------------------*/
043    package org.deegree.processing.raster.interpolation;
044    
045    import java.net.URI;
046    import java.net.URISyntaxException;
047    
048    import org.deegree.datatypes.values.Interval;
049    import org.deegree.datatypes.values.TypedLiteral;
050    import org.deegree.datatypes.values.Values;
051    import org.deegree.framework.log.ILogger;
052    import org.deegree.framework.log.LoggerFactory;
053    import org.deegree.graphics.transformation.WorldToScreenTransform;
054    import org.deegree.io.quadtree.IndexException;
055    import org.deegree.io.quadtree.Quadtree;
056    import org.deegree.model.coverage.grid.FloatGridCoverage;
057    import org.deegree.model.spatialschema.Envelope;
058    
059    /**
060     * <code>Interpolation</code> is the abstract base class for all interpolation algorithms. Data
061     * representation is done via the Quadtree interface.
062     * 
063     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
064     * @author last edited by: $Author: apoth $
065     * 
066     * @version $Revision: 9346 $, $Date: 2007-12-27 17:39:07 +0100 (Do, 27 Dez 2007) $
067     */
068    public abstract class Interpolation {
069    
070        /**
071         * 
072         */
073        protected Quadtree data;
074    
075        private static URI type = null;
076        static {
077            try {
078                type = new URI( "xsd:integer" );
079            } catch ( URISyntaxException never_happens ) {
080            }
081        }
082    
083        protected Values ignoreValues = new Values( new Interval[0], new TypedLiteral[0],
084                                                    new TypedLiteral( "-9999", type ) );
085    
086        protected double searchRadius1 = 0;
087    
088        protected double searchRadius2 = 0;
089    
090        protected double searchRadiusAngle = 0;
091    
092        protected int minData = 3;
093    
094        protected int maxData = Integer.MAX_VALUE;
095    
096        protected double noValue = -9999;
097    
098        protected double autoincreaseSearchRadius1 = 0;
099    
100        protected double autoincreaseSearchRadius2 = 0;
101    
102        private static final ILogger LOG = LoggerFactory.getLogger( Interpolation.class );
103    
104        /**
105         * 
106         * @param data
107         */
108        protected Interpolation( Quadtree data ) {
109            this.data = data;
110            searchRadius1 = calcSearchRadius();
111            searchRadius2 = searchRadius1;
112        }
113    
114        /**
115         * 
116         * @param data
117         * @param ignoreValues
118         */
119        protected Interpolation( Quadtree data, Values ignoreValues ) {
120            this.data = data;
121            this.ignoreValues = ignoreValues;
122            searchRadius1 = calcSearchRadius();
123            searchRadius2 = searchRadius1;
124        }
125    
126        /**
127         * 
128         * @param data
129         * @param ignoreValues
130         * @param searchRadius1
131         * @param searchRadius2
132         * @param searchRadiusAngle
133         * @param minData
134         * @param maxData
135         * @param noValue
136         * @param autoincreaseSearchRadius1
137         * @param autoincreaseSearchRadius2
138         */
139        protected Interpolation( Quadtree data, Values ignoreValues, double searchRadius1,
140                                 double searchRadius2, double searchRadiusAngle, int minData,
141                                 int maxData, double noValue, double autoincreaseSearchRadius1,
142                                 double autoincreaseSearchRadius2 ) {
143            this.data = data;
144            this.ignoreValues = ignoreValues;
145            // this.envelope = envelope;
146            this.searchRadius1 = searchRadius1;
147            this.searchRadius2 = searchRadius2;
148            this.searchRadiusAngle = searchRadiusAngle;
149            this.minData = minData;
150            this.maxData = maxData;
151            this.noValue = noValue;
152            this.autoincreaseSearchRadius1 = autoincreaseSearchRadius1;
153            this.autoincreaseSearchRadius2 = autoincreaseSearchRadius2;
154        }
155    
156        private double calcSearchRadius() {
157            try {
158                double w = data.getRootBoundingBox().getWidth();
159                double h = data.getRootBoundingBox().getHeight();
160                // default search radius is 20% of the target envelope
161                return Math.sqrt( w * w + h * h ) / 5d;
162            } catch ( IndexException e ) {
163                LOG.logError( e.getLocalizedMessage(), e );
164            }
165            return 0;
166        }
167    
168        /**
169         * performs the interpolation
170         * 
171         * @param width
172         *            width of the result grid in number of cells
173         * @param height
174         *            height of the result grid in number of cells
175         * @return result grid as an instance of
176         * @see org.deegree.model.coverage.grid.GridCoverage
177         * @throws InterpolationException
178         */
179        public FloatGridCoverage interpolate( int width, int height )
180                                throws InterpolationException {
181    
182            Envelope envelope = null;
183    
184            try {
185                envelope = data.getRootBoundingBox();
186            } catch ( IndexException e ) {
187                LOG.logError( e.getLocalizedMessage(), e );
188            }
189    
190            WorldToScreenTransform trans = new WorldToScreenTransform( envelope.getMin().getX(),
191                                                                       envelope.getMin().getY(),
192                                                                       envelope.getMax().getX(),
193                                                                       envelope.getMax().getY(), 0, 0,
194                                                                       width - 1, height - 1 );
195    
196            float[][][] data = new float[1][height][width];
197            for ( int i = 0; i < data[0][0].length; i++ ) {
198                for ( int j = 0; j < data[0].length; j++ ) {
199                    data[0][j][i] = (float) calcInterpolatedValue( trans.getSourceX( i ),
200                                                                   trans.getSourceY( j ),
201                                                                   searchRadius1, searchRadius2 );
202                }
203            }
204    
205            // the CoverageOffering is passed as null here, desired? TODO
206            FloatGridCoverage result = new FloatGridCoverage( null, envelope, data );
207    
208            return result;
209        }
210    
211        /**
212         * calculates the interpolated value for a position defined by x and y
213         * 
214         * @param x
215         * @param y
216         * @param searchRadius1
217         * @param searchRadius2
218         * @return the interpolated value
219         * @throws InterpolationException
220         */
221        public abstract double calcInterpolatedValue( double x, double y, double searchRadius1,
222                                                      double searchRadius2 )
223                                throws InterpolationException;
224    
225    }