density,flowClust-method      package:flowClust      R Documentation

_G_r_i_d _o_f _D_e_n_s_i_t_y _V_a_l_u_e_s _f_o_r _t_h_e _F_i_t_t_e_d _t _M_i_x_t_u_r_e _M_o_d_e_l _w_i_t_h _B_o_x-_C_o_x _T_r_a_n_s_f_o_r_m_a_t_i_o_n

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

     This method constructs the 'flowDens' object which is used to
     generate a contour or image plot.

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

     ## S4 method for signature 'flowClust':
     density(x, data=NULL, subset=c(1,2), include=1:(x@K), 
             npoints=c(100,100), from=NULL, to=NULL)

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

       x: Object returned from 'flowClust' or from running 'filter' on
          a 'flowFrame' object.

    data: A matrix, data frame of observations, or object of class
          'flowFrame'.  This is the object on which 'flowClust' or
          'filter' was performed.  If this argument is not specified,
          the grid square upon which densities will be computed must be
          provided (through arguments 'from' and 'to').

  subset: A numeric vector of length two indicating which two variables
          are selected for the scatterplot.  Alternatively, a character
          vector containing the names of the two variables is allowed
          if 'x@varNames' is not 'NULL'.

 include: A numeric vector specifying which clusters are included to
          compute the density values.  By default, all clusters are
          included.

 npoints: A numeric vector of size two specifying the number of grid
          points in x (horizontal) and y (vertical) directions
          respectively.

    from: A numeric vector of size two specifying the coordinates of
          the lower left point of the grid square.  Note that, if this
          (and 'to') is not specified, 'data' must be provided such
          that the range in the two variables (dimensions) selected
          will be used to define the grid square.

      to: A numeric vector of size two specifying the co-ordinates of
          the upper right point of the grid square.

_D_e_t_a_i_l_s:

     The 'flowDens' object returned is to be passed to the 'plot'
     method for generating a contour or image plot.

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

     An object of class 'flowDens' containing the following slots is
     constructed: 

      dx: A numeric vector of length 'npoints[1]'; the x-coordinates of
          the grid points.

      dy: A numeric vector of length 'npoints[2]'; the y-coordinates of
          the grid points.

   value: A matrix of size 'npoints[1]' x 'npoints[2]'; the density
          values at the grid points.

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

     Raphael Gottardo <raph@stat.ubc.ca>, Kenneth Lo <c.lo@stat.ubc.ca>

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

     'plot', 'flowClust'

