org.gdal.gdal
Class gdal

java.lang.Object
  extended by org.gdal.gdal.gdal

public class gdal
extends Object

Class gdal is an uninstanciable class providing various utility functions as static methods.

In particular, it provides :


Method Summary
static void AllRegister()
          Register all known configured GDAL drivers.
static void ApplyGeoTransform(double[] padfGeoTransform, double dfPixel, double dfLine, double[] pdfGeoX, double[] pdfGeoY)
          Apply GeoTransform to x/y coordinate.
static Dataset AutoCreateWarpedVRT(Dataset src_ds)
          Create virtual warped dataset automatically.
static Dataset AutoCreateWarpedVRT(Dataset src_ds, String src_wkt)
          Create virtual warped dataset automatically.
static Dataset AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt)
          Create virtual warped dataset automatically.
static Dataset AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg)
          Create virtual warped dataset automatically.
static Dataset AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg, double maxError)
          Create virtual warped dataset automatically.
static int ComputeMedianCutPCT(Band red, Band green, Band blue, int num_colors, ColorTable colors)
          Compute optimal PCT for RGB image.
static int ComputeMedianCutPCT(Band red, Band green, Band blue, int num_colors, ColorTable colors, ProgressCallback callback)
          Compute optimal PCT for RGB image.
static int ComputeProximity(Band srcBand, Band proximityBand)
          Compute the proximity of all pixels in the image to a set of pixels in the source image.
static int ComputeProximity(Band srcBand, Band proximityBand, Vector options)
          Compute the proximity of all pixels in the image to a set of pixels in the source image.
static int ComputeProximity(Band srcBand, Band proximityBand, Vector options, ProgressCallback callback)
          Compute the proximity of all pixels in the image to a set of pixels in the source image.
static int ContourGenerate(Band srcBand, double contourInterval, double contourBase, double[] fixedLevelCount, int useNoData, double noDataValue, Layer dstLayer, int idField, int elevField)
           
static int ContourGenerate(Band srcBand, double contourInterval, double contourBase, double[] fixedLevelCount, int useNoData, double noDataValue, Layer dstLayer, int idField, int elevField, ProgressCallback callback)
           
static String CPLBinaryToHex(byte[] nBytes)
           
static byte[] CPLHexToBinary(String pszHex)
           
static int DataTypeIsComplex(int eDataType)
          Is data type complex?
static void Debug(String msg_class, String message)
          Display a debugging message.
static String DecToDMS(double dfAngle, String pszAxis)
           
static String DecToDMS(double dfAngle, String pszAxis, int nPrecision)
           
static double DecToPackedDMS(double dfDec)
           
static int DitherRGB2PCT(Band red, Band green, Band blue, Band target, ColorTable colors)
          24bit to 8bit conversion with dithering.
static int DitherRGB2PCT(Band red, Band green, Band blue, Band target, ColorTable colors, ProgressCallback callback)
          24bit to 8bit conversion with dithering.
static void Error(int msg_class, int err_code, String msg)
          Report an error.
static void ErrorReset()
          Erase any traces of previous errors.
static String EscapeString(byte[] byteArray, int scheme)
          Apply escaping to string to preserve special characters.
static String EscapeString(String str, int scheme)
          Apply escaping to string to preserve special characters.
static void FileFromMemBuffer(String fileName, byte[] byteArray)
          Create memory "file" from a buffer.
static int FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations)
          Fill selected raster regions by interpolation from the edges.
static int FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations, Vector options)
          Fill selected raster regions by interpolation from the edges.
static int FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations, Vector options, ProgressCallback callback)
          Fill selected raster regions by interpolation from the edges.
static void FinderClean()
           
static String FindFile(String pszClass, String utf8_path)
           
static int GCPsToGeoTransform(GCP[] gcpArray, double[] outGeoTransform)
          Generate Geotransform from GCPs.
static int GCPsToGeoTransform(GCP[] gcpArray, double[] outGeoTransform, int bApproxOK)
          Generate Geotransform from GCPs.
static double GDAL_GCP_GCPLine_get(GCP gcp)
           
static void GDAL_GCP_GCPLine_set(GCP gcp, double dfGCPLine)
           
static double GDAL_GCP_GCPPixel_get(GCP gcp)
           
static void GDAL_GCP_GCPPixel_set(GCP gcp, double dfGCPPixel)
           
static double GDAL_GCP_GCPX_get(GCP gcp)
           
static void GDAL_GCP_GCPX_set(GCP gcp, double dfGCPX)
           
static double GDAL_GCP_GCPY_get(GCP gcp)
           
static void GDAL_GCP_GCPY_set(GCP gcp, double dfGCPY)
           
static double GDAL_GCP_GCPZ_get(GCP gcp)
           
static void GDAL_GCP_GCPZ_set(GCP gcp, double dfGCPZ)
           
static double GDAL_GCP_get_GCPLine(GCP gcp)
           
static double GDAL_GCP_get_GCPPixel(GCP gcp)
           
static double GDAL_GCP_get_GCPX(GCP gcp)
           
static double GDAL_GCP_get_GCPY(GCP gcp)
           
static double GDAL_GCP_get_GCPZ(GCP gcp)
           
static String GDAL_GCP_get_Id(GCP gcp)
           
static String GDAL_GCP_get_Info(GCP gcp)
           
static String GDAL_GCP_Id_get(GCP gcp)
           
static void GDAL_GCP_Id_set(GCP gcp, String pszId)
           
static String GDAL_GCP_Info_get(GCP gcp)
           
static void GDAL_GCP_Info_set(GCP gcp, String pszInfo)
           
static void GDAL_GCP_set_GCPLine(GCP gcp, double dfGCPLine)
           
static void GDAL_GCP_set_GCPPixel(GCP gcp, double dfGCPPixel)
           
static void GDAL_GCP_set_GCPX(GCP gcp, double dfGCPX)
           
static void GDAL_GCP_set_GCPY(GCP gcp, double dfGCPY)
           
static void GDAL_GCP_set_GCPZ(GCP gcp, double dfGCPZ)
           
static void GDAL_GCP_set_Id(GCP gcp, String pszId)
           
static void GDAL_GCP_set_Info(GCP gcp, String pszInfo)
           
static void GDALDestroyDriverManager()
           
static String[] GeneralCmdLineProcessor(String[] args)
          General utility option processing.
static String[] GeneralCmdLineProcessor(String[] args, int options)
          General utility option processing.
static Vector GeneralCmdLineProcessor(Vector args)
          General utility option processing.
static Vector GeneralCmdLineProcessor(Vector args, int options)
          General utility option processing.
static int GetCacheMax()
          Get maximum cache memory.
static int GetCacheUsed()
          Get cache memory used.
static String GetColorInterpretationName(int eColorInterp)
          Get name of color interpretation.
static String GetConfigOption(String key)
          Get the value of a configuration option.
static String GetConfigOption(String key, String defaultValue)
          Get the value of a configuration option.
static int GetDataTypeByName(String dataTypeName)
          Get data type by symbolic name.
static String GetDataTypeName(int eDataType)
          Get name of data type.
static int GetDataTypeSize(int eDataType)
          Get data type size in bits.
static Driver GetDriver(int iDriver)
          Fetch driver by index.
static Driver GetDriverByName(String name)
          Fetch a driver based on the short name.
static int GetDriverCount()
          Fetch the number of registered drivers.
static String GetLastErrorMsg()
          Get the last error message.
static int GetLastErrorNo()
          Fetch the last error number.
static int GetLastErrorType()
          Fetch the last error type.
static String GetPaletteInterpretationName(int ePaletteInterp)
          Get name of palette interpretation.
static String GOA2GetAccessToken(String pszRefreshToken, String pszScope)
           
static String GOA2GetAuthorizationURL(String pszScope)
           
static String GOA2GetRefreshToken(String pszAuthToken, String pszScope)
           
static int GridCreate(String algorithmOptions, double[][] points, double xMin, double xMax, double yMin, double yMax, int xSize, int ySize, int dataType, ByteBuffer nioBuffer)
           
static int GridCreate(String algorithmOptions, double[][] points, double xMin, double xMax, double yMin, double yMax, int xSize, int ySize, int dataType, ByteBuffer nioBuffer, ProgressCallback callback)
           
