Class to manage the spatial dimension. More...

#include <Gis.h>

Inheritance diagram for Gis:

Collaboration diagram for Gis:

[legend]

Public Member Functions
	Gis (ThreadManager *MTHREAD_h)
	Constructor.

	~Gis ()

void	setSpace ()
	Set the initial space environment, including loading data from files.

void	initLayers ()
	Init the layers.

void	initLayersPixelData ()

void	initLayersModelData (const int &year_h=DATA_NOW)

void	applyForestReclassification ()
	Apply the forest reclassification with the rules defined in reclRules sheet.

void	filterSubRegion (string layerName_h)
	If subregion mode is on, this function place noValues on the selected layer for all out-of-region pixels.

void	updateImage (string layerName_h)
	Add one layer to the system.

void	addLayer (string name_h, string label_h, bool isInteger_h, bool dynamicContent_h, string fullFileName_h="", bool display_h=true)
	Fill a layer with empty values.

void	resetLayer (string layerName_h)
	Check if a layer with a certain name is loaded in the model. Used e.g. to check if the dtm layer (optional) exist.

bool	layerExist (const string &layerName_h, bool exactMatch=true) const
	Return a pointer to a layer given its name.

Layers *	getLayer (const string &layerName_h)
	Add a legend item to an existing layer.

void	addLegendItem (string name_h, int D_h, string label_h, int rColor_h, int gColor_h, int bColor_h, double minValue_h, double maxValue_h)

void	countItems (const string &layerName_h, const bool &debug=false)
	Count the pixels within each legend item for the selected layer.

Pixel *	getRandomPlotByValue (string layer_h, int layerValue__h)
	Return a pointer to a plot with a specific value for the specified layer.

vector< Pixel * >	getAllPlotsByValue (string layer_h, int layerValue_h, int outputLevel=MSG_WARNING)
	Return the vector (shuffled) of all plots with a specific value for a specified layer. It is also possible to specify the level in case of failure.

vector< Pixel * >	getAllPlotsByValue (string layer_h, vector< int > layerValues_h, int outputLevel=MSG_WARNING)
	Return the vector (shuffled) of all plots with specific values for a specified layer. It is also possible to specify the level in case of failure.

vector< Pixel * >	getAllPlots (bool masked=true, int outputLevel=MSG_WARNING)
	Return the vector (shuffled) of all plots. It is also possible to specify the level in case of failure.

vector< Pixel * >	getAllPlotsByRegion (ModelRegion &region_h, bool shuffle=false)
	Return the vector of all plots by a specific region (main region or subregion), optionally shuffled;.

vector< Pixel * >	getAllPlotsByRegion (int regId_h, bool shuffle=false)

vector< string >	getLayerNames ()
	Return a vector of the layer ids (as string)

vector< Layers * >	getLayerPointers ()
	Return a vector of pointers of existing layers.

void	printLayers (string layerName_h="")
	Print the specified layer or all layers (if param layerName_h is missing).

void	printBinMaps (string layerName_h="")
	Save an image in standard png format.

void	printDebugValues (string layerName_h, int min_h=0, int max_h=0)

double	getDistance (const Pixel px1, const Pixel px2)

int	getXNPixels () const

int	getYNPixels () const
	Return the number of pixels on X.

double	getXyNPixels () const
	Return the number of pixels on Y.

double	getHaByPixel () const
	Return the total number of pixels.

double	getNoValue () const

Pixel *	getPixel (int x_h, int y_h)

Pixel *	getPixel (int ID_h)
	Return a pixel pointer from its coordinates.

double	getGeoTopY () const
	Return a pixel pointer from its ID.

double	getGeoBottomY () const

double	getGeoLeftX () const

double	getGeoRightX () const

double	getXMetersByPixel () const

double	getYMetersByPixel () const

int	getSubXL () const

int	getSubXR () const

int	getSubYT () const

int	getSubYB () const

int	sub2realID (int id_h)
	Transform the ID of a pixel in subregion coordinates to the real (and model used) coordinates.

string	pack (const string &parName, const string &forName, const string &dClass, const int &year) const

void	unpack (const string &key, string &parName, string &forName, string &dClass, int &year) const

void	swap (const int &swap_what)

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

Private Member Functions
void	loadLayersDataFromFile ()
	Load the data of a layer its datafile.

void	applySpatialStochasticValues ()
	Apply stochastic simulation, e.g. regional volume growth s.d. -> tp multipliers.

void	applyStochasticRiskAdversion ()
	Give to each agend a stochastic risk adversion. For now Pixel = Agent.

Private Attributes
vector< Pixel >	pxVector
	array of Pixel objects

vector< Layers >	layerVector
	array of Layer objects

vector< double >	lUseTotals
	totals, in ha, of area in the region for each type (cached values)

int	xNPixels
	number of pixels along the X dimension

int	yNPixels
	number of pixels along the Y dimension

double	xyNPixels
	total number of pixels

double	xMetersByPixel
	pixel dimension (meters), X

double	yMetersByPixel
	pixel dimension (meters), Y

double	geoLeftX
	geo-coordinates of the map left border

double	geoTopY
	geo-coordinates of the map upper border

double	geoRightX
	geo-coordinates of the map right border

double	geoBottomY
	geo-coordinates of the map bottom border

double	noValue
	value internally use as novalue (individual layer maps can have other values)

int	subXL
	sub region left X

int	subXR
	sub region right X

int	subYT
	sub region top Y

int	subYB
	sub region bottom Y

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

Detailed Description

Class to manage the spatial dimension.

Gis class is responsable to provide all methods for spatial analysis.
It is equipped with two important vectors:

pxVector contains the array of all pixels on the screen
layerVector contains the layer objects
Along the model, IDs of pixels are assigned from left to right, from top to down:
—>
/
—>
/
—>

Pixel origin (0,0) on the top left corner is also the system used by the underlying libraries, but put attencion that instead geographical coordinates, if we are on the North emisfere, are increasing along the up-right direction.

Author: Antonello Lobianco

Definition at line 67 of file Gis.h.

Constructor & Destructor Documentation

◆ Gis()

Gis ( ThreadManager * MTHREAD_h )

Constructor.

The constructor of the GIS (unique) instance want:

Parameters

RD_h	Pointer to the manager of the regional data
MTHREAD_h	Pointer to the main thread manager

Definition at line 40 of file Gis.cpp.

                                {
  MTHREAD=MTHREAD_h;
}

◆ ~Gis()

~Gis ( )

Definition at line 44 of file Gis.cpp.

44 {

45}

Member Function Documentation

◆ addLayer()

void addLayer	(	string	name_h,
		string	label_h,
		bool	isInteger_h,
		bool	dynamicContent_h,
		string	fullFileName_h = `""`,
		bool	display_h = `true`
	)

Fill a layer with empty values.

Called at init time from initLayers, or during model run-time, this function will add a layer to the system.

Parameters

name_h	ID of the layer (no spaces!)
label_h	layer label
type_h	type of the layer, integer or contiguous
dynamicContent_h	if it change during the time (so it needs to be printed each year) or not
fullFilename_h	if the layer has to be read at the beginning, the name of the associated datafile (default="")

It:

had the layer to the layerVector
set all pixels with nodata for that specific layer
let the GUI know we have a new layer

Definition at line 515 of file Gis.cpp.

                                                                                                                          {
  if(name_h == "forArea_ash"){
    bool debug = true;
  }
  for(uint i=0; i<layerVector.size(); i++){
    if (layerVector.at(i).getName() == name_h){
      msgOut(MSG_ERROR, "Layer already exist with that name");
      return;
    }
  }
  Layers LAYER (MTHREAD, name_h, label_h, isInteger_h, dynamicContent_h, fullFileName_h, display_h);
  layerVector.push_back(LAYER);
 
  for (uint i=0;i<xyNPixels; i++){
    pxVector[i].setValue(name_h,noValue);
  }
  if(display_h){
    MTHREAD->addLayer(name_h,label_h);
  }
  
}

