Java プラットフォーム 1.2 API 仕様: クラス Raster

概要

パッケージ

クラス

使用

階層ツリー

推奨されない

インデックス

ヘルプ

Java プラットフォーム 1.2

前のクラス 次のクラス

フレームあり フレームなし

概要: 内部クラス | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

java.awt.image
クラス Raster

java.lang.Object
  |
  +--java.awt.image.Raster

直接の既知のサブクラス:: WritableRaster

public class Raster
extends Object

ピクセルで構成される矩形配列を表現するクラスです。Raster は、サンプル値が格納されている DataBuffer と、指定されたサンプル値を DataBuffer から探し出す方法が記述されている SampleModel をカプセル化します。

Raster は、平面上の特定の矩形領域 (必ずしも (0, 0) を含んでいなくてもよい) を占めるピクセル値を定義します。この矩形は、Raster の境界の矩形といい、getBounds メソッドにより取得され、minX、minY、width、height の値によって定義されます。minX と minY の値は、Raster の左上隅の座標を定義します。境界の矩形外のピクセルを参照すると、例外がスローされたり、Raster に関連付けられている DataBuffer の意図しない要素が参照されることになります。Raster を使用するときは、このような範囲外のアクセスは行わないようにしてください。

SampleModel は、Raster のサンプルが DataBuffer のプリミティブ配列要素に格納される方法を記述します。サンプルは、PixelInterleavedSampleModel や BandedSampleModel のようにデータ要素ごとに 1 つずつ格納することも、SinglePixelPackedSampleModel や MultiPixelPackedSampleModel のように複数の要素を 1 つにまとめて格納することもできます。SampleModel は、サンプルが符号付き拡張形式かどうかも制御します。これにより、符号なしデータを byte、short、int など Java の符号付きデータ型として格納できます。

Raster は平面上のどこにでも存在できますが、SampleModel は (0, 0) から始まる簡易座標系を利用します。このため、Raster は、Raster の座標系と SampleModel の座標系の間でピクセル位置をマッピングできるようにする変換因子を持っています。SampleModel の座標系から Raster の座標系への変換は、getSampleModelTranslateX メソッドと getSampleModelTranslateY メソッドによって取得できます。

Raster はほかの Raster と DataBuffer を共有できますが、このためには、このような Raster を明示的に作成するか、createChild メソッドと createTranslatedChild メソッドを使用します。これらのメソッドによって作成された Raster に対して getParent メソッドを使用すると、作成側 Raster への参照を取得できます。createTranslatedChild や createChild の呼び出しによって作成された Raster でない場合、getParent は null を返します。

createTranslatedChild メソッドは、現在の Raster のすべてのデータを共有する新しい Raster を返します。新しい Raster は、現在の Raster と同じ幅と高さの境界の矩形を占めますが、始点は異なります。たとえば、親の Raster が (10, 10) から (100, 100) までの領域を占める場合、変換後の Raster の領域の始点を (50, 50) に定義したときは、親のピクセル (20, 20) と子のピクセル (60, 60) はこれら 2 つの Raster で共有される DataBuffer で同じ位置を占めます。対応する SampleModel 座標を取得するには、前者の場合はピクセル座標に (-10, -10) が加算されるのに対し、後者の場合は (-50, -50) が加算されます。

Raster の親子間の変換は、親の sampleModelTranslateX と sampleModelTranslateY の値から、子の sampleModelTranslateX と sampleModelTranslateY の値を減算することにより判定できます。

createChild メソッドを使うと、親の境界の矩形 (同じ座標系または変換後の座標系を持つ) のサブセットのみを占める新しい Raster や、親のバンドのサブセットを持つ新しい Raster を作成できます。

コンストラクタはすべて protected です。Raster を作成する方法としては、このクラスで定義されている static な create メソッドの 1 つを使うのが正しい方法です。これらのメソッドを使うと、標準のインタリーブ化された SampleModel、バンド化された SmpleModel、およびパックされた SampleModel を使う Raster のインスタンスが生成され、外部で生成された SampleModel と DataBuffer を結合して作成される場合と比べて効率的に処理できます。

関連項目:: DataBuffer, SampleModel, PixelInterleavedSampleModel, BandedSampleModel, SinglePixelPackedSampleModel, MultiPixelPackedSampleModel

フィールドの概要
`protected DataBuffer`	`dataBuffer` イメージデータを格納する DataBufferです。
`protected int`	`height` この Raster の高さです。
`protected int`	`minX` この Raster の左上隅のピクセルの X 座標です。
`protected int`	`minY` この Raster の左上隅のピクセルの Y 座標です。
`protected int`	`numBands` Raster 内のバンド数です。
`protected int`	`numDataElements` 1 ピクセル当たりの DataBuffer データ要素の数です。
`protected Raster`	`parent` この Raster の親、または null です。
`protected SampleModel`	`sampleModel` この Raster のピクセルが DataBuffer に格納される方法を記述する SampleModel です。
`protected int`	`sampleModelTranslateX` Raster の SampleModel の座標空間から Raster の座標空間への X 変換です。
`protected int`	`sampleModelTranslateY` Raster の SampleModel の座標空間から Raster の座標空間への Y 変換です。
`protected int`	`width` この Raster の幅です。

コンストラクタの概要
`protected`	`Raster(SampleModel sampleModel, DataBuffer dataBuffer, Point origin)` 指定された SampleModel と DataBuffer を持つ Raster を構築します。
`protected`	`Raster(SampleModel sampleModel, DataBuffer dataBuffer, Rectangle aRegion, Point sampleModelTranslate, Raster parent)` 指定された SampleModel、DataBuffer、および親を持つ Raster を構築します。
`protected`	`Raster(SampleModel sampleModel, Point origin)` 指定された SampleModel を持つ Raster を構築します。