static Driver IdentifyDriver(String name)
          Identify the driver that can open a raster file.
static Driver IdentifyDriver(String name, Vector fileList)
          Identify the driver that can open a raster file.
static double[] InvGeoTransform(double[] gt_in)
          Invert Geotransform.
static int InvGeoTransform(double[] gt_in, double[] gt_out)
          Invert Geotransform.
static int Mkdir(String path, int mode)
          Create a directory.
static Dataset Open(String name)
          Open a raster file as a Dataset object.
static Dataset Open(String name, int eAccess)
          Open a raster file as a Dataset object.
static Dataset OpenShared(String name)
          Open a raster file as a Dataset object.
static Dataset OpenShared(String name, int eAccess)
          Open a raster file as a GDALDataset.
static double PackedDMSToDec(double dfPacked)
           
static XMLNode ParseXMLString(String xmlString)
          Parse an XML string into tree form.
static int Polygonize(Band srcBand, Band maskBand, Layer outLayer, int iPixValField)
          Create polygon coverage from raster data.
static int Polygonize(Band srcBand, Band maskBand, Layer outLayer, int iPixValField, Vector options)
          Create polygon coverage from raster data.
static int Polygonize(Band srcBand, Band maskBand, Layer outLayer, int iPixValField, Vector options, ProgressCallback callback)
          Create polygon coverage from raster data.
static void PopErrorHandler()
          Pop error handler off stack.
static void PopFinderLocation()
           
static int PushErrorHandler()
          Push the quiet error handler.
static int PushErrorHandler(String callbackName)
          Push a new error handler.
static void PushFinderLocation(String utf8_path)
           
static int RasterizeLayer(Dataset dataset, int[] bandNumbers, Layer layer)
          Burn geometries from the specified layer into raster.
static int RasterizeLayer(Dataset dataset, int[] bandNumbers, Layer layer, double[] burn_values)
          Burn geometries from the specified layer into raster.
static int RasterizeLayer(Dataset dataset, int[] bandNumbers, Layer layer, double[] burn_values, Vector options)
          Burn geometries from the specified layer into raster.
static int RasterizeLayer(Dataset dataset, int[] bandNumbers, Layer layer, double[] burn_values, Vector options, ProgressCallback callback)
          Burn geometries from the specified layer into raster.
static Vector ReadDir(String path)
          Read names in a directory.
static Vector ReadDirRecursive(String utf8_path)
           
static int RegenerateOverview(Band srcBand, Band overviewBand)
          Generate downsampled overview.
static int RegenerateOverview(Band srcBand, Band overviewBand, String resampling)
          Generate downsampled overview.
static int RegenerateOverview(Band srcBand, Band overviewBand, String resampling, ProgressCallback callback)
          Generate downsampled overview.
static int RegenerateOverviews(Band srcBand, Band[] overviewBands)
          Generate downsampled overviews.
static int RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling)
          Generate downsampled overviews.
static int RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)
          Generate downsampled overviews.
static int Rename(String oldpath, String newpath)
          Rename a file.
static int ReprojectImage(Dataset src_ds, Dataset dst_ds)
          Reproject image.
static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt)
          Reproject image.
static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt)
          Reproject image.
static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg)
          Reproject image.
static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit)
          Reproject image.
static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError)
          Reproject image.
static int ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)
          Reproject image.
static int Rmdir(String path)
          Delete a directory.
static String SerializeXMLTree(XMLNode xmlnode)
          Convert tree into string document.
static void SetCacheMax(int newSize)
          Set maximum cache memory.
static void SetConfigOption(String key, String value)
          Set a configuration option for GDAL/OGR use.
static int SetErrorHandler()
          Set a quiet global error handler.
static int SetErrorHandler(String callbackName)
          Set a global error handler.
static int SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold)
          Removes small raster polygons.
static int SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness)
          Removes small raster polygons.
static int SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness, Vector options)
          Removes small raster polygons.
static int SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness, Vector options, ProgressCallback callback)
          Removes small raster polygons.
static int Unlink(String fileName)
          Delete a file.
static String VersionInfo()
          Get runtime version information.
static String VersionInfo(String request)
          Get runtime version information.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

GeneralCmdLineProcessor

public static String[] GeneralCmdLineProcessor(String[] args,
                                               int options)
General utility option processing. This function is intended to provide a variety of generic commandline options for all GDAL commandline utilities. It takes care of the following commandline options:

The typical usage looks something like the following. Note that the formats should be registered so that the --formats and --format options will work properly.

  public static void main( Strings[] args )
  { 
    gdal.AllRegister();

    args = gdal.GeneralCmdLineProcessor( args, 0 );
  }
 

Parameters:
args - the argument list array
options - currently unused
Returns:
updated argument list array.
Since:
Java bindings 1.7.0

GeneralCmdLineProcessor

public static String[] GeneralCmdLineProcessor(String[] args)
General utility option processing. Same as below with options == 0

Since:
Java bindings 1.7.0
See Also:
GeneralCmdLineProcessor(String[] args, int options)

InvGeoTransform

public static double[] InvGeoTransform(double[] gt_in)
Invert Geotransform.

This function will invert a standard 3x2 set of GeoTransform coefficients. This converts the equation from being pixel to geo to being geo to pixel.

Parameters:
gt_in - Input geotransform (allocated array of six doubles - unaltered).
Returns:
an array of six doubles with the inverted geotransform on success or null if the equation is uninvertable.
Since:
Java bindings 1.7.0

Debug

public static void Debug(String msg_class,
                         String message)
Display a debugging message. The category argument is used in conjunction with the CPL_DEBUG environment variable to establish if the message should be displayed. If the CPL_DEBUG environment variable is not set, no debug messages are emitted (use Error(gdalconst.CE_Warning,...) to ensure messages are displayed). If CPL_DEBUG is set, but is an empty string or the word "ON" then all debug messages are shown. Otherwise only messages whose category appears somewhere within the CPL_DEBUG value are displayed (as determinted by strstr()).

Categories are usually an identifier for the subsystem producing the error. For instance "GDAL" might be used for the GDAL core, and "TIFF" for messages from the TIFF translator.

Parameters:
msg_class - name of the debugging message category.
message - message to display.

SetErrorHandler

public static int SetErrorHandler(String callbackName)
Set a global error handler. This installs a global error handler. Note; if a local handler is already installed with PushErrorHandler(), the global error handler will not be used until the last local handler is uninstalled with PopErrorHandler().

Parameters:
callbackName - handler function name : "CPLQuietErrorHandler", "CPLDefaultErrorHandler", "CPLLoggingErrorHandler"
Since:
Java bindings 1.10.0

SetErrorHandler

public static int SetErrorHandler()
Set a quiet global error handler. This installs a quiet global error handler. Note; if a local handler is already installed with PushErrorHandler(), the global error handler will not be used until the last local handler is uninstalled with PopErrorHandler().

Since:
Java bindings 1.10.0

PushErrorHandler

public static int PushErrorHandler(String callbackName)
Push a new error handler. This pushes a new error handler on the thread-local error handler stack. This handler will be used untill removed with gdal.PopErrorHandler().

Parameters:
callbackName - handler function name : "CPLQuietErrorHandler", "CPLDefaultErrorHandler", "CPLLoggingErrorHandler"

PushErrorHandler

public static int PushErrorHandler()
Push the quiet error handler. This pushes a new error handler on the thread-local error handler stack. This handler will be used untill removed with gdal.PopErrorHandler().

Since:
Java bindings 1.7.0

Error

public static void Error(int msg_class,
                         int err_code,
                         String msg)
Report an error. This function reports an error in a manner that can be hooked and reported appropriate by different applications.

The msg_class argument can have the value gdalconst.CE_Warning indicating that the message is an informational warning, gdalconst.CE_Failure indicating that the action failed, but that normal recover mechanisms will be used or CE_Fatal meaning that a fatal error has occured, and that Error() should not return.

The default behaviour of Error() is to report errors to stderr, and to abort() after reporting a gdalconst.CE_Fatal error. It is expected that some applications will want to supress error reporting, and will want to install a C++ exception, or longjmp() approach to no local fatal error recovery.

