Класс 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.length.
`SinglePixelPackedSampleModel(int dataType, int w, int h, int scanlineStride, int[] bitMasks)`	Создаёт SinglePixelPackedSampleModel с полосами bitMasks.length и размером строки сканирования, равным 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, соответствующий этому SinglePixelPackedSampleModel.

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 - подмножество полос этого SinglePixelPackedSampleModel
Возвращает:: SinglePixelPackedSampleModel с подмножеством полос этого SinglePixelPackedSampleModel.
Исключения:: 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 имеют одинаковое количество полос, соответствующие полосы имеют одинаковое количество бит на образец и типы TransferType совпадают.

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

Определено в:

getDataElements в классе SampleModel

Параметры:

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

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

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

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

Возвращает:

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

См. также:

setDataElements(int, int, Object, 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, содержащий данные изображения.

Возвращает:

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

См. также:

setPixel(int, int, int[], 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:

setPixels(int, int, int, int, int[], DataBuffer)

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:

setSample(int, int, int, int, DataBuffer)

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:

setSamples(int, int, int, int, int, int[], DataBuffer)

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:

getDataElements(int, int, Object, DataBuffer)

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:

getPixel(int, int, int[], DataBuffer)

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:

getPixels(int, int, int, int, int[], DataBuffer)

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:

getSample(int, int, int, DataBuffer)

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:

getSamples(int, int, int, int, int, int[], DataBuffer)

© 1993, 2021, 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/17/docs/api/java.desktop/java/awt/image/SinglePixelPackedSampleModel.html