Класс IIOParam

protected Rectangle sourceRegion

Исходная область или null, если она не задана.

protected int sourceXSubsampling

Коэффициент прореживания, применяемый в горизонтальном направлении. По умолчанию значение равно 1. Значение не должно быть отрицательным или равным 0.

protected int sourceYSubsampling

Коэффициент прореживания, применяемый в вертикальном направлении. По умолчанию значение равно 1. Значение не должно быть отрицательным или равным 0.

protected int subsamplingXOffset

Горизонтальное смещение сетки прореживания, применяемое перед прореживанием. Первый используемый пиксель будет смещён на это значение относительно начала области или изображения, если область не задана.

protected int subsamplingYOffset

Вертикальное смещение сетки прореживания, применяемое перед прореживанием. Первый используемый пиксель будет смещён на это значение относительно начала области или изображения, если область не задана.

protected int[] sourceBands

Массив int, указывающих, какие исходные каналы будут использоваться, или null. Если задано null, набор используемых исходных каналов определяется так, как описано в комментарии к методу setSourceBands. Значения не должны быть отрицательными.

protected ImageTypeSpecifier destinationType

Объект ImageTypeSpecifier, используемый для создания целевого изображения при чтении или для задания выходного типа цвета при записи. Если значение не задано, оно будет равно null. По умолчанию значение равно null.

protected Point destinationOffset

Смещение в целевом изображении, в которое следует поместить декодированный пиксель в левом верхнем углу. По умолчанию значение равно (0, 0).

protected IIOParamController defaultController

Контроллер IIOParamController по умолчанию, который будет использоваться для задания параметров этого объекта IIOParam при вызове метода activateController. Подклассы, предоставляющие собственный контроллер по умолчанию, обычно графический интерфейс для задания параметров, должны установить его.

protected IIOParamController controller

Контроллер IIOParamController, который будет использоваться для задания параметров этого объекта IIOParam при вызове метода activateController. Это значение переопределяет любой контроллер по умолчанию, даже если оно равно null.

protected IIOParam()

Защищённый конструктор, который могут вызывать только подклассы.

public void setSourceRegion(Rectangle sourceRegion)

Задаёт исходную область интереса. Область интереса задаётся прямоугольником, где левый верхний угол исходного изображения имеет координаты пикселя (0, 0), а значения увеличиваются вниз и вправо. Фактическое количество используемых пикселей зависит от коэффициентов прореживания, заданных методом setSourceSubsampling. Если прореживание задано так, что это количество равно нулю, будет выброшено исключение IllegalStateException.

При необходимости указанная этим методом исходная область интереса будет обрезана, чтобы соответствовать границам источника, а также смещениям, ширине и высоте целевого изображения на момент фактического выполнения операции ввода-вывода.

Значение null для sourceRegion удаляет указание области, в результате чего используется всё изображение.

public Rectangle getSourceRegion()

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

public void setSourceSubsampling(int sourceXSubsampling, int sourceYSubsampling, int subsamplingXOffset, int subsamplingYOffset)

Задаёт прореживание, применяемое при операциях ввода-вывода. Параметры sourceXSubsampling и sourceYSubsampling задают период прореживания (т. е. количество строк и столбцов, на которое нужно перейти после каждого исходного пикселя). В частности, при периоде 1 используется каждая строка или столбец, а при периоде 2 — каждая вторая строка или столбец. Параметры subsamplingXOffset и subsamplingYOffset задают смещение первого прореживаемого пикселя относительно начала области (или изображения). Изменение начала сетки прореживания полезно для устранения швов при прореживании очень большого исходного изображения в целевые области, которые затем объединяются в полное прореженное изображение. Большинству пользователей следует просто оставить эти параметры равными 0.

Количество используемых пикселей и строк сканирования вычисляется следующим образом.

Количество прореженных пикселей в строке сканирования определяется выражением

truncate[(width - subsamplingXOffset + sourceXSubsampling - 1) / sourceXSubsampling].

Если ширина области при этом равна нулю, выбрасывается исключение IllegalStateException.

Количество используемых строк сканирования можно вычислить аналогичным образом.

Возможность задать начало сетки прореживания не в начале исходной области полезна, если область используется для создания прореженных фрагментов большого изображения, ширина и высота которых не кратны периодам прореживания. Если сетка прореживания не сохраняет согласованность от фрагмента к фрагменту, на их границах появляются артефакты. Этих артефактов можно избежать, скорректировав смещение сетки прореживания для каждого фрагмента. Компромисс заключается в том, что для устранения артефактов фрагменты будут иметь неодинаковый размер. В этом случае используемое смещение сетки определяется формулой:
смещение сетки = [период - (смещение области по модулю периода)] по модулю периода)

Если sourceXSubsampling или sourceYSubsampling равно 0 или меньше, будет выброшено исключение IllegalArgumentException.

Если subsamplingXOffset или subsamplingYOffset отрицательно или больше либо равно соответствующему периоду, будет выброшено исключение IllegalArgumentException.

Метода unsetSourceSubsampling нет; для восстановления значений по умолчанию достаточно вызвать setSourceSubsampling(1, 1, 0, 0).

