Statistics
| Revision:

svn-gvsig-desktop / trunk / libraries / libRaster / src / org / gvsig / raster / dataset / IStatistics.java @ 11067

History | View | Annotate | Download (3.57 KB)

1
/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana
2
 *
3
 * Copyright (C) 2006 IVER T.I. and Generalitat Valenciana.
4
 *
5
 * This program is free software; you can redistribute it and/or
6
 * modify it under the terms of the GNU General Public License
7
 * as published by the Free Software Foundation; either version 2
8
 * of the License, or (at your option) any later version.
9
 *
10
 * This program is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 * GNU General Public License for more details.
14
 *
15
 * You should have received a copy of the GNU General Public License
16
 * along with this program; if not, write to the Free Software
17
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.
18
 */
19
package org.gvsig.raster.dataset;
20

    
21
/**
22
 * Interfaz a implementar por las clases que ofrecen estadisticas raster.
23
 *  
24
 * @author Nacho Brodin (nachobrodin@gmail.com)
25
 */
26
public interface IStatistics{
27
        
28
        /**
29
         * Obtiene el valor m?ximo
30
         * @return Valor m?ximo
31
         */
32
        public double[] getMax();
33
        
34
        /**
35
         * Obtiene el valor del segundo m?ximo
36
         * @return Valor del segundo m?ximo
37
         */
38
        public double[] getSecondMax();
39
        
40
        /**
41
         * Obtiene el valor del segundo m?nimo
42
         * @return Valor del segundo m?nimo
43
         */
44
        public double[] getSecondMin();
45
        
46
        /**
47
         * Devuelve el m?ximo valor de todos los m?ximos de las bandas
48
         * @return M?ximo
49
         */
50
        public double getMaximun();
51
        
52
        /**
53
         * Devuelve el m?nimo valor de todos los m?nimos de las bandas
54
         * @return M?ximo
55
         */
56
        public double getMinimun();
57

    
58
        /**
59
         * Obtiene el valor m?dio
60
         * @return Valor medio
61
         */
62
        public double[] getMean();
63

    
64
        /**
65
         * Obtiene el valor m?ximo
66
         * @return Valor m?nimo
67
         */
68
        public double[] getMin();
69

    
70
        /**
71
         * Obtiene la varianza
72
         * @return Varianza
73
         */
74
        public double[] getVariance();
75
        
76
        /**
77
         * N?mero de bandas
78
         * @return
79
         */
80
        public int getBandCount();
81
        
82
        /**
83
         * Asigna un valor de recorte de colas para un porcentaje dado. El valor ser? un array 
84
         * bidimensional ([N?mero de bandas][2]) donde para cada banda se almacena el valor en
85
         * esa posici?n del recorte de colas. Este recorte consiste en ordenar los elementos del 
86
         * raster (o una muestra de ellos) y devolver el valor que corresponde al porcentaje comenzando
87
         * desde el principio del array ordenado y desde el final de ?l (m?nimo y m?ximo).
88
         * @param percent Porcentaje de recorte
89
         * @param valueByBand array bidimensional de enteros o doubles. Depende del tipo de dato del raster.
90
         */
91
        public void setTailTrimValue(double percent, Object valueByBand);
92
        
93
        /**
94
         * Asigna un valor de recorte de colas para un porcentaje dado. El valor ser? un array 
95
         * bidimensional ([N?mero de bandas][2]) donde para cada banda se almacena el valor en
96
         * esa posici?n del recorte de colas. Este recorte consiste en ordenar los elementos del 
97
         * raster (o una muestra de ellos) y devolver el valor que corresponde al porcentaje comenzando
98
         * desde el principio del array ordenado y desde el final de ?l (m?nimo y m?ximo).
99
         * @param percent Porcentaje de recorte
100
         * @param valueByBand array bidimensional de enteros o doubles. Depende del tipo de dato del raster.
101
         */
102
        public Object getTailTrimValue(double percent);
103
        
104
        /**
105
         * Calcula las estadisticas recorriendo todo el fichero.
106
         */
107
        public void calcFullStatistics()throws FileNotOpenException, RasterDriverException;
108
        
109
        /**
110
         * Obtiene el flag que informa de si las estad?sticas est?n calculadas o no.
111
         * @return true indica que est?n calculadas y false que no lo est?n
112
         */
113
        public boolean isCalculated();
114
}