javax.imageio

Класс IIOParam

java.lang. Объект

javax.imageio. IIOParam

Прямые Известные Подклассы:

ImageReadParam, ImageWriteParam

public abstract class IIOParam
extends Object

Суперкласс всех классов, описывающих, как потоки должны декодироваться или закодированы. Этот class содержит все переменные и методы, которые совместно используются ImageReadParam и ImageWriteParam.

Этот class обеспечивает механизмы, чтобы определить исходную область и целевую область. Читая, источник является потоком, и в отображении памяти является место назначения. При записи они инвертируются. В случае записи целевые области могут использоваться только с писателем, который поддерживает пиксельную замену.

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

Подмножества источника и целевых полос могут быть выбраны.

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
protected IIOParamController	контроллер IIOParamController это будет использоваться, чтобы обеспечить настройки для этого IIOParam возразите когда activateController метод вызывают.
protected IIOParamController	defaultController Значение по умолчанию IIOParamController это будет использоваться, чтобы обеспечить настройки для этого IIOParam возразите когда activateController метод вызывают.
protected Point	destinationOffset Смещение в месте назначения, куда верхний левый декодируемый пиксель должен быть помещен.
protected ImageTypeSpecifier	destinationType ImageTypeSpecifier чтобы использоваться, чтобы генерировать целевое изображение, читая, или установить вывод красят тип при записи.
protected int[]	sourceBands Массив ints указание, какие исходные полосы будут использоваться, или null.
protected Rectangle	sourceRegion Исходная область, на null если ни один не устанавливается.
protected int	sourceXSubsampling Подвыборка десятикратного уменьшения, которая будет применена в горизонтальном направлении.
protected int	sourceYSubsampling Подвыборка десятикратного уменьшения, которая будет применена в вертикальном направлении.
protected int	subsamplingXOffset Горизонтальное смещение, которое будет применено к сетке подвыборки перед подвыборкой.
protected int	subsamplingYOffset Вертикальное смещение, которое будет применено к сетке подвыборки перед подвыборкой.

Сводка конструктора

Конструкторы

Модификатор	Конструктор и Описание
protected	IIOParam() Защищенного конструктора могут вызвать только подклассы.

Сводка метода

Модификатор и Тип	Метод и Описание
boolean	activateController() Активирует установленный IIOParamController для этого IIOParam возразите и возвращает получающееся значение.
IIOParamController	getController() Возвраты вообще IIOParamController в настоящий момент устанавливается.
IIOParamController	getDefaultController() Возвращает значение по умолчанию IIOParamController, если есть один, независимо от в настоящий момент установленного контроллера.
Точка	getDestinationOffset() Возвращает смещение в целевом изображении, в которое должны быть помещены пиксели.
ImageTypeSpecifier	getDestinationType() Возвращает тип изображения, которое будет возвращено чтением, если Вы были установлены звонком setDestination(ImageTypeSpecifier), как ImageTypeSpecifier.
int[]	getSourceBands() Возвращает набор исходных полос, которые будут использоваться.
Прямоугольник	getSourceRegion() Возвращает исходную область, которая будет использоваться.
int	getSourceXSubsampling() Возвращает число исходных столбцов, чтобы совершенствоваться для каждого пикселя.
int	getSourceYSubsampling() Возвращает число строк, чтобы совершенствоваться для каждого пикселя.
int	getSubsamplingXOffset() Возвращает горизонтальное смещение сетки подвыборки.
int	getSubsamplingYOffset() Возвращает вертикальное смещение сетки подвыборки.
boolean	hasController() Возвраты true если есть контроллер, установленный для этого IIOParam объект.
void	setController(IIOParamController controller) Наборы IIOParamController использоваться, чтобы обеспечить настройки для этого IIOParam возразите когда activateController метод вызывают, переопределяя любой контроллер значения по умолчанию.
void	setDestinationOffset(Point destinationOffset) Определяет смещение в целевом изображении, в которое будущее декодируемые пиксели должны быть помещены, читая, или где область будет записана при записи.
void	setDestinationType(ImageTypeSpecifier destinationType) Устанавливает требуемый тип изображения для целевого изображения, используя ImageTypeSpecifier.
void	setSourceBands(int[] sourceBands) Устанавливает индексы исходных полос, которые будут использоваться.
void	setSourceRegion(Rectangle sourceRegion) Устанавливает исходную область интереса.
void	setSourceSubsampling(int sourceXSubsampling, int sourceYSubsampling, int subsamplingXOffset, int subsamplingYOffset) Определяет подвыборку десятикратного уменьшения, чтобы применяться на вводе-выводе.

Методы, наследованные от class java.lang. Объект

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Полевая Деталь

sourceRegion

protected Rectangle sourceRegion

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

sourceXSubsampling

protected int sourceXSubsampling

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

sourceYSubsampling

protected int sourceYSubsampling

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

subsamplingXOffset

protected int subsamplingXOffset

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

subsamplingYOffset

protected int subsamplingYOffset

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

sourceBands

protected int[] sourceBands

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

destinationType

protected ImageTypeSpecifier destinationType

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

destinationOffset

protected Point destinationOffset

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

defaultController

protected IIOParamController defaultController

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

См. Также:

IIOParamController, getDefaultController(), activateController()

контроллер

protected IIOParamController controller

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

См. Также:

IIOParamController, setController(IIOParamController), hasController(), activateController()

Деталь конструктора

IIOParam

protected IIOParam()

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

Деталь метода

setSourceRegion

public void setSourceRegion(Rectangle sourceRegion)

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

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

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

Параметры:

sourceRegion - a Rectangle определение исходной области интереса, или null.

Броски:

IllegalArgumentException - если sourceRegion не -null и также sourceRegion.x или sourceRegion.y отрицательно.

