Pixel-level class. More...

#include <Pixel.h>

Inheritance diagram for Pixel:

Collaboration diagram for Pixel:

[legend]

Public Member Functions
	Pixel (double ID_h, ThreadManager *MTHREAD_h)

	~Pixel ()

double	getDoubleValue (const string &layerName_h, const bool &returnZeroForNoValue=false) const
	Return the value for a specific layer.

double	getDoubleValue (const string &parName, const string &forName, const string &dClass, const int &year, const bool &returnZeroForNoValue=false)

double	getMultiplier (const string &multiplierName, const string &forName, int year=DATA_NOW)

double	getPathMortality (const string &forType, const string &dC, int year=DATA_NOW)
	Return the INCREASED mortality due to pathogen presence for a given ft and dc in a certain year (default the running year)

void	correctInputMultiplier (const string &multiplierName, const string &forName, double coefficient=1)
	It apply a given coefficient to all the multipliers layers of a given ft.

void	newYear ()

double	getPastRegArea (const int &ft_idx, const int &year)

void	setPastRegArea (const double &value, const int &ft_idx, const int &year)

ModelRegion *	getMyRegion (const int &rLevel=2)

double	getSTData (const string &parName, const string &forName, int year, const string &d2="", double naToReturn=RETNA)

double	getID () const

int	getX () const

int	getY () const

vector< Pixel * >	getPixelsAtDistLevel (int distLevel_h) const
	Return a vector of pixels at the specified distance (in levels, not in physical units)

string	getPxComments () const

double	getCachedDouble () const

void	setValue (const string &layerName_h, const double &value_h)
	Insert a new layer and its value.

void	changeValue (const string &layerName_h, const double &value_h, const bool &setNoValueForZero=false)
	Change the value of an existing layerMTHREAD->GIS->pack(parName, forName, dClass, year), value_h,.

void	setCoordinates (int x_h, int y_h)

void	setPxComments (std::string pxComments_h)

void	setCachedDouble (double cachedDouble_h)

void	clearCache ()

void	setSpModifier (const double &value, const int &ftindex)

double	getSpModifier (const string &ft)

void	swap (const int &swap_what)
	Assign to the delayed value the current values, e.g. vol_l = vol.

void	setMyRegion (ModelRegion *region_h)

Public Member Functions inherited from BaseClass
	BaseClass ()

	~BaseClass ()

void	msgOut (const int &msgCode_h, const string &msg_h, const bool &refreshGUI_h=true) const
	Overloaded function to print the output log.

void	msgOut (const int &msgCode_h, const int &msg_h, const bool &refreshGUI_h=true) const
	Overloaded function to print the output log.

void	msgOut (const int &msgCode_h, const double &msg_h, const bool &refreshGUI_h=true) const
	Overloaded function to print the output log.

int	s2i (const string &string_h) const
	string to integer conversion

double	s2d (const string &string_h) const
	string to double conversion

double	s2d (const string &string_h, const bool &replaceComma) const
	string to double conversion

bool	s2b (const string &string_h) const
	string to bool conversion

string	i2s (const int &int_h) const
	integer to string conversion

string	d2s (const double &double_h) const
	double to string conversion

string	b2s (const bool &bool_h) const
	bool to string conversion

vector< int >	s2i (const vector< string > &string_h) const
	string to integer conversion (vector)

vector< double >	s2d (const vector< string > &string_h, const bool &replaceComma=false) const
	string to double conversion (vector)

vector< bool >	s2b (const vector< string > &string_h) const
	string to bool conversion (vector)

vector< string >	i2s (const vector< int > &int_h) const
	integer to string conversion (vector)

vector< string >	d2s (const vector< double > &double_h) const
	double to string conversion (vector)

vector< string >	b2s (const vector< bool > &bool_h) const
	bool to string conversion (vector)

int	getType (const string &type_h) const
	Return a type according to enum TYPE_* from a string (eg: "string" -> TYPE_STRING (2))

void	refreshGUI () const
	Ping to periodically return the control to the GUI.

template<typename T >
string	toString (const T &x) const

template<typename T >
T	stringTo (const std::string &s) const

int	vSum (const vector< int > &vector_h) const

double	vSum (const vector< double > &vector_h) const

int	vSum (const vector< vector< int > > &vector_h) const

double	vSum (const vector< vector< double > > &vector_h) const

void	tokenize (const string &str, vector< string > &tokens, const string &delimiter=" ") const
	Tokenize a string using a delimiter (default is space)

void	untokenize (string &str, vector< string > &tokens, const string &delimiter=" ") const

template<typename K , typename V >
V	findMap (const map< K, V > &mymap, const K &key, const int &error_level=MSG_CRITICAL_ERROR, const V &notFoundValue=numeric_limits< V >::min()) const
	Lookup a map for a value. Return the value starting from the key.

