Класс 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 для конкретного плагина. Однако контроллеры необязательно являются графическими интерфейсами.