IllegalArgumentException - если sourceRegion не -null и также sourceRegion.width или sourceRegion.height отрицательно или 0.

IllegalStateException - если подвыборка будет так, что этой областью, то будет иметь подвыбранный width или height нуля.

См. Также:

getSourceRegion(), setSourceSubsampling(int, int, int, int), setDestinationOffset(java.awt.Point), getDestinationOffset()

getSourceRegion

public Rectangle getSourceRegion()

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

Возвраты:

исходная область интереса как a Rectangle, или null.

См. Также:

setSourceRegion(java.awt.Rectangle)

setSourceSubsampling

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

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

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

Числом подвыбранных пикселей в строке развертки дают

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

Если областью является так, что этот width, нуль, IllegalStateException бросается.

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

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

Если также sourceXSubsampling или sourceYSubsampling 0 или отрицательно, IllegalArgumentException будет брошен.

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

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

Параметры:

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

sourceYSubsampling - число строк, чтобы совершенствоваться между пикселями.

subsamplingXOffset - горизонтальное смещение первой подвыборки в пределах области, или в пределах изображения, если никакая область не устанавливается.

subsamplingYOffset - горизонтальное смещение первой подвыборки в пределах области, или в пределах изображения, если никакая область не устанавливается.

Броски:

IllegalArgumentException - если или период отрицателен или 0, или если или смещение сетки отрицательно или больше чем соответствующий период.

IllegalStateException - если бы исходная область является так, что подвыбранным выводом, не содержал бы пикселей.

getSourceXSubsampling

public int getSourceXSubsampling()

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

Если setSourceSubsampling не был вызван, 1 возвращается (который является корректным значением).

Возвраты:

исходная подвыборка X периодов.

См. Также:

setSourceSubsampling(int, int, int, int), getSourceYSubsampling()

getSourceYSubsampling

public int getSourceYSubsampling()

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

Если setSourceSubsampling не был вызван, 1 возвращается (который является корректным значением).

Возвраты:

исходная подвыборка Y период.

См. Также:

setSourceSubsampling(int, int, int, int), getSourceXSubsampling()

getSubsamplingXOffset

public int getSubsamplingXOffset()

Возвращает горизонтальное смещение сетки подвыборки.

Если setSourceSubsampling не был вызван, 0 возвращается (который является корректным значением).

Возвраты:

исходная сетка подвыборки X смещений.

См. Также:

setSourceSubsampling(int, int, int, int), getSubsamplingYOffset()

getSubsamplingYOffset

public int getSubsamplingYOffset()

Возвращает вертикальное смещение сетки подвыборки.

Если setSourceSubsampling не был вызван, 0 возвращается (который является корректным значением).

Возвраты:

исходная сетка подвыборки Y смещение.

См. Также:

setSourceSubsampling(int, int, int, int), getSubsamplingXOffset()

setSourceBands

public void setSourceBands(int[] sourceBands)

Устанавливает индексы исходных полос, которые будут использоваться. Двойные индексы не позволяются.

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

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

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

Параметры:

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

Броски:

IllegalArgumentException - если sourceBands содержит отрицательное или двойное значение.

См. Также:

getSourceBands(), ImageReadParam.setDestinationBands(int[]), ImageReader.checkReadParamBandSettings(javax.imageio.ImageReadParam, int, int)

getSourceBands

public int[] getSourceBands()

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

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

Возвраты:

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

См. Также:

setSourceBands(int[])

setDestinationType

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 обратится ко всему изображению, а не к подмножеству записанных полос.

Параметры:

destinationType - ImageTypeSpecifier использоваться, чтобы определить целевое расположение и цветной тип.

См. Также:

getDestinationType()

getDestinationType

public ImageTypeSpecifier getDestinationType()

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

Возвраты:

ImageTypeSpecifier описание целевого типа, или null.

См. Также:

setDestinationType(javax.imageio.ImageTypeSpecifier)

setDestinationOffset

public void setDestinationOffset(Point destinationOffset)

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

Читая, область, которая будет записана в пределах места назначения BufferedImage запустится при этом смещении и иметь width и height, определенный исходной областью интереса, параметров подвыборки, и целевых границ.

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

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

Параметры:

destinationOffset - смещение в месте назначения, как a Point.

Броски:

IllegalArgumentException - если destinationOffset null.

См. Также:

getDestinationOffset(), ImageWriter.replacePixels(java.awt.image.RenderedImage, javax.imageio.ImageWriteParam)

getDestinationOffset

public Point getDestinationOffset()

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

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

Возвраты:

место назначения смещало как a Point.

См. Также:

setDestinationOffset(java.awt.Point)

setController

public void setController(IIOParamController controller)

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

Параметры:

controller - Соответствующее IIOParamController, или null.

См. Также:

IIOParamController, getController(), getDefaultController(), hasController(), activateController()

getController

public IIOParamController getController()

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

Возвраты:

в настоящий момент установленный IIOParamController, или null.

См. Также:

IIOParamController, setController(javax.imageio.IIOParamController), getDefaultController(), hasController(), activateController()

getDefaultController

public IIOParamController getDefaultController()

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

Возвраты:

значение по умолчанию IIOParamController, или null.

См. Также:

IIOParamController, setController(IIOParamController), getController(), hasController(), activateController()

hasController

public boolean hasController()

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

Возвраты:

true если контроллер устанавливается.

См. Также:

IIOParamController, setController(IIOParamController), getController(), getDefaultController(), activateController()

activateController

public boolean activateController()

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

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

Возвраты:

true если контроллер обычно завершался.

Броски:

IllegalStateException - если нет никакого контроллера, в настоящий момент установленного.

См. Также:

IIOParamController, setController(IIOParamController), getController(), getDefaultController(), hasController()