Application: gvSIG desktop » gvSIG raster

org.gvsig.raster.cache.tile.TileCacheLibrary

package org.gvsig.raster.cache.buffer;

import java.awt.geom.Rectangle2D;

import java.awt.image.DataBuffer;

import java.io.IOException;

import java.util.ArrayList;

import org.gvsig.raster.cache.buffer.exception.BandNotCompatibleException;

import org.gvsig.raster.cache.buffer.exception.OperationNotSupportedException;

import org.gvsig.raster.cache.buffer.exception.ProcessInterruptedException;

import org.gvsig.raster.cache.buffer.exception.WrongParameterException;

import org.gvsig.raster.cache.buffer.histogram.Histogramable;

/**

 * Interfaz que contiene las operaciones que debe soportar un buffer de datos.

 * @author Nacho Brodin (nachobrodin@gmail.com)

 *

 */

public interface Buffer extends Histogramable {

	public static boolean   noDataValueEnable = false;

	public static double    defaultNoDataValue = -99999.0;

    public final static int TYPE_UNDEFINED = DataBuffer.TYPE_UNDEFINED;

    public final static int TYPE_BYTE = DataBuffer.TYPE_BYTE;

    public final static int TYPE_SHORT = DataBuffer.TYPE_SHORT;

    public final static int TYPE_USHORT = DataBuffer.TYPE_USHORT;

    public final static int TYPE_INT = DataBuffer.TYPE_INT;

    public final static int TYPE_FLOAT = DataBuffer.TYPE_FLOAT;

    public final static int TYPE_DOUBLE = DataBuffer.TYPE_DOUBLE;

    //Read type constants

	public static final int      READ_ONLY             = 0;

	public static final int      READ_WRITE            = 1;

	//If the returned buffer is a cache buffer then it will have vertical stripes

	public static final int      READ_WRITE_CVERT      = 2;

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

    //************GETTING INFO**************

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

    /**

     * Ancho del raster

     * @return Entero con el ancho del raster

     */

    public int getWidth();

    /**

     * Alto del raster

     * @return Entero con el alto del raster

     */

    public int getHeight();

    /**

     * N?mero de bandas

     * @return Entero con el n?mero de bandas

     */

    public int getBandCount();

    /**

     * Obtiene el tipo de dato. Los tipos de dato posibles est?n definidos en IRaster.

     * @return tipo de datos

     */

	public int getDataType();

	/**

	 * Asigna el tipo de dato. Los tipos de dato posibles est?n definidos en IRaster.

	 * @param dataType Tipo de dato del buffer

	 */

	public void setDataType(int dataType);

	/**

     * Get no data value

     * @return double

     */

 	public BufferNoData getNoDataValue();

    /**

 	 * Sets no data value

 	 * @return double

 	 */

 	public void setNoDataValue(BufferNoData noDataValue);

    /**

     * Get true if current buffer is writable and false if is not.

     * @return true or false 

     */

    public boolean isWritable();

    /**

     * Obtiene true si el pixel pasado por par?metro cae dentro de los l?mites

     * del rater y false si cae fuera. 

     * @param x Posici?n X del pixel a averiguar

     * @param y Posici?n Y del pixel a averiguar

     * @return true si est? dentro y false si cae fuera.

     */

    public boolean isInside(int x, int y);

    /**

	 * Gets a bouding box of this buffer

	 * @return

	 */

	public Rectangle2D getDataExtent();

	/**

	 * Sets the bounding box of this buffer

	 * @param extent

	 */

	public void setDataExtent(Rectangle2D extent);

	/**

	 * Libera el buffer de memoria

	 * @throws IOException 

	 */

	public void free() throws IOException;

	/**

	 * Sets the RasterDataStore reference

	 * @param store

	 */

	public void setStore(Object store);

	/**

	 * Gets the RasterDataStore reference

	 * @return

	 */

	public Object getStore();

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

    //************GETTING DATA**************

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

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

    //Obtiene una linea de datos de todas las bandas

	/**

	 * Obtiene una l?nea de datos con todas las bandas para buffers con tipo

	 * de dato byte.

	 * @param line N?mero de l?nea del buffer a recuperar

	 * @return Array bidimensional conteniendo la l?nea de datos donde la primera

	 * dimensi?n representa las bandas y la segunda la posici?n en la l?nea

	 */    

    public byte[][] getLineByte(int line) throws OperationNotSupportedException;

    /**

	 * Obtiene una l?nea de datos con todas las bandas para buffers con tipo

	 * de dato short.

	 * @param line N?mero de l?nea del buffer a recuperar

	 * @return Array bidimensional conteniendo la l?nea de datos donde la primera

	 * dimensi?n representa las bandas y la segunda la posici?n en la l?nea

	 */  

    public short[][] getLineShort(int line) throws OperationNotSupportedException;

    /**

	 * Obtiene una l?nea de datos con todas las bandas para buffers con tipo

	 * de dato int.

	 * @param line N?mero de l?nea del buffer a recuperar

	 * @return Array bidimensional conteniendo la l?nea de datos donde la primera

	 * dimensi?n representa las bandas y la segunda la posici?n en la l?nea

	 */  

    public int[][] getLineInt(int line) throws OperationNotSupportedException;

    /**

	 * Obtiene una l?nea de datos con todas las bandas para buffers con tipo

	 * de dato float.

	 * @param line N?mero de l?nea del buffer a recuperar

	 * @return Array bidimensional conteniendo la l?nea de datos donde la primera

	 * dimensi?n representa las bandas y la segunda la posici?n en la l?nea

	 */  

    public float[][] getLineFloat(int line) throws OperationNotSupportedException;

    /**

	 * Obtiene una l?nea de datos con todas las bandas para buffers con tipo

	 * de dato double.

	 * @param line N?mero de l?nea del buffer a recuperar

	 * @return Array bidimensional conteniendo la l?nea de datos donde la primera

	 * dimensi?n representa las bandas y la segunda la posici?n en la l?nea

	 */  

    public double[][] getLineDouble(int line) throws OperationNotSupportedException;

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

    //Obtiene una linea de datos de una banda

    /**

     * Obtiene una l?nea de datos de la banda solicitada para buffers con tipo

	 * de dato byte.

     * @param line N?mero de l?nea del buffer a recuperar

     * @param band N?mero de banda a recuperar

     * @return Array unidimensional que representa la l?nea de datos.

     */

    public byte[] getLineFromBandByte(int line, int band) throws OperationNotSupportedException;

    /**

     * Obtiene una l?nea de datos de la banda solicitada para buffers con tipo

	 * de dato short.

     * @param line N?mero de l?nea del buffer a recuperar

     * @param band N?mero de banda a recuperar

     * @return Array unidimensional que representa la l?nea de datos.

     */

    public short[] getLineFromBandShort(int line, int band) throws OperationNotSupportedException;

    /**

     * Obtiene una l?nea de datos de la banda solicitada para buffers con tipo

	 * de dato int.

     * @param line N?mero de l?nea del buffer a recuperar

     * @param band N?mero de banda a recuperar

     * @return Array unidimensional que representa la l?nea de datos.

     */

    public int[] getLineFromBandInt(int line, int band) throws OperationNotSupportedException;

    /**

     * Obtiene una l?nea de datos de la banda solicitada para buffers con tipo

	 * de dato float.

     * @param line N?mero de l?nea del buffer a recuperar

     * @param band N?mero de banda a recuperar

     * @return Array unidimensional que representa la l?nea de datos.

     */

    public float[] getLineFromBandFloat(int line, int band) throws OperationNotSupportedException;

    /**

     * Obtiene una l?nea de datos de la banda solicitada para buffers con tipo

	 * de dato double.

     * @param line N?mero de l?nea del buffer a recuperar

     * @param band N?mero de banda a recuperar

     * @return Array unidimensional que representa la l?nea de datos.

     */

    public double[] getLineFromBandDouble(int line, int band) throws OperationNotSupportedException;

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

    //Obtiene un elemento de la matriz

    /**

     * Gets one element from the array if this is byte datatype

     * @param line Y position

     * @param col X position

     * @param band Number of band to read

     * @return Readed element

     */

    public byte getElemByte(int line, int col, int band);

    /**

    * Gets one element from the array if this is short datatype

    * @param line Y position

    * @param col X position

    * @param band Number of band to read

    * @return Readed element

    */

    public short getElemShort(int line, int col, int band);

    /**

     * Gets one element from the array if this is int datatype

     * @param line Y position

     * @param col X position

     * @param band Number of band to read

     * @return Readed element

     */