template<typename K , typename V >
void	changeMapValue (map< K, V > &mymap, const K &key, const V &value, const int &error_level=MSG_CRITICAL_ERROR)
	Change the value stored in a map given the key and the new value.

template<typename K , typename V >
void	incrMapValue (map< K, V > &mymap, const K &key, const V &value, const int &error_level=MSG_CRITICAL_ERROR)
	Increments a value stored in a map of the specified value, given the key.

template<typename K , typename V >
void	incrOrAddMapValue (map< K, V > &mymap, const K &key, const V &value)
	Increments a value stored in a map of the specified value, given the key.

template<typename K , typename V >
void	resetMapValues (map< K, V > &mymap, const V &value)
	Reset all values stored in a map to the specified one.

template<typename K , typename V >
map< K, V >	vectorToMap (const vector< K > &keys, const V &value=0.0)
	Returns a map built using the given vector and the given (scalar) value as keys/values pairs.

template<typename T >
vector< T >	positionsToContent (const vector< T > &vector_h, const vector< int > &positions)
	Return a vector of content from a vector and a vector of positions (int)

template<typename V >
void	debugMap (const map< iisskey, V > &mymap)
	Debug a map.

template<typename K , typename V >
void	debugMap (const map< K, V > &mymap, const K &key)

template<typename K >
int	getMaxPos (const vector< K > &v)
	Returns the position of the maximum element in the vector (the last one in case of multiple equivalent maxima)

template<typename K >
int	getMinPos (const vector< K > &v)
	Returns the position of the minimum element in the vector (the first one in case of multiple equivalent minima)

template<typename K >
K	getMax (const vector< K > &v)
	Returns the value of the maximum element in the vector (the last one in case of multiple equivalent maxima)

template<typename K >
K	getMin (const vector< K > &v)
	Returns the value of the minimum element in the vector (the first one in case of multiple equivalent minima)

template<typename K >
double	getAvg (const vector< K > &v)
	Returns the average of the elements in the vector.

template<typename K >
double	getSd (const vector< K > &v, bool sample=true)

template<typename K >
int	getPos (const K &element, const vector< K > &v, const int &msgCode_h=MSG_CRITICAL_ERROR)

template<typename K >
bool	inVector (const K &element, const vector< K > &v)

double	normSample (const double &avg, const double &stdev, const double &minval=NULL, const double &maxval=NULL) const
	Sample from a normal distribution with bounds. Slower (double time, but still you see the diff only after milion of loops).

template<typename K >
K	normSample (normal_distribution< K > &d, std::mt19937 &gen, const K &minval=NULL, const K &maxval=NULL) const
	Sample from a normal distribution with bounds. Faster (half time) as the normal_distribution is made only once.

template<typename T >
std::string	toString (const T &x) const

Public Attributes
vector< vector< double > >	vol

vector< vector< double > >	area

vector< vector< double > >	deltaArea

vector< double >	initialDc0Area

vector< vector< double > >	hArea

vector< vector< double > >	hVol

vector< vector< double > >	hProductivity

vector< vector< vector< double > > >	hVol_byPrd

map< int, vector< double > >	regArea

vector< double >	vReg

vector< vector< double > >	vMort

vector< vector< double > >	vMortAdd

vector< double >	expectedReturns

vector< int >	optDc

vector< int >	optFtChosen

vector< int >	optDcChosen

vector< double >	expectedAnnualIncome_carbon

vector< double >	expectedAnnualIncome_timber

vector< double >	expectedReturnsNotCorrByRa
	by ft. Attenction, reported expReturns at "forest" level (compared with those at forest type level) do NOT include ra

vector< vector< double > >	vol_l
	store the volumes of the previous year

vector< vector< double > >	area_l
	store the areas of the previous year

vector< vector< double > >	beta

vector< vector< double > >	mort

vector< vector< double > >	addMort

vector< vector< double > >	tp

vector< vector< double > >	cumTp
	This is time of passage to REACH a diameter class (while the exogenous tp by diameter class is the time of passage to LEAVE to the next d class). By ft,dc.

vector< vector< double > >	vHa
	Volume at hectar by each diameter class [m^3/ha].

vector< vector< double > >	cumAlive
	Cumulative prob of remaining alive at beginnin of a given diam class.

vector< vector< double > >	cumTp_exp
	This is the expected version of cumTp, used for calculating profits.

vector< vector< double > >	vHa_exp
	This is the expected version of vHa, used for calculating profits.

vector< vector< double > >	cumAlive_exp
	This is the expected version of cumAlive, used for calculating profits.

