Skip to content
Permalink
Browse files

[processing] improvements in help for algorithms

Avoid creating temporary helpfiles
Added basic converter to convert rst into html on the fly
Added SAGA help files
  • Loading branch information
volaya committed Apr 19, 2014
1 parent 9b277cb commit bce5b899a28b0933b1f7ebdb199dc71fad80dcb3
Showing with 9,145 additions and 75 deletions.
  1. +3 −4 python/plugins/processing/algs/grass/GrassAlgorithm.py
  2. +2 −2 python/plugins/processing/algs/otb/OTBAlgorithm.py
  3. +3 −4 python/plugins/processing/algs/r/RAlgorithm.py
  4. +10 −3 python/plugins/processing/algs/saga/SagaAlgorithm.py
  5. +31 −0 python/plugins/processing/algs/saga/help/accumulatedcostanisotropic.rst
  6. +30 −0 python/plugins/processing/algs/saga/help/accumulatedcostisotropic.rst
  7. +28 −0 python/plugins/processing/algs/saga/help/addcoordinatestopoints.rst
  8. +44 −0 python/plugins/processing/algs/saga/help/addgridvaluestopoints.rst
  9. +38 −0 python/plugins/processing/algs/saga/help/addgridvaluestoshapes.rst
  10. +31 −0 python/plugins/processing/algs/saga/help/addpolygonattributestopoints.rst
  11. +35 −0 python/plugins/processing/algs/saga/help/aggregate.rst
  12. +37 −0 python/plugins/processing/algs/saga/help/aggregatepointobservations.rst
  13. +28 −0 python/plugins/processing/algs/saga/help/aggregationindex.rst
  14. +28 −0 python/plugins/processing/algs/saga/help/analyticalhierarchyprocess.rst
  15. +39 −0 python/plugins/processing/algs/saga/help/analyticalhillshading.rst
  16. +32 −0 python/plugins/processing/algs/saga/help/bifurcation.rst
  17. +37 −0 python/plugins/processing/algs/saga/help/bsplineapproximation.rst
  18. +36 −0 python/plugins/processing/algs/saga/help/burnstreamnetworkintodem.rst
  19. +47 −0 python/plugins/processing/algs/saga/help/catchmentareaflowtracing.rst
  20. +42 −0 python/plugins/processing/algs/saga/help/catchmentareamassfluxmethod.rst
  21. +55 −0 python/plugins/processing/algs/saga/help/catchmentareaparallel.rst
  22. +49 −0 python/plugins/processing/algs/saga/help/catchmentarearecursive.rst
  23. +36 −0 python/plugins/processing/algs/saga/help/cellbalance.rst
  24. +60 −0 python/plugins/processing/algs/saga/help/changedateformat.rst
  25. +46 −0 python/plugins/processing/algs/saga/help/changedetection.rst
  26. +36 −0 python/plugins/processing/algs/saga/help/changegridvalues.rst
  27. +52 −0 python/plugins/processing/algs/saga/help/changetimeformat.rst
  28. +31 −0 python/plugins/processing/algs/saga/help/changevectoranalysis.rst
  29. +44 −0 python/plugins/processing/algs/saga/help/channelnetwork.rst
  30. +34 −0 python/plugins/processing/algs/saga/help/channelnetworkanddrainagebasins.rst
  31. +28 −0 python/plugins/processing/algs/saga/help/clipgridwithpolygon.rst
  32. +36 −0 python/plugins/processing/algs/saga/help/clippointswithpolygons.rst
  33. +29 −0 python/plugins/processing/algs/saga/help/closegaps.rst
  34. +41 −0 python/plugins/processing/algs/saga/help/closegapswithspline.rst
  35. +27 −0 python/plugins/processing/algs/saga/help/closeonecellgaps.rst
  36. +39 −0 python/plugins/processing/algs/saga/help/clusteranalysisforgrids.rst
  37. +37 −0 python/plugins/processing/algs/saga/help/colorblending.rst
  38. +29 −0 python/plugins/processing/algs/saga/help/combinegrids.rst
  39. +30 −0 python/plugins/processing/algs/saga/help/contourlinesfromgrid.rst
  40. +39 −0 python/plugins/processing/algs/saga/help/convergenceindex.rst
  41. +46 −0 python/plugins/processing/algs/saga/help/convergenceindexsearchradius.rst
  42. +41 −0 python/plugins/processing/algs/saga/help/convertdatastoragetype.rst
  43. +31 −0 python/plugins/processing/algs/saga/help/convertlinestopoints.rst
  44. +28 −0 python/plugins/processing/algs/saga/help/convertlinestopolygons.rst
  45. +27 −0 python/plugins/processing/algs/saga/help/convertmultipointstopoints.rst
  46. +30 −0 python/plugins/processing/algs/saga/help/convertpointstolines.rst
  47. +28 −0 python/plugins/processing/algs/saga/help/convertpolygonlineverticestopoints.rst
  48. +29 −0 python/plugins/processing/algs/saga/help/convertpolygonstolines.rst
  49. +31 −0 python/plugins/processing/algs/saga/help/converttabletopoints.rst
  50. +36 −0 python/plugins/processing/algs/saga/help/convexhull.rst
  51. +27 −0 python/plugins/processing/algs/saga/help/countpointsinpolygons.rst
  52. +41 −0 python/plugins/processing/algs/saga/help/creategraticule.rst
  53. +30 −0 python/plugins/processing/algs/saga/help/crossclassificationandtabulation.rst
  54. +31 −0 python/plugins/processing/algs/saga/help/crossprofiles.rst
  55. +40 −0 python/plugins/processing/algs/saga/help/cubicsplineapproximation.rst
  56. +29 −0 python/plugins/processing/algs/saga/help/curvatureclassification.rst
  57. +51 −0 python/plugins/processing/algs/saga/help/cutshapeslayer.rst
  58. +54 −0 python/plugins/processing/algs/saga/help/directionalstatisticsforsinglegrid.rst
  59. +32 −0 python/plugins/processing/algs/saga/help/distancematrix.rst
  60. +28 −0 python/plugins/processing/algs/saga/help/diurnalanisotropicheating.rst
  61. +37 −0 python/plugins/processing/algs/saga/help/downslopedistancegradient.rst
  62. +31 −0 python/plugins/processing/algs/saga/help/dtmfilterslopebased.rst
  63. +27 −0 python/plugins/processing/algs/saga/help/edgecontamination.rst
  64. +44 −0 python/plugins/processing/algs/saga/help/effectiveairflowheights.rst
  65. +63 −0 python/plugins/processing/algs/saga/help/enumeratetablefield.rst
  66. +30 −0 python/plugins/processing/algs/saga/help/fastregiongrowingalgorithm.rst
  67. +30 −0 python/plugins/processing/algs/saga/help/fastrepresentativeness.rst
  68. +36 −0 python/plugins/processing/algs/saga/help/fillgapsinrecords.rst
  69. +28 −0 python/plugins/processing/algs/saga/help/fillsinksplanchondarboux2001.rst
  70. +30 −0 python/plugins/processing/algs/saga/help/fillsinkswangliu.rst
  71. +28 −0 python/plugins/processing/algs/saga/help/fillsinksxxlwangliu.rst
  72. +28 −0 python/plugins/processing/algs/saga/help/filterclumps.rst
  73. +41 −0 python/plugins/processing/algs/saga/help/fireriskanalysis.rst
  74. +28 −0 python/plugins/processing/algs/saga/help/fitnpointstoshape.rst
  75. +35 −0 python/plugins/processing/algs/saga/help/flatdetection.rst
  76. +37 −0 python/plugins/processing/algs/saga/help/flowpathlength.rst
  77. +37 −0 python/plugins/processing/algs/saga/help/flowwidthandspecificcatchmentarea.rst
  78. +27 −0 python/plugins/processing/algs/saga/help/fractaldimensionofgridsurface.rst
  79. +46 −0 python/plugins/processing/algs/saga/help/fragmentationalternative.rst
  80. +32 −0 python/plugins/processing/algs/saga/help/fragmentationclassesfromdensityandconnectivity.rst
  81. +50 −0 python/plugins/processing/algs/saga/help/fragmentationstandard.rst
  82. +31 −0 python/plugins/processing/algs/saga/help/function.rst
  83. +40 −0 python/plugins/processing/algs/saga/help/fuzzify.rst
  84. +35 −0 python/plugins/processing/algs/saga/help/fuzzyintersectionand.rst
  85. +35 −0 python/plugins/processing/algs/saga/help/fuzzyunionor.rst
  86. +36 −0 python/plugins/processing/algs/saga/help/gaussianfilter.rst
  87. +37 −0 python/plugins/processing/algs/saga/help/gaussianlandscapes.rst
  88. +67 −0 python/plugins/processing/algs/saga/help/geographicallyweightedmultipleregression.rst
  89. +62 −0 python/plugins/processing/algs/saga/help/geographicallyweightedmultipleregressionpoints.rst
  90. +63 −0 python/plugins/processing/algs/saga/help/geographicallyweightedmultipleregressionpointsgrids.rst
  91. +68 −0 python/plugins/processing/algs/saga/help/geographicallyweightedregression.rst
  92. +63 −0 python/plugins/processing/algs/saga/help/geographicallyweightedregressionpointsgrid.rst
  93. +42 −0 python/plugins/processing/algs/saga/help/geometricfigures.rst
  94. +31 −0 python/plugins/processing/algs/saga/help/getshapesextents.rst
  95. +34 −0 python/plugins/processing/algs/saga/help/globalmoransiforgrids.rst
  96. +48 −0 python/plugins/processing/algs/saga/help/gradientvectorfromcartesiantopolarcoordinates.rst
  97. +48 −0 python/plugins/processing/algs/saga/help/gradientvectorfrompolartocartesiancoordinates.rst
  98. +44 −0 python/plugins/processing/algs/saga/help/gradientvectorsfromdirectionalcomponents.rst
  99. +44 −0 python/plugins/processing/algs/saga/help/gradientvectorsfromdirectionandlength.rst
  100. +43 −0 python/plugins/processing/algs/saga/help/gradientvectorsfromsurface.rst
  101. +35 −0 python/plugins/processing/algs/saga/help/gridbuffer.rst
  102. +61 −0 python/plugins/processing/algs/saga/help/gridcalculator.rst
  103. +28 −0 python/plugins/processing/algs/saga/help/griddifference.rst
  104. +29 −0 python/plugins/processing/algs/saga/help/griddivision.rst
  105. +28 −0 python/plugins/processing/algs/saga/help/gridmasking.rst
  106. +29 −0 python/plugins/processing/algs/saga/help/gridnormalisation.rst
  107. +36 −0 python/plugins/processing/algs/saga/help/gridorientation.rst
  108. +31 −0 python/plugins/processing/algs/saga/help/gridproximitybuffer.rst
  109. +47 −0 python/plugins/processing/algs/saga/help/gridshrinkexpand.rst
  110. +43 −0 python/plugins/processing/algs/saga/help/gridskeletonization.rst
  111. +27 −0 python/plugins/processing/algs/saga/help/gridsproduct.rst
  112. +27 −0 python/plugins/processing/algs/saga/help/gridssum.rst
  113. +28 −0 python/plugins/processing/algs/saga/help/gridstandardisation.rst
  114. +37 −0 python/plugins/processing/algs/saga/help/gridstatisticsforpolygons.rst
  115. +36 −0 python/plugins/processing/algs/saga/help/gridvaluestopoints.rst
  116. +28 −0 python/plugins/processing/algs/saga/help/gridvaluestopointsrandomly.rst
  117. +36 −0 python/plugins/processing/algs/saga/help/gridvolume.rst
  118. +35 −0 python/plugins/processing/algs/saga/help/histogramsurface.rst
  119. +43 −0 python/plugins/processing/algs/saga/help/hypsometry.rst
  120. +62 −0 python/plugins/processing/algs/saga/help/inversedistanceweighted.rst
  121. +27 −0 python/plugins/processing/algs/saga/help/invertdatanodata.rst
  122. +42 −0 python/plugins/processing/algs/saga/help/kerneldensityestimation.rst
  123. +30 −0 python/plugins/processing/algs/saga/help/lakeflood.rst
  124. +33 −0 python/plugins/processing/algs/saga/help/landsurfacetemperature.rst
  125. +43 −0 python/plugins/processing/algs/saga/help/laplacianfilter.rst
  126. +34 −0 python/plugins/processing/algs/saga/help/layerofextremevalue.rst
  127. +30 −0 python/plugins/processing/algs/saga/help/leastcostpaths.rst
  128. +37 −0 python/plugins/processing/algs/saga/help/linedissolve.rst
  129. +35 −0 python/plugins/processing/algs/saga/help/linepolygonintersection.rst
  130. +32 −0 python/plugins/processing/algs/saga/help/lineproperties.rst
  131. +30 −0 python/plugins/processing/algs/saga/help/linesimplification.rst
  132. +28 −0 python/plugins/processing/algs/saga/help/localminimaandmaxima.rst
  133. +48 −0 python/plugins/processing/algs/saga/help/lsfactor.rst
  134. +36 −0 python/plugins/processing/algs/saga/help/majorityfilter.rst
  135. +31 −0 python/plugins/processing/algs/saga/help/massbalanceindex.rst
  136. +33 −0 python/plugins/processing/algs/saga/help/mergeshapeslayers.rst
  137. +54 −0 python/plugins/processing/algs/saga/help/merging.rst
  138. +42 −0 python/plugins/processing/algs/saga/help/metricconversions.rst
  139. +34 −0 python/plugins/processing/algs/saga/help/minimumdistanceanalysis.rst
  140. +41 −0 python/plugins/processing/algs/saga/help/modifedquadraticshepard.rst
  141. +42 −0 python/plugins/processing/algs/saga/help/morphologicalfilter.rst
  142. +28 −0 python/plugins/processing/algs/saga/help/morphometricprotectionindex.rst
  143. +42 −0 python/plugins/processing/algs/saga/help/multibandvariation.rst
  144. +40 −0 python/plugins/processing/algs/saga/help/multidirectionleefilter.rst
  145. +43 −0 python/plugins/processing/algs/saga/help/multilevelbsplineinterpolation.rst
  146. +47 −0 python/plugins/processing/algs/saga/help/multilevelbsplineinterpolationfromgrid.rst
  147. +53 −0 python/plugins/processing/algs/saga/help/multipleregressionanalysisgridgrids.rst
  148. +54 −0 python/plugins/processing/algs/saga/help/multipleregressionanalysispointsgrids.rst
  149. +36 −0 python/plugins/processing/algs/saga/help/multiresolutionindexofvalleybottomflatnessmrvbf.rst
  150. +37 −0 python/plugins/processing/algs/saga/help/naturalneighbour.rst
  151. +36 −0 python/plugins/processing/algs/saga/help/nearestneighbour.rst
  152. +28 −0 python/plugins/processing/algs/saga/help/orderedweightedaveragingowa.rst
  153. +61 −0 python/plugins/processing/algs/saga/help/ordinarykriging.rst
  154. +58 −0 python/plugins/processing/algs/saga/help/ordinarykrigingglobal.rst
  155. +37 −0 python/plugins/processing/algs/saga/help/overlandflowdistancetochannelnetwork.rst
  156. +43 −0 python/plugins/processing/algs/saga/help/overlandflowkinematicwaved8.rst
  157. +38 −0 python/plugins/processing/algs/saga/help/patching.rst
  158. +41 −0 python/plugins/processing/algs/saga/help/patternanalysis.rst
  159. +45 −0 python/plugins/processing/algs/saga/help/pointsfilter.rst
  160. +35 −0 python/plugins/processing/algs/saga/help/pointstatisticsforpolygons.rst
  161. +29 −0 python/plugins/processing/algs/saga/help/pointsthinning.rst
  162. +31 −0 python/plugins/processing/algs/saga/help/polartocartesiancoordinates.rst
  163. +30 −0 python/plugins/processing/algs/saga/help/polygoncentroids.rst
  164. +39 −0 python/plugins/processing/algs/saga/help/polygondissolve.rst
  165. +40 −0 python/plugins/processing/algs/saga/help/polygonintersection.rst
  166. +28 −0 python/plugins/processing/algs/saga/help/polygonlineintersection.rst
  167. +28 −0 python/plugins/processing/algs/saga/help/polygonpartstoseparatepolygons.rst
  168. +31 −0 python/plugins/processing/algs/saga/help/polygonproperties.rst
  169. +42 −0 python/plugins/processing/algs/saga/help/polygonshapeindices.rst
  170. +33 −0 python/plugins/processing/algs/saga/help/polygonstoedgesandnodes.rst
  171. +48 −0 python/plugins/processing/algs/saga/help/polynomialregression.rst
  172. +40 −0 python/plugins/processing/algs/saga/help/polynomialtrendfromgrids.rst
  173. +36 −0 python/plugins/processing/algs/saga/help/principlecomponentsanalysis.rst
  174. +30 −0 python/plugins/processing/algs/saga/help/profilefrompoints.rst
  175. +32 −0 python/plugins/processing/algs/saga/help/profilesfromlines.rst
  176. +29 −0 python/plugins/processing/algs/saga/help/proximitygrid.rst
  177. +30 −0 python/plugins/processing/algs/saga/help/quadtreestructuretoshapes.rst
  178. +36 −0 python/plugins/processing/algs/saga/help/radiusofvariancegrid.rst
  179. +45 −0 python/plugins/processing/algs/saga/help/randomfield.rst
  180. +37 −0 python/plugins/processing/algs/saga/help/randomterraingeneration.rst
  181. +36 −0 python/plugins/processing/algs/saga/help/rankfilter.rst
  182. +27 −0 python/plugins/processing/algs/saga/help/realareacalculation.rst
  183. +65 −0 python/plugins/processing/algs/saga/help/reclassifygridvalues.rst
  184. +49 −0 python/plugins/processing/algs/saga/help/regressionanalysispointsgrid.rst
  185. +34 −0 python/plugins/processing/algs/saga/help/relativeheightsandslopepositions.rst
  186. +44 −0 python/plugins/processing/algs/saga/help/removeduplicatepoints.rst
  187. +29 −0 python/plugins/processing/algs/saga/help/representativenessgrid.rst
  188. +57 −0 python/plugins/processing/algs/saga/help/resampling.rst
  189. +47 −0 python/plugins/processing/algs/saga/help/residualanalysisgrid.rst
  190. +46 −0 python/plugins/processing/algs/saga/help/rgbcomposite.rst
  191. +29 −0 python/plugins/processing/algs/saga/help/runningaverage.rst
  192. +31 −0 python/plugins/processing/algs/saga/help/sagawetnessindex.rst
  193. +50 −0 python/plugins/processing/algs/saga/help/seedgeneration.rst
  194. +29 −0 python/plugins/processing/algs/saga/help/separatepointsbydirection.rst
  195. +41 −0 python/plugins/processing/algs/saga/help/shapesbuffer.rst
  196. +57 −0 python/plugins/processing/algs/saga/help/shapestogrid.rst
  197. +41 −0 python/plugins/processing/algs/saga/help/simplefilter.rst
  198. +47 −0 python/plugins/processing/algs/saga/help/simpleregiongrowing.rst
  199. +39 −0 python/plugins/processing/algs/saga/help/simulation.rst
  200. +29 −0 python/plugins/processing/algs/saga/help/sinkdrainageroutedetection.rst
  201. +37 −0 python/plugins/processing/algs/saga/help/sinkremoval.rst
  202. +40 −0 python/plugins/processing/algs/saga/help/skyviewfactor.rst
  203. +43 −0 python/plugins/processing/algs/saga/help/slopeaspectcurvature.rst
  204. +27 −0 python/plugins/processing/algs/saga/help/slopelength.rst
  205. +30 −0 python/plugins/processing/algs/saga/help/soiltextureclassification.rst
  206. +28 −0 python/plugins/processing/algs/saga/help/sortgrid.rst
  207. +30 −0 python/plugins/processing/algs/saga/help/spatialpointpatternanalysis.rst
  208. +29 −0 python/plugins/processing/algs/saga/help/splitrgbbands.rst
  209. +30 −0 python/plugins/processing/algs/saga/help/splitshapeslayerrandomly.rst
  210. +33 −0 python/plugins/processing/algs/saga/help/statisticsforgrids.rst
  211. +27 −0 python/plugins/processing/algs/saga/help/strahlerorder.rst
  212. +35 −0 python/plugins/processing/algs/saga/help/streampowerindex.rst
  213. +51 −0 python/plugins/processing/algs/saga/help/supervisedclassification.rst
  214. +38 −0 python/plugins/processing/algs/saga/help/surfacespecificpoints.rst
  215. +40 −0 python/plugins/processing/algs/saga/help/terrainruggednessindextri.rst
  216. +27 −0 python/plugins/processing/algs/saga/help/thiessenpolygons.rst
  217. +37 −0 python/plugins/processing/algs/saga/help/thinplatesplineglobal.rst
  218. +49 −0 python/plugins/processing/algs/saga/help/thinplatesplinelocal.rst
  219. +44 −0 python/plugins/processing/algs/saga/help/thinplatesplinetin.rst
  220. +37 −0 python/plugins/processing/algs/saga/help/thresholdbuffer.rst
  221. +49 −0 python/plugins/processing/algs/saga/help/topographiccorrection.rst
  222. +42 −0 python/plugins/processing/algs/saga/help/topographicpositionindextpi.rst
  223. +41 −0 python/plugins/processing/algs/saga/help/topographicwetnessindextwi.rst
  224. +43 −0 python/plugins/processing/algs/saga/help/tpibasedlandformclassification.rst
  225. +43 −0 python/plugins/processing/algs/saga/help/transectthroughpolygonshapefile.rst
  226. +34 −0 python/plugins/processing/algs/saga/help/transformshapes.rst
  227. +36 −0 python/plugins/processing/algs/saga/help/triangulation.rst
  228. +70 −0 python/plugins/processing/algs/saga/help/universalkriging.rst
  229. +67 −0 python/plugins/processing/algs/saga/help/universalkrigingglobal.rst
  230. +29 −0 python/plugins/processing/algs/saga/help/userdefinedfilter.rst
  231. +30 −0 python/plugins/processing/algs/saga/help/variogramcloud.rst
  232. +32 −0 python/plugins/processing/algs/saga/help/variogramsurface.rst
  233. +40 −0 python/plugins/processing/algs/saga/help/vectorisinggridclasses.rst
  234. +40 −0 python/plugins/processing/algs/saga/help/vectorruggednessmeasurevrm.rst
  235. +33 −0 python/plugins/processing/algs/saga/help/vegetationindexdistancebased.rst
  236. +33 −0 python/plugins/processing/algs/saga/help/vegetationindexslopebased.rst
  237. +31 −0 python/plugins/processing/algs/saga/help/verticaldistancetochannelnetwork.rst
  238. +29 −0 python/plugins/processing/algs/saga/help/waterretentioncapacity.rst
  239. +30 −0 python/plugins/processing/algs/saga/help/watershedbasins.rst
  240. +50 −0 python/plugins/processing/algs/saga/help/watershedsegmentation.rst
  241. +44 −0 python/plugins/processing/algs/saga/help/windeffectwindwardleewardindex.rst
  242. +31 −0 python/plugins/processing/algs/saga/help/zonalgridstatistics.rst
  243. +6 −5 python/plugins/processing/core/GeoAlgorithm.py
  244. +10 −6 python/plugins/processing/gui/AlgorithmExecutionDialog.py
  245. +46 −35 python/plugins/processing/gui/Help2Html.py
  246. BIN python/plugins/processing/images/saga100x100.jpg
  247. +3 −4 python/plugins/processing/modeler/ModelerAlgorithm.py
  248. +12 −8 python/plugins/processing/modeler/ModelerParametersDialog.py
  249. +3 −4 python/plugins/processing/script/ScriptAlgorithm.py