    public int getElemInt(int line, int col, int band);

    /**

     * Gets one element from the array if this is float datatype

     * @param line Y position

     * @param col X position

     * @param band Number of band to read

     * @return Readed element

     */

    public float getElemFloat(int line, int col, int band);

    /**

     * Gets one element from the array if this is double datatype

     * @param line Y position

     * @param col X position

     * @param band Number of band to read

     * @return Readed element

     */

    public double getElemDouble(int line, int col, int band);

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

    //Copia un elemento de todas la bandas en el buffer pasado por par?metro

    /**

     * Gets one element of each band from the array if this is byte datatype

     * @param line Y position

     * @param col X position

     * @param data Each element of this array is a diferent band of the position line, col

     */

    public void getElemByte(int line, int col, byte[] data);

    /**

     * Gets one element of each band from the array if this is short datatype

     * @param line Y position

     * @param col X position

     * @param data Each element of this array is a diferent band of the position line, col

     */

    public void getElemShort(int line, int col, short[] data);

    /**

     * Gets one element of each band from the array if this is int datatype

     * @param line Y position

     * @param col X position

     * @param data Each element of this array is a diferent band of the position line, col

     */

    public void getElemInt(int line, int col, int[] data);

    /**

     * Gets one element of each band from the array if this is float datatype

     * @param line Y position

     * @param col X position

     * @param data Each element of this array is a diferent band of the position line, col

     */

    public void getElemFloat(int line, int col, float[] data);

    /**

     * Gets one element of each band from the array if this is double datatype

     * @param line Y position

     * @param col X position

     * @param data Each element of this array is a diferent band of the position line, col

     */

    public void getElemDouble(int line, int col, double[] data);

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

    //************SETTING DATA**************

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

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

    //Asigna una linea de datos a una banda

    /**

     * Sets a line of byte data

     * @param data Array of data 

     * @param line Y position

     * @param band N?mber of band

     * @throws OperationNotSupportedException 

     */

    public void setLineInBandByte(byte[] data, int line, int band) throws OperationNotSupportedException;

    /**

     * Sets a line of short data

     * @param data Array of data 

     * @param line Y position

     * @param band N?mber of band

     */

    public void setLineInBandShort(short[] data, int line, int band) throws OperationNotSupportedException;

    /**

     * Sets a line of int data

     * @param data Array of data 

     * @param line Y position

     * @param band N?mber of band

     */

    public void setLineInBandInt(int[] data, int line, int band) throws OperationNotSupportedException;

    /**

     * Sets a line of float data

     * @param data Array of data 

     * @param line Y position

     * @param band N?mber of band

     */

    public void setLineInBandFloat(float[] data, int line, int band) throws OperationNotSupportedException;

    /**

     * Sets a line of double data

     * @param data Array of data 

     * @param line Y position

     * @param band N?mber of band

     */

    public void setLineInBandDouble(double[] data, int line, int band) throws OperationNotSupportedException;

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

    //Asigna una linea de datos a todas las bandas

    public void setLineByte(byte[][] data, int line) throws OperationNotSupportedException;

    public void setLineShort(short[][] data, int line) throws OperationNotSupportedException;

    public void setLineInt(int[][] data, int line) throws OperationNotSupportedException;

    public void setLineFloat(float[][] data, int line) throws OperationNotSupportedException;

    public void setLineDouble(double[][] data, int line) throws OperationNotSupportedException;

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

    //Asigna un elemento de la matriz

    public void setElem(int line, int col, int band, byte data) throws OperationNotSupportedException;

    public void setElem(int line, int col, int band, short data) throws OperationNotSupportedException;

    public void setElem(int line, int col, int band, int data) throws OperationNotSupportedException;

    public void setElem(int line, int col, int band, float data) throws OperationNotSupportedException;

    public void setElem(int line, int col, int band, double data) throws OperationNotSupportedException;

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

    //Asigna un elemento a todas la bandas en el buffer pasado por par?metro

    public void setElemByte(int line, int col, byte[] data) throws OperationNotSupportedException;

    public void setElemShort(int line, int col, short[] data) throws OperationNotSupportedException;

    public void setElemInt(int line, int col, int[] data) throws OperationNotSupportedException;

    public void setElemFloat(int line, int col, float[] data) throws OperationNotSupportedException;

