Browse Source

r.fillnulls: update manual (new methods)

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@58280 15284696-431f-4ddb-bdfa-cd5b030d7da7
Martin Landa 11 years ago
parent
commit
60e6337b87
2 changed files with 51 additions and 44 deletions
  1. 43 36
      scripts/r.fillnulls/r.fillnulls.html
  2. 8 8
      scripts/r.fillnulls/r.fillnulls.py

+ 43 - 36
scripts/r.fillnulls/r.fillnulls.html

@@ -1,9 +1,12 @@
 <h2>DESCRIPTION</h2>
 <h2>DESCRIPTION</h2>
 
 
-<em>r.fillnulls</em> fills NULL pixels (no data areas) in input map and
-stores filled map to a new output map. The fill data are interpolated 
-from the no data area boundaries buffer using <em>v.surf.rst</em>  or 
-<em>v.surf.bspline</em> spline interpolation.
+<em>r.fillnulls</em> fills NULL pixels (no data areas) in input raster
+map and stores filled data to a new output raster map. The fill areas
+are interpolated from the no data area boundaries buffer
+using <em><a href="v.surf.rst.html">v.surf.rst</a></em> regularized
+spline interpolation with tension (<b>method=rst</b>) or
+<em><a href="r.resamp.bspline.html">r.resamp.bspline</a></em> cubic or
+linear spline interpolation with Tykhonov regularization.
 
 
 <h2>NOTES</h2>
 <h2>NOTES</h2>
 
 
@@ -26,17 +29,18 @@ may pay attention to below notes.
 If interpolation fails, temporary raster and vector maps are left in place to allow
 If interpolation fails, temporary raster and vector maps are left in place to allow
 unfilled map hole (NULL area) identification and manual repair.
 unfilled map hole (NULL area) identification and manual repair.
 
 
-<h2>NOTES</h2>
-
-When using the default RST method, the algorithm is based on <em>v.surf.rst</em>
-regularized splines with tension interpolation module which interpolates the
-raster cell values for NULL data areas from the boundary values of the NULL
-data area. An eventual raster MASK is respected during the NULL data area(s)
-filling. The interpolated values are patched into the NULL data area(s) of
-the input map and saved into a new raster map.
-
-Otherwise, either the bilinear or bicubic method can be selected (based on
-<em>v.surf.bspline</em>). 
+<p>
+When using the default RST method, the algorithm is based
+on <em><a href="v.surf.rst.html">v.surf.rst</a></em> regularized
+splines with tension interpolation module which interpolates the
+raster cell values for NULL data areas from the boundary values of the
+NULL data area. An eventual raster MASK is respected during the NULL
+data area(s) filling. The interpolated values are patched into the
+NULL data area(s) of the input map and saved into a new raster map.
+
+Otherwise, either the linear or cubic spline interpolation with
+Tykhonov regularization can be selected (based on
+<em><a href="r.resamp.bspline.html">r.resamp.bspline</a></em>). 
 
 
 <h2>WARNING</h2>
 <h2>WARNING</h2>
 
 
@@ -44,11 +48,13 @@ Depending on the shape of the NULL data area(s) problems may occur due to an
 insufficient number of input cell values for the interpolation process. Most
 insufficient number of input cell values for the interpolation process. Most
 problems will occur if a NULL data area reaches a large amount of the map
 problems will occur if a NULL data area reaches a large amount of the map
 boundary. The user will have to carefully check the result using
 boundary. The user will have to carefully check the result using
-<em>r.mapcalc</em> (generating a difference map to the
-input map and applying the "differences" color table with <em>r.colors</em>)
-and/or <em>d.what.rast</em> to query individual cell values.
+<em><a href="r.mapcalc.html">r.mapcalc</a></em> (generating a
+difference map to the input map and applying the
+&quot;differences&quot; color table
+with <em><a href="r.colors.html">r.colors</a></em>) and/or to query
+individual cell values.
 
 
-<h2>WARNING</h2>
+<p>
 RST method stores temporary maps on hard disk. It will require at least as much
 RST method stores temporary maps on hard disk. It will require at least as much
 free space as one extra input raster map takes.
 free space as one extra input raster map takes.
 
 
@@ -72,40 +78,41 @@ d.histogram elev_srtm_30m_complete
 d.rast elev_srtm_30m_complete
 d.rast elev_srtm_30m_complete
 </pre></div>
 </pre></div>
 
 
-
-<h2>SEE ALSO</h2>
-
-<em>
-<a href="r.fill.dir.html">r.fill.dir</a>, 
-<a href="r.mapcalc.html">r.mapcalc</a>,
-<a href="v.surf.bspline.html">v.surf.bspline</a>, 
-<a href="v.surf.rst.html">v.surf.rst</a>
-</em>
-
 <h2>REFERENCES</h2>
 <h2>REFERENCES</h2>
