featdefs.cpp File Reference

#include "featdefs.h"
#include "emalloc.h"
#include "danerror.h"
#include "scanutils.h"
#include <string.h>
#include <stdio.h>

Go to the source code of this file.

Macros
#define	ILLEGAL_NUM_SETS   3001
#define	PICO_FEATURE_LENGTH   0.05

Functions
	StartParamDesc (MicroFeatureParams) DefineParam(0
	DefineParam (0, 0, -0.25, 0.75) DefineParam(0
	DefineParam (1, 0, 0.0, 1.0) DefineParam(0
	DefineParam (0, 1, -0.5, 0.5) EndParamDesc DefineFeature(MicroFeatureDesc
MicroFeatureParams	StartParamDesc (CharNormParams) DefineParam(0
MicroFeatureParams	DefineParam (0, 1, 0.0, 1.0) DefineParam(0
MicroFeatureParams	DefineParam (0, 0, 0.0, 1.0) EndParamDesc DefineFeature(CharNormDesc
MicroFeatureParams CharNormParams	StartParamDesc (IntFeatParams) DefineParam(0
MicroFeatureParams CharNormParams	DefineParam (0, 0, 0.0, 255.0) DefineParam(1
MicroFeatureParams CharNormParams EndParamDesc	DefineFeature (IntFeatDesc, 2, 1, kIntFeatureType, IntFeatParams) StartParamDesc(GeoFeatParams) DefineParam(0
MicroFeatureParams CharNormParams EndParamDesc EndParamDesc	DefineFeature (GeoFeatDesc, 3, 0, kGeoFeatureType, GeoFeatParams) FLOAT32 PicoFeatureLength
	StartParamDesc (PicoFeatParams) DefineParam(0
EndParamDesc	DefineFeature (PicoFeatDesc, 2, 1, "pf", PicoFeatParams) StartParamDesc(OutlineFeatParams) DefineParam(0
void	InitFeatureDefs (FEATURE_DEFS_STRUCT *featuredefs)
void	FreeCharDescription (CHAR_DESC CharDesc)
CHAR_DESC	NewCharDescription (const FEATURE_DEFS_STRUCT &FeatureDefs)
void	WriteCharDescription (const FEATURE_DEFS_STRUCT &FeatureDefs, CHAR_DESC CharDesc, STRING *str)
bool	ValidCharDescription (const FEATURE_DEFS_STRUCT &FeatureDefs, CHAR_DESC CharDesc)
CHAR_DESC	ReadCharDescription (const FEATURE_DEFS_STRUCT &FeatureDefs, FILE *File)
uint32_t	ShortNameToFeatureType (const FEATURE_DEFS_STRUCT &FeatureDefs, const char *ShortName)

Variables
const char *	kMicroFeatureType = "mf"
const char *	kCNFeatureType = "cn"
const char *	kIntFeatureType = "if"
const char *	kGeoFeatureType = "tb"
EndParamDesc	of

Macro Definition Documentation

ILLEGAL_NUM_SETS

#define ILLEGAL_NUM_SETS   3001

define errors triggered by this module

Definition at line 30 of file featdefs.cpp.

PICO_FEATURE_LENGTH

#define PICO_FEATURE_LENGTH   0.05

Definition at line 32 of file featdefs.cpp.

Function Documentation

DefineFeature() [1/3]

MicroFeatureParams CharNormParams EndParamDesc DefineFeature	(	IntFeatDesc	,
		2	,
		1	,
		kIntFeatureType	,
		IntFeatParams
	)

DefineFeature() [2/3]

MicroFeatureParams CharNormParams EndParamDesc EndParamDesc DefineFeature	(	GeoFeatDesc	,
		3	,
		0	,
		kGeoFeatureType	,
		GeoFeatParams
	)

DefineFeature() [3/3]

EndParamDesc DefineFeature	(	PicoFeatDesc	,
		2	,
		1	,
		"pf"	,
		PicoFeatParams
	)

DefineParam() [1/6]

EndParamDesc DefineParam	(	0	,
		0	,
		-0.	25,
		0.	75
	)

DefineParam() [2/6]

EndParamDesc DefineParam	(	1	,
		0	,
		0.	0,
		1.	0
	)

DefineParam() [3/6]

DefineParam	(	0	,
		1	,
		-0.	5,
		0.	5
	)

DefineParam() [4/6]

MicroFeatureParams DefineParam	(	0	,
		1	,
		0.	0,
		1.	0
	)

DefineParam() [5/6]

MicroFeatureParams DefineParam	(	0	,
		0	,
		0.	0,
		1.	0
	)

DefineParam() [6/6]

MicroFeatureParams CharNormParams EndParamDesc DefineParam	(	0	,
		0	,
		0.	0,
		255.	0
	)

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

Note

Exceptions: none

History: Wed May 23 13:52:19 1990, DSJ, Created.

Definition at line 137 of file featdefs.cpp.

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

InitFeatureDefs()

void InitFeatureDefs

(

FEATURE_DEFS_STRUCT *

featuredefs

)

Definition at line 117 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.

Note

Exceptions: none

History: Wed May 23 15:27:10 1990, DSJ, Created.

Definition at line 158 of file featdefs.cpp.

                                                                     {
  CHAR_DESC CharDesc;
  CharDesc = (CHAR_DESC) Emalloc (sizeof (CHAR_DESC_STRUCT));
  CharDesc->NumFeatureSets = FeatureDefs.NumFeatureTypes;

  for (size_t i = 0; i < CharDesc->NumFeatureSets; i++)
    CharDesc->FeatureSets[i] = NULL;

  return (CharDesc);

}                                /* NewCharDescription */

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.

Note

Exceptions:

• ILLEGAL_NUM_SETS

History: Wed May 23 17:32:48 1990, DSJ, Created.

Definition at line 254 of file featdefs.cpp.

                                          {
  int NumSetsToRead;
  char ShortName[FEAT_NAME_SIZE];
  CHAR_DESC CharDesc;
  int Type;

  if (tfscanf(File, "%d", &NumSetsToRead) != 1 ||
    NumSetsToRead < 0 || NumSetsToRead > FeatureDefs.NumFeatureTypes)
    DoError (ILLEGAL_NUM_SETS, "Illegal number of feature sets");

  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);

}                                // ReadCharDescription

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.

Note

Exceptions:

• ILLEGAL_SHORT_NAME

History: Wed May 23 15:36:05 1990, DSJ, Created.

Definition at line 293 of file featdefs.cpp.

                                                       {
  int i;

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

}                                // ShortNameToFeatureType

StartParamDesc() [1/4]

StartParamDesc

(

MicroFeatureParams

)

StartParamDesc() [2/4]

MicroFeatureParams StartParamDesc

(

CharNormParams

)

StartParamDesc() [3/4]

MicroFeatureParams CharNormParams StartParamDesc

(

IntFeatParams

)

StartParamDesc() [4/4]

StartParamDesc

(

PicoFeatParams

)

ValidCharDescription()

bool ValidCharDescription	(	const FEATURE_DEFS_STRUCT &	FeatureDefs,
		CHAR_DESC	CharDesc
	)

Definition at line 210 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 (isnan(feat->Params[p]) || isinf(feat->Params[p]))
            well_formed = false;
          else
            anything_written = true;
        }
      }
    } else {
      return false;
    }
  }
  return anything_written && well_formed;
}                                /* ValidCharDescription */

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

Note

Exceptions: none

History: Wed May 23 17:21:18 1990, DSJ, Created.

Definition at line 189 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);
    }
  }
}                                /* WriteCharDescription */

Variable Documentation

kCNFeatureType

MicroFeatureParams kCNFeatureType = "cn"

Definition at line 38 of file featdefs.cpp.

kGeoFeatureType

const char* kGeoFeatureType = "tb"

Definition at line 40 of file featdefs.cpp.

kIntFeatureType

const char* kIntFeatureType = "if"

Definition at line 39 of file featdefs.cpp.

kMicroFeatureType

kMicroFeatureType = "mf"

Definition at line 37 of file featdefs.cpp.

of

EndParamDesc of

Definition at line 104 of file featdefs.cpp.