easyidp.data.ForestBirds

class easyidp.data.ForestBirds(*, cache_root=None, notify_missing=True)

Dataset for the forest ecology survey in Florida.

2022_florida_forestbirds.png

  • Author : Prof. Ben Weinstein, The University of Florida

  • Location : Florida, US

  • Flight date : March 24, 2022

  • UAV model : DJI FC6540

  • Image number : 93

  • Image size : 6016 x 4008

  • Software : Metashape

  • Outputs : DOM, DSM

__init__(*, cache_root=None, notify_missing=True)

Create a lightweight handle to the forest birds demo dataset.

The constructor only exposes paths. It does not download files; call download() explicitly when is_ready() returns False.

Accessible path attributes include:

  • .photo : raw image folder

  • .shp : plot ROI shapefile

  • .metashape.project : Metashape project file

  • .metashape.param : Metashape project folder

  • .metashape.dom : Metashape orthomosaic GeoTIFF

  • .metashape.dsm : Metashape digital surface model GeoTIFF

Parameters:

  • cache_root (Path or str, optional) – Root directory for cached datasets. Defaults to idp.config.get("data_dir").

  • notify_missing (bool, optional) – Retained for backward compatibility only; no longer logs warnings.

Examples

>>> fb = idp.data.ForestBirds()
>>> fb.photo
PosixPath('.../2022_florida_forestbirds/Hidden_Little_03_24_2022')

ForestBirds inherits the common dataset API from easyidp.data.dataset.Dataset. The inherited attributes and methods are documented on the hidden Data Advanced API page.

Inherited attributes

Attribute

Description

name

Dataset manifest name.

root

Extracted dataset directory.

Inherited methods

Method

Description

download()

Download and extract the dataset.

dry_run()

Return a JSON-friendly summary without touching the network.

is_ready()

Check whether required dataset files are available.

path()

Resolve a dotted manifest key to an absolute path.