Application: gvSIG desktop » gvSIG raster

/* 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.fmap.dal.coverage.store.props;

import org.gvsig.tools.persistence.Persistent;

/**

 * Interfaz que representa una interpretaci?n de color.

 * 

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

 */

public interface ColorInterpretation extends Persistent {

        // Identificadores de color interpretation

        public static final String RED_BAND            = "Red";

        public static final String GREEN_BAND          = "Green";

        public static final String BLUE_BAND           = "Blue";

        public static final String ALPHA_BAND          = "Alpha";

        public static final String GRAY_BAND           = "Gray";

        public static final String PAL_BAND            = "Palette";

        public static final String UNDEF_BAND          = "Undefined";

        public static final String RED_GREEN_BAND      = "Red_Green";

        public static final String RED_BLUE_BAND       = "Red_Blue";

        public static final String GREEN_BLUE_BAND     = "Green_Blue";

        //Constants to initialize the color interpretation

        public static final String RGB                 = "RGB";

        public static final String BGR                 = "BGR";

        public static final String ARGB                = "ARGB";

        public static final String GRAYSCALE           = "GRAYSCALE";

        public static final String PALETTE             = "PALETTE";

        /**

         * Asigna un valor para la interpretaci?n de color de una banda

         * @param band Banda 

         * @param value valor

         */

        public void setColorInterpValue(int band, String value);

        /**

         * Obtiene el n?mero de entradas de interpretaci?n de color por

         * banda en la lista.

         * @return

         */

        public int length();

        /**

         * Returns true if the values Red, Green and Blue are

         * assigned to any band of the image or the values Gray or Palette are

         * assigned.

         * @return

         */

        public boolean hasInterpretation();

        /**

         * Returns true if the color interpretation is BGR, that is, the 

         * three first bands of the image are Blue, Green and Red.

         * @return

         */

        public boolean isBGR();

        /**

         * Returns true if the color interpretation is RGB, that is, the 

         * three first bands of the image are Red, Green and Blue.

         * @return

         */

        public boolean isRGB();

        /**

         * Returns true if the color interpretation is ARGB, that is, the 

         * four first bands of the image are Red, Green, Blue and Alpha.

         * @return

         */

        public boolean isRGBA();

        /**

         * Returns true if the color interpretation is Palette

         * @return

         */

        public boolean isPalette();

        /**

         * Returns true if the selected band has red, green or blue interpretation and false otherwise

         * @param band

         * @return

         */

        public boolean isColorInterpretation(int band);

        /**

         * Returns true if the selected band has gray interpretation and false otherwise

         * @param band

         * @return

         */

        public boolean isGrayInterpretation(int band);

        /**

         * Returns true if the selected band has alpha interpretation and false otherwise

         * @param band

         * @return

         */

        public boolean isAlphaInterpretation(int band);

        /**

         * Obtiene el valor de interpretaci?n de color de la entrada i. 

         * @param i N?mero de entrada

         * @return interpretaci?n de color para la entrada solicitada

         */

        public String get(int i);

        /**

         * Obtiene la posici?n de la banda que contiene el identificador pasado por par?metro 

         * o -1 si no tiene dicho identificador.

         * @return Posici?n de la banda que contiene el identificador o -1 si no lo tiene.

         */

        public int getBand(String id);

        /**

         * Consulta si la interpretaci?n de color est? por definir en la imagen.

         * @return true si no hay interpretaci?n de color definida y false si la hay

         */

        public boolean isUndefined();

        /**

         * Inicializa el vector de cadenas que contendr?n el nombre de la interpretaci?n 

         * de color asignada a cada banda. Este valor es el devuelto por la imagen.

         * @param values N?mero de valores

         */

        public void initColorInterpretation(int values);

        /**

         * Obtiene los valores de la interpretaci?n de color

         * @return String[]

         */

        public String[] getValues();

        /**

         * Returns true if one band has the "Alpha" label

         * @return

         */

        public boolean hasAlphaBand();

        /**

         * Returns the number of band with the label "Alpha"

         * @return

         */

        public int getAlphaBand();

        /**

         * A?ade un objeto DatasetColorInterpretation al actual. El resultado es la suma 

         * de ambos.

         * @param ci

         */

        public void addColorInterpretation(ColorInterpretation ci);

        /**

         * Returns an array with bands to render reading values of this color

         * interpretation object. Each element in the array represents band in the destination buffer

         * . The value in this position represents the source band which will be write 

         * in the destination buffer 

         * @return

         */

        public int[] buildRenderBands();

        /**

         * Clones this object

         * @return

         */

        public ColorInterpretation cloneColorInterpretation();

}