openModeller
Version 1.5.0
|
#include <envelope_score.hh>
Public Member Functions | |
EnvelopeScore () | |
~EnvelopeScore () | |
int | initialize () |
int | iterate () |
int | done () const |
Scalar | getValue (const Sample &x) const |
int | getConvergence (Scalar *const val) const |
Public Member Functions inherited from AlgorithmImpl | |
AlgorithmImpl (AlgMetadata const *metadata) | |
virtual | ~AlgorithmImpl () |
void | setParameters (int nparam, AlgParameter const *param) |
void | setParameters (const ParamSetType &) |
std::string const | getID () const |
AlgMetadata const * | getMetadata () const |
AlgorithmPtr | getFreshCopy () |
virtual int | supportsModelProjection () const |
Model | createModel (const SamplerPtr &samp, CallbackWrapper *func=0) |
void | setSampler (const SamplerPtr &samp) |
virtual int | finalize () |
virtual float | getProgress () const |
virtual int | needNormalization () |
Normalizer * | getNormalizer () const |
void | setNormalization (const SamplerPtr &samp) const |
void | setNormalization (const EnvironmentPtr &env) const |
virtual Model | getModel () const |
ConfigurationPtr | getConfiguration () const |
void | setConfiguration (const ConstConfigurationPtr &) |
Public Member Functions inherited from Configurable | |
virtual | ~Configurable () |
Protected Member Functions | |
virtual void | _getConfiguration (ConfigurationPtr &) const |
virtual void | _setConfiguration (const ConstConfigurationPtr &) |
Protected Member Functions inherited from AlgorithmImpl | |
int | dimDomain () |
int | getParameter (std::string const &name, std::string *value) |
int | getParameter (std::string const &name, double *value) |
int | getParameter (std::string const &name, float *value) |
int | getParameter (std::string const &name, int *value) |
Private Member Functions | |
void | computeStats (const OccurrencesPtr &) |
void | logEnvelope () |
Private Attributes | |
bool | _done |
Sample | _minimum |
More... | |
Sample | _maximum |
More... | |
Additional Inherited Members | |
Public Types inherited from AlgorithmImpl | |
typedef std::map< icstring, std::string > | ParamSetType |
Protected Attributes inherited from AlgorithmImpl | |
SamplerPtr | _samp |
Normalizer * | _normalizerPtr |
ParamSetType | _param |
Declaration of EnvelopeScoreatic Envelope Algorithm - Nix, 1986.
LICENSE INFORMATION
Based on Bioclim alg Copyright(c) 2004 by CRIA - Centro de Referência em Informação Ambiental
Envelope Score implementation (c) 2007 Chris Yesson and Tim Sutton
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details:
http://www.gnu.org/copyleft/gpl.html Bioclimatic Envelope Algorithm with occurrence probability based on the number variables within the min/max range
Definition at line 45 of file envelope_score.hh.
EnvelopeScore::EnvelopeScore | ( | ) |
Definition at line 131 of file envelope_score.cpp.
EnvelopeScore::~EnvelopeScore | ( | ) |
Definition at line 142 of file envelope_score.cpp.
|
protectedvirtual |
Reimplemented from AlgorithmImpl.
Definition at line 265 of file envelope_score.cpp.
|
protectedvirtual |
Reimplemented from AlgorithmImpl.
Definition at line 279 of file envelope_score.cpp.
|
private |
compute the statistic member variables based on the data in the OccurrencesPtr
Definition at line 230 of file envelope_score.cpp.
References _maximum, and _minimum.
Referenced by initialize().
|
virtual |
Return != 0 if algorithm finished.
Reimplemented from AlgorithmImpl.
Definition at line 186 of file envelope_score.cpp.
References _done.
|
virtual |
Returns the algorithm's convergence value at the moment
Reimplemented from AlgorithmImpl.
Definition at line 220 of file envelope_score.cpp.
The algorithm must return the occurrence probability at the given environment conditions.
x | Environmental conditions. |
Implements AlgorithmImpl.
Definition at line 196 of file envelope_score.cpp.
References _maximum, _minimum, and Sample::size().
|
virtual |
Initiate a new training.
Implements AlgorithmImpl.
Definition at line 150 of file envelope_score.cpp.
References _done, AlgorithmImpl::_samp, computeStats(), Log::error(), Log::info(), and Log::instance().
|
virtual |
One step further on the training. Return 0 if something wrong happened.
Reimplemented from AlgorithmImpl.
Definition at line 177 of file envelope_score.cpp.
|
private |
Log the bioclimatic envelopes information.
Definition at line 297 of file envelope_score.cpp.
References _maximum, _minimum, Log::info(), Log::instance(), and Sample::size().
|
private |
Definition at line 73 of file envelope_score.hh.
Referenced by _getConfiguration(), _setConfiguration(), done(), and initialize().
|
private |
Mininum value for each variable.
Definition at line 76 of file envelope_score.hh.
Referenced by _getConfiguration(), _setConfiguration(), computeStats(), getValue(), and logEnvelope().
|
private |
is true if the algorithm is finished.
Definition at line 75 of file envelope_score.hh.
Referenced by _getConfiguration(), _setConfiguration(), computeStats(), getValue(), and logEnvelope().