Application: gvSIG desktop

/**********************************************************************

 * $Id: GdalRasterBand.java 15691 2007-10-31 10:49:53Z nbrodin $

 *

 * Name:     GdalRasterBand.java

 * Project:  JGDAL. Interface java to gdal (Frank Warmerdam).

 * Purpose:  Basic Funcions about raster bands. 

 * Author:   Nacho Brodin, brodin_ign@gva.es

 *

 **********************************************************************/

/* gvSIG. Sistema de Informaci�n Geogr�fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib��ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package es.gva.cit.jgdal;

/**

 * Representa a una banda simple de la im�gen o canal.

 * 

 * @author Nacho Brodin <brodin_ign@gva.es>.<BR> Equipo de desarrollo gvSIG.<BR> http://www.gvsig.gva.es

 * @version 0.0

 * @link http://www.gvsig.gva.es

 */

public class GdalRasterBand extends JNIBase{

        private native long getOverviewNat(long cPtr,int i);

        private native long getRasterColorTableNat(long cPtr);

        private native GdalBuffer readRasterNat(long cPtr, 

                        int nXOff, int nYOff, int nXSize, int nYSize,

                        int BufXSize, int BufYSize,

                        int eBufType);

        private native GdalBuffer readRasterWithPaletteNat(long cPtr, 

                        int nXOff, int nYOff, int nXSize, int nYSize,

                        int BufXSize, int BufYSize,

                        int eBufType);

        private native void writeRasterNat(        long cPtr, 

                        int nXOff, int nYOff, int nXSize, int nYSize,

                        GdalBuffer buffer,

                        int eBufType);

        private native double getRasterNoDataValueNat(long cPtr);

        private native String[] getMetadataNat(long cPtr,String pszDomain);

        private native int getRasterColorInterpretationNat(long cPtr);

        /**

         * Asigna el identificador de la banda

         */

         public GdalRasterBand(long cPtr) {

                 this.cPtr=cPtr;

         }

         /**

          * Lee datos de la banda de la im�gen

          * 

          * @return        Devuelve un vector de bytes con el trozo de raster le�do.

          * @param nXOff        El desplazamiento del pixel desde la esquina superior derecha

          * de la banda accedida.  

          * @param nYOff        El desplazamiento de l�nea desde la esquina superior derecha

          * de la banda accedida.         

          * @param nXSize        Ancho de la regi�n en pixels de la banda que ser� accedida

          * @param nYSize        Altura de la regi�n en l�neas de la banda que ser� accedida

          * @param BufXSize        Ancho del buffer donde la regi�n de la im�gen ser� guardada

          * @param BufYSize        Altura del buffer donde la regi�n de la im�gen ser� guardada

          * @param eBufType                

          */

         public GdalBuffer readRaster(int nXOff, int nYOff, int nXSize, int nYSize,

                         int BufXSize, int BufYSize,

                         int eBufType)throws GdalException {

                 System.err.println("Leyendo raster...");

                 GdalBuffer buffer = readRasterNat(cPtr, nXOff, nYOff, nXSize, nYSize, BufXSize, BufYSize, eBufType);

                 System.err.println("Raster leido.");

                 if(buffer!=null)

                         return buffer;

                 else 

                         return null;

         }

         /**

          * Escribe datos en la banda de la im�gen

          * 

          * @param nXOff        El desplazamiento del pixel desde la esquina superior derecha

          * de la banda accedida.  

          * @param nYOff        El desplazamiento de l�nea desde la esquina superior derecha

          * de la banda accedida.         

          * @param nXSize        Ancho de la regi�n en pixels de la banda que ser� accedida

          * @param nYSize        Altura de la regi�n en l�neas de la banda que ser� accedida

          * @param BufXSize        Ancho del buffer donde la regi�n de la im�gen ser� guardada

          * @param BufYSize        Altura del buffer donde la regi�n de la im�gen ser� guardada

          * @param eBufType

          */

         public void writeRaster(int nXOff, int nYOff, int nXSize, int nYSize, GdalBuffer buf, int eBufType)throws GdalException{

                 GdalBuffer buffer=new GdalBuffer();

                 switch(eBufType){

                 case 0:

                         return;

                 case 1:

                         buffer.buffByte=buf.buffByte;

                         break;

                 case 2:

                 case 3:

                 case 8:

                         buffer.buffShort=buf.buffShort;

                         break;

                 case 4:

                 case 5:

                 case 9:

                         buffer.buffInt=buf.buffInt;

                         break;

                 case 6:

                 case 10:

                         buffer.buffFloat=buf.buffFloat;

                         break;

                 case 7:

                 case 11:

                         buffer.buffDouble=buf.buffDouble;

                         break;                 

                 case 12:

                         return;

                 }

                 writeRasterNat(cPtr, nXOff, nYOff, nXSize, nYSize, buffer, eBufType);                  

         }

         /**

          *Obtiene el tama�o en pixeles de la im�gen en el eje de las X

          *@return Tama�o en pixeles del eje X

          *@throws GdalException 

          */

         public int getRasterBandXSize()throws GdalException {

                 String msg1="Error en getRasterBandXSize(). La llamada getRasterBand no tuvo exito";

                 String msg2="Tama�o de banda erroneo devuelto por GetRasterBandXSize";

                 return baseSimpleFunctions(0,msg1,msg2);

         }

