EVOLUTION-MANAGER
Edit File: classSDTSRasterReader.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>SDTS_AL: SDTSRasterReader Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">SDTS_AL </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classSDTSRasterReader-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">SDTSRasterReader Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="sdts__al_8h_source.html">sdts_al.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aab9c9516e4d39e402e7e0011f0eb663b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSRasterReader.html#aab9c9516e4d39e402e7e0011f0eb663b">GetRasterType</a> ()</td></tr> <tr class="separator:aab9c9516e4d39e402e7e0011f0eb663b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a21b947af7ad073525fd9b31ba7ef9018"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSRasterReader.html#a21b947af7ad073525fd9b31ba7ef9018">GetTransform</a> (double *)</td></tr> <tr class="separator:a21b947af7ad073525fd9b31ba7ef9018"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abf7dc46031598be7cd6081784a2d6bee"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSRasterReader.html#abf7dc46031598be7cd6081784a2d6bee">GetMinMax</a> (double *pdfMin, double *pdfMax, double dfNoData)</td></tr> <tr class="separator:abf7dc46031598be7cd6081784a2d6bee"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa275b83c8c8b9c40ab0e28bfc3e08ad8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSRasterReader.html#aa275b83c8c8b9c40ab0e28bfc3e08ad8">GetXSize</a> ()</td></tr> <tr class="separator:aa275b83c8c8b9c40ab0e28bfc3e08ad8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a00efe380beb807d29de75ff59385caa3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSRasterReader.html#a00efe380beb807d29de75ff59385caa3">GetYSize</a> ()</td></tr> <tr class="separator:a00efe380beb807d29de75ff59385caa3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acd2ab09e205f3f2fa162420d28e6054f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSRasterReader.html#acd2ab09e205f3f2fa162420d28e6054f">GetBlockXSize</a> ()</td></tr> <tr class="separator:acd2ab09e205f3f2fa162420d28e6054f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e228c555941538f63f5a33dc806be3a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSRasterReader.html#a5e228c555941538f63f5a33dc806be3a">GetBlockYSize</a> ()</td></tr> <tr class="separator:a5e228c555941538f63f5a33dc806be3a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acf6d12ae289a6430449b1bbde567159f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSRasterReader.html#acf6d12ae289a6430449b1bbde567159f">GetBlock</a> (int nXOffset, int nYOffset, void *pData)</td></tr> <tr class="separator:acf6d12ae289a6430449b1bbde567159f"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Class for reading raster data from a raster layer.</p> <p>This class is somewhat unique amoung the reader classes in that it isn't derived from SDTSIndexedFeature, and it doesn't return "features". Instead it is used to read raster blocks, in the natural block size of the dataset. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="acf6d12ae289a6430449b1bbde567159f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDTSRasterReader::GetBlock </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>nXOffset</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>nYOffset</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>pData</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Read a block of raster data from the file.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nXOffset</td><td>X block offset into the file. Normally zero for scanline organized raster files.</td></tr> <tr><td class="paramname">nYOffset</td><td>Y block offset into the file. Normally the scanline offset from top of raster for scanline organized raster files.</td></tr> <tr><td class="paramname">pData</td><td>pointer to GInt16 (signed short) buffer of data into which to read the raster.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE on success and FALSE on error. </dd></dl> </div> </div> <a class="anchor" id="acd2ab09e205f3f2fa162420d28e6054f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int SDTSRasterReader::GetBlockXSize </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch the width of a source block (usually same as raster width). </p> </div> </div> <a class="anchor" id="a5e228c555941538f63f5a33dc806be3a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int SDTSRasterReader::GetBlockYSize </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch the height of a source block (usually one). </p> </div> </div> <a class="anchor" id="abf7dc46031598be7cd6081784a2d6bee"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDTSRasterReader::GetMinMax </td> <td>(</td> <td class="paramtype">double * </td> <td class="paramname"><em>pdfMin</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"><em>pdfMax</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>dfNoData</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Fetch the minimum and maximum raster values that occur in the file.</p> <p>Note this operation current results in a scan of the entire file.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pdfMin</td><td>variable in which the minimum value encountered is returned. </td></tr> <tr><td class="paramname">pdfMax</td><td>variable in which the maximum value encountered is returned. </td></tr> <tr><td class="paramname">dfNoData</td><td>a value to ignore when computing min/max, defaults to -32766.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE on success, or FALSE if an error occurs. </dd></dl> </div> </div> <a class="anchor" id="aab9c9516e4d39e402e7e0011f0eb663b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDTSRasterReader::GetRasterType </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Fetch the pixel data type.</p> <p>Returns one of SDTS_RT_INT16 (1) or SDTS_RT_FLOAT32 (6) indicating the type of buffer that should be passed to <a class="el" href="classSDTSRasterReader.html#acf6d12ae289a6430449b1bbde567159f">GetBlock()</a>. </p> </div> </div> <a class="anchor" id="a21b947af7ad073525fd9b31ba7ef9018"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDTSRasterReader::GetTransform </td> <td>(</td> <td class="paramtype">double * </td> <td class="paramname"><em>padfTransformOut</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Fetch the transformation between pixel/line coordinates and georeferenced coordinates.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">padfTransformOut</td><td>pointer to an array of six doubles which will be filled with the georeferencing transform.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE is returned, indicating success.</dd></dl> <p>The padfTransformOut array consists of six values. The pixel/line coordinate (Xp,Yp) can be related to a georeferenced coordinate (Xg,Yg) or (Easting, Northing).</p> <pre> Xg = padfTransformOut[0] + Xp * padfTransform[1] + Yp * padfTransform[2] Yg = padfTransformOut[3] + Xp * padfTransform[4] + Yp * padfTransform[5] </pre><p>In other words, for a north up image the top left corner of the top left pixel is at georeferenced coordinate (padfTransform[0],padfTransform[3]) the pixel width is padfTransform[1], the pixel height is padfTransform[5] and padfTransform[2] and padfTransform[4] will be zero. </p> </div> </div> <a class="anchor" id="aa275b83c8c8b9c40ab0e28bfc3e08ad8"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int SDTSRasterReader::GetXSize </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch the raster width.</p> <dl class="section return"><dt>Returns</dt><dd>the width in pixels. </dd></dl> </div> </div> <a class="anchor" id="a00efe380beb807d29de75ff59385caa3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int SDTSRasterReader::GetYSize </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch the raster height.</p> <dl class="section return"><dt>Returns</dt><dd>the height in pixels. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="sdts__al_8h_source.html">sdts_al.h</a></li> <li>sdtsrasterreader.cpp</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>