Regardless of how application error handlers or the default error handler choose to handle an error, the error number, and message will be stored for recovery with gdal.GetLastErrorNo() and gdal.GetLastErrorMsg().

Parameters:
msg_class - one of gdalconst.CE_Warning, gdalconst.CE_Failure or gdalconst.CE_Fatal.
err_code - the error number (CPLE_*) from cpl_error.h.
msg - message to display..

GOA2GetAuthorizationURL

public static String GOA2GetAuthorizationURL(String pszScope)

GOA2GetRefreshToken

public static String GOA2GetRefreshToken(String pszAuthToken,
                                         String pszScope)

GOA2GetAccessToken

public static String GOA2GetAccessToken(String pszRefreshToken,
                                        String pszScope)

PopErrorHandler

public static void PopErrorHandler()
Pop error handler off stack.

Discards the current error handler on the error handler stack, and restores the one in use before the last gdal.PushErrorHandler() call. This method has no effect if there are no error handlers on the current threads error handler stack.


ErrorReset

public static void ErrorReset()
Erase any traces of previous errors.

This is normally used to ensure that an error which has been recovered from does not appear to be still in play with high level functions.


EscapeString

public static String EscapeString(byte[] byteArray,
                                  int scheme)
Apply escaping to string to preserve special characters.

Since:
Java bindings 1.7.0
See Also:
EscapeString(String str, int scheme)

EscapeString

public static String EscapeString(String str,
                                  int scheme)
Apply escaping to string to preserve special characters. This function will "escape" a variety of special characters to make the string suitable to embed within a string constant or to write within a text stream but in a form that can be reconstitued to it's original form. The escaping will even preserve zero bytes allowing preservation of raw binary data.

Parameters:
str - the string to escape.
scheme - the encoding scheme to use.
Returns:
an escaped string
Since:
Java bindings 1.7.0

GetLastErrorNo

public static int GetLastErrorNo()
Fetch the last error number.

This is the error number, not the error class.

Returns:
the error number of the last error to occur, or gdalconst.CPLE_None (0) if there are no posted errors.

GetLastErrorType

public static int GetLastErrorType()
Fetch the last error type.

This is the error class, not the error number.

Returns:
the error number of the last error to occur, or gdalconst.CE_None (0) if there are no posted errors.

GetLastErrorMsg

public static String GetLastErrorMsg()
Get the last error message.

Fetches the last error message posted with CPLError(), that hasn't been cleared by gdal.ErrorReset().

Returns:
the last error message, or null if there is no posted error message.

PushFinderLocation

public static void PushFinderLocation(String utf8_path)

PopFinderLocation

public static void PopFinderLocation()

FinderClean

public static void FinderClean()

FindFile

public static String FindFile(String pszClass,
                              String utf8_path)

ReadDir

public static Vector ReadDir(String path)
Read names in a directory.

This function abstracts access to directory contains. It returns a list of strings containing the names of files, and directories in this directory.

Note that no error is issued via CPLError() if the directory path is invalid, though null is returned.

Parameters:
path - the relative, or absolute path of a directory to read.
Returns:
The list of entries in the directory, or null if the directory doesn't exist.
Since:
Java bindings 1.7.0

ReadDirRecursive

public static Vector ReadDirRecursive(String utf8_path)

SetConfigOption

public static void SetConfigOption(String key,
                                   String value)
Set a configuration option for GDAL/OGR use.

Those options are defined as a (key, value) couple. The value corresponding to a key can be got later with the gdal.GetConfigOption() method.

This mechanism is similar to environment variables, but options set with gdal.SetConfigOption() overrides, for gdal.GetConfigOption() point of view, values defined in the environment.

If gdal.SetConfigOption() is called several times with the same key, the value provided during the last call will be used.

Options can also be passed on the command line of most GDAL utilities with the with '--config KEY VALUE'. For example, ogrinfo --config CPL_DEBUG ON ~/data/test/point.shp

Parameters:
key - the key of the option
value - the value of the option
See Also:
GetConfigOption(java.lang.String, java.lang.String)

GetConfigOption

public static String GetConfigOption(String key,
                                     String defaultValue)
Get the value of a configuration option.

The value is the value of a (key, value) option set with gdal.SetConfigOption(). If the given option was no defined with gdal.SetConfigOption(), it tries to find it in environment variables.

Parameters:
key - the key of the option to retrieve
defaultValue - a default value if the key does not match existing defined options (may be null)
Returns:
the value associated to the key, or the default value if not found
See Also:
SetConfigOption(java.lang.String, java.lang.String)

GetConfigOption

public static String GetConfigOption(String key)
Get the value of a configuration option.

Same as below with defaultValue == null

Since:
Java bindings 1.7.0
See Also:
GetConfigOption(String key, String defaultValue)

CPLBinaryToHex

public static String CPLBinaryToHex(byte[] nBytes)

CPLHexToBinary

public static byte[] CPLHexToBinary(String pszHex)

FileFromMemBuffer

public static void FileFromMemBuffer(String fileName,
                                     byte[] byteArray)
Create memory "file" from a buffer. A virtual memory file is created from the passed buffer with the indicated filename. Under normal conditions the filename would need to be absolute and within the /vsimem/ portion of the filesystem.

The filename then can be used with GDAL and OGR drivers that uses the virtual file API.

To free the memory associated with the file, you must use Unlink(fileName), otherwise memory leaks will occur.

Parameters:
fileName - filename (should begin with "/vsimem/")
byteArray - data buffer to put in the file
Since:
Java bindings 1.7.0
See Also:
Unlink(String fileName)

Unlink

public static int Unlink(String fileName)
Delete a file.

Deletes a file object from the file system. This method goes through the VSIFileHandler virtualization and may work on unusual filesystems such as in memory.

Analog of the POSIX unlink() function.

Parameters:
fileName - the path of the file to be deleted.
Returns:
0 on success or -1 on an error.
Since:
Java bindings 1.7.0
See Also:
FileFromMemBuffer(String fileName, byte[] byteArray)

Mkdir

public static int Mkdir(String path,
                        int mode)
Create a directory.

Create a new directory with the indicated mode. The mode is ignored on some platforms. A reasonable default mode value would be 0666. This method goes through the VSIFileHandler virtualization and may work on unusual filesystems such as in memory.

Analog of the POSIX mkdir() function.

Parameters:
path - the path to the directory to create.
mode - the permissions mode.
Returns:
0 on success or -1 on an error.
Since:
Java bindings 1.8.0

Rmdir

public static int Rmdir(String path)
Delete a directory.

Deletes a directory object from the file system. On some systems the directory must be empty before it can be deleted.

This method goes through the VSIFileHandler virtualization and may work on unusual filesystems such as in memory.

Analog of the POSIX rmdir() function.

Parameters:
path - the path of the directory to be deleted.
Returns:
0 on success or -1 on an error.
Since:
Java bindings 1.8.0

Rename

public static int Rename(String oldpath,
                         String newpath)
Rename a file.

Renames a file object in the file system. It should be possible to rename a file onto a new filesystem, but it is safest if this function is only used to rename files that remain in the same directory.

This method goes through the VSIFileHandler virtualization and may work on unusual filesystems such as in memory.

Analog of the POSIX rename() function.

Parameters:
oldpath - the name of the file to be renamed.
newpath - the name the file should be given.
Returns:
0 on success or -1 on an error.
Since:
Java bindings 1.8.0

GDAL_GCP_GCPX_get

public static double GDAL_GCP_GCPX_get(GCP gcp)

GDAL_GCP_GCPX_set

public static void GDAL_GCP_GCPX_set(GCP gcp,
                                     double dfGCPX)

GDAL_GCP_GCPY_get

public static double GDAL_GCP_GCPY_get(GCP gcp)

GDAL_GCP_GCPY_set

public static void GDAL_GCP_GCPY_set(GCP gcp,
                                     double dfGCPY)

GDAL_GCP_GCPZ_get

public static double GDAL_GCP_GCPZ_get(GCP gcp)

GDAL_GCP_GCPZ_set

public static void GDAL_GCP_GCPZ_set(GCP gcp,
                                     double dfGCPZ)

GDAL_GCP_GCPPixel_get

public static double GDAL_GCP_GCPPixel_get(GCP gcp)

GDAL_GCP_GCPPixel_set

