classgdalrasterattributetable.html

gdal库的学习文档

          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="gdal_8h.html#810154ac91149d1a63c42717258fe16e">GDALRATFieldType</a>&nbsp;</td>
          <td class="paramname"> <em>eFieldType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="gdal_8h.html#27bf786b965d5227da1acc2a4cab69a1">GDALRATFieldUsage</a>&nbsp;</td>
          <td class="paramname"> <em>eFieldUsage</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create new column. 
<p>
If the table already has rows, all row values for the new column will be initialized to the default value ("", or zero). The new column is always created as the last column, can will be column (field) "GetColumnCount()-1" after <a class="el" href="classGDALRasterAttributeTable.html#2a4f7248c0e37e217b1d6423c538123e">CreateColumn()</a> has completed successfully.<p>
This method is the same as the C function GDALRATCreateColumn().<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>pszFieldName</em>&nbsp;</td><td>the name of the field to create. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>eFieldType</em>&nbsp;</td><td>the field type (integer, double or string). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>eFieldUsage</em>&nbsp;</td><td>the field usage, GFU_Generic if not known.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>CE_None on success or CE_Failure if something goes wrong. </dd></dl>

</div>
</div><p>
<a class="anchor" name="ca7ea5023d9820fd8611a388ca947887"></a><!-- doxytag: member="GDALRasterAttributeTable::SetLinearBinning" ref="ca7ea5023d9820fd8611a388ca947887" args="(double dfRow0Min, double dfBinSize)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CPLErr GDALRasterAttributeTable::SetLinearBinning           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>dfRow0MinIn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>dfBinSizeIn</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set linear binning information. 
<p>
For RATs with equal sized categories (in pixel value space) that are evenly spaced, this method may be used to associate the linear binning information with the table.<p>
This method is the same as the C function GDALRATSetLinearBinning().<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>dfRow0MinIn</em>&nbsp;</td><td>the lower bound (pixel value) of the first category. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>dfBinSizeIn</em>&nbsp;</td><td>the width of each category (in pixel value units).</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>CE_None on success or CE_Failure on failure. </dd></dl>

</div>
</div><p>
<a class="anchor" name="256e0e90249b812048731c597f6f79f2"></a><!-- doxytag: member="GDALRasterAttributeTable::GetLinearBinning" ref="256e0e90249b812048731c597f6f79f2" args="(double *pdfRow0Min, double *pdfBinSize) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int GDALRasterAttributeTable::GetLinearBinning           </td>
          <td>(</td>
          <td class="paramtype">double *&nbsp;</td>
          <td class="paramname"> <em>pdfRow0Min</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&nbsp;</td>
          <td class="paramname"> <em>pdfBinSize</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get linear binning information. 
<p>
Returns linear binning information if any is associated with the RAT.<p>
This method is the same as the C function GDALRATGetLinearBinning().<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>pdfRow0MinIn</em>&nbsp;</td><td>(out) the lower bound (pixel value) of the first category. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pdfBinSizeIn</em>&nbsp;</td><td>(out) the width of each category (in pixel value units).</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE if linear binning information exists or FALSE if there is none. </dd></dl>

</div>
</div><p>
<a class="anchor" name="ce0bd498e5533d9f1585f801ca6ecf5e"></a><!-- doxytag: member="GDALRasterAttributeTable::InitializeFromColorTable" ref="ce0bd498e5533d9f1585f801ca6ecf5e" args="(const GDALColorTable *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CPLErr GDALRasterAttributeTable::InitializeFromColorTable           </td>
          <td>(</td>
          <td class="paramtype">const GDALColorTable *&nbsp;</td>
          <td class="paramname"> <em>poTable</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize from color table. 
<p>
This method will setup a whole raster attribute table based on the contents of the passed color table. The Value (GFU_MinMax), Red (GFU_Red), Green (GFU_Green), Blue (GFU_Blue), and Alpha (GFU_Alpha) fields are created, and a row is set for each entry in the color table.<p>
The raster attribute table must be empty before calling <a class="el" href="classGDALRasterAttributeTable.html#ce0bd498e5533d9f1585f801ca6ecf5e">InitializeFromColorTable()</a>.<p>
The Value fields are set based on the implicit assumption with color tables that entry 0 applies to pixel value 0, 1 to 1, etc.<p>
This method is the same as the C function GDALRATInitializeFromColorTable().<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>poTable</em>&nbsp;</td><td>the color table to copy from.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>CE_None</em>&nbsp;</td><td>on success or CE_Failure if something goes wrong. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="855180a5a68a73a6830d00ffd6ee655f"></a><!-- doxytag: member="GDALRasterAttributeTable::TranslateToColorTable" ref="855180a5a68a73a6830d00ffd6ee655f" args="(int nEntryCount=-1)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GDALColorTable * GDALRasterAttributeTable::TranslateToColorTable           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>nEntryCount</em> = <code>-1</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Translate to a color table. 
<p>
This method will attempt to create a corresponding GDALColorTable from this raster attribute table.<p>
This method is the same as the C function GDALRATTranslateToColorTable().<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>nEntryCount</em>&nbsp;</td><td>The number of entries to produce (0 to nEntryCount-1), or -1 to auto-determine the number of entries.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the generated color table or NULL on failure. </dd></dl>

</div>
</div><p>
<a class="anchor" name="3dad1ef8c228f8a24c304b511e17c72f"></a><!-- doxytag: member="GDALRasterAttributeTable::DumpReadable" ref="3dad1ef8c228f8a24c304b511e17c72f" args="(FILE *=NULL)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GDALRasterAttributeTable::DumpReadable           </td>
          <td>(</td>
          <td class="paramtype">FILE *&nbsp;</td>
          <td class="paramname"> <em>fp</em> = <code>NULL</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Dump RAT in readable form. 
<p>
Currently the readable form is the XML encoding ... only barely readable.<p>
This method is the same as the C function GDALRATDumpReadable().<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>fp</em>&nbsp;</td><td>file to dump to or NULL for stdout. </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="gdal__rat_8h-source.html">gdal_rat.h</a><li>gdal_rat.cpp</ul>
<hr>

Generated for GDAL by 
<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1.
</body>
</html>