|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectImageWriter
GDALImageWriter
public abstract class GDALImageWriter
Main abstract class defining the main framework which needs to be used to extend Image I/O architecture using GDAL (Geospatial Data Abstraction Library) by means of SWIG (Simplified Wrapper and Interface Generator) bindings in order to perform write operations.
Field Summary | |
---|---|
protected File |
outputFile
Output File |
Fields inherited from class ImageWriter |
---|
availableLocales, locale, originatingProvider, output, progressListeners, warningListeners, warningLocales |
Constructor Summary | |
---|---|
GDALImageWriter(ImageWriterSpi originatingProvider)
Constructor for GDALImageWriter |
Method Summary | |
---|---|
IIOMetadata |
convertImageMetadata(IIOMetadata inData,
ImageTypeSpecifier imageType,
ImageWriteParam param)
|
IIOMetadata |
convertStreamMetadata(IIOMetadata inData,
ImageWriteParam param)
|
IIOMetadata |
getDefaultImageMetadata(ImageTypeSpecifier imageType,
ImageWriteParam param)
|
IIOMetadata |
getDefaultStreamMetadata(ImageWriteParam param)
|
protected static int |
getMaxMemorySizeForGDALMemoryDataset()
Utility method which checks if a system property has been specified to set the maximum allowed size to create a GDAL "In Memory Raster" Dataset in case of CreateCopy. |
protected static Driver |
getMemoryDriver()
return a "In Memory" Driver which need to be used when using the CreateCopy method. |
void |
setOutput(Object output)
Sets the destination to the given Object , usually a
File or a FileImageOutputStreamExt . |
void |
write(IIOImage image)
This method is a shorthand for write(null, image, null) . |
void |
write(IIOMetadata streamMetadata,
IIOImage image,
ImageWriteParam param)
Write the input image to the output. |
void |
write(RenderedImage image)
This method is a shorthand for write(null, new IIOImage(image,
null, null), null) . |
Methods inherited from class ImageWriter |
---|
abort, abortRequested, addIIOWriteProgressListener, addIIOWriteWarningListener, canInsertEmpty, canInsertImage, canRemoveImage, canReplaceImageMetadata, canReplacePixels, canReplaceStreamMetadata, canWriteEmpty, canWriteRasters, canWriteSequence, clearAbortRequest, dispose, endInsertEmpty, endReplacePixels, endWriteEmpty, endWriteSequence, getAvailableLocales, getDefaultWriteParam, getLocale, getNumThumbnailsSupported, getOriginatingProvider, getOutput, getPreferredThumbnailSizes, prepareInsertEmpty, prepareReplacePixels, prepareWriteEmpty, prepareWriteSequence, processImageComplete, processImageProgress, processImageStarted, processThumbnailComplete, processThumbnailProgress, processThumbnailStarted, processWarningOccurred, processWarningOccurred, processWriteAborted, removeAllIIOWriteProgressListeners, removeAllIIOWriteWarningListeners, removeIIOWriteProgressListener, removeIIOWriteWarningListener, removeImage, replaceImageMetadata, replacePixels, replacePixels, replaceStreamMetadata, reset, setLocale, writeInsert, writeToSequence |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected File outputFile
Constructor Detail |
---|
public GDALImageWriter(ImageWriterSpi originatingProvider)
GDALImageWriter
Method Detail |
---|
protected static final int getMaxMemorySizeForGDALMemoryDataset()
DEFAULT_GDALMEMORYRASTER_MAXSIZE
protected static Driver getMemoryDriver()
public IIOMetadata getDefaultStreamMetadata(ImageWriteParam param)
getDefaultStreamMetadata
in class ImageWriter
public void write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param) throws IOException
The output must have been set beforehand using the setOutput
method.
An ImageWriteParam
may optionally be supplied to control
the writing process. If param
is null
, a
default write param will be used.
If the supplied ImageWriteParam
contains optional setting
values not supported by this writer (e.g. progressive encoding
or any format-specific settings), they will be ignored.
write
in class ImageWriter
streamMetadata
- an IIOMetadata
object representing stream
metadata, or null
to use default values.image
- an IIOImage
object containing an image, and
metadata to be written. Note that metadata is actually
supposed to be an instance of
GDALCommonIIOImageMetadata
.
GDALWritableCommonIIOImageMetadata
may be used to
set properties from other type of ImageMetadata to a
format which is understood by this writer.param
- an ImageWriteParam
, or null
to use a default ImageWriteParam
.
IllegalStateException
- if the output has not been set.
IllegalArgumentException
- if image
is null
.
IOException
- if an error occurs during writing.public IIOMetadata getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)
getDefaultImageMetadata
in class ImageWriter
public IIOMetadata convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)
convertStreamMetadata
in interface ImageTranscoder
convertStreamMetadata
in class ImageWriter
public IIOMetadata convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)
convertImageMetadata
in interface ImageTranscoder
convertImageMetadata
in class ImageWriter
public void setOutput(Object output)
Object
, usually a
File
or a FileImageOutputStreamExt
.
setOutput
in class ImageWriter
output
- the Object
to use for future writing.public void write(IIOImage image) throws IOException
write(null, image, null)
.
write
in class ImageWriter
image
- an IIOImage
object containing an image,
thumbnails, and metadata to be written to the output.
IOException
public void write(RenderedImage image) throws IOException
write(null, new IIOImage(image,
null, null), null)
.
write
in class ImageWriter
image
- a RenderedImage
to be written.
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |