Application: gvSIG desktop

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2016 gvSIG Association

 *

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.raster.lib.buffer.api;

import java.awt.image.BufferedImage;

import org.cresques.cts.ICoordTrans;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.geom.exception.CreateEnvelopeException;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.fmap.geom.primitive.Point;

import org.gvsig.raster.lib.buffer.api.Band.BandByte;

import org.gvsig.raster.lib.buffer.api.Band.BandDouble;

import org.gvsig.raster.lib.buffer.api.Band.BandFloat;

import org.gvsig.raster.lib.buffer.api.Band.BandInt;

import org.gvsig.raster.lib.buffer.api.Band.BandShort;

import org.gvsig.raster.lib.buffer.api.exceptions.BandException;

import org.gvsig.raster.lib.buffer.api.exceptions.BufferException;

import org.gvsig.raster.lib.buffer.api.statistics.StatisticsCapable;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.locator.LocatorException;

import org.gvsig.tools.observer.Observer;

import org.gvsig.tools.task.SimpleTaskStatus;

/**

 * @author fdiaz

 *

 */

public interface Buffer extends StatisticsCapable, Iterable<Band>, Observer , Disposable {

    public final static int INTERPOLATION_Undefined        = 0;

    public final static int INTERPOLATION_NearestNeighbour = 1;

    public final static int INTERPOLATION_Bilinear         = 2;

    public final static int INTERPOLATION_InverseDistance  = 3;

    public final static int INTERPOLATION_BicubicSpline    = 4;

    public final static int INTERPOLATION_BSpline          = 5;

//    /**

//     * Adds a filter list to buffer

//     *

//     * @param filterList

//     */

//    public void filter(FilterList filterList);

    /**

     * @return Number of buffer bands

     */

    public int getBandCount();

    /**

     * @return Bands of buffer

     */

    public Band[] getBands();

    public BandInfo[] getBandsInfo();

    /**

     * @return the number of columns

     */

    public int getColumns();

    /**

     * @return the number of rows

     */

    public int getRows();

    /**

     * @return Envelope of this buffer

     * @throws CreateEnvelopeException

     * @throws LocatorException

     */

    public Envelope getEnvelope() throws LocatorException, CreateEnvelopeException;

    /**

     * @return Projection of buffer

     */

    public IProjection getProjection();

    /**

     * Returns true if passed as parameter cell is inside of the buffer, else returns false.

     *

     * @param cellX Cell's x position

     * @param cellY Cell's y position

     * @return true if cell is inside, false if it is outside

     */

    public boolean isInside(int cellX, int cellY);

    /**

     * Returns true if passed as parameter point is inside of the buffer, else returns false.

     *

     * @param point

     * @return true if point is inside of this

     */

    public boolean isInside(Point point);

    /**

     * Adds a band

     *

     * @param band

     */

    public void addBand(Band band);

    /**

     * Sets a band in the "pos" position

     *

     * @param pos

     * @param band

     * @throws BandException

     */

    public void setBand(int pos, Band band) throws BandException;

    /**

     * Removes the band in the "pos" position

     *

     * @param pos

     */

    public void removeBand(int pos);

    /**

     * Gets the band in the "pos" position

     *

     * @param pos

     * @return return the band in the "pos" position

     */

    public Band getBand(int pos);

    /**

     *

     * @param pos

     * @return return the band in the "pos" position if the band is of type byte

     */

    public BandByte getBandByte(int pos);

    /**

     * @param pos

     * @return return the band in the "pos" position if the band is of type short

     */

    public BandShort getBandShort(int pos);

    /**

     * @param pos

     * @return return the band in the"pos" position if the band is of type int

     */

    public BandInt getBandInt(int pos);

    /**

     * @param pos

     * @return return the band in the "pos" position if the band is of type float

     */

    public BandFloat getBandFloat(int pos);

    /**

     * @param pos

     * @return return the band in the "pos" position if the band is of type double

     */

    public BandDouble getBandDouble(int pos);

    /**

     * Switches the bands as indicated by the parameter

     *

     * @param positions

     */

    public void switchBands(int[] positions);

    /**

     * Switches two bands

     *

     * @param pos1

     * @param pos2

     */

    public void switchBands(int pos1, int pos2);

    /**

     * Creates a interpolated buffer

     *

     * @param rows

     * @param columns

     * @param interpolationMode

     * @param status

     * @return a interpolated Buffer according the interpolation mode

     * @throws BufferException

     * @throws LocatorException

     */

    public Buffer createInterpolated(int rows, int columns, int interpolationMode, SimpleTaskStatus status) throws LocatorException, BufferException;

    /**

     * Converts buffer using specified coordinate transformation

     *

     * @param ct

     *            Coordinate transformation to convert buffer

     * @param status

     * @return New converted buffer.

     * @throws BufferException If there are problems converting buffer

     */

    public Buffer convert(ICoordTrans ct, SimpleTaskStatus status) throws BufferException;

    /**

     * @return Gets band types of buffer bands

     */

    public int[] getBandTypes();

    public boolean areAllBandsOfTheSameType();

    /**

     * @return Gets NoData object from buffer bands

     */

    public NoData[] getBandNoData();

    /**

     * @param envelope

     * @return A clip of buffer

     * @throws BufferException

     */

    public Buffer clip(Envelope envelope) throws BufferException;

    /**

     * @return Returns X pixel of this buffer.

     * @deprecated use getDimensions().getPixelSizeX()

     */

    public double getPixelSizeX();

    /**

     * @return Returns Y pixel of this buffer.

     * @deprecated use getDimensions().getPixelSizeY()

     */

    public double getPixelSizeY();

    /**

     * @return

     */

    BufferedImage getBufferedImage();

    /**

     * @return

     */

    public BufferDimensions getDimensions();

}