Класс SinglePixelPackedSampleModel

java.lang.Object

java.awt.image.SampleModel

java.awt.image.SinglePixelPackedSampleModel

public class SinglePixelPackedSampleModel extends SampleModel

Этот класс представляет данные пикселей, упакованные таким образом, что N образцов, составляющих один пиксель, хранятся в одном элементе массива данных, и каждый элемент массива данных содержит образцы только для одного пикселя. Этот класс поддерживает типы данных TYPE_BYTE, TYPE_USHORT, TYPE_INT. Все элементы массива данных находятся в первом банке DataBuffer. Предоставляются методы-обработчики, позволяющие непосредственно манипулировать данными изображения. Шаг строки сканирования — это количество элементов массива данных между заданным образцом и соответствующим образцом в той же колонке следующей строки сканирования. Маски битов — это маски, необходимые для извлечения образцов, представляющих полосы пикселя. Битовые смещения — это смещения в битах внутри элемента массива данных образцов, представляющих полосы пикселя.

Следующий код иллюстрирует извлечение битов образца, представляющего полосу b для пикселя x,y из DataBuffer data:


      int sample = data.getElem(y * scanlineStride + x);
      sample = (sample & bitMasks[b]) >>> bitOffsets[b];

Краткое описание полей

Поля, объявленные в классе java.awt.image.SampleModel

dataType, height, numBands, width

Краткое описание конструкторов

Конструктор	Описание
`SinglePixelPackedSampleModel(int dataType, int w, int h, int[] bitMasks)`	Создаёт SinglePixelPackedSampleModel с полосами, равными длине bitMasks.
`SinglePixelPackedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bitMasks)`	Создаёт SinglePixelPackedSampleModel с полосами, равными длине bitMasks, и шагом строки сканирования, равным scanlineStride элементам массива данных.

Краткое описание методов

Модификатор и тип	Метод	Описание
`SampleModel`	`createCompatibleSampleModel(int w, int h)`	Создаёт новый SinglePixelPackedSampleModel с заданной шириной и высотой.
`DataBuffer`	`createDataBuffer()`	Создаёт DataBuffer, соответствующий этому SinglePixelPackedSampleModel.
`SampleModel`	`createSubsetSampleModel(int[] bands)`	Создаёт новый SinglePixelPackedSampleModel с подмножеством полос этого SinglePixelPackedSampleModel.
`int[]`	`getBitMasks()`	Возвращает маски битов для всех полос.
`int[]`	`getBitOffsets()`	Возвращает смещения битов в элементе массива данных, представляющие пиксель для всех полос.
`Object`	`getDataElements(int x, int y, Object obj, DataBuffer data)`	Возвращает данные для одного пикселя в примитивном массиве типа TransferType.
`int`	`getNumDataElements()`	Возвращает количество элементов данных, необходимых для передачи одного пикселя через методы getDataElements и setDataElements.
`int`	`getOffset(int x, int y)`	Возвращает смещение (в элементах массива данных) пикселя (x,y).
`int[]`	`getPixel(int x, int y, int[] iArray, DataBuffer data)`	Возвращает все образцы для указанного пикселя в массиве int.
`int[]`	`getPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)`	Возвращает все образцы для указанного прямоугольника пикселей в массиве int, по одному образцу на элемент массива.
`int`	`getSample(int x, int y, int b, DataBuffer data)`	Возвращает образец в указанной полосе для пикселя, расположенного в координатах (x,y), как int.
`int[]`	`getSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)`	Возвращает образцы для указанной полосы для указанного прямоугольника пикселей в массиве int, по одному образцу на элемент массива.
`int[]`	`getSampleSize()`	Возвращает количество бит на образец для всех полос.
`int`	`getSampleSize(int band)`	Возвращает количество бит на образец для указанной полосы.
`int`	`getScanlineStride()`	Возвращает шаг строки сканирования этого SinglePixelPackedSampleModel.
`void`	`setDataElements(int x, int y, Object obj, DataBuffer data)`	Устанавливает данные для одного пикселя в указанном DataBuffer из примитивного массива типа TransferType.
`void`	`setPixel(int x, int y, int[] iArray, DataBuffer data)`	Устанавливает пиксель в DataBuffer, используя массив int для ввода образцов.
`void`	`setPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)`	Устанавливает все образцы для прямоугольника пикселей из массива int, содержащего по одному образцу на элемент массива.
`void`	`setSample(int x, int y, int b, int s, DataBuffer data)`	Устанавливает образец в указанной полосе для пикселя, расположенного в координатах (x,y) в DataBuffer, используя int для ввода.
`void`	`setSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)`	Устанавливает образцы в указанной полосе для указанного прямоугольника пикселей из массива int, содержащего по одному образцу на элемент массива.