    public void setElemDouble(int line, int col, double[] data) throws OperationNotSupportedException;

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

    //Inicializa una banda a un valor pasado por par?metro

    public void assign(int band, byte value) throws OperationNotSupportedException;

    public void assign(int band, short value) throws OperationNotSupportedException;

    public void assign(int band, int value) throws OperationNotSupportedException;

    public void assign(int band, float value) throws OperationNotSupportedException;

    public void assign(int band, double value) throws OperationNotSupportedException;

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

    //**********BANDS OPERATIONS************

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

    /**

     * Removes a band from memory buffer

     * @param band Number of band

     */

    public void removeBand(int pos) throws IOException ;

    /**

     * Makes an empty band without initial value in the selected position

     * @return IRasterBand New band

     * @throws IOException 

     */

    public Band addBand(int pos) throws IOException;

    /**

     * Sustituye una banda completa copiando los datos de la que se pasa por par?metro

     * @param nBand N?mero de banda a sustituir

     * @param banda a copiar

     * @throws OperationNotSupportedException 

     */

    public void copyBand(int nBand, Band band) throws BandNotCompatibleException, OperationNotSupportedException;

    /**

     * Creates a new band assigning other by reference. Owing to this fact, the band 

     * assigned must be the same kind of buffer.

     * @param  nBand 

     *         band number to be assigned

     * @param  banda 

     *         Assigned band

     * @throws IOException 

     */

    public void assignBand(int nBand, Band band) throws IOException, BandNotCompatibleException;

    /**

     * Gets a band from raster by reference.

     * @param  nBand 

     *         Band number 

     */

    public Band getBand(int nBand);

    /**

     * Gets a copy of one band from ra.

     * @param  nBand 

     *         Band number 

     */

    public Band getBandCopy(int nBand);

    /**

     * Gets all bands in an IRasterBand array by reference.

     * @return Array of IRasterBand

     */

    public Band[] getBands();

    /**

     * Gets all bands in an IRasterBand array by reference.

     * @return ArrayList of IRasterBand

     */

    public ArrayList<Band> getBandList();

    /**

     * Gets a buffer with only one band. The number of this band is specified with the parameter.

     * @param  nBand 

     *         Band number

     * @throws IOException 

     * @throws OperationNotSupportedException 

     */

    public Buffer getBufferWithOneBand(int nBand) throws IOException, OperationNotSupportedException;

    /**

     * This method create a new band with the value in selected in

     * the parameter. Settings in the new band are readed from the existing 

     * buffer.

     * @param  defaultValue 

     *         Default value in new band

     * @throws OperationNotSupportedException 

     */

    public Band createBand(double defaultValue) throws OperationNotSupportedException;

    /**

     * Replica la banda de una posici?n sobre otra. Si la banda de destino no existe

     * se crea nueva. Si la posici?n de la banda de destino est? intercalada entre bandas 

     * que ya existen las otras se desplazan hacia abajo, NO se machacan los datos de ninguna.

     * Los datos se replican por referencia por lo que al modificar la banda original las

     * del resto quedar?n afectadas.   

     * @param orig. Posici?n de la banda de origen. 

     * @param dest. Posici?n de la banda destino

     * @throws IOException 

     */   

    public void replicateBand(int orig, int dest) throws IOException;

    /**

     * Clona el buffer actual y devuelve el clone

     * @return Buffer clonado

     */

    public Buffer cloneBuffer();

    /**

     * Swap two bands.

     * @param  band1 

     *         band to swap with band2 

     * @param  band2 

     *         band to swap with band1

     * @throws IOException 

     * @throws WrongParameterException 

     */

    public void swapBands(int band1, int band2) throws WrongParameterException, IOException;

    /**

     * Intercambia la posici?n de las bandas. La nueva posici?n viene dada por el vector

     * pasado por par?metro. Cada posici?n del vector es una banda del buffer y el contenido de 

     * esa posici?n es la banda que se dibujar? sobre ese buffer.

	 * <P> 

     * Por ejemplo un array con los valores:

     * [2, 0, 1] significa que la banda que ocupa ahora la posici?n 2 pasar? a ocupar la 0, la que 

     * tiene la posici?n 0 pasa a ocupar la 1 y la que tiene la posici?n 1 pasa a ocupar la 2.

     * </P>

     * @param bands  Array con la nueva distribuci?n de bandas

     * @throws WrongParameterException 

     * @throws IOException 

     */