double	portfolioVarRa
	Sampling derived risk aversion on portfolio variance for of this agent.

double	expType
	Sampling derived expectation types of this agent (forest bilogical parameters: growth, mortality)

double	expTypePrices
	Sampling derived expectation types of this agent (prices)

bool	usePortfolio
	Sampling derived usage of portfolio management (false/true)

vector< double >	avalCoef
	Availability (of wood resources) coefficient. A [0,1] coefficient (new: by forest type) that reduces avaiability of wood resources to exploitation due to local reasons (protected area, altimetry..)

Private Attributes
map< string, double >	values
	Map of values for each layer.

map< string, double >::const_iterator	vIter

double	ID

int	pxX

int	pxY

string	pxComments

double	cachedDouble
	Cachable double used in some optimized algorithms.

vector< double >	spMods
	The sampled spatial modifiers (by forest type)

ModelRegion *	l2region
	Pointer to level 2 region where this pixel is.

Additional Inherited Members
Protected Attributes inherited from BaseClass
ThreadManager *	MTHREAD
	Pointer to the Thread manager.

Detailed Description

Pixel-level class.

This class manage the info at the pixel level. A vector of pixel objects is owned by the class Gis.

Author: Antonello Lobianco

Definition at line 47 of file Pixel.h.

Constructor & Destructor Documentation

◆ Pixel()

Pixel	(	double	ID_h,
		ThreadManager *	MTHREAD_h
	)

Definition at line 27 of file Pixel.cpp.

                                                 : ID(ID_h)
{
  MTHREAD=MTHREAD_h;
  int nft = MTHREAD->MD->getForTypeIds().size();
  vector<double> temp(nft,1);
  //vector<double> temp2(nft,0);
  spMods = temp;
  avalCoef = temp;
  //vMort  = temp2;
  //std::fill(v.begin(), v.end(), 0);
}

Here is the call graph for this function:

◆ ~Pixel()

~Pixel ( )

Definition at line 39 of file Pixel.cpp.

40{

41}

Member Function Documentation

◆ changeValue()

void changeValue	(	const string &	layerName_h,
		const double &	value_h,
		const bool &	setNoValueForZero = `false`
	)

Change the value of an existing layerMTHREAD->GIS->pack(parName, forName, dClass, year), value_h,.

Definition at line 135 of file Pixel.cpp.

                                                                                                 {
  map<string, double>::iterator p;
  p=values.find(layerName_h);
  if(p != values.end()){
    if(setNoValueForZero && value_h == 0){
      p->second = MTHREAD->GIS->getNoValue();
    } else {
      p->second = value_h;
    }
  } else {
    msgOut(MSG_ERROR, "Coud not change pixel value for layer "+layerName_h+". Layer don't found.");
  }
  return;
}

Referenced by Gis::applyForestReclassification(), ModelCoreSpatial::loadExogenousForestLayers(), Layers::randomShuffle(), and ModelCoreSpatial::updateMapAreas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearCache()

void clearCache ( )

inline

Definition at line 86 of file Pixel.h.

86{cachedDouble=0;};

Pixel::cachedDouble

double cachedDouble

Cachable double used in some optimized algorithms.

Definition Pixel.h:157

◆ correctInputMultiplier()

void correctInputMultiplier	(	const string &	multiplierName,
		const string &	forName,
		double	coefficient = `1`
	)

It apply a given coefficient to all the multipliers layers of a given ft.

Definition at line 369 of file Pixel.cpp.

                                                                                                     {
  string search_for = multiplierName+"#"+forName+"#";
  for (std::map<string,double>::iterator it=values.lower_bound(search_for); it!=values.end(); ++it){
    if (it->first.compare(0, search_for.size(), search_for) == 0){
            //cout << ID << ";" << forName << ";" << coefficient << endl;
      it->second = it->second * coefficient;
    }
  }
}

◆ getCachedDouble()

double getCachedDouble ( ) const

inline

Definition at line 74 of file Pixel.h.

74{return cachedDouble;};

◆ getDoubleValue() [1/2]

double getDoubleValue	(	const string &	layerName_h,
		const bool &	returnZeroForNoValue = `false`
	)		const

Return the value for a specific layer.

Definition at line 158 of file Pixel.cpp.

                                                                                      {
  vIter=values.find(layerName_h);
  if(vIter != values.end()) {
    if(returnZeroForNoValue && vIter->second==MTHREAD->GIS->getNoValue()){
      return 0.0;
    } else {
      return vIter->second;
    }
  } else {
    msgOut(MSG_WARNING, "No layer \""+layerName_h+"\" found on pixel ("+i2s(getX())+","+i2s(getY())+"). Sure you didn't mispelled it?");
    if(returnZeroForNoValue){
      return 0.0;
    } else {
      return MTHREAD->GIS->getNoValue();
    }
  }
}

