Function algorithmInfo

src/python/globalfuncs.cpp:377–441

template <typename T>
PyObject* algorithmInfo(T* algo) {
  PyObject* result = PyDict_New();

  vector<string> info(3, "");
  PyObject* sublist = PyList_New(0);

  // add general description & version number
  AlgorithmInfo<T> staticInfo = EssentiaFactory<T>::getInfo(algo->name());

  PyDict_SetItemString(result, "description", PyString_FromString(staticInfo.description.c_str()));

  // add inputs
  typename T::InputMap inputs = algo->inputs();
  for (typename T::InputMap::const_iterator it = inputs.begin();
       it != inputs.end();
       ++it) {
    string name = it->first;
    info[0] = name;
    info[1] = edtToString( typeInfoToEdt( it->second->typeInfo() ) );
    info[2] = algo->inputDescription[name];

    PyList_Append(sublist, VectorString::toPythonCopy(&info));
  }
  PyDict_SetItemString(result, "inputs", sublist);

  // add outputs
  sublist = PyList_New(0);
  typename T::OutputMap outputs = algo->outputs();
  for (typename T::OutputMap::const_iterator it = outputs.begin();
       it != outputs.end();
       ++it) {
    string name = it->first;
    info[0] = name;
    info[1] = edtToString( typeInfoToEdt( it->second->typeInfo() ) );
    info[2] = algo->outputDescription[name];

    PyList_Append(sublist, VectorString::toPythonCopy(&info));
  }
  PyDict_SetItemString(result, "outputs", sublist);

  // add parameters
  sublist = PyList_New(0);
  info.resize(4);
  ParameterMap pm = algo->defaultParameters();

  for (ParameterMap::const_iterator it=pm.begin(); it != pm.end(); ++it) {
    string name = it->first;
    info[0] = name;
    info[1] = algo->parameterDescription[name];
    info[2] = algo->parameterRange[name];
    if (it->second.isConfigured()) {
      info[3] = it->second.toString();
    }
    else {
      info[3] = "";
    }

    PyList_Append(sublist, VectorString::toPythonCopy(&info));