glpolygon-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 lattice 'lpolygon' 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 'flowFrame's using the any of  the lattice-type
     '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. These
     methods are meant to be used within lattice panel functions and
     are probably not of much use outside of those.

_V_a_l_u_e:

     The methods will return the outlines of the gate region as polygon
     vertices.

_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 = "_m_i_s_s_i_n_g" 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
          'rectangleGate' 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', 'glpoints'