Referenced by Gis::applyForestReclassification(), ThreadManager::computeQuery(), Layers::countMyPixels(), getDoubleValue(), getPathMortality(), ModelCoreSpatial::initializePixelArea(), ModelCoreSpatial::loadExogenousForestLayers(), Layers::print(), Layers::printBinMap(), Layers::randomShuffle(), ModelCoreSpatial::runBiologicalModule(), ModelCoreSpatial::runManagementModule(), ModelRegion::setMyPixels(), ModelCoreSpatial::sumRegionalForData(), and ModelCoreSpatial::updateMapAreas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDoubleValue() [2/2]

double getDoubleValue	(	const string &	parName,
		const string &	forName,
		const string &	dClass,
		const int &	year,
		const bool &	returnZeroForNoValue = `false`
	)

Definition at line 380 of file Pixel.cpp.

                                                                                                                                            {
  return getDoubleValue(MTHREAD->GIS->pack(parName, forName, dClass, year), returnZeroForNoValue);
}

Here is the call graph for this function:

◆ getID()

double getID ( ) const

inline

Definition at line 67 of file Pixel.h.

67{return ID;} ;

Referenced by ModelCoreSpatial::initializePixelArea(), Output::printDebugPixelValues(), ModelCoreSpatial::runBiologicalModule(), ModelCoreSpatial::sumRegionalForData(), and ModelCoreSpatial::updateMapAreas().

Here is the caller graph for this function:

◆ getMultiplier()

double getMultiplier	(	const string &	multiplierName,
		const string &	forName,
		int	year = `DATA_NOW`
	)

getMultiplier() returns the value of the multiplier as memorized in the spatialDataSubfolder layers or in the forData table. It will looks for exact match or for lower years if available. If no layers are available or the usePixelData option is not used, it will return 1. If the tp_multiplier is asked for, it will adjusts for spatial variance coefficient. If the mortCoef_multiplier is used and we are in the table settings it will adjust it by mortCoef_link.

Definition at line 184 of file Pixel.cpp.

                                                                                 {
 
 
  if(year==DATA_NOW){year = MTHREAD->SCD->getYear();}
 
 
    double multiplierSpVar = (multiplierName == "tp_multiplier")?getSpModifier(forName):1.0;
 
    vector <string> modifiersFromTable = MTHREAD->MD->getStringVectorSetting("modifiersFromTable");
 
    if(std::find(modifiersFromTable.begin(), modifiersFromTable.end(), multiplierName) != modifiersFromTable.end()) {
      // load multiplier from forData table..
      int regId = getMyRegion()->getRegId();
      double multiplier = MTHREAD->MD->getForData(multiplierName, regId, forName, "",year);
      if (multiplierName == "mortCoef_multiplier"){
        return pow(multiplier,MTHREAD->MD->getDoubleSetting("mortMultiplier_link",DATA_NOW))*multiplierSpVar; //Added to account that our multipliers are based on probability of presence and not on planted/managed forests, where mortality is somhow reduced
      }
      return multiplier*multiplierSpVar;
 
    } else {
      // load multiplier from layer file..
      return getSTData(multiplierName, forName, year, "", 1.0);
 
//      // return 1 if not using pixel mode
//      if(!MTHREAD->MD->getBoolSetting("usePixelData")) return 1.0;
//      string search_for = multiplierName+"#"+forName+"##"+i2s(year);
//      map <string,double>::const_iterator i = values.upper_bound(search_for); //return the position always upper to the found one, even if it's an equal match.
//      if(i!= values.begin())  i--; // this rewind the position to the one just before or equal
//      const string& key = i->first;
//      string search_base = search_for.substr(0,search_for.size()-4);
//      if (key.compare(0, search_base.size(), search_base) == 0){
//          //cout << "MATCH: " << search_for <<", "<< i->first << ", " << i->second << endl;
//          //if(i->second != 1){
//          //  cout << "NOT ONE: " << search_for <<", "<< i->first << ", " << i->second << endl;
//          //  exit(0);
//          //}
//          return i->second*multiplierSpVar;
//      } else {
//          //cout << "NOTM:  " << search_for <<", "<< i->first << endl;
//          return 1.0*multiplierSpVar;
//      }
 
    }
}

Referenced by ModelCoreSpatial::cachePixelExogenousData(), ModelCoreSpatial::computeCumulativeData(), and Output::printDebugPixelValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMyRegion()

ModelRegion * getMyRegion ( const int & rLevel = 2 )

Definition at line 449 of file Pixel.cpp.

                                   {
    if(rLevel==2){
        return l2region;
    } else if (rLevel==1) {
        return l2region->getParent();
    } else {
        msgOut(MSG_ERROR, "Requested a unknown level region code in getMyRegion().");
    }
}

