showHilbertImage         package:HilbertVis         R Documentation

_d_i_s_p_l_a_y _a _h_i_l_b_e_r_t

_D_e_s_c_r_i_p_t_i_o_n:

     A convenient wrapper around 'levelplot' to display a hilbert image
     matrix as it is returned by 'hilbertImage'. Alternatively to
     'levelplot', 'EBImage' is available as well.

_U_s_a_g_e:

     showHilbertImage( mat, 
        palettePos = colorRampPalette(c("white", "red"))(300), 
        paletteNeg = colorRampPalette(c("white", "blue"))(300), 
        maxPaletteValue = max(abs(mat)), 
        mode = c("lattice", "EBImage", "EBImage-batch") )

_A_r_g_u_m_e_n_t_s:

     mat: The matrix to be displayed. In principle this can be any
          matrix,  but typically, it is one returned by 'hilbertImage'. 

palettePos: The colour palette to be used for the positive entries in
          'mat' (including 0). 

paletteNeg: The colour palette to be used for the negative entries in
          'mat'. 

maxPaletteValue: The absolute value to which the right end of the
          palettes should correspond.  (The left ends correspond to 0.) 

    mode: For mode "lattice", the function 'levelplot' from the
          'lattice' package is used. An (invisible) lattice object is
          returned that can be displayed with 'show'. In interactive
          mode, the image is displayed automatically. For mode
          "EBImage" the image is displayed with the 'EBImage' package,
          and for "EBImage-batch", the same image is  produced and not
          displayed but rather returned as a value suitable to be
          passed to EBImage's 'display' function. 

_V_a_l_u_e:

     A lattice or EBImage graphics object. For all modes except
     ``EBImage-batch'' it is marked ``invisible''.

_A_u_t_h_o_r(_s):

     Simon Anders, EMBL-EBI (sanders\@fs.tum.de)

_S_e_e _A_l_s_o:

     'hilbertImage'

_E_x_a_m_p_l_e_s:

       # See ?hilbertImage for examples.