public static void GDAL_GCP_GCPPixel_set(GCP gcp,
                                         double dfGCPPixel)

GDAL_GCP_GCPLine_get

public static double GDAL_GCP_GCPLine_get(GCP gcp)

GDAL_GCP_GCPLine_set

public static void GDAL_GCP_GCPLine_set(GCP gcp,
                                        double dfGCPLine)

GDAL_GCP_Info_get

public static String GDAL_GCP_Info_get(GCP gcp)

GDAL_GCP_Info_set

public static void GDAL_GCP_Info_set(GCP gcp,
                                     String pszInfo)

GDAL_GCP_Id_get

public static String GDAL_GCP_Id_get(GCP gcp)

GDAL_GCP_Id_set

public static void GDAL_GCP_Id_set(GCP gcp,
                                   String pszId)

GDAL_GCP_get_GCPX

public static double GDAL_GCP_get_GCPX(GCP gcp)

GDAL_GCP_set_GCPX

public static void GDAL_GCP_set_GCPX(GCP gcp,
                                     double dfGCPX)

GDAL_GCP_get_GCPY

public static double GDAL_GCP_get_GCPY(GCP gcp)

GDAL_GCP_set_GCPY

public static void GDAL_GCP_set_GCPY(GCP gcp,
                                     double dfGCPY)

GDAL_GCP_get_GCPZ

public static double GDAL_GCP_get_GCPZ(GCP gcp)

GDAL_GCP_set_GCPZ

public static void GDAL_GCP_set_GCPZ(GCP gcp,
                                     double dfGCPZ)

GDAL_GCP_get_GCPPixel

public static double GDAL_GCP_get_GCPPixel(GCP gcp)

GDAL_GCP_set_GCPPixel

public static void GDAL_GCP_set_GCPPixel(GCP gcp,
                                         double dfGCPPixel)

GDAL_GCP_get_GCPLine

public static double GDAL_GCP_get_GCPLine(GCP gcp)

GDAL_GCP_set_GCPLine

public static void GDAL_GCP_set_GCPLine(GCP gcp,
                                        double dfGCPLine)

GDAL_GCP_get_Info

public static String GDAL_GCP_get_Info(GCP gcp)

GDAL_GCP_set_Info

public static void GDAL_GCP_set_Info(GCP gcp,
                                     String pszInfo)

GDAL_GCP_get_Id

public static String GDAL_GCP_get_Id(GCP gcp)

GDAL_GCP_set_Id

public static void GDAL_GCP_set_Id(GCP gcp,
                                   String pszId)

GCPsToGeoTransform

public static int GCPsToGeoTransform(GCP[] gcpArray,
                                     double[] outGeoTransform,
                                     int bApproxOK)
Generate Geotransform from GCPs.

Given a set of GCPs perform first order fit as a geotransform.

Due to imprecision in the calculations the fit algorithm will often return non-zero rotational coefficients even if given perfectly non-rotated inputs. A special case has been implemented for corner corner coordinates given in TL, TR, BR, BL order. So when using this to get a geotransform from 4 corner coordinates, pass them in this order.

Parameters:
gcpArray - the array of GCP.
outGeoTransform - the six double array in which the affine geotransformation will be returned.
bApproxOK - If 0 the function will fail if the geotransform is not essentially an exact fit (within 0.25 pixel) for all GCPs.
Returns:
1 on success or 0 if there aren't enough points to prepare a geotransform, the pointers are ill-determined or if bApproxOK is 0 and the fit is poor.
Since:
Java bindings 1.7.0

GCPsToGeoTransform

public static int GCPsToGeoTransform(GCP[] gcpArray,
                                     double[] outGeoTransform)
Generate Geotransform from GCPs.

Same as below with bApproxOK == 0

Since:
Java bindings 1.7.0
See Also:
GCPsToGeoTransform(GCP[] gcpArray, double[] outGeoTransform, int bApproxOK)

ComputeMedianCutPCT

public static int ComputeMedianCutPCT(Band red,
                                      Band green,
                                      Band blue,
                                      int num_colors,
                                      ColorTable colors,
                                      ProgressCallback callback)
Compute optimal PCT for RGB image.

This function implements a median cut algorithm to compute an "optimal" pseudocolor table for representing an input RGB image. This PCT could then be used with GDALDitherRGB2PCT() to convert a 24bit RGB image into an eightbit pseudo-colored image.

This code was based on the tiffmedian.c code from libtiff (www.libtiff.org) which was based on a paper by Paul Heckbert:

   "Color  Image Quantization for Frame Buffer Display", Paul
   Heckbert, SIGGRAPH proceedings, 1982, pp. 297-307.
 

The red, green and blue input bands do not necessarily need to come from the same file, but they must be the same width and height. They will be clipped to 8bit during reading, so non-eight bit bands are generally inappropriate.

Parameters:
red - Red input band.
green - Green input band.
blue - Blue input band.
num_colors - the desired number of colors to be returned (2-256).
colors - the color table will be returned in this color table object.
callback - for reporting algorithm progress. May be null
Returns:
returns gdalconst.CE_None on success or gdalconst.CE_Failure if an error occurs.
Since:
Java bindings 1.7.0

ComputeMedianCutPCT

public static int ComputeMedianCutPCT(Band red,
                                      Band green,
                                      Band blue,
                                      int num_colors,
                                      ColorTable colors)
Compute optimal PCT for RGB image.

Same as below with callback == null

Since:
Java bindings 1.7.0
See Also:
ComputeMedianCutPCT(Band red, Band green, Band blue, int num_colors, ColorTable colors, ProgressCallback callback)

DitherRGB2PCT

public static int DitherRGB2PCT(Band red,
                                Band green,
                                Band blue,
                                Band target,
                                ColorTable colors,
                                ProgressCallback callback)
24bit to 8bit conversion with dithering.

This functions utilizes Floyd-Steinberg dithering in the process of converting a 24bit RGB image into a pseudocolored 8bit image using a provided color table.

The red, green and blue input bands do not necessarily need to come from the same file, but they must be the same width and height. They will be clipped to 8bit during reading, so non-eight bit bands are generally inappropriate. Likewise the hTarget band will be written with 8bit values and must match the width and height of the source bands.

The color table cannot have more than 256 entries.

Parameters:
red - Red input band.
green - Green input band.
blue - Blue input band.
target - Output band.
colors - the color table to use with the output band.
callback - for reporting algorithm progress. May be null
Returns:
gdalconst.CE_None on success or gdalconst.CE_Failure if an error occurs.
Since:
Java bindings 1.7.0

DitherRGB2PCT

public static int DitherRGB2PCT(Band red,
                                Band green,
                                Band blue,
                                Band target,
                                ColorTable colors)
24bit to 8bit conversion with dithering.

Same as below with callback == null

Since:
Java bindings 1.7.0
See Also:
DitherRGB2PCT(Band red, Band green, Band blue, Band target, ColorTable colors, ProgressCallback callback)

ReprojectImage

public static int ReprojectImage(Dataset src_ds,
                                 Dataset dst_ds,
                                 String src_wkt,
                                 String dst_wkt,
                                 int resampleAlg,
                                 double warpMemoryLimit,
                                 double maxError,
                                 ProgressCallback callback)
Reproject image.

This is a convenience function utilizing the GDALWarpOperation class to reproject an image from a source to a destination. In particular, this function takes care of establishing the transformation function to implement the reprojection, and will default a variety of other warp options.

By default all bands are transferred, with no masking or nodata values in effect. No metadata, projection info, or color tables are transferred to the output file.

Parameters:
src_ds - the source image file.
dst_ds - the destination image file.
src_wkt - the source projection. If null the source projection is read from from src_ds.
dst_wkt - the destination projection. If null the destination projection will be read from dst_ds.
resampleAlg - the type of resampling to use. (among gdalconst.GRA_*)
warpMemoryLimit - the amount of memory (in bytes) that the warp API is allowed to use for caching. This is in addition to the memory already allocated to the GDAL caching (as per gdal.SetCacheMax()). May be 0.0 to use default memory settings.
maxError - maximum error measured in input pixels that is allowed in approximating the transformation (0.0 for exact calculations).
callback - for reporting progress or null
Returns:
gdalconst.CE_None on success or gdalconst.CE_Failure if something goes wrong.
Since:
Java bindings 1.7.0

