org.geotools.gce.imagepyramid
Class ImagePyramidFormat

Object
  extended by AbstractGridFormat
      extended by ImagePyramidFormat
All Implemented Interfaces:
Format

public final class ImagePyramidFormat
extends AbstractGridFormat
implements Format

This class implements the basic format capabilities for a coverage format.

Author:
Simone Giannecchini (simboss), Stefan Alfons Krueger (alfonx), Wikisquare.de : Support for jar:file:foo.jar/bar.properties like URLs

Field Summary
static ParameterDescriptor<Boolean> ALLOW_MULTITHREADING
          Control the threading behavior for this plugin.
static ParameterDescriptor<double[]> BACKGROUND_VALUES
          Control the background values for the output coverage
static ParameterDescriptor<Boolean> FADING
          Control the type of the final mosaic.
static ParameterDescriptor<Double> INPUT_IMAGE_THRESHOLD_VALUE
          Deprecated. we don't use this param anymore, since it is confusing and interact badly with the transparency
static ParameterDescriptor<Color> INPUT_TRANSPARENT_COLOR
          Control the transparency of the input coverages.
static ParameterDescriptor<Integer> MAX_ALLOWED_TILES
          Control the thresholding on the input coverage
static ParameterDescriptor<Color> OUTPUT_TRANSPARENT_COLOR
          Control the transparency of the output coverage.
static DefaultParameterDescriptor<String> SUGGESTED_TILE_SIZE
          This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify the suggested size of tiles to avoid long time reading occurring with JAI ImageRead on striped images.
static String TILE_SIZE_SEPARATOR
           
 
Fields inherited from class AbstractGridFormat
GEOTOOLS_WRITE_PARAMS, mInfo, OVERVIEW_POLICY, READ_GRIDGEOMETRY2D, readParameters, USE_JAI_IMAGEREAD, writeParameters
 
Constructor Summary
ImagePyramidFormat()
          Creates an instance and sets the metadata.
 
Method Summary
 boolean accepts(Object source)
          Tells me if this Format can read the provided input.
 GeoToolsWriteParams getDefaultImageIOWriteParameters()
          Throw an exception since this plugin is readonly.
 ImagePyramidReader getReader(Object source)
          Retrieves a reader for this source object in case the provided source can be read using this plugin.
 ImagePyramidReader getReader(Object source, Hints hints)
          Retrieves a reader for this source object in case the provided source can be read using this plugin.
 GridCoverageWriter getWriter(Object destination)
          This methods throw an UnsupportedOperationException because this plugiin si read only.
 
Methods inherited from class AbstractGridFormat
equals, getDefaultCRS, getDescription, getDocURL, getName, getReadParameters, getVendor, getVersion, getWriteParameters
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface Format
getDescription, getDocURL, getName, getReadParameters, getVendor, getVersion, getWriteParameters
 

Field Detail

SUGGESTED_TILE_SIZE

public static final DefaultParameterDescriptor<String> SUGGESTED_TILE_SIZE
This GeneralParameterValue can be provided to the GridCoverageReaders through the GridCoverageReader.read(GeneralParameterValue[]) method in order to specify the suggested size of tiles to avoid long time reading occurring with JAI ImageRead on striped images. (Images with tiles Nx1) Value should be a String in the form of "W,H" (without quotes) where W is a number representing the suggested tileWidth and H is a number representing the suggested tileHeight.


TILE_SIZE_SEPARATOR

public static final String TILE_SIZE_SEPARATOR
See Also:
Constant Field Values

FADING

public static final ParameterDescriptor<Boolean> FADING
Control the type of the final mosaic.


INPUT_TRANSPARENT_COLOR

public static final ParameterDescriptor<Color> INPUT_TRANSPARENT_COLOR
Control the transparency of the input coverages.


OUTPUT_TRANSPARENT_COLOR

public static final ParameterDescriptor<Color> OUTPUT_TRANSPARENT_COLOR
Control the transparency of the output coverage.


INPUT_IMAGE_THRESHOLD_VALUE

public static final ParameterDescriptor<Double> INPUT_IMAGE_THRESHOLD_VALUE
Deprecated. we don't use this param anymore, since it is confusing and interact badly with the transparency
Control the thresholding on the input coverage.


MAX_ALLOWED_TILES

public static final ParameterDescriptor<Integer> MAX_ALLOWED_TILES
Control the thresholding on the input coverage


ALLOW_MULTITHREADING

public static final ParameterDescriptor<Boolean> ALLOW_MULTITHREADING
Control the threading behavior for this plugin. This parameter contains the number of thread that we should use to load the granules. Default value is 0 which means not additional thread, max value is 8.


BACKGROUND_VALUES

public static final ParameterDescriptor<double[]> BACKGROUND_VALUES
Control the background values for the output coverage

Constructor Detail

ImagePyramidFormat

public ImagePyramidFormat()
Creates an instance and sets the metadata.

Method Detail

getReader

public ImagePyramidReader getReader(Object source)
Retrieves a reader for this source object in case the provided source can be read using this plugin.

Specified by:
getReader in class AbstractGridFormat
Parameters:
source - Object
Returns:
An ImagePyramidReader if the provided object can be read using this plugin or null.

getWriter

public GridCoverageWriter getWriter(Object destination)
This methods throw an UnsupportedOperationException because this plugiin si read only.

Specified by:
getWriter in class AbstractGridFormat
Parameters:
destination - The destinatin where to write.
Returns:
A GridCoverageWriter suitable for writing to the provided destination with this format.

accepts

public boolean accepts(Object source)
Description copied from class: AbstractGridFormat
Tells me if this Format can read the provided input.

Specified by:
accepts in class AbstractGridFormat
Parameters:
source - The input object to test for suitablilty.
Returns:
True if this format can read this object, False otherwise.
See Also:
org.geotools.data.coverage.grid.AbstractGridFormat#accepts(Object input)

getReader

public ImagePyramidReader getReader(Object source,
                                    Hints hints)
Retrieves a reader for this source object in case the provided source can be read using this plugin.

Specified by:
getReader in class AbstractGridFormat
Parameters:
source - Object
hints - Hints to control the reader behaviour.
Returns:
An ImagePyramidReader if the provided object can be read using this plugin or null.

getDefaultImageIOWriteParameters

public GeoToolsWriteParams getDefaultImageIOWriteParameters()
Throw an exception since this plugin is readonly.

Specified by:
getDefaultImageIOWriteParameters in class AbstractGridFormat
Returns:
nothing.


Copyright © 1996-2009 Geotools. All Rights Reserved.