#include <input.h>

Inheritance diagram for tesseract::Input:

Public Member Functions
TESS_API	Input (const std::string &name, int ni, int no)

TESS_API	Input (const std::string &name, const StaticShape &shape)

	~Input () override=default

std::string	spec () const override

StaticShape	InputShape () const override

StaticShape	OutputShape ([[maybe_unused]] const StaticShape &input_shape) const override

bool	Serialize (TFile *fp) const override

bool	DeSerialize (TFile *fp) override

int	XScaleFactor () const override

void	CacheXScaleFactor (int factor) override

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

bool	Backward (bool debug, const NetworkIO &fwd_deltas, NetworkScratch scratch, NetworkIO back_deltas) override

Public Member Functions inherited from tesseract::Network
	Network ()

	Network (NetworkType type, const std::string &name, int ni, int no)

virtual	~Network ()=default

NetworkType	type () const

bool	IsTraining () const

bool	needs_to_backprop () const

int	num_weights () const

int	NumInputs () const

int	NumOutputs () const

virtual StaticShape	OutputShape (const StaticShape &input_shape) const

const std::string &	name () const

bool	TestFlag (NetworkFlags flag) const

virtual bool	IsPlumbingType () const

virtual void	SetEnableTraining (TrainingState state)

virtual void	SetNetworkFlags (uint32_t flags)

virtual int	InitWeights (float range, TRand *randomizer)

virtual int	RemapOutputs ([[maybe_unused]] int old_no, [[maybe_unused]] const std::vector< int > &code_map)

virtual void	ConvertToInt ()

virtual void	SetRandomizer (TRand *randomizer)

virtual bool	SetupNeedsBackprop (bool needs_backprop)

virtual void	CacheXScaleFactor ([[maybe_unused]] int factor)

virtual void	Update ([[maybe_unused]] float learning_rate, [[maybe_unused]] float momentum, [[maybe_unused]] float adam_beta, [[maybe_unused]] int num_samples)

virtual void	CountAlternators ([[maybe_unused]] const Network &other, [[maybe_unused]] TFloat same, [[maybe_unused]] TFloat changed) const

void	DisplayForward (const NetworkIO &matrix)

void	DisplayBackward (const NetworkIO &matrix)

Static Public Member Functions
static Image	PrepareLSTMInputs (const ImageData &image_data, const Network network, int min_width, TRand randomizer, float *image_scale)

static void	PreparePixInput (const StaticShape &shape, const Image 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 (Image pix, ScrollView *window)

Additional Inherited Members
Protected Member Functions inherited from tesseract::Network
TFloat	Random (TFloat range)

Protected Attributes inherited from tesseract::Network
NetworkType	type_

TrainingState	training_

bool	needs_to_backprop_

int32_t	network_flags_

int32_t	ni_

int32_t	no_

int32_t	num_weights_

std::string	name_

ScrollView *	forward_win_

ScrollView *	backward_win_

TRand *	randomizer_

Detailed Description

Definition at line 27 of file input.h.

Constructor & Destructor Documentation

◆ Input() [1/2]

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

Definition at line 30 of file input.cpp.

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

tesseract::NT_INPUT

@ NT_INPUT

Definition: network.h:43

tesseract::Network::name

const std::string & name() const

Definition: network.h:140

tesseract::Network::Network

Network()

Definition: network.cpp:80

◆ Input() [2/2]

tesseract::Input::Input	(	const std::string &	name,
		const StaticShape &	shape
	)

Definition at line 32 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 ( )

overridedefault

Member Function Documentation

◆ Backward()

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

overridevirtual

Implements tesseract::Network.

Definition at line 71 of file input.cpp.

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

◆ CacheXScaleFactor()

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

override

Definition at line 58 of file input.cpp.

                                         {
   cached_x_scale_ = factor;
 }

◆ DeSerialize()

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

overridevirtual

Implements tesseract::Network.

Definition at line 45 of file input.cpp.

                                  {
   return shape_.DeSerialize(fp);
 }

◆ Forward()

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

overridevirtual

Implements tesseract::Network.

Definition at line 64 of file input.cpp.

                                                                 {
   *output = input;
 }

◆ InputShape()

StaticShape tesseract::Input::InputShape ( ) const

inlineoverridevirtual

Reimplemented from tesseract::Network.

Definition at line 43 of file input.h.

                                           {
     return shape_;
   }

◆ OutputShape()

StaticShape tesseract::Input::OutputShape ( [[maybe_unused] ] const StaticShape & input_shape ) const

inlineoverride

Definition at line 48 of file input.h.

                                                                       {
     return shape_;
   }

◆ PrepareLSTMInputs()

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

static

Definition at line 81 of file input.cpp.

                                                                      {
   // Note that NumInputs() is defined as input image height.
   int target_height = network->NumInputs();
   int width, height;
   Image 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);
     pix.destroy();
     return nullptr;
   }
   return pix;
 }

◆ PreparePixInput()

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

static

Definition at line 107 of file input.cpp.

                                               {
   bool color = shape.depth() == 3;
   Image var_pix = pix;
   int depth = pixGetDepth(var_pix);
   Image 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 = var_pix.clone();
     } else {
       normed_pix = pixConvertTo32(var_pix);
     }
   } else {
     // Convert non-8-bit images to 8 bit.
     if (depth == 8) {
       normed_pix = var_pix.clone();
     } 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) {
     // Get the scaled image.
     float im_factor = static_cast<float>(target_height) / height;
     Image scaled_pix = pixScale(normed_pix, im_factor, im_factor);
     normed_pix.destroy();
     normed_pix = scaled_pix;
   }
   input->FromPix(shape, normed_pix, randomizer);
   normed_pix.destroy();
 }

◆ Serialize()

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

overridevirtual

Reimplemented from tesseract::Network.

Definition at line 40 of file input.cpp.

                                      {
   return Network::Serialize(fp) && shape_.Serialize(fp);
 }

◆ spec()

std::string tesseract::Input::spec ( ) const

inlineoverridevirtual

Reimplemented from tesseract::Network.

Definition at line 35 of file input.h.

                                   {
     return std::to_string(shape_.batch()) + "," +
            std::to_string(shape_.height()) + "," +
            std::to_string(shape_.width()) + "," +
            std::to_string(shape_.depth());
   }

◆ XScaleFactor()

int tesseract::Input::XScaleFactor ( ) const

overridevirtual

Reimplemented from tesseract::Network.

Definition at line 52 of file input.cpp.

                               {
   return 1;
 }

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

src/lstm/input.h
src/lstm/input.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Input() [1/2]

◆ Input() [2/2]

◆ ~Input()

Member Function Documentation

◆ Backward()

◆ CacheXScaleFactor()

◆ DeSerialize()

◆ Forward()

◆ InputShape()

◆ OutputShape()

◆ PrepareLSTMInputs()

◆ PreparePixInput()

◆ Serialize()

◆ spec()

◆ XScaleFactor()