tesseract::ParamUtils Class Reference

#include <params.h>

Static Public Member Functions
static bool	ReadParamsFile (const char *file, SetParamConstraint constraint, ParamsVectors *member_params)
static bool	ReadParamsFromFp (SetParamConstraint constraint, TFile *fp, ParamsVectors *member_params)
static bool	SetParam (const char *name, const char *value, SetParamConstraint constraint, ParamsVectors *member_params)
template<class T >
static T *	FindParam (const char *name, const std::vector< T * > &global_vec, const std::vector< T * > &member_vec)
template<class T >
static void	RemoveParam (T *param_ptr, std::vector< T * > *vec)
static bool	GetParamAsString (const char *name, const ParamsVectors *member_params, std::string *value)
static void	PrintParams (FILE *fp, const ParamsVectors *member_params)
static void	ResetToDefaults (ParamsVectors *member_params)

Detailed Description

Definition at line 54 of file params.h.

Member Function Documentation

FindParam()

template<class T >

static T * tesseract::ParamUtils::FindParam ( const char *  name, const std::vector< T * > &  global_vec, const std::vector< T * > &  member_vec  )

inlinestatic

Definition at line 76 of file params.h.

                                                        {
    for (auto *param : global_vec) {
      if (strcmp(param->name_str(), name) == 0) {
        return param;
      }
    }
    for (auto *param : member_vec) {
      if (strcmp(param->name_str(), name) == 0) {
        return param;
      }
    }
    return nullptr;
  }

GetParamAsString()

bool tesseract::ParamUtils::GetParamAsString ( const char *  name, const ParamsVectors *  member_params, std::string *  value  )

static

Definition at line 130 of file params.cpp.

                                                    {
  // Look for the parameter among string parameters.
  auto *sp =
      FindParam<StringParam>(name, GlobalParams()->string_params, member_params->string_params);
  if (sp) {
    *value = sp->c_str();
    return true;
  }
  // Look for the parameter among int parameters.
  auto *ip = FindParam<IntParam>(name, GlobalParams()->int_params, member_params->int_params);
  if (ip) {
    *value = std::to_string(int32_t(*ip));
    return true;
  }
  // Look for the parameter among bool parameters.
  auto *bp = FindParam<BoolParam>(name, GlobalParams()->bool_params, member_params->bool_params);
  if (bp != nullptr) {
    *value = bool(*bp) ? "1" : "0";
    return true;
  }
  // Look for the parameter among double parameters.
  auto *dp =
      FindParam<DoubleParam>(name, GlobalParams()->double_params, member_params->double_params);
  if (dp != nullptr) {
    std::ostringstream stream;
    stream.imbue(std::locale::classic());
    stream << double(*dp);
    *value = stream.str();
    return true;
  }
  return false;
}

PrintParams()

void tesseract::ParamUtils::PrintParams ( FILE *  fp, const ParamsVectors *  member_params  )

static

Definition at line 164 of file params.cpp.

                                                                         {
  int num_iterations = (member_params == nullptr) ? 1 : 2;
  std::ostringstream stream;
  stream.imbue(std::locale::classic());
  for (int v = 0; v < num_iterations; ++v) {
    const ParamsVectors *vec = (v == 0) ? GlobalParams() : member_params;
    for (auto int_param : vec->int_params) {
      stream << int_param->name_str() << '\t' << (int32_t)(*int_param) << '\t'
             << int_param->info_str() << '\n';
    }
    for (auto bool_param : vec->bool_params) {
      stream << bool_param->name_str() << '\t' << bool(*bool_param) << '\t'
             << bool_param->info_str() << '\n';
    }
    for (auto string_param : vec->string_params) {
      stream << string_param->name_str() << '\t' << string_param->c_str() << '\t'
             << string_param->info_str() << '\n';
    }
    for (auto double_param : vec->double_params) {
      stream << double_param->name_str() << '\t' << (double)(*double_param) << '\t'
             << double_param->info_str() << '\n';
    }
  }
  fprintf(fp, "%s", stream.str().c_str());
}

ReadParamsFile()

bool tesseract::ParamUtils::ReadParamsFile ( const char *  file, SetParamConstraint  constraint, ParamsVectors *  member_params  )

static

Definition at line 41 of file params.cpp.

                                                              {
  TFile fp;
  if (!fp.Open(file, nullptr)) {
    tprintf("read_params_file: Can't open %s\n", file);
    return true;
  }
  return ReadParamsFromFp(constraint, &fp, member_params);
}