    public void swapBands(int[] bands) throws WrongParameterException, IOException;

    /**

     * Asigna el valor de no valido.

     * @param value

     */

    public void setNotValidValue(double value);

    /**

     * Obtiene el valor de no valido.

     * @return value

     */

    public double getNotValidValue();

    /**

     * Asigna una banda al valor especificado como no valido. Esta banda es com?n para todas las bandas

     * del buffer, es decir se asigna por referencia. No tiene el mismo resultado que asignar una banda

     * a un valor fijo.

     * @param iBand N?mero de banda

     * @throws OperationNotSupportedException 

     */

    public void assignBandToNotValid(int iBand) throws OperationNotSupportedException;

	/**

	 * Gets the statistics object

	 * @return BufferStats

	 */

	public BufferStats getStatistics();

	/**

	 * Ajusta el ?rea del grid a un ancho y un alto dado en pixeles. Este ajuste se har? 

	 * en relaci?n a un m?todo de interpolaci?n definido en el par?metro.

	 * @param w Ancho de la nueva imagen.

	 * @param h Alto de la nueva imagen.

	 * @param interpolation M?todo de interpolaci?n que se usar? en el ajuste.

	 */

	public Buffer getAdjustedWindow(int w, int h, int interpolationMethod) throws ProcessInterruptedException;

	/**

	 * Selects bands for read-only buffers which referencing a image in disk

	 * @param bands

	 */

	public void addDrawableBands(int[] bands);

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.cache.buffer.histogram;

import org.gvsig.raster.cache.buffer.exception.HistogramException;

import org.gvsig.raster.cache.buffer.exception.ProcessInterruptedException;

/**

 * 

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public interface HistogramComputer {

	/**

	 * Obtiene el minimo valor de las estadisticas de un histograma.

	 * @return double

	 */

	public double getMinimum();

	/**

	 * Obtiene el maximo valor de las estadisticas de un histograma.

	 * @return double

	 */

	public double getMaximum();

	/**

	 * Obtiene el histograma. 

	 * @return histograma 

	 */

	public BufferHistogram getBufferHistogram(int numberOfClasses) throws HistogramException, ProcessInterruptedException;

	/**

	 * Pone a cero el porcentaje de progreso del proceso de calculo de histograma

	 */

	public void resetPercent();

	/**

	 * Obtiene el porcentaje de progreso del proceso de calculo de histograma

	 * @return porcentaje de progreso

	 */

	public int getPercent();

	/**

	 * Force to recalculate the histogram next time that the method getBufferHistogram

	 * be called 

	 */

	public void refreshHistogram();

}

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.raster.cache.buffer.histogram package documentation</title>

</head>

<body>

	<p>Classes to get a buffer histogram</p>

	<p>

	</p>

</body>

</html>

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.cache.buffer.histogram;

import org.gvsig.raster.cache.buffer.exception.HistogramException;

import org.gvsig.raster.cache.buffer.exception.ProcessInterruptedException;

/**

 * This interface should be implemented for every class that is capable to

 * provide an object to compute its histogram.

 * 

 * @version 27/03/2007

 * @author Nacho Brodin (nachobrodin@gmail.com)

 *

 */

public interface Histogramable {

	/**

	 * Gets the object which computes the histogram

	 * @return Histograma

	 */

	public HistogramComputer getHistogramComputer() throws HistogramException, ProcessInterruptedException;

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.cache.buffer.histogram;

/**

 * Clase que define un intervalo de datos. Es util para cosas como el calculo de histogramas

 * con tipo de datos en coma flotante en el cual hay que dividir los intervalos en

 * clases. Las clases se tendr?n en cuenta como un intervalo el cual el menor es cerrado y el 

 * mayor abierto, es decir

 * <PRE>

 * En las clases:

 * 0-1000

 * 1000-2000

 * los intervalos son 

 * [0, 1000 [  de 0-999.9p

 * [1000, 2000[ de 1000-1999.9p

 * </PRE>

 *  

 * @author Nacho Brodin (nachobrodin@gmail.com)

 *

 */

public interface HistogramClass {	

	/**

	 * Comprueba si el valor pasado por par?metro est? dentro del intervalo

	 * @param value Valor a comprobar

	 * @return true si est? dentro del intervalo y false si no lo est?

	 */