Методы, объявленные в классе java.awt.image.SampleModel

getDataElements, getDataType, getHeight, getNumBands, getPixel, getPixel, getPixels, getPixels, getSampleDouble, getSampleFloat, getSamples, getSamples, getTransferType, getWidth, setDataElements, setPixel, setPixel, setPixels, setPixels, setSample, setSample, setSamples, setSamples

Методы, объявленные в классе java.lang.Object

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

Краткое описание конструкторов

SinglePixelPackedSampleModel

public SinglePixelPackedSampleModel(int dataType, int w, int h, int[] bitMasks)

Создает SinglePixelPackedSampleModel с bitMasks.length полосами. Каждый образец хранится в элементе массива данных в позиции своей соответствующей битовой маски. Каждая битовая маска должна быть непрерывной, и маски не должны перекрываться. Битовые маски, превышающие емкость типа данных, усекаются.

Параметры:: dataType - Тип данных для хранения образцов.; w - Ширина (в пикселях) области данных изображения.; h - Высота (в пикселях) области данных изображения.; bitMasks - Битовые маски для всех полос.
Исключения:: IllegalArgumentException - если dataType не является ни DataBuffer.TYPE_BYTE, ни DataBuffer.TYPE_USHORT, ни DataBuffer.TYPE_INT

SinglePixelPackedSampleModel

public SinglePixelPackedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bitMasks)

Создает SinglePixelPackedSampleModel с bitMasks.length полосами и шагом строки, равным scanlineStride элементам массива данных. Каждый образец хранится в элементе массива данных в позиции своей соответствующей битовой маски. Каждая битовая маска должна быть непрерывной, и маски не должны перекрываться. Битовые маски, превышающие емкость типа данных, усекаются.

Параметры:: dataType - Тип данных для хранения образцов.; w - Ширина (в пикселях) области данных изображения.; h - Высота (в пикселях) области данных изображения.; scanlineStride - Шаг строки данных изображения.; bitMasks - Битовые маски для всех полос.
Исключения:: IllegalArgumentException - если w или h не больше 0; IllegalArgumentException - если какая-либо маска в bitMask не является непрерывной; IllegalArgumentException - если dataType не является ни DataBuffer.TYPE_BYTE, ни DataBuffer.TYPE_USHORT, ни DataBuffer.TYPE_INT

Подробное описание методов

getNumDataElements

public int getNumDataElements()

Возвращает количество элементов данных, необходимых для передачи одного пикселя с помощью методов getDataElements и setDataElements. Для SinglePixelPackedSampleModel это равно одному.

Указано в:

getNumDataElements в классе SampleModel

Возвращает:

количество элементов данных.

См. также:

createCompatibleSampleModel

public SampleModel createCompatibleSampleModel(int w, int h)

Создает новый SinglePixelPackedSampleModel с указанной шириной и высотой. Новый SinglePixelPackedSampleModel будет иметь тот же тип данных хранилища и битовые маски, что и этот SinglePixelPackedSampleModel.

