metadata.json

The metadata.json file contains JSON metadata on the fire event, and on the implementation of the hazard assessment. The document is intended to (1) document the assessment for the PWFDF user community, and (2) facilitate advanced programmatic interactions with assessment datasets. This page documents the objects and values within this file.

fire

The fire object records metadata about the fire event.

Field	Type	Description
name	String	The name of the fire event
start_date	String	An ISO 8601 date string (YYYY-MM-DD) indicating the starting date of the fire event.
location	String	Provides additional context for the location of the fire. Often records a national forest or county, but this is not guaranteed.
bbox	Object	The WGS-84 bounding box for the fire perimeter.
bbox.left	Number	The longitude of the left edge of the fire perimeter bounding box in WGS-84 decimal degrees.
bbox.right	Number	The longitude of the right edge of the fire perimeter bounding box in WGS-84 decimal degrees.
bbox.bottom	Number	The latitude of the bottom edge of the fire perimeter bounding box in WGS-84 decimal degrees.
bbox.top	Number	The latitude of the top edge of the fire perimeter bounding box in WGS-84 decimal degrees.
area_km2	Number	The area of the fire perimeter in square kilometers.

version

The version object records the purpose for an assessment version. It also records the version of the PWFDF data specification used to produce the assessment.

version	String	The version string for the assessment.
note	String	Provides additional information on the reason for the assessment version.
spec	Object	Records metadata on the version of the PWFDF data specification used to produce the assessment.
spec.version	String	The version string of the PWFDF data specification used to produce the assessment.
spec.doi	String	The DOI of the version of the PWFDF data specification used to produce the assessment.
spec.url	String	A URL linking to the version of the PWFDF data specification used to produce the assessment.

assessment

The assessment object records information on the implementation of the hazard assessment.

Field	Type	Description
date	String	An ISO 8601 date string (YYYY-MM-DD) indicating the date the assessment was run.
implementation	Object	Records information on how the assessment was produced.
bbox	Object	A WGS-84 bounding box for the buffered fire perimeter used to define the analysis domain.
models	Object	Information on the models used to estimate debris-flow hazards.
input_datasets	Object	Provenance information for the datasets used as inputs for the assessment.

implementation

The assessment.implementation object contains fields that document how the assessment was produced.

Field	Type	Description
method	String	Describes the method used to produce the assessment. This will often record a specific version of the ocelote package.
doi	String	A DOI for the method used to produce the assessment.
url	String	A URL linking to the method used to produce the assessment.

bbox

The assessment.bbox object records the WGS-84 bounding box of the buffered fire perimeter used to define the analysis domain.

Field	Type	Description
left	Number	The longitude of the left edge of the buffered fire perimeter bounding box in WGS-84 decimal degrees.
right	Number	The longitude of the right edge of the buffered fire perimeter bounding box in WGS-84 decimal degrees.
bottom	Number	The latitude of the bottom edge of the buffered fire perimeter bounding box in WGS-84 decimal degrees.
top	Number	The latitude of the top edge of the buffered fire perimeter bounding box in WGS-84 decimal degrees.

models

The assessment.models object documents the models used to estimate debris-flow hazards.

Field	Type	Description
likelihood	Object	Documents the model used to estimate debris-flow likelihoods.
volume	Object	Documents the model used to estimate potential sediment volumes.
combined_hazard	Object	Documents the model used to classify combined debris-flow hazards.
rainfall_threshold	Object	Documents the model used to estimate rainfall thresholds.

Each model object will contain the following fields:

Field	Type	Description
name	String	A identifying name for the hazard model.
doi	String	A DOI archiving the model.
url	String	A URL linking to the model.
note	String	Provides additional context on the implementation of the model.
parameters	Object	Documents the design parameters used to run the model.

A given parameters object may include the following fields:

Field	Type	Description
I15	[Number, …]	The list of peak 15-minute rainfall intensities used as design storms for the likelihood, volume, and combined hazard models.
ci	Number	The confidence interval (as a percentage) computed for potential sediment volumes.
durations	[Number, …]	The list of rainfall durations (in minutes) used to estimate rainfall thresholds.
probabilities	[Number, …]	The list of design probabilities (on the interval from 0 to 1) used to estimate rainfall thresholds.

input_datasets

The assessment.input_datasets object documents the provenance of the datasets used as inputs for the hazard assessment.

Field	Type	Description
perimeter	Object	Provenance metadata for the fire perimeter.
dem	Object	Provenance metadata for the digital elevation model.
dnbr	Object	Provenance metadata for the differenced normalized burn ratio raster.
severity	Object	Provenance metadata for the burn severity dataset.
kf	Object	Provenance metadata for the soil KF-factor dataset.
evt	Object	Provenance metadata for the existing vegetation type dataset. Assessments that do not leverage this data will not include an evt field.
retainments	Object	Provenance metadata for debris-retainment feature locations. Assessments that do not leverage retainments will not include a retainments field.
excluded	Object	Provenance metadata for an exclusion mask. Assessments that do not leverage an exclusion mask will not include an excluded field.

All extant dataset objects will include the following field:

Field	Type	Description
source	String	Describes the provenance of the dataset.

Dataset object may also include the following fields:

Field	Type	Description
note	String	Additional context on the provenance of the dataset.
doi	String	A DOI archiving the dataset.
url	String	A URL linking to the dataset.
access_date	String	An ISO 8601 date string (YYYY-MM-DD) indicating the date the dataset was accessed.

Specific datasets may also include the following unique fields:

Field	Type	Description
dem.tiles	[String, …]	A list of tiles leveraged by the input DEM dataset.
evt.water	[Number, …]	A list of EVT classification codes interpreted as representing water features.
evt.developed	[Number, …]	A list of EVT classification codes interpreted as representing human development.