ReprojectImage

public static int ReprojectImage(Dataset src_ds,
                                 Dataset dst_ds,
                                 String src_wkt,
                                 String dst_wkt,
                                 int resampleAlg,
                                 double warpMemoryLimit,
                                 double maxError)
Reproject image.

Same as below with callback == null.

Returns:
gdalconst.CE_None on success or gdalconst.CE_Failure if something goes wrong.
Since:
Java bindings 1.7.0
See Also:
ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)

ReprojectImage

public static int ReprojectImage(Dataset src_ds,
                                 Dataset dst_ds,
                                 String src_wkt,
                                 String dst_wkt,
                                 int resampleAlg,
                                 double warpMemoryLimit)
Reproject image.

Same as below with maxError == 0.0 and callback == null.

Since:
Java bindings 1.7.0
See Also:
ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)

ReprojectImage

public static int ReprojectImage(Dataset src_ds,
                                 Dataset dst_ds,
                                 String src_wkt,
                                 String dst_wkt,
                                 int resampleAlg)
Reproject image.

Same as below with warpMemoryLimit == 0.0, maxError == 0.0 and callback == null.

Since:
Java bindings 1.7.0
See Also:
ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)

ReprojectImage

public static int ReprojectImage(Dataset src_ds,
                                 Dataset dst_ds,
                                 String src_wkt,
                                 String dst_wkt)
Reproject image.

Same as below with resampleAlg == gdalconst.GRA_NearestNeighbour, warpMemoryLimit == 0.0, maxError == 0.0 and callback == null.

Since:
Java bindings 1.7.0
See Also:
ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)

ReprojectImage

public static int ReprojectImage(Dataset src_ds,
                                 Dataset dst_ds,
                                 String src_wkt)
Reproject image.

Same as below with dst_wkt == null, resampleAlg == gdalconst.GRA_NearestNeighbour, warpMemoryLimit == 0.0, maxError == 0.0 and callback == null.

Since:
Java bindings 1.7.0
See Also:
ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)

ReprojectImage

public static int ReprojectImage(Dataset src_ds,
                                 Dataset dst_ds)
Reproject image.

Same as below with src_wkt == null, dst_wkt == null, resampleAlg == gdalconst.GRA_NearestNeighbour, warpMemoryLimit == 0.0, maxError == 0.0 and callback == null.

Since:
Java bindings 1.7.0
See Also:
ReprojectImage(Dataset src_ds, Dataset dst_ds, String src_wkt, String dst_wkt, int resampleAlg, double warpMemoryLimit, double maxError, ProgressCallback callback)

ComputeProximity

public static int ComputeProximity(Band srcBand,
                                   Band proximityBand,
                                   Vector options,
                                   ProgressCallback callback)
Compute the proximity of all pixels in the image to a set of pixels in the source image.

The following options are used to define the behavior of the function. By default all non-zero pixels in srcBand will be considered the "target", and all proximities will be computed in pixels. Note that target pixels are set to the value corresponding to a distance of zero.

Options:

VALUES=n[,n]*
A list of target pixel values to measure the distance from. If this option is not provided proximity will be computed from non-zero pixel values. Currently pixel values are internally processed as integers.
DISTUNITS=[PIXEL]/GEO
Indicates whether distances will be computed in pixel units or in georeferenced units. The default is pixel units. This also determines the interpretation of MAXDIST.
MAXDIST=n
The maximum distance to search. Proximity distances greater than this value will not be computed. Instead output pixels will be set to a nodata value.
NODATA=n
The NODATA value to use on the output band for pixels that are beyond MAXDIST. If not provided, the hProximityBand will be queried for a nodata value. If one is not found, 65535 will be used.
FIXED_BUF_VAL=n
If this option is set, all pixels within the MAXDIST threadhold are set to this fixed value instead of to a proximity distance.

Parameters:
srcBand - the source band
proximityBand - the destination band
options - a vector of strings with the above options
callback - for reporting progress or null
Returns:
gdalconst.CE_None on success or gdalconst.CE_Failure if something goes wrong.
Since:
Java bindings 1.7.0

ComputeProximity

public static int ComputeProximity(Band srcBand,
                                   Band proximityBand,
                                   Vector options)
Compute the proximity of all pixels in the image to a set of pixels in the source image.

Same as below with callback = null

Since:
Java bindings 1.7.0
See Also:
ComputeProximity(Band srcBand, Band proximityBand, java.util.Vector options, ProgressCallback callback)

ComputeProximity

public static int ComputeProximity(Band srcBand,
                                   Band proximityBand)
Compute the proximity of all pixels in the image to a set of pixels in the source image.

Same as below with options == null and callback == null

Since:
Java bindings 1.7.0
See Also:
ComputeProximity(Band srcBand, Band proximityBand, java.util.Vector options, ProgressCallback callback)

RasterizeLayer

public static int RasterizeLayer(Dataset dataset,
                                 int[] bandNumbers,
                                 Layer layer,
                                 double[] burn_values,
                                 Vector options,
                                 ProgressCallback callback)
Burn geometries from the specified layer into raster.

Rasterize all the geometric objects from a layer into a raster dataset.

The transform needs to transform the geometry locations into pixel/line coordinates on the raster dataset.

The output raster may be of any GDAL supported datatype, though currently internally the burning is done either as gdal.GDT_Byte or gdal.GDT_Float32. This may be improved in the future. An explicit list of burn values for each layer for each band must be passed in.

Parameters:
dataset - output data, must be opened in update mode.
bandNumbers - the list of bands to be updated.
layer - the layer to burn in.
burn_values - the array of values to burn into the raster. There should be as many values as in bandNumbers. If null, 255 will be used
options - a vector of strings for special options controlling rasterization:
"ATTRIBUTE":
Identifies an attribute field on the features to be used for a burn in value. The value will be burned into all output bands. If specified, burn_values will not be used and can be a null value.
"CHUNKYSIZE":
The height in lines of the chunk to operate on. The larger the chunk size the less times we need to make a pass through all the shapes. If it is not set or set to zero the default chunk size will be used. Default size will be estimated based on the GDAL cache buffer size using formula: cache_size_bytes/scanline_size_bytes, so the chunk will not exceed the cache.
callback - for reporting progress or null
Returns:
gdalconst.CE_None on success or gdalconst.CE_Failure on error.
Since:
Java bindings 1.7.0

RasterizeLayer

public static int RasterizeLayer(Dataset dataset,
                                 int[] bandNumbers,
                                 Layer layer,
                                 double[] burn_values,
                                 Vector options)
Burn geometries from the specified layer into raster.

Same as below with callback == null

Since:
Java bindings 1.7.0
See Also:
RasterizeLayer(Dataset dataset, int[] bandNumbers, org.gdal.ogr.Layer layer, double[] burn_values, java.util.Vector options, ProgressCallback callback)

RasterizeLayer

public static int RasterizeLayer(Dataset dataset,
                                 int[] bandNumbers,
                                 Layer layer,
                                 double[] burn_values)
Burn geometries from the specified layer into raster.

Same as below with options == null and callback == null

Since:
Java bindings 1.7.0
See Also:
RasterizeLayer(Dataset dataset, int[] bandNumbers, org.gdal.ogr.Layer layer, double[] burn_values, java.util.Vector options, ProgressCallback callback)

RasterizeLayer

public static int RasterizeLayer(Dataset dataset,
                                 int[] bandNumbers,
                                 Layer layer)
Burn geometries from the specified layer into raster.

Same as below with burn_values == null, options == null and callback == null

Since:
Java bindings 1.7.0
See Also:
RasterizeLayer(Dataset dataset, int[] bandNumbers, org.gdal.ogr.Layer layer, double[] burn_values, java.util.Vector options, ProgressCallback callback)

Polygonize

public static int Polygonize(Band srcBand,
                             Band maskBand,
                             Layer outLayer,
                             int iPixValField,
                             Vector options,
                             ProgressCallback callback)
Create polygon coverage from raster data.

This function creates vector polygons for all connected regions of pixels in the raster sharing a common pixel value. Optionally each polygon may be labelled with the pixel value in an attribute. Optionally a mask band can be provided to determine which pixels are eligible for processing.

