javax.imageio

Класс ImageReadParam

java.lang. Объект

javax.imageio. IIOParam

javax.imageio. ImageReadParam

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

JPEGImageReadParam

public class ImageReadParam
extends IIOParam

class, описывающий, как должен декодироваться поток. Экземпляры этого class или его подклассов используются, чтобы предоставить предписывающую информацию "с практическими рекомендациями" к экземплярам ImageReader.

Об изображении, закодированном как часть файла или потока, можно думать расширения в многократных размерностях: пространственные размерности width и height, многих полос, и многих прогрессивных передач декодирования. Этот class позволяет непрерывной (hyper) прямоугольной подобласти изображения во всех этих размерностях быть выбранной для того, чтобы декодировать. Дополнительно, пространственные размерности могут быть подвыбраны с перерывами. Наконец, цвет и преобразования формата могут быть определены, управляя ColorModel и SampleModel из целевого изображения, любого, обеспечивая a BufferedImage или при использовании ImageTypeSpecifier.

ImageReadParam объект используется, чтобы определить, как изображение, или ряд изображений, будет преобразовано на вводе из потока в контексте платформы ввода-вывода Изображения Java. Плагин для определенного формата изображения возвратит экземпляры ImageReadParam от getDefaultReadParam метод ImageReader реализация.

Состояние, сохраняемое экземпляром ImageReadParam независимо от любого определенного декодируемого изображения. Когда фактическое декодирование имеет место, набор значений в чтении param объединяются с фактическими свойствами изображения, декодируемого от потока и места назначения BufferedImage это получит декодируемые пиксельные данные. Например, исходное использование набора области setSourceRegion будет сначала пересечен с фактической допустимой исходной областью. Результат будет преобразован значением, возвращенным getDestinationOffset, и получающийся прямоугольник, пересеченный с фактической допустимой конечной областью, чтобы привести к конечной области, которая будет записана.

Параметры, определенные ImageReadParam применяются к изображению следующим образом. Во-первых, если размер рендеринга был установлен setSourceRenderSize, все декодируемое изображение представляется в размере, данном getSourceRenderSize. Иначе, изображению дали его естественный размер ImageReader.getWidth и ImageReader.getHeight.

Затем, изображение отсекается против исходной области, определенной getSourceXOffset, getSourceYOffset, getSourceWidth, и getSourceHeight.

Получающаяся область тогда подвыбирается согласно поданным факторам IIOParam.setSourceSubsampling. Первый пиксель, число пикселей на строку, и число строк все зависят от настроек подвыборки. Вызовите минимум X и координаты Y получающегося прямоугольника (minX, minY), его width w и его height h.

Этот прямоугольник смещается (getDestinationOffset().x, getDestinationOffset().y) и отсеченный против целевых границ. Если никакое целевое изображение не было установлено, место назначения определяется, чтобы иметь width getDestinationOffset().x + w, и height getDestinationOffset().y + h так, чтобы все пиксели исходной области могли быть записаны месту назначения.

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

Наконец, исходные выборки каждого пикселя отображаются в целевые полосы согласно алгоритму, описанному в комментарии для setDestinationBands.

Сменные писатели могут расширить функциональность ImageReadParam обеспечивая подкласс, который реализует дополнительные, сменные определенные интерфейсы. Это до плагина к документу, какие интерфейсы доступны и как они должны использоваться. Читатели тихо проигнорируют любые расширенные функции ImageReadParam подкласс которого они не знают. Кроме того, они могут проигнорировать любые дополнительные функции, которые они обычно отключают, создавая их собственное ImageReadParam экземпляры через getDefaultReadParam.

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

См. Также:

ImageReader, ImageWriter, ImageWriteParam

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

Поля

Модификатор и Тип	Поле и Описание
protected boolean	canSetSourceRenderSize true если это ImageReadParam позволяет исходным размерностям рендеринга быть установленными.
protected BufferedImage	место назначения Текущее место назначения BufferedImage, или null если ни один не был установлен.
protected int[]	destinationBands Набор целевых полос, которые будут использоваться, как массив ints.
protected int	minProgressivePass Минимум индексирует прогрессивной передачи, чтобы читать из источника.
protected int	numProgressivePasses Максимальное количество прогрессивных передач, чтобы читать из источника.
protected Dimension	sourceRenderSize Требуемый рендеринг width и height источника, если canSetSourceRenderSize true, или null.

Поля, наследованные от class javax.imageio. IIOParam

controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset

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

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

Конструктор и Описание
ImageReadParam() Конструкции ImageReadParam.

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