-<p> Mitas, L., Mitasova, H., 1999, Spatial Interpolation. In: P.Longley,
+<ul>
+<li> Mitas, L., Mitasova, H., 1999, Spatial Interpolation. In: P.Longley,
 M.F. Goodchild, D.J. Maguire, D.W.Rhind (Eds.), Geographical Information
 M.F. Goodchild, D.J. Maguire, D.W.Rhind (Eds.), Geographical Information
 Systems: Principles, Techniques, Management and Applications, Wiley,
 Systems: Principles, Techniques, Management and Applications, Wiley,
 pp.481-492
 pp.481-492
 
 
-<p>Mitasova H., Mitas L.,&nbsp; Brown W.M.,&nbsp; D.P. Gerdes, I.
+<li>Mitasova H., Mitas L.,&nbsp; Brown W.M.,&nbsp; D.P. Gerdes, I.
 Kosinovsky, Baker, T.1995, Modeling spatially and temporally distributed
 Kosinovsky, Baker, T.1995, Modeling spatially and temporally distributed
 phenomena: New methods and tools for GRASS GIS. <i>International Journal of
 phenomena: New methods and tools for GRASS GIS. <i>International Journal of
 GIS</i>, 9 (4), special issue on Integrating GIS and Environmental modeling,
 GIS</i>, 9 (4), special issue on Integrating GIS and Environmental modeling,
 433-446.
 433-446.
 
 
-<p><a href="http://skagit.meas.ncsu.edu/~helena/gmslab/papers/lmg.rev1.ps">Mitasova H.
+<li><a href="http://skagit.meas.ncsu.edu/~helena/gmslab/papers/lmg.rev1.ps">Mitasova H.
 and Mitas L. 1993</a>: Interpolation by Regularized Spline with Tension: I.
 and Mitas L. 1993</a>: Interpolation by Regularized Spline with Tension: I.
 Theory and Implementation, <i>Mathematical Geology</i> 25, 641-655.
 Theory and Implementation, <i>Mathematical Geology</i> 25, 641-655.
 
 
-<p><a href="http://skagit.meas.ncsu.edu/~helena/gmslab/papers/hmg.rev1.ps">Mitasova H.
+<li><a href="http://skagit.meas.ncsu.edu/~helena/gmslab/papers/hmg.rev1.ps">Mitasova H.
 and Hofierka L. 1993</a>: Interpolation by Regularized Spline with Tension:
 and Hofierka L. 1993</a>: Interpolation by Regularized Spline with Tension:
 II. Application to Terrain Modeling and Surface Geometry Analysis,
 II. Application to Terrain Modeling and Surface Geometry Analysis,
 <i>Mathematical Geology</i> 25, 657-667.
 <i>Mathematical Geology</i> 25, 657-667.
+</ul>
+
+<h2>SEE ALSO</h2>
+
+<em>
+<a href="r.fill.dir.html">r.fill.dir</a>, 
+<a href="r.mapcalc.html">r.mapcalc</a>,
+<a href="r.resamp.bspline.html">r.resamp.bspline</a>, 
+<a href="v.surf.rst.html">v.surf.rst</a>
+</em>
 
 
 <h2>AUTHORS</h2>
 <h2>AUTHORS</h2>
-r.fillnulls: Markus Neteler, University of Hannover  and Fondazione Edmund Mach
-<p>and authors of v.surf.rst<br>
+Markus Neteler, University of Hannover  and Fondazione Edmund Mach<br>
 Improvement by Hamish Bowman, NZ
 Improvement by Hamish Bowman, NZ
 
 
-<p><i>Last changed: $Date$</i>
+<p>
+<i>Last changed: $Date$</i>

+ 8 - 8
scripts/r.fillnulls/r.fillnulls.py

@@ -34,6 +34,14 @@
 #%option G_OPT_R_OUTPUT
 #%option G_OPT_R_OUTPUT
 #%end
 #%end
 #%option
 #%option
+#% key: method
+#% type: string
+#% description: Interpolation method
+#% required: yes
+#% options: linear,cubic,rst
+#% answer: rst
+#%end
+#%option
 #% key: tension
 #% key: tension
 #% type: double
 #% type: double
 #% description: Spline tension parameter
 #% description: Spline tension parameter
@@ -76,14 +84,6 @@
 #% options : 2-10000
 #% options : 2-10000
 #% guisection: RST options
 #% guisection: RST options
 #%end
 #%end
-#%option
-#% key: method
-#% type: string
-#% description: Interpolation method
-#% required : yes
-#% options : linear,cubic,rst
-#% answer : rst
-#%end
 
 
 import sys
 import sys
 import os
 import os