tesseract 4.1.1
Loading...
Searching...
No Matches
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

TESS_API const char *const kMicroFeatureType
 
TESS_API const char *const kCNFeatureType
 
TESS_API const char *const kIntFeatureType
 
TESS_API const char *const kGeoFeatureType
 
const FEATURE_DESC_STRUCT MicroFeatureDesc
 
TESS_API const 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 27 of file featdefs.h.

Typedef Documentation

◆ CHAR_DESC

Definition at line 43 of file featdefs.h.

◆ FEATURE_DEFS

Definition at line 49 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
CharDesccharacter description to be deallocated

Globals:

  • none

Definition at line 129 of file featdefs.cpp.

129 {
130 if (CharDesc) {
131 for (size_t i = 0; i < CharDesc->NumFeatureSets; i++)
132 FreeFeatureSet (CharDesc->FeatureSets[i]);
133 Efree(CharDesc);
134 }
135} /* FreeCharDescription */
void FreeFeatureSet(FEATURE_SET FeatureSet)
Definition: ocrfeatures.cpp:62
void Efree(void *ptr)
Definition: emalloc.cpp:45
uint32_t NumFeatureSets
Definition: featdefs.h:40
FEATURE_SET FeatureSets[NUM_FEATURE_TYPES]
Definition: featdefs.h:41

◆ InitFeatureDefs()

void InitFeatureDefs ( FEATURE_DEFS_STRUCT featuredefs)

Definition at line 112 of file featdefs.cpp.

112 {
113 featuredefs->NumFeatureTypes = NUM_FEATURE_TYPES;
114 for (int i = 0; i < NUM_FEATURE_TYPES; ++i) {
115 featuredefs->FeatureDesc[i] = DescDefs[i];
116 }
117}
#define NUM_FEATURE_TYPES
Definition: featdefs.h:27
int32_t NumFeatureTypes
Definition: featdefs.h:46
const FEATURE_DESC_STRUCT * FeatureDesc[NUM_FEATURE_TYPES]
Definition: featdefs.h:47

◆ 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 148 of file featdefs.cpp.

148 {
149 CHAR_DESC CharDesc;
150 CharDesc = static_cast<CHAR_DESC>(Emalloc (sizeof (CHAR_DESC_STRUCT)));
151 CharDesc->NumFeatureSets = FeatureDefs.NumFeatureTypes;
152
153 for (size_t i = 0; i < CharDesc->NumFeatureSets; i++)
154 CharDesc->FeatureSets[i] = nullptr;
155
156 return (CharDesc);
157} /* NewCharDescription */
void * Emalloc(int Size)
Definition: emalloc.cpp:31

◆ 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
FeatureDefsdefinitions of feature types/extractors
Fileopen text file to read character description from
Returns
Character description read from File.

Definition at line 236 of file featdefs.cpp.

237 {
238 int NumSetsToRead;
239 char ShortName[FEAT_NAME_SIZE];
240 CHAR_DESC CharDesc;
241 int Type;
242
243 ASSERT_HOST(tfscanf(File, "%d", &NumSetsToRead) == 1);
244 ASSERT_HOST(NumSetsToRead >= 0);
245 ASSERT_HOST(NumSetsToRead <= FeatureDefs.NumFeatureTypes);
246
247 CharDesc = NewCharDescription(FeatureDefs);
248 for (; NumSetsToRead > 0; NumSetsToRead--) {
249 tfscanf(File, "%s", ShortName);
250 Type = ShortNameToFeatureType(FeatureDefs, ShortName);
251 CharDesc->FeatureSets[Type] =
252 ReadFeatureSet (File, FeatureDefs.FeatureDesc[Type]);
253 }
254 return CharDesc;
255}
#define ASSERT_HOST(x)
Definition: errcode.h:88
int tfscanf(FILE *stream, const char *format,...)
Definition: scanutils.cpp:181
CHAR_DESC NewCharDescription(const FEATURE_DEFS_STRUCT &FeatureDefs)
Definition: featdefs.cpp:148
uint32_t ShortNameToFeatureType(const FEATURE_DEFS_STRUCT &FeatureDefs, const char *ShortName)
Definition: featdefs.cpp:270
FEATURE_SET ReadFeatureSet(FILE *File, const FEATURE_DESC_STRUCT *FeatureDesc)
#define FEAT_NAME_SIZE
Definition: ocrfeatures.h:33