Модификатор и Тип	Метод и Описание
boolean	canSetSourceRenderSize() Возвраты true если этот читатель позволяет исходному изображению быть представленным в произвольном размере как часть процесса декодирования, посредством setSourceRenderSize метод.
BufferedImage	getDestination() Возвраты BufferedImage в настоящий момент установленный setDestination метод, или null если ни один не устанавливается.
int[]	getDestinationBands() Возвращает набор индексов полосы, куда данные будут помещены.
int	getSourceMaxProgressivePass() Если getSourceNumProgressivePasses равно Integer.MAX_VALUE, возвраты Integer.MAX_VALUE.
int	getSourceMinProgressivePass() Возвращает индексирование первой прогрессивной передачи, которая будет декодироваться.
int	getSourceNumProgressivePasses() Возвращает число прогрессивных передач, которые будут декодироваться.
Размерность	getSourceRenderSize() Возвращает width и height исходного изображения, поскольку это будет представлено во время декодирования, если они были установлены через setSourceRenderSize метод.
void	setDestination(BufferedImage destination) Предоставления a BufferedImage использоваться в качестве места назначения для декодируемых пиксельных данных.
void	setDestinationBands(int[] destinationBands) Устанавливает индексы целевых полос, куда данные будут помещены.
void	setDestinationType(ImageTypeSpecifier destinationType) Устанавливает требуемый тип изображения для целевого изображения, используя ImageTypeSpecifier.
void	setSourceProgressivePasses(int minPass, int numPasses) Устанавливает диапазон прогрессивных передач, которые будут декодироваться.
void	setSourceRenderSize(Dimension size) Если изображение в состоянии быть представленным в произвольном размере, устанавливает источник width и height к предоставленным значениям.

Методы, наследованные от class javax.imageio. IIOParam

activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setSourceBands, setSourceRegion, setSourceSubsampling

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

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

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

canSetSourceRenderSize

protected boolean canSetSourceRenderSize

true если это ImageReadParam позволяет исходным размерностям рендеринга быть установленными. По умолчанию значение false. Подклассы должны установить это значение вручную.

ImageReaders, которые не поддерживают установку источника, представляют размер, должен установить это значение в false.

sourceRenderSize

protected Dimension sourceRenderSize

Требуемый рендеринг width и height источника, если canSetSourceRenderSize true, или null.

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

место назначения

protected BufferedImage destination

Текущее место назначения BufferedImage, или null если ни один не был установлен. По умолчанию значение null.

destinationBands

protected int[] destinationBands

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

minProgressivePass

protected int minProgressivePass

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

Подклассы должны гарантировать, что это значение является неотрицательным.

numProgressivePasses

protected int numProgressivePasses

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

Подклассы должны гарантировать, что это значение положительно. Дополнительно, если значение не Integer.MAX_VALUE, тогда minProgressivePass + numProgressivePasses - 1 не должен превысить Integer.MAX_VALUE.

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

ImageReadParam

public ImageReadParam()

Конструкции ImageReadParam.

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

setDestinationType

public void setDestinationType(ImageTypeSpecifier destinationType)

Описание скопировало с class: IIOParam

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

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

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

Переопределения:

setDestinationType в class IIOParam

Параметры:

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

См. Также:

IIOParam.getDestinationType()

setDestination

public void setDestination(BufferedImage destination)

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

Пиксельные данные от вышеупомянутых методов будут записаны, запускаясь при смещении, определенном getDestinationOffset.

Если destination null, недавно создаваемый BufferedImage будет возвращен теми методами.

Во время чтения изображение проверяется, чтобы проверить что ColorModel и SampleModel соответствуйте одному из ImageTypeSpecifiers возвратился из ImageReader's getImageTypes метод. Если это не сделает, то читатель бросит IIOException.

Параметры:

destination - BufferedImage, который будет записан, или null.

См. Также:

getDestination()

getDestination

public BufferedImage getDestination()

Возвраты BufferedImage в настоящий момент установленный setDestination метод, или null если ни один не устанавливается.

Возвраты:

BufferedImage, который будет записан.

См. Также:

setDestination(java.awt.image.BufferedImage)

setDestinationBands

public void setDestinationBands(int[] destinationBands)

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

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

Выбор целевого подмножества полосы не будет влиять на число полос в выходном изображении чтения, если никакое целевое изображение не будет определено; у создаваемого целевого изображения все еще будет то же самое число полос, как будто этот метод никогда не вызывали. Если различное число полос в целевом изображении требуется, изображение должно быть предоставлено, используя ImageReadParam.setDestination метод.

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

Параметры:

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

Броски:

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

См. Также:

getDestinationBands(), IIOParam.getSourceBands(), ImageReader.checkReadParamBandSettings(javax.imageio.ImageReadParam, int, int)