Note that currently the source pixel band values are read into a signed 32bit integer buffer (Int32), so floating point or complex bands will be implicitly truncated before processing.

Polygon features will be created on the output layer, with polygon geometries representing the polygons. The polygon geometries will be in the georeferenced coordinate system of the image (based on the geotransform of the source dataset). It is acceptable for the output layer to already have features. Note that gdal.Polygonize() does not set the coordinate system on the output layer. Application code should do this when the layer is created, presumably matching the raster coordinate system.

The algorithm used attempts to minimize memory use so that very large rasters can be processed. However, if the raster has many polygons or very large/complex polygons, the memory use for holding polygon enumerations and active polygon geometries may grow to be quite large.

The algorithm will generally produce very dense polygon geometries, with edges that follow exactly on pixel boundaries for all non-interior pixels. For non-thematic raster data (such as satellite images) the result will essentially be one small polygon per pixel, and memory and output layer sizes will be substantial. The algorithm is primarily intended for relatively simple thematic imagery, masks, and classification results.

Parameters:
srcBand - the source raster band to be processed.
maskBand - an optional mask band (or null). All pixels in the mask band with a value other than zero will be considered suitable for collection as polygons.
outLayer - the vector feature layer to which the polygons should be written.
iPixValField - the attribute field index indicating the feature attribute into which the pixel value of the polygon should be written.
options - a name/value list of additional options (none currently supported. just pass null).
callback - for reporting progress or null
Returns:
gdalconst.CE_None on success or gdalconst.CE_Failure on a failure.
Since:
Java bindings 1.7.0

Polygonize

public static int Polygonize(Band srcBand,
                             Band maskBand,
                             Layer outLayer,
                             int iPixValField,
                             Vector options)
Create polygon coverage from raster data.

Same as below with callback == null

Since:
Java bindings 1.7.0
See Also:
Polygonize(Band srcBand, Band maskBand, org.gdal.ogr.Layer outLayer, int iPixValField, java.util.Vector options, ProgressCallback callback)

Polygonize

public static int Polygonize(Band srcBand,
                             Band maskBand,
                             Layer outLayer,
                             int iPixValField)
Create polygon coverage from raster data.

Same as below with options == null and callback == null

Since:
Java bindings 1.7.0
See Also:
Polygonize(Band srcBand, Band maskBand, org.gdal.ogr.Layer outLayer, int iPixValField, java.util.Vector options, ProgressCallback callback)

FillNodata

public static int FillNodata(Band targetBand,
                             Band maskBand,
                             double maxSearchDist,
                             int smoothingIterations,
                             Vector options,
                             ProgressCallback callback)
Fill selected raster regions by interpolation from the edges.

This algorithm will interpolate values for all designated nodata pixels (marked by zeros in maskBand). For each pixel a four direction conic search is done to find values to interpolate from (using inverse distance weighting). Once all values are interpolated, zero or more smoothing iterations (3x3 average filters on interpolated pixels) are applied to smooth out artifacts.

This algorithm is generally suitable for interpolating missing regions of fairly continuously varying rasters (such as elevation models for instance). It is also suitable for filling small holes and cracks in more irregularly varying images (like airphotos). It is generally not so great for interpolating a raster from sparse point data - see the algorithms defined in gdal_grid.h for that case.

Parameters:
targetBand - the raster band to be modified in place.
maskBand - a mask band indicating pixels to be interpolated (zero valued
maxSearchDist - the maximum number of pixels to search in all directions to find values to interpolate from.
smoothingIterations - the number of 3x3 smoothing filter passes to run (0 or more).
options - additional name=value options in a string list (none supported at this time - just pass null).
callback - for reporting progress or null
Returns:
gdalconst.CE_None on success or gdalconst.CE_Failure on a failure.
Since:
Java bindings 1.7.0

FillNodata

public static int FillNodata(Band targetBand,
                             Band maskBand,
                             double maxSearchDist,
                             int smoothingIterations,
                             Vector options)
Fill selected raster regions by interpolation from the edges.

Same as below with callback == null

Since:
Java bindings 1.7.0
See Also:
FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations, java.util.Vector options, ProgressCallback callback)

FillNodata

public static int FillNodata(Band targetBand,
                             Band maskBand,
                             double maxSearchDist,
                             int smoothingIterations)
Fill selected raster regions by interpolation from the edges.

Same as below with options == null and callback == null

Since:
Java bindings 1.7.0
See Also:
FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations, java.util.Vector options, ProgressCallback callback)

SieveFilter

public static int SieveFilter(Band srcBand,
                              Band maskBand,
                              Band dstBand,
                              int threshold,
                              int connectedness,
                              Vector options,
                              ProgressCallback callback)
Removes small raster polygons.

The function removes raster polygons smaller than a provided threshold size (in pixels) and replaces replaces them with the pixel value of the largest neighbour polygon.

Polygon are determined (per GDALRasterPolygonEnumerator) as regions of the raster where the pixels all have the same value, and that are contiguous (connected).

Pixels determined to be "nodata" per maskBand will not be treated as part of a polygon regardless of their pixel values. Nodata areas will never be changed nor affect polygon sizes.

Polygons smaller than the threshold with no neighbours that are as large as the threshold will not be altered. Polygons surrounded by nodata areas will therefore not be altered.

The algorithm makes three passes over the input file to enumerate the polygons and collect limited information about them. Memory use is proportional to the number of polygons (roughly 24 bytes per polygon), but is not directly related to the size of the raster. So very large raster files can be processed effectively if there aren't too many polygons. But extremely noisy rasters with many one pixel polygons will end up being expensive (in memory) to process.

Parameters:
srcBand - the source raster band to be processed.
maskBand - an optional mask band. All pixels in the mask band with a value other than zero will be considered suitable for inclusion in polygons.
dstBand - the output raster band. It may be the same as srcBand to update the source in place.
threshold - raster polygons with sizes smaller than this will be merged into their largest neighbour.
connectedness - either 4 indicating that diagonal pixels are not considered directly adjacent for polygon membership purposes or 8 indicating they are.
options - algorithm options in name=value list form. None currently supported. just pass null
callback - for reporting progress or null
Returns:
gdalconst.CE_None on success or gdalconst.CE_Failure on a failure.
Since:
Java bindings 1.7.0

SieveFilter

public static int SieveFilter(Band srcBand,
                              Band maskBand,
                              Band dstBand,
                              int threshold,
                              int connectedness,
                              Vector options)
Removes small raster polygons.

Same as below with callback == null

Since:
Java bindings 1.7.0
See Also:
SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness, java.util.Vector options, ProgressCallback callback)

SieveFilter

public static int SieveFilter(Band srcBand,
                              Band maskBand,
                              Band dstBand,
                              int threshold,
                              int connectedness)
Removes small raster polygons.

Same as below with options == null and callback == null

Since:
Java bindings 1.7.0
See Also:
SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness, java.util.Vector options, ProgressCallback callback)

SieveFilter

public static int SieveFilter(Band srcBand,
                              Band maskBand,
                              Band dstBand,
                              int threshold)
Removes small raster polygons.

Same as below with connectedness == 4, options == null and callback == null

Since:
Java bindings 1.7.0
See Also:
SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness, java.util.Vector options, ProgressCallback callback)

RegenerateOverviews

public static int RegenerateOverviews(Band srcBand,
                                      Band[] overviewBands,
                                      String resampling,
                                      ProgressCallback callback)
Generate downsampled overviews.

This function will generate one or more overview images from a base image using the requested downsampling algorithm. It's primary use is for generating overviews via Dataset.BuildOverviews(), but it can also be used to generate downsampled images in one file from another outside the overview architecture.

The output bands need to exist in advance.

The full set of resampling algorithms is documented in Dataset.BuildOverviews().

Parameters:
srcBand - the source (base level) band.
overviewBands - the list of downsampled bands to be generated.
resampling - Resampling algorithm (eg. "AVERAGE").
callback - for reporting progress or null
Returns:
gdalconst.CE_None on success or gdalconst.CE_Failure on a failure.
Since:
Java bindings 1.7.0
See Also:
Dataset.BuildOverviews(java.lang.String resampling, int[] overviewlist, ProgressCallback callback)

RegenerateOverviews