	public boolean isIn(double value);

	/**

	 * Obtiene el valor m?ximo de la clase

	 * @return Entero que representa al valor m?ximo de la clase

	 */

	public double getMax();

	/**

	 * Asigna el valor m?ximo de la clase

	 * @param max Entero que representa al valor m?ximo de la clase

	 */

	public void setMax(double max);

	/**

	 * Obtiene el valor m?nimo de la clase

	 * @return Entero que representa al valor m?nimo de la clase

	 */

	public double getMin();

	/**

	 * ASigna el valor m?nimo de la clase

	 * @param min Entero que representa al valor m?nimo de la clase

	 */

	public void setMin(double min);

	/**

	 * Obtiene el valor de la clase

	 * @return double con el valor

	 */

	public double getValue();

	/**

	 * Asigna el valor de la clase

	 * @param double con el valor

	 */

	public void setValue(double value);

	/**

	 * Incrementa en n el valor especificado

	 * @param double n

	 */

	public void increment(double n);

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.cache.buffer.histogram;

import org.gvsig.raster.cache.buffer.BufferNoData;

/**

 * Interfaz que representa un histograma.

 * 

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public interface BufferHistogram {

	/**

	 * Obtiene el n?mero de bandas del histograma 

	 * @return entero que representa el n?mero de bandas 

	 */

	public int getNumBands();

	/**

	 * Obtiene la longitud (n?mero de valores) de una banda determinada

	 * @param band Banda o obtener la longitud

	 * @return entero con la longitud de la banda

	 * rangos de valores y DataclassList.

	 */

	public int getBandLenght(int band);

	/**

	 * Obtiene el tipo de datos del histograma original

	 * @return

	 */

	public int getDataType();

	/**

	 * Asigna un valor para una posici?n del histograma segun la posicion en las

	 * clases

	 * @param band Valor del pixel o clase a asignar

	 * @param pos Posicion dentro de la clase. Ejemplo 0..63

	 * @param value Valor a asignar

	 */

	public void setHistogramValueByPos(int band, int pos, long value);

	/**

	 * Obtiene un valor del histograma segun la posicion dentro de las clases

	 * @param band N?mero de banda del valor a recuperar

	 * @param px Pixel o valor de la clase del valor a recuperar

	 * @return valor

	 */

	public double getHistogramValueByPos(int band, int pos);

	/**

	 * Obtiene un valor del histograma

	 * @param band N?mero de banda del valor a recuperar

	 * @param px Pixel o valor de la clase del valor a recuperar

	 * @return valor

	 */

	public double getHistogramValue(int band, double px);

	/**

	 * Realiza la uni?n entre el histograma actual y el pasado 

	 * por par?metro.

	 * @param hist

	 */

	public boolean union(BufferHistogram hist);

	/**

	 * Obtiene la tabla de valores

	 * @return

	 */

	public long[][] getTable();

	/**

	 * Asigna la tabla

	 * @param t

	 */

	public void setTable(long[][] t);

	/**

	 * Obtiene el histograma sin modificar

	 * @return array bidimensional donde el primer elemento es el valor del pixel

	 * o rango y el segundo el n?mero de elementos que aparecen.

	 */

	public HistogramClass[][] getHistogram();

	/**

	 * Obtiene el histograma de la imagen negativa.

	 * @return long[][]

	 */

	public long[][] getNegativeTable();

	/**

	 * Devuelve el minimo valor del histograma

	 * @return

	 */

	public double getMin(int band);

	/**

	 * Devuelve el maximo valor del histograma

	 * @return

	 */

	public double getMax(int band);

	/**

	 * Obtiene el n?mero de valores o clases del histograma

	 * @return entero que representa el n?mero de valores o clases del histograma

	 */

	public int getNumValues();

	/**

	 * Devuelve si un histograma esta en un rango RGB aceptable

	 * @return

	 */

	public boolean isInRangeRGB();