public int getSourceXSubsampling()

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

Если метод setSourceSubsampling не вызывался, возвращается 1 (правильное значение).

public int getSourceYSubsampling()

Возвращает количество строк, на которое следует перейти для каждого пикселя.

Если метод setSourceSubsampling не вызывался, возвращается 1 (правильное значение).

public int getSubsamplingXOffset()

Возвращает горизонтальное смещение сетки прореживания.

Если метод setSourceSubsampling не вызывался, возвращается 0 (правильное значение).

public int getSubsamplingYOffset()

Возвращает вертикальное смещение сетки прореживания.

Если метод setSourceSubsampling не вызывался, возвращается 0 (правильное значение).

public void setSourceBands(int[] sourceBands)

Задаёт индексы используемых исходных каналов. Повторяющиеся индексы не допускаются.

Значение null указывает, что будут использоваться все исходные каналы.

При чтении средство чтения или записи выбросит исключение IllegalArgumentException, если задано значение больше наибольшего доступного индекса исходного канала или если количество используемых исходных и целевых каналов различается. Для автоматической проверки можно использовать метод ImageReader.checkReadParamBandSettings.

Семантически создаётся копия массива; изменения его содержимого после этого вызова не влияют на данный объект IIOParam.

public int[] getSourceBands()

Возвращает набор используемых исходных каналов. Возвращаемое значение задаётся последним вызовом setSourceBands или равно null, если вызовов setSourceBands не было.

Семантически возвращаемый массив является копией; изменения его содержимого после этого вызова не влияют на данный объект IIOParam.

public void setDestinationType(ImageTypeSpecifier destinationType)

Задаёт желаемый тип изображения для целевого изображения с помощью ImageTypeSpecifier.

При чтении, если разметка целевого изображения была задана этим методом, каждый вызов метода ImageReader read будет возвращать новый объект BufferedImage, использующий формат, указанный переданным спецификатором типа. Побочным эффектом является отмена ранее заданного назначения BufferedImage с помощью ImageReadParam.setDestination(BufferedImage). Иными словами, этот метод можно рассматривать как вызов setDestination((BufferedImage)null).

При записи тип назначения может использоваться для определения типа цвета изображения. Информация SampleModel будет игнорироваться и может быть null. Например, изображение с 4 каналами может содержать данные CMYK или RGBA. Если задан тип назначения, его ColorModel переопределит любой ColorModel самого изображения. Это особенно важно при использовании setSourceBands, поскольку ColorModel изображения будет относиться ко всему изображению, а не к подмножеству записываемых каналов.

public ImageTypeSpecifier getDestinationType()

Возвращает тип изображения, которое будет возвращено при чтении, если он был задан вызовом setDestination(ImageTypeSpecifier), в виде объекта ImageTypeSpecifier. Если тип не задан, возвращается null.

public void setDestinationOffset(Point destinationOffset)

Задаёт смещение в целевом изображении, в которое будут помещаться декодированные пиксели при чтении или по которому будет записываться область при записи.

При чтении область записи в целевом изображении BufferedImage начинается с этого смещения, а её ширина и высота определяются исходной областью интереса, параметрами прореживания и границами целевого изображения.

Обычная запись не зависит от этого метода; он влияет только на запись с помощью ImageWriter.replacePixels. При такой записи заданное смещение относится к изображению в выходном потоке, пиксели которого изменяются.

Метода unsetDestinationOffset нет; для восстановления значений по умолчанию достаточно вызвать setDestinationOffset(new Point(0, 0)).

public Point getDestinationOffset()

Возвращает смещение в целевом изображении, в которое будут помещаться пиксели.

Если метод setDestinationOffsets не вызывался, возвращается Point с нулевыми значениями X и Y (правильное значение).

public void setController(IIOParamController controller)

Задаёт контроллер IIOParamController, используемый для задания параметров этого объекта IIOParam при вызове метода activateController, переопределяя любой контроллер по умолчанию. Если аргумент равен null, контроллер не будет использоваться, в том числе контроллер по умолчанию. Чтобы восстановить значение по умолчанию, используйте setController(getDefaultController()).

public IIOParamController getController()

Возвращает установленный в данный момент контроллер IIOParamController. Это может быть контроллер по умолчанию, если он есть, null или аргумент последнего вызова setController.

public IIOParamController getDefaultController()

Возвращает контроллер IIOParamController по умолчанию, если он есть, независимо от установленного в данный момент контроллера. Если контроллер по умолчанию отсутствует, возвращает null.

public boolean hasController()

Возвращает true, если для этого объекта IIOParam установлен контроллер. Возвращает true, если getController не вернёт null.

public boolean activateController()

Активирует установленный контроллер IIOParamController для этого объекта IIOParam и возвращает полученное значение. Если метод возвращает true, все значения этого объекта IIOParam будут готовы к следующей операции чтения или записи. Если возвращается false, параметры объекта не изменятся (т. е. пользователь отменил операцию).

Обычно контроллер представляет собой графический интерфейс, предоставляющий пользовательский интерфейс для подкласса IIOParam конкретного подключаемого модуля. Однако контроллеры не обязательно должны быть графическими интерфейсами.