tesseract::TessResultRenderer Class Reference

#include <renderer.h>

Inheritance diagram for tesseract::TessResultRenderer:

Public Member Functions
virtual	~TessResultRenderer ()
void	insert (TessResultRenderer *next)
TessResultRenderer *	next ()
bool	BeginDocument (const char *title)
bool	AddImage (TessBaseAPI *api)
bool	EndDocument ()
const char *	file_extension () const
const char *	title () const
bool	happy ()
int	imagenum () const

Protected Member Functions
	TessResultRenderer (const char *outputbase, const char *extension)
virtual bool	BeginDocumentHandler ()
virtual bool	AddImageHandler (TessBaseAPI *api)=0
virtual bool	EndDocumentHandler ()
void	AppendString (const char *s)
void	AppendData (const char *s, int len)

Detailed Description

Interface for rendering tesseract results into a document, such as text, HOCR or pdf. This class is abstract. Specific classes handle individual formats. This interface is then used to inject the renderer class into tesseract when processing images.

For simplicity implementing this with tesseract version 3.01, the renderer contains document state that is cleared from document to document just as the TessBaseAPI is. This way the base API can just delegate its rendering functionality to injected renderers, and the renderers can manage the associated state needed for the specific formats in addition to the heuristics for producing it.

Definition at line 49 of file renderer.h.

Constructor & Destructor Documentation

~TessResultRenderer()

tesseract::TessResultRenderer::~TessResultRenderer ( )

virtual

Definition at line 48 of file renderer.cpp.

                                        {
  if (fout_ != nullptr) {
    if (fout_ != stdout)
      fclose(fout_);
    else
      clearerr(fout_);
  }
  delete next_;

TessResultRenderer()

tesseract::TessResultRenderer::TessResultRenderer ( const char *  outputbase, const char *  extension  )

protected

Called by concrete classes.

outputbase is the name of the output file excluding extension. For example, "/path/to/chocolate-chip-cookie-recipe"

extension indicates the file extension to be used for output files. For example "pdf" will produce a .pdf file, and "hocr" will produce .hocr files.

Definition at line 32 of file renderer.cpp.

    : file_extension_(extension),
      title_(""), imagenum_(-1),
      fout_(stdout),
      next_(nullptr),
      happy_(true) {
  if (strcmp(outputbase, "-") && strcmp(outputbase, "stdout")) {
    STRING outfile = STRING(outputbase) + STRING(".") + STRING(file_extension_);
    fout_ = fopen(outfile.c_str(), "wb");
    if (fout_ == nullptr) {
      happy_ = false;
    }
  }

Member Function Documentation

AddImage()

bool tesseract::TessResultRenderer::AddImage

(

TessBaseAPI *

api

)

Adds the recognized text from the source image to the current document. Invalid if BeginDocument not yet called.

Note that this API is a bit weird but is designed to fit into the current TessBaseAPI implementation where the api has lots of state information that we might want to add in.

Definition at line 82 of file renderer.cpp.

                                                  {
  if (!happy_) return false;
  ++imagenum_;
  bool ok = AddImageHandler(api);
  if (next_) {
    ok = next_->AddImage(api) && ok;
  }
  return ok;

AddImageHandler()

virtual bool tesseract::TessResultRenderer::AddImageHandler ( TessBaseAPI *  api )

protectedpure virtual

Implemented in tesseract::TessOsdRenderer, tesseract::TessWordStrBoxRenderer, tesseract::TessBoxTextRenderer, tesseract::TessLSTMBoxRenderer, tesseract::TessUnlvRenderer, tesseract::TessPDFRenderer, tesseract::TessTsvRenderer, tesseract::TessAltoRenderer, tesseract::TessHOcrRenderer, and tesseract::TessTextRenderer.

AppendData()

void tesseract::TessResultRenderer::AppendData ( const char *  s, int  len  )

protected

Definition at line 105 of file renderer.cpp.

                                                          {
  if (!tesseract::Serialize(fout_, s, len)) happy_ = false;
  fflush(fout_);

AppendString()

void tesseract::TessResultRenderer::AppendString ( const char *  s )

protected

Definition at line 101 of file renderer.cpp.

                                                   {
  AppendData(s, strlen(s));

BeginDocument()

bool tesseract::TessResultRenderer::BeginDocument

(

const char *

title

)

Starts a new document with the given title. This clears the contents of the output data. Title should use UTF-8 encoding.

Definition at line 71 of file renderer.cpp.

                                                        {
  if (!happy_) return false;
  title_ = title;
  imagenum_ = -1;
  bool ok = BeginDocumentHandler();
  if (next_) {
    ok = next_->BeginDocument(title) && ok;
  }
  return ok;

BeginDocumentHandler()

bool tesseract::TessResultRenderer::BeginDocumentHandler ( )

protectedvirtual

Reimplemented in tesseract::TessPDFRenderer, tesseract::TessTsvRenderer, tesseract::TessAltoRenderer, and tesseract::TessHOcrRenderer.

Definition at line 110 of file renderer.cpp.

                                              {
  return happy_;

EndDocument()

bool tesseract::TessResultRenderer::EndDocument

(

)

Finishes the document and finalizes the output data Invalid if BeginDocument not yet called.

Definition at line 92 of file renderer.cpp.

                                     {
  if (!happy_) return false;
  bool ok = EndDocumentHandler();
  if (next_) {
    ok = next_->EndDocument() && ok;
  }
  return ok;

EndDocumentHandler()

bool tesseract::TessResultRenderer::EndDocumentHandler ( )

protectedvirtual

Reimplemented in tesseract::TessPDFRenderer, tesseract::TessTsvRenderer, tesseract::TessAltoRenderer, and tesseract::TessHOcrRenderer.

Definition at line 114 of file renderer.cpp.

                                            {
  return happy_;

file_extension()

const char* tesseract::TessResultRenderer::file_extension ( ) const

inline

Definition at line 86 of file renderer.h.

                                     {
    return file_extension_;
  }

happy()

bool tesseract::TessResultRenderer::happy ( )

inline

Definition at line 94 of file renderer.h.

               {
    return happy_;
  }

imagenum()

int tesseract::TessResultRenderer::imagenum ( ) const

inline

Returns the index of the last image given to AddImage (i.e. images are incremented whether the image succeeded or not)

This is always defined. It means either the number of the current image, the last image ended, or in the completed document depending on when in the document lifecycle you are looking at it. Will return -1 if a document was never started.

Definition at line 107 of file renderer.h.

                       {
    return imagenum_;
  }

insert()

void tesseract::TessResultRenderer::insert

(

TessResultRenderer *

next

)

Definition at line 58 of file renderer.cpp.

                                                        {
  if (next == nullptr) return;
 
  TessResultRenderer* remainder = next_;
  next_ = next;
  if (remainder) {
    while (next->next_ != nullptr) {
      next = next->next_;
    }
    next->next_ = remainder;
  }

next()

TessResultRenderer* tesseract::TessResultRenderer::next ( )

inline

Definition at line 59 of file renderer.h.

                             {
    return next_;
  }

title()

const char* tesseract::TessResultRenderer::title ( ) const

inline

Definition at line 89 of file renderer.h.

                            {
    return title_.c_str();
  }

---

The documentation for this class was generated from the following files:

• /tesseract/include/tesseract/renderer.h
• /tesseract/src/api/renderer.cpp