@@ -91,14 +91,13 @@ def getCopy(self):
def getIcon(self):
return QIcon(os.path.dirname(__file__) + '/../../images/grass.png')

def helpFile(self):
return 'http://grass.osgeo.org/grass64/manuals/' + self.grassName \
+ '.html'
def help(self):
return False, 'http://grass.osgeo.org/grass64/manuals/' + self.grassName + '.html'

def getParameterDescriptions(self):
descs = {}
try:
helpfile = self.helpFile()
_, helpfile = self.help()
except WrongHelpFileException:
return descs
if helpfile:
@@ -74,11 +74,11 @@ def getCopy(self):
def getIcon(self):
return PyQt4.QtGui.QIcon(os.path.dirname(__file__) + "/../../images/otb.png")

def helpFile(self):
def help(self):
folder = os.path.join( OTBUtils.otbDescriptionPath(), 'doc' )
helpfile = os.path.join( str(folder), self.appkey + ".html")
if os.path.exists(helpfile):
return helpfile
return False, helpfile
else:
raise WrongHelpFileException("Could not find help file for this algorithm. \nIf you have it put it in: \n"+str(folder))

@@ -34,7 +34,7 @@
from processing.core.GeoAlgorithmExecutionException import \
GeoAlgorithmExecutionException
from processing.core.ProcessingLog import ProcessingLog
from processing.gui.Help2Html import Help2Html
from processing.gui.Help2Html import getHtmlFromHelpFile
from processing.parameters.ParameterRaster import ParameterRaster
from processing.parameters.ParameterTable import ParameterTable
from processing.parameters.ParameterVector import ParameterVector
@@ -401,11 +401,10 @@ def getImportCommands(self):
def getRCommands(self):
return self.commands