getDestinationBands

public int[] getDestinationBands()

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

Возвраты:

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

См. Также:

setDestinationBands(int[])

canSetSourceRenderSize

public boolean canSetSourceRenderSize()

Возвраты true если этот читатель позволяет исходному изображению быть представленным в произвольном размере как часть процесса декодирования, посредством setSourceRenderSize метод. Если этот метод возвращается false, звонки setSourceRenderSize бросит UnsupportedOperationException.

Возвраты:

true если установка исходного размера рендеринга поддерживается.

См. Также:

setSourceRenderSize(java.awt.Dimension)

setSourceRenderSize

public void setSourceRenderSize(Dimension size)
                         throws UnsupportedOperationException

Если изображение в состоянии быть представленным в произвольном размере, устанавливает источник width и height к предоставленным значениям. Отметьте что значения, возвращенные из getWidth и getHeight методы на ImageReader не влияются этим методом; они будут продолжать возвращать размер значения по умолчанию для изображения. Точно так же, если изображение также размещается мозаика рядом, width и height даются с точки зрения размера значения по умолчанию.

Как правило, width и height должны быть выбраны так, что, отношение width к height близко приближает формат изображения изображения, как возвращено из ImageReader.getAspectRatio.

Если этот плагин не позволяет размеру рендеринга быть установленным, UnsupportedOperationException будет брошен.

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

Параметры:

size - a Dimension указание на требуемый width и height.

Броски:

IllegalArgumentException - если или width или height отрицательны или 0.

UnsupportedOperationException - если изменение размеров изображения не поддерживается этим плагином.

См. Также:

getSourceRenderSize(), ImageReader.getWidth(int), ImageReader.getHeight(int), ImageReader.getAspectRatio(int)

getSourceRenderSize

public Dimension getSourceRenderSize()

Возвращает width и height исходного изображения, поскольку это будет представлено во время декодирования, если они были установлены через setSourceRenderSize метод. A nullзначение указывает, что никакая установка не была сделана.

Возвраты:

представленный width и height исходного изображения как a Dimension.

См. Также:

setSourceRenderSize(java.awt.Dimension)

setSourceProgressivePasses

public void setSourceProgressivePasses(int minPass,
                                       int numPasses)

Устанавливает диапазон прогрессивных передач, которые будут декодироваться. Передачи за пределами этого диапазона будут проигнорированы.

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

Фактическое число передач, которые будут декодироваться, определяется во время декодирования, основанного на числе фактических передач, доступных в потоке. Таким образом, если minPass + numPasses - 1 больше чем индексирование последних доступных передач, декодирование закончится той передачей.

Значение numPasses из Integer.MAX_VALUE указывает что все передачи от minPass вперед должен быть считан. Иначе, индексирование последней передачи (то есть, minPass + numPasses - 1) не должен превысить Integer.MAX_VALUE.

Есть нет unsetSourceProgressivePasses метод; тот же самый эффект может быть получен, вызывая setSourceProgressivePasses(0, Integer.MAX_VALUE).

Параметры:

minPass - индексирование первой передачи, которая будет декодироваться.

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

Броски:

IllegalArgumentException - если minPass отрицательно, numPasses отрицательно или 0, или numPasses меньше чем Integer.MAX_VALUE но minPass + numPasses - 1 больше чем INTEGER.MAX_VALUE.

См. Также:

getSourceMinProgressivePass(), getSourceMaxProgressivePass()

getSourceMinProgressivePass

public int getSourceMinProgressivePass()

Возвращает индексирование первой прогрессивной передачи, которая будет декодироваться. Если никакое значение не было установлено, 0 будет возвращен (который является корректным значением).

Возвраты:

индексирование первой передачи, которая будет декодироваться.

См. Также:

setSourceProgressivePasses(int, int), getSourceNumProgressivePasses()

getSourceMaxProgressivePass

public int getSourceMaxProgressivePass()

Если getSourceNumProgressivePasses равно Integer.MAX_VALUE, возвраты Integer.MAX_VALUE. Иначе, возвраты getSourceMinProgressivePass() + getSourceNumProgressivePasses() - 1.

Возвраты:

индексирование последней передачи, которая будет считана, или Integer.MAX_VALUE.

getSourceNumProgressivePasses

public int getSourceNumProgressivePasses()

Возвращает число прогрессивных передач, которые будут декодироваться. Если никакое значение не было установлено, Integer.MAX_VALUE будет возвращен (который является корректным значением).

Возвраты:

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

См. Также:

setSourceProgressivePasses(int, int), getSourceMinProgressivePass()