te_algorithms.gdal.land_deg.models

class CounterbalancingLandTypeResult

Gains, losses, and delta LDN for a single land type.

Schema: alias of CounterbalancingLandTypeResult

__init__(land_type_code, land_type_name, gains_area_sqkm, losses_area_sqkm, total_area_sqkm, delta_ldn, ldn_achieved, ldn_pct, status_breakdown_sqkm=None, transition_breakdown_sqkm=None)

Parameters:

land_type_code (int)
land_type_name (str)
gains_area_sqkm (float)
losses_area_sqkm (float)
total_area_sqkm (float)
delta_ldn (float)
ldn_achieved (bool)
ldn_pct (float)
status_breakdown_sqkm (Dict[int, float] | None)
transition_breakdown_sqkm (Dict[int, float] | None)

Return type:

None

delta_ldn: float

gains_area_sqkm: float

land_type_code: int

land_type_name: str

ldn_achieved: bool

ldn_pct: float

losses_area_sqkm: float

status_breakdown_sqkm: Dict[int, float] | None = None

total_area_sqkm: float

transition_breakdown_sqkm: Dict[int, float] | None = None

class DegradationErrorRecodeSummaryParams

DegradationErrorRecodeSummaryParams(in_file: str, out_file: str, band_dict: dict, model_band_number: int, n_out_bands: int, mask_file: str, trans_code_lists: tuple, write_reporting_sdg_tifs: bool = False, baseline_band_num: Optional[int] = None, report_band_nums: Optional[List[int]] = None)

static Schema()

__init__(in_file, out_file, band_dict, model_band_number, n_out_bands, mask_file, trans_code_lists, write_reporting_sdg_tifs=False, baseline_band_num=None, report_band_nums=None)

Parameters:

in_file (str)
out_file (str)
band_dict (dict)
model_band_number (int)
n_out_bands (int)
mask_file (str)
trans_code_lists (tuple)
write_reporting_sdg_tifs (bool)
baseline_band_num (int | None)
report_band_nums (List[int] | None)

Return type:

None

band_dict: dict

baseline_band_num: int | None = None

in_file: str

mask_file: str

model_band_number: int

n_out_bands: int

out_file: str

report_band_nums: List[int] | None = None

trans_code_lists: tuple

write_reporting_sdg_tifs: bool = False

class DegradationStatusSummaryParams

DegradationStatusSummaryParams(prod_mode: str, in_file: str, out_file: str, band_dict: dict, model_band_number: int, n_out_bands: int, n_reporting: int, mask_file: str, nesting: te_schemas.land_cover.LCLegendNesting)

static Schema()

__init__(prod_mode, in_file, out_file, band_dict, model_band_number, n_out_bands, n_reporting, mask_file, nesting)

Parameters:

prod_mode (str)
in_file (str)
out_file (str)
band_dict (dict)
model_band_number (int)
n_out_bands (int)
n_reporting (int)
mask_file (str)
nesting (LCLegendNesting)

Return type:

None

band_dict: dict

in_file: str

mask_file: str

model_band_number: int

n_out_bands: int

n_reporting: int

nesting: LCLegendNesting

out_file: str

prod_mode: str

class DegradationSummaryParams

DegradationSummaryParams(in_df: te_schemas.datafile.DataFile, prod_mode: str, in_file: str, out_file: str, model_band_number: int, n_out_bands: int, mask_file: str, nesting: te_schemas.land_cover.LCLegendNesting, trans_matrix: te_schemas.land_cover.LCTransitionDefinitionDeg, period_name: str, periods: dict, error_recode: Optional[Dict] = <factory>)

static Schema()

__init__(in_df, prod_mode, in_file, out_file, model_band_number, n_out_bands, mask_file, nesting, trans_matrix, period_name, periods, error_recode=<factory>)

Parameters:

in_df (DataFile)
prod_mode (str)
in_file (str)
out_file (str)
model_band_number (int)
n_out_bands (int)
mask_file (str)
nesting (LCLegendNesting)
trans_matrix (LCTransitionDefinitionDeg)
period_name (str)
periods (dict)
error_recode (Dict | None)

Return type:

None

error_recode: Dict | None

in_df: DataFile

in_file: str

mask_file: str

model_band_number: int

n_out_bands: int

nesting: LCLegendNesting

out_file: str

period_name: str

periods: dict

prod_mode: str

trans_matrix: LCTransitionDefinitionDeg

class SummaryTableCounterbalancing

Accumulated counterbalancing statistics across all land types.

Schema: alias of SummaryTableCounterbalancing

__init__(gains_by_land_type, losses_by_land_type, status_breakdown=None, transition_breakdown=None)

Parameters:

gains_by_land_type (Dict[int, float])
losses_by_land_type (Dict[int, float])
status_breakdown (Dict[int, Dict[int, float]] | None)
transition_breakdown (Dict[int, Dict[int, float]] | None)

Return type:

None

cast_to_cpython()

gains_by_land_type: Dict[int, float]

losses_by_land_type: Dict[int, float]

status_breakdown: Dict[int, Dict[int, float]] | None = None

transition_breakdown: Dict[int, Dict[int, float]] | None = None

class SummaryTableLD

SummaryTableLD(soc_by_lc_annual_totals: List[Dict[int, float]], lc_annual_totals: List[Dict[int, float]], lc_trans_zonal_areas: List[Dict[int, float]], lc_trans_zonal_areas_periods: List[Dict[str, float]], lc_trans_prod_bizonal: Dict[Tuple[int, int], float], sdg_zonal_population_total: Dict[int, float], sdg_zonal_population_male: Dict[int, float], sdg_zonal_population_female: Dict[int, float], sdg_summary: Dict[int, float], prod_summary: Dict[str, Dict[int, float]], lc_summary: Dict[int, float], soc_summary: Dict[str, Dict[int, float]])

Schema: alias of SummaryTableLD

__init__(soc_by_lc_annual_totals, lc_annual_totals, lc_trans_zonal_areas, lc_trans_zonal_areas_periods, lc_trans_prod_bizonal, sdg_zonal_population_total, sdg_zonal_population_male, sdg_zonal_population_female, sdg_summary, prod_summary, lc_summary, soc_summary)

Parameters:

soc_by_lc_annual_totals (List[Dict[int, float]])
lc_annual_totals (List[Dict[int, float]])
lc_trans_zonal_areas (List[Dict[int, float]])
lc_trans_zonal_areas_periods (List[Dict[str, float]])
lc_trans_prod_bizonal (Dict[Tuple[int, int], float])
sdg_zonal_population_total (Dict[int, float])
sdg_zonal_population_male (Dict[int, float])
sdg_zonal_population_female (Dict[int, float])
sdg_summary (Dict[int, float])
prod_summary (Dict[str, Dict[int, float]])
lc_summary (Dict[int, float])
soc_summary (Dict[str, Dict[int, float]])

Return type:

None

cast_to_cpython()

lc_annual_totals: List[Dict[int, float]]

lc_summary: Dict[int, float]

lc_trans_prod_bizonal: Dict[Tuple[int, int], float]

lc_trans_zonal_areas: List[Dict[int, float]]

lc_trans_zonal_areas_periods: List[Dict[str, float]]

prod_summary: Dict[str, Dict[int, float]]

sdg_summary: Dict[int, float]

sdg_zonal_population_female: Dict[int, float]

sdg_zonal_population_male: Dict[int, float]

sdg_zonal_population_total: Dict[int, float]

soc_by_lc_annual_totals: List[Dict[int, float]]

soc_summary: Dict[str, Dict[int, float]]

class SummaryTableLDChange

Records change in land degradation status between baseline and one or more periods

Schema: alias of SummaryTableLDChange

__init__(sdg_crosstabs, prod_crosstabs, lc_crosstabs, soc_crosstabs)

Parameters:

sdg_crosstabs (List[Dict[tuple, float]])
prod_crosstabs (List[Dict[tuple, float]])
lc_crosstabs (List[Dict[tuple, float]])
soc_crosstabs (List[Dict[tuple, float]])

Return type:

None

lc_crosstabs: List[Dict[tuple, float]]

prod_crosstabs: List[Dict[tuple, float]]

sdg_crosstabs: List[Dict[tuple, float]]

soc_crosstabs: List[Dict[tuple, float]]

class SummaryTableLDErrorRecode

SummaryTableLDErrorRecode(baseline_summary: Dict[int, float], report_summaries: Optional[List[Dict[int, float]]] = None, crosstabs: Optional[List] = None)

Schema: alias of SummaryTableLDErrorRecode

__init__(baseline_summary, report_summaries=None, crosstabs=None)

Parameters:

baseline_summary (Dict[int, float])
report_summaries (List[Dict[int, float]] | None)
crosstabs (List | None)

Return type:

None

baseline_summary: Dict[int, float]

crosstabs: List | None = None

report_summaries: List[Dict[int, float]] | None = None

class SummaryTableLDStatus

Records land degradation status for one or more periods

Schema: alias of SummaryTableLDStatus

__init__(sdg_summaries, prod_summaries, lc_summaries, soc_summaries)

Parameters:

sdg_summaries (List[Dict[int, float]])
prod_summaries (List[Dict[str, Dict[int, float]]])
lc_summaries (List[Dict[int, float]])
soc_summaries (List[Dict[str, Dict[int, float]]])

Return type:

None

lc_summaries: List[Dict[int, float]]

prod_summaries: List[Dict[str, Dict[int, float]]]

sdg_summaries: List[Dict[int, float]]

soc_summaries: List[Dict[str, Dict[int, float]]]

accumulate_summary_table_counterbalancing(tables)

Parameters:: tables (List[SummaryTableCounterbalancing])
Return type:: SummaryTableCounterbalancing

accumulate_summarytableld(tables)

Parameters:: tables (List[SummaryTableLD])
Return type:: SummaryTableLD