seims.scenario_analysis.spatialunits.scenario.SUScenario Class Reference

Inheritance diagram for seims.scenario_analysis.spatialunits.scenario.SUScenario:

Public Member Functions
def	__init__ (self, cf)
def	read_bmp_parameters (self)
def	get_suitable_bmps (self, types='LANDUSE')
def	initialize (self, input_genes=None)
def	initialize_with_bmps_order (self, opt_genes, input_genes=False)
def	rule_based_config (self, method, conf_rate=0.5)
def	random_based_config (self, conf_rate=0.5)
def	boundary_adjustment (self)
def	decoding (self)
def	decoding_with_bmps_order (self)
def	import_from_mongodb (self, sid)
def	import_from_txt (self, sid)
def	calculate_economy (self)
def	calculate_economy_bmps_order (self, costs, maintains, incomes)
def	calculate_environment (self)
def	calculate_environment_bmps_order (self)
def	export_scenario_to_gtiff (self, outpath=None)
Public Member Functions inherited from seims.scenario_analysis.scenario.Scenario
def	set_unique_id (self, given_id=None)
def	export_to_mongodb (self)
def	export_scenario_to_txt (self)
def	clean (self, scenario_id=None, calibration_id=None, delete_scenario=False, delete_spatial_gfs=False)
def	execute_seims_model (self)

Detailed Description

Scenario analysis using different spatial units as BMPs configuration units.

Constructor & Destructor Documentation

__init__()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.__init__	(		self,
			cf
	)

Initialization.

Reimplemented from seims.scenario_analysis.scenario.Scenario.

Member Function Documentation

boundary_adjustment()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.boundary_adjustment

(

self

)

Update BMP configuration units and related data according to gene_values,
  i.e., bmps_info and units_infos

calculate_economy()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.calculate_economy

(

self

)

Calculate economic benefit by simple cost-benefit model, see Qin et al. (2018).

Reimplemented from seims.scenario_analysis.scenario.Scenario.

calculate_economy_bmps_order()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.calculate_economy_bmps_order	(		self,
			costs,
			maintains,
			incomes
	)

Calculate economic benefit by simple cost-benefit model, see Qin et al. (2018).

calculate_environment()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.calculate_environment

(

self

)

Calculate environment benefit based on the output and base values predefined in
configuration file.

Reimplemented from seims.scenario_analysis.scenario.Scenario.

calculate_environment_bmps_order()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.calculate_environment_bmps_order

(

self

)

Calculate environment benefit based on the output and base values predefined in
        configuration file.

decoding()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.decoding

(

self

)

Decode gene values to Scenario item, i.e., `self.bmp_items`.

Reimplemented from seims.scenario_analysis.scenario.Scenario.

decoding_with_bmps_order()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.decoding_with_bmps_order

(

self

)

Decode gene values to Scenario item, i.e., `self.bmp_items`.

export_scenario_to_gtiff()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.export_scenario_to_gtiff	(		self,
			outpath = None
	)

Export scenario to GTiff.

Read Raster from MongoDB should be extracted to pygeoc. -- Done using mask_rasterio!
By ZhuLJ, 2023-03-25

Reimplemented from seims.scenario_analysis.scenario.Scenario.

get_suitable_bmps()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.get_suitable_bmps	(		self,
			types = 'LANDUSE'
	)

Construct the suitable BMPs for each slope position.

import_from_mongodb()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.import_from_mongodb	(		self,
			sid
	)

Import a specified Scenario (`sid`) from MongoDB.

This function should be overridden in inherited class.
Returns:
    True if succeed, otherwise False.

Reimplemented from seims.scenario_analysis.scenario.Scenario.

import_from_txt()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.import_from_txt	(		self,
			sid
	)

Import a specified Scenario (`sid`) from text file.

This function should be overridden in inherited class.
Returns:
    True if succeed, otherwise False.

Reimplemented from seims.scenario_analysis.scenario.Scenario.

initialize()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.initialize	(		self,
			input_genes = None
	)

Initialize a scenario.

Returns:
    A list contains BMPs identifier of each gene location.

Reimplemented from seims.scenario_analysis.scenario.Scenario.

initialize_with_bmps_order()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.initialize_with_bmps_order	(		self,
			opt_genes,
			input_genes = False
	)

Initialize a scenario with bmps order.

Returns:
    A list contains BMPs identifier of each gene location.

random_based_config()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.random_based_config	(		self,
			conf_rate = 0.5
	)

Config BMPs on each spatial unit randomly.

Reimplemented from seims.scenario_analysis.scenario.Scenario.

read_bmp_parameters()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.read_bmp_parameters

(

self

)

Read BMP configuration from MongoDB.
Each BMP is stored in Collection as one item identified by 'SUBSCENARIO' field,
so the `self.bmps_params` is dict with BMP_ID ('SUBSCENARIO') as key.

rule_based_config()

def seims.scenario_analysis.spatialunits.scenario.SUScenario.rule_based_config	(		self,
			method,
			conf_rate = 0.5
	)

Config available BMPs on each spatial units by knowledge-based rule method.
The looping methods vary from different spatial units, e.g., for slope position units,
it is from the bottom slope position of each hillslope tracing upslope.

The available rule methods are 'SUIT', 'UPDOWN', and 'HILLSLP'.

See Also:
    :obj:`scenario_analysis.BMPS_CFG_METHODS`

Reimplemented from seims.scenario_analysis.scenario.Scenario.

---

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

• seims/scenario_analysis/spatialunits/scenario.py