Restoration Status Summary#

Restoration Status Summary (RSS) computes patch-based connectivity indices for a binary raster map. RSS characterises the spatial structure of the foreground by analysing the size distribution of individual patches, providing a set of indices that quantify landscape connectivity and restoration potential. Further details about Restoration Status Summary analysis are available in the RSS product sheet.

Connectivity Indices#

RSS computes the following indices:

RSS connectivity indices.#

Full Name

Code

Unit

Description

Critical New Object Area

CNOA

pixels

Minimum area of a new patch that would increase connectivity

Equivalent Connected Area

ECA

pixels

Area of a single patch providing the same connectivity as observed

Reference Area Coverage

RAC

%

Percentage of foreground relative to total foreground and background

Coherence

COH

%

Percentage of foreground pixels effectively connected

Restoration Potential

REST_POT

%

Percentage of foreground pixels that could improve connectivity (100 - COH)

Usage#

import pyguidos as pg

result = pg.rss(
    in_tiff="my_map.tif",
    outdir="output/",
    stat_files=True,
    verb=False
)

Parameters#

Parameter

Type

Default

Description

in_tiff

str or Path

–

Path to input GeoTIFF

outdir

str or Path

None

Output directory

stat_files

bool

True

Write statistics to files

verb

bool

False

Print progress messages

Output Files#

File

Description

<name>_rss.txt

Statistics report with all connectivity indices

Result Object#

rss() returns an RssResult dataclass:

result = pg.rss("my_map.tif")

# Access statistics
print(result.stats.keys())
# dict_keys(['output paths', 'input stats', 'output stats'])

# Input pixel counts
print(result.stats["input stats"])
# {'foreground pxl': 12500, 'background pxl': 37500,
#  'missing pxl': 0, 'backgr3 pxl': 0, 'backgr4 pxl': 0}

# Connectivity indices
print(result.stats["output stats"])
# {'total patches': 142, 'average patch size': 88.0,
#  'median patch size': 12.0, 'largest patch size': 8542,
#  'ECA': 8764.3, 'COH': 70.1, 'CNOA': 3, 'REST_POT': 29.9, 'RAC': 25.0}

# Output file paths
print(result.stats["output paths"])
# {'path txt': 'output/my_map_rss.txt'}

Note

result.stats["output paths"] is None when stat_files=False. All other keys are always populated regardless of stat_files.

Patch Statistics#

In addition to the connectivity indices, RSS also reports basic patch size statistics:

  • Total patches: total number of foreground patches

  • Average patch size: mean patch size in pixels

  • Median patch size: median patch size in pixels

  • Largest patch size: size of the largest patch in pixels