Class AbstractGridFormat
- All Implemented Interfaces:
Format
- Direct Known Subclasses:
ArcGridFormat,BaseGDALGridFormat,GeoPackageFormat,GeoTiffFormat,GrassCoverageFormat,ImageMosaicFormat,ImagePyramidFormat,JP2KFormat,MBTilesFormat,NetCDFFormat,PGRasterFormat,TPKFormat,UnknownFormat,WorldImageFormat
For example the ArcGridFormat has the following method which sets up all the required information:
private void setInfo(){ HashMap info=new
HashMap(); info.put("name", "ArcGrid"); info.put("description", "Arc Grid
Coverage Format"); info.put("vendor", "Geotools"); info.put("docURL",
"http://gdal.velocet.ca/projects/aigrid/index.html"); info.put("version",
"1.0"); mInfo=info; readParameters=new GeneralParameterDescriptor[2];
readParameters[0]=ArcGridOperationParameter.getGRASSReadParam();
readParameters[0]=ArcGridOperationParameter.getCompressReadParam();
writeParameters=new GeneralParameterDescriptor[2];
writeParameters[0]=ArcGridOperationParameter.getGRASSWriteParam();
writeParameters[0]=ArcGridOperationParameter.getCompressWriteParam();
}
- Author:
- jeichar, Simone Giannecchini, GeoSolutions
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ParameterDescriptor<Color>Control the background color to be used where the input was transparentstatic final DefaultParameterDescriptor<int[]>ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#read(GeneralParameterValue[])method to specify the band indices of the input grid coverage that are going to be in the resulting coverage.static final ParameterDescriptor<DecimationPolicy>ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#read(GeneralParameterValue[])method in order to specify the policy a reader should adopt when setting read parameters when evaluating a needed resolution.static final ParameterDescriptor<List>Optional Elevation value for this mosaic.static final ParameterDescriptor<String>Control the footprint management.static final DefaultParameterDescriptor<GeoToolsWriteParams>ThisGeneralParameterValuecan be provided to theGridCoverageWriters through theGridCoverageWriter#write(org.geotools.api.coverage.grid.GridCoverage, GeneralParameterValue[])method in order to control the writing process in terms of compression, tiling, etc.GridGeometry2Dstatic final ParameterDescriptor<Color>Control the transparency of the input coverages.static final ParameterDescriptor<Interpolation>Control the interpolation to be used in the eventual image processing done while reading dataThe Map object is used by the information methods(such as getName()) as a data source.static final DefaultParameterDescriptor<OverviewPolicy>ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#read(GeneralParameterValue[])method in order to specify the policy a reader should adopt when choosing the right overview during a read operation.static final DefaultParameterDescriptor<ProgressListener>ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#write(GeneralParameterValue[])method in order to monitor a writing processstatic final DefaultParameterDescriptor<GridGeometry2D>ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#read(GeneralParameterValue[])method in order to pick up the best matching resolution level and (soon) the best matching area.protected ParameterValueGroupParameterValueGroupthat controls the reading process for aGridCoverageReaderthrough theGridCoverageReader.read(org.geotools.api.parameter.GeneralParameterValue[])method.static final DefaultParameterDescriptor<Boolean>ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader.read(GeneralParameterValue[])method in order to specify the whether eventual value rescaling should be performed, or the original pixel value preservedstatic final DefaultParameterDescriptor<String>ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#read(GeneralParameterValue[])method in order to specify the suggested size of tiles to avoid long time reading occurring with ImageN ImageRead on striped images.static final Stringstatic final ParameterDescriptor<List>Optional Time value for this mosaic.static final DefaultParameterDescriptor<Boolean>ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader.read(GeneralParameterValue[])method in order to specify the type of image read operation requested: using a ImageN ImageRead operation (leveraging on Deferred Execution Model, Tile Caching,...), or the directImageReader's read methods.protected ParameterValueGroupParameterValueGroupthat controls the writing process for aGridCoverageWriterthrough theGridCoverageWriter.write(org.geotools.api.coverage.grid.GridCoverage, org.geotools.api.parameter.GeneralParameterValue[])method. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanTells me if thisFormatcan read the providedinput.abstract booleanTells me if thisFormatcan read the providedinput.booleanstatic CoordinateReferenceSystemgetDefaultCRSabstract GeoToolsWriteParamsReturns an instance ofImageWriteParamthat can be used to control a subsequentGridCoverageWriter.write(org.geotools.api.coverage.grid.GridCoverage, org.geotools.api.parameter.GeneralParameterValue[]);Description of the file format.Documentation URL for the format.getName()Name of the file format.abstract AbstractGridCoverage2DReaderGets aGridCoverageReaderfor this format able to create coverages out of thesourceobject.abstract AbstractGridCoverage2DReaderGets aGridCoverageReaderfor this format able to create coverages out of thesourceobject using the providedhints.Retrieve the parameter information for areadoperation.Vendor or agency for the format.Version number of the format.Retrieve the parameter information for awriteoperation.abstract GridCoverageWriterRetrieves aGridCoverageWritersuitable for writing to the provideddestinationwith this format.abstract GridCoverageWriterCall the accepts() method before asking for a writer to determine if the current object is supported.
-
Field Details
-
mInfo
The Map object is used by the information methods(such as getName()) as a data source. The keys in the Map object (for the associated method) are as follows: getName() key = "name" value type=String getDescription() key = "description" value type=String getVendor() key = "vendor" value type=String getDocURL() key = "docURL" value type=String getVersion() key = "version" value type=String Naturally, any methods that are overridden need not have an entry in the Map -
readParameters
ParameterValueGroupthat controls the reading process for aGridCoverageReaderthrough theGridCoverageReader.read(org.geotools.api.parameter.GeneralParameterValue[])method. -
writeParameters
ParameterValueGroupthat controls the writing process for aGridCoverageWriterthrough theGridCoverageWriter.write(org.geotools.api.coverage.grid.GridCoverage, org.geotools.api.parameter.GeneralParameterValue[])method. -
READ_GRIDGEOMETRY2D
ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#read(GeneralParameterValue[])method in order to pick up the best matching resolution level and (soon) the best matching area. -
PROGRESS_LISTENER
ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#write(GeneralParameterValue[])method in order to monitor a writing process -
GEOTOOLS_WRITE_PARAMS
ThisGeneralParameterValuecan be provided to theGridCoverageWriters through theGridCoverageWriter#write(org.geotools.api.coverage.grid.GridCoverage, GeneralParameterValue[])method in order to control the writing process in terms of compression, tiling, etc.GridGeometry2D -
USE_IMAGEN_IMAGEREAD
ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader.read(GeneralParameterValue[])method in order to specify the type of image read operation requested: using a ImageN ImageRead operation (leveraging on Deferred Execution Model, Tile Caching,...), or the directImageReader's read methods. -
OVERVIEW_POLICY
ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#read(GeneralParameterValue[])method in order to specify the policy a reader should adopt when choosing the right overview during a read operation. -
DECIMATION_POLICY
ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#read(GeneralParameterValue[])method in order to specify the policy a reader should adopt when setting read parameters when evaluating a needed resolution. -
SUGGESTED_TILE_SIZE
ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#read(GeneralParameterValue[])method in order to specify the suggested size of tiles to avoid long time reading occurring with ImageN 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. -
BANDS
ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader#read(GeneralParameterValue[])method to specify the band indices of the input grid coverage that are going to be in the resulting coverage. The order of the bands on the output coverage is the order of the indices in the parameter. Value should be an integer array (int[]) containing the band indices in the desired order. Duplicate or multiple appearances of the same band index are allowed. -
TILE_SIZE_SEPARATOR
- See Also:
-
INPUT_TRANSPARENT_COLOR
Control the transparency of the input coverages. -
BACKGROUND_COLOR
Control the background color to be used where the input was transparent -
TIME
Optional Time value for this mosaic. -
ELEVATION
Optional Elevation value for this mosaic. -
INTERPOLATION
Control the interpolation to be used in the eventual image processing done while reading data -
FOOTPRINT_BEHAVIOR
Control the footprint management. -
RESCALE_PIXELS
ThisGeneralParameterValuecan be provided to theGridCoverageReaders through theGridCoverageReader.read(GeneralParameterValue[])method in order to specify the whether eventual value rescaling should be performed, or the original pixel value preserved
-
-
Constructor Details
-
AbstractGridFormat
public AbstractGridFormat()
-
-
Method Details
-
getName
Description copied from interface:FormatName of the file format. -
getDescription
Description copied from interface:FormatDescription of the file format. If no description, the value will benull.- Specified by:
getDescriptionin interfaceFormat- See Also:
-
getVendor
Description copied from interface:FormatVendor or agency for the format. -
getDocURL
Description copied from interface:FormatDocumentation URL for the format. -
getVersion
Description copied from interface:FormatVersion number of the format.- Specified by:
getVersionin interfaceFormat- See Also:
-
getReader
Gets aGridCoverageReaderfor this format able to create coverages out of thesourceobject.In case this
Formatcannot reader the providedsourceobjectnullis returned.- Parameters:
source- The source object to parse.- Returns:
- A reader for this
Formator null.
-
getReader
Gets aGridCoverageReaderfor this format able to create coverages out of thesourceobject using the providedhints.In case this
Formatcannot reader the providedsourceobjectnullis returned. -
getWriter
Retrieves aGridCoverageWritersuitable for writing to the provideddestinationwith this format.In case no writers are available
nullis returned.- Parameters:
destination- The destinatin where to write.- Returns:
- A
GridCoverageWritersuitable for writing to the provideddestinationwith this format.
-
accepts
Tells me if thisFormatcan read the providedinput.- Parameters:
source- The input object to test for suitability.- Returns:
- True if this format can read this object, False otherwise.
-
accepts
Tells me if thisFormatcan read the providedinput.- Parameters:
source- The input object to test for suitability.hints-Hintsto control the accepts internal machinery.- Returns:
- True if this format can read this object, False otherwise.
-
equals
- See Also:
-
org.geotools.data.coverage.grid.Format#equals(org.geotools.data.coverage.grid.Format)
-
getReadParameters
Description copied from interface:FormatRetrieve the parameter information for areadoperation.- Specified by:
getReadParametersin interfaceFormat
-
getWriteParameters
Description copied from interface:FormatRetrieve the parameter information for awriteoperation.- Specified by:
getWriteParametersin interfaceFormat
-
getDefaultCRS
getDefaultCRSThis method provides the user with a default crs WGS84
-
getDefaultImageIOWriteParameters
Returns an instance ofImageWriteParamthat can be used to control a subsequentGridCoverageWriter.write(org.geotools.api.coverage.grid.GridCoverage, org.geotools.api.parameter.GeneralParameterValue[]);Be careful with using the
ImageWriteParamsince their usage is still experimental.- Returns:
- an instance of
ImageWriteParam.
-
getWriter
Call the accepts() method before asking for a writer to determine if the current object is supported.- Parameters:
destination- the destination object to write a WorldImage tohints-Hintsto control the internal machinery.- Returns:
- a new WorldImageWriter for the destination
-