Указано в:: createCompatibleSampleModel в классе SampleModel
Параметры:: w - ширина результирующего SampleModel; h - высота результирующего SampleModel
Возвращает:: SinglePixelPackedSampleModel с указанной шириной и высотой.
Исключения:: IllegalArgumentException - если w или h не больше 0

createDataBuffer

public DataBuffer createDataBuffer()

Создает DataBuffer, который соответствует этому SinglePixelPackedSampleModel. Тип данных и размер DataBuffer будут согласованы с этим SinglePixelPackedSampleModel. DataBuffer будет иметь один банк.

Указано в:: createDataBuffer в классе SampleModel
Возвращает:: DataBuffer соответствующий этому SampleModel.

getSampleSize

public int[] getSampleSize()

Возвращает количество бит на образец для всех полос.

Указано в:: getSampleSize в классе SampleModel
Возвращает:: размер образцов для всех полос.

getSampleSize

public int getSampleSize(int band)

Возвращает количество бит на образец для указанной полосы.

Указано в:: getSampleSize в классе SampleModel
Параметры:: band - указанная полоса
Возвращает:: размер образцов указанной полосы.

getOffset

public int getOffset(int x, int y)

Возвращает смещение (в элементах массива данных) пикселя (x,y). Элемент данных, содержащий пиксель x,y, может быть извлечен из DataBuffer data с SinglePixelPackedSampleModel sppsm как:

        data.getElem(sppsm.getOffset(x, y));

Параметры:: x - координата X указанного пикселя; y - координата Y указанного пикселя
Возвращает:: смещение указанного пикселя.

getBitOffsets

public int[] getBitOffsets()

Возвращает битовые смещения в элементе массива данных, представляющем пиксель для всех полос.

Возвращает:: битовые смещения, представляющие пиксель для всех полос.

getBitMasks

public int[] getBitMasks()

Возвращает битовые маски для всех полос.

Возвращает:: битовые маски для всех полос.

getScanlineStride

public int getScanlineStride()

Возвращает шаг строки этого SinglePixelPackedSampleModel.

Возвращает:: шаг строки этого SinglePixelPackedSampleModel.

createSubsetSampleModel

public SampleModel createSubsetSampleModel(int[] bands)

Это создает новый SinglePixelPackedSampleModel с подмножеством полос этого SinglePixelPackedSampleModel. Новый SinglePixelPackedSampleModel может использоваться с любым DataBuffer, с которым может использоваться существующий SinglePixelPackedSampleModel. Новая комбинация SinglePixelPackedSampleModel/DataBuffer будет представлять изображение с подмножеством полос исходной комбинации SinglePixelPackedSampleModel/DataBuffer.

Указано в:: createSubsetSampleModel в классе SampleModel
Параметры:: bands - подмножество полос этого SampleModel
Возвращает:: SampleModel с подмножеством полос этого SampleModel.
Исключения:: RasterFormatException - если длина аргумента полос больше, чем количество полос в модели образца.

getDataElements

public Object getDataElements(int x, int y, Object obj, DataBuffer data)

Возвращает данные для одного пикселя в примитивном массиве типа TransferType. Для SinglePixelPackedSampleModel массив будет иметь один элемент, и тип будет таким же, как тип данных хранилища. Как правило, obj должен передаваться как null, чтобы объект был создан автоматически и имел правильный тип примитивных данных.

Следующий код иллюстрирует передачу данных для одного пикселя из DataBuffer db1, макет хранилища которого описывается SinglePixelPackedSampleModel sppsm1, в DataBuffer db2, макет хранилища которого описывается SinglePixelPackedSampleModel sppsm2. Передача, как правило, будет более эффективной, чем использование getPixel/setPixel.

       SinglePixelPackedSampleModel sppsm1, sppsm2;
       DataBufferInt db1, db2;
       sppsm2.setDataElements(x, y, sppsm1.getDataElements(x, y, null,
                              db1), db2);

