java.awt.image

Class PixelInterleavedSampleModel


public class PixelInterleavedSampleModel
extends ComponentSampleModel

A SampleModel that uses exactly one element of the raster’s DataBuffer per pixel, holds all bands in a single bank, and stores band data in pixel-interleaved manner.
Since:
1.2

Field Summary

Fields inherited from class java.awt.image.ComponentSampleModel

bandOffsets, bankIndices, numBands, numBanks, pixelStride, scanlineStride

Fields inherited from class java.awt.image.SampleModel

dataType, height, numBands, width

Constructor Summary

PixelInterleavedSampleModel(int dataType, int width, int height, int pixelStride, int scanlineStride, int[] bandOffsets)
Creates a new sample model that assumes that all bands are stored in a single bank of the DataBuffer.

Method Summary

SampleModel
createCompatibleSampleModel(int width, int height)
Creates a new SampleModel that is like this one, but uses the specified width and height.
SampleModel
createSubsetSampleModel(int[] bands)
Creates a new SampleModel that is like this one, but uses only a subset of its bands.

Methods inherited from class java.awt.image.ComponentSampleModel

createCompatibleSampleModel, createDataBuffer, createSubsetSampleModel, equals, getBandOffsets, getBankIndices, getDataElements, getNumDataElements, getOffset, getOffset, getPixel, getPixelStride, getPixels, getSample, getSampleSize, getSampleSize, getScanlineStride, hashCode, setDataElements, setPixel, setSample

Methods inherited from class java.awt.image.SampleModel

createCompatibleSampleModel, createDataBuffer, createSubsetSampleModel, getDataElements, getDataElements, getDataType, getHeight, getNumBands, getNumDataElements, getPixel, getPixel, getPixel, getPixels, getPixels, getPixels, getSample, getSampleDouble, getSampleFloat, getSampleSize, getSampleSize, getSamples, getSamples, getSamples, getTransferType, getWidth, setDataElements, setDataElements, setPixel, setPixel, setPixel, setPixels, setPixels, setPixels, setSample, setSample, setSample, setSamples, setSamples, setSamples

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PixelInterleavedSampleModel

public PixelInterleavedSampleModel(int dataType,
                                   int width,
                                   int height,
                                   int pixelStride,
                                   int scanlineStride,
                                   int[] bandOffsets)
Creates a new sample model that assumes that all bands are stored in a single bank of the DataBuffer.

Note that the bandOffsets array is copied to internal storage to prevent subsequent changes to the array from affecting this object.

Parameters:
dataType - the data type (one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_FLOAT or DataBuffer.TYPE_DOUBLE).
pixelStride - the number of data elements in the step from a sample in one pixel to the corresponding sample in the next pixel.
scanlineStride - the number of data elements in the step from a sample in a pixel to the corresponding sample in the pixel in the next row.
bandOffsets - the offset to the first element for each band, with the size of the array defining the number of bands (null not permitted).
Throws:
IllegalArgumentException - if dataType is not one of the specified values.
IllegalArgumentException - if w is less than or equal to zero.
IllegalArgumentException - if h is less than or equal to zero.
IllegalArgumentException - if w * h exceeds Integer.MAX_VALUE.
IllegalArgumentException - if pixelStride is negative.
IllegalArgumentException - if scanlineStride is less than or equal to zero.
IllegalArgumentException - if bandOffsets has zero length.

Method Details

createCompatibleSampleModel

public SampleModel createCompatibleSampleModel(int width,
                                               int height)
Creates a new SampleModel that is like this one, but uses the specified width and height.
Overrides:
createCompatibleSampleModel in interface ComponentSampleModel
Parameters:
width - the number of pixels in the horizontal direction.
height - the number of pixels in the vertical direction.

createSubsetSampleModel

public SampleModel createSubsetSampleModel(int[] bands)
Creates a new SampleModel that is like this one, but uses only a subset of its bands.
Overrides:
createSubsetSampleModel in interface ComponentSampleModel
Parameters:
bands - an array whose elements indicate which bands shall be part of the subset. For example, [0, 2, 3] would create a SampleModel containing bands #0, #2 and #3.

PixelInterleavedSampleModel.java Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath 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, or (at your option) any later version. GNU Classpath 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 GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.