<!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>GDALDataset Class 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:32 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>GDALDataset Class Reference</h1><code>#include <<a class="el" href="gdal_priv_h-source.html">gdal_priv.h</a>></code>
<p>
<p>Inheritance diagram for GDALDataset:
<p><center><img src="class_GDALDataset.gif" usemap="#GDALDataset_map" border="0"></center>
<map name="GDALDataset_map">
</map>
<a href="class_GDALDataset-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a0">~GDALDataset</a> ()</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a1">GetRasterXSize</a> ( void )</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a2">GetRasterYSize</a> ( void )</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a3">GetRasterCount</a> ( void )</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_GDALRasterBand.html">GDALRasterBand</a>* </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a4">GetRasterBand</a> ( int )</td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a5">FlushCache</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a6">GetProjectionRef</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>virtual CPLErr </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a7">SetProjection</a> ( const char * )</td></tr>
<tr><td nowrap align=right valign=top>virtual CPLErr </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a8">GetGeoTransform</a> ( double * )</td></tr>
<tr><td nowrap align=right valign=top>virtual CPLErr </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a9">SetGeoTransform</a> ( double * )</td></tr>
<tr><td nowrap align=right valign=top>virtual CPLErr </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a10">AddBand</a> ( <a class="el" href="gdal_h.html#a141">GDALDataType</a> eType, char **papszOptions=NULL )</td></tr>
<tr><td nowrap align=right valign=top>virtual void* </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a11">GetInternalHandle</a> ( const char * )</td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_GDALDriver.html">GDALDriver</a>* </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a12">GetDriver</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a13">GetGCPCount</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a14">GetGCPProjection</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual const <a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a>* </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a15">GetGCPs</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual CPLErr </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a16">SetGCPs</a> ( int nGCPCount, const <a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a> *pasGCPList, const char *pszGCPProjection )</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a17">Reference</a> ()</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a18">Dereference</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a19" doxytag="GDALDataset::GetAccess"></a>
<a class="el" href="gdal_h.html#a142">GDALAccess</a> </td><td valign=bottom><b>GetAccess</b> ()</td></tr>
<tr><td nowrap align=right valign=top>CPLErr </td><td valign=bottom><a class="el" href="class_GDALDataset.html#a20">BuildOverviews</a> ( const char *, int, int *, int, int *, <a class="el" href="gdal_h.html#a10">GDALProgressFunc</a>, void * )</td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="b0" doxytag="GDALDataset::GDALDataset"></a>
</td><td valign=bottom><b>GDALDataset</b> (void)</td></tr>
<tr><td nowrap align=right valign=top><a name="b1" doxytag="GDALDataset::RasterInitialize"></a>
void </td><td valign=bottom><b>RasterInitialize</b> ( int, int )</td></tr>
<tr><td nowrap align=right valign=top><a name="b2" doxytag="GDALDataset::SetBand"></a>
void </td><td valign=bottom><b>SetBand</b> ( int, <a class="el" href="class_GDALRasterBand.html">GDALRasterBand</a> * )</td></tr>
<tr><td nowrap align=right valign=top><a name="b3" doxytag="GDALDataset::IBuildOverviews"></a>
virtual CPLErr </td><td valign=bottom><b>IBuildOverviews</b> ( const char *, int, int *, int, int *, <a class="el" href="gdal_h.html#a10">GDALProgressFunc</a>, void * )</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="n0" doxytag="GDALDataset::poDriver"></a>
<a class="el" href="class_GDALDriver.html">GDALDriver</a>* </td><td valign=bottom><b>poDriver</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n1" doxytag="GDALDataset::eAccess"></a>
<a class="el" href="gdal_h.html#a142">GDALAccess</a> </td><td valign=bottom><b>eAccess</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n2" doxytag="GDALDataset::nRasterXSize"></a>
int </td><td valign=bottom><b>nRasterXSize</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n3" doxytag="GDALDataset::nRasterYSize"></a>
int </td><td valign=bottom><b>nRasterYSize</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n4" doxytag="GDALDataset::nBands"></a>
int </td><td valign=bottom><b>nBands</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n5" doxytag="GDALDataset::papoBands"></a>
<a class="el" href="class_GDALRasterBand.html">GDALRasterBand</a>** </td><td valign=bottom><b>papoBands</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n6" doxytag="GDALDataset::nRefCount"></a>
int </td><td valign=bottom><b>nRefCount</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n7" doxytag="GDALDataset::oOvManager"></a>
GDALDefaultOverviews </td><td valign=bottom><b>oOvManager</b></td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_GDALDriver.html">GDALDriver</a></td></tr>
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_GDALRasterBand.html">GDALRasterBand</a></td></tr>
<tr><td nowrap align=right valign=top>GDALDatasetH </td><td valign=bottom><a class="el" href="class_GDALDataset.html#l2">GDALOpen</a> ( const char *, <a class="el" href="gdal_h.html#a142">GDALAccess</a>)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A dataset encapsulating one or more raster bands.
<p>
Use <a class="el" href="class_GDALDataset.html#l2">GDALOpen</a> to create a GDALDataset for a named file.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="GDALDataset::~GDALDataset"></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>
GDALDataset::~GDALDataset (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destroy an open GDALDataset.
<p>
This is the accepted method of closing a GDAL dataset and deallocating all resources associated with it.
<p>
Equivelent of the C callable <a class="el" href="gdal_h.html">GDALClose</a>(). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a10" doxytag="GDALDataset::AddBand"></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>
CPLErr GDALDataset::AddBand (
</b></td>
<td valign="bottom"><b>
<a class="el" href="gdal_h.html#a141">GDALDataType</a> <em>eType</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
char ** <em>papszOptions</em> = NULL )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Add a band to a dataset.
<p>
This method will add a new band to the dataset if the underlying format supports this action. Most formats do not.
<p>
Note that the new <a class="el" href="class_GDALRasterBand.html">GDALRasterBand</a> is not returned. It may be fetched after successful completion of the method by calling <a class="el" href="class_GDALDataset.html#a4">GDALDataset::GetRasterBand</a>(<a class="el" href="class_GDALDataset.html#a3">GDALDataset::GetRasterCount</a>()-1) as the newest band will always be the last band.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>eType</em>
</td><td>
the data type of the pixels in the new band.</td></tr>
<tr><td valign=top><em>papszOptions</em>
</td><td>
a list of NAME=VALUE option strings. The supported options are format specific. NULL may be passed by default.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
CE_None on success or CE_Failure on failure. </dl> </td>
</tr>
</table>
<a name="a20" doxytag="GDALDataset::BuildOverviews"></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>
CPLErr GDALDataset::BuildOverviews (
</b></td>
<td valign="bottom"><b>
const char * <em>pszResampling</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>nOverviews</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int * <em>panOverviewList</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>nListBands</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int * <em>panBandList</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="gdal_h.html#a10">GDALProgressFunc</a> <em>pfnProgress</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
void * <em>pProgressData</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Build raster overview(s)
<p>
If the operation is unsupported for the indicated dataset, then CE_Failure is returned, and CPLGetLastError() will return CPLE_NonSupported.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pszResampling</em>
</td><td>
one of "NEAREST", "AVERAGE" or "MODE" controlling the downsampling method applied. </td></tr>
<tr><td valign=top><em>nOverviews</em>
</td><td>
number of overviews to build. </td></tr>
<tr><td valign=top><em>panOverviewList</em>
</td><td>
the list of overview decimation factors to build. </td></tr>
<tr><td valign=top><em>nBand</em>
</td><td>
number of bands to build overviews for in panBandList. Build for all bands if this is 0. </td></tr>
<tr><td valign=top><em>panBandList</em>
</td><td>
list of band numbers. </td></tr>
<tr><td valign=top><em>pfnProgress</em>
</td><td>
a function to call to report progress, or NULL. </td></tr>
<tr><td valign=top><em>pProgressData</em>
</td><td>
application data to pass to the progress function.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
CE_None on success or CE_Failure if the operation doesn't work.
<p>
</dl>For example, to build overview level 2, 4 and 8 on all bands the following call could be made: <pre>
int anOverviewList[3] = { 2, 4, 8 };
poDataset->BuildOverviews( "NEAREST", 3, anOverviewList, 0, NULL,
GDALDummyProgress, NULL );
</pre> </td>
</tr>
</table>
<a name="a18" doxytag="GDALDataset::Dereference"></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 GDALDataset::Dereference (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Subtract one from dataset reference count.
<p>
The reference is one after instantiation. Generally when the reference count has dropped to zero the dataset may be safely deleted (closed).
<p>
This method is the same as the C <a class="el" href="gdal_h.html">GDALDereferenceDataset</a>() function.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
the post-decrement reference count. </dl> </td>
</tr>
</table>
<a name="a5" doxytag="GDALDataset::FlushCache"></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 GDALDataset::FlushCache (
</b></td>
<td valign="bottom"><b>
void )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Flush all write cached data to disk.
<p>
Any raster (or other GDAL) data written via GDAL calls, but buffered internally will be written to disk. </td>
</tr>
</table>
<a name="a12" doxytag="GDALDataset::GetDriver"></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="class_GDALDriver.html">GDALDriver</a> * GDALDataset::GetDriver (
</b></td>
<td valign="bottom"><b>
void )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch the driver to which this dataset relates.
<p>
This method is the same as the C <a class="el" href="gdal_h.html">GDALGetDatasetDriver</a>() function.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
the driver on which the dataset was created with <a class="el" href="class_GDALDataset.html#l2">GDALOpen</a> or <a class="el" href="gdal_h.html">GDALCreate</a>(). </dl> </td>
</tr>
</table>
<a name="a13" doxytag="GDALDataset::GetGCPCount"></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 GDALDataset::GetGCPCount (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get number of GCPs.
<p>
This method is the same as the C function <a class="el" href="gdal_h.html">GDALGetGCPCount</a>().
<p>
<dl compact><dt>
<b>Returns: </b><dd>
number of GCPs for this dataset. Zero if there are none. </dl> </td>
</tr>
</table>
<a name="a14" doxytag="GDALDataset::GetGCPProjection"></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 * GDALDataset::GetGCPProjection (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get output projection for GCPs.
<p>
This method is the same as the C function <a class="el" href="gdal_h.html">GDALGetGCPProjection</a>().
<p>
The projection string follows the normal rules from <a class="el" href="class_GDALDataset.html#a6">GetProjectionRef</a>().
<p>
<dl compact><dt>
<b>Returns: </b><dd>
internal projection string or "" if there are no GCPs. </dl> </td>
</tr>
</table>
<a name="a15" doxytag="GDALDataset::GetGCPs"></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 <a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a> * GDALDataset::GetGCPs (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch GCPs.
<p>
This method is the same as the C function <a class="el" href="gdal_h.html">GDALGetGCPs</a>().
<p>
<dl compact><dt>
<b>Returns: </b><dd>
pointer to internal GCP structure list. It should not be modified, and may change on the next GDAL call. </dl> </td>
</tr>
</table>
<a name="a8" doxytag="GDALDataset::GetGeoTransform"></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>
CPLErr GDALDataset::GetGeoTransform (
</b></td>
<td valign="bottom"><b>
double * <em>padfTransform</em> )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch the affine transformation coefficients.
<p>
Fetches the coefficients for transforming between pixel/line (P,L) raster space, and projection coordinates (Xp,Yp) space.
<p>
Xp = padfTransform[0] + P*padfTransform[1] + L*padfTransform[2]; Yp = padfTransform[3] + P*padfTransform[4] + L*padfTransform[5];
<p>
In a north up image, padfTransform[1] is the pixel width, and padfTransform[5] is the pixel height. The upper left corner of the upper left pixel is at position (padfTransform[0],padfTransform[3]).
<p>
The default transform is (0,1,0,0,0,1) and should be returned even when a CE_Failure error is returned, such as for formats that don't support transformation to projection coordinates.
<p>
NOTE: <a class="el" href="class_GDALDataset.html#a8">GetGeoTransform</a>() isn't expressive enough to handle the variety of OGC Grid Coverages pixel/line to projection transformation schemes. Eventually this method will be depreciated in favour of a more general scheme.
<p>
This method does the same thing as the C <a class="el" href="gdal_h.html">GDALGetGeoTransform</a>() function.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>padfTransform</em>
</td><td>
an existing six double buffer into which the transformation will be placed.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
CE_None on success, or CE_Failure if no transform can be fetched. </dl> </td>
</tr>
</table>
<a name="a11" doxytag="GDALDataset::GetInternalHandle"></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 * GDALDataset::GetInternalHandle (
</b></td>
<td valign="bottom"><b>
const char * )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch a format specific internally meaningful handle.
<p>
This method is the same as the C <a class="el" href="gdal_h.html">GDALGetInternalHandle</a>() method.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pszHandleName</em>
</td><td>
the handle name desired. The meaningful names will be specific to the file format.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
the desired handle value, or NULL if not recognised/supported. </dl> </td>
</tr>
</table>
<a name="a6" doxytag="GDALDataset::GetProjectionRef"></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 * GDALDataset::GetProjectionRef (
</b></td>
<td valign="bottom"><b>
void )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch the projection definition string for this dataset.
<p>
Same as the C function <a class="el" href="gdal_h.html">GDALGetProjectionRef</a>().
<p>
The returned string defines the projection coordinate system of the image in either PROJ.4 format or OpenGIS WKT format. It should be suitable for use with the GDALProjDef object to reproject positions.
<p>
When a projection definition is not available an empty (but not NULL) string is returned.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
a pointer to an internal projection reference string. It should not be altered, freed or expected to last for long. </dl> </td>
</tr>
</table>
<a name="a4" doxytag="GDALDataset::GetRasterBand"></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="class_GDALRasterBand.html">GDALRasterBand</a> * GDALDataset::GetRasterBand (
</b></td>
<td valign="bottom"><b>
int <em>nBandId</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch a band object for a dataset.
<p>
Equivelent of the C function <a class="el" href="gdal_h.html">GDALGetRasterBand</a>().<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>nBandId</em>
</td><td>
the index number of the band to fetch, from 1 to <a class="el" href="class_GDALDataset.html#a3">GetRasterCount</a>().
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
the height in pixels of raster bands in this GDALDataset. </dl> </td>
</tr>
</table>
<a name="a3" doxytag="GDALDataset::GetRasterCount"></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 GDALDataset::GetRasterCount (
</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>
Fetch the number of raster bands on this dataset.
<p>
Same as the C function <a class="el" href="gdal_h.html">GDALGetRasterCount</a>().
<p>
<dl compact><dt>
<b>Returns: </b><dd>
the number of raster bands. </dl> </td>
</tr>
</table>
<a name="a1" doxytag="GDALDataset::GetRasterXSize"></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 GDALDataset::GetRasterXSize (
</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>
Fetch raster width in pixels.
<p>
Equivelent of the C function <a class="el" href="gdal_h.html">GDALGetRasterXSize</a>().
<p>
<dl compact><dt>
<b>Returns: </b><dd>
the width in pixels of raster bands in this GDALDataset. </dl> </td>
</tr>
</table>
<a name="a2" doxytag="GDALDataset::GetRasterYSize"></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 GDALDataset::GetRasterYSize (
</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>
Fetch raster height in pixels.
<p>
Equivelent of the C function <a class="el" href="gdal_h.html">GDALGetRasterYSize</a>().
<p>
<dl compact><dt>
<b>Returns: </b><dd>
the height in pixels of raster bands in this GDALDataset. </dl> </td>
</tr>
</table>
<a name="a17" doxytag="GDALDataset::Reference"></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 GDALDataset::Reference (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Add one to dataset reference count.
<p>
The reference is one after instantiation.
<p>
This method is the same as the C <a class="el" href="gdal_h.html">GDALReferenceDataset</a>() function.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
the post-increment reference count. </dl> </td>
</tr>
</table>
<a name="a16" doxytag="GDALDataset::SetGCPs"></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>
CPLErr GDALDataset::SetGCPs (
</b></td>
<td valign="bottom"><b>
int <em>nGCPCount</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="struct_GDAL_GCP.html">GDAL_GCP</a> * <em>pasGCPList</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>pszGCPProjection</em> )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Assign GCPs.
<p>
This method is the same as the C function <a class="el" href="gdal_h.html">GDALSetGCPs</a>().
<p>
This method assigns the passed set of GCPs to this dataset, as well as setting their coordinate system. Internally copies are made of the coordinate system and list of points, so the caller remains resposible for deallocating these arguments if appropriate.
<p>
Most formats do not support setting of GCPs, even foramts that can handle GCPs. These formats will return CE_Failure.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>nGCPCount</em>
</td><td>
number of GCPs being assigned.</td></tr>
<tr><td valign=top><em>pasGCPList</em>
</td><td>
array of GCP structures being assign (nGCPCount in array).</td></tr>
<tr><td valign=top><em>pszGCPProjection</em>
</td><td>
the new OGC WKT coordinate system to assign for the GCP output coordinates. This parameter should be "" if no output coordinate system is known.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
CE_None on success, CE_Failure on failure (including if action is not supported for this format). </dl> </td>
</tr>
</table>
<a name="a9" doxytag="GDALDataset::SetGeoTransform"></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>
CPLErr GDALDataset::SetGeoTransform (
</b></td>
<td valign="bottom"><b>
double * )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the affine transformation coefficients.
<p>
See <a class="el" href="class_GDALDataset.html#a8">GetGeoTransform</a>() for details on the meaning of the padfTransform coefficients.
<p>
This method does the same thing as the C <a class="el" href="gdal_h.html">GDALSetGeoTransform</a>() function.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>padfTransform</em>
</td><td>
a six double buffer containing the transformation coefficients to be written with the dataset.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
CE_None on success, or CE_Failure if this transform cannot be written. </dl> </td>
</tr>
</table>
<a name="a7" doxytag="GDALDataset::SetProjection"></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>
CPLErr GDALDataset::SetProjection (
</b></td>
<td valign="bottom"><b>
const char * )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the projection reference string for this dataset.
<p>
The string should be in OGC WKT or PROJ.4 format. An error may occur because of incorrectly specified projection strings, because the dataset is not writable, or because the dataset does not support the indicated projection. Many formats do not support writing projections.
<p>
This method is the same as the C <a class="el" href="gdal_h.html">GDALSetProjection</a>() function.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pszProjection</em>
</td><td>
projection reference string.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
CE_Failure if an error occurs, otherwise CE_None. </dl> </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="l2" doxytag="GDALDataset::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> )<code> [friend]</code>
</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 GDALDataset.<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 GDALDataset *. </dl> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="gdal_priv_h-source.html">gdal_priv.h</a><li><a class="el" href="gdaldataset_cpp-source.html">gdaldataset.cpp</a></ul>
<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>