メソッドの概要
`static WritableRaster`	`createBandedRaster(DataBuffer dataBuffer, int w, int h, int scanlineStride, int[] bankIndices, int[] bandOffsets, Point location)` 指定された DataBuffer、幅、高さ、走査線ストライド、バンクインデックス、およびバンクオフセットを持つ、BandedSampleModel に基づいた Raster を作成します。
`static WritableRaster`	`createBandedRaster(int dataType, int w, int h, int scanlineStride, int[] bankIndices, int[] bandOffsets, Point location)` 指定されたデータ型、幅、高さ、走査線ストライド、バンクインデックス、およびバンドオフセットを持つ、BandedSampleModel に基づいた Raster を作成します。
`static WritableRaster`	`createBandedRaster(int dataType, int w, int h, int bands, Point location)` 指定されたデータ型、幅、高さ、およびバンド数を持つ、BandedSampleModel に基づいた Raster を作成します。
`Raster`	`createChild(int parentX, int parentY, int width, int height, int childMinX, int childMinY, int[] bandList)` この Raster の DataBuffer のすべてまたは一部を共有する新しい Raster を返します。
`WritableRaster`	`createCompatibleWritableRaster()` この Raster と同じ SampleModel と初期化された新しい DataBuffer を持つ、この Raster と同じサイズで互換性のある WritableRaster を作成します。
`WritableRaster`	`createCompatibleWritableRaster(int w, int h)` 指定されたサイズ、新しい SampleModel、初期化された新しい DataBuffer を持つ、互換性のある WritableRaster を作成します。
`WritableRaster`	`createCompatibleWritableRaster(int x, int y, int w, int h)` 指定された位置 (minX, minY) とサイズ (width, height)、新しい SampleModel、および初期化された新しい DataBuffer を持つ、互換性のある WritableRaster を作成します。
`WritableRaster`	`createCompatibleWritableRaster(Rectangle rect)` rect によって指定される位置 (minX, minY) とサイズ (width, height)、新しい SampleModel、および初期化された新しい DataBuffer を持つ、互換性のある WritableRaster を作成します。
`static WritableRaster`	`createInterleavedRaster(DataBuffer dataBuffer, int w, int h, int scanlineStride, int pixelStride, int[] bandOffsets, Point location)` 指定された DataBuffer、幅、高さ、走査線ストライド、ピクセルストライド、およびバンドオフセットを持つ、PixelInterleavedSampleModel に基づいた Raster を作成します。
`static WritableRaster`	`createInterleavedRaster(int dataType, int w, int h, int scanlineStride, int pixelStride, int[] bandOffsets, Point location)` 指定されたデータ型、幅、高さ、走査線ストライド、ピクセルストライド、およびバンドオフセットを持つ、PixelInterleavedSampleModel に基づいた Raster を作成します。
`static WritableRaster`	`createInterleavedRaster(int dataType, int w, int h, int bands, Point location)` 指定されたデータ型、幅、高さ、およびバンド数を持つ、PixelInterleavedSampleModel に基づいた Raster を作成します。
`static WritableRaster`	`createPackedRaster(DataBuffer dataBuffer, int w, int h, int scanlineStride, int[] bandMasks, Point location)` 指定された DataBuffer、幅、高さ、走査線ストライド、およびバンドマスクを持つ、SinglePixelPackedSampleModel に基づいた Raster を作成します。
`static WritableRaster`	`createPackedRaster(DataBuffer dataBuffer, int w, int h, int bitsPerPixel, Point location)` 指定された DataBuffer、幅、高さ、および 1 ピクセル当たりのビット数を持つ、MultiPixelPackedSampleModel に基づいた Raster を作成します。
`static WritableRaster`	`createPackedRaster(int dataType, int w, int h, int[] bandMasks, Point location)` 指定されたデータ型、幅、高さ、およびバンドマスクを持つ、SinglePixelPackedSampleModel に基づいた Raster を作成します。
`static WritableRaster`	`createPackedRaster(int dataType, int w, int h, int bands, int bitsPerBand, Point location)` 指定されたデータ型、幅、高さ、バンド数、および 1 バンド当たりのビット数を持つ、パックされた SampleModel に基づいた Raster を作成します。
`static Raster`	`createRaster(SampleModel sm, DataBuffer db, Point location)` 指定された SampleModel と DataBuffer を持つ Raster を作成します。
`Raster`	`createTranslatedChild(int childMinX, int childMinY)` この Raster と同じサイズ、SampleModel、および DataBuffer を持ち、位置が異なる Raster を作成します。
`static WritableRaster`	`createWritableRaster(SampleModel sm, DataBuffer db, Point location)` 指定された SampleModel と DataBuffer を持つ WritableRaster を作成します。
`static WritableRaster`	`createWritableRaster(SampleModel sm, Point location)` 指定された SampleModel を持つ WritableRaster を作成します。
`Rectangle`	`getBounds()` この Raster の境界の Rectangle を返します。
`DataBuffer`	`getDataBuffer()` この Raster に関連付けられている DataBuffer を返します。
`Object`	`getDataElements(int x, int y, int w, int h, Object outData)` 指定されたピクセル矩形のピクセルデータを transferType 型のプリミティブ配列として返します。
`Object`	`getDataElements(int x, int y, Object outData)` 1 つのピクセルのデータを transferType 型のプリミティブ配列として返します。
`int`	`getHeight()` Raster の高さをピクセル単位で返します。
`int`	`getMinX()` Raster の有効な最小の X 座標を返します。
`int`	`getMinY()` Raster の有効な最小の Y 座標を返します。
`int`	`getNumBands()` この Raster 内のバンド数 (1 ピクセル当たりのサンプル数) を返します。
`int`	`getNumDataElements()` getDataElements メソッドと setDataElements メソッドにより 1 つのピクセルを転送するために必要なデータ要素の数を返します。
`Raster`	`getParent()` この Raster の親 Raster があればそれを返します。
`double[]`	`getPixel(int x, int y, double[] dArray)` 指定されたピクセルのサンプルを double の配列として返します。
`float[]`	`getPixel(int x, int y, float[] fArray)` 指定されたピクセルのサンプルを float の配列として返します。
`int[]`	`getPixel(int x, int y, int[] iArray)` 指定されたピクセルのサンプルを int の配列として返します。
`double[]`	`getPixels(int x, int y, int w, int h, double[] dArray)` 矩形のピクセルのサンプルすべてを、配列要素ごとに 1 つのサンプルが格納されている double 配列として返します。
`float[]`	`getPixels(int x, int y, int w, int h, float[] fArray)` 矩形のピクセルのサンプルすべてを、配列要素ごとに 1 つのサンプルが格納されている float 配列として返します。
`int[]`	`getPixels(int x, int y, int w, int h, int[] iArray)` 矩形のピクセルのサンプルすべてを、配列要素ごとに 1 つのサンプルが格納されている int 配列として返します。
`int`	`getSample(int x, int y, int b)` (x,y) に位置するピクセルの指定されたバンド内のサンプルを int として返します。
`double`	`getSampleDouble(int x, int y, int b)` (x,y) に位置するピクセルの指定されたバンド内のサンプルを double として返します。
`float`	`getSampleFloat(int x, int y, int b)` (x,y) に位置するピクセルの指定されたバンド内のサンプルを float として返します。
`SampleModel`	`getSampleModel()` イメージデータのレイアウトを記述する SampleModel を返します。
`int`	`getSampleModelTranslateX()` SampleModel の座標系から Raster の座標系への X 変換を返します。
`int`	`getSampleModelTranslateY()` SampleModel の座標系から Raster の座標系への Y 変換を返します。
`double[]`	`getSamples(int x, int y, int w, int h, int b, double[] dArray)` 指定されたピクセル矩形の指定されたバンドのサンプルを、配列要素ごとに 1 つのサンプルが格納されている double 配列として返します。
`float[]`	`getSamples(int x, int y, int w, int h, int b, float[] fArray)` 指定されたピクセル矩形の指定されたバンドのサンプルを、配列要素ごとに 1 つのサンプルが格納されている float 配列として返します。
`int[]`	`getSamples(int x, int y, int w, int h, int b, int[] iArray)` 指定された矩形ピクセルの指定されたバンドのサンプルを、配列要素ごとに 1 つのサンプルが格納されている int 配列として返します。
`int`	`getTransferType()` getDataElements メソッドと setDataElements メソッドにより複数のピクセルを転送するために必要な transferType を返します。
`int`	`getWidth()` Raster の幅をピクセル単位で返します。

