featdefs.h File Reference

#include "ocrfeatures.h"

Go to the source code of this file.

Classes
struct	CHAR_DESC_STRUCT
struct	FEATURE_DEFS_STRUCT

Macros
#define	NUM_FEATURE_TYPES   4

Typedefs
using	CHAR_DESC = CHAR_DESC_STRUCT *
using	FEATURE_DEFS = FEATURE_DEFS_STRUCT *

Functions
void	InitFeatureDefs (FEATURE_DEFS_STRUCT *featuredefs)
void	FreeCharDescription (CHAR_DESC CharDesc)
CHAR_DESC	NewCharDescription (const FEATURE_DEFS_STRUCT &FeatureDefs)
bool	ValidCharDescription (const FEATURE_DEFS_STRUCT &FeatureDefs, CHAR_DESC CharDesc)
void	WriteCharDescription (const FEATURE_DEFS_STRUCT &FeatureDefs, CHAR_DESC CharDesc, STRING *str)
CHAR_DESC	ReadCharDescription (const FEATURE_DEFS_STRUCT &FeatureDefs, FILE *File)
uint32_t	ShortNameToFeatureType (const FEATURE_DEFS_STRUCT &FeatureDefs, const char *ShortName)

Variables
const TESS_API char *const	kMicroFeatureType
const TESS_API char *const	kCNFeatureType
const TESS_API char *const	kIntFeatureType
const TESS_API char *const	kGeoFeatureType
const FEATURE_DESC_STRUCT	MicroFeatureDesc
const TESS_API FEATURE_DESC_STRUCT	PicoFeatDesc
const FEATURE_DESC_STRUCT	CharNormDesc
const FEATURE_DESC_STRUCT	OutlineFeatDesc
const FEATURE_DESC_STRUCT	IntFeatDesc
const FEATURE_DESC_STRUCT	GeoFeatDesc

Macro Definition Documentation

NUM_FEATURE_TYPES

#define NUM_FEATURE_TYPES   4

---

Include Files and Type Defines

Definition at line 26 of file featdefs.h.

Typedef Documentation

CHAR_DESC

using CHAR_DESC = CHAR_DESC_STRUCT *

Definition at line 42 of file featdefs.h.

FEATURE_DEFS

using FEATURE_DEFS = FEATURE_DEFS_STRUCT *

Definition at line 48 of file featdefs.h.

Function Documentation

FreeCharDescription()

void FreeCharDescription

(

CHAR_DESC

CharDesc

)

Release the memory consumed by the specified character description and all of the features in that description.

Parameters

CharDesc

character description to be deallocated

Globals:

• none