◆ 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
FeatureDefsdefinitions of feature types/extractors
ShortNameshort name of a feature type
Returns
Feature type which corresponds to ShortName.

Definition at line 270 of file featdefs.cpp.

271 {
272 for (int i = 0; i < FeatureDefs.NumFeatureTypes; i++)
273 if (!strcmp ((FeatureDefs.FeatureDesc[i]->ShortName), ShortName))
274 return static_cast<uint32_t>(i);
275 ASSERT_HOST(!"Illegal short name for a feature");
276 return 0;
277}
const char * ShortName
Definition: ocrfeatures.h:54

◆ ValidCharDescription()

bool ValidCharDescription ( const FEATURE_DEFS_STRUCT FeatureDefs,
CHAR_DESC  CharDesc 
)

Definition at line 195 of file featdefs.cpp.

196 {
197 bool anything_written = false;
198 bool well_formed = true;
199 for (size_t Type = 0; Type < CharDesc->NumFeatureSets; Type++) {
200 if (CharDesc->FeatureSets[Type]) {
201 for (int i = 0; i < CharDesc->FeatureSets[Type]->NumFeatures; i++) {
202 FEATURE feat = CharDesc->FeatureSets[Type]->Features[i];
203 for (int p = 0; p < feat->Type->NumParams; p++) {
204 if (std::isnan(feat->Params[p]) || std::isinf(feat->Params[p]))
205 well_formed = false;
206 else
207 anything_written = true;
208 }
209 }
210 } else {
211 return false;
212 }
213 }
214 return anything_written && well_formed;
215} /* ValidCharDescription */
const FEATURE_DESC_STRUCT * Type
Definition: ocrfeatures.h:60
float Params[1]
Definition: ocrfeatures.h:61
FEATURE Features[1]
Definition: ocrfeatures.h:68
uint16_t NumFeatures
Definition: ocrfeatures.h:66

◆ 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
FeatureDefsdefinitions of feature types/extractors
strstring to append CharDesc to
CharDesccharacter description to write to File

Definition at line 174 of file featdefs.cpp.

175 {
176 int NumSetsToWrite = 0;
177
178 for (size_t Type = 0; Type < CharDesc->NumFeatureSets; Type++)
179 if (CharDesc->FeatureSets[Type])
180 NumSetsToWrite++;
181
182 str->add_str_int(" ", NumSetsToWrite);
183 *str += "\n";
184 for (size_t Type = 0; Type < CharDesc->NumFeatureSets; Type++) {
185 if (CharDesc->FeatureSets[Type]) {
186 *str += FeatureDefs.FeatureDesc[Type]->ShortName;
187 *str += " ";
188 WriteFeatureSet(CharDesc->FeatureSets[Type], str);
189 }
190 }
191} /* WriteCharDescription */
void WriteFeatureSet(FEATURE_SET FeatureSet, STRING *str)
void add_str_int(const char *str, int number)
Definition: strngs.cpp:377

Variable Documentation

◆ CharNormDesc

const FEATURE_DESC_STRUCT CharNormDesc
extern

◆ GeoFeatDesc

const FEATURE_DESC_STRUCT GeoFeatDesc
extern

◆ IntFeatDesc

const FEATURE_DESC_STRUCT IntFeatDesc
extern

◆ kCNFeatureType

TESS_API const char* const kCNFeatureType
extern

Definition at line 33 of file featdefs.cpp.

◆ kGeoFeatureType

TESS_API const char* const kGeoFeatureType
extern

Definition at line 35 of file featdefs.cpp.

◆ kIntFeatureType

TESS_API const char* const kIntFeatureType
extern

Definition at line 34 of file featdefs.cpp.

◆ kMicroFeatureType

TESS_API const char* const kMicroFeatureType
extern

Definition at line 32 of file featdefs.cpp.

◆ MicroFeatureDesc

const FEATURE_DESC_STRUCT MicroFeatureDesc
extern

Global Data Definitions and Declarations

◆ OutlineFeatDesc

const FEATURE_DESC_STRUCT OutlineFeatDesc
extern

◆ PicoFeatDesc

TESS_API const FEATURE_DESC_STRUCT PicoFeatDesc
extern