public static int RegenerateOverviews(Band srcBand,
                                      Band[] overviewBands,
                                      String resampling)
Generate downsampled overviews.

Same as below with callback == null

Since:
Java bindings 1.7.0
See Also:
RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)

RegenerateOverviews

public static int RegenerateOverviews(Band srcBand,
                                      Band[] overviewBands)
Generate downsampled overviews.

Same as below with resampling == "AVERAGE" and callback == null

Since:
Java bindings 1.7.0
See Also:
RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)

RegenerateOverview

public static int RegenerateOverview(Band srcBand,
                                     Band overviewBand,
                                     String resampling,
                                     ProgressCallback callback)
Generate downsampled overview.

Same as below for a unique overview band

Since:
Java bindings 1.7.0
See Also:
RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)

RegenerateOverview

public static int RegenerateOverview(Band srcBand,
                                     Band overviewBand,
                                     String resampling)
Generate downsampled overview.

Same as below for a unique overview band and callback == null

Since:
Java bindings 1.7.0
See Also:
RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)

RegenerateOverview

public static int RegenerateOverview(Band srcBand,
                                     Band overviewBand)
Generate downsampled overview.

Same as below for a unique overview band, resampling == "AVERAGE" and callback == null

Since:
Java bindings 1.7.0
See Also:
RegenerateOverviews(Band srcBand, Band[] overviewBands, String resampling, ProgressCallback callback)

GridCreate

public static int GridCreate(String algorithmOptions,
                             double[][] points,
                             double xMin,
                             double xMax,
                             double yMin,
                             double yMax,
                             int xSize,
                             int ySize,
                             int dataType,
                             ByteBuffer nioBuffer,
                             ProgressCallback callback)

GridCreate

public static int GridCreate(String algorithmOptions,
                             double[][] points,
                             double xMin,
                             double xMax,
                             double yMin,
                             double yMax,
                             int xSize,
                             int ySize,
                             int dataType,
                             ByteBuffer nioBuffer)

ContourGenerate

public static int ContourGenerate(Band srcBand,
                                  double contourInterval,
                                  double contourBase,
                                  double[] fixedLevelCount,
                                  int useNoData,
                                  double noDataValue,
                                  Layer dstLayer,
                                  int idField,
                                  int elevField,
                                  ProgressCallback callback)

ContourGenerate

public static int ContourGenerate(Band srcBand,
                                  double contourInterval,
                                  double contourBase,
                                  double[] fixedLevelCount,
                                  int useNoData,
                                  double noDataValue,
                                  Layer dstLayer,
                                  int idField,
                                  int elevField)

AutoCreateWarpedVRT

public static Dataset AutoCreateWarpedVRT(Dataset src_ds,
                                          String src_wkt,
                                          String dst_wkt,
                                          int eResampleAlg,
                                          double maxError)
Create virtual warped dataset automatically.

This function will create a warped virtual file representing the input image warped into the target coordinate system. A GenImgProj transformation is created to accomplish any required GCP/Geotransform warp and reprojection to the target coordinate system. The output virtual dataset will be "northup" in the target coordinate system. The GDALSuggestedWarpOutput() function is used to determine the bounds and resolution of the output virtual file which should be large enough to include all the input image

Note that the constructed Dataset object will acquire one or more references to the passed in src_ds. Reference counting semantics on the source dataset should be honoured. That is, don't just GDALClose() it unless it was opened with GDALOpenShared().

The returned dataset will have no associated filename for itself. If you want to write the virtual dataset description to a file, use the SetDescription() method on the dataset to assign a filename before it is closed.

Parameters:
src_ds - The source dataset.
src_wkt - The coordinate system of the source image. If null, it will be read from the source image.
dst_wkt - The coordinate system to convert to. If null no change of coordinate system will take place.
eResampleAlg - One of gdalconst.GRA_NearestNeighbour, gdalconst.GRA_Bilinear, gdalconst.GRA_Cubic or gdalconst.RA_CubicSpline. Controls the sampling method used.
maxError - Maximum error measured in input pixels that is allowed in approximating the transformation (0.0 for exact calculations).
Returns:
null on failure, or a new virtual dataset handle on success.

AutoCreateWarpedVRT

public static Dataset AutoCreateWarpedVRT(Dataset src_ds,
                                          String src_wkt,
                                          String dst_wkt,
                                          int eResampleAlg)
Create virtual warped dataset automatically.

Same as below with maxError == 0.0

Since:
Java bindings 1.7.0
See Also:
AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg, double maxError)

AutoCreateWarpedVRT

public static Dataset AutoCreateWarpedVRT(Dataset src_ds,
                                          String src_wkt,
                                          String dst_wkt)
Create virtual warped dataset automatically.

Same as below with eResampleAlg == gdalconst.GRA_NearestNeighbour and maxError == 0.0

Since:
Java bindings 1.7.0
See Also:
AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg, double maxError)

AutoCreateWarpedVRT

public static Dataset AutoCreateWarpedVRT(Dataset src_ds,
                                          String src_wkt)
Create virtual warped dataset automatically.

Same as below with dst_wkt == null, eResampleAlg == gdalconst.GRA_NearestNeighbour and maxError == 0.0

Since:
Java bindings 1.7.0
See Also:
AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg, double maxError)

AutoCreateWarpedVRT

public static Dataset AutoCreateWarpedVRT(Dataset src_ds)
Create virtual warped dataset automatically.

Same as below with src_wkt == null, dst_wkt == null, eResampleAlg == gdalconst.GRA_NearestNeighbour and maxError == 0.0

Since:
Java bindings 1.7.0
See Also:
AutoCreateWarpedVRT(Dataset src_ds, String src_wkt, String dst_wkt, int eResampleAlg, double maxError)

ApplyGeoTransform

public static void ApplyGeoTransform(double[] padfGeoTransform,
                                     double dfPixel,
                                     double dfLine,
                                     double[] pdfGeoX,
                                     double[] pdfGeoY)
Apply GeoTransform to x/y coordinate.

Applies the following computation, converting a (pixel,line) coordinate into a georeferenced (geo_x,geo_y) location.

 pdfGeoX[0] = padfGeoTransform[0] + dfPixel * padfGeoTransform[1] + dfLine * padfGeoTransform[2];
 pdfGeoY[0] = padfGeoTransform[3] + dfPixel * padfGeoTransform[4] + dfLine * padfGeoTransform[5];
 

Parameters:
padfGeoTransform - Six coefficient GeoTransform to apply.
dfPixel - Input pixel position
dfLine - Input line position.
pdfGeoX - allocated array of 1 double where geo_x (easting/longitude) location is placed.
pdfGeoY - allocated array of 1 double where geo_y (northing/latitude) location is placed.
Since:
Java bindings 1.7.0

InvGeoTransform

public static int InvGeoTransform(double[] gt_in,
                                  double[] gt_out)
Invert Geotransform.

This function will invert a standard 3x2 set of GeoTransform coefficients. This converts the equation from being pixel to geo to being geo to pixel.

Parameters:
gt_in - Input geotransform (allocated array of six doubles - unaltered).
gt_out - Output geotransform (allocated array of six doubles - updated).
Returns:
1 on success or 0 if the equation is uninvertable.
Since:
Java bindings 1.7.0

VersionInfo

public static String VersionInfo(String request)
Get runtime version information.

Available request values:

Parameters:
request - the type of version info desired, as listed above.
Returns:
a string containing the requested information.

VersionInfo

public static String VersionInfo()
Get runtime version information.

Returns:
a string containing GDAL_VERSION_NUM formatted as a string. ie. "1170"
Since:
Java bindings 1.7.0

AllRegister

public static void AllRegister()
Register all known configured GDAL drivers.

This function will drive any of the following that are configured into GDAL. Many others as well that haven't been updated in this documentation (see full list):

This function should generally be called once at the beginning of the application.


GDALDestroyDriverManager

public static void GDALDestroyDriverManager()

GetCacheMax

public static int GetCacheMax()
Get maximum cache memory.

Gets the maximum amount of memory available to the GDALRasterBlock caching system for caching GDAL read/write imagery.

Returns:
maximum in bytes.

GetCacheUsed

public static int GetCacheUsed()
Get cache memory used.

