tesseract::Input Class Reference

#include <input.h>

Inheritance diagram for tesseract::Input:

Public Member Functions
	Input (const STRING &name, int ni, int no)
	Input (const STRING &name, const StaticShape &shape)
virtual	~Input ()
virtual STRING	spec () const
virtual StaticShape	InputShape () const
virtual StaticShape	OutputShape (const StaticShape &input_shape) const
virtual bool	Serialize (TFile *fp) const
virtual bool	DeSerialize (TFile *fp)
virtual int	XScaleFactor () const
virtual void	CacheXScaleFactor (int factor)
virtual void	Forward (bool debug, const NetworkIO &input, const TransposedArray *input_transpose, NetworkScratch *scratch, NetworkIO *output)
virtual bool	Backward (bool debug, const NetworkIO &fwd_deltas, NetworkScratch *scratch, NetworkIO *back_deltas)
Public Member Functions inherited from tesseract::Network
	Network ()
	Network (NetworkType type, const STRING &name, int ni, int no)
virtual	~Network ()
NetworkType	type () const
bool	IsTraining () const
bool	needs_to_backprop () const
int	num_weights () const
int	NumInputs () const
int	NumOutputs () const
const STRING &	name () const
bool	TestFlag (NetworkFlags flag) const
virtual bool	IsPlumbingType () const
virtual void	SetEnableTraining (TrainingState state)
virtual void	SetNetworkFlags (uinT32 flags)
virtual int	InitWeights (float range, TRand *randomizer)
virtual int	RemapOutputs (int old_no, const std::vector< int > &code_map)
virtual void	ConvertToInt ()
virtual void	SetRandomizer (TRand *randomizer)
virtual bool	SetupNeedsBackprop (bool needs_backprop)
virtual void	DebugWeights ()
virtual void	Update (float learning_rate, float momentum, float adam_beta, int num_samples)
virtual void	CountAlternators (const Network &other, double *same, double *changed) const
void	DisplayForward (const NetworkIO &matrix)
void	DisplayBackward (const NetworkIO &matrix)

Static Public Member Functions
static Pix *	PrepareLSTMInputs (const ImageData &image_data, const Network *network, int min_width, TRand *randomizer, float *image_scale)
static void	PreparePixInput (const StaticShape &shape, const Pix *pix, TRand *randomizer, NetworkIO *input)
Static Public Member Functions inherited from tesseract::Network
static Network *	CreateFromFile (TFile *fp)
static void	ClearWindow (bool tess_coords, const char *window_name, int width, int height, ScrollView **window)
static int	DisplayImage (Pix *pix, ScrollView *window)

Additional Inherited Members
Protected Member Functions inherited from tesseract::Network
double	Random (double range)
Protected Attributes inherited from tesseract::Network
NetworkType	type_
TrainingState	training_
bool	needs_to_backprop_
inT32	network_flags_
inT32	ni_
inT32	no_
inT32	num_weights_
STRING	name_
ScrollView *	forward_win_
ScrollView *	backward_win_
TRand *	randomizer_
Static Protected Attributes inherited from tesseract::Network
static char const *const	kTypeNames [NT_COUNT]

Detailed Description

Definition at line 28 of file input.h.

Constructor & Destructor Documentation

Input() [1/2]

tesseract::Input::Input	(	const STRING &	name,
		int	ni,
		int	no
	)

Definition at line 31 of file input.cpp.

    : Network(NT_INPUT, name, ni, no), cached_x_scale_(1) {}

Input() [2/2]

tesseract::Input::Input	(	const STRING &	name,
		const StaticShape &	shape
	)

Definition at line 33 of file input.cpp.

    : Network(NT_INPUT, name, shape.height(), shape.depth()),
      shape_(shape),
      cached_x_scale_(1) {
  if (shape.height() == 1) ni_ = shape.depth();
}

~Input()

tesseract::Input::~Input ( )

virtual

Definition at line 40 of file input.cpp.

              {
}

Member Function Documentation

Backward()

bool tesseract::Input::Backward ( bool  debug, const NetworkIO &  fwd_deltas, NetworkScratch *  scratch, NetworkIO *  back_deltas  )

virtual

Reimplemented from tesseract::Network.

Definition at line 78 of file input.cpp.

                                             {
  tprintf("Input::Backward should not be called!!\n");
  return false;
}

CacheXScaleFactor()

void tesseract::Input::CacheXScaleFactor ( int  factor )

virtual

Reimplemented from tesseract::Network.

Definition at line 64 of file input.cpp.

                                        {
  cached_x_scale_ = factor;
}

DeSerialize()