	/**

	 * Calculo de estad?sticas a partir de un histograma. El resultado de la funci?n es un array

	 * bidimensional donde el primer ?ndice inndica la estadistica y el segundo el n?mero de banda.

	 * 

	 * <UL>

	 * <LI>m?nimo</LI>

	 * <LI>m?ximo</LI>

	 * <LI>media</LI>

	 * <LI>mediana</LI>

	 * <LI>N?mero de pixels</LI>

	 * </UL>

	 * @param histogram

	 * @param beginPos Posici?n de inicio del histograma para contabilizar estadisticas

	 * @param endPos Posici?n de fin del histograma para contabilizar estadisticas

	 * @param bandas solicitadas. Cada elemento del vector representa una banda. Si est? a true se calcula la 

	 * estadistica para esa banda y si est? a false no se calcular?.

	 * @return

	 */

	public double[][] getBasicStats(double beginPos2, double endPos2, boolean[] bands);

	/**

	 * Calculo de estad?sticas a partir de un histograma. El resultado de la funci?n es un array

	 * bidimensional donde el primer ?ndice inndica la estadistica y el segundo el n?mero de banda.

	 * 

	 * <UL>

	 * <LI>m?nimo</LI>

	 * <LI>m?ximo</LI>

	 * <LI>media</LI>

	 * <LI>mediana</LI>

	 * <LI>N?mero de pixels</LI>

	 * </UL>

	 * @param histogram

	 * @param bandas solicitadas. Cada elemento del vector representa una banda. Si est? a true se calcula la 

	 * estadistica para esa banda y si est? a false no se calcular?.

	 * @return

	 */

	public double[][] getBasicStats(boolean[] bands);

	/**

	 * Adds a new table

	 * @param table

	 */

	public void addTable(long[][] table);

	/**

	 * Incrementa un valor de una posici?n del histograma

	 * @param band N?mero de banda

	 * @param px Pixel o valor de la clase

	 */

	public void incrementPxValue(int band, double px);

	/**

	 * @param noDataValue the noDataValue to set

	 */

	public void setNoDataValue(BufferNoData noDataValue);

}

package org.gvsig.raster.cache.buffer;

/**

 * Interface implemented by a raster band with statistics

 * capabilities. 

 * 

 * @author Nacho Brodin (nachobrodin@gmail.com)

 *

 */

public interface StatsValues {

	/**

	 * Get the maximun value

	 * @return double

	 */

	public double getMax();

	/**

	 * Set the maximun value

	 * @param max

	 */

	public void setMax(double max);

	/**

	 * Get the minimun value

	 * @return double

	 */

	public double getMin();

	/**

	 * Set the minimun value

	 * @param max

	 */

	public void setMin(double min);

	/**

	 * Get the second maximun value

	 * @return double

	 */

	public double getSecondMax();

	/**

	 * Set the second maximun value

	 * @param max

	 */

	public void setSecondMax(double secondMax);

	/**

	 * Get the second minimun value

	 * @return double

	 */

	public double getSecondMin();

	/**

	 * Set the second minimun value

	 * @param max

	 */

	public void setSecondMin(double secondMin);

	/**

	 * Get the maximun value in a eight bits band.

	 * A value of eight bits has a range betwen -127 and 128.

	 * The maximun is readed in a range betwen 0 and 255.

	 * @return

	 */

	public double getMaxRGB();

	/**

	 * Set the maximun value in a eight bits band.

	 * A value of eight bits has a range betwen -127 and 128.

	 * The maximun is writed in a range betwen 0 and 255.

	 * @return

	 */

	public void setMaxRGB(double maxRGB);

	/**

	 * Get the minimun value in a eight bits band.

	 * A value of eight bits has a range betwen -127 and 128.

	 * The minimun is readed in a range betwen 0 and 255.

	 * @return

	 */

	public double getMinRGB();

	/**

	 * Set the minimun value in a eight bits band.

	 * A value of eight bits has a range betwen -127 and 128.

	 * The minimun is readed in a range betwen 0 and 255.

	 * @param  minRGB

	 */

	public void setMinRGB(double minRGB);

	/**

	 * Get the second maximun value in a eight bits band.

	 * A value of eight bits has a range betwen -127 and 128.

	 * The second maximun is readed in a range betwen 0 and 255.

	 * @return

	 */

	public double getSecondMaxRGB();

	/**

	 * Set the second maximun value in a eight bits band.

	 * A value of eight bits has a range betwen -127 and 128.

	 * The second maximun is writed in a range betwen 0 and 255.

	 * @return

	 */

	public void setSecondMaxRGB(double secondMaxRGB);

