IMAGE Class Reference

#include <img.h>

List of all members.

Public Member Functions

 IMAGE ()
 ~IMAGE ()
IMAGEoperator= (IMAGE &source)
inT8 read_header (const char *name)
inT8 read (inT32 buflines)
inT8 write (const char *name)
inT8 create (inT32 x, inT32 y, inT8 bits_per_pixel)
inT8 capture (uinT8 *pixels, inT32 x, inT32 y, inT8 bits_per_pixel)
void destroy ()
inT32 get_xsize ()
inT32 get_ysize ()
inT8 get_bpp ()
inT8 get_bps ()
BOOL8 white_high ()
uinT8 get_white_level ()
inT32 get_res ()
void set_res (inT32 resolution)
uinT8get_buffer ()
uinT8 pixel (inT32 x, inT32 y)
void fast_get_line (inT32 x, inT32 y, inT32 width, IMAGELINE *linebuf)
void get_line (inT32 x, inT32 y, inT32 width, IMAGELINE *linebuf, inT32 margins)
void get_column (inT32 x, inT32 y, inT32 height, IMAGELINE *linebuf, inT32 margins)
void fast_put_line (inT32 x, inT32 y, inT32 width, IMAGELINE *linebuf)
void put_line (inT32 x, inT32 y, inT32 width, IMAGELINE *linebuf, inT32 margins)
void put_column (inT32 x, inT32 y, inT32 height, IMAGELINE *linebuf, inT32 margins)
void check_legal_access (inT32 x, inT32 y, inT32 xext)
Pix * ToPix ()
void FromPix (const Pix *src_pix)
void convolver (inT32 win_width, inT32 win_height, void(*convolve)(uinT8 **pixels, uinT8 bytespp, inT32 win_wd, inT32 win_ht, uinT8 ret_white_value, uinT8 *result))

Friends

DLLSYM void copy_sub_image (IMAGE *source, inT32 xstart, inT32 ystart, inT32 xext, inT32 yext, IMAGE *dest, inT32 xdest, inT32 ydest, BOOL8 adjust_grey)
DLLSYM void enlarge_sub_image (IMAGE *source, inT32 xstart, inT32 ystart, IMAGE *dest, inT32 xdest, inT32 ydest, inT32 xext, inT32 yext, inT32 scale, BOOL8 adjust_grey)
DLLSYM void fast_reduce_sub_image (IMAGE *source, inT32 xstart, inT32 ystart, inT32 xext, inT32 yext, IMAGE *dest, inT32 xdest, inT32 ydest, inT32 scale, BOOL8 adjust_grey)
DLLSYM void reduce_sub_image (IMAGE *source, inT32 xstart, inT32 ystart, inT32 xext, inT32 yext, IMAGE *dest, inT32 xdest, inT32 ydest, inT32 scale, BOOL8 adjust_grey)

Detailed Description

encapsulated image


Constructor & Destructor Documentation

IMAGE::IMAGE (  ) 
IMAGE::~IMAGE (  )  [inline]

Member Function Documentation

inT8 IMAGE::capture ( uinT8 pixels,
inT32  x,
inT32  y,
inT8  bits_per_pixel 
)

capture raw image

Parameters:
pixels pixels to capture
x x size required
y y size required
bits_per_pixel bpp required
void IMAGE::check_legal_access ( inT32  x,
inT32  y,
inT32  xext 
)

check coordinates

Parameters:
x xcoord to check
y ycoord to check
void IMAGE::convolver ( inT32  win_width,
inT32  win_height,
void(*)(uinT8 **pixels, uinT8 bytespp, inT32 win_wd, inT32 win_ht, uinT8 ret_white_value, uinT8 *result)  convolve 
)

Map function over window

Parameters:
win_width Window width
win_height Window height
convolve Conv function
inT8 IMAGE::create ( inT32  x,
inT32  y,
inT8  bits_per_pixel 
)

create blank image

Parameters:
x x size required
y y size required
bits_per_pixel bpp required
void IMAGE::destroy (  ) 

destroy image

void IMAGE::fast_get_line ( inT32  x,
inT32  y,
inT32  width,
IMAGELINE linebuf 
)

