frameDist              package:EBImage              R Documentation

_C_a_l_c_u_l_a_t_e _p_a_i_r_w_i_s_e _d_i_s_t_a_n_c_e_s _b_e_t_w_e_e_n _i_m_a_g_e _f_r_a_m_e_s _o_r _f_r_a_m_e_s _o_f _t_w_o _i_m_a_g_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     Given two images with multiple frames, 'frameDist' calculates a
     matrix of distances between frames (the more similar are the
     images, the smaller are the distances). Prerequisite: images
     should be centered and rotationally and scale aligned. The
     function is recommended with 'stackObjects' with arguments
     'rotate=combine=TRUE'.

_U_s_a_g_e:

       ## S4 method for signature 'Image, Image':
       frameDist(x, y, r, g, b, blur=TRUE, 
           method="dist", verbose, ...)
       ## S4 method for signature 'Image, missing':
       frameDist(x, y, r, g, b, blur=TRUE, 
           method="dist", verbose, ...)

_A_r_g_u_m_e_n_t_s:

     x,y: A image stacks. 

   r,b,g: If 'x' and 'y' are in TrueColor mode, these values specify
          weights of red, green and blue channels in the resulting
          distance. 

    blur: A logical indicating whether frames ought to be blurred
          before comparison ('TRUE' recommended). 

  method: Method to use: 'dist' - Euclidian distance, 'dot' - dot
          product. 

 verbose: Provides additional output as the function can be lengthy. 

     ...: Reserved. 

_D_e_t_a_i_l_s:

     For Grayscale images, the distance of each pair of frames, 'xf'
     and  'yf', is calculated as 'mean(abs(xf-yf))', where 'mean' is 
     taken over the pixels with at least 'xf' or 'yf' being non-zero. 
     For TrueColor images, the distance is calculated as 
     'mean(sqrt(r*rc^2+g*gc^2+b*bc^2))', where 'rc,gc,bc' are '[0,1]'
     ranged values of red, green and blue channels and 'r,g,b' are the
     weights. Again, the mean is taken only over non-zero pixels.

_V_a_l_u_e:

     A matrix of distances. If 'y' is missing - a square symmetric
     matrix for the distances between frames in the same image with
     diagonal elements set at 'Inf'.

_A_u_t_h_o_r(_s):

     Oleg Sklyar, osklyar@ebi.ac.uk, 2007

_S_e_e _A_l_s_o:

     ' stackObjects '

