setmask              package:adehabitat              R Documentation

_A_p_p_l_i_e_s _a _M_a_s_k _o_n _O_b_j_e_c_t_s _o_f _C_l_a_s_s '_a_s_c' _o_r '_k_a_s_c'

_D_e_s_c_r_i_p_t_i_o_n:

     Applies a mask on objects of class 'asc' or 'kasc'. In other
     words, the function creates an object of class 'asc' or 'kasc',
     with 'NA' for all pixels 'NA' on the masking map.

_U_s_a_g_e:

     setmask(x, mask)

_A_r_g_u_m_e_n_t_s:

       x: an object of class 'asc' or 'kasc'

    mask: an object of class 'asc'

_V_a_l_u_e:

     Returns an object of class 'asc' or 'kasc'

_A_u_t_h_o_r(_s):

     Clment Calenge calenge@biomserv.univ-lyon1.fr

_S_e_e _A_l_s_o:

     'import.asc' for additionnal information on objects of class
     'asc'.

_E_x_a_m_p_l_e_s:

     data(puechabon)
     kasc <- puechabon$kasc
     image(kasc)
     elev <- getkasc(kasc, "Elevation")
     slope <- getkasc(kasc, "Slope")

     ## ma is the mask: only areas with elevation > 250 m
     ## are kept
     ma <- elev
     ma[ma < 250] <- NA
     ma <- getascattr(elev, ma)
     image(ma)

     ## The mask is applied on maps of slope
     slp <- setmask(slope, ma)
     image(slp)

     ## The mask is applied on all maps in kasc
     im <- setmask(kasc, ma)
     image(im)