Referenced by getMultiplier().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPastRegArea()

double getPastRegArea	(	const int &	ft_idx,
		const int &	year
	)

Definition at line 390 of file Pixel.cpp.

                                                       {
  map <int,vector<double> >::const_iterator i=regArea.find(year);
  if(i != regArea.end()) {
    return i->second.at(ft_idx);
  } else {
    msgOut(MSG_ERROR, "Asking for a pastRegArea of a not-registered year. I don't have year "+i2s(year)+"!");
  }
}

Referenced by ModelCoreSpatial::runBiologicalModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPathMortality()

double getPathMortality	(	const string &	forType,
		const string &	dC,
		int	year = `DATA_NOW`
	)

Return the INCREASED mortality due to pathogen presence for a given ft and dc in a certain year (default the running year)

The mortality returned is the increased yearly mortality due to any affecting pathogenes. The function load the relevant pathogen mortality rule(s), for each of them check for how many years the phatogen is present with concentrations above the threshold and returns the relavant increase in mortality (summing them in case of multiple pathogens).

Definition at line 329 of file Pixel.cpp.

                                                                        {
  if(!MTHREAD->MD->getBoolSetting("usePathogenModule")) return 0.0;
 
  string debug=forType;
  int initialOptYear = MTHREAD->MD->getIntSetting("initialOptYear");
  int simulationYears = MTHREAD->MD->getIntSetting("simulationYears");
 
  int maxYear = initialOptYear + simulationYears;
 
  vector<pathRule*> pathRules = MTHREAD->MD->getPathMortalityRule(forType,dC);
 
  double pathMort = 0.0;
  if(year==DATA_NOW){year = MTHREAD->SCD->getYear();}
 
  for(uint r=0;r<pathRules.size();r++){
    string pathId=pathRules[r]->pathId;
    double pres_min=pathRules[r]->pres_min;
    vector<double> mortCoefficients=pathRules[r]->mortCoefficents;
    double pathMort_thispath = 0.0;
    for(uint y=year;y>(year-mortCoefficients.size());y--){
      int i =year-y;
      int y2 = y;
      if(y>=maxYear){
        y2=maxYear-1;
      }
 
      string layerName="pathogen_pp#"+pathId+"#"+i2s(y2);
      if(MTHREAD->GIS->layerExist(layerName)){
        if (this->getDoubleValue(layerName,true)>= pres_min){
          pathMort_thispath = mortCoefficients[i];
        }
      }
    }
    pathMort += pathMort_thispath;
  }
  return pathMort;
 
}

Referenced by ModelCoreSpatial::cachePixelExogenousData(), ModelCoreSpatial::computeCumulativeData(), ModelCoreSpatial::runManagementModule(), and ModelCoreSpatial::sumRegionalForData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPixelsAtDistLevel()

vector< Pixel * > getPixelsAtDistLevel ( int distLevel_h ) const

Return a vector of pixels at the specified distance (in levels, not in physical units)

The function return a vector of pointers to Pixels at the gived distance from the caller pixel.\ The list start with those on the Top, then add those on the right, those on the bottom and those on the left. Finally it had the corner pixels (that are more far).\ It takes into consideration borders correctly.

Fully tested on internal points as well semi-border cases, border cases and corner cases. ALL OK.

Parameters

distLevel_h Distance in number of adiacent pixels. It has to be at least 1 (the function return an error if it is 0).

