Класс IIOParam

protected Rectangle sourceRegion

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

protected int sourceXSubsampling

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

protected int sourceYSubsampling

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

protected int subsamplingXOffset

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

protected int subsamplingYOffset

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

protected int[] sourceBands

Массив ints, указывающий, какие исходные каналы будут использоваться, или 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. Например, изображение с четырьмя каналами может содержать данные 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 конкретного подключаемого модуля. Однако контроллеры не обязательно должны быть графическими интерфейсами.