Package de.digitalcollections.openjpeg.imageio

Class OpenJp2ImageWriteParam

java.lang.Object

javax.imageio.IIOParam

javax.imageio.ImageWriteParam

de.digitalcollections.openjpeg.imageio.OpenJp2ImageWriteParam

public class OpenJp2ImageWriteParam
extends ImageWriteParam

Parameters for encoding JPEG2000 images

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenJp2ImageWriteParam.ProgressionOrder

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPRESS_TYPE_LOSSLESS
static String	COMPRESS_TYPE_LOSSY

Fields inherited from class javax.imageio.ImageWriteParam

canOffsetTiles, canWriteCompressed, canWriteProgressive, canWriteTiles, compressionMode, compressionQuality, compressionType, compressionTypes, locale, MODE_COPY_FROM_METADATA, MODE_DEFAULT, MODE_DISABLED, MODE_EXPLICIT, preferredTileSizes, progressiveMode, tileGridXOffset, tileGridYOffset, tileHeight, tileWidth, tilingMode, tilingSet

Fields inherited from class javax.imageio.IIOParam

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

Constructor Summary

Constructors

Constructor	Description
OpenJp2ImageWriteParam()

Method Summary

Modifier and Type	Method	Description
boolean	canOffsetTiles()
boolean	canWriteCompressed()
boolean	canWriteProgressive()
boolean	canWriteTiles()
String	getCompressionType()
String[]	getCompressionTypes()
int	getNumResolutions()
OpenJp2ImageWriteParam.ProgressionOrder	getProgressionOrder()
boolean	isCompressionLossless()
void	setCompressionQuality(float quality)	Set the compression quality.
void	setCompressionType(String compressionType)	Set the compression type.
void	setNumResolutions(int numResolutions)	Set the number of resolutions to encode in the output image.
void	setProgressionOrder(OpenJp2ImageWriteParam.ProgressionOrder progOrder)	Set the progression order of the encoded image.
void	setWriteEPHMarkers(boolean writeEPHMarkers)	Write EPH marker after each header packet.
void	setWriteSOPMarkers(boolean writeSOPMarkers)	Write SOP markers after each packet.
boolean	shouldWriteEPHMarkers()
boolean	shouldWriteSOPMarkers()
protected opj_cparameters	toNativeParams(OpenJpeg lib)
void	unsetCompression()

Methods inherited from class javax.imageio.ImageWriteParam

getBitRate, getCompressionMode, getCompressionQuality, getCompressionQualityDescriptions, getCompressionQualityValues, getLocale, getLocalizedCompressionTypeName, getPreferredTileSizes, getProgressiveMode, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, getTilingMode, setCompressionMode, setProgressiveMode, setTiling, setTilingMode, unsetTiling

Methods inherited from class javax.imageio.IIOParam

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

Methods inherited from class java.lang.Object

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

Field Detail

COMPRESS_TYPE_LOSSY

public static String COMPRESS_TYPE_LOSSY

COMPRESS_TYPE_LOSSLESS

public static String COMPRESS_TYPE_LOSSLESS

Constructor Detail

OpenJp2ImageWriteParam

public OpenJp2ImageWriteParam()

Method Detail

toNativeParams

protected opj_cparameters toNativeParams(OpenJpeg lib)

canWriteTiles

public boolean canWriteTiles()

Overrides:

canWriteTiles in class ImageWriteParam

canOffsetTiles

public boolean canOffsetTiles()

Overrides:

canOffsetTiles in class ImageWriteParam

canWriteProgressive

public boolean canWriteProgressive()

Overrides:

canWriteProgressive in class ImageWriteParam

canWriteCompressed

public boolean canWriteCompressed()

Overrides:

canWriteCompressed in class ImageWriteParam

getCompressionTypes

public String[] getCompressionTypes()

Overrides:

getCompressionTypes in class ImageWriteParam

setCompressionType

public void setCompressionType(String compressionType)

Set the compression type. Must be 'lossless' (default) or 'lossy'.

Overrides:

setCompressionType in class ImageWriteParam

getCompressionType

public String getCompressionType()

Overrides:

getCompressionType in class ImageWriteParam

unsetCompression

public void unsetCompression()

Overrides:

unsetCompression in class ImageWriteParam

isCompressionLossless

public boolean isCompressionLossless()

Overrides:

isCompressionLossless in class ImageWriteParam

shouldWriteSOPMarkers

public boolean shouldWriteSOPMarkers()

setWriteSOPMarkers

public void setWriteSOPMarkers(boolean writeSOPMarkers)

Write SOP markers after each packet.

Parameters:

writeSOPMarkers - flag if sop markers should be written

shouldWriteEPHMarkers

public boolean shouldWriteEPHMarkers()

setWriteEPHMarkers

public void setWriteEPHMarkers(boolean writeEPHMarkers)

Write EPH marker after each header packet.

Parameters:

writeEPHMarkers - flag if eph markers should be written

setCompressionQuality

public void setCompressionQuality(float quality)

Set the compression quality. Automatically switches compression type to lossy. ImageWriteParam.setCompressionType(java.lang.String) must have been set to ImageWriteParam.MODE_EXPLICIT.

Quality must be between 0.0 (worst) and 1.0 (best).

Overrides:

setCompressionQuality in class ImageWriteParam

getNumResolutions

public int getNumResolutions()

setNumResolutions

public void setNumResolutions(int numResolutions)

Set the number of resolutions to encode in the output image.

Each resolution will be 2^num times smaller than the native resolution.

Parameters:

numResolutions - the num resolutions

getProgressionOrder

public OpenJp2ImageWriteParam.ProgressionOrder getProgressionOrder()

setProgressionOrder

public void setProgressionOrder(OpenJp2ImageWriteParam.ProgressionOrder progOrder)

Set the progression order of the encoded image.

Parameters:

progOrder - the progression order