Image                package:EBImage                R Documentation

_I_m_a_g_e _c_r_e_a_t_i_o_n, _c_o_p_y_i_n_g _a_n_d _a_s_s_e_r_t_i_o_n

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

     Functions to create, copy and assert images.

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


         Image(data=0.5, dim=c(200,200), colormode=Grayscale, ...)
         is.Image(x)
         stopIfNotImage(x)

         # S4 methods for class 'Image':

         copy(x)
         combine(x, y, ...)
         header(x)
         assert(x, y, strict=FALSE)


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


     '_x, _y' Objects of 'Image-class'. 

     '_d_a_t_a' A vector giving data to fill the image. 

     '_d_i_m' Image dimensions, 2D or 3D. In case of 2D, the third
          dimension is set to 1 automatically. 

     '_c_o_l_o_r_m_o_d_e' Image color mode, 'TrueColor' or 'Grayscale'. 

     '_s_t_r_i_c_t' If 'TRUE' the size of all three dimensions of two images
          will be compared, if 'FALSE', the function will compare only
          the first two dimensions (i.e. stacks can have different
          size, but image size should be the same). 

     '...' Further arguments to fill the slot values in constructor or
          further images in combine. 

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

     'Image', 'copy', 'combine' and 'header' will return a new object
     of 'Image-class'.

     'assert' and 'is.Image' will return a 'logical'.

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


     '_I_m_a_g_e' This is a default constructor for images. It is a
          convenience functions being a wrapper around standard 'R'
          function 'new'. 

     '_c_o_p_y' Makes an identical copy of an object of 'Image-class'. It
          is similar to assignment, but it forces 'R' to allocate new
          memory for the object. 

     '_c_o_m_b_i_n_e' Acts similarly to 'rbind' and 'cbind' allowing to add
          images into the stack. Properties of the first image in
          argument 'x' will be transfered to the result. Images must be
          of the same size (in first two dimensions) and in the same
          color mode. 

     '_h_e_a_d_e_r' Acts similarly to copy, but leaves image data empty -
          only copies other properties. This function is useful when
          creating new images from existing large ones changing the
          dimensions. In this case, the result will have all the
          properties of the source and its data can be assigned later
          using 'imageData'. 

     '_a_s_s_e_r_t' Compares image dimensions and other properties. This is a
          method defined for objects of 'Image-class', therefore it
          will generate an error if 'x' is not an Image. Use 'is.Image'
          to test the class of a single object.

     '_i_s._I_m_a_g_e' Returns 'TRUE' if argument is a valid 'Image' and
          'FALSE' otherwise. 

     '_s_t_o_p_I_f_N_o_t_I_m_a_g_e' Prints an error message if argument is not of
          'Image-class'. 

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

     2005-2006 Oleg Sklyar : osklyar@ebi.ac.uk

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

     ' Image-class, read.image '

