Класс 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)

Устанавливает требуемый тип изображения для целевого изображения, используя спецификатор типа.

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

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

public ImageTypeSpecifier getDestinationType()

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

public void setDestinationOffset(Point destinationOffset)

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

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

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

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

public Point getDestinationOffset()

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

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

public void setController(IIOParamController controller)

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

public IIOParamController getController()

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

public IIOParamController getDefaultController()

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

public boolean hasController()

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

public boolean activateController()

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

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