classgdalrasterband.html

gdal库的学习文档

          <td class="memname">double GDALRasterBand::GetNoDataValue           </td>
          <td>(</td>
          <td class="paramtype">int *&nbsp;</td>
          <td class="paramname"> <em>pbSuccess</em> = <code>NULL</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fetch the no data value for this band.<p>
If there is no out of data value, an out of range value will generally be returned. The no data value for a band is generally a special marker value used to mark pixels that are not valid data. Such pixels should generally not be displayed, nor contribute to analysis operations.<p>
This method is the same as the C function <a class="el" href="gdal_8h.html#087441349e8ce2285c405fabf662aeaf">GDALGetRasterNoDataValue()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>pbSuccess</em>&nbsp;</td><td>pointer to a boolean to use to indicate if a value is actually associated with this layer. May be NULL (default).</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the nodata value for this band. </dd></dl>

</div>
</div><p>
<a class="anchor" name="aabf419931d0f505428f91cff54085cc"></a><!-- doxytag: member="GDALRasterBand::GetMinimum" ref="aabf419931d0f505428f91cff54085cc" args="(int *pbSuccess=NULL)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double GDALRasterBand::GetMinimum           </td>
          <td>(</td>
          <td class="paramtype">int *&nbsp;</td>
          <td class="paramname"> <em>pbSuccess</em> = <code>NULL</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fetch the minimum value for this band.<p>
For file formats that don't know this intrinsically, the minimum supported value for the data type will generally be returned.<p>
This method is the same as the C function <a class="el" href="gdal_8h.html#3a2e32244e8e906238171efa0af767ba">GDALGetRasterMinimum()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>pbSuccess</em>&nbsp;</td><td>pointer to a boolean to use to indicate if the returned value is a tight minimum or not. May be NULL (default).</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the minimum raster value (excluding no data pixels) </dd></dl>

</div>
</div><p>
<a class="anchor" name="bd5f6f0b339155484343d887998e29f5"></a><!-- doxytag: member="GDALRasterBand::GetMaximum" ref="bd5f6f0b339155484343d887998e29f5" args="(int *pbSuccess=NULL)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double GDALRasterBand::GetMaximum           </td>
          <td>(</td>
          <td class="paramtype">int *&nbsp;</td>
          <td class="paramname"> <em>pbSuccess</em> = <code>NULL</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fetch the maximum value for this band.<p>
For file formats that don't know this intrinsically, the maximum supported value for the data type will generally be returned.<p>
This method is the same as the C function <a class="el" href="gdal_8h.html#403a61b92434a77717488915a5e615cb">GDALGetRasterMaximum()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>pbSuccess</em>&nbsp;</td><td>pointer to a boolean to use to indicate if the returned value is a tight maximum or not. May be NULL (default).</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the maximum raster value (excluding no data pixels) </dd></dl>

</div>
</div><p>
<a class="anchor" name="b62e0761dde3e3b76f83155920275e4f"></a><!-- doxytag: member="GDALRasterBand::GetOffset" ref="b62e0761dde3e3b76f83155920275e4f" args="(int *pbSuccess=NULL)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double GDALRasterBand::GetOffset           </td>
          <td>(</td>
          <td class="paramtype">int *&nbsp;</td>
          <td class="paramname"> <em>pbSuccess</em> = <code>NULL</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fetch the raster value offset.<p>
This value (in combination with the <a class="el" href="classGDALRasterBand.html#94f689e571b963cf8d35989b60269d1e">GetScale()</a> value) is used to transform raw pixel values into the units returned by GetUnits(). For example this might be used to store elevations in GUInt16 bands with a precision of 0.1, and starting from -100.<p>
Units value = (raw value * scale) + offset<p>
For file formats that don't know this intrinsically a value of zero is returned.<p>
This method is the same as the C function GDALGetRasterOffset().<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>pbSuccess</em>&nbsp;</td><td>pointer to a boolean to use to indicate if the returned value is meaningful or not. May be NULL (default).</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the raster offset. </dd></dl>

</div>
</div><p>
<a class="anchor" name="94f689e571b963cf8d35989b60269d1e"></a><!-- doxytag: member="GDALRasterBand::GetScale" ref="94f689e571b963cf8d35989b60269d1e" args="(int *pbSuccess=NULL)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double GDALRasterBand::GetScale           </td>
          <td>(</td>
          <td class="paramtype">int *&nbsp;</td>
          <td class="paramname"> <em>pbSuccess</em> = <code>NULL</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fetch the raster value scale.<p>
This value (in combination with the <a class="el" href="classGDALRasterBand.html#b62e0761dde3e3b76f83155920275e4f">GetOffset()</a> value) is used to transform raw pixel values into the units returned by GetUnits(). For example this might be used to store elevations in GUInt16 bands with a precision of 0.1, and starting from -100.<p>
Units value = (raw value * scale) + offset<p>
For file formats that don't know this intrinsically a value of one is returned.<p>
This method is the same as the C function GDALGetRasterScale().<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>pbSuccess</em>&nbsp;</td><td>pointer to a boolean to use to indicate if the returned value is meaningful or not. May be NULL (default).</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the raster scale. </dd></dl>

</div>
</div><p>
<a class="anchor" name="c3df26caebd2b90c8e808e3fb6105a07"></a><!-- doxytag: member="GDALRasterBand::GetUnitType" ref="c3df26caebd2b90c8e808e3fb6105a07" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char * GDALRasterBand::GetUnitType           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return raster unit type.<p>
Return a name for the units of this raster's values. For instance, it might be "m" for an elevation model in meters, or "ft" for feet. If no units are available, a value of "" will be returned. The returned string should not be modified, nor freed by the calling application.<p>
This method is the same as the C function <a class="el" href="gdal_8h.html#48e4bb5bb87c2f2df2db3e53badefa75">GDALGetRasterUnitType()</a>.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>unit name string. </dd></dl>

</div>
</div><p>
<a class="anchor" name="772e1232ac07944e4c6bce3c66f98103"></a><!-- doxytag: member="GDALRasterBand::GetColorInterpretation" ref="772e1232ac07944e4c6bce3c66f98103" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gdal_8h.html#ce76452d94514561fffa8ea1d2a5968c">GDALColorInterp</a> GDALRasterBand::GetColorInterpretation           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
How should this band be interpreted as color?<p>
CV_Undefined is returned when the format doesn't know anything about the color interpretation.<p>
This method is the same as the C function <a class="el" href="gdal_8h.html#ec13128878a5f4e4a96605c4b6c71d6f">GDALGetRasterColorInterpretation()</a>.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>color interpretation value for band. </dd></dl>

</div>
</div><p>
<a class="anchor" name="2c5cad0f0fc1b6e261d1e965a5b49969"></a><!-- doxytag: member="GDALRasterBand::GetColorTable" ref="2c5cad0f0fc1b6e261d1e965a5b49969" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">