ocrfeatures.h File Reference

#include "blobs.h"
#include <cstdio>

Go to the source code of this file.

Classes
struct	PARAM_DESC
struct	FEATURE_DESC_STRUCT
struct	FEATURE_STRUCT
struct	FEATURE_SET_STRUCT

Macros
#define	FEAT_NAME_SIZE   80
#define	StartParamDesc(Name)   const PARAM_DESC Name[] = {
#define	DefineParam(Circular, NonEssential, Min, Max)
#define	EndParamDesc   };
#define	DefineFeature(Name, NL, NC, SN, PN)   const FEATURE_DESC_STRUCT Name = {((NL) + (NC)), SN, PN};

Typedefs
using	FEATURE_DESC = FEATURE_DESC_STRUCT *
using	FEATURE = FEATURE_STRUCT *
using	FEATURE_SET = FEATURE_SET_STRUCT *
using	CHAR_FEATURES = char *

Functions
bool	AddFeature (FEATURE_SET FeatureSet, FEATURE Feature)
void	FreeFeature (FEATURE Feature)
void	FreeFeatureSet (FEATURE_SET FeatureSet)
FEATURE	NewFeature (const FEATURE_DESC_STRUCT *FeatureDesc)
FEATURE_SET	NewFeatureSet (int NumFeatures)
FEATURE	ReadFeature (FILE *File, const FEATURE_DESC_STRUCT *FeatureDesc)
FEATURE_SET	ReadFeatureSet (FILE *File, const FEATURE_DESC_STRUCT *FeatureDesc)
void	WriteFeature (FEATURE Feature, STRING *str)
void	WriteFeatureSet (FEATURE_SET FeatureSet, STRING *str)

Macro Definition Documentation

DefineFeature

#define DefineFeature	(		Name,
			NL,
			NC,
			SN,
			PN
	)		const FEATURE_DESC_STRUCT Name = {((NL) + (NC)), SN, PN};

Definition at line 100 of file ocrfeatures.h.

DefineParam

#define DefineParam	(		Circular,
			NonEssential,
			Min,
			Max
	)

Value:

{Circular,                                          \
   NonEssential,                                      \
   Min,                                               \
   Max,                                               \
   (Max) - (Min),                                     \
   (((Max) - (Min)) / 2.0),                           \
   (((Max) + (Min)) / 2.0)},

Definition at line 83 of file ocrfeatures.h.

EndParamDesc

#define EndParamDesc   };

Definition at line 92 of file ocrfeatures.h.

FEAT_NAME_SIZE

#define FEAT_NAME_SIZE   80

Definition at line 34 of file ocrfeatures.h.

StartParamDesc

#define StartParamDesc

(

Name

)

