<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>gdal.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.3-20001105 on Thu Mar 28 09:47:31 2002 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>gdal.h File Reference</h1><code>#include "<a class="el" href="cpl_port_h-source.html">cpl_port.h</a>"</code><br>
<code>#include "<a class="el" href="cpl_error_h-source.html">cpl_error.h</a>"</code><br>
<p>
<a href="gdal_h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="struct_GDALColorEntry.html">GDALColorEntry</a></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="gdal.h::GDAL_VERSION_NUM"></a>
#define </td><td valign=bottom><b>GDAL_VERSION_NUM</b> 1160</td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="gdal.h::GDAL_RELEASE_DATE"></a>
#define </td><td valign=bottom><b>GDAL_RELEASE_DATE</b> 20020204</td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="gdal.h::GDAL_RELEASE_NAME"></a>
#define </td><td valign=bottom><b>GDAL_RELEASE_NAME</b> "1.1.6"</td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="gdal.h::CPLE_WrongFormat"></a>
#define </td><td valign=bottom><b>CPLE_WrongFormat</b> 200</td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="gdal.h::GDALMajorObjectH"></a>
typedef void* </td><td valign=bottom><b>GDALMajorObjectH</b></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="gdal.h::GDALDatasetH"></a>
typedef void* </td><td valign=bottom><b>GDALDatasetH</b></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="gdal.h::GDALRasterBandH"></a>
typedef void* </td><td valign=bottom><b>GDALRasterBandH</b></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="gdal.h::GDALDriverH"></a>
typedef void* </td><td valign=bottom><b>GDALDriverH</b></td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="gdal.h::GDALProjDefH"></a>
typedef void* </td><td valign=bottom><b>GDALProjDefH</b></td></tr>
<tr><td nowrap align=right valign=top><a name="a9" doxytag="gdal.h::GDALColorTableH"></a>
typedef void* </td><td valign=bottom><b>GDALColorTableH</b></td></tr>
<tr><td nowrap align=right valign=top>typedef int (* </td><td valign=bottom><a class="el" href="gdal_h.html#a10">GDALProgressFunc</a> )(double,const char *, void *)</td></tr>
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="gdal_h.html#a141">GDALDataType</a> { <br>
<b>GDT_Unknown</b> = 0,
<a class="el" href="gdal_h.html#a141a12">GDT_Byte</a> = 1,
<a class="el" href="gdal_h.html#a141a13">GDT_UInt16</a> = 2,
<a class="el" href="gdal_h.html#a141a14">GDT_Int16</a> = 3,
<br>
<a class="el" href="gdal_h.html#a141a15">GDT_UInt32</a> = 4,
<a class="el" href="gdal_h.html#a141a16">GDT_Int32</a> = 5,
<a class="el" href="gdal_h.html#a141a17">GDT_Float32</a> = 6,
<a class="el" href="gdal_h.html#a141a18">GDT_Float64</a> = 7,
<br>
<a class="el" href="gdal_h.html#a141a19">GDT_CInt16</a> = 8,
<a class="el" href="gdal_h.html#a141a20">GDT_CInt32</a> = 9,
<a class="el" href="gdal_h.html#a141a21">GDT_CFloat32</a> = 10,
<a class="el" href="gdal_h.html#a141a22">GDT_CFloat64</a> = 11,
<br>
<b>GDT_TypeCount</b> = 12
<br>
}</td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="gdal_h.html#a142">GDALAccess</a> { <a class="el" href="gdal_h.html#a142a24">GA_ReadOnly</a> = 0,
<a class="el" href="gdal_h.html#a142a25">GA_Update</a> = 1
}</td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="gdal_h.html#a143">GDALRWFlag</a> { <a class="el" href="gdal_h.html#a143a26">GF_Read</a> = 0,
<a class="el" href="gdal_h.html#a143a27">GF_Write</a> = 1
}</td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="gdal_h.html#a144">GDALColorInterp</a> { <br>
<b>GCI_Undefined</b> = 0,
<a class="el" href="gdal_h.html#a144a29">GCI_GrayIndex</a> = 1,
<a class="el" href="gdal_h.html#a144a30">GCI_PaletteIndex</a> = 2,
<a class="el" href="gdal_h.html#a144a31">GCI_RedBand</a> = 3,
<br>
<a class="el" href="gdal_h.html#a144a32">GCI_GreenBand</a> = 4,
<a class="el" href="gdal_h.html#a144a33">GCI_BlueBand</a> = 5,
<a class="el" href="gdal_h.html#a144a34">GCI_AlphaBand</a> = 6,
<a class="el" href="gdal_h.html#a144a35">GCI_HueBand</a> = 7,
<br>
<a class="el" href="gdal_h.html#a144a36">GCI_SaturationBand</a> = 8,
<a class="el" href="gdal_h.html#a144a37">GCI_LightnessBand</a> = 9,
<a class="el" href="gdal_h.html#a144a38">GCI_CyanBand</a> = 10,
<a class="el" href="gdal_h.html#a144a39">GCI_MagentaBand</a> = 11,
<br>
<a class="el" href="gdal_h.html#a144a40">GCI_YellowBand</a> = 12,
<a class="el" href="gdal_h.html#a144a41">GCI_BlackBand</a> = 13
<br>
}</td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="gdal_h.html#a145">GDALPaletteInterp</a> { <a class="el" href="gdal_h.html#a145a42">GPI_Gray</a> = 0,
<a class="el" href="gdal_h.html#a145a43">GPI_RGB</a> = 1,
<a class="el" href="gdal_h.html#a145a44">GPI_CMYK</a> = 2,
<a class="el" href="gdal_h.html#a145a45">GPI_HLS</a> = 3
}</td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a46" doxytag="gdal.h::GDALGetDataTypeSize"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetDataTypeSize</b> ( <a class="el" href="gdal_h.html#a141">GDALDataType</a> )</td></tr>
<tr><td nowrap align=right valign=top><a name="a47" doxytag="gdal.h::GDALDataTypeIsComplex"></a>
int CPL_DLL </td><td valign=bottom><b>GDALDataTypeIsComplex</b> ( <a class="el" href="gdal_h.html#a141">GDALDataType</a> )</td></tr>
<tr><td nowrap align=right valign=top><a name="a48" doxytag="gdal.h::GDALGetDataTypeName"></a>
const char CPL_DLL* </td><td valign=bottom><b>GDALGetDataTypeName</b> ( <a class="el" href="gdal_h.html#a141">GDALDataType</a> )</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="gdal_h.html#a141">GDALDataType</a> CPL_DLL </td><td valign=bottom><a class="el" href="gdal_h.html#a49">GDALDataTypeUnion</a> ( <a class="el" href="gdal_h.html#a141">GDALDataType</a>, <a class="el" href="gdal_h.html#a141">GDALDataType</a> )</td></tr>
<tr><td nowrap align=right valign=top>const char CPL_DLL* </td><td valign=bottom><a class="el" href="gdal_h.html#a50">GDALGetColorInterpretationName</a> ( <a class="el" href="gdal_h.html#a144">GDALColorInterp</a> )</td></tr>
<tr><td nowrap align=right valign=top>const char CPL_DLL* </td><td valign=bottom><a class="el" href="gdal_h.html#a51">GDALGetPaletteInterpretationName</a> ( <a class="el" href="gdal_h.html#a145">GDALPaletteInterp</a> )</td></tr>
<tr><td nowrap align=right valign=top>int CPL_DLL </td><td valign=bottom><a class="el" href="gdal_h.html#a52">GDALDummyProgress</a> ( double, const char *, void *)</td></tr>
<tr><td nowrap align=right valign=top><a name="a53" doxytag="gdal.h::GDALTermProgress"></a>
int CPL_DLL </td><td valign=bottom><b>GDALTermProgress</b> ( double, const char *, void *)</td></tr>
<tr><td nowrap align=right valign=top><a name="a54" doxytag="gdal.h::GDALScaledProgress"></a>
int CPL_DLL </td><td valign=bottom><b>GDALScaledProgress</b> ( double, const char *, void *)</td></tr>
<tr><td nowrap align=right valign=top><a name="a55" doxytag="gdal.h::GDALCreateScaledProgress"></a>
void CPL_DLL* </td><td valign=bottom><b>GDALCreateScaledProgress</b> ( double, double, <a class="el" href="gdal_h.html#a10">GDALProgressFunc</a>, void * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a56" doxytag="gdal.h::GDALDestroyScaledProgress"></a>
void CPL_DLL </td><td valign=bottom><b>GDALDestroyScaledProgress</b> ( void * )</td></tr>
<tr><td nowrap align=right valign=top>void CPL_DLL </td><td valign=bottom><a class="el" href="gdal_h.html#a57">GDALAllRegister</a> ( void )</td></tr>
<tr><td nowrap align=right valign=top><a name="a58" doxytag="gdal.h::GDALCreate"></a>
GDALDatasetH CPL_DLL </td><td valign=bottom><b>GDALCreate</b> ( GDALDriverH hDriver, const char *, int, int, int, <a class="el" href="gdal_h.html#a141">GDALDataType</a>, char ** )</td></tr>
<tr><td nowrap align=right valign=top><a name="a59" doxytag="gdal.h::GDALCreateCopy"></a>
GDALDatasetH CPL_DLL </td><td valign=bottom><b>GDALCreateCopy</b> ( GDALDriverH, const char *, GDALDatasetH, int, char **, <a class="el" href="gdal_h.html#a10">GDALProgressFunc</a>, void * )</td></tr>
<tr><td nowrap align=right valign=top>GDALDatasetH CPL_DLL </td><td valign=bottom><a class="el" href="gdal_h.html#a60">GDALOpen</a> ( const char *, <a class="el" href="gdal_h.html#a142">GDALAccess</a> )</td></tr>
<tr><td nowrap align=right valign=top><a name="a61" doxytag="gdal.h::GDALGetDriverByName"></a>
GDALDriverH CPL_DLL </td><td valign=bottom><b>GDALGetDriverByName</b> ( const char * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a62" doxytag="gdal.h::GDALGetDriverCount"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetDriverCount</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a63" doxytag="gdal.h::GDALGetDriver"></a>
GDALDriverH CPL_DLL </td><td valign=bottom><b>GDALGetDriver</b> ( int )</td></tr>
<tr><td nowrap align=right valign=top><a name="a64" doxytag="gdal.h::GDALRegisterDriver"></a>
int CPL_DLL </td><td valign=bottom><b>GDALRegisterDriver</b> ( GDALDriverH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a65" doxytag="gdal.h::GDALDeregisterDriver"></a>
void CPL_DLL </td><td valign=bottom><b>GDALDeregisterDriver</b> ( GDALDriverH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a66" doxytag="gdal.h::GDALDeleteDataset"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALDeleteDataset</b> ( GDALDriverH, const char * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a67" doxytag="gdal.h::GDALGetDriverShortName"></a>
const char CPL_DLL* </td><td valign=bottom><b>GDALGetDriverShortName</b> ( GDALDriverH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a68" doxytag="gdal.h::GDALGetDriverLongName"></a>
const char CPL_DLL* </td><td valign=bottom><b>GDALGetDriverLongName</b> ( GDALDriverH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a69" doxytag="gdal.h::GDALGetDriverHelpTopic"></a>
const char CPL_DLL* </td><td valign=bottom><b>GDALGetDriverHelpTopic</b> ( GDALDriverH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a70" doxytag="gdal.h::GDALInitGCPs"></a>
void CPL_DLL </td><td valign=bottom><b>GDALInitGCPs</b> ( int, <a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a> * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a71" doxytag="gdal.h::GDALDeinitGCPs"></a>
void CPL_DLL </td><td valign=bottom><b>GDALDeinitGCPs</b> ( int, <a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a> * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a72" doxytag="gdal.h::GDALDuplicateGCPs"></a>
<a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a> CPL_DLL* </td><td valign=bottom><b>GDALDuplicateGCPs</b> ( int, const <a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a> * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a73" doxytag="gdal.h::GDALGetMetadata"></a>
char CPL_DLL** </td><td valign=bottom><b>GDALGetMetadata</b> ( GDALMajorObjectH, const char * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a74" doxytag="gdal.h::GDALSetMetadata"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALSetMetadata</b> ( GDALMajorObjectH, char **, const char * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a75" doxytag="gdal.h::GDALGetMetadataItem"></a>
const char CPL_DLL* </td><td valign=bottom><b>GDALGetMetadataItem</b> ( GDALMajorObjectH, const char *, const char * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a76" doxytag="gdal.h::GDALSetMetadataItem"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALSetMetadataItem</b> ( GDALMajorObjectH, const char *, const char *, const char * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a77" doxytag="gdal.h::GDALGetDescription"></a>
const char CPL_DLL* </td><td valign=bottom><b>GDALGetDescription</b> ( GDALMajorObjectH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a78" doxytag="gdal.h::GDALGetDatasetDriver"></a>
GDALDriverH CPL_DLL </td><td valign=bottom><b>GDALGetDatasetDriver</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a79" doxytag="gdal.h::GDALClose"></a>
void CPL_DLL </td><td valign=bottom><b>GDALClose</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a80" doxytag="gdal.h::GDALGetRasterXSize"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetRasterXSize</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a81" doxytag="gdal.h::GDALGetRasterYSize"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetRasterYSize</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a82" doxytag="gdal.h::GDALGetRasterCount"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetRasterCount</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a83" doxytag="gdal.h::GDALGetRasterBand"></a>
GDALRasterBandH CPL_DLL </td><td valign=bottom><b>GDALGetRasterBand</b> ( GDALDatasetH, int )</td></tr>
<tr><td nowrap align=right valign=top><a name="a84" doxytag="gdal.h::GDALAddBand"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALAddBand</b> ( GDALDatasetH hDS, <a class="el" href="gdal_h.html#a141">GDALDataType</a> eType, char **papszOptions )</td></tr>
<tr><td nowrap align=right valign=top><a name="a85" doxytag="gdal.h::GDALGetProjectionRef"></a>
const char CPL_DLL* </td><td valign=bottom><b>GDALGetProjectionRef</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a86" doxytag="gdal.h::GDALSetProjection"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALSetProjection</b> ( GDALDatasetH, const char * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a87" doxytag="gdal.h::GDALGetGeoTransform"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALGetGeoTransform</b> ( GDALDatasetH, double * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a88" doxytag="gdal.h::GDALSetGeoTransform"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALSetGeoTransform</b> ( GDALDatasetH, double * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a89" doxytag="gdal.h::GDALGetGCPCount"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetGCPCount</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a90" doxytag="gdal.h::GDALGetGCPProjection"></a>
const char CPL_DLL* </td><td valign=bottom><b>GDALGetGCPProjection</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a91" doxytag="gdal.h::GDALGetGCPs"></a>
const <a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a> CPL_DLL* </td><td valign=bottom><b>GDALGetGCPs</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a92" doxytag="gdal.h::GDALSetGCPs"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALSetGCPs</b> ( GDALDatasetH, int, const <a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a> *, const char * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a93" doxytag="gdal.h::GDALGetInternalHandle"></a>
void CPL_DLL* </td><td valign=bottom><b>GDALGetInternalHandle</b> ( GDALDatasetH, const char * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a94" doxytag="gdal.h::GDALReferenceDataset"></a>
int CPL_DLL </td><td valign=bottom><b>GDALReferenceDataset</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a95" doxytag="gdal.h::GDALDereferenceDataset"></a>
int CPL_DLL </td><td valign=bottom><b>GDALDereferenceDataset</b> ( GDALDatasetH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a96" doxytag="gdal.h::GDALBuildOverviews"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALBuildOverviews</b> ( GDALDatasetH, const char *, int, int *, int, int *, <a class="el" href="gdal_h.html#a10">GDALProgressFunc</a>, void * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a97" doxytag="gdal.h::GDALGetRasterDataType"></a>
<a class="el" href="gdal_h.html#a141">GDALDataType</a> CPL_DLL </td><td valign=bottom><b>GDALGetRasterDataType</b> ( GDALRasterBandH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a98" doxytag="gdal.h::GDALGetBlockSize"></a>
void CPL_DLL </td><td valign=bottom><b>GDALGetBlockSize</b> ( GDALRasterBandH, int * pnXSize, int * pnYSize )</td></tr>
<tr><td nowrap align=right valign=top><a name="a99" doxytag="gdal.h::GDALRasterIO"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALRasterIO</b> ( GDALRasterBandH hRBand, <a class="el" href="gdal_h.html#a143">GDALRWFlag</a> eRWFlag, int nDSXOff, int nDSYOff, int nDSXSize, int nDSYSize, void * pBuffer, int nBXSize, int nBYSize, <a class="el" href="gdal_h.html#a141">GDALDataType</a> eBDataType, int nPixelSpace, int nLineSpace )</td></tr>
<tr><td nowrap align=right valign=top><a name="a100" doxytag="gdal.h::GDALReadBlock"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALReadBlock</b> ( GDALRasterBandH, int, int, void * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a101" doxytag="gdal.h::GDALWriteBlock"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALWriteBlock</b> ( GDALRasterBandH, int, int, void * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a102" doxytag="gdal.h::GDALGetRasterBandXSize"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetRasterBandXSize</b> ( GDALRasterBandH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a103" doxytag="gdal.h::GDALGetRasterBandYSize"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetRasterBandYSize</b> ( GDALRasterBandH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a104" doxytag="gdal.h::GDALGetRasterMetadata"></a>
char CPL_DLL** </td><td valign=bottom><b>GDALGetRasterMetadata</b> ( GDALRasterBandH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a105" doxytag="gdal.h::GDALGetRasterColorInterpretation"></a>
<a class="el" href="gdal_h.html#a144">GDALColorInterp</a> CPL_DLL </td><td valign=bottom><b>GDALGetRasterColorInterpretation</b> ( GDALRasterBandH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a106" doxytag="gdal.h::GDALGetRasterColorTable"></a>
GDALColorTableH CPL_DLL </td><td valign=bottom><b>GDALGetRasterColorTable</b> ( GDALRasterBandH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a107" doxytag="gdal.h::GDALSetRasterColorTable"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALSetRasterColorTable</b> ( GDALRasterBandH, GDALColorTableH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a108" doxytag="gdal.h::GDALHasArbitraryOverviews"></a>
int CPL_DLL </td><td valign=bottom><b>GDALHasArbitraryOverviews</b> ( GDALRasterBandH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a109" doxytag="gdal.h::GDALGetOverviewCount"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetOverviewCount</b> ( GDALRasterBandH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a110" doxytag="gdal.h::GDALGetOverview"></a>
GDALRasterBandH CPL_DLL </td><td valign=bottom><b>GDALGetOverview</b> ( GDALRasterBandH, int )</td></tr>
<tr><td nowrap align=right valign=top><a name="a111" doxytag="gdal.h::GDALGetRasterNoDataValue"></a>
double CPL_DLL </td><td valign=bottom><b>GDALGetRasterNoDataValue</b> ( GDALRasterBandH, int * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a112" doxytag="gdal.h::GDALSetRasterNoDataValue"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALSetRasterNoDataValue</b> ( GDALRasterBandH, double )</td></tr>
<tr><td nowrap align=right valign=top><a name="a113" doxytag="gdal.h::GDALGetRasterCategoryNames"></a>
char CPL_DLL** </td><td valign=bottom><b>GDALGetRasterCategoryNames</b> ( GDALRasterBandH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a114" doxytag="gdal.h::GDALSetRasterCategoryNames"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALSetRasterCategoryNames</b> ( GDALRasterBandH, char ** )</td></tr>
<tr><td nowrap align=right valign=top><a name="a115" doxytag="gdal.h::GDALGetRasterMinimum"></a>
double CPL_DLL </td><td valign=bottom><b>GDALGetRasterMinimum</b> ( GDALRasterBandH, int *pbSuccess )</td></tr>
<tr><td nowrap align=right valign=top><a name="a116" doxytag="gdal.h::GDALGetRasterMaximum"></a>
double CPL_DLL </td><td valign=bottom><b>GDALGetRasterMaximum</b> ( GDALRasterBandH, int *pbSuccess )</td></tr>
<tr><td nowrap align=right valign=top><a name="a117" doxytag="gdal.h::GDALGetRasterUnitType"></a>
const char CPL_DLL* </td><td valign=bottom><b>GDALGetRasterUnitType</b> ( GDALRasterBandH )</td></tr>
<tr><td nowrap align=right valign=top>void CPL_DLL </td><td valign=bottom><a class="el" href="gdal_h.html#a118">GDALComputeRasterMinMax</a> ( GDALRasterBandH hBand, int bApproxOK, double adfMinMax[2] )</td></tr>
<tr><td nowrap align=right valign=top><a name="a119" doxytag="gdal.h::GDALFlushRasterCache"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALFlushRasterCache</b> ( GDALRasterBandH hBand )</td></tr>
<tr><td nowrap align=right valign=top><a name="a120" doxytag="gdal.h::GDALGetRasterHistogram"></a>
CPLErr CPL_DLL </td><td valign=bottom><b>GDALGetRasterHistogram</b> ( GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets, int *panHistogram, int bIncludeOutOfRange, int bApproxOK, <a class="el" href="gdal_h.html#a10">GDALProgressFunc</a> pfnProgress, void * pProgressData )</td></tr>
<tr><td nowrap align=right valign=top><a name="a121" doxytag="gdal.h::GDALGetRandomRasterSample"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetRandomRasterSample</b> ( GDALRasterBandH, int, float * )</td></tr>
<tr><td nowrap align=right valign=top>GDALRasterBandH CPL_DLL </td><td valign=bottom><a class="el" href="gdal_h.html#a122">GDALGetRasterSampleOverview</a> ( GDALRasterBandH, int )</td></tr>
<tr><td nowrap align=right valign=top><a name="a123" doxytag="gdal.h::GDALComputeBandStats"></a>
CPLErr </td><td valign=bottom><b>GDALComputeBandStats</b> ( GDALRasterBandH hBand, int nSampleStep, double *pdfMean, double *pdfStdDev, <a class="el" href="gdal_h.html#a10">GDALProgressFunc</a> pfnProgress, void *pProgressData )</td></tr>
<tr><td nowrap align=right valign=top><a name="a124" doxytag="gdal.h::GDALOverviewMagnitudeCorrection"></a>
CPLErr </td><td valign=bottom><b>GDALOverviewMagnitudeCorrection</b> ( GDALRasterBandH hBaseBand, int nOverviewCount, GDALRasterBandH *pahOverviews, <a class="el" href="gdal_h.html#a10">GDALProgressFunc</a> pfnProgress, void *pProgressData )</td></tr>
<tr><td nowrap align=right valign=top><a name="a125" doxytag="gdal.h::GDALSwapWords"></a>
void CPL_DLL </td><td valign=bottom><b>GDALSwapWords</b> ( void *pData, int nWordSize, int nWordCount, int nWordSkip )</td></tr>
<tr><td nowrap align=right valign=top><a name="a126" doxytag="gdal.h::GDALCopyWords"></a>
void CPL_DLL </td><td valign=bottom><b>GDALCopyWords</b> ( void * pSrcData, <a class="el" href="gdal_h.html#a141">GDALDataType</a> eSrcType, int nSrcPixelOffset, void * pDstData, <a class="el" href="gdal_h.html#a141">GDALDataType</a> eDstType, int nDstPixelOffset, int nWordCount )</td></tr>
<tr><td nowrap align=right valign=top><a name="a127" doxytag="gdal.h::GDALReadWorldFile"></a>
int </td><td valign=bottom><b>GDALReadWorldFile</b> ( const char *pszBaseFilename, const char *pszExtension, double * padfGeoTransform )</td></tr>
<tr><td nowrap align=right valign=top><a name="a128" doxytag="gdal.h::GDALDecToDMS"></a>
const char CPL_DLL* </td><td valign=bottom><b>GDALDecToDMS</b> ( double, const char *, int )</td></tr>
<tr><td nowrap align=right valign=top><a name="a129" doxytag="gdal.h::GDALCreateColorTable"></a>
GDALColorTableH CPL_DLL </td><td valign=bottom><b>GDALCreateColorTable</b> ( <a class="el" href="gdal_h.html#a145">GDALPaletteInterp</a> )</td></tr>
<tr><td nowrap align=right valign=top><a name="a130" doxytag="gdal.h::GDALDestroyColorTable"></a>
void CPL_DLL </td><td valign=bottom><b>GDALDestroyColorTable</b> ( GDALColorTableH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a131" doxytag="gdal.h::GDALCloneColorTable"></a>
GDALColorTableH CPL_DLL </td><td valign=bottom><b>GDALCloneColorTable</b> ( GDALColorTableH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a132" doxytag="gdal.h::GDALGetPaletteInterpretation"></a>
<a class="el" href="gdal_h.html#a145">GDALPaletteInterp</a> CPL_DLL </td><td valign=bottom><b>GDALGetPaletteInterpretation</b> ( GDALColorTableH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a133" doxytag="gdal.h::GDALGetColorEntryCount"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetColorEntryCount</b> ( GDALColorTableH )</td></tr>
<tr><td nowrap align=right valign=top><a name="a134" doxytag="gdal.h::GDALGetColorEntry"></a>
const <a class="el" href="struct_GDALColorEntry.html">GDALColorEntry</a> CPL_DLL* </td><td valign=bottom><b>GDALGetColorEntry</b> ( GDALColorTableH, int )</td></tr>
<tr><td nowrap align=right valign=top><a name="a135" doxytag="gdal.h::GDALGetColorEntryAsRGB"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetColorEntryAsRGB</b> ( GDALColorTableH, int, <a class="el" href="struct_GDALColorEntry.html">GDALColorEntry</a> *)</td></tr>
<tr><td nowrap align=right valign=top><a name="a136" doxytag="gdal.h::GDALSetColorEntry"></a>
void CPL_DLL </td><td valign=bottom><b>GDALSetColorEntry</b> ( GDALColorTableH, int, const <a class="el" href="struct_GDALColorEntry.html">GDALColorEntry</a> * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a137" doxytag="gdal.h::GDALSetCacheMax"></a>
void CPL_DLL </td><td valign=bottom><b>GDALSetCacheMax</b> ( int nBytes )</td></tr>
<tr><td nowrap align=right valign=top><a name="a138" doxytag="gdal.h::GDALGetCacheMax"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetCacheMax</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a139" doxytag="gdal.h::GDALGetCacheUsed"></a>
int CPL_DLL </td><td valign=bottom><b>GDALGetCacheUsed</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a140" doxytag="gdal.h::GDALFlushCacheBlock"></a>
int CPL_DLL </td><td valign=bottom><b>GDALFlushCacheBlock</b> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
Public (C callable) GDAL entry points.
<p>
<hr><h2>Typedef Documentation</h2>
<a name="a10" doxytag="gdal.h::GDALProgressFunc"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef int (* GDALProgressFunc)(double,const char *, void *)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Progresss function signature, see <a class="el" href="gdal_h.html#a52">GDALDummyProgress</a>() for details. </td>
</tr>
</table>
<hr><h2>Enumeration Type Documentation</h2>
<a name="a142" doxytag="gdal.h::GDALAccess"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
enum GDALAccess
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Flag indicating read/write, or read-only access to data. <dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="a142a24" doxytag="GA_ReadOnly"></a><em>GA_ReadOnly</em>
</td><td>
Read only (no update) access </td></tr>
<tr><td valign=top><a name="a142a25" doxytag="GA_Update"></a><em>GA_Update</em>
</td><td>
Read/write access. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a144" doxytag="gdal.h::GDALColorInterp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
enum GDALColorInterp
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Types of color interpretation for raster bands. <dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="a144a29" doxytag="GCI_GrayIndex"></a><em>GCI_GrayIndex</em>
</td><td>
Greyscale </td></tr>
<tr><td valign=top><a name="a144a30" doxytag="GCI_PaletteIndex"></a><em>GCI_PaletteIndex</em>
</td><td>
Paletted (see associated color table) </td></tr>
<tr><td valign=top><a name="a144a31" doxytag="GCI_RedBand"></a><em>GCI_RedBand</em>
</td><td>
Red band of RGBA image </td></tr>
<tr><td valign=top><a name="a144a32" doxytag="GCI_GreenBand"></a><em>GCI_GreenBand</em>
</td><td>
Green band of RGBA image </td></tr>
<tr><td valign=top><a name="a144a33" doxytag="GCI_BlueBand"></a><em>GCI_BlueBand</em>
</td><td>
Blue band of RGBA image </td></tr>
<tr><td valign=top><a name="a144a34" doxytag="GCI_AlphaBand"></a><em>GCI_AlphaBand</em>
</td><td>
Alpha (0=transparent, 255=opaque) </td></tr>
<tr><td valign=top><a name="a144a35" doxytag="GCI_HueBand"></a><em>GCI_HueBand</em>
</td><td>
Hue band of HLS image </td></tr>
<tr><td valign=top><a name="a144a36" doxytag="GCI_SaturationBand"></a><em>GCI_SaturationBand</em>
</td><td>
Saturation band of HLS image </td></tr>
<tr><td valign=top><a name="a144a37" doxytag="GCI_LightnessBand"></a><em>GCI_LightnessBand</em>
</td><td>
Lightness band of HLS image </td></tr>
<tr><td valign=top><a name="a144a38" doxytag="GCI_CyanBand"></a><em>GCI_CyanBand</em>
</td><td>
Cyan band of CMYK image </td></tr>
<tr><td valign=top><a name="a144a39" doxytag="GCI_MagentaBand"></a><em>GCI_MagentaBand</em>
</td><td>
Magenta band of CMYK image </td></tr>
<tr><td valign=top><a name="a144a40" doxytag="GCI_YellowBand"></a><em>GCI_YellowBand</em>
</td><td>
Yellow band of CMYK image </td></tr>
<tr><td valign=top><a name="a144a41" doxytag="GCI_BlackBand"></a><em>GCI_BlackBand</em>
</td><td>
Black band of CMLY image </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a141" doxytag="gdal.h::GDALDataType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
enum GDALDataType
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Pixel data types <dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="a141a12" doxytag="GDT_Byte"></a><em>GDT_Byte</em>
</td><td>
Eight bit unsigned integer </td></tr>
<tr><td valign=top><a name="a141a13" doxytag="GDT_UInt16"></a><em>GDT_UInt16</em>
</td><td>
Sixteen bit unsigned integer </td></tr>
<tr><td valign=top><a name="a141a14" doxytag="GDT_Int16"></a><em>GDT_Int16</em>
</td><td>
Sixteen bit signed integer </td></tr>
<tr><td valign=top><a name="a141a15" doxytag="GDT_UInt32"></a><em>GDT_UInt32</em>
</td><td>
Thirty two bit unsigned integer </td></tr>
<tr><td valign=top><a name="a141a16" doxytag="GDT_Int32"></a><em>GDT_Int32</em>
</td><td>
Thirty two bit signed integer </td></tr>
<tr><td valign=top><a name="a141a17" doxytag="GDT_Float32"></a><em>GDT_Float32</em>
</td><td>
Thirty two bit floating point </td></tr>
<tr><td valign=top><a name="a141a18" doxytag="GDT_Float64"></a><em>GDT_Float64</em>
</td><td>
Sixty four bit floating point </td></tr>
<tr><td valign=top><a name="a141a19" doxytag="GDT_CInt16"></a><em>GDT_CInt16</em>
</td><td>
Complex Int16 </td></tr>
<tr><td valign=top><a name="a141a20" doxytag="GDT_CInt32"></a><em>GDT_CInt32</em>
</td><td>
Complex Int32 </td></tr>
<tr><td valign=top><a name="a141a21" doxytag="GDT_CFloat32"></a><em>GDT_CFloat32</em>
</td><td>
Complex Float32 </td></tr>
<tr><td valign=top><a name="a141a22" doxytag="GDT_CFloat64"></a><em>GDT_CFloat64</em>
</td><td>
Complex Float64 </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a145" doxytag="gdal.h::GDALPaletteInterp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
enum GDALPaletteInterp
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Types of color interpretations for a GDALColorTable. <dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="a145a42" doxytag="GPI_Gray"></a><em>GPI_Gray</em>
</td><td>
Grayscale (in GDALColorEntry.c1) </td></tr>
<tr><td valign=top><a name="a145a43" doxytag="GPI_RGB"></a><em>GPI_RGB</em>
</td><td>
Red, Green, Blue and Alpha in (in c1, c2, c3 and c4) </td></tr>
<tr><td valign=top><a name="a145a44" doxytag="GPI_CMYK"></a><em>GPI_CMYK</em>
</td><td>
Cyan, Magenta, Yellow and Black (in c1, c2, c3 and c4) </td></tr>
<tr><td valign=top><a name="a145a45" doxytag="GPI_HLS"></a><em>GPI_HLS</em>
</td><td>
Hue, Lightness and Saturation (in c1, c2, and c3) </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a143" doxytag="gdal.h::GDALRWFlag"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
enum GDALRWFlag
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Read/Write flag for RasterIO() method <dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="a143a26" doxytag="GF_Read"></a><em>GF_Read</em>
</td><td>
Read data </td></tr>
<tr><td valign=top><a name="a143a27" doxytag="GF_Write"></a><em>GF_Write</em>
</td><td>
Write data </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a57" doxytag="gdal.h::GDALAllRegister"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void GDALAllRegister (
</b></td>
<td valign="bottom"><b>
void )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Register all known configured GDAL drivers.
<p>
This function will drive any of the following that are configured into GDAL. Possible others as well that haven't been updated in this documentation:
<p>
<ul>
<li> GeoTIFF (GTiff) <li> Geosoft GXF (GXF) <li> Erdas Imagine (HFA) <li> CEOS (CEOS) <li> ELAS (ELAS) <li> Arc/Info Binary Grid (AIGrid) <li> SDTS Raster DEM (SDTS) <li> OGDI (OGDI) <li> ESRI Labelled BIL (EHdr) <li> PCI .aux Labelled Raw Raster (PAux) </ul>
</td>
</tr>
</table>
<a name="a118" doxytag="gdal.h::GDALComputeRasterMinMax"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void GDALComputeRasterMinMax (
</b></td>
<td valign="bottom"><b>
GDALRasterBandH <em>hBand</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>bApproxOK</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
double <em>adfMinMax</em>[2] )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Compute the min/max values for a band.
<p>
If approximate is OK, then the band's GetMinimum()/GetMaximum() will be trusted. If it doesn't work, a subsample of blocks will be read to get an approximate min/max. If the band has a nodata value it will be excluded from the minimum and maximum.
<p>
If bApprox is FALSE, then all pixels will be read and used to compute an exact range.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>hBand</em>
</td><td>
the band to copmute the range for. </td></tr>
<tr><td valign=top><em>bApproxOK</em>
</td><td>
TRUE if an approximate (faster) answer is OK, otherwise FALSE. </td></tr>
<tr><td valign=top><em>adfMinMax</em>
</td><td>
the array in which the minimum (adfMinMax[0]) and the maximum (adfMinMax[1]) are returned. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a49" doxytag="gdal.h::GDALDataTypeUnion"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="gdal_h.html#a141">GDALDataType</a> GDALDataTypeUnion (
</b></td>
<td valign="bottom"><b>
<a class="el" href="gdal_h.html#a141">GDALDataType</a> <em>eType1</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="gdal_h.html#a141">GDALDataType</a> <em>eType2</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return the smallest data type that can fully express both input data types.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>eType1</em>
</td><td>
</td></tr>
<tr><td valign=top><em>eType2</em>
</td><td>
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
a data type able to express eType1 and eType2. </dl> </td>
</tr>
</table>
<a name="a52" doxytag="gdal.h::GDALDummyProgress"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int GDALDummyProgress (
</b></td>
<td valign="bottom"><b>
double,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char *,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
void * )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Stub progress function.
<p>
Many long running operations within GDAL the option of passing a progress function. The progress function is intended to provide a way of displaying a progress indicator to the user, and for the user to terminate the process prematurely. Applications not desiring to utilize this support should normally pass GDALDummyProgress as the pfnProgress argument and NULL as the pData argument.
<p>
Applications wishing to take advantage of the progress semantics should pass a function implementing GDALProgressFunc semantics.
<p>
<pre>
typedef int (*GDALProgressFunc)(double dfComplete,
const char *pszMessage,
void *pData);
</pre><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>dfComplete</em>
</td><td>
Passed in the with ratio of the operation that is complete, and is a value between 0.0 and 1.0.</td></tr>
<tr><td valign=top><em>pszMessage</em>
</td><td>
This is normally passed in as NULL, but will occasionally be passed in with a message about what is happening that may be displayed to the user.</td></tr>
<tr><td valign=top><em>pData</em>
</td><td>
Application data (as passed via pData into GDAL operation).
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
TRUE if the operation should continue, or FALSE if the user has requested a cancel.
<p>
</dl>For example, an application might implement the following simple text progress reporting mechanism, using pData to pass a default message:
<p>
<pre>
int MyTextProgress( double dfComplete, const char *pszMessage, void *pData)
{
if( pszMessage != NULL )
printf( "d%% complete: s<br>
", (int) (dfComplete*100), pszMessage );
else if( pData != NULL )
printf( "d%% complete:s<br>
", (int) (dfComplete*100),
(char *) pData );
else
printf( "d%% complete.\n", (int) (dfComplete*100) );
return TRUE;
}
</pre>
<p>
This could be utilized with the <a class="el" href="class_GDALDataset.html#a20">GDALDataset::BuildOverviews</a>() method like this:
<p>
<pre>
int anOverviewList[3] = {2, 4, 8};
poDataset->BuildOverviews( "NEAREST", 3, anOverviewList, 0, NULL,
MyTextProgress, "building overviews" );
</pre>
<p>
More often that implementing custom progress functions, applications will just use existing progress functions like <a class="el" href="gdal_h.html#a52">GDALDummyProgress</a>(), and <a class="el" href="gdal_h.html">GDALScaledProgress</a>(). Python scripts also can pass progress functions. </td>
</tr>
</table>
<a name="a50" doxytag="gdal.h::GDALGetColorInterpretationName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const char * GDALGetColorInterpretationName (
</b></td>
<td valign="bottom"><b>
<a class="el" href="gdal_h.html#a144">GDALColorInterp</a> <em>eInterp</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Translate a GDALColorInterp into a user displayable string. </td>
</tr>
</table>
<a name="a51" doxytag="gdal.h::GDALGetPaletteInterpretationName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const char * GDALGetPaletteInterpretationName (
</b></td>
<td valign="bottom"><b>
<a class="el" href="gdal_h.html#a145">GDALPaletteInterp</a> <em>eInterp</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Translate a GDALPaletteInterp into a user displayable string. </td>
</tr>
</table>
<a name="a122" doxytag="gdal.h::GDALGetRasterSampleOverview"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
GDALRasterBandH GDALGetRasterSampleOverview (
</b></td>
<td valign="bottom"><b>
GDALRasterBandH <em>hBand</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>nDesiredSamples</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch best sampling overview.
<p>
Returns the most reduced overview of the given band that still satisfies the desired number of samples. This function can be used with zero as the number of desired samples to fetch the most reduced overview. The same band as was passed in will be returned if it has not overviews, or if none of the overviews have enough samples.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>hBand</em>
</td><td>
the band to search for overviews on. </td></tr>
<tr><td valign=top><em>nDesiredSamples</em>
</td><td>
the returned band will have at least this many pixels. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
optimal overview or hBand itself. </dl> </td>
</tr>
</table>
<a name="a60" doxytag="gdal.h::GDALOpen"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
GDALDatasetH GDALOpen (
</b></td>
<td valign="bottom"><b>
const char * <em>pszFilename</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="gdal_h.html#a142">GDALAccess</a> <em>eAccess</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Open a raster file as a <a class="el" href="class_GDALDataset.html">GDALDataset</a>.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pszFilename</em>
</td><td>
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.</td></tr>
<tr><td valign=top><em>eAccess</em>
</td><td>
the desired access, either GA_Update or GA_ReadOnly. Many drivers support only read only access.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
A GDALDatasetH handle or NULL on failure. For C++ applications this handle can be cast to a <a class="el" href="class_GDALDataset.html">GDALDataset</a> *. </dl> </td>
</tr>
</table>
<hr><address><small>Generated at Thu Mar 28 09:47:32 2002 for GDAL by
<a href="http://www.stack.nl/~dimitri/doxygen/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.3-20001105 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2000</small></address>
</body>
</html>