def helpFile(self):
def help(self):
helpfile = unicode(self.descriptionFile) + '.help'
if os.path.exists(helpfile):
h2h = Help2Html()
return h2h.getHtmlFile(self, helpfile)
return True, getHtmlFromHelpFile(self, helpfile)
else:
return None

@@ -16,6 +16,7 @@
* *
***************************************************************************
"""
from processing.gui.Help2Html import getHtmlFromRstFile

__author__ = 'Victor Olaya'
__date__ = 'August 2012'
@@ -501,9 +502,15 @@ def checkParameterValuesBeforeExecuting(self):
+ ' has more than one band.\n' \
+ 'Multiband layers are not supported by SAGA'

def helpFile(self):
return os.path.join(os.path.dirname(__file__), 'help',
self.name.replace(' ', '') + '.html')
def help(self):
name = self.cmdname.lower()
validChars = 'abcdefghijklmnopqrstuvwxyz'
name = ''.join(c for c in name if c in validChars)
html = getHtmlFromRstFile(os.path.join(os.path.dirname(__file__), 'help',
name + '.rst'))
imgpath = os.path.join(os.path.dirname(__file__),os.pardir, os.pardir, 'images', 'saga100x100.jpg')
html = ('<img src="%s"/>' % imgpath) + html
return True, html

def getPostProcessingErrorMessage(self, wrongLayers):
html = GeoAlgorithm.getPostProcessingErrorMessage(self, wrongLayers)
@@ -0,0 +1,31 @@
ACCUMULATED COST (ANISOTROPIC)
==============================

Description
-----------

Parameters
----------

- ``Cost Grid[Raster]``:
- ``Direction of max cost[Raster]``:
- ``Destination Points[Raster]``:
- ``k factor[Number]``:
- ``Threshold for different route[Number]``:

Outputs
-------

- ``Accumulated Cost[Raster]``:

See also
---------


Console usage
-------------


::

sextante.runalg('saga:accumulatedcostanisotropic', cost, direction, points, k, threshold, acccost)
@@ -0,0 +1,30 @@
ACCUMULATED COST (ISOTROPIC)
============================

Description
-----------

Parameters
----------

- ``Cost Grid[Raster]``:
- ``Destination Points[Raster]``:
- ``Threshold for different route[Number]``:

Outputs
-------

- ``Accumulated Cost[Raster]``:
- ``Closest Point[Raster]``:

See also
---------


Console usage
-------------


::

sextante.runalg('saga:accumulatedcostisotropic', cost, points, threshold, acccost, closestpt)
@@ -0,0 +1,28 @@
ADD COORDINATES TO POINTS
=========================

Description
-----------
This algorithm adds the X and Y coordinates in the attribute table.

Parameters
----------

- ``Points[Vector]``: input points layer

Outputs
-------

- ``Output[Vector]``: resulting layer with the updated attribute table.

See also
---------


Console usage
-------------


::

sextante.runalg('saga:addcoordinatestopoints', input, output)
@@ -0,0 +1,44 @@
ADD GRID VALUES TO POINTS
=========================

Description
-----------
This algorithm creates a new vector layer as a result of the union of a points layer with the interpolated value of one or more base background grid layer/s. This way, the new layer created will have a new column in the attribute table that reflects the interpolated value of the background grid.
There are several interpolation methods available:
- nearest neighbor
- bilinear interpolation
- inverse distance interpolation
- bicubic spline interpolation
- b-spline interpolation
Parameters
----------

- ``Points[Vector]``: points layer in input
- ``Grids[MultipleInput]``: background grid layer (it possible to choose multiple grids)
- ``Interpolation[Selection]``: interpolation method

Outputs
-------

- ``Result[Vector]``: the resulting vector

See also
---------


Console usage
-------------


::

sextante.runalg('saga:addgridvaluestopoints', shapes, grids, interpol, result)

Available options for selection parameters:

interpol(Interpolation)
0 - [0] Nearest Neighbor
1 - [1] Bilinear Interpolation
2 - [2] Inverse Distance Interpolation
3 - [3] Bicubic Spline Interpolation
4 - [4] B-Spline Interpolation
@@ -0,0 +1,38 @@
ADD GRID VALUES TO SHAPES
=========================

Description
-----------

Parameters
----------

- ``Shapes[Vector]``:
- ``Grids[MultipleInput]``:
- ``Interpolation[Selection]``:

Outputs
-------

- ``Result[Vector]``:

See also
---------


Console usage
-------------


::

sextante.runalg('saga:addgridvaluestoshapes', shapes, grids, interpol, result)

Available options for selection parameters:

interpol(Interpolation)
0 - [0] Nearest Neighbor
1 - [1] Bilinear Interpolation
2 - [2] Inverse Distance Interpolation
3 - [3] Bicubic Spline Interpolation
4 - [4] B-Spline Interpolation
@@ -0,0 +1,31 @@
ADD POLYGON ATTRIBUTES TO POINTS
================================

Description
-----------
This algorithm adds the specified field of the polygons layer to the attribute table of the points layer in input.
The new attributes added for each point depend on the value of the background polygon layer.

Parameters
----------

- ``Points[Vector]``: points layer
- ``Polygons[Vector]``: polygons layer
- ``Attribute[TableField]``: attribute of the polygons layer that will be added to the table attribute

Outputs
-------

- ``Result[Vector]``: resulting points layer with the new field

See also
---------


Console usage
-------------


::

sextante.runalg('saga:addpolygonattributestopoints', input, polygons, field, output)
@@ -0,0 +1,35 @@
AGGREGATE
=========

Description
-----------

Parameters
----------

- ``Grid[Raster]``:
- ``Aggregation Size[Number]``:
- ``Method[Selection]``:

Outputs
-------


See also
---------


Console usage
-------------


::

sextante.runalg('saga:aggregate', input, size, method)

Available options for selection parameters:

method(Method)
0 - [0] Sum
1 - [1] Min
2 - [2] Max
@@ -0,0 +1,37 @@
AGGREGATE POINT OBSERVATIONS
============================

Description
-----------

Parameters
----------

- ``Reference Points[Vector]``:
- ``ID[TableField]``:
- ``Observations[Table]``:
- ``X[TableField]``:
- ``Y[TableField]``:
- ``Track[TableField]``:
- ``Date[TableField]``:
- ``Time[TableField]``:
- ``Parameter[TableField]``:
- ``Maximum Time Span (Seconds)[Number]``:
- ``Maximum Distance[Number]``:

Outputs
-------

- ``Aggregated[Table]``:

See also
---------


Console usage
-------------


::

sextante.runalg('saga:aggregatepointobservations', reference, reference_id, observations, x, y, track, date, time, parameter, eps_time, eps_space, aggregated)
@@ -0,0 +1,28 @@
AGGREGATION INDEX
=================

Description
-----------

Parameters
----------

- ``Input Grid[Raster]``:
- ``Max. Number of Classes[Number]``:

Outputs
-------

- ``Result[Table]``:

See also
---------


Console usage
-------------


::

sextante.runalg('saga:aggregationindex', input, maxnumclass, result)

0 comments on commit bce5b89

Please sign in to comment.
You can’t perform that action at this time.