Definition at line 53 of file Pixel.cpp.

                                                {
 
  if (distLevel_h<1) {
    msgOut(MSG_CRITICAL_ERROR, "getPixelsAtDistLevel() is defined for distances of at least 1 !");
  }
 
  vector <Pixel *> toReturn;
  int xNPixels = MTHREAD->GIS->getXNPixels();
  int yNPixels = MTHREAD->GIS->getYNPixels();
  int thisX = this->getX();
  int thisY = this->getY();
  int minX = max(0        , (thisX - distLevel_h)+1);
  int maxX = min(xNPixels , thisX + distLevel_h);
  int minY = max(0        , (thisY - distLevel_h)+1);
  int maxY = min(yNPixels , thisY + distLevel_h);
 
  // getting the top pixels (corner exluded)...
  if (thisY-distLevel_h >=0){
    for(int i=minX;i<maxX;i++){
      toReturn.push_back(MTHREAD->GIS->getPixel(i,thisY-distLevel_h));
    }
  }
  // getting the right pixels (corner exluded)...
  if (thisX+distLevel_h < xNPixels){
    for(int i=minY;i<maxY;i++){
      toReturn.push_back(MTHREAD->GIS->getPixel(thisX+distLevel_h,i));
    }
  }
  // getting the bottom pixels (corner exluded)...
  if (thisY+distLevel_h < yNPixels){
    for(int i=minX;i<maxX;i++){
      toReturn.push_back(MTHREAD->GIS->getPixel(i,thisY+distLevel_h));
    }
  }
  // getting the left pixels (corner exluded)...
  if (thisX-distLevel_h >= 0){
    for(int i=minY;i<maxY;i++){
      toReturn.push_back(MTHREAD->GIS->getPixel(thisX-distLevel_h,i));
    }
  }
 
  // getting the corners (correctly at the end, after already retrieved the other pixels..)...
  // top-left..
  if (thisX-distLevel_h >= 0 && thisY-distLevel_h >=0){
    toReturn.push_back(MTHREAD->GIS->getPixel(thisX-distLevel_h,thisY-distLevel_h));
  }
  // top-right..
  if (thisX+distLevel_h < xNPixels && thisY-distLevel_h >=0){
    toReturn.push_back(MTHREAD->GIS->getPixel(thisX+distLevel_h,thisY-distLevel_h));
  }
  // bottom-right..
  if (thisX+distLevel_h < xNPixels && thisY+distLevel_h <yNPixels){ // bug discovered 20070719
    toReturn.push_back(MTHREAD->GIS->getPixel(thisX+distLevel_h,thisY+distLevel_h));
  }
  // bottom-left..
  if (thisX-distLevel_h >= 0 && thisY+distLevel_h <yNPixels){
    toReturn.push_back(MTHREAD->GIS->getPixel(thisX-distLevel_h,thisY+distLevel_h));
  }
  return toReturn;
} 

Here is the call graph for this function:

◆ getPxComments()

string getPxComments ( ) const

inline

Definition at line 73 of file Pixel.h.

73{return pxComments;};

Pixel::pxComments

string pxComments

Definition Pixel.h:156

◆ getSpModifier()

double getSpModifier ( const string & ft )

Definition at line 437 of file Pixel.cpp.

                                    {
  vector<string>ftypes = MTHREAD->MD->getForTypeIds();
  for (int i=0;i<ftypes.size();i++){
      if (ftypes[i] == ft){
          return spMods.at(i);
      }
  }
  msgOut(MSG_CRITICAL_ERROR,"Asked spatial modifier for a forest type that doesn't exist");
 
}

Referenced by getMultiplier().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSTData()

double getSTData	(	const string &	parName,
		const string &	forName,
		int	year,
		const string &	d2 = `""`,
		double	naToReturn = `RETNA`
	)

getSTData() (standing for "get spatial temporal data") returns the value memorized in a spatial layer whose name follows the above convention

parName::fType::dimension2::year

It queries the layer framework with the following logic:

Parameters

parName	Parameter name (exact match)
forName	Forest type (exact match or look for "")
year	Year (exact match or look for the highest lower value). Accept enum DATA_NOW
d2	Optional dimension (exact match or look for "", string. Default = "")
naToReturn	Optional value to return if no match (default to secnario-specific novalue)