Использование getDataElements/setDataElements для передачи между двумя парами DataBuffer/SampleModel допустимо, если SampleModels имеют одинаковое количество полос, соответствующие полосы имеют одинаковое количество бит на образец, и TransferTypes одинаковы.

Если obj не равен null, он должен быть примитивным массивом типа TransferType. В противном случае будет выброшено исключение ClassCastException. Исключение ArrayIndexOutOfBoundsException может быть выброшено, если координаты находятся за пределами границ или если obj не равен null и не достаточно велик, чтобы содержать данные пикселя.

Указано в:

getDataElements в классе SampleModel

Параметры:

x - Координата X расположения пикселя.

y - Координата Y расположения пикселя.

obj - Если не равно null, примитивный массив, в котором возвращаются данные пикселя.

data - DataBuffer, содержащий данные изображения.

Возвращает:

данные для указанного пикселя.

См. также:

getPixel

public int[] getPixel(int x, int y, int[] iArray, DataBuffer data)

Возвращает все образцы для указанного пикселя в массиве int. Исключение ArrayIndexOutOfBoundsException может быть выброшено, если координаты находятся за пределами границ.

Переопределяет:

getPixel в классе SampleModel

Параметры:

x - Координата X расположения пикселя.

y - Координата Y расположения пикселя.

iArray - Если не равно null, возвращает образцы в этом массиве

data - DataBuffer, содержащий данные изображения.

Возвращает:

все образцы для указанного пикселя.

См. также:

getPixels

public int[] getPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)

Возвращает все образцы для заданного прямоугольника пикселей в массиве int, по одному образцу на элемент массива. Может быть брошено исключение ArrayIndexOutOfBoundsException, если координаты не находятся в пределах границ.

Overrides:

getPixels в классе SampleModel

Parameters:

x - Координата X верхнего левого пикселя.

y - Координата Y верхнего левого пикселя.

w - Ширина прямоугольника пикселей.

h - Высота прямоугольника пикселей.

iArray - Если не null, возвращает образцы в этом массиве.

data - DataBuffer, содержащий данные изображения.

Returns:

все образцы для заданной области пикселей.

See Also:

getSample

public int getSample(int x, int y, int b, DataBuffer data)

Возвращает в виде int образец в указанной полосе для пикселя, расположенного по координатам (x, y). Может быть брошено исключение ArrayIndexOutOfBoundsException, если координаты не находятся в пределах границ.

Specified by:

getSample в классе SampleModel

Parameters:

x - Координата X местоположения пикселя.

y - Координата Y местоположения пикселя.

b - Полоса для возврата.

data - DataBuffer, содержащий данные изображения.

Returns:

образец в указанной полосе для заданного пикселя.

See Also:

getSamples

public int[] getSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)

Возвращает образцы для указанной полосы для заданного прямоугольника пикселей в массиве int, по одному образцу на элемент массива. Может быть брошено исключение ArrayIndexOutOfBoundsException, если координаты не находятся в пределах границ.

Overrides:

getSamples в классе SampleModel

Parameters:

x - Координата X верхнего левого пикселя.

y - Координата Y верхнего левого пикселя.

w - Ширина прямоугольника пикселей.

h - Высота прямоугольника пикселей.

b - Номер полосы для возврата.

iArray - Если не null, возвращает образцы в этом массиве.

data - DataBuffer, содержащий данные изображения.

Returns:

образцы для указанной полосы для заданной области пикселей.

See Also:

setDataElements

public void setDataElements(int x, int y, Object obj, DataBuffer data)

Устанавливает данные для одного пикселя в указанном DataBuffer из примитивного массива типа TransferType. Для SinglePixelPackedSampleModel только первый элемент массива будет содержать допустимые данные, и тип массива должен быть таким же, как тип данных хранения SinglePixelPackedSampleModel.