クラス java.lang.Object から継承したメソッド

clone, 
equals, 
finalize, 
getClass, 
hashCode, 
notify, 
notifyAll, 
toString, 
wait, 
wait, 
wait

フィールドの詳細

sampleModel

protected SampleModel sampleModel

この Raster のピクセルが DataBuffer に格納される方法を記述する SampleModel です。

dataBuffer

protected DataBuffer dataBuffer

イメージデータを格納する DataBufferです。

minX

protected int minX

この Raster の左上隅のピクセルの X 座標です。

minY

protected int minY

この Raster の左上隅のピクセルの Y 座標です。

width

protected int width

この Raster の幅です。

height

protected int height

この Raster の高さです。

sampleModelTranslateX

protected int sampleModelTranslateX

Raster の SampleModel の座標空間から Raster の座標空間への X 変換です。

sampleModelTranslateY

protected int sampleModelTranslateY

Raster の SampleModel の座標空間から Raster の座標空間への Y 変換です。

numBands

protected int numBands

Raster 内のバンド数です。

numDataElements

protected int numDataElements

1 ピクセル当たりの DataBuffer データ要素の数です。

parent

protected Raster parent

この Raster の親、または null です。

コンストラクタの詳細

Raster

protected Raster(SampleModel sampleModel,
                 Point origin)

指定された SampleModel を持つ Raster を構築します。Raster は左上隅が原点で、SampleModel と同じサイズです。Raster を記述するために十分な大きさの DataBuffer が自動的に作成されます。

パラメータ:: sampleModel - レイアウトを指定する SampleModel; origin - 原点を指定する Point

Raster

protected Raster(SampleModel sampleModel,
                 DataBuffer dataBuffer,
                 Point origin)

指定された SampleModel と DataBuffer を持つ Raster を構築します。Raster は左上隅が原点で、SampleModel と同じサイズです。DataBuffer は初期化されず、SampleModel と互換性があります。

パラメータ:: sampleModel - レイアウトを指定する SampleModel; dataBuffer - イメージデータが格納されている DataBuffer; origin - 原点を指定する Point

Raster

protected Raster(SampleModel sampleModel,
                 DataBuffer dataBuffer,
                 Rectangle aRegion,
                 Point sampleModelTranslate,
                 Raster parent)

指定された SampleModel、DataBuffer、および親を持つ Raster を構築します。aRegion には、新しい Raster の境界の矩形を指定します。aRegion は、ベース Raster の座標系に変換されたときに、ベース Raster によって包含されなければなりません (ベース Raster は、Raster の祖先であり、親を持たない)。sampleModelTranslate には、新しい Raster の sampleModelTranslateX と sampleModelTranslateY の値を指定します。このコンストラクタは、通常、ほかのコンストラクタまたは create メソッドによって呼び出されるものであり、直接使用することはありません。

パラメータ:: sampleModel - レイアウトを指定する SampleModel; dataBuffer - イメージデータが格納されている DataBuffer; aRegion - イメージ領域を指定する Rectangle; sampleModelTranslate - SampleModel から Raster への座標変換を指定する Point; parent - このラスタの親 (存在する場合)

メソッドの詳細

createInterleavedRaster

public static WritableRaster createInterleavedRaster(int dataType,
                                                     int w,
                                                     int h,
                                                     int bands,
                                                     Point location)

指定されたデータ型、幅、高さ、およびバンド数を持つ、PixelInterleavedSampleModel に基づいた Raster を作成します。

Raster の左上隅は location 引数によって指定されます。location が null の場合は、(0, 0) が使用されます。dataType パラメータは、DataBuffer クラスで定義される、列挙された値の 1 つです。