gpolygon-methods           package:flowViz           R Documentation

_D_r_a_w_i_n_g _f_i_l_t_e_r _r_e_g_i_o_n_s

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

     These methods extend the basic graphics 'polygon' methods for
     drawing of 'filter' regions. They allow for multiple dispatch,
     since not all 'filter' types need to be evaluated for plotting,
     but this decision should be made internally.

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

     When plotting code{flowFrame}s using the 'plot' method provided by
     'flowViz', the plotted parameters are recorded, which makes it
     possible to correctly overlay the outlines of 'filter's assuming
     that they are defined for the repective parameters. Warnings and
     error will be cast for the cases where the parameters are
     non-distinct or ambigious.

     The flow parameters plotted can be passed on to any of the methods
     through the optional 'channels' argument, which always gets
     precedence over automatically detected parameters.

     The methods support all plotting parameters that are available for
     the code{base} 'polygon' functions.

_M_e_t_h_o_d_s:



     _x = "_f_i_l_t_e_r", _d_a_t_a = "_m_i_s_s_i_n_g" General method for all objects
          inheriting from 'filter'. This is used as the default when no
          more explicit method is found. It tries to find the plotted
          parameters from the internal 'flowViz.state' environment.
          This only works if the flow data has been plotted using the
          'plot' methods provided by this 'flowViz' package. 

     _x = "_f_i_l_t_e_r_R_e_s_u_l_t", _d_a_t_a = "_A_N_Y" General method for all
          'filterResult' object. This basically extracts the 'filter'
          from the 'filterResult' and dispatches on that. 

     _x = "_f_i_l_t_e_r_R_e_s_u_l_t", _d_a_t_a = "_f_l_o_w_F_r_a_m_e" For some 'filter' types we
          need the raw data to re-evaluate the filter. 

     _x = "_c_u_r_v_1_F_i_l_t_e_r", _d_a_t_a = "_A_N_Y" We either need a 'filterResult' or
          the raw data as a 'flowFrame' for 'curv1Filter's. 

     _x = "_c_u_r_v_1_F_i_l_t_e_r", _d_a_t_a = "_f_l_o_w_F_r_a_m_e" see above 

     _x = "_c_u_r_v_1_F_i_l_t_e_r", _d_a_t_a = "_m_i_s_s_i_n_g" see above 

     _x = "_c_u_r_v_1_F_i_l_t_e_r", _d_a_t_a = "_m_u_l_t_i_p_l_e_F_i_l_t_e_r_R_e_s_u_l_t" see above 

     _x = "_c_u_r_v_2_F_i_l_t_e_r", _d_a_t_a = "_A_N_Y" We either need a 'filterResult' or
          the raw data as a 'flowFrame' for 'curv2Filter's.

     _x = "_c_u_r_v_2_F_i_l_t_e_r", _d_a_t_a = "_f_l_o_w_F_r_a_m_e" see above 

     _x = "_c_u_r_v_2_F_i_l_t_e_r", _d_a_t_a = "_m_u_l_t_i_p_l_e_F_i_l_t_e_r_R_e_s_u_l_t" see above 

     _x = "_k_m_e_a_n_s_F_i_l_t_e_r", _d_a_t_a = "_A_N_Y" We don't know how to plot regions
          of a 'kmeansFilter', hence we warn. 

     _x = "_n_o_r_m_2_F_i_l_t_e_r", _d_a_t_a = "_A_N_Y" We either need a 'filterResult' or
          the raw data as a 'flowFrame' for 'norm2Filter's.

     _x = "_n_o_r_m_2_F_i_l_t_e_r", _d_a_t_a = "_f_l_o_w_F_r_a_m_e" see above 

     _x = "_n_o_r_m_2_F_i_l_t_e_r", _d_a_t_a = "_l_o_g_i_c_a_l_F_i_l_t_e_r_R_e_s_u_l_t" see above 

     _x = "_p_o_l_y_g_o_n_G_a_t_e", _d_a_t_a = "_c_h_a_r_a_c_t_e_r" We can plot a 'polygonGate'
          directly from the gate definition. 

     _x = "_p_o_l_y_g_o_n_G_a_t_e", _d_a_t_a = "_f_i_l_t_e_r_R_e_s_u_l_t" see above 

     _x = "_p_o_l_y_g_o_n_G_a_t_e", _d_a_t_a = "_f_l_o_w_F_r_a_m_e" see above 

     _x = "_q_u_a_d_G_a_t_e", _d_a_t_a = "_c_h_a_r_a_c_t_e_r" We can plot a 'quadGate'
          directly from the gate definition. 

     _x = "_q_u_a_d_G_a_t_e", _d_a_t_a = "_f_i_l_t_e_r_R_e_s_u_l_t" see above 

     _x = "_q_u_a_d_G_a_t_e", _d_a_t_a = "_f_l_o_w_F_r_a_m_e" see above 

     _x = "_r_e_c_t_a_n_g_l_e_G_a_t_e", _d_a_t_a = "_c_h_a_r_a_c_t_e_r" We can plot a
          'rectangleGate' directly from the gate definition. 

     _x = "_r_e_c_t_a_n_g_l_e_G_a_t_e", _d_a_t_a = "_f_i_l_t_e_r_R_e_s_u_l_t" see above 

     _x = "_r_e_c_t_a_n_g_l_e_G_a_t_e", _d_a_t_a = "_f_l_o_w_F_r_a_m_e" see above 

     _x = "_e_l_l_i_p_s_o_i_d_G_a_t_e", _d_a_t_a = "_c_h_a_r_a_c_t_e_r" We can plot a
          'ellipsoidGate' directly from the gate definition. 

     _x = "_e_l_l_i_p_s_o_i_d_G_a_t_e", _d_a_t_a = "_f_i_l_t_e_r_R_e_s_u_l_t" see above 

     _x = "_e_l_l_i_p_s_o_i_d_G_a_t_e", _d_a_t_a = "_f_l_o_w_F_r_a_m_e" see above 


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

     F. Hahne

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

     'filter', 'flowFrame', 'glines', 'gpoints'

