SuperMap.Analyst.TerrainAnalyst.xml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SuperMap.Analyst.TerrainAnalyst</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst">
  8. <summary>
  9. The hydrology analyst class, which is used to fill sink, flow direction, sink calculation, flow accumulation, basin, flow length, stream to line, and quad mesh.
  10. </summary>
  11. </member>
  12. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.BuildQuadMesh(SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter,SuperMap.Data.Datasource,System.String)">
  13. <summary>
  14. Processes the meshing for a simple region object.
  15. </summary>
  16. <param name="parameter">The parameter of meshing</param>
  17. <param name="targetDatasource">The dataset to store the result after meshing</param>
  18. <param name="targetDatasetName">The name of the dataset after meshing.</param>
  19. <returns>The dataset after meshing. </returns>
  20. </member>
  21. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.BuildQuadMesh(SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter)">
  22. <summary>
  23. Processes the meshing for the simple region object. And returns the array of simple region object
  24. </summary>
  25. <param name="parameter">The parameter of meshing</param>
  26. <returns>The simple region object array after meshing.</returns>
  27. </member>
  28. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.Basin(SuperMap.Data.DatasetGrid,SuperMap.Data.Datasource,System.String)">
  29. <summary>
  30. Drainage basin is calculated according to the flow direction grid.
  31. </summary>
  32. <param name="directionGrid">The specified flow direction raster dataset.</param>
  33. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where directionGrid is.</param>
  34. <param name="resultGridName">The specified name of the result dataset.</param>
  35. <returns>The drainage basin is grid dataset. If the build fails, it returns null.</returns>
  36. </member>
  37. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.FillSink(SuperMap.Data.DatasetGrid,SuperMap.Data.Datasource,System.String)">
  38. <summary>
  39. Fill sink for DEM grid data.
  40. </summary>
  41. <param name="surfaceGrid">The specified DEM data to fill sinks.</param>
  42. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where surfaceGrid is.</param>
  43. <param name="resultGridName">The specified name of the result dataset.</param>
  44. <returns>Pseudo sinks DEM grid dataset. If failed, returns null.</returns>
  45. </member>
  46. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.FillSink(SuperMap.Data.DatasetGrid,SuperMap.Data.Datasource,System.String,SuperMap.Data.DatasetVector)">
  47. <summary>
  48. According to the given sinks data excluded (point or region datasets), fill sinks in DEM grid data, and the result of these sink area is assigned as no value.
  49. </summary>
  50. <param name="surfaceGrid">The specified DEM data to fill sinks.</param>
  51. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where surfaceGrid is.</param>
  52. <param name="resultGridName">The specified name of the result dataset.</param>
  53. <param name="excludeArea">The sink point or region data used to indicate the known natural sinks or sinks excluded. If it is point dataset, one or more points area are sinks; if it is region dataset, each region object corresponds to a sink.</param>
  54. <returns>Pseudo sinks DEM grid dataset. If failed, returns null.</returns>
  55. </member>
  56. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.FlowDirection(SuperMap.Data.DatasetGrid,System.Boolean,SuperMap.Data.Datasource,System.String)">
  57. <summary>
  58. Calculate flow diretion. In order to guarantee the correctness of the flow, it is recommended to use the DEM grid data after filling.
  59. </summary>
  60. <param name="surfaceGrid">The specified DEM to calculate flow direction.</param>
  61. <param name="forceFlowAtEdge">Specifies whether to force the boundary grid flow outward. If true, the DEM grid at the edge of the flow of all the cells are outward.</param>
  62. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where surfaceGrid is.</param>
  63. <param name="resultGridName">The specified name of the result dataset.</param>
  64. <returns>The result flow grid dataset. If the build fails, it returns null.</returns>
  65. </member>
  66. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.FlowDirection(SuperMap.Data.DatasetGrid,System.Boolean,SuperMap.Data.Datasource,System.String,System.String)">
  67. <summary>
  68. Calculate flow direction, and create the elevation gradient gird. In order to guarantee the correctness of the flow, it is recommended to use the DEM grid data after filling.
  69. </summary>
  70. <param name="surfaceGrid">The specified DEM to calculate flow direction.</param>
  71. <param name="forceFlowAtEdge">Specifies whether to force the boundary grid flow outward. If true, the DEM grid at the edge of the flow of all the cells are outward.</param>
  72. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where surfaceGrid is.</param>
  73. <param name="resultGridName">The specified name of the result dataset.</param>
  74. <param name="dropGridName">The specified name of the elevation gradient dataset.</param>
  75. <returns>The result flow grid dataset. If the build fails, it returns null.</returns>
  76. </member>
  77. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.FlowAccumulation(SuperMap.Data.DatasetGrid,SuperMap.Data.DatasetGrid,SuperMap.Data.Datasource,System.String)">
  78. <summary>
  79. This function is used to create a network to show accumulated flow into each cell.
  80. </summary>
  81. <param name="directionGrid">The specified flow direction grid data.</param>
  82. <param name="weightGrid">The weight grid data. If null, there is no weight.</param>
  83. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where directionGrid is.</param>
  84. <param name="resultGridName">The specified name of the result dataset.</param>
  85. <returns>The result accumulative flow grid dataset. If the build fails, it returns null.</returns>
  86. </member>
  87. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.FlowLength(SuperMap.Data.DatasetGrid,SuperMap.Data.DatasetGrid,System.Boolean,SuperMap.Data.Datasource,System.String)">
  88. <summary>
  89. Every cell in a raster has a flow path which passes it.
  90. </summary>
  91. <param name="directionGrid">The specified flow direction grid data.</param>
  92. <param name="weightGrid">The weight grid data. If null, there is no weight.</param>
  93. <param name="upStream">Specify downstream direction or upstream direction. If true, it is upstream, otherwise, false. </param>
  94. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where directionGrid is.</param>
  95. <param name="resultGridName">The name of the result length dataset.</param>
  96. <returns>The result flow length grid dataset. If the build fails, it returns null.</returns>
  97. </member>
  98. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.PourPoints(SuperMap.Data.DatasetGrid,SuperMap.Data.DatasetGrid,System.Int32,SuperMap.Data.Datasource,System.String)">
  99. <summary>
  100. The pour point grid is generated based on the flow grid and cumulative water grid.
  101. </summary>
  102. <param name="directionGrid">The specified flow direction grid data.</param>
  103. <param name="accumulationGrid">The accumulation grid.</param>
  104. <param name="areaLimit">The area limit.</param>
  105. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where directionGrid is.</param>
  106. <param name="resultGridName">The specified name for the result grid dataset.</param>
  107. <returns>The result pour point grid dataset. If the build fails, it returns null.</returns>
  108. </member>
  109. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.StreamLink(SuperMap.Data.DatasetGrid,SuperMap.Data.DatasetGrid,SuperMap.Data.Datasource,System.String)">
  110. <summary>
  111. Stream linkage refers to assigning a unique value for each river according to the grid water system and the flow grid.
  112. </summary>
  113. <param name="streamGrid">The grid water system data.</param>
  114. <param name="directionGrid">The specified flow direction grid data.</param>
  115. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where directionGrid is.</param>
  116. <param name="resultGridName">The specified name for the result grid dataset.</param>
  117. <returns>The grid water system after linking. It is a grid dataset. If failed, return null.</returns>
  118. </member>
  119. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.StreamOrder(SuperMap.Data.DatasetGrid,SuperMap.Data.DatasetGrid,SuperMap.Analyst.TerrainAnalyst.StreamOrderType,SuperMap.Data.Datasource,System.String)">
  120. <summary>
  121. Classify rivers and mark numbers.
  122. </summary>
  123. <param name="streamGrid">The grid water system data.</param>
  124. <param name="directionGrid">The specified flow direction grid data.</param>
  125. <param name="orderType">The order type.</param>
  126. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where directionGrid is.</param>
  127. <param name="resultGridName">The specified name for the result grid dataset.</param>
  128. <returns>After numbering, it is a grid dataset. If failed, return null.</returns>
  129. </member>
  130. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.StreamToLine(SuperMap.Data.DatasetGrid,SuperMap.Data.DatasetGrid,SuperMap.Data.Datasource,System.String,SuperMap.Analyst.TerrainAnalyst.StreamOrderType)">
  131. <summary>
  132. Extract vector river system, that is convert raster river system to vector river system and store river levels to the attribute table of the result dataset.
  133. </summary>
  134. <param name="streamGrid">The grid water system data.</param>
  135. <param name="directionGrid">The specified flow direction grid data.</param>
  136. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where directionGrid is.</param>
  137. <param name="resultGridName">The specified name for the result grid dataset.</param>
  138. <param name="orderType">The order type.</param>
  139. <returns>Vector water dataset, as a vector line dataset. If the build fails, it returns null.</returns>
  140. </member>
  141. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.Watershed(SuperMap.Data.DatasetGrid,SuperMap.Data.Point2Ds,SuperMap.Data.Datasource,System.String)">
  142. <summary>
  143. A watershed is also called a contributing area, this function identifies every contributing area through a series of points.
  144. </summary>
  145. <param name="directionGrid">The specified flow direction grid data.</param>
  146. <param name="pourPoints">The pour points, in geographic coordinate unit.</param>
  147. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where directionGrid is.</param>
  148. <param name="resultGridName">The specified name for the result grid dataset.</param>
  149. <returns>The drainage basin is grid dataset. If the build fails, it returns null.</returns>
  150. </member>
  151. <member name="M:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.Watershed(SuperMap.Data.DatasetGrid,SuperMap.Data.DatasetGrid,SuperMap.Data.Datasource,System.String)">
  152. <summary>
  153. A watershed is also called a contributing area, this function identifies every contributing area through a series of points.
  154. </summary>
  155. <param name="directionGrid">The specified flow direction grid data.</param>
  156. <param name="pourPointsGrid">The pour point grid data.</param>
  157. <param name="targetDatasource">The specified datasource used to store the result dataset. If set to null, the resulting dataset will be automatically stored in the datasource where directionGrid is.</param>
  158. <param name="resultGridName">The specified name for the result grid dataset.</param>
  159. <returns>The drainage basin is grid dataset. If the build fails, it returns null.</returns>
  160. </member>
  161. <member name="E:SuperMap.Analyst.TerrainAnalyst.HydrologyAnalyst.Stepped">
  162. <summary>
  163. The event is trigged when the process bar is activated.
  164. </summary>
  165. </member>
  166. <member name="T:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter">
  167. <summary>
  168. The QuadMeshParameter class. It usually contain the count of rows and columns as well as the coordinates of four tops.
  169. </summary>
  170. </member>
  171. <member name="M:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.#ctor">
  172. <summary>
  173. Build a new object of the QuadMeshParameter class.
  174. </summary>
  175. </member>
  176. <member name="M:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.#ctor(SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter)">
  177. <summary>
  178. Builds a same QuadMeshParameter object as the specified object
  179. </summary>
  180. <param name="quadMeshParameter">The meshing parameter object </param>
  181. </member>
  182. <member name="M:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.#ctor(SuperMap.Data.GeoRegion,System.Int32,System.Int32,SuperMap.Data.Point2D,SuperMap.Data.Point2D,SuperMap.Data.Point2D,SuperMap.Data.Point2D,System.String,System.String)">
  183. <summary>
  184. Builds a new object according to the parameter.
  185. </summary>
  186. <param name="quadMeshRegion">The region object for meshing.</param>
  187. <param name="rowCount">The row count for meshing.</param>
  188. <param name="colCount">The column count for meshing.</param>
  189. <param name="leftBottomPoint">The coordinate of the lower left point.</param>
  190. <param name="rightBottomPoint">The coordinate of the lower right point.</param>
  191. <param name="rightTopPoint">The coordinate of the top right point.</param>
  192. <param name="leftTopPoint">The coordinate of the top left point.</param>
  193. <param name="colField">The name of the row field</param>
  194. <param name="rowField">The name of the column field.</param>
  195. </member>
  196. <member name="P:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.QuadMeshRegion">
  197. <summary>
  198. Gets or sets the region object of the meshing.
  199. </summary>
  200. </member>
  201. <member name="P:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.RowCount">
  202. <summary>
  203. Gets or sets the row count in the meshing.
  204. </summary>
  205. <value>The default is 0, indicating that it is not processed. If this value is less than RowCount-1, the RowCount-1 will be the maximum tops of the polygon; If this value is greater than RowCount-1, this value will be the maximum tops of the polygon. </value>
  206. </member>
  207. <member name="P:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.ColCount">
  208. <summary>
  209. Gets or sets the column count in the meshing.
  210. </summary>
  211. <value>The default is 0, indicating that it is not processed. If this value is less than ColCount-1, the ColCount-1 will be the maximum tops of the polygon; If this value is greater than ColCount-1, this value will be the maximum tops of the polygon.</value>
  212. </member>
  213. <member name="P:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.LeftTopPoint">
  214. <summary>
  215. Sets the coordinate of top left point of the meshing.
  216. </summary>
  217. </member>
  218. <member name="P:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.RightTopPoint">
  219. <summary>
  220. Sets the coordinate of top right point of the meshing.
  221. </summary>
  222. </member>
  223. <member name="P:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.LeftBottomPoint">
  224. <summary>
  225. Sets the coordinate of lower left point of the meshing.
  226. </summary>
  227. </member>
  228. <member name="P:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.RightBottomPoint">
  229. <summary>
  230. Sets the coordinate of lower right of the meshing.
  231. </summary>
  232. </member>
  233. <member name="P:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.RowField">
  234. <summary>
  235. Gets or sets the row field of the meshing result. This field holds the No. of rows.
  236. </summary>
  237. </member>
  238. <member name="P:SuperMap.Analyst.TerrainAnalyst.QuadMeshParameter.ColField">
  239. <summary>
  240. Gets or sets the column field of the meshing result. This field holds the No. of columns.
  241. </summary>
  242. </member>
  243. <member name="T:SuperMap.Analyst.TerrainAnalyst.StreamOrderType">
  244. <summary>
  245. This enumeration defines the stream order type constants.
  246. </summary>
  247. </member>
  248. <member name="F:SuperMap.Analyst.TerrainAnalyst.StreamOrderType.Strahler">
  249. <summary>
  250. Strahler river classification.
  251. <para>Strahler: the river source is the first level; if the river formed by two same level, then level of the river plus one; if the river formed by two different levels, then the level of this river equals to the original river with higher level.</para><para></para></summary>
  252. </member>
  253. <member name="F:SuperMap.Analyst.TerrainAnalyst.StreamOrderType.Shreve">
  254. <summary>
  255. Shreve river classification
  256. <para>Shreve: the river source is the first level; if the river formed by two rivers, then the level of the river is the sum of the two. As shown below: the river source is the first level; if the river formed by two rivers, then the level of the river is the sum of the two.</para><para></para></summary>
  257. </member>
  258. </members>
  259. </doc>