Definition at line 246 of file Pixel.cpp.

                                                                                                           {
 
  double defaultNoValue = MTHREAD->MD->getDoubleSetting("noValue");
  if (naToReturn == RETNA) naToReturn = defaultNoValue;
 
  // return NA if not using pixel mode
  if(!MTHREAD->MD->getBoolSetting("usePixelData")) return naToReturn;
 
  // If year is DATA_NOW get current year
  if (year == DATA_NOW) year = MTHREAD->SCD->getYear();
 
  // Looking for an exact match in forName
  string search_for = parName+"#"+forName+"#"+d2+"#"+i2s(year);
  map <string,double>::const_iterator i = values.upper_bound(search_for); //return the position always upper to the found one, even if it's an equal match.
  if(i!= values.begin())  i--; // this rewind the position to the one just before or equal
  const string& key = i->first;
  string search_base = search_for.substr(0,search_for.size()-4);
  if (key.compare(0, search_base.size(), search_base) == 0){
      //cout << "MATCH: " << search_for <<", "<< i->first << ", " << i->second << endl;
      //if(i->second != 1){
      //  cout << "NOT ONE: " << search_for <<", "<< i->first << ", " << i->second << endl;
      //  exit(0);
      //}
      return i->second == defaultNoValue ? naToReturn : i->second;
  } else {
      // An exact match in forName has not being found, look for no forName:
      string search_for2 = parName+"#"+"#"+d2+"#"+i2s(year);
      map <string,double>::const_iterator i2 = values.upper_bound(search_for2); //return the position always upper to the found one, even if it's an equal match.
      if(i2!= values.begin())  i2--; // this rewind the position to the one just before or equal
      const string& key2 = i2->first;
      string search_base2 = search_for2.substr(0,search_for2.size()-4);
      if (key2.compare(0, search_base2.size(), search_base2) == 0){
        //cout << "MATCH: " << search_for <<", "<< i->first << ", " << i->second << endl;
        //if(i->second != 1){
        //  cout << "NOT ONE: " << search_for <<", "<< i->first << ", " << i->second << endl;
        //  exit(0);
        //}
        return i2->second == defaultNoValue ? naToReturn : i2->second;
      } else {
          // An exact match in forName or noforName has not being found, look for no dc:
          string search_for2 = parName+"#"+forName+"#"+"#"+i2s(year);
          map <string,double>::const_iterator i2 = values.upper_bound(search_for2); //return the position always upper to the found one, even if it's an equal match.
          if(i2!= values.begin())  i2--; // this rewind the position to the one just before or equal
          const string& key2 = i2->first;
          string search_base2 = search_for2.substr(0,search_for2.size()-4);
          if (key2.compare(0, search_base2.size(), search_base2) == 0){
            //cout << "MATCH: " << search_for <<", "<< i->first << ", " << i->second << endl;
            //if(i->second != 1){
            //  cout << "NOT ONE: " << search_for <<", "<< i->first << ", " << i->second << endl;
            //  exit(0);
            //}
            return i2->second == defaultNoValue ? naToReturn : i2->second;
          } else {
              // An exact match, or partial match in forName or dc alones has not being found, look for no forName AND no dc:
              string search_for2 = parName+"#"+"#"+"#"+i2s(year);
              map <string,double>::const_iterator i2 = values.upper_bound(search_for2); //return the position always upper to the found one, even if it's an equal match.
              if(i2!= values.begin())  i2--; // this rewind the position to the one just before or equal
              const string& key2 = i2->first;
              string search_base2 = search_for2.substr(0,search_for2.size()-4);
              if (key2.compare(0, search_base2.size(), search_base2) == 0){
                //cout << "MATCH: " << search_for <<", "<< i->first << ", " << i->second << endl;
                //if(i->second != 1){
                //  cout << "NOT ONE: " << search_for <<", "<< i->first << ", " << i->second << endl;
                //  exit(0);
                //}
                return i2->second == defaultNoValue ? naToReturn : i2->second;
              } else {
                 //cout << "NOTM:  " << search_for <<", "<< i->first << endl;
                 return naToReturn;
              }
           }
      }
  }
}

Referenced by ModelCoreSpatial::cachePixelExogenousData(), ModelCoreSpatial::computeCumulativeData(), and getMultiplier().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getX()

int getX ( ) const

inline

Definition at line 68 of file Pixel.h.

68{return pxX;} ;

Pixel::pxX

int pxX

Definition Pixel.h:154

Referenced by ThreadManager::computeQuery(), Gis::getDistance(), getDoubleValue(), getPixelsAtDistLevel(), and Output::printDebugPixelValues().

Here is the caller graph for this function:

◆ getY()

int getY ( ) const

inline

Definition at line 69 of file Pixel.h.

69{return pxY;};

Pixel::pxY

int pxY

Definition Pixel.h:155

Referenced by ThreadManager::computeQuery(), Gis::getDistance(), getDoubleValue(), getPixelsAtDistLevel(), and Output::printDebugPixelValues().

Here is the caller graph for this function:

◆ newYear()

void newYear ( )

Definition at line 385 of file Pixel.cpp.

              {
 
}

Referenced by Scheduler::run().

Here is the caller graph for this function:

◆ setCachedDouble()

void setCachedDouble ( double cachedDouble_h )

inline

Definition at line 85 of file Pixel.h.

85{cachedDouble=cachedDouble_h;};

◆ setCoordinates()

void setCoordinates	(	int	x_h,
		int	y_h
	)

inline

Definition at line 83 of file Pixel.h.

83{pxX=x_h; pxY=y_h;};

Referenced by Gis::setSpace().

Here is the caller graph for this function:

◆ setMyRegion()

void setMyRegion ( ModelRegion * region_h )

inline

Definition at line 90 of file Pixel.h.

90{l2region = region_h;};

Referenced by ModelRegion::setMyPixels().

Here is the caller graph for this function:

◆ setPastRegArea()

void setPastRegArea	(	const double &	value,
		const int &	ft_idx,
		const int &	year
	)