bool tesseract::Input::DeSerialize ( TFile *  fp )

virtual

Reimplemented from tesseract::Network.

Definition at line 51 of file input.cpp.

                                 {
  return fp->FReadEndian(&shape_, sizeof(shape_), 1) == 1;
}

Forward()

void tesseract::Input::Forward ( bool  debug, const NetworkIO &  input, const TransposedArray *  input_transpose, NetworkScratch *  scratch, NetworkIO *  output  )

virtual

Reimplemented from tesseract::Network.

Definition at line 70 of file input.cpp.

                                                                {
  *output = input;
}

InputShape()

virtual StaticShape tesseract::Input::InputShape ( ) const

inlinevirtual

Reimplemented from tesseract::Network.

Definition at line 44 of file input.h.

{ return shape_; }

OutputShape()

virtual StaticShape tesseract::Input::OutputShape ( const StaticShape &  input_shape ) const

inlinevirtual

Reimplemented from tesseract::Network.

Definition at line 47 of file input.h.

                                                                        {
    return shape_;
  }

PrepareLSTMInputs()

Pix * tesseract::Input::PrepareLSTMInputs ( const ImageData &  image_data, const Network *  network, int  min_width, TRand *  randomizer, float *  image_scale  )

static

Definition at line 89 of file input.cpp.

                                                                     {
  // Note that NumInputs() is defined as input image height.
  int target_height = network->NumInputs();
  int width, height;
  Pix* pix = image_data.PreScale(target_height, kMaxInputHeight, image_scale,
                                 &width, &height, nullptr);
  if (pix == nullptr) {
    tprintf("Bad pix from ImageData!\n");
    return nullptr;
  }
  if (width <= min_width || height < min_width) {
    tprintf("Image too small to scale!! (%dx%d vs min width of %d)\n", width,
            height, min_width);
    pixDestroy(&pix);
    return nullptr;
  }
  return pix;
}

PreparePixInput()

void tesseract::Input::PreparePixInput ( const StaticShape &  shape, const Pix *  pix, TRand *  randomizer, NetworkIO *  input  )

static

Definition at line 117 of file input.cpp.

                                                                 {
  bool color = shape.depth() == 3;
  Pix* var_pix = const_cast<Pix*>(pix);
  int depth = pixGetDepth(var_pix);
  Pix* normed_pix = nullptr;
  // On input to BaseAPI, an image is forced to be 1, 8 or 24 bit, without
  // colormap, so we just have to deal with depth conversion here.
  if (color) {
    // Force RGB.
    if (depth == 32)
      normed_pix = pixClone(var_pix);
    else
      normed_pix = pixConvertTo32(var_pix);
  } else {
    // Convert non-8-bit images to 8 bit.
    if (depth == 8)
      normed_pix = pixClone(var_pix);
    else
      normed_pix = pixConvertTo8(var_pix, false);
  }
  int height = pixGetHeight(normed_pix);
  int target_height = shape.height();
  if (target_height == 1) target_height = shape.depth();
  if (target_height == 0) target_height = height;
  float im_factor = static_cast<float>(target_height) / height;
  if (im_factor != 1.0f) {
    // Get the scaled image.
    Pix* scaled_pix = pixScale(normed_pix, im_factor, im_factor);
    pixDestroy(&normed_pix);
    normed_pix = scaled_pix;
  }
  input->FromPix(shape, normed_pix, randomizer);
  pixDestroy(&normed_pix);
}

Serialize()

bool tesseract::Input::Serialize ( TFile *  fp ) const

virtual

Reimplemented from tesseract::Network.

Definition at line 44 of file input.cpp.

                                     {
  if (!Network::Serialize(fp)) return false;
  if (fp->FWrite(&shape_, sizeof(shape_), 1) != 1) return false;
  return true;
}

spec()

virtual STRING tesseract::Input::spec ( ) const

inlinevirtual

Reimplemented from tesseract::Network.

Definition at line 34 of file input.h.

                              {
    STRING spec;
    spec.add_str_int("", shape_.batch());
    spec.add_str_int(",", shape_.height());
    spec.add_str_int(",", shape_.width());
    spec.add_str_int(",", shape_.depth());
    return spec;
  }

XScaleFactor()

int tesseract::Input::XScaleFactor ( ) const

virtual

Reimplemented from tesseract::Network.

Definition at line 58 of file input.cpp.

                              {
  return 1;
}

---

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

• /home/stweil/src/github/tesseract-ocr/tesseract/lstm/input.h
• /home/stweil/src/github/tesseract-ocr/tesseract/lstm/input.cpp