| gvSIG desktop 1

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

 * $Id: GdalRasterBand.java 823 2005-01-03 17:02:37Z igbrotru $

 *

 * Name:     GdalRasterBand.java

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

 * Purpose:  Basic Funcions about raster bands. 

 * Author:   Nacho Brodin, brodin_ign@gva.es

 *

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

/*Copyright (C) 2004  Nacho Brodin <brodin_ign@gva.es>

 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.

 */

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 GdalBuffer readRasterNat(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);

        /**

         * 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 byte[] readRaster(int nXOff, int nYOff, int nXSize, int nYSize,

                                                                                 int BufXSize, int BufYSize,

                                                                                int eBufType)throws GdalException{

                 if(cPtr <= 0)

                        throw new GdalException("Error en GDALGetRasterBand(). La llamada GDALOpen no tuvo exito");

                 /*if( nXOff < 0 || nXOff + nXSize > nRasterXSize || nYOff < 0 || nYOff + nYSize > nRasterYSize )

                         throw new GdalException("Error en GDALReadRaster(). Limites de la ventana incorrectos");*/

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

                 return buffer.pabyScanLineBuf;

         }

         /**

          * 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, byte[] buf, int eBufType)throws GdalException{

                 if(cPtr <= 0)

                        throw new GdalException("Error en GDALGetRasterBand(). La llamada GDALOpen no tuvo exito");

                 GdalBuffer buffer=new GdalBuffer();

                 buffer.pabyScanLineBuf=buf;

                 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(cPtr <= 0)

                        throw new GdalException("Error en getOverview(). La llamada GDALOpen no tuvo exito");

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

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

                cPtr_ov = getOverviewNat(cPtr,i);

                if(cPtr_ov < 0)

                        throw new GdalException("No ha podido obtenerse el overview seleccionado");

                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);

        }

}