Definition at line 128 of file featdefs.cpp.

                                             {
  if (CharDesc) {
    for (size_t i = 0; i < CharDesc->NumFeatureSets; i++)
      FreeFeatureSet (CharDesc->FeatureSets[i]);
    Efree(CharDesc);
  }

InitFeatureDefs()

void InitFeatureDefs

(

FEATURE_DEFS_STRUCT *

featuredefs

)

Definition at line 111 of file featdefs.cpp.

                                                       {
  featuredefs->NumFeatureTypes = NUM_FEATURE_TYPES;
  for (int i = 0; i < NUM_FEATURE_TYPES; ++i) {
    featuredefs->FeatureDesc[i] = DescDefs[i];
  }

NewCharDescription()

CHAR_DESC NewCharDescription

(

const FEATURE_DEFS_STRUCT &

FeatureDefs

)

Allocate a new character description, initialize its feature sets to be empty, and return it.

Globals:

• none

Returns

New character description structure.

Definition at line 147 of file featdefs.cpp.

                                                                     {
  CHAR_DESC CharDesc;
  CharDesc = static_cast<CHAR_DESC>(Emalloc (sizeof (CHAR_DESC_STRUCT)));
  CharDesc->NumFeatureSets = FeatureDefs.NumFeatureTypes;
 
  for (size_t i = 0; i < CharDesc->NumFeatureSets; i++)
    CharDesc->FeatureSets[i] = nullptr;
 
  return (CharDesc);

ReadCharDescription()

CHAR_DESC ReadCharDescription	(	const FEATURE_DEFS_STRUCT &	FeatureDefs,
		FILE *	File
	)

Read a character description from File, and return a data structure containing this information. The data is formatted as follows:

  NumberOfSets
          ShortNameForSet1 Set1
          ShortNameForSet2 Set2
          ...

Globals:

• none

Parameters

FeatureDefs	definitions of feature types/extractors
File	open text file to read character description from

Returns

Character description read from File.

Definition at line 235 of file featdefs.cpp.

                                          {
  int NumSetsToRead;
  char ShortName[FEAT_NAME_SIZE];
  CHAR_DESC CharDesc;
  int Type;
 
  ASSERT_HOST(tfscanf(File, "%d", &NumSetsToRead) == 1);
  ASSERT_HOST(NumSetsToRead >= 0);
  ASSERT_HOST(NumSetsToRead <= FeatureDefs.NumFeatureTypes);
 
  CharDesc = NewCharDescription(FeatureDefs);
  for (; NumSetsToRead > 0; NumSetsToRead--) {
    tfscanf(File, "%s", ShortName);
    Type = ShortNameToFeatureType(FeatureDefs, ShortName);
    CharDesc->FeatureSets[Type] =
      ReadFeatureSet (File, FeatureDefs.FeatureDesc[Type]);
  }
  return CharDesc;

ShortNameToFeatureType()

uint32_t ShortNameToFeatureType	(	const FEATURE_DEFS_STRUCT &	FeatureDefs,
		const char *	ShortName
	)

Search through all features currently defined and return the feature type for the feature with the specified short name. Trap an error if the specified name is not found.

Globals:

• none

Parameters

FeatureDefs	definitions of feature types/extractors
ShortName	short name of a feature type

Returns

Feature type which corresponds to ShortName.

Definition at line 269 of file featdefs.cpp.

                                                       {
  for (int i = 0; i < FeatureDefs.NumFeatureTypes; i++)
    if (!strcmp ((FeatureDefs.FeatureDesc[i]->ShortName), ShortName))
      return static_cast<uint32_t>(i);
  ASSERT_HOST(!"Illegal short name for a feature");
  return 0;

ValidCharDescription()

bool ValidCharDescription	(	const FEATURE_DEFS_STRUCT &	FeatureDefs,
		CHAR_DESC	CharDesc
	)

Definition at line 194 of file featdefs.cpp.

                                              {
  bool anything_written = false;
  bool well_formed = true;
  for (size_t Type = 0; Type < CharDesc->NumFeatureSets; Type++) {
    if (CharDesc->FeatureSets[Type]) {
      for (int i = 0; i < CharDesc->FeatureSets[Type]->NumFeatures; i++) {
        FEATURE feat = CharDesc->FeatureSets[Type]->Features[i];
        for (int p = 0; p < feat->Type->NumParams; p++) {
          if (std::isnan(feat->Params[p]) || std::isinf(feat->Params[p]))
            well_formed = false;
          else
            anything_written = true;
        }
      }
    } else {
      return false;
    }
  }
  return anything_written && well_formed;

WriteCharDescription()

void WriteCharDescription	(	const FEATURE_DEFS_STRUCT &	FeatureDefs,
		CHAR_DESC	CharDesc,
		STRING *	str
	)

Appends a textual representation of CharDesc to str. The format used is to write out the number of feature sets which will be written followed by a representation of each feature set.

Each set starts with the short name for that feature followed by a description of the feature set. Feature sets which are not present are not written.

Parameters

FeatureDefs	definitions of feature types/extractors
str	string to append CharDesc to
CharDesc	character description to write to File

Definition at line 173 of file featdefs.cpp.

                                                           {
  int NumSetsToWrite = 0;
 
  for (size_t Type = 0; Type < CharDesc->NumFeatureSets; Type++)
    if (CharDesc->FeatureSets[Type])
      NumSetsToWrite++;
 
  str->add_str_int(" ", NumSetsToWrite);
  *str += "\n";
  for (size_t Type = 0; Type < CharDesc->NumFeatureSets; Type++) {
    if (CharDesc->FeatureSets[Type]) {
      *str += FeatureDefs.FeatureDesc[Type]->ShortName;
      *str += " ";
      WriteFeatureSet(CharDesc->FeatureSets[Type], str);
    }
  }

Variable Documentation

CharNormDesc

const FEATURE_DESC_STRUCT CharNormDesc

GeoFeatDesc

const FEATURE_DESC_STRUCT GeoFeatDesc

IntFeatDesc

const FEATURE_DESC_STRUCT IntFeatDesc

kCNFeatureType

const TESS_API char* const kCNFeatureType

Definition at line 32 of file featdefs.cpp.

kGeoFeatureType

const TESS_API char* const kGeoFeatureType

Definition at line 34 of file featdefs.cpp.

kIntFeatureType

const TESS_API char* const kIntFeatureType

Definition at line 33 of file featdefs.cpp.

kMicroFeatureType

const TESS_API char* const kMicroFeatureType

Definition at line 31 of file featdefs.cpp.

MicroFeatureDesc

const FEATURE_DESC_STRUCT MicroFeatureDesc

---

Global Data Definitions and Declarations

OutlineFeatDesc

const FEATURE_DESC_STRUCT OutlineFeatDesc

PicoFeatDesc

const TESS_API FEATURE_DESC_STRUCT PicoFeatDesc