         /**

          *Obtiene el tama�o en pixeles de la im�gen en el eje de las Y

          *@return Tama�o en pixeles del eje Y

          *@throws GdalException 

          */

         public int getRasterBandYSize()throws GdalException {

                 String msg1="Error en getRasterBandYSize(). La llamada getRasterBand no tuvo exito";

                 String msg2="Tama�o de banda erroneo devuelto por GetRasterBandYSize";

                 return baseSimpleFunctions(1,msg1,msg2);

         }

         /**

          * Devuelve el n�mero de overviews que contiene la banda.

          * @return N�mero de overviews

          * @throws GdalException 

          */

         public int getOverviewCount()throws GdalException {

                 String msg1="Error en getOverviewCount(). La llamada getRasterBand no tuvo exito";                

                 String msg2="Error al obtener el n�mero de overviews";

                 return baseSimpleFunctions(2,msg1,msg2);

         }

         /**

          * Obtiene el overview indicado por el �ndice "i".

          * 

          * @param i        indice del overview que se quiere recuperar.

          * @return GdalRasterBand        Banda correspondiente al overview selecccionado

          * @throws GdalException 

          */

         public GdalRasterBand getOverview(int i)throws GdalException {

                 long cPtr_ov;

                 if(i<0 && i>=this.getOverviewCount())

                         throw new GdalException("El overview seleccionado no existe");

                 cPtr_ov = getOverviewNat(cPtr,i);

                 return new GdalRasterBand(cPtr_ov);

         }

         /**

          * Devuelve el tama�o en X del bloque para esa banda

          * @return Tama�o en pixeles del bloque en el eje X

          * @throws GdalException 

          */

         public int getBlockXSize()throws GdalException {

                 String msg1="Error en getBlockXSize(). La llamada getRasterBand no tuvo exito";

                 String msg2="Tama�o de bloque erroneo devuelto por GetBlockXSize";

                 return baseSimpleFunctions(3,msg1,msg2);

         }

         /**

          * Devuelve el tama�o en Y del bloque para esa banda

          * @return Tama�o en pixeles del bloque en el eje Y

          * @throws GdalException 

          */

         public int getBlockYSize()throws GdalException {

                 String msg1="Error en getBlockXSize(). La llamada getRasterBand no tuvo exito";

                 String msg2="Tama�o de bloque erroneo devuelto por GetBlockYSize";

                 return baseSimpleFunctions(4,msg1,msg2);

         }

         /**

          * Devuelve el tipo de datos de la banda

          * @return Tama�o en pixeles del bloque en el eje Y

          * @throws GdalException 

          */

         public int getRasterDataType()throws GdalException {

                 String msg1="Error en getRasterDataType(). La llamada getRasterBand no tuvo exito";

                 String msg2="Tipo de dato devuelto por GetRasterDataType erroneo";

                 return baseSimpleFunctions(9,msg1,msg2);

         }

         /**

          * Obtiene la tabla de color asociada a la imagen

          */

         public GdalColorTable getRasterColorTable()throws GdalException {

                 GdalColorTable gct = null;

                 long l = getRasterColorTableNat(cPtr);

                 if(l > 0)

                         gct = new GdalColorTable(l);

                 else 

                         return null;

                 return gct;

         }

         /**

          * Lee datos de la banda de la im�gen con una paleta asociada

          * 

          * @return        Devuelve un vector de bytes con el trozo de raster le�do.

          * @param nXOff        El desplazamiento del pixel desde la esquina superior derecha

          * de la banda accedida.  

          * @param nYOff        El desplazamiento de l�nea desde la esquina superior derecha

          * de la banda accedida.         

          * @param nXSize        Ancho de la regi�n en pixels de la banda que ser� accedida

          * @param nYSize        Altura de la regi�n en l�neas de la banda que ser� accedida

          * @param BufXSize        Ancho del buffer donde la regi�n de la im�gen ser� guardada

          * @param BufYSize        Altura del buffer donde la regi�n de la im�gen ser� guardada

          * @param eBufType                

          */

         public GdalBuffer readRasterWithPalette(int nXOff, int nYOff, int nXSize, int nYSize,

                         int BufXSize, int BufYSize,

                         int eBufType)throws GdalException {

                 GdalBuffer buffer = readRasterWithPaletteNat(cPtr, nXOff, nYOff, nXSize, nYSize, BufXSize, BufYSize, eBufType);

                 if(buffer!=null)

                         return buffer;

                 else 

                         return null;

         }

         /**

          *Devuelve el valor de NoData

          */

         public double getRasterNoDataValue()throws GdalException {

                 return getRasterNoDataValueNat(cPtr);

         }

         /**

          * Obtiene un array de Strings con los metadatos

          * 

          * @throws GdalException

          * @return Array de Strings que corresponden a los metadatos que ofrece la im�gen

          */

         public String[] getMetadata()throws GdalException {

                 String[] res = getMetadataNat(cPtr,null);

                 if(res == null)

                         return new String[0];

                 else return res;

         }

         /**

          * Obtiene identificador que representa el tipo de banda de color. 

          * @return        identificador del tipo de banda de color

          * @throws GdalException

          */

         public int getRasterColorInterpretation()throws GdalException {

                 int bandType = getRasterColorInterpretationNat(cPtr);

                 return bandType;                

         }

}