OpenModeller.hh

Go to the documentation of this file.

#ifndef _OM_CONTROLHH_
#define _OM_CONTROLHH_

#include <openmodeller/om_defs.hh>
#include <openmodeller/CallbackWrapper.hh>
#include <openmodeller/Log.hh>
#include <openmodeller/Configuration.hh>
#include <openmodeller/AlgMetadata.hh>
#include <openmodeller/Sampler.hh>
#include <openmodeller/Algorithm.hh>
#include <openmodeller/ConfusionMatrix.hh>
#include <openmodeller/RocCurve.hh>

class AlgParameter;

#include <openmodeller/Occurrences.hh>
#include <openmodeller/Environment.hh>

// Since MapCommand's defn/decl have been moved to om_projector.hh,
// we need to actually include the entire header.
#include <openmodeller/Projector.hh>

#include <openmodeller/Algorithm.hh>

#include <openmodeller/MapFormat.hh>

class MapFormat;
class ConfusionMatrix;
class RocCurve;
class AreaStats;

#include <string>
#include <vector>


/****************************************************************/
/************************* Open Modeller ************************/

class dllexp OpenModeller
{
public:

  OpenModeller();
  ~OpenModeller();

  void setLogLevel(Log::Level level);


  std::string getVersion();

  /*****************************************************************************
   *
   * Algorithms related methods
   *
   ****************************************************************************/

  AlgMetadata const **availableAlgorithms();

  AlgMetadata const *algorithmMetadata( char const *algorithm_id );

  int numAvailableAlgorithms();

  /*****************************************************************************
   *
   * Accessor methods
   *
   ****************************************************************************/

  EnvironmentPtr getEnvironment() { return _env; }

  AlgorithmPtr getAlgorithm() { return _alg; }

  Model getModel() const { return _alg->getModel(); }

  const SamplerPtr& getSampler() const { return _samp; }

  /*****************************************************************************
   *
   * Parameters setting methods
   *
   ****************************************************************************/

  int setOccurrences( const OccurrencesPtr& presence,
                      const OccurrencesPtr& absence=OccurrencesPtr() );

  int setAlgorithm( std::string const id, int nparam, AlgParameter const *param );

  void setEnvironment( std::vector<std::string> categ_map,
           std::vector<std::string> continuous_map,
           const std::string& mask );
    
  void setSampler(const SamplerPtr& sampler);

  void setAbortionCallback( AbortionCallback func, void *param=0 );

  /*****************************************************************************
   *
   * Projection / Map Generation Methods
   *
   ****************************************************************************/

  void setMapCallback( ModelProjectionCallback func, void *param=0 );

  int createMap( const EnvironmentPtr & env, char const *output_file, MapFormat& format );

  int createMap( const EnvironmentPtr & env, char const *output_file );
  
  int createMap( char const *output_file, MapFormat& format );

  int createMap( char const *output_file );

  /*****************************************************************************
   *
   * Model generation procedures
   *
   ****************************************************************************/

  void setModelCallback( ModelCreationCallback func, void *param=0 );

  //
  // Model and distribution map related methods.
  //

  int createModel();

  int run()  { return createModel(); }

  Scalar getValue(const ConstEnvironmentPtr& env, Coord x, Coord y);

  Scalar getValue( Scalar const *environment_values );

  char *error()  { return _error; }

  /*****************************************************************************
   *
   * Statistics
   *
   ****************************************************************************/

  AreaStats * getActualAreaStats();

  AreaStats * getEstimatedAreaStats(double proportionAreaToSample = 0.01);
  AreaStats * getEstimatedAreaStats(const ConstEnvironmentPtr& env, 
            double proportionAreaToSample = 0.01);

  const ConfusionMatrix * const getConfusionMatrix();

  RocCurve * const getRocCurve();

  /*****************************************************************************
   *
   * Serialization & Deserialization
   *
   ****************************************************************************/

  ConfigurationPtr getModelConfiguration() const;

  void setModelConfiguration( const ConstConfigurationPtr & );

  void setProjectionConfiguration( const ConstConfigurationPtr & );

  void calculateModelStatistics( const ConstConfigurationPtr & );

private:

  bool hasEnvironment();

  // Sampler object
  SamplerPtr _samp;

  // Algorithm object
  AlgorithmPtr _alg;

  // Presence occurrences points
  OccurrencesPtr _presence;

  // Absence occurrences points
  OccurrencesPtr _absence;

  // Original environmental layers
  EnvironmentPtr _env;

  // Wrapper object for callbacks
  CallbackWrapper _callback_wrapper;

  // Output format
  MapFormat _format;

  // Environmental layers for projection
  EnvironmentPtr _projEnv;

  // Model statistics: helper objects
  AreaStats * _actualAreaStats;
  AreaStats * _estimatedAreaStats;

  // Confusion matrix
  ConfusionMatrix _confusion_matrix;

  // ROC Curve
  RocCurve _roc_curve;

  char _error[256];
};


#endif