Definition at line 400 of file Pixel.cpp.

                                                                            {
  msgOut(MSG_CRITICAL_ERROR,"TODO");
  /*map <int,vector<double> >::const_iterator i=regArea.find(year);
  if(i != regArea.end()) {
    // we already have this year, let's see if the vector is bif enough
    int currsize = i->second.size();
    for(j=0;j<ft_idx-currside;j++){
 
    }
    return i->second.at(ft_idx);
  } else {
    // new year
  }
 
 
  pair<int,vector<double> newRegArea;
  */
 
 
}

Here is the call graph for this function:

◆ setPxComments()

void setPxComments ( std::string pxComments_h )

inline

Definition at line 84 of file Pixel.h.

84{pxComments = pxComments_h;};

◆ setSpModifier()

void setSpModifier	(	const double &	value,
		const int &	ftindex
	)

inline

Definition at line 87 of file Pixel.h.

87{spMods.at(ftindex)=value;};

Referenced by ModelCoreSpatial::assignSpMultiplierPropToVols().

Here is the caller graph for this function:

◆ setValue()

void setValue	(	const string &	layerName_h,
		const double &	value_h
	)

inline

Insert a new layer and its value.

Definition at line 78 of file Pixel.h.

78{values.insert(pair<string, double>(layerName_h, value_h));}

◆ swap()

void swap ( const int & swap_what )

Assign to the delayed value the current values, e.g. vol_l = vol.

Definition at line 422 of file Pixel.cpp.

                               {
  switch (swap_what){
    case VAR_VOL:
      vol_l = vol;
      break;
    case VAR_AREA:
      area_l = area;
      break;
    default:
      msgOut(MSG_CRITICAL_ERROR,"Don't know how to swap "+swap_what);
  }
}

Referenced by ModelCoreSpatial::resetPixelValues().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ addMort

vector<vector <double> > addMort

Definition at line 134 of file Pixel.h.

Referenced by ModelCoreSpatial::cachePixelExogenousData(), ModelCoreSpatial::resetPixelValues(), and ModelCoreSpatial::runBiologicalModule().

◆ area

vector<vector <double> > area

Definition at line 107 of file Pixel.h.

Referenced by ModelCoreSpatial::initializePixelArea(), ModelCoreSpatial::loadExogenousForestLayers(), Output::printDebugPixelValues(), ModelCoreSpatial::resetPixelValues(), ModelCoreSpatial::runBiologicalModule(), ModelCoreSpatial::runManagementModule(), ModelCoreSpatial::sumRegionalForData(), swap(), and ModelCoreSpatial::updateMapAreas().

◆ area_l

vector<vector <double> > area_l

store the areas of the previous year

Definition at line 130 of file Pixel.h.

Referenced by ModelCoreSpatial::initializePixelArea(), ModelCoreSpatial::loadExogenousForestLayers(), ModelCoreSpatial::resetPixelValues(), ModelCoreSpatial::runBiologicalModule(), and swap().

◆ avalCoef

vector<double> avalCoef

Availability (of wood resources) coefficient. A [0,1] coefficient (new: by forest type) that reduces avaiability of wood resources to exploitation due to local reasons (protected area, altimetry..)

Definition at line 148 of file Pixel.h.

Referenced by ModelCoreSpatial::cachePixelExogenousData(), ModelCoreSpatial::computeInventary(), ModelData::getAvailableAliveTimber(), Pixel(), and ModelCoreSpatial::runBiologicalModule().

◆ beta

vector<vector <double> > beta

Definition at line 132 of file Pixel.h.

Referenced by ModelCoreSpatial::cachePixelExogenousData(), ModelCoreSpatial::resetPixelValues(), and ModelCoreSpatial::runBiologicalModule().

◆ cachedDouble

double cachedDouble

private

Cachable double used in some optimized algorithms.

Definition at line 157 of file Pixel.h.

Referenced by clearCache(), getCachedDouble(), and setCachedDouble().

◆ cumAlive

vector<vector <double> > cumAlive

Cumulative prob of remaining alive at beginnin of a given diam class.

Definition at line 138 of file Pixel.h.

Referenced by ModelCoreSpatial::computeCumulativeData(), and ModelCoreSpatial::resetPixelValues().

◆ cumAlive_exp

vector<vector <double> > cumAlive_exp

This is the expected version of cumAlive, used for calculating profits.

Definition at line 141 of file Pixel.h.

Referenced by ModelCoreSpatial::computeCumulativeData(), ModelCoreSpatial::resetPixelValues(), and ModelCoreSpatial::runManagementModule().

◆ cumTp

vector<vector <double> > cumTp

This is time of passage to REACH a diameter class (while the exogenous tp by diameter class is the time of passage to LEAVE to the next d class). By ft,dc.

Definition at line 136 of file Pixel.h.

Referenced by ModelCoreSpatial::computeCumulativeData(), ModelCoreSpatial::getAvgAgeByDc(), and ModelCoreSpatial::resetPixelValues().