Referenced by applyForestReclassification(), initLayers(), and initLayersPixelData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addLegendItem()

void addLegendItem	(	string	name_h,
		int	ID_h,
		string	label_h,
		int	rColor_h,
		int	gColor_h,
		int	bColor_h,
		double	minValue_h,
		double	maxValue_h
	)

Search within the layerVector and call addLegendItem(...) to the appropriate one.

Called at init time from initLayers, or during model run-time.

Parameters

name_h	Name of the layer
ID_h	ID of the specific lagend item

See also: Layers::addLegendItem

Definition at line 579 of file Gis.cpp.

                                                                                                                                         {
  
  for(uint i=0; i<layerVector.size(); i++){
    if (layerVector.at(i).getName() == name_h){
      layerVector.at(i).addLegendItem(ID_h, label_h, rColor_h, gColor_h, bColor_h, minValue_h, maxValue_h);
      return;
    }
  }
  msgOut(MSG_ERROR, "Trying to add a legend item to a layer that doesn't exist.");
  return;
}

Referenced by initLayers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyForestReclassification()

void applyForestReclassification ( )

Apply the forest reclassification with the rules defined in reclRules sheet.

Definition at line 439 of file Gis.cpp.

                                 {
/*per ogni forest type:
 - crea i layers delle forest type nuovi
 - riempi con zero
 - passa le info dal layerr ereditato al nuovo
 per ogni pixel
 */
 
  // caching
  int nReclassRules = MTHREAD->MD->getNReclRules();
  vector <reclRule*> RRs;
  for(uint z=0;z<nReclassRules;z++){
    RRs.push_back(MTHREAD->MD->getReclRule(z));
  }
 
 
 
  for (uint i=0;i< MTHREAD->MD->getNForTypes();i++){
    forType* FT = MTHREAD->MD->getForType(i);
    if(!layerExist(FT->forLayer)){
      addLayer(FT->forLayer, "Are layer for forest type "+FT->forTypeId, false, true);
      resetLayer(FT->forLayer);
      Layers* newLayer = getLayer(FT->forLayer);
      Layers* ereditatedLayer = getLayer(MTHREAD->MD->getForType(FT->ereditatedFrom)->forLayer);
      newLayer->addLegendItems(ereditatedLayer->getLegendItems());
    }
  }
 
 
  for (uint i=0;i< MTHREAD->MD->getNForTypes();i++){
    forType* FT = MTHREAD->MD->getForType(i);
    for(uint j=0;j<xyNPixels;j++){
      Pixel* PX = getPixel(j);
      //int regL1 =  PX->getDoubleValue ("regLev_1");
      int regL2 =  PX->getDoubleValue ("regLev_2");
      double value =  PX->getDoubleValue (FT->forLayer, true);
      for(uint z=0;z<nReclassRules;z++){
        reclRule* RR = RRs[z];
        //if( (RR->regId == regL2 || RR->regId == regL1) && RR->forTypeOut == FT->forTypeId ){ // we found a reclassification rule for the region where is located this pixel and that output on the for type we are using
        if( RR->regId == regL2  && RR->forTypeOut == FT->forTypeId ){ // we found a reclassification rule for the region where is located this pixel and that output on the for type we are using
          string debugForTypeIn = RR->forTypeIn;
          double inputValue = PX->getDoubleValue(MTHREAD->MD->getForType(RR->forTypeIn)->forLayer, true);
          double reclassCoeff = RR->coeff;
          value += inputValue * reclassCoeff ;
          // not breaking because we may have more than one input for the same output
        }
      }
      PX->changeValue(FT->forLayer, value, true);
    }
    updateImage(FT->forLayer);
  }
  //countItems("forType_B_HF", true);
  refreshGUI();
  /*Pixel* DP = getPixel(8386);
  msgOut(MSG_DEBUG,"Debug info on plot 8386");
  for (uint i=0;i< MTHREAD->MD->getNForTypes();i++){
    forType* FT = MTHREAD->MD->getForType(i);
    msgOut(MSG_DEBUG,FT->forTypeId+" - "+d2s(DP->getDoubleValue (FT->forLayer)));
  }
  */
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applySpatialStochasticValues()

void applySpatialStochasticValues ( )

private

Apply stochastic simulation, e.g. regional volume growth s.d. -> tp multipliers.

Apply all stochastic modifications required by the model at init time. Currently used to change time of passage devending on regional variance

with simmetric boundary on the cv I do not change the average, but of course I slighly reduce the stdev. See file monte_carlo_with_multipliers_sample_proof.ods

Definition at line 121 of file Gis.cpp.

                                 {
  // apply regional volume growth st.dev. -> variance to pixel based t.p.
  // - cashing value to the pixels
  // - apply to the tp layers with change values
 
  if(!MTHREAD->MD->getBoolSetting("usePixelData")) return;
 
  vector <int> regIds2 = MTHREAD->MD->getRegionIds(2);
  //ModelRegion* reg = MTHREAD->MD->getRegion(regIds2[i]);
  //vector<Pixel*> regPixels = region->getMyPixels();
  //double sumc = 0;
  //double nc = 0;
  for(uint i=0;i<regIds2.size();i++){
    int regId = regIds2[i];
    ModelRegion* reg = MTHREAD->MD->getRegion(regId );
    vector <Pixel*> rpx = MTHREAD->GIS->getAllPlotsByRegion(regId );
    vector <string> fTypes = MTHREAD->MD->getForTypeIds();
 
    // regional variance
    if(MTHREAD->MD->getBoolSetting("useSpatialRegionalVariance")){
      for(uint j=0; j<fTypes.size(); j++){
        double sStDev = MTHREAD->MD->getForData("sStDev",regId ,fTypes[j],""); // spatial standard deviation
        double agr = MTHREAD->MD->getForData("agr",regId ,fTypes[j],""); // average growth
        // BUG solved 20141220 To obtain a population with the same avg and st.dev of the original using moltipliers, I need to use the cv not the st.dev. !
        // tested with excel
        normal_distribution<double> d(1,sStDev/agr); // default any how to double
        for (uint z=0;z<rpx.size();z++){
          double c = d(*MTHREAD->gen);
          double c2 = max(0.4,min(1.6,c)); /// with simmetric boundary on the cv I do not change the average, but of course I slighly reduce the stdev. See file monte_carlo_with_multipliers_sample_proof.ods
          // TO.DO: Convert it to using normSample where instead of a min/max a loop is used to fund smaples that are within the bounds
          //cout << regIds2[i] << ";" <<sStDev <<";"<< c <<endl
          //rpx[z]->correctInputMultiplier("tp_multiplier",fTypes[j],c);
          //cout << sStDev/agr << "    " << c2 << endl;
          rpx[z]->setSpModifier(c2,j);
          //sumc += c;
          //nc ++;
        }
      }
    }
 
    // expectation types
    double avgExpTypes       = MTHREAD->MD->getDoubleSetting("expType",DATA_NOW,regId);
    double avgExpTypesPrices = MTHREAD->MD->getDoubleSetting("expTypePrices",DATA_NOW,regId);
    double expTypes_cv       = MTHREAD->MD->getDoubleSetting("expType_cv",DATA_NOW,regId);
    double expTypesPrices_cv = MTHREAD->MD->getDoubleSetting("expTypePrices_cv",DATA_NOW,regId);
    if((avgExpTypes<0 || avgExpTypes>1) && avgExpTypes != -1){
      msgOut(MSG_CRITICAL_ERROR, "expType parameter must be between 1 (expectations) and 0 (adaptative) or -1 (fixed).");
    }
    if(avgExpTypesPrices<0 || avgExpTypesPrices>1){
      msgOut(MSG_CRITICAL_ERROR, "vgExpTypesPrices parameter must be between 1 (expectations) and 0 (adaptative).");
    }
    //cout << avgExpTypes << "     " << expTypes_cv << endl;
 
    normal_distribution<double> exp_distr(avgExpTypes,expTypes_cv *avgExpTypes); // works only for double, but default any how to double
    normal_distribution<double> expPrices_distr(avgExpTypesPrices,expTypesPrices_cv *avgExpTypesPrices);
 
    for (uint z=0;z<rpx.size();z++){
      if(avgExpTypes == -1){
        rpx[z]->expType = -1;
      } else {
        //double c = exp_distr(*MTHREAD->gen);
        //double c2 = max(0.0,min(1.0,c)); /// Bounded [0,1]. With simmetric boundary on the cv I do not change the average, but of course I slighly reduce the stdev. See file monte_carlo_with_multipliers_sample_proof.ods
        double c3 = normSample(exp_distr,*MTHREAD->gen,0.0,1.0);
        //cout << "Sampled:\t" << c3 <<  endl;
        rpx[z]->expType = c3;
      }
      double cPrice = normSample(expPrices_distr,*MTHREAD->gen,0.0,1.0);
      rpx[z]->expTypePrices = cPrice;
    }
  }
}

Referenced by setSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyStochasticRiskAdversion()

void applyStochasticRiskAdversion ( )

private

Give to each agend a stochastic risk adversion. For now Pixel = Agent.

Apply to each agent a random risk-adversion coefficient

For now, 1 pixel = 1 agent, and avg and st.dev. are the same in the model, but eventually this can change

Definition at line 199 of file Gis.cpp.

                                 {
  // apply regional volume growth st.dev. -> variance to pixel based t.p.
  // - cashing value to the pixels
  // - apply to the tp layers with change values
 
  if(!MTHREAD->MD->getBoolSetting("usePixelData")) return;
 
  vector <int> regIds2 = MTHREAD->MD->getRegionIds(2);
  bool raEnabled = MTHREAD->MD->getBoolSetting("heterogeneousRiskAversion");
  for(uint i=0;i<regIds2.size();i++){
    int regId = regIds2[i];
    ModelRegion* reg = MTHREAD->MD->getRegion(regId);
    vector <Pixel*> rpx = MTHREAD->GIS->getAllPlotsByRegion(regId);
    for (uint z=0;z<rpx.size();z++){
      if(raEnabled){
        double raStDev = MTHREAD->MD->getDoubleSetting("riskAversionAgentSd",DATA_NOW,regId);
        double avg = MTHREAD->MD->getDoubleSetting("riskAversionAgentAverage",DATA_NOW,regId);
        normal_distribution<double> d(avg,raStDev); // default any how to double
        double c = d(*MTHREAD->gen);
        rpx[z]->setValue ("ra", c);
      } else {
        rpx[z]->setValue ("ra", 0.0);
      }
    }
  }
}

Referenced by setSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countItems()

void countItems	(	const string &	layerName_h,
		const bool &	debug = `false`
	)

Count the pixels within each legend item for the selected layer.

Search within the layerVector and call countMyPixels(...) to the appropriate one.

Called at init time from initLayers, or during model run-time.

Parameters

layerName_h	Name of the layer
debug	Print the values on the GUI

See also: Layers::countMyPixels

Definition at line 599 of file Gis.cpp.

                                                           {
 
  for(uint i=0; i<layerVector.size(); i++){
    if (layerVector.at(i).getName() == layerName_h){
      layerVector.at(i).countMyPixels(debug);
      return;
    }
  }
  msgOut(MSG_ERROR, "Trying to get statistics (count pixels) of a layer that doesn't exist.");
  return;
}

Here is the call graph for this function:

◆ filterSubRegion()

void filterSubRegion ( string layerName_h )

If subregion mode is on, this function place noValues on the selected layer for all out-of-region pixels.

Update the image behind a layer to the GUI;

This function filter the region, placing noValue on the selected informative layer on pixels that are outside the subregion.
It was thinked for speedup the development without have to run the whole model for testing each new implementation, but it can used to see what happen in the model when only a subset of the region is analysed.

Definition at line 921 of file Gis.cpp.

                                      {
 subXL = 0;
 subYT = 0;
 subXR = xNPixels-1;
 subYB = yNPixels-1;
}

Referenced by loadLayersDataFromFile().

Here is the caller graph for this function:

◆ getAllPlots()

vector< Pixel * > getAllPlots	(	bool	masked = `true`,
		int	outputLevel = `MSG_WARNING`
	)

Return the vector (shuffled) of all plots. It is also possible to specify the level in case of failure.

Parameters

onlyFreePlots	Flag to get only plots marked as free (d=false)
outputLevel	Level of output in case of failure (no plots available). Default is warning, but if set as MSG_CRITICAL_ERROR it make stop the model.

Definition at line 823 of file Gis.cpp.

                                            {
  vector <Pixel* > candidates;
  if(masked = false){
    for (uint i=0;i<pxVector.size();i++){
      candidates.push_back(&pxVector.at(i));
    }
    if (candidates.size()>0){
      random_shuffle(candidates.begin(), candidates.end()); // randomize ther elements of the array... cool !!! ;-)))
    } else {
      msgOut(outputLevel,"We can't find any free plot.");
    }
  } else {
    // Only pixels within a L2 region
    vector <int> regIds2 = MTHREAD->MD->getRegionIds(2);
    for(uint i=0;i<regIds2.size();i++){
      vector <Pixel*> rpx = getAllPlotsByRegion(regIds2[i]);
      //for (uint i=0;i<rpx.size();i++){
      //  candidates.push_back(rpx.at(i));
      //}
      candidates.insert( candidates.end(), rpx.begin(), rpx.end() );
    }
    if (candidates.size()>0){
      random_shuffle(candidates.begin(), candidates.end()); // randomize ther elements of the array... cool !!! ;-)))
    } else {
      msgOut(outputLevel,"We can't find any free plot.");
    }
  }
  return candidates;
}

Referenced by initLayersPixelData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllPlotsByRegion() [1/2]

vector< Pixel * > getAllPlotsByRegion	(	int	regId_h,
		bool	shuffle = `false`
	)

Definition at line 864 of file Gis.cpp.

                                                 {
    ModelRegion* reg = MTHREAD->MD->getRegion(regId_h);
    return getAllPlotsByRegion(*reg,shuffle);
}

Here is the call graph for this function:

◆ getAllPlotsByRegion() [2/2]

vector< Pixel * > getAllPlotsByRegion	(	ModelRegion &	region_h,
		bool	shuffle = `false`
	)

Return the vector of all plots by a specific region (main region or subregion), optionally shuffled;.

Definition at line 855 of file Gis.cpp.

                                                           {
  vector <Pixel*> regionalPixels = region_h.getMyPixels();
  if(shuffle){
    random_shuffle(regionalPixels.begin(), regionalPixels.end()); // randomize the elements of the array.
  }
  return regionalPixels;
}

Referenced by applySpatialStochasticValues(), applyStochasticRiskAdversion(), ModelCoreSpatial::assignSpMultiplierPropToVols(), getAllPlots(), getAllPlotsByRegion(), ModelCoreSpatial::initializePixelArea(), ModelCoreSpatial::initializePixelVolumes(), ModelCore::updateMapAreas(), ModelCoreSpatial::updateMapAreas(), and ModelCoreSpatial::updateOtherMapData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllPlotsByValue() [1/2]

vector< Pixel * > getAllPlotsByValue	(	string	layer_h,
		int	layerValue_h,
		int	outputLevel = `MSG_WARNING`
	)

Return the vector (shuffled) of all plots with a specific value for a specified layer. It is also possible to specify the level in case of failure.

Parameters

layer_h	Name of the layer
layerValue_h	Value we want the plots for
onlyFreePlots	Flag to get only plots marked as free (d=false)
outputLevel	Level of output in case of failure (no plots available). Default is warning, but if set as MSG_CRITICAL_ERROR it make stop the model.

Definition at line 758 of file Gis.cpp.

                                                                        {
  // this would be easier to mantain and cleaned code, but slighly slower:
  //vector<int> layerValues;
  //layerValues.push_back(layerValue_h);
  //return getAllPlotsByValue(layer_h, layerValues, onlyFreePlots, outputLevel);
 
  vector <Pixel* > candidates;
  for (uint i=0;i<pxVector.size();i++){
    if(pxVector.at(i).getDoubleValue(layer_h) == layerValue_h){
      candidates.push_back(&pxVector.at(i));
    }
  }
 
  if (candidates.size()>0){
    random_shuffle(candidates.begin(), candidates.end()); // randomize ther elements of the array... cool !!! ;-)))
  }
  else {
    msgOut(outputLevel,"We can't find any free pixel with "+d2s(layerValue_h)+" value on layer "+layer_h+".");
  }
  return candidates;
}

Here is the call graph for this function:

◆ getAllPlotsByValue() [2/2]

vector< Pixel * > getAllPlotsByValue	(	string	layer_h,
		vector< int >	layerValues_h,
		int	outputLevel = `MSG_WARNING`
	)

Return the vector (shuffled) of all plots with specific values for a specified layer. It is also possible to specify the level in case of failure.

Parameters

layer_h	Name of the layer
layerValues_h	Values we want the plots for
onlyFreePlots	Flag to get only plots marked as free (d=false)
outputLevel	Level of output in case of failure (no plots available). Default is warning, but if set as MSG_CRITICAL_ERROR it make stop the model.

Definition at line 790 of file Gis.cpp.

                                                                                 {
  vector <Pixel* > candidates;
  string valuesToMatch;
  unsigned int z;
 
  //string of the required land values to match;
  for (uint j=0;j<layerValues_h.size();j++){
    valuesToMatch = valuesToMatch + " " + i2s(layerValues_h.at(j));
  }
 
  for (uint i=0;i<pxVector.size();i++){
    z = valuesToMatch.find(d2s(pxVector.at(i).getDoubleValue(layer_h))); // search if in the string of required values is included also the value of the current plot
    if(z!=string::npos){ //z is not at the end of the string, means found!
      candidates.push_back(&pxVector.at(i));
    }
  }
 
  if (candidates.size()>0){
    random_shuffle(candidates.begin(), candidates.end()); // randomize ther elements of the array... cool !!! ;-)))
  }
  else {
    msgOut(outputLevel,"We can't find any free plot with the specified values ("+valuesToMatch+") on layer "+layer_h+".");
  }
  return candidates;
}

Here is the call graph for this function:

◆ getDistance()

double getDistance	(	const Pixel *	px1,
		const Pixel *	px2
	)

Definition at line 929 of file Gis.cpp.

                                                  {
  return sqrt (
        pow ( (((double)px1->getX()) - ((double)px2->getX()))*xMetersByPixel,2)
        +
        pow ( (((double)px1->getY()) - ((double)px2->getY()))*yMetersByPixel,2)
      );
}

Here is the call graph for this function:

◆ getGeoBottomY()

double getGeoBottomY ( ) const

inline

Definition at line 137 of file Gis.h.

137{return geoBottomY;};

Gis::geoBottomY

double geoBottomY

geo-coordinates of the map bottom border

Definition Gis.h:169

Referenced by Layers::print().

Here is the caller graph for this function:

◆ getGeoLeftX()

double getGeoLeftX ( ) const

inline

Definition at line 138 of file Gis.h.

138{return geoLeftX;};

Gis::geoLeftX

double geoLeftX

geo-coordinates of the map left border

Definition Gis.h:166

Referenced by Layers::print().

Here is the caller graph for this function:

◆ getGeoRightX()

double getGeoRightX ( ) const

inline

Definition at line 139 of file Gis.h.

139{return geoRightX;};

Gis::geoRightX

double geoRightX

geo-coordinates of the map right border

Definition Gis.h:168

Referenced by Layers::print().

Here is the caller graph for this function:

◆ getGeoTopY()

double getGeoTopY ( ) const

inline

Return a pixel pointer from its ID.

Definition at line 136 of file Gis.h.

136{return geoTopY;};

Gis::geoTopY

double geoTopY

geo-coordinates of the map upper border

Definition Gis.h:167

Referenced by Layers::print().

Here is the caller graph for this function:

◆ getHaByPixel()

double getHaByPixel ( ) const

inline

Return the total number of pixels.

Definition at line 132 of file Gis.h.

132{return ((xMetersByPixel*yMetersByPixel)/10000) ;};

Referenced by setSpace().

Here is the caller graph for this function:

◆ getLayer()

Layers * getLayer ( const string & layerName_h )

Add a legend item to an existing layer.

Init the layers of exogenous data at pixel level (e.g. time of passage) These layers will NOT be read by datafile, but volume for each pixel will be calculated from regional data and area map

Definition at line 429 of file Gis.cpp.

                                      {
  for(uint i=0;i<layerVector.size();i++){
    if(layerVector[i].getName() == layerName_h){
      return &layerVector[i];
    }
  }
  msgOut(MSG_CRITICAL_ERROR, "Layer "+layerName_h+" not found. Aborting.");
}

Referenced by applyForestReclassification().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLayerNames()

vector< string > getLayerNames ( )

Return a vector of the layer ids (as string)

Definition at line 872 of file Gis.cpp.

                  {
  vector <string> toReturn;
  for (uint i=0;i<layerVector.size();i++){
    toReturn.push_back(layerVector[i].getName());
  }
  return toReturn;
}

◆ getLayerPointers()

vector< Layers * > getLayerPointers ( )

Return a vector of pointers of existing layers.

Definition at line 881 of file Gis.cpp.

                     {
  vector <Layers*> toReturn;
  for (uint i=0;i<layerVector.size();i++){
    toReturn.push_back(&layerVector[i]);
  }
  return toReturn;
}

Referenced by ThreadManager::computeQuery().

Here is the caller graph for this function:

◆ getNoValue()

double getNoValue ( ) const

inline

Definition at line 133 of file Gis.h.

133{return noValue;};

Referenced by Pixel::changeValue(), Layers::getCategory(), Layers::getColor(), Pixel::getDoubleValue(), Layers::print(), and Layers::randomShuffle().

Here is the caller graph for this function:

◆ getPixel() [1/2]

Pixel * getPixel ( int ID_h )

inline

Return a pixel pointer from its coordinates.

Definition at line 135 of file Gis.h.

135{return &pxVector.at(ID_h);}; ///< Return a pixel pointer from its ID

◆ getPixel() [2/2]

Pixel * getPixel	(	int	x_h,
		int	y_h
	)

inline

Definition at line 134 of file Gis.h.

134{return &pxVector.at(x_h+y_h*xNPixels);}; ///< Return a pixel pointer from its coordinates

Referenced by applyForestReclassification(), ThreadManager::computeQuery(), Layers::countMyPixels(), Pixel::getPixelsAtDistLevel(), Layers::print(), Layers::printBinMap(), Layers::randomShuffle(), Scheduler::run(), and ModelRegion::setMyPixels().

Here is the caller graph for this function:

◆ getRandomPlotByValue()

Pixel * getRandomPlotByValue	(	string	layer_h,
		int	layerValue__h
	)

Return a pointer to a plot with a specific value for the specified layer.

Definition at line 730 of file Gis.cpp.

                                                         {
  
  vector <Pixel* > candidates;
  vector <uint> counts;
  for(uint i=0;i<pxVector.size();i++) counts.push_back(i);
  random_shuffle(counts.begin(), counts.end()); // randomize the elements of the array.
 
  for (uint i=0;i<counts.size();i++){
    if(pxVector.at(counts.at(i)).getDoubleValue(layer_h) == layerValue_h ) {
        return &pxVector.at(counts.at(i));
    }
  }
 
  msgOut(MSG_CRITICAL_ERROR,"We can't find any plot with "+d2s(layerValue_h)+" value on layer "+layer_h+".");
  Pixel* toReturn;
  toReturn =0;
  return toReturn;
}

Here is the call graph for this function:

◆ getSubXL()

int getSubXL ( ) const

inline

Definition at line 142 of file Gis.h.

142{return subXL;};

Referenced by Layers::printBinMap().

Here is the caller graph for this function:

◆ getSubXR()

int getSubXR ( ) const

inline

Definition at line 143 of file Gis.h.

143{return subXR;};

Referenced by Layers::printBinMap().

Here is the caller graph for this function:

◆ getSubYB()

int getSubYB ( ) const

inline

Definition at line 145 of file Gis.h.

145{return subYB;};

Referenced by Layers::printBinMap().

Here is the caller graph for this function:

◆ getSubYT()

int getSubYT ( ) const

inline

Definition at line 144 of file Gis.h.

144{return subYT;};

Referenced by Layers::printBinMap().

Here is the caller graph for this function:

◆ getXMetersByPixel()

double getXMetersByPixel ( ) const

inline

Definition at line 140 of file Gis.h.

140{return xMetersByPixel;};

Referenced by Layers::print().

Here is the caller graph for this function:

◆ getXNPixels()

int getXNPixels ( ) const

inline

Definition at line 129 of file Gis.h.

129{return xNPixels;}; ///< Return the number of pixels on X

Referenced by Pixel::getPixelsAtDistLevel(), Layers::print(), Layers::printBinMap(), and Scheduler::run().

Here is the caller graph for this function:

◆ getXyNPixels()

double getXyNPixels ( ) const

inline

Return the number of pixels on Y.

Definition at line 131 of file Gis.h.

131{return xyNPixels;}; ///< Return the total number of pixels

Referenced by Layers::countMyPixels(), Layers::randomShuffle(), ModelRegion::setMyPixels(), and setSpace().

Here is the caller graph for this function:

◆ getYMetersByPixel()

double getYMetersByPixel ( ) const

inline

Definition at line 141 of file Gis.h.

141{return yMetersByPixel;};

Referenced by Layers::print().

Here is the caller graph for this function:

◆ getYNPixels()

int getYNPixels ( ) const

inline

Return the number of pixels on X.

Definition at line 130 of file Gis.h.

130{return yNPixels;}; ///< Return the number of pixels on Y

Referenced by Pixel::getPixelsAtDistLevel(), and Layers::print().

Here is the caller graph for this function:

◆ initLayers()

void initLayers ( )

Init the layers.

Called from setSpace(), initLayers() is responsable of:

load each layer propriety (name, label, datafile..)
add the layer to the system
See also
addLayer
If the layer is to be read at start-up:
adding to the layer each legend item (ID, label, min-max values..)
See also
addLegendItem
[REMOVED, as reclassification rules are in the input ods file now, not in the gis input file] eventually adding to the layer each reclassification rules
See also
addReclassificationRule

Definition at line 259 of file Gis.cpp.

               {
  // setting layers...
  //string filename_complete= MTHREAD->MD->getFilenameByType("gis");
  string filename_complete = MTHREAD->getBaseDirectory()+MTHREAD->MD->getStringSetting("gisFilename");
 
  InputNode gisDocument;
  bool test=gisDocument.setWorkingFile(filename_complete);
  if (!test){msgOut(MSG_CRITICAL_ERROR, "Error opening the gis file "+filename_complete+".");}
  vector<InputNode> layerNodes = gisDocument.getNodesByName("layer");
  vector<string> ftIds = MTHREAD->MD->getForTypeIds();
  for (uint i=0; i<layerNodes.size();i++){
    
    string nameOrig = layerNodes.at(i).getNodeByName("name").getStringContent();
    string labelOrig = layerNodes.at(i).getNodeByName("label").getStringContent();
    bool isInteger = layerNodes.at(i).getNodeByName("isInteger").getBoolContent();
    bool dynamicContent = layerNodes.at(i).getNodeByName("dynamicContent").getBoolContent();
    bool expandByFt = layerNodes.at(i).getNodeByName("expandByFt").getBoolContent();
    string readAtStart = layerNodes.at(i).getNodeByName("readAtStart").getStringContent();
    if (readAtStart != "true") continue;
    string dirName = layerNodes.at(i).getNodeByName("dirName").getStringContent();
    string fileName = layerNodes.at(i).getNodeByName("fileName").getStringContent();
 
    // Eventually expanding this input layern in as many layer as forest types exists..
    uint endingLoop = expandByFt ? ftIds.size(): 1;
    for(uint z=0;z<endingLoop;z++){
      string ftExtension= expandByFt ? "_"+ftIds[z]:"";
      string labelFtExtension= expandByFt ? " ("+ftIds[z]+")":"";
      string name = nameOrig+ftExtension;
      string label = labelOrig + labelFtExtension;
 
      string fullFileName = ((dirName == "") || (fileName==""))?"":MTHREAD->MD->getBaseDirectory()+dirName+fileName+ftExtension; // TODO: ugly: one would have to put mmyfile.grd_broadL_highF
      addLayer(name,label,isInteger,dynamicContent,fullFileName);
      //legend..
      vector<InputNode> legendItemsNodes = layerNodes.at(i).getNodesByName("legendItem");
      for (uint j=0; j<legendItemsNodes.size();j++){
        int lID = legendItemsNodes.at(j).getIntContent();
        string llabel = legendItemsNodes.at(j).getStringAttributeByName("label");
        int rColor = legendItemsNodes.at(j).getIntAttributeByName("rColor");
        int gColor = legendItemsNodes.at(j).getIntAttributeByName("gColor");
        int bColor = legendItemsNodes.at(j).getIntAttributeByName("bColor");
        double minValue, maxValue;
        if (isInteger){
          minValue = ((double)lID);
          maxValue = ((double)lID);
        }
        else {
          minValue = legendItemsNodes.at(j).getDoubleAttributeByName("minValue");
          maxValue = legendItemsNodes.at(j).getDoubleAttributeByName("maxValue");
        }
        addLegendItem(name, lID, llabel, rColor, gColor, bColor, minValue, maxValue);
      }
    }
  }
  initLayersPixelData();
  //initLayersModelData(DATA_INIT); // only the layers relative to the initial years are inserted now. All the simulation year layers will be added each year before mainSimulationyear()
}

Referenced by setSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initLayersModelData()

void initLayersModelData ( const int & year_h = DATA_NOW )

◆ initLayersPixelData()

void initLayersPixelData ( )

Init the layers of exogenous data at pixel level (e.g. time of passage, multipliers, volumes of sp. espl. ft, spread models) These layers will then be read from datafile

See also: loadLayersDataFromFile

Definition at line 320 of file Gis.cpp.

                        {
  if (!MTHREAD->MD->getBoolSetting("usePixelData")){return;}
  string dir = MTHREAD->MD->getBaseDirectory()+MTHREAD->MD->getStringSetting("spatialDataSubfolder");
  string fileExt = MTHREAD->MD->getStringSetting("spatialDataFileExtension");
  vector<string> files = vector<string>();
  string fullFilename, filename, fullPath;
  //string parName, forName, dClass, yearString;
  //int year;
 
  MTHREAD->MD->getFilenamesByDir(dir,files, fileExt); // Ugly format. Files is the output (reference)
 
  for (unsigned int i = 0;i < files.size();i++) {
    fullFilename = files[i];
    fullPath = dir+"/"+fullFilename;
    filename = fullFilename.substr(0,fullFilename.find_last_of("."));
    addLayer(filename,filename,false,false,fullPath,false);
  }
 
  // Loading volumes of forest types that are spatially known..
  if(MTHREAD->MD->getBoolSetting("useSpExplicitForestTypes")){
    string dir2 = MTHREAD->MD->getBaseDirectory()+MTHREAD->MD->getStringSetting("spExplicitForTypesInputDir");
    string fileExt2 = MTHREAD->MD->getStringSetting("spExplicitForTypesFileExtension");
    vector<string> files2 = vector<string>();
    string fullFilename2, filename2, fullPath2;
    MTHREAD->MD->getFilenamesByDir (dir2,files2, fileExt2); // Ugly format. Files is the output (reference)
    for (unsigned int i = 0;i < files2.size();i++) {
      fullFilename2 = files2[i];
      fullPath2 = dir2+"/"+fullFilename2;
      filename2 = fullFilename2.substr(0,fullFilename2.find_last_of("."));
      addLayer(filename2,filename2,false,false,fullPath2,false);
    }
  }
 
  // Loading pathogens exogenous spread models...
  if(MTHREAD->MD->getBoolSetting("usePathogenModule")){
    string dir2 = MTHREAD->MD->getBaseDirectory()+MTHREAD->MD->getStringSetting("pathogenExogenousSpreadModelFolder");
    string fileExt2 = MTHREAD->MD->getStringSetting("pathogenExogenousSpreadModelFileExtension");
    vector<string> files2 = vector<string>();
    string fullFilename2, filename2, fullPath2;
    MTHREAD->MD->getFilenamesByDir (dir2,files2, fileExt2); // Ugly format. Files is the output (reference)
    for (unsigned int i = 0;i < files2.size();i++) {
      fullFilename2 = files2[i];
      fullPath2 = dir2+"/"+fullFilename2;
      filename2 = fullFilename2.substr(0,fullFilename2.find_last_of("."));
      addLayer(filename2,filename2,false,false,fullPath2,false);
    }
  }
 
  // Add layer of pixel IDs
  addLayer("pixelIds","Pixel IDs", true, false, "", true);
  vector <Pixel*> allPx = getAllPlots(false);
  for (unsigned int i = 0; i < allPx.size();i++) {
      allPx[i]->changeValue("pixelIds", allPx[i]->getID());
  }
 
 
 
}

Referenced by initLayers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ layerExist()

bool layerExist	(	const string &	layerName_h,
		bool	exactMatch = `true`
	)		const

Return a pointer to a layer given its name.

Definition at line 552 of file Gis.cpp.

                                                               {
 
  if(exactMatch){
    for(uint i=0; i<layerVector.size(); i++){
      if (layerVector.at(i).getName() == layerName_h){
        return true;
      }
    }
  } else { // partial matching (stored layer name begin with search parameter)
    for(uint i=0; i<layerVector.size(); i++){
      if (layerVector.at(i).getName().compare(0, layerName_h.size(),layerName_h )){
        return true;
      }
    }
  }
 
  return false;
}

Referenced by applyForestReclassification(), Pixel::getPathMortality(), ModelCoreSpatial::loadExogenousForestLayers(), and ModelCoreSpatial::updateOtherMapData().

Here is the caller graph for this function:

◆ loadLayersDataFromFile()

void loadLayersDataFromFile ( )

private

Load the data of a layer its datafile.

Called at init time from initLayers, this function load the associated datafile to the existing layers (that if exists at this stage are all of type to be loaded at start-up).
This function loop over layerVector and works with GRASS/ASCII (tested) or ARC/ASCII (untested) datasets, assigning to each pixel the readed value to the corresponding layer.
The function also "compose" the initial map with the colors read by the layer (for each specific values) and send the map to the GUI.

NOTE: It uses some Qt functions!!!

See also: Pixel::changeValue; Layers::filterExogenousDataset; Layers::getColor

Definition at line 624 of file Gis.cpp.

                           {
  double localNoValue = noValue;
  double inputValue;
  double outputValue;
  QColor color;
 
  for(uint i=0;i<layerVector.size();i++){
    string layerName =layerVector.at(i).getName();
    string fileName=layerVector.at(i).getFilename();
    if(fileName == "") continue; // BUGGED !!! 20121017, Antonello. It was "return", so it wasn't reading any layers following a layer with no filename
    QFile file(fileName.c_str());
    if (!file.open(QFile::ReadOnly)) {
      cerr << "Cannot open file for reading: "
        << qPrintable(file.errorString()) << endl;
      msgOut(MSG_ERROR, "Cannot open map file "+fileName+" for reading.");
      continue;
    }
    QTextStream in(&file);
    int countRow = 0;
    QImage image = QImage(xNPixels, yNPixels, QImage::Format_RGB32);
    image.fill(qRgb(255, 255, 255));
    while (!in.atEnd()) {
      QString line = in.readLine();
      QStringList fields = line.split(' ');
      if ( 
        (fields.at(0)== "north:" && fields.at(1).toDouble() != geoTopY)
        || ((fields.at(0)== "south:" || fields.at(0) == "yllcorner" ) && fields.at(1).toDouble() != geoBottomY)
        || (fields.at(0)== "east:" && fields.at(1).toDouble() != geoRightX)
        || ((fields.at(0)== "west:" || fields.at(0) == "xllcorner" ) && fields.at(1).toDouble() != geoLeftX)
        || ((fields.at(0)== "rows:" || fields.at(0) == "nrows" ) && fields.at(1).toInt() != yNPixels)
        || ((fields.at(0)== "cols:" || fields.at(0) == "ncols" ) && fields.at(1).toInt() != xNPixels)
      )
      {
        msgOut(MSG_ERROR, "Layer "+layerName+" has different coordinates. Aborting reading.");
        break;
      } else if (fields.at(0)== "null:" || fields.at(0) == "NODATA_value" || fields.at(0) == "nodata_value" ) {
        localNoValue = fields.at(1).toDouble();
      } else if (fields.size() > 5) {
        for (int countColumn=0;countColumn<xNPixels;countColumn++){
          inputValue = fields.at(countColumn).toDouble();
          if (inputValue == localNoValue){
            outputValue = noValue;
            pxVector.at((countRow*xNPixels+countColumn)).changeValue(layerName,outputValue);
            QColor nocolor(255,255,255);
            color = nocolor;
          }
          else {
            outputValue=layerVector.at(i).filterExogenousDataset(fields.at(countColumn).toDouble());
            pxVector.at((countRow*xNPixels+countColumn)).changeValue(layerName,outputValue);
            color = layerVector.at(i).getColor(outputValue);
          }
          image.setPixel(countColumn,countRow,color.rgb());
        }
        countRow++;
      }
    }
    if (MTHREAD->MD->getBoolSetting("initialRandomShuffle") ){
      layerVector.at(i).randomShuffle();
    }
    this->filterSubRegion(layerName);
    if(layerVector.at(i).getDisplay()){
      MTHREAD->updateImage(layerName,image);
      //send the image to the gui...
      refreshGUI();
    }
 
 
  }
}

Referenced by setSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pack()

string pack	(	const string &	parName,
		const string &	forName,
		const string &	dClass,
		const int &	year
	)		const

inline

Definition at line 148 of file Gis.h.

148{return parName+"#"+forName+"#"+dClass+"#"+i2s(year)+"#";};

Referenced by Pixel::getDoubleValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printBinMaps()

void printBinMaps ( string layerName_h = "" )

Save an image in standard png format.

Print debug information (for each pixel in the requested interval, their values on the specified layer)

Definition at line 963 of file Gis.cpp.

                                   {
  msgOut(MSG_DEBUG,"Printing the maps as images");
  int iteration = MTHREAD->SCD->getIteration(); // are we on the first year of the simulation ??
  if(layerName_h == ""){
    for (uint i=0;i<layerVector.size();i++){
      if (!iteration || layerVector[i].getDynamicContent()) {layerVector[i].printBinMap();}
    }
  } else {
    for (uint i=0;i<layerVector.size();i++){
      if(layerVector[i].getName() == layerName_h){
        if (!iteration || layerVector[i].getDynamicContent()) {layerVector[i].printBinMap();}
        return;
      }
    }
    msgOut(MSG_ERROR, "Layer "+layerName_h+" unknow. No layer printed.");
  }
}

Referenced by Output::printMaps().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printDebugValues()

void printDebugValues	(	string	layerName_h,
		int	min_h = `0`,
		int	max_h = `0`
	)

Definition at line 890 of file Gis.cpp.

                                                              {
  int min=min_h;
  int max;
  int ID, X, Y;
  string out;
  double value;
  //double noValue = MTHREAD->MD->getDoubleSetting("noValue");
  if (max_h==0){
    max= pxVector.size();
  }
  else {
    max = max_h;
  }
  msgOut(MSG_DEBUG,"Printing debug information for layer "+layerName_h+".");
  for (int i=min;i<max;i++){
    value = pxVector.at(i).getDoubleValue(layerName_h);
    if (value != noValue){ 
      ID    = i;
      X     = pxVector.at(i).getX();
      Y     = pxVector.at(i).getY();
      out = "Px. "+i2s(ID)+" ("+i2s(X)+","+i2s(Y)+"): "+d2s(value);
      msgOut(MSG_DEBUG,out);
    }
  }
}

Here is the call graph for this function:

◆ printLayers()

void printLayers ( string layerName_h = "" )

Print the specified layer or all layers (if param layerName_h is missing).

See also: Layers::print()

Definition at line 940 of file Gis.cpp.

                                  {
  msgOut(MSG_DEBUG,"Printing the layers");
  int iteration = MTHREAD->SCD->getIteration(); // are we on the first year of the simulation ??
  if(layerName_h == ""){
    for (uint i=0;i<layerVector.size();i++){
      //if(layerVector[i].getName() == "pixelIds"){
      //   cout << layerVector[i].getName() << endl;
      //}
      // not printing if we are in a not-0 iteration and the content of the map doesn't change
      if (!iteration || layerVector[i].getDynamicContent()) layerVector[i].print();
    }
  } else {
    for (uint i=0;i<layerVector.size();i++){
      if(layerVector[i].getName() == layerName_h){
        if (!iteration || layerVector[i].getDynamicContent()) layerVector[i].print();
        return;
      }
    }
    msgOut(MSG_ERROR, "Layer "+layerName_h+" unknow. No layer printed.");
  }
}

Referenced by Output::printMaps().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetLayer()

void resetLayer ( string layerName_h )

Check if a layer with a certain name is loaded in the model. Used e.g. to check if the dtm layer (optional) exist.

Definition at line 538 of file Gis.cpp.

                                 {
 
  for(uint i=0; i<layerVector.size(); i++){
    if (layerVector.at(i).getName() == layerName_h){
      for (uint i=0;i<xyNPixels; i++){
        pxVector.at(i).changeValue(layerName_h,noValue); // bug solved 20071022, Antonello
      }
      return;
    }
  }
  msgOut(MSG_ERROR, "I could not reset layer "+layerName_h+" as it doesn't exist!");  
}

Referenced by applyForestReclassification().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSpace()

void setSpace ( )

Set the initial space environment, including loading data from files.

setSpace is called directly from the init system to setting the space environment in the model.
It is responsable to:

define map dimensions (from setting files)
create the pixels
initialize the layer
See also
initLayers
load the layer data from their fdata-files
See also
loadLayersDataFromFile
tell the GUI that our map will have (x,y) dimensions

Definition at line 57 of file Gis.cpp.

             {
 
 
 
  msgOut(MSG_INFO,"Creating the space...");
 
  // init basic settings....
  geoTopY = MTHREAD->MD->getDoubleSetting("geoNorthEdge");
  geoBottomY = MTHREAD->MD->getDoubleSetting("geoSouthEdge");
  geoLeftX = MTHREAD->MD->getDoubleSetting("geoWestEdge");
  geoRightX = MTHREAD->MD->getDoubleSetting("geoEastEdge");
  xNPixels = MTHREAD->MD->getIntSetting("nCols");
  yNPixels = MTHREAD->MD->getIntSetting("nRows");
  noValue = MTHREAD->MD->getDoubleSetting("noValue");
  xyNPixels = xNPixels * yNPixels;
  xMetersByPixel = (geoRightX - geoLeftX)/xNPixels;
  yMetersByPixel = (geoTopY - geoBottomY)/yNPixels;
  MTHREAD->treeViewerChangeGeneralPropertyValue("total plots", d2s(getXyNPixels()));
  MTHREAD->treeViewerChangeGeneralPropertyValue("total land", d2s(xyNPixels*getHaByPixel()));
  // creating pixels...
  for (int i=0;i<yNPixels;i++){
    for (int j=0;j<xNPixels;j++){
      Pixel myPixel(i*xNPixels+j, MTHREAD);
      myPixel.setCoordinates(j,i);
      pxVector.push_back(myPixel);
    }
  }
  initLayers();
  loadLayersDataFromFile();
 
  // Cashing the pixels owned by each region..
  vector <ModelRegion*> regions = MTHREAD->MD->getAllRegions();
  int nRegions = regions.size();
  for(uint i=0;i<nRegions;i++){
    regions[i]->setMyPixels();
  }
 
  applySpatialStochasticValues(); // regional variance -> different tp in each pixel trought tp modifiers
  applyStochasticRiskAdversion(); // risk adversion to each pixel
  //cachePixelValues(); // For computational reasons cache some values in the constant layers directly as properties of the pixel object
 
  //< Print a layer of pixels id..
  //addLayer("pxIds", "idx of the pixels", true, true, "pxIds.grd", true);
  //resetLayer("pxIds");
  //vector<Pixel*> allPixels = getAllPlotsByRegion(11000);
  //for (int i=0;i<allPixels.size();i++){
  //  int pxId= allPixels[i]->getID();
  //  allPixels[i]->changeValue ("pxIds", pxId);
  //}
  //printLayers("pxIds");
  //exit(1);
 
  MTHREAD->fitInWindow(); // tell the gui to fit the map to the widget
//  countItems("landUse",false); // count the various records assigned to each legendItem. Do not print debug infos
  return;
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sub2realID()

int sub2realID ( int id_h )

Transform the ID of a pixel in subregion coordinates to the real (and model used) coordinates.

Definition at line 982 of file Gis.cpp.

                       {
  // IMPORTANT: this function is called at refreshGUI() times, so if there are output messages, call them with the option to NOT refresh the gui, otherwise we go to an infinite loop...
  return id_h;
}

Referenced by ThreadManager::computeQuery().

Here is the caller graph for this function:

◆ swap()

void swap ( const int & swap_what )

Definition at line 1005 of file Gis.cpp.

                             {
 
  for(uint i=0;i<pxVector.size();i++) {
    pxVector[i].swap(swap_what);
  }
 
}

◆ unpack()

void unpack	(	const string &	key,
		string &	parName,
		string &	forName,
		string &	dClass,
		int &	year
	)		const

Definition at line 988 of file Gis.cpp.

                                                                                               {
  int parNameDelimiter = key.find("#",0);
  int forNameDelimiter = key.find("#",parNameDelimiter+1);
  int dClassDelimiter = key.find("#",forNameDelimiter+1);
  int yearDelimiter = key.find("#",dClassDelimiter+1);
  if (yearDelimiter == string::npos){
    msgOut(MSG_CRITICAL_ERROR, "Error in unpacking the key for the layer.");
  }
  parName.assign(key,0,parNameDelimiter);
  forName.assign(key,parNameDelimiter+1,forNameDelimiter-parNameDelimiter-1);
  dClass.assign(key,forNameDelimiter+1,dClassDelimiter-forNameDelimiter-1);
  string yearString="";
  yearString.assign(key,dClassDelimiter+1,yearDelimiter-dClassDelimiter-1);
  year = s2i(yearString);
}

Here is the call graph for this function:

◆ updateImage()

void updateImage ( string layerName_h )

Add one layer to the system.

Update an ALREADY EXISTING image and send the updated image to the GUI.
It is used instead of updating the individual pixels that is much more time consuming than change the individual pixels value and then upgrade the image as a whole.

Parameters

layername_h Layer from where get the image data

Definition at line 700 of file Gis.cpp.

                                  {
  msgOut (1, "Update image "+layerName_h+"...");
 
  // sub{X,Y}{R,L,T,B} refer to the subregion coordinates, but when this is not active they coincide with the whole region
  QImage image = QImage(subXR-subXL+1, subYB-subYT+1, QImage::Format_RGB32);
 
  image.fill(qRgb(255, 255, 255));
  int layerIndex=-1;
  for (uint i=0;i<layerVector.size();i++){
    if (layerVector.at(i).getName() == layerName_h){
      layerIndex=i;
      break;
    }
  }
  if (layerIndex <0) {
    msgOut(MSG_CRITICAL_ERROR, "Layer not found in Gis::updateImage()");
  }
 
  for (int countRow=subYT;countRow<subYB;countRow++){
    for (int countColumn=subXL;countColumn<subXR;countColumn++){      
      double value = pxVector.at((countRow*xNPixels+countColumn)).getDoubleValue(layerName_h);
      QColor color = layerVector.at(layerIndex).getColor(value);
      image.setPixel(countColumn-subXL,countRow-subYT,color.rgb());
    }
  }
  MTHREAD->updateImage(layerName_h,image);
  refreshGUI();
}

Referenced by applyForestReclassification(), and ModelCoreSpatial::updateOtherMapData().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ geoBottomY

double geoBottomY

private

geo-coordinates of the map bottom border

Definition at line 169 of file Gis.h.

Referenced by getGeoBottomY(), loadLayersDataFromFile(), and setSpace().

◆ geoLeftX

double geoLeftX

private

geo-coordinates of the map left border

Definition at line 166 of file Gis.h.

Referenced by getGeoLeftX(), loadLayersDataFromFile(), and setSpace().

◆ geoRightX

double geoRightX

private

geo-coordinates of the map right border

Definition at line 168 of file Gis.h.

Referenced by getGeoRightX(), loadLayersDataFromFile(), and setSpace().

◆ geoTopY

double geoTopY

private

geo-coordinates of the map upper border

Definition at line 167 of file Gis.h.

Referenced by getGeoTopY(), loadLayersDataFromFile(), and setSpace().

◆ layerVector

vector<Layers> layerVector

private

array of Layer objects

Definition at line 159 of file Gis.h.

Referenced by addLayer(), addLegendItem(), countItems(), getLayer(), getLayerNames(), getLayerPointers(), layerExist(), loadLayersDataFromFile(), printBinMaps(), printLayers(), resetLayer(), and updateImage().

◆ lUseTotals

vector<double> lUseTotals

private

totals, in ha, of area in the region for each type (cached values)

Definition at line 160 of file Gis.h.

◆ noValue

double noValue

private

value internally use as novalue (individual layer maps can have other values)

Definition at line 170 of file Gis.h.

Referenced by addLayer(), getNoValue(), loadLayersDataFromFile(), printDebugValues(), resetLayer(), and setSpace().

◆ pxVector

vector<Pixel> pxVector

private

array of Pixel objects

Definition at line 158 of file Gis.h.

Referenced by addLayer(), getAllPlots(), getAllPlotsByValue(), getAllPlotsByValue(), getPixel(), getPixel(), getRandomPlotByValue(), loadLayersDataFromFile(), printDebugValues(), resetLayer(), setSpace(), swap(), and updateImage().

◆ subXL

int subXL

private

sub region left X

Definition at line 171 of file Gis.h.

Referenced by filterSubRegion(), getSubXL(), and updateImage().

◆ subXR

int subXR

private

sub region right X

Definition at line 172 of file Gis.h.

Referenced by filterSubRegion(), getSubXR(), and updateImage().

◆ subYB

int subYB

private

sub region bottom Y

Definition at line 174 of file Gis.h.

Referenced by filterSubRegion(), getSubYB(), and updateImage().

◆ subYT

int subYT

private

sub region top Y

Definition at line 173 of file Gis.h.

Referenced by filterSubRegion(), getSubYT(), and updateImage().

◆ xMetersByPixel

double xMetersByPixel

private

pixel dimension (meters), X

Definition at line 164 of file Gis.h.

Referenced by getDistance(), getHaByPixel(), getXMetersByPixel(), and setSpace().

◆ xNPixels

int xNPixels

private

number of pixels along the X dimension

Definition at line 161 of file Gis.h.

Referenced by filterSubRegion(), getPixel(), getXNPixels(), loadLayersDataFromFile(), setSpace(), and updateImage().

◆ xyNPixels

double xyNPixels

private

total number of pixels

Definition at line 163 of file Gis.h.

Referenced by addLayer(), applyForestReclassification(), getXyNPixels(), resetLayer(), and setSpace().

◆ yMetersByPixel

double yMetersByPixel

private

pixel dimension (meters), Y

Definition at line 165 of file Gis.h.

Referenced by getDistance(), getHaByPixel(), getYMetersByPixel(), and setSpace().

◆ yNPixels

int yNPixels

private

number of pixels along the Y dimension

Definition at line 162 of file Gis.h.

Referenced by filterSubRegion(), getYNPixels(), loadLayersDataFromFile(), and setSpace().

The documentation for this class was generated from the following files:

/exports/ffsm/src_latest/src/Gis.h
/exports/ffsm/src_latest/src/Gis.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Gis()

◆ ~Gis()

Member Function Documentation

◆ addLayer()

◆ addLegendItem()

◆ applyForestReclassification()

◆ applySpatialStochasticValues()

◆ applyStochasticRiskAdversion()

◆ countItems()

◆ filterSubRegion()

◆ getAllPlots()

◆ getAllPlotsByRegion() [1/2]

◆ getAllPlotsByRegion() [2/2]

◆ getAllPlotsByValue() [1/2]

◆ getAllPlotsByValue() [2/2]

◆ getDistance()

◆ getGeoBottomY()

◆ getGeoLeftX()

◆ getGeoRightX()

◆ getGeoTopY()

◆ getHaByPixel()

◆ getLayer()

◆ getLayerNames()

◆ getLayerPointers()

◆ getNoValue()

◆ getPixel() [1/2]

◆ getPixel() [2/2]

◆ getRandomPlotByValue()

◆ getSubXL()

◆ getSubXR()

◆ getSubYB()

◆ getSubYT()

◆ getXMetersByPixel()

◆ getXNPixels()

◆ getXyNPixels()

◆ getYMetersByPixel()

◆ getYNPixels()

◆ initLayers()

◆ initLayersModelData()

◆ initLayersPixelData()

◆ layerExist()

◆ loadLayersDataFromFile()

◆ pack()

◆ printBinMaps()

◆ printDebugValues()

◆ printLayers()

◆ resetLayer()

◆ setSpace()

◆ sub2realID()

◆ swap()

◆ unpack()

◆ updateImage()

Member Data Documentation

◆ geoBottomY

◆ geoLeftX

◆ geoRightX

◆ geoTopY

◆ layerVector

◆ lUseTotals

◆ noValue

◆ pxVector

◆ subXL

◆ subXR

◆ subYB

◆ subYT

◆ xMetersByPixel

◆ xNPixels

◆ xyNPixels

◆ yMetersByPixel

◆ yNPixels