File: vtkio_vtkdemreader.html

package info (click to toggle)
freemat 4.2%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 141,800 kB
  • ctags: 14,082
  • sloc: ansic: 126,788; cpp: 62,046; python: 2,080; perl: 1,255; sh: 1,146; yacc: 1,019; lex: 239; makefile: 100
file content (136 lines) | stat: -rw-r--r-- 7,794 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<!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"/>
<title>FreeMat: vtkDEMReader</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</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">FreeMat
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vtkio_vtkdemreader.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">vtkDEMReader </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkio.html">Visualization Toolkit IO Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkDEMReader reads digital elevation files and creates image data. Digital elevation files are produced by the <a href="http://www.usgs.gov">US Geological Survey</a>. A complete description of the DEM file is located at the USGS site. The reader reads the entire dem file and create a vtkImageData that contains a single scalar component that is the elevation in meters. The spacing is also expressed in meters. A number of get methods provide access to fields on the header.</p>
<p>To create an instance of class vtkDEMReader, simply invoke its constructor as follows </p>
<pre class="fragment">  obj = vtkDEMReader
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkDEMReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, <code>obj</code> is an instance of the vtkDEMReader class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code>  </li>
<li>
<code>int = obj.IsA (string name)</code>  </li>
<li>
<code>vtkDEMReader = obj.NewInstance ()</code>  </li>
<li>
<code>vtkDEMReader = obj.SafeDownCast (vtkObject o)</code>  </li>
<li>
<code>obj.SetFileName (string )</code> - Specify file name of Digital Elevation Model (DEM) file  </li>
<li>
<code>string = obj.GetFileName ()</code> - Specify file name of Digital Elevation Model (DEM) file  </li>
<li>
<code>obj.SetElevationReference (int )</code> - Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).  </li>
<li>
<code>int = obj.GetElevationReferenceMinValue ()</code> - Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).  </li>
<li>
<code>int = obj.GetElevationReferenceMaxValue ()</code> - Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).  </li>
<li>
<code>int = obj.GetElevationReference ()</code> - Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).  </li>
<li>
<code>obj.SetElevationReferenceToSeaLevel ()</code> - Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).  </li>
<li>
<code>obj.SetElevationReferenceToElevationBounds ()</code> - Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).  </li>
<li>
<code>string = obj.GetElevationReferenceAsString (void )</code> - Specify the elevation origin to use. By default, the elevation origin is equal to ElevationBounds[0]. A more convenient origin is to use sea level (i.e., a value of 0.0).  </li>
<li>
<code>string = obj.GetMapLabel ()</code> - An ASCII description of the map  </li>
<li>
<code>int = obj.GetDEMLevel ()</code> - Code 1=DEM-1, 2=DEM_2, ...  </li>
<li>
<code>int = obj.GetElevationPattern ()</code> - Code 1=regular, 2=random, reserved for future use  </li>
<li>
<code>int = obj.GetGroundSystem ()</code> - Ground planimetric reference system  </li>
<li>
<code>int = obj.GetGroundZone ()</code> - Zone in ground planimetric reference system  </li>
<li>
<code>float = obj. GetProjectionParameters ()</code> - Map Projection parameters. All are zero.  </li>
<li>
<code>int = obj.GetPlaneUnitOfMeasure ()</code> - Defining unit of measure for ground planimetric coordinates throughout the file. 0 = radians, 1 = feet, 2 = meters, 3 = arc-seconds.  </li>
<li>
<code>int = obj.GetElevationUnitOfMeasure ()</code> - Defining unit of measure for elevation coordinates throughout the file. 1 = feet, 2 = meters  </li>
<li>
<code>int = obj.GetPolygonSize ()</code> - Number of sides in the polygon which defines the coverage of the DEM file. Set to 4.  </li>
<li>
<code>float = obj. GetElevationBounds ()</code> - Minimum and maximum elevation for the DEM. The units in the file are in ElevationUnitOfMeasure. This class converts them to meters.  </li>
<li>
<code>float = obj.GetLocalRotation ()</code> - Counterclockwise angle (in radians) from the primary axis of the planimetric reference to the primary axis of the DEM local reference system. IGNORED BY THIS IMPLEMENTATION.  </li>
<li>
<code>int = obj.GetAccuracyCode ()</code> - Accuracy code for elevations. 0=unknown accuracy  </li>
<li>
<code>float = obj. GetSpatialResolution ()</code> - DEM spatial resolution for x,y,z. Values are expressed in units of resolution. Since elevations are read as integers, this permits fractional elevations.  </li>
<li>
<code>int = obj. GetProfileDimension ()</code> - The number of rows and columns in the DEM.  </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_vtkio.html">Visualization Toolkit IO Classes</a></li>
    <li class="footer">Generated on Thu Jul 25 2013 17:18:34 for FreeMat by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
  </ul>
</div>
</body>
</html>