doxygen classify/normfeat.cpp

This commit is contained in:
Jim O'Regan 2015-07-20 12:43:47 +01:00
parent 784450fdba
commit 8bca324848

View File

@ -15,50 +15,50 @@
** See the License for the specific language governing permissions and ** See the License for the specific language governing permissions and
** limitations under the License. ** limitations under the License.
******************************************************************************/ ******************************************************************************/
/**---------------------------------------------------------------------------- /*----------------------------------------------------------------------------
Include Files and Type Defines Include Files and Type Defines
----------------------------------------------------------------------------**/ ----------------------------------------------------------------------------*/
#include "normfeat.h" #include "normfeat.h"
#include "intfx.h" #include "intfx.h"
#include "featdefs.h" #include "featdefs.h"
#include "mfoutline.h" #include "mfoutline.h"
/**---------------------------------------------------------------------------- /*----------------------------------------------------------------------------
Public Code Public Code
----------------------------------------------------------------------------**/ ----------------------------------------------------------------------------*/
// Return the length of the outline in baseline normalized form. /** Return the length of the outline in baseline normalized form. */
FLOAT32 ActualOutlineLength(FEATURE Feature) { FLOAT32 ActualOutlineLength(FEATURE Feature) {
return (Feature->Params[CharNormLength] * LENGTH_COMPRESSION); return (Feature->Params[CharNormLength] * LENGTH_COMPRESSION);
} }
/*---------------------------------------------------------------------------*/ /**
// Return the character normalization feature for a blob. * Return the character normalization feature for a blob.
// *
// The features returned are in a scale where the x-height has been * The features returned are in a scale where the x-height has been
// normalized to live in the region y = [-0.25 .. 0.25]. Example ranges * normalized to live in the region y = [-0.25 .. 0.25]. Example ranges
// for English below are based on the Linux font collection on 2009-12-04: * for English below are based on the Linux font collection on 2009-12-04:
// *
// Params[CharNormY] * - Params[CharNormY]
// The y coordinate of the grapheme's centroid. * - The y coordinate of the grapheme's centroid.
// English: [-0.27, 0.71] * - English: [-0.27, 0.71]
// *
// Params[CharNormLength] * - Params[CharNormLength]
// The length of the grapheme's outline (tiny segments discarded), * - The length of the grapheme's outline (tiny segments discarded),
// divided by 10.0=LENGTH_COMPRESSION. * divided by 10.0=LENGTH_COMPRESSION.
// English: [0.16, 0.85] * - English: [0.16, 0.85]
// *
// Params[CharNormRx] * - Params[CharNormRx]
// The radius of gyration about the x axis, as measured from CharNormY. * - The radius of gyration about the x axis, as measured from CharNormY.
// English: [0.011, 0.34] * - English: [0.011, 0.34]
// *
// Params[CharNormRy] * - Params[CharNormRy]
// The radius of gyration about the y axis, as measured from * - The radius of gyration about the y axis, as measured from
// the x center of the grapheme's bounding box. * the x center of the grapheme's bounding box.
// English: [0.011, 0.31] * - English: [0.011, 0.31]
// */
FEATURE_SET ExtractCharNormFeatures(const INT_FX_RESULT_STRUCT& fx_info) { FEATURE_SET ExtractCharNormFeatures(const INT_FX_RESULT_STRUCT& fx_info) {
FEATURE_SET feature_set = NewFeatureSet(1); FEATURE_SET feature_set = NewFeatureSet(1);
FEATURE feature = NewFeature(&CharNormDesc); FEATURE feature = NewFeature(&CharNormDesc);