openModeller
Version 1.5.0
|
#include <bioclim.hh>
Public Member Functions | |
Bioclim () | |
~Bioclim () | |
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 | |
void | _getConfiguration (ConfigurationPtr &) const |
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... | |
Sample | _mean |
More... | |
Sample | _std_dev |
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 Bioclimatic Envelope Algorithm - Nix, 1986.
LICENSE INFORMATION
Copyright(c) 2004 by CRIA - Centro de Referência em Informação Ambiental
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 distance to points' mean value.
Definition at line 41 of file bioclim.hh.
Bioclim::Bioclim | ( | ) |
Definition at line 157 of file bioclim.cpp.
Bioclim::~Bioclim | ( | ) |
Definition at line 170 of file bioclim.cpp.
|
protectedvirtual |
Reimplemented from AlgorithmImpl.
Definition at line 352 of file bioclim.cpp.
|
protectedvirtual |
Reimplemented from AlgorithmImpl.
Definition at line 368 of file bioclim.cpp.
|
private |
compute the statistic member variables based on the data in the OccurrencesPtr
Definition at line 286 of file bioclim.cpp.
References _maximum, _mean, _minimum, _std_dev, Sample::resize(), Sample::size(), and Sample::sqrt().
Referenced by initialize().
|
virtual |
Return != 0 if algorithm finished.
Reimplemented from AlgorithmImpl.
Definition at line 227 of file bioclim.cpp.
References _done.
|
virtual |
Returns the algorithm's convergence value at the moment
Reimplemented from AlgorithmImpl.
Definition at line 276 of file bioclim.cpp.
The algorithm must return the occurrence probability at the given environment conditions.
x | Environmental conditions. |
Implements AlgorithmImpl.
Definition at line 237 of file bioclim.cpp.
References _maximum, _mean, _minimum, _std_dev, and Sample::size().
|
virtual |
Initiate a new training.
Implements AlgorithmImpl.
Definition at line 178 of file bioclim.cpp.
References _done, AlgorithmImpl::_samp, _std_dev, computeStats(), CUTOFF_ID, Log::error(), AlgorithmImpl::getParameter(), Log::info(), Log::instance(), and Log::warn().
|
virtual |
One step further on the training. Return 0 if something wrong happened.
Reimplemented from AlgorithmImpl.
Definition at line 218 of file bioclim.cpp.
|
private |
Log the bioclimatic envelopes information.
Definition at line 388 of file bioclim.cpp.
References _maximum, _mean, _minimum, _std_dev, Log::info(), Log::instance(), and Sample::size().
|
private |
Definition at line 70 of file bioclim.hh.
Referenced by _getConfiguration(), _setConfiguration(), done(), and initialize().
|
private |
Mininum value for each variable.
Definition at line 73 of file bioclim.hh.
Referenced by _getConfiguration(), _setConfiguration(), computeStats(), getValue(), and logEnvelope().
|
private |
Maximum value for each variable.
Definition at line 74 of file bioclim.hh.
Referenced by _getConfiguration(), _setConfiguration(), computeStats(), getValue(), and logEnvelope().
|
private |
is true if the algorithm is finished.
Definition at line 72 of file bioclim.hh.
Referenced by _getConfiguration(), _setConfiguration(), computeStats(), getValue(), and logEnvelope().
|
private |
Mean of sampled points.
Definition at line 75 of file bioclim.hh.
Referenced by _getConfiguration(), _setConfiguration(), computeStats(), getValue(), initialize(), and logEnvelope().