/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2005-2008, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotools.gce.geotiff;
import it.geosolutions.imageio.plugins.tiff.TIFFImageWriteParam;
import java.util.Locale;
import javax.imageio.ImageWriteParam;
import org.geotools.coverage.grid.io.imageio.GeoToolsWriteParams;
/**
* Subclass of {@link GeoToolsWriteParams} the allows the user to specify
* parameters to control the process of writing out a GeoTiff file through
* standards {@link ImageWriteParam} (with possible extensions).
*
* <p>
* This class allows the user to control the output tile size for the GeoTiff
* file we are going to create as well as the possible compression.
*
* <p>
* An example of usage of this parameters is as follows:
*
* <pre>
* <code>
* //getting a format
* final GeoTiffFormat format = new GeoTiffFormat();
*
* //getting the write parameters
* final GeoTiffWriteParams wp = new GeoTiffWriteParams();
*
* //setting compression to LZW
* wp.setCompressionMode(GeoTiffWriteParams.MODE_EXPLICIT);
* wp.setCompressionType("LZW");
* wp.setCompressionQuality(0.75F);
*
* //setting the tile size to 256X256
* wp.setTilingMode(GeoToolsWriteParams.MODE_EXPLICIT);
* wp.setTiling(256, 256);
*
* //setting the write parameters for this geotiff
* final ParameterValueGroup params = format.getWriteParameters();
* params.parameter(
* AbstractGridFormat.GEOTOOLS_WRITE_PARAMS.getName().toString())
* .setValue(wp);
*
* //get a reader to the input File
* GridCoverageReader reader = new GeoTiffReader(inFile, null);
* GridCoverageWriter writer = null;
* GridCoverage2D gc = null;
* if (reader != null) {
*
* // reading the coverage
* gc = (GridCoverage2D) reader.read(null);
* if (gc != null) {
* final File writeFile = new File(new StringBuffer(writedir
* .getAbsolutePath()).append(File.separatorChar)
* .append(gc.getName().toString()).append(".tiff")
* .toString());
* writer = format.getWriter(writeFile);
* writer.write(gc, (GeneralParameterValue[]) params.values()
* .toArray(new GeneralParameterValue[1]));
* }
* </code>
* </pre>
*
* @author Simone Giannecchini
* @since 2.3.x
*
*
*
*
* @source $URL$
*/
public class GeoTiffWriteParams extends GeoToolsWriteParams {
/**
* Default constructor.
*/
public GeoTiffWriteParams() {
super(new TIFFImageWriteParam(Locale.getDefault()));
}
public void setForceToBigTIFF(final boolean forceToBigTIFF) {
((TIFFImageWriteParam) adaptee).setForceToBigTIFF(forceToBigTIFF);
}
public boolean isForceToBigTIFF() {
return ((TIFFImageWriteParam) adaptee).isForceToBigTIFF();
}
}