get image line

Parameters:
x coord to start at
y line to get
width line to get
linebuf line to copy to
void IMAGE::fast_put_line ( inT32  x,
inT32  y,
inT32  width,
IMAGELINE linebuf 
)

put image line

Parameters:
x coord to start at
y line to put
width number of pixels to put
linebuf line to copy from
void IMAGE::FromPix ( const Pix *  src_pix  ) 
inT8 IMAGE::get_bpp (  )  [inline]

access function

Returns:
bits per pixel
inT8 IMAGE::get_bps (  )  [inline]

access function

Returns:
bits per sample
uinT8* IMAGE::get_buffer (  )  [inline]
void IMAGE::get_column ( inT32  x,
inT32  y,
inT32  height,
IMAGELINE linebuf,
inT32  margins 
)

get image column

Parameters:
x coord to start at
y line to get
height number of pixels to get
linebuf line to copy to
margins size of margins
void IMAGE::get_line ( inT32  x,
inT32  y,
inT32  width,
IMAGELINE linebuf,
inT32  margins 
)

get image line

Parameters:
x coord to start at
y line to get
width line to get
linebuf line to copy to
margins size of margins
inT32 IMAGE::get_res (  )  [inline]

get resolution

uinT8 IMAGE::get_white_level (  )  [inline]

access function

inT32 IMAGE::get_xsize (  )  [inline]

access function

Returns:
xsize
inT32 IMAGE::get_ysize (  )  [inline]

access function

Returns:
ysize
IMAGE & IMAGE::operator= ( IMAGE source  ) 
uinT8 IMAGE::pixel ( inT32  x,
inT32  y 
)

access pixel

Parameters:
x coord
y coord
void IMAGE::put_column ( inT32  x,
inT32  y,
inT32  height,
IMAGELINE linebuf,
inT32  margins 
)

put image column

Parameters:
x coord to start at
y line to put
height number of pixels to put
linebuf line to copy to
margins size of margins
void IMAGE::put_line ( inT32  x,
inT32  y,
inT32  width,
IMAGELINE linebuf,
inT32  margins 
)

put image line

Parameters:
x coord to start at
y line to put
width number of pixels to put
linebuf line to copy from
margins size of margins
inT8 IMAGE::read ( inT32  buflines  ) 

get rest of image

Parameters:
buflines size of buffer
inT8 IMAGE::read_header ( const char *  name  ) 

get file header

Parameters:
name name of image
void IMAGE::set_res ( inT32  resolution  )  [inline]

set resolution

Pix* IMAGE::ToPix (  ) 

Methods to convert image types. Only available if Leptonica is available.

BOOL8 IMAGE::white_high (  )  [inline]

photo interp

inT8 IMAGE::write ( const char *  name  ) 

write image

Parameters:
name name to write

Friends And Related Function Documentation

DLLSYM void copy_sub_image ( IMAGE source,
inT32  xstart,
inT32  ystart,
inT32  xext,
inT32  yext,
IMAGE dest,
inT32  xdest,
inT32  ydest,
BOOL8  adjust_grey 
) [friend]
DLLSYM void enlarge_sub_image ( IMAGE source,
inT32  xstart,
inT32  ystart,
IMAGE dest,
inT32  xdest,
inT32  ydest,
inT32  xext,
inT32  yext,
inT32  scale,
BOOL8  adjust_grey 
) [friend]
DLLSYM void fast_reduce_sub_image ( IMAGE source,
inT32  xstart,
inT32  ystart,
inT32  xext,
inT32  yext,
IMAGE dest,
inT32  xdest,
inT32  ydest,
inT32  scale,
BOOL8  adjust_grey 
) [friend]
DLLSYM void reduce_sub_image ( IMAGE source,
inT32  xstart,
inT32  ystart,
inT32  xext,
inT32  yext,
IMAGE dest,
inT32  xdest,
inT32  ydest,
inT32  scale,
BOOL8  adjust_grey 
) [friend]

The documentation for this class was generated from the following files:
Generated on Sun Jul 18 17:11:09 2010 for Tesseract by  doxygen 1.6.3