s.mask(1)		      Grass User's Manual		     s.mask(1)



NNAAMMEE
       ss..mmaasskk  - Filter a sites list with a raster mask

       _(_G_R_A_S_S _S_i_t_e_s _P_r_o_g_r_a_m_)

SSYYNNOOPPSSIISS
       ss..mmaasskk
       ss..mmaasskk hheellpp
       ss..mmaasskk [--rr] iinnppuutt==_n_a_m_e oouuttppuutt==_n_a_m_e rraasstteerr==_n_a_m_e

DDEESSCCRRIIPPTTIIOONN
       Use  _s_._m_a_s_k  to filter a sites list with a raster mask.	The raster can
       be any available raster.  Sites are filtered first by the region,  then
       by  whether the site falls in a cell with a non-NULL value.  The region
       used for filtering is the current region by default.  However, the user
       may  specify  that  the	raster	mask's region be used instead.	If the
       raster mask's region is used, both it's extents and resolution are used
       in the filtering process.


       Upon  succesful	completion,  _s_._m_a_s_k will print out the total number of
       sites examined and the number of sites output.

OOPPTTIIOONNSS
   FFllaaggss::
       --rr     Use the raster's extents and cell resolution,  rather  than  the
	      current region settings.


   PPaarraammeetteerrss::
       iinnppuutt==_n_a_m_e
	      The name of the existing sites list to filter.

       oouuttppuutt==_n_a_m_e
	      The name of the sites list to output.

       rraasstteerr==_n_a_m_e
	      The name of the raster to use as the mask.


SSEEEE AALLSSOO
       d.sites parser

AAUUTTHHOORR
       Eric G. Miller


       Inspired by code supplied by Helen Mitasova and Jaro Hofierka.

       _L_a_s_t _c_h_a_n_g_e_d_: _$_D_a_t_e_: _2_0_0_2_/_0_3_/_1_6 _2_2_:_2_7_:_5_7 _$



GRASS 5.0							     s.mask(1)
