/[schmitzm]/trunk/src/appl/util/RasterMetaData.java

Diff of /trunk/src/appl/util/RasterMetaData.java

Parent Directory | Revision Log | View Patch Patch

-revision 243 by mojays,
Tue Feb 24 22:43:52 2009 UTC
+revision 244 by alfonx,
Wed Jul 29 09:33:33 2009 UTC
 Line 1
- package appl.util;
+ /*******************************************************************************
+  * Copyright (c) 2009 Martin O. J. Schmitz.
- import java.awt.image.DataBuffer;
+  *
- import java.io.Serializable;
+  * This file is part of the SCHMITZM library - a collection of utility
+  * classes based on Java 1.6, focussing (not only) on Java Swing
- import org.geotools.referencing.crs.DefaultGeographicCRS;
+  * and the Geotools library.
- import org.opengis.referencing.crs.CoordinateReferenceSystem;
+  *
+  * The SCHMITZM project is hosted at:
- import schmitzm.data.WritableGrid;
+  * http://wald.intevation.org/projects/schmitzm/
+  *
- /**
+  * This program is free software; you can redistribute it and/or
-  * Simple immutable class that encapsulates raster metadata,
+  * modify it under the terms of the GNU Lesser General Public License
-  * especially the MetaData of a {@link WritableGrid}.
+  * as published by the Free Software Foundation; either version 3
-  * Just a constructor and getters
+  * of the License, or (at your option) any later version.
-  * on the fields.
+  *
-  *
+  * This program is distributed in the hope that it will be useful,
-  * <br>
+  * but WITHOUT ANY WARRANTY; without even the implied warranty of
-  * @see WritableGrid for details on the variable description
+  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  *
+  * GNU General Public License for more details.
-  * @author Dominik Appl
+  *
-  */
+  * You should have received a copy of the GNU Lesser General Public License (license.txt)
- public final class RasterMetaData implements Serializable {
+  * along with this program; if not, write to the Free Software
+  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-     int width = 0;
+  * or try this link: http://www.gnu.org/licenses/lgpl.html
+  *
-     int height = 0;
+  * Contributors:
+  *     Martin O. J. Schmitz - initial API and implementation
-     int minX = 0;
+  *     Stefan A. Krüger - additional utility classes
+  ******************************************************************************/
-     int minY = 0;
+ package appl.util;
-     double realWidth = 0;
+ import java.awt.image.DataBuffer;
+ import java.io.Serializable;
-     double realHeight = 0;
+ import org.geotools.referencing.crs.DefaultGeographicCRS;
-     int dataType = DataBuffer.TYPE_UNDEFINED;
+ import org.opengis.referencing.crs.CoordinateReferenceSystem;
-     double x = 0.0;
+ import schmitzm.data.WritableGrid;
-     double y = 0.0;
+ /**
+  * Simple immutable class that encapsulates raster metadata,
-     CoordinateReferenceSystem crs = null;
+  * especially the MetaData of a {@link WritableGrid}.
+  * Just a constructor and getters
+  * on the fields.
-         /**
+  *
-          * @return Returns the CRS of the raster
+  * <br>
-          */
+  * @see WritableGrid for details on the variable description
-         public final CoordinateReferenceSystem getCoordinateReferenceSystem() {
+  *
-           return crs;
+  * @author Dominik Appl
-         }
+  */
+ public final class RasterMetaData implements Serializable {
-         /**
-          * @return Returns the height in cells
+     int width = 0;
-          */
-         public final int getHeight() {
+     int height = 0;
-                 return height;
-         }
+     int minX = 0;
-         /**
+     int minY = 0;
-          * @return Returns the width in cells.
-          */
+     double realWidth = 0;
-         public final int getWidth() {
-                 return width;
+     double realHeight = 0;
-         }
+     int dataType = DataBuffer.TYPE_UNDEFINED;
-         /**
-          * @return Returns the dataType.
+     double x = 0.0;
-          */
-         public final int getDataType() {
+     double y = 0.0;
-                 return dataType;
-         }
+     CoordinateReferenceSystem crs = null;
-         /**
-          * @return Returns minX (used to indicate a start index)
+         /**
-          * @see WritableGrid#getMinX()
+          * @return Returns the CRS of the raster
           */
-         public final int getMinX() {
+         public final CoordinateReferenceSystem getCoordinateReferenceSystem() {
-                 return minX;
+           return crs;
          }
          /**
-          * @return Returns the minY ((used to indicate a start index)
+          * @return Returns the height in cells
-          * @see WritableGrid#getMinY()
+          */
-          */
+         public final int getHeight() {
-         public final int getMinY() {
+                 return height;
-                 return minY;
+         }
-         }
+         /**
-         /**
+          * @return Returns the width in cells.
-          * @return Returns the realHeight.
+          */
-          */
+         public final int getWidth() {
-         public final double getRealHeight() {
+                 return width;
-                 return realHeight;
+         }
-         }
+         /**
-         /**
+          * @return Returns the dataType.
-          * @return Returns the realWidth.
+          */
-          */
+         public final int getDataType() {
-         public final double getRealWidth() {
+                 return dataType;
-                 return realWidth;
+         }
-         }
+         /**
-         /**
+          * @return Returns minX (used to indicate a start index)
-          * @return Returns the (geographic) x-coordinate
+          * @see WritableGrid#getMinX()
           */
-         public final double getX() {
+         public final int getMinX() {
-                 return x;
+                 return minX;
          }
+         /**
-         /**
+          * @return Returns the minY ((used to indicate a start index)
-          * @return Returns  the (geographic) y-coordinate
+          * @see WritableGrid#getMinY()
           */
-         public final double getY() {
+         public final int getMinY() {
-                 return y;
+                 return minY;
          }
          /**
-          * @param dataType the datatype
+          * @return Returns the realHeight.
-          * @param gridWidth the width of the grid (in cells)
+          */
-          * @param gridHeight the height of the grid (in cells)
+         public final double getRealHeight() {
-          * @param minX the minX (used to indicate a start index)
+                 return realHeight;
-          * @param minY the minY (used to indicate a start index)
+         }
-          * @param realWidth the real width
-          * @param realHeight the real height
+         /**
-          * @param x the (geographic) x-coordinate
+          * @return Returns the realWidth.
-          * @param y the (geographic) y-coordinate
+          */
-      * @param crs the {@link CoordinateReferenceSystem}. Use null for DefaultCRS (WGS84)
+         public final double getRealWidth() {
-      *
+                 return realWidth;
-      * @see WritableGrid
+         }
-          */
-         public RasterMetaData(int dataType, int gridWidth, int gridHeight,
+         /**
-                         int minX, int minY, double x, double y, double realWidth,
+          * @return Returns the (geographic) x-coordinate
-                         double realHeight, CoordinateReferenceSystem crs) {
+          */
-                 this.width = gridWidth;
+         public final double getX() {
-                 this.height = gridHeight;
+                 return x;
-                 this.minX = minX;
+         }
-                 this.minY = minY;
-                 this.realWidth = realWidth;
-                 this.realHeight = realHeight;
+         /**
-                 this.dataType = dataType;
+          * @return Returns  the (geographic) y-coordinate
-                 this.x = x;
+          */
-                 this.y = y;
+         public final double getY() {
-                 this.crs = (crs == null) ? DefaultGeographicCRS.WGS84 : crs;
+                 return y;
+         }
-         }
+         /**
-         /**
+          * @param dataType the datatype
-          * Constructs a RasterMetaData Object. The values of the real height/ width
+          * @param gridWidth the width of the grid (in cells)
-          * are calculated out of the cellsize. The cells are assumed to be squares.
+          * @param gridHeight the height of the grid (in cells)
-          *
+          * @param minX the minX (used to indicate a start index)
-          * @param dataType the datatype
+          * @param minY the minY (used to indicate a start index)
-          * @param gridWidth the width of the grid (in cells)
+          * @param realWidth the real width
-          * @param gridHeight the height of the grid (in cells)
+          * @param realHeight the real height
-          * @param minX the minX (used to indicate a start index)
+          * @param x the (geographic) x-coordinate
-          * @param minY the minY (used to indicate a start index)
+          * @param y the (geographic) y-coordinate
-          * @param x the (geographic) x-coordinate
+      * @param crs the {@link CoordinateReferenceSystem}. Use null for DefaultCRS (WGS84)
-          * @param y the (geographic) y-coordinate
+      *
-          * @param cellSize the real size of one cell
+      * @see WritableGrid
-      * @param crs the {@link CoordinateReferenceSystem}, use null for default CRS (WGS84)
+          */
-          */
+         public RasterMetaData(int dataType, int gridWidth, int gridHeight,
-         public RasterMetaData(int dataType,  int gridWidth, int gridHeight,
+                         int minX, int minY, double x, double y, double realWidth,
-                         int minX, int minY, double x, double y, double cellSize, CoordinateReferenceSystem crs) {
+                         double realHeight, CoordinateReferenceSystem crs) {
+                 this.width = gridWidth;
-                 this(dataType, gridWidth, gridHeight, minX, minY, x, y, gridWidth
+                 this.height = gridHeight;
-                                 * cellSize, gridHeight * cellSize,crs);
+                 this.minX = minX;
-         }
+                 this.minY = minY;
+                 this.realWidth = realWidth;
-         /**
+                 this.realHeight = realHeight;
-          * Constructs a RasterMetaDataObject out of the given Grid
+                 this.dataType = dataType;
-          * @param w the source grid
+                 this.x = x;
-          */
+                 this.y = y;
-         public RasterMetaData(WritableGrid w) {
+                 this.crs = (crs == null) ? DefaultGeographicCRS.WGS84 : crs;
-         super();
-         this.width = w.getWidth();
+         }
-         this.height = w.getHeight();
-         this.minX = w.getMinX();
+         /**
-         this.minY = w.getMinY();
+          * Constructs a RasterMetaData Object. The values of the real height/ width
-         this.realWidth = w.getRealWidth();
+          * are calculated out of the cellsize. The cells are assumed to be squares.
-         this.realHeight = w.getRealHeight();
+          *
-         this.dataType = w.getSampleType();
+          * @param dataType the datatype
-         this.x = w.getX();
+          * @param gridWidth the width of the grid (in cells)
-         this.y = w.getY();
+          * @param gridHeight the height of the grid (in cells)
-         this.crs = w.getCoordinateReferenceSystem();
+          * @param minX the minX (used to indicate a start index)
-     }
+          * @param minY the minY (used to indicate a start index)
+          * @param x the (geographic) x-coordinate
-         /**
+          * @param y the (geographic) y-coordinate
-          * needed for serialization
+          * @param cellSize the real size of one cell
-          */
+      * @param crs the {@link CoordinateReferenceSystem}, use null for default CRS (WGS84)
-         private RasterMetaData() {
+          */
-          this(0,0,0,0,0,0,0,0,0,null);
+         public RasterMetaData(int dataType,  int gridWidth, int gridHeight,
-         }
+                         int minX, int minY, double x, double y, double cellSize, CoordinateReferenceSystem crs) {
-         /**
+                 this(dataType, gridWidth, gridHeight, minX, minY, x, y, gridWidth
-          * @return the real width of a raster cell
+                                 * cellSize, gridHeight * cellSize,crs);
-          */
+         }
-         public final double getCellWidth() {
-                 return getRealWidth() / getWidth();
+         /**
-         }
+          * Constructs a RasterMetaDataObject out of the given Grid
+          * @param w the source grid
-         /**
+          */
-          * Checks if the given RasterMetaData object has the same values.
+         public RasterMetaData(WritableGrid w) {
-          *
+         super();
-          * @param rasterMeta must be a RasterMetaDataObject! Else ClassCastException will be thrown.
+         this.width = w.getWidth();
-          * @return true, if all values are the same
+         this.height = w.getHeight();
-          * @see java.lang.Object#equals(java.lang.Object)
+         this.minX = w.getMinX();
-          */
+         this.minY = w.getMinY();
-         @Override
+         this.realWidth = w.getRealWidth();
-         public boolean equals(Object rasterMeta) {
+         this.realHeight = w.getRealHeight();
-                 RasterMetaData r = (RasterMetaData) rasterMeta;
+         this.dataType = w.getSampleType();
-         return (
+         this.x = w.getX();
-                         this.width == r.getWidth() &&
+         this.y = w.getY();
-                         this.height == r.getHeight() &&
+         this.crs = w.getCoordinateReferenceSystem();
-                         this.minX == r.getMinX() &&
+     }
-                         this.minY == r.getMinY() &&
-                         this.realWidth == r.getRealWidth() &&
+         /**
-                         this.realHeight == r.getRealHeight() &&
+          * needed for serialization
-                         this.dataType == r.getDataType() &&
+          */
-                         this.x == r.getX() &&
+         private RasterMetaData() {
-                         this.y == r.getY()
+          this(0,0,0,0,0,0,0,0,0,null);
-                         );
+         }
-         }
+         /**
-         /**
+          * @return the real width of a raster cell
-          * @return the real height of a raster cell
+          */
-          */
+         public final double getCellWidth() {
-         public final double getCellHeight() {
+                 return getRealWidth() / getWidth();
-                 return getRealHeight() / getHeight();
+         }
-         }
+         /**
-         public final String toString() {
+          * Checks if the given RasterMetaData object has the same values.
-                 return "MetaData: type:" + dataType + " wc:" + width + "hc:" + height
+          *
-                                 + " minX:" + minX + " minY:" + minY + " x:" + x + " y:" + y
+          * @param rasterMeta must be a RasterMetaDataObject! Else ClassCastException will be thrown.
-                                 + " rw:" + realWidth + " rh:" + realHeight;
+          * @return true, if all values are the same
-         }
+          * @see java.lang.Object#equals(java.lang.Object)
- }
+          */
+         @Override
+         public boolean equals(Object rasterMeta) {
+                 RasterMetaData r = (RasterMetaData) rasterMeta;
+         return (
+                         this.width == r.getWidth() &&
+                         this.height == r.getHeight() &&
+                         this.minX == r.getMinX() &&
+                         this.minY == r.getMinY() &&
+                         this.realWidth == r.getRealWidth() &&
+                         this.realHeight == r.getRealHeight() &&
+                         this.dataType == r.getDataType() &&
+                         this.x == r.getX() &&
+                         this.y == r.getY()
+                         );
+         }
+         /**
+          * @return the real height of a raster cell
+          */
+         public final double getCellHeight() {
+                 return getRealHeight() / getHeight();
+         }
+         public final String toString() {
+                 return "MetaData: type:" + dataType + " wc:" + width + "hc:" + height
+                                 + " minX:" + minX + " minY:" + minY + " x:" + x + " y:" + y
+                                 + " rw:" + realWidth + " rh:" + realHeight;
+         }
+ }

 Legend:



Removed from v.243
 


changed lines


 
Added in v.244
 Legend:



Removed from v.243
 


changed lines


 
Added in v.244
-Removed from v.243
+Added in v.244

[email protected]	ViewVC Help
Powered by ViewVC 1.1.26