const PARAM_DESC Name[] = {

Definition at line 82 of file ocrfeatures.h.

Typedef Documentation

CHAR_FEATURES

using CHAR_FEATURES = char*

Definition at line 77 of file ocrfeatures.h.

FEATURE

using FEATURE = FEATURE_STRUCT*

Definition at line 64 of file ocrfeatures.h.

FEATURE_DESC

using FEATURE_DESC = FEATURE_DESC_STRUCT*

Definition at line 58 of file ocrfeatures.h.

FEATURE_SET

using FEATURE_SET = FEATURE_SET_STRUCT*

Definition at line 71 of file ocrfeatures.h.

Function Documentation

AddFeature()

bool AddFeature	(	FEATURE_SET	FeatureSet,
		FEATURE	Feature
	)

Add a feature to a feature set. If the feature set is already full, FALSE is returned to indicate that the feature could not be added to the set; otherwise, TRUE is returned.

Parameters

FeatureSet	set of features to add Feature to
Feature	feature to be added to FeatureSet

Returns

TRUE if feature added to set, FALSE if set is already full.

Definition at line 41 of file ocrfeatures.cpp.

                                                         {
  if (FeatureSet->NumFeatures >= FeatureSet->MaxNumFeatures) {
    FreeFeature(Feature);
    return false;
  }

  FeatureSet->Features[FeatureSet->NumFeatures++] = Feature;
  return true;
}                                /* AddFeature */

FreeFeature()

void FreeFeature

(

FEATURE

Feature

)

Release the memory consumed by the specified feature.

Parameters

Feature

feature to be deallocated.

Returns

none

Definition at line 56 of file ocrfeatures.cpp.

{ free(Feature); } /* FreeFeature */

FreeFeatureSet()

void FreeFeatureSet

(

FEATURE_SET

FeatureSet

)

Release the memory consumed by the specified feature set. This routine also frees the memory consumed by the features contained in the set.

Parameters

FeatureSet

set of features to be freed

Returns

none

Definition at line 65 of file ocrfeatures.cpp.

                                            {
  int i;

  if (FeatureSet) {
    for (i = 0; i < FeatureSet->NumFeatures; i++)
      FreeFeature(FeatureSet->Features[i]);
    free(FeatureSet);
  }
}                                /* FreeFeatureSet */

NewFeature()

FEATURE NewFeature

(

const FEATURE_DESC_STRUCT *

FeatureDesc

)

Allocate and return a new feature of the specified type.

Parameters

FeatureDesc

description of feature to be created.

Returns

New FEATURE.

Definition at line 81 of file ocrfeatures.cpp.

                                                           {
  FEATURE Feature;

  Feature = (FEATURE)malloc(sizeof(FEATURE_STRUCT) +
                            (FeatureDesc->NumParams - 1) * sizeof(float));
  Feature->Type = FeatureDesc;
  return (Feature);

}                                /* NewFeature */

NewFeatureSet()

FEATURE_SET NewFeatureSet

(

int

NumFeatures

)

Allocate and return a new feature set large enough to hold the specified number of features.

Parameters

NumFeatures

maximum # of features to be put in feature set

Returns

New FEATURE_SET.

Definition at line 97 of file ocrfeatures.cpp.

                                           {
  FEATURE_SET FeatureSet;

  FeatureSet = (FEATURE_SET) Emalloc (sizeof (FEATURE_SET_STRUCT) +
    (NumFeatures - 1) * sizeof (FEATURE));
  FeatureSet->MaxNumFeatures = NumFeatures;
  FeatureSet->NumFeatures = 0;
  return (FeatureSet);

}                                /* NewFeatureSet */

ReadFeature()

FEATURE ReadFeature	(	FILE *	File,
		const FEATURE_DESC_STRUCT *	FeatureDesc
	)

Create a new feature of the specified type and read in the value of its parameters from File. The extra penalty for the feature is also computed by calling the appropriate function for the specified feature type. The correct text representation for a feature is a list of N floats where N is the number of parameters in the feature.

Parameters

File	open text file to read feature from
FeatureDesc	specifies type of feature to read from File

Returns

New FEATURE read from File.

Definition at line 119 of file ocrfeatures.cpp.

                                                                        {
  FEATURE Feature;
  int i;

  Feature = NewFeature (FeatureDesc);
  for (i = 0; i < Feature->Type->NumParams; i++) {
    ASSERT_HOST(tfscanf(File, "%f", &(Feature->Params[i])) == 1);
#ifndef _WIN32
    assert (!std::isnan(Feature->Params[i]));
#endif
  }
  return Feature;
}

ReadFeatureSet()

FEATURE_SET ReadFeatureSet	(	FILE *	File,
		const FEATURE_DESC_STRUCT *	FeatureDesc
	)

Create a new feature set of the specified type and read in the features from File. The correct text representation for a feature set is an integer which specifies the number (N) of features in a set followed by a list of N feature descriptions.

Parameters

File	open text file to read new feature set from
FeatureDesc	specifies type of feature to read from File

Returns

New feature set read from File.

Definition at line 143 of file ocrfeatures.cpp.

                                                                               {
  int NumFeatures;
  ASSERT_HOST(tfscanf(File, "%d", &NumFeatures) == 1);
  ASSERT_HOST(NumFeatures >= 0);

  FEATURE_SET FeatureSet = NewFeatureSet(NumFeatures);
  for (int i = 0; i < NumFeatures; i++)
    AddFeature(FeatureSet, ReadFeature (File, FeatureDesc));

  return FeatureSet;
}

WriteFeature()

void WriteFeature	(	FEATURE	Feature,
		STRING *	str
	)

Appends a textual representation of Feature to str. This representation is simply a list of the N parameters of the feature, terminated with a newline. It is assumed that the ExtraPenalty field can be reconstructed from the parameters of the feature. It is also assumed that the feature type information is specified or assumed elsewhere.

Parameters

Feature	feature to write out to str
str	string to write Feature to

Returns

none

Definition at line 166 of file ocrfeatures.cpp.

                                                {
  for (int i = 0; i < Feature->Type->NumParams; i++) {
#ifndef WIN32
    assert(!std::isnan(Feature->Params[i]));
#endif
    str->add_str_double(" ", Feature->Params[i]);
  }
  *str += "\n";
}                                /* WriteFeature */

WriteFeatureSet()

void WriteFeatureSet	(	FEATURE_SET	FeatureSet,
		STRING *	str
	)

Write a textual representation of FeatureSet to File. This representation is an integer specifying the number of features in the set, followed by a newline, followed by text representations for each feature in the set.

Parameters

FeatureSet	feature set to write to File
str	string to write Feature to

Returns

none

Definition at line 185 of file ocrfeatures.cpp.

                                                          {
  if (FeatureSet) {
    str->add_str_int("", FeatureSet->NumFeatures);
    *str += "\n";
    for (int i = 0; i < FeatureSet->NumFeatures; i++) {
      WriteFeature(FeatureSet->Features[i], str);
    }
  }
}                                /* WriteFeatureSet */