Skip to main content

lulc-validation

A package to estimate overall accuracy, user's accuracy, and producer's accuracy for a land use / land cover (LULC) map when i) the reference data is generated via a stratified sampling approach, and ii) the strata do not match the map classes.

This package is based on Stehman, S.V. (2014), Estimating area and map accuracy for stratified random sampling when the strata are different from the map classes. International Journal of Remote Sensing, 35, 13.

Install

Clone this repo, then pip install locally.

pip install .

or from PyPi.

pip install lulc-validation

Use

A sample dataset is provided in this repo at data/samples.csv. This is based on Table. 2 in Stehman (2014).

Initialise a StratVal object:

import pandas as pd
import os
from lulc_validation.lulc_val import StratVal

df = pd.read_csv(os.path.join("data", "samples.csv"))

strat_val = StratVal(
    strata_list=[1, 2, 3, 4], # List of labels for strata.
    class_list=[1, 2, 3, 4], # List of labels for LULC map classes.
    n_strata=[40000, 30000, 20000, 10000], # List of the total number of pixels in each strata.
    samples_df=df, # pandas DataFrame of reference data
    strata_col="stratum", # Column label for strata in `samples_df`
    ref_class="ref_class", # Column label for reference classes in `samples_df`
    map_class="map_class" # Column label for map classes in `samples_df`
)

A StratVal object has the following methods:

  • accuracy(): returns a float type number representing the overall accuracy of the LULC map accounting for the stratified sampling design of the reference data. This implementation is based on the worked example of 3. Numerical examples in Stehman (2014).
  • users_accuracy(): returns a dict object where keys indicate the map class and values represent user's accuracy for the corresponding class accounting for the stratified sampling design of the reference data. This implementation is based on the worked example of 3. Numerical examples in Stehman (2014).
  • producers_accuracy(): returns a dict object where keys indicate the map class and values represent producer's accuracy for the corresponding class accounting for the stratified sampling design of the reference data. This implementation is based on the worked example of 3. Numerical examples in Stehman (2014).
  • accuracy_se(): returns the standard error of the estimate of the overall accuracy of the LULC map accounting for the stratified sampling design of the reference data. This implementation is based on the worked example of 3. Numerical examples in Stehman (2014).
  • users_accuracy_se(): returns a dict object where keys indicate the map class and values represent standard errors of the estimates of the user's accuracy for the corresponding class accounting for the stratified sampling design of the reference data. This implementation is based on the worked example of 3. Numerical examples in Stehman (2014).
  • producers_accuracy_se(): returns a dict object where keys indicate the map class and values represent standard errors of the estimates of the producer's accuracy for the corresponding class accounting for the stratified sampling design of the reference data. This implementation is based on the worked example of 3. Numerical examples in Stehman (2014).
print(f"accuracy: {strat_val.accuracy()}")
print(f"user's accuracy: {strat_val.users_accuracy()}")
print(f"producer's accuracy: {strat_val.producers_accuracy()}")
print(f"accuracy se: {strat_val.accuracy_se()}")
print(f"user's accuracy se: {strat_val.users_accuracy_se()}")
print(f"producers's accuracy se: {strat_val.producers_accuracy_se()}")

Development

pytest is used for testing and tests are based on replicating calculations in the worked example of 3. Numerical examples in Stehman (2014).

To run the tests:

pytest

Release files for lulc-validation 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lulc-validation 0.0.4
File Size Uploaded
lulc-validation-0.0.4.tar.gz 5.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lulc-validation 0.0.4
File Interpreter ABI Platform
lulc_validation-0.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 10.7 kB

Release files / lulc-validation-0.0.4.tar.gz

Download URL lulc-validation-0.0.4.tar.gz
Size 5.4 kB
Tags Source
SHA-256 checksum
How to use checksums
b0e040a7c52e790bd2637436c727d589c28b30f828b34ca9407836733db0a137
BLAKE2b-256 checksum
How to use checksums
5693fec1231d178271504220bb08c840e5d6cebefedbb58dda795ea9afc7d354
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release files / lulc_validation-0.0.4-py3-none-any.whl

Download URL lulc_validation-0.0.4-py3-none-any.whl
Size 5.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
30fc75c6c894aa30ce75b1bf40900b075bbc229875e1530da83487ce5c523943
BLAKE2b-256 checksum
How to use checksums
451b6ce400ccff57791adeda6811b2080903b2e73f10eed7374be8cf76f4ccfd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release history Release notifications | RSS feed

This release

0.0.4 This release

2 release files

0.0.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page