Следующий код иллюстрирует передачу данных для одного пикселя из DataBuffer db1, структура хранения которого описывается SinglePixelPackedSampleModel sppsm1, в DataBuffer db2, структура хранения которого описывается SinglePixelPackedSampleModel sppsm2. Передача, как правило, будет более эффективной, чем использование getPixel/setPixel.

       SinglePixelPackedSampleModel sppsm1, sppsm2;
       DataBufferInt db1, db2;
       sppsm2.setDataElements(x, y, sppsm1.getDataElements(x, y, null,
                              db1), db2);

Использование getDataElements/setDataElements для передачи между двумя парами DataBuffer/SampleModel допустимо, если SampleModel имеют одинаковое количество полос, соответствующие полосы имеют одинаковое количество бит на образец, и TransferType одинаковы.

obj должен быть примитивным массивом типа TransferType. В противном случае возникает исключение ClassCastException. Может быть брошено исключение ArrayIndexOutOfBoundsException, если координаты не находятся в пределах границ или если obj недостаточно велик для хранения данных пикселя.

Specified by:

setDataElements в классе SampleModel

Parameters:

x - Координата X местоположения пикселя.

y - Координата Y местоположения пикселя.

obj - Примитивный массив, содержащий данные пикселя.

data - DataBuffer, содержащий данные изображения.

See Also:

setPixel

public void setPixel(int x, int y, int[] iArray, DataBuffer data)

Устанавливает пиксель в DataBuffer, используя массив int для ввода образцов. Может быть брошено исключение ArrayIndexOutOfBoundsException, если координаты не находятся в пределах границ.

Overrides:

setPixel в классе SampleModel

Parameters:

x - Координата X местоположения пикселя.

y - Координата Y местоположения пикселя.

iArray - Входные образцы в массиве int.

data - DataBuffer, содержащий данные изображения.

See Also:

setPixels

public void setPixels(int x, int y, int w, int h, int[] iArray, DataBuffer data)

Устанавливает все образцы для прямоугольника пикселей из массива int, содержащего по одному образцу на элемент массива. Может быть брошено исключение ArrayIndexOutOfBoundsException, если координаты не находятся в пределах границ.

Overrides:

setPixels в классе SampleModel

Parameters:

x - Координата X верхнего левого пикселя.

y - Координата Y верхнего левого пикселя.

w - Ширина прямоугольника пикселей.

h - Высота прямоугольника пикселей.

iArray - Входные образцы в массиве int.

data - DataBuffer, содержащий данные изображения.

See Also:

setSample

public void setSample(int x, int y, int b, int s, DataBuffer data)

Устанавливает образец в указанной полосе для пикселя, расположенного по координатам (x, y) в DataBuffer, используя int для ввода. Может быть брошено исключение ArrayIndexOutOfBoundsException, если координаты не находятся в пределах границ.

Specified by:

setSample в классе SampleModel

Parameters:

x - Координата X местоположения пикселя.

y - Координата Y местоположения пикселя.

b - Номер полосы для установки.

s - Входной образец в виде int.

data - DataBuffer, содержащий данные изображения.

See Also:

setSamples

public void setSamples(int x, int y, int w, int h, int b, int[] iArray, DataBuffer data)

Устанавливает образцы в указанной полосе для заданного прямоугольника пикселей из массива int, содержащего по одному образцу на элемент массива. Может быть брошено исключение ArrayIndexOutOfBoundsException, если координаты не находятся в пределах границ.

Overrides:

setSamples в классе SampleModel

Parameters:

x - Координата X верхнего левого пикселя.

y - Координата Y верхнего левого пикселя.

w - Ширина прямоугольника пикселей.

h - Высота прямоугольника пикселей.

b - Номер полосы для установки.

iArray - Входные образцы в массиве int.

data - DataBuffer, содержащий данные изображения.

See Also:

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/image/SinglePixelPackedSampleModel.html