Returns:
the number of bytes of memory currently in use by the GDALRasterBlock memory caching.

SetCacheMax

public static void SetCacheMax(int newSize)
Set maximum cache memory.

This function sets the maximum amount of memory that GDAL is permitted to use for GDALRasterBlock caching.

Parameters:
newSize - the maximum number of bytes for caching. Maximum is 2GB.

GetDataTypeSize

public static int GetDataTypeSize(int eDataType)
Get data type size in bits.

Returns the size of a a GDT_* type in bits, not bytes!

Parameters:
eDataType - type, such as gdalconst.GDT_Byte.
Returns:
the number of bits or zero if it is not recognised.

DataTypeIsComplex

public static int DataTypeIsComplex(int eDataType)
Is data type complex?

Returns:
1 if the passed type is complex (one of gdalconst.GDT_CInt16, GDT_CInt32, GDT_CFloat32 or GDT_CFloat64), that is it consists of a real and imaginary component.

GetDataTypeName

public static String GetDataTypeName(int eDataType)
Get name of data type.

Returns a symbolic name for the data type. This is essentially the the enumerated item name with the GDT_ prefix removed. So gdalconst.GDT_Byte returns "Byte". These strings are useful for reporting datatypes in debug statements, errors and other user output.

Parameters:
eDataType - type to get name of.
Returns:
string corresponding to type.

GetDataTypeByName

public static int GetDataTypeByName(String dataTypeName)
Get data type by symbolic name.

Returns a data type corresponding to the given symbolic name. This function is opposite to the gdal.GetDataTypeName().

Parameters:
dataTypeName - string containing the symbolic name of the type.
Returns:
GDAL data type.

GetColorInterpretationName

public static String GetColorInterpretationName(int eColorInterp)
Get name of color interpretation.

Returns a symbolic name for the color interpretation. This is derived from the enumerated item name with the GCI_ prefix removed, but there are some variations. So GCI_GrayIndex returns "Gray" and GCI_RedBand returns "Red". The returned strings are static strings and should not be modified or freed by the application.

Parameters:
eColorInterp - color interpretation to get name of.
Returns:
string corresponding to color interpretation.

GetPaletteInterpretationName

public static String GetPaletteInterpretationName(int ePaletteInterp)
Get name of palette interpretation.

Returns a symbolic name for the palette interpretation. This is the the enumerated item name with the GPI_ prefix removed. So GPI_Gray returns "Gray". The returned strings are static strings and should not be modified or freed by the application.

Parameters:
ePaletteInterp - palette interpretation to get name of.
Returns:
string corresponding to palette interpretation.

DecToDMS

public static String DecToDMS(double dfAngle,
                              String pszAxis,
                              int nPrecision)

DecToDMS

public static String DecToDMS(double dfAngle,
                              String pszAxis)

PackedDMSToDec

public static double PackedDMSToDec(double dfPacked)

DecToPackedDMS

public static double DecToPackedDMS(double dfDec)

ParseXMLString

public static XMLNode ParseXMLString(String xmlString)
Parse an XML string into tree form.

The passed document is parsed into a XMLNode tree representation. If the document is not well formed XML then null is returned, and errors are reported via CPLError(). No validation beyond wellformedness is done.

If the document has more than one "root level" element then those after the first will be attached to the first as siblings (via the psNext pointers) even though there is no common parent. A document with no XML structure (no angle brackets for instance) would be considered well formed, and returned as a single CXT_Text node.

Parameters:
xmlString - the document to parse.
Returns:
parsed tree or null on error.
Since:
Java bindings 1.7.0

SerializeXMLTree

public static String SerializeXMLTree(XMLNode xmlnode)
Convert tree into string document.

This function converts a XMLNode tree representation of a document into a flat string representation. White space indentation is used visually preserve the tree structure of the document.

Parameters:
xmlnode - the root of the tree to serialize
Returns:
the document on success or null on failure.
Since:
Java bindings 1.7.0

GetDriverCount

public static int GetDriverCount()
Fetch the number of registered drivers.

Returns:
the number of registered drivers.

GetDriverByName

public static Driver GetDriverByName(String name)
Fetch a driver based on the short name.

Parameters:
name - the short name, such as "GTiff", being searched for.
Returns:
the identified driver, or null if no match is found.

GetDriver

public static Driver GetDriver(int iDriver)
Fetch driver by index.

Parameters:
iDriver - the driver index from 0 to gdal.GetDriverCount()-1.
Returns:
the driver identified by the index or null if the index is invalid

Open

public static Dataset Open(String name,
                           int eAccess)
Open a raster file as a Dataset object.

This function will try to open the passed file, or virtual dataset name by invoking the Open method of each registered Driver in turn. The first successful open will result in a returned dataset. If all drivers fail then null is returned.

It is required that you explicitely close a dataset opened in update mode with the Dataset.delete() method. Otherwise the data might not be flushed to the disk. Don't rely only on Java garbage collection.

Parameters:
name - the name of the file to access. In the case of exotic drivers this may not refer to a physical file, but instead contain information for the driver on how to access a dataset.
eAccess - the desired access, either gdalconst.GA_Update or gdalconst.GA_ReadOnly. Many drivers support only read only access.
Returns:
A Dataset object or null on failure.
See Also:
OpenShared(String name, int eAccess)

Open

public static Dataset Open(String name)
Open a raster file as a Dataset object.

Same as below with eAccess == gdalconst.GA_ReadOnly

Since:
Java bindings 1.7.0
See Also:
Open(String name, int eAccess)

OpenShared

public static Dataset OpenShared(String name,
                                 int eAccess)
Open a raster file as a GDALDataset.

This function works the same as gdal.Open(), but allows the sharing of GDALDataset handles for a dataset with other callers to gdal.OpenShared().

In particular, gdal.OpenShared() will first consult it's list of currently open and shared Dataset's, and if the GetDescription() name for one exactly matches the name passed to gdal.OpenShared() it will be referenced and returned.

Parameters:
name - the name of the file to access. In the case of exotic drivers this may not refer to a physical file, but instead contain information for the driver on how to access a dataset.
eAccess - the desired access, either gdalconst.GA_Update or gdalconst.GA_ReadOnly. Many drivers support only read only access.
Returns:
A Dataset object or null on failure.
See Also:
Open(String name, int eAccess)

OpenShared

public static Dataset OpenShared(String name)
Open a raster file as a Dataset object.

Same as below with eAccess == gdalconst.GA_ReadOnly

Since:
Java bindings 1.7.0
See Also:
OpenShared(String name, int eAccess)

IdentifyDriver

public static Driver IdentifyDriver(String name,
                                    Vector fileList)
Identify the driver that can open a raster file.

This function will try to identify the driver that can open the passed file name by invoking the Identify method of each registered Driver in turn. The first driver that successful identifies the file name will be returned. If all drivers fail then null is returned.

In order to reduce the need for such searches touch the operating system file system machinery, it is possible to give an optional list of files. This is the list of all files at the same level in the file system as the target file, including the target file. The filenames will not include any path components, are an essentially just the output of ReadDir() on the parent directory. If the target object does not have filesystem semantics then the file list should be null.

Parameters:
name - the name of the file to access. In the case of exotic drivers this may not refer to a physical file, but instead contain information for the driver on how to access a dataset.
fileList - a veector of strings. These strings are filenames that are auxiliary to the main filename. The passed value may be null.
Returns:
A Driver object or null on failure.

IdentifyDriver

public static Driver IdentifyDriver(String name)
Identify the driver that can open a raster file.

Same as below with fileList == null

Since:
Java bindings 1.7.0
See Also:
IdentifyDriver(String name, java.util.Vector fileList)

GeneralCmdLineProcessor

public static Vector GeneralCmdLineProcessor(Vector args,
                                             int options)
General utility option processing. Same as below but with arguments as a Vector of strings

Returns:
updated argument list as a new Vector of strings
See Also:
GeneralCmdLineProcessor(String[] args, int options)

GeneralCmdLineProcessor

public static Vector GeneralCmdLineProcessor(Vector args)
General utility option processing. Same as below but with arguments as a Vector of strings and options == 0

Returns:
updated argument list as a new Vector of strings
Since:
Java bindings 1.7.0
See Also:
GeneralCmdLineProcessor(String[] args, int options)