001/* PixelInterleavedSampleModel.java
002   Copyright (C) 2004, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.awt.image;
039
040
041/**
042 * A <code>SampleModel</code> that uses exactly one element of the
043 * raster&#x2019;s {@link DataBuffer} per pixel, holds all bands in a
044 * single bank, and stores band data in pixel-interleaved manner.
045 *
046 * @since 1.2
047 *
048 * @author Sascha Brawer (brawer@dandelis.ch)
049 */
050public class PixelInterleavedSampleModel
051  extends ComponentSampleModel
052{
053  public PixelInterleavedSampleModel(int dataType, int width, int height,
054                                     int pixelStride, int scanlineStride,
055                                     int[] bandOffsets)
056  {
057    super(dataType, width, height, pixelStride, scanlineStride,
058          bandOffsets);
059  }
060
061
062  /**
063   * Creates a new <code>SampleModel</code> that is like this one, but
064   * uses the specified width and height.
065   *
066   * @param width the number of pixels in the horizontal direction.
067   *
068   * @param height the number of pixels in the vertical direction.
069   */
070  public SampleModel createCompatibleSampleModel(int width, int height)
071  {
072    // Find minimum band offset.
073    int minBandoff = bandOffsets[0];
074    int numBands = bandOffsets.length;
075    for (int i = 1; i < numBands; i++)
076      {
077        if (bandOffsets[i] < minBandoff)
078          {
079            minBandoff = bandOffsets[i];
080          }
081      }
082    // Adjust band offsets so that minimum offset is at 0.
083    int[] bandOff;
084    if (minBandoff > 0)
085      {
086        bandOff = new int[numBands];
087        for (int i = 0; i < numBands; i++)
088          {
089            bandOff[i] = bandOffsets[i] - minBandoff;
090          }
091      }
092    else
093      {
094        bandOff = bandOffsets;
095      }
096    // Adjust scanline stride for new width.
097    return new PixelInterleavedSampleModel(dataType, width, height,
098                                           pixelStride, pixelStride * width,
099                                           bandOff);
100  }
101
102
103  /**
104   * Creates a new <code>SampleModel</code> that is like this one, but
105   * uses only a subset of its bands.
106   *
107   * @param bands an array whose elements indicate which bands shall
108   * be part of the subset. For example, <code>[0, 2, 3]</code> would
109   * create a SampleModel containing bands #0, #2 and #3.
110   */
111  public SampleModel createSubsetSampleModel(int[] bands)
112  {
113    int[] subOffsets;
114
115    subOffsets = new int[bands.length];
116    for (int i = 0; i < bands.length; i++)
117      subOffsets[i] = bandOffsets[bands[i]];
118
119    return new PixelInterleavedSampleModel(dataType, width, height,
120                                           pixelStride, scanlineStride,
121                                           subOffsets);
122  }
123}