	/**

	 * Get the second minimun value in a eight bits band.

	 * A value of eight bits has a range betwen -127 and 128.

	 * The second minimun is readed in a range betwen 0 and 255.

	 * @return

	 */

	public double getSecondMinRGB();

	/**

	 * Set the second minimun value in a eight bits band.

	 * A value of eight bits has a range betwen -127 and 128.

	 * The second minimun is readed in a range betwen 0 and 255.

	 * @param  minRGB

	 */

	public void setSecondMinRGB(double secondMinRGB);

	/**

	 * Get the mean value in this band

	 * @return

	 */

	public double getMean();

	/**

	 * Get the mean value in this band

	 * @param mean

	 */

	public void setMean(double mean);

}

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.raster.cache.buffer.exception package documentation</title>

</head>

<body>

	<p>Exceptions which are thrown by a wrong buffer access</p>

	<p>

	</p>

</body>

</html>

package org.gvsig.raster.cache.buffer.exception;

/**

 * Excepci?n lanzada cuando se detecta que un buffer de raster es incorrecto.

 * @author Nacho Brodin (nachobrodin@gmail.com)

 *

 */

public class BufferInvalidException extends Exception{

	private static final long serialVersionUID = -1566113755637911586L;

	public BufferInvalidException(String msg){

		super(msg);

	}

}

package org.gvsig.raster.cache.buffer.exception;

/**

 * Excepci?n lanzada cuando se detecta un acceso a un tipo de datos incorrecto

 * en un RasterBuffer.

 * @author Nacho Brodin (nachobrodin@gmail.com)

 *

 */

public class BufferInvalidAccessException extends Exception{

	private static final long serialVersionUID = -3065331336250589153L;

	public BufferInvalidAccessException(String msg){

		super(msg);

	}

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.cache.buffer.exception;

import org.gvsig.tools.exception.BaseException;

/**

 * Excepci?n lanzada cuando se interrumpe un proceso

 * 

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public class ProcessInterruptedException extends BaseException {

	private static final long serialVersionUID = 666908550965442025L;

	public ProcessInterruptedException(Throwable e){

		super(e.getMessage(), e, "", 0);

	}

	public ProcessInterruptedException(String msg){

		super(msg, "", 0);

	}

}

package org.gvsig.raster.cache.buffer.exception;

/**

 * This exception is throwed when a selected band is not compatible with other or

 * with a databuffer.

 * 

 * 24/10/2008

 * @author Nacho Brodin nachobrodin@gmail.com

 */

public class BandNotCompatibleException  extends Exception {

	private static final long serialVersionUID = -4312548276663417111L;

	public BandNotCompatibleException(String msg) {

		super(msg);

	}

}

package org.gvsig.raster.cache.buffer.exception;

/**

 * This exception is throwed when a selected operation is not compatible with 

 * the buffer

 * 

 * 24/10/2008

 * @author Nacho Brodin nachobrodin@gmail.com

 */

public class OperationNotSupportedException  extends Exception {

	private static final long serialVersionUID = -4312548276663417111L;

	public OperationNotSupportedException(String message, Throwable cause) {

       super(message, cause);

    }

	public OperationNotSupportedException(String msg) {

		super(msg);

	}

}

package org.gvsig.raster.cache.buffer.exception;

/**

 * Excepci?n lanzada cuando el n?mero de p?gina al que se intenta acceder no es valido.

 * @author Nacho Brodin (nachobrodin@gmail.com)

 *

 */

public class InvalidPageNumberException extends Exception {

	private static final long serialVersionUID = -4312548276663417111L;

	public InvalidPageNumberException(String msg){

		super(msg);

	}

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.cache.buffer.exception;

/**

 * Excepci?n lanzada por errores en el calculo de histogramas.

 * 

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public class HistogramException extends Exception {

	private static final long serialVersionUID = 666908550965442025L;

	public HistogramException(String msg, Throwable e) {

		super(msg, e);

	}

	public HistogramException(String msg){

		super(msg);

	}

}

package org.gvsig.raster.cache.buffer.exception;

/**

 * This exception is throwed when a parameter of a function is wrong.

 * 

 * 24/10/2008

 * @author Nacho Brodin nachobrodin@gmail.com

 */

public class WrongParameterException  extends Exception {

	private static final long serialVersionUID = -4312548276663417111L;