ReadParamsFromFp()

bool tesseract::ParamUtils::ReadParamsFromFp ( SetParamConstraint  constraint, TFile *  fp, ParamsVectors *  member_params  )

static

Definition at line 51 of file params.cpp.

                                                                {
  char line[MAX_PATH]; // input line
  bool anyerr = false; // true if any error
  bool foundit;        // found parameter
  char *valptr;        // value field
 
  while (fp->FGets(line, MAX_PATH) != nullptr) {
    if (line[0] != '\r' && line[0] != '\n' && line[0] != '#') {
      chomp_string(line); // remove newline
      for (valptr = line; *valptr && *valptr != ' ' && *valptr != '\t'; valptr++) {
        ;
      }
      if (*valptr) {    // found blank
        *valptr = '\0'; // make name a string
        do {
          valptr++; // find end of blanks
        } while (*valptr == ' ' || *valptr == '\t');
      }
      foundit = SetParam(line, valptr, constraint, member_params);
 
      if (!foundit) {
        anyerr = true; // had an error
        tprintf("Warning: Parameter not found: %s\n", line);
      }
    }
  }
  return anyerr;
}

RemoveParam()

template<class T >

static void tesseract::ParamUtils::RemoveParam ( T *  param_ptr, std::vector< T * > *  vec  )

inlinestatic

Definition at line 92 of file params.h.

                                                             {
    for (auto it = vec->begin(); it != vec->end(); ++it) {
      if (*it == param_ptr) {
        vec->erase(it);
        break;
      }
    }
  }

ResetToDefaults()

void tesseract::ParamUtils::ResetToDefaults ( ParamsVectors *  member_params )

static

Definition at line 191 of file params.cpp.

                                                             {
  int num_iterations = (member_params == nullptr) ? 1 : 2;
  for (int v = 0; v < num_iterations; ++v) {
    ParamsVectors *vec = (v == 0) ? GlobalParams() : member_params;
    for (auto &param : vec->int_params) {
      param->ResetToDefault();
    }
    for (auto &param : vec->bool_params) {
      param->ResetToDefault();
    }
    for (auto &param : vec->string_params) {
      param->ResetToDefault();
    }
    for (auto &param : vec->double_params) {
      param->ResetToDefault();
    }
  }
}

SetParam()

bool tesseract::ParamUtils::SetParam ( const char *  name, const char *  value, SetParamConstraint  constraint, ParamsVectors *  member_params  )

static

Definition at line 81 of file params.cpp.

                                                        {
  // Look for the parameter among string parameters.
  auto *sp =
      FindParam<StringParam>(name, GlobalParams()->string_params, member_params->string_params);
  if (sp != nullptr && sp->constraint_ok(constraint)) {
    sp->set_value(value);
  }
  if (*value == '\0') {
    return (sp != nullptr);
  }
 
  // Look for the parameter among int parameters.
  auto *ip = FindParam<IntParam>(name, GlobalParams()->int_params, member_params->int_params);
  if (ip && ip->constraint_ok(constraint)) {
    int intval = INT_MIN;
    std::stringstream stream(value);
    stream.imbue(std::locale::classic());
    stream >> intval;
    if (intval != INT_MIN) {
      ip->set_value(intval);
    }
  }
 
  // Look for the parameter among bool parameters.
  auto *bp = FindParam<BoolParam>(name, GlobalParams()->bool_params, member_params->bool_params);
  if (bp != nullptr && bp->constraint_ok(constraint)) {
    if (*value == 'T' || *value == 't' || *value == 'Y' || *value == 'y' || *value == '1') {
      bp->set_value(true);
    } else if (*value == 'F' || *value == 'f' || *value == 'N' || *value == 'n' || *value == '0') {
      bp->set_value(false);
    }
  }
 
  // Look for the parameter among double parameters.
  auto *dp =
      FindParam<DoubleParam>(name, GlobalParams()->double_params, member_params->double_params);
  if (dp != nullptr && dp->constraint_ok(constraint)) {
    double doubleval = NAN;
    std::stringstream stream(value);
    stream.imbue(std::locale::classic());
    stream >> doubleval;
    if (!std::isnan(doubleval)) {
      dp->set_value(doubleval);
    }
  }
  return (sp || ip || bp || dp);
}

---

The documentation for this class was generated from the following files:

• /media/home/debian/src/github/tesseract-ocr/tesseract/src/ccutil/params.h
• /media/home/debian/src/github/tesseract-ocr/tesseract/src/ccutil/params.cpp