@hestia-earth/schema/Indicator.d.ts

HESTIA Schema

import { JSON, SchemaType } from './types';
import { Term } from './Term';
import { Source } from './Source';
import { TermTermType } from './Term';
export declare enum IndicatorStatsDefinition {
    animals = "animals",
    cycles = "cycles",
    impactAssessments = "impactAssessments",
    modelled = "modelled",
    'other observations' = "other observations",
    regions = "regions",
    replications = "replications",
    simulated = "simulated",
    sites = "sites",
    spatial = "spatial",
    time = "time"
}
export declare enum IndicatorMethodTier {
    background = "background",
    measured = "measured",
    'not relevant' = "not relevant",
    'tier 1' = "tier 1",
    'tier 2' = "tier 2",
    'tier 3' = "tier 3"
}
/**
 * Contains all the TermTermType with override on the Indicator.
 * Note: it does not contain the default TermTermType on related Blank Nodes.
 */
export declare const indicatorTermTermType: {
    term: TermTermType[];
    methodModel: TermTermType[];
    operation: TermTermType[];
    landCover: TermTermType[];
    previousLandCover: TermTermType[];
    country: TermTermType[];
    key: TermTermType[];
    inputs: TermTermType[];
    animals: TermTermType[];
    all: TermTermType[];
};
/**
 * Contains all the fields that make the blank nodes unique.
 */
export declare const indicatorUniquenessFields: {
    inputs: string[];
    animals: string[];
};
/**
 * An emission, resource use, or characterised environmental impact indicator. Each Indicator must be unique, and the fields which determine uniqueness are defined in the <code>[emissionsResourceUse](/schema/ImpactAssessment#emissionsResourceUse)</code>, <code>[impacts](/schema/ImpactAssessment#impacts)</code>, and <code>[endpoints](/schema/ImpactAssessment#endpoints)</code> fields of the Impact Assessment.
 */
export declare class Indicator extends JSON<SchemaType.Indicator> {
    /**
    * A reference to the [Term](/schema/Term) describing the emission e.g., [CH4, to air, crop residue burning](/term/ch4ToAirCropResidueBurning); the resource use e.g., [Freshwater withdrawals, during Cycle](/term/freshwaterWithdrawalsDuringCycle); or the characterised environmental impact indicator e.g., [Terrestrial ecotoxicity potential (1,4-DCBeq)](/term/terrestrialEcotoxicityPotential14Dcbeq).
    */
    term?: Term;
    /**
    * For certain emissions (`Pesticide, to ...`, `Ionising compounds, to`, and `Heavy metals, to...`) the element or compound that was emitted.
    */
    key?: Term;
    /**
    * The quantity. If an average, it should always be the mean.
    */
    value?: number;
    /**
    * An array of up to 1000 random samples from the posterior distribution of <code>[value](/schema/Indicator#value)</code. This should describe the entire distribution of the dataset and not the distribution of the mean.
    */
    distribution?: (number)[];
    /**
    * The standard deviation of <code>[value](/schema/Indicator#value)</code>.
    */
    sd?: number;
    /**
    * The minimum of <code>[value](/schema/Indicator#value)</code>.
    */
    min?: number;
    /**
    * The maximum of <code>[value](/schema/Indicator#value)</code>.
    */
    max?: number;
    /**
    * What the descriptive statistics (<code>[sd](/schema/Indicator#sd)</code>, <code>[min](/schema/Indicator#min)</code>, <code>[max](/schema/Indicator#max)</code>, and <code>[value](/schema/Indicator#value)</code>) are calculated across, or whether they are simulated or the output of a model. <code>spatial</code> refers to descriptive statistics calculated across spatial units (e.g., pixels) within a region or country. <code>time</code> refers to descriptive statistics calculated across units of time (e.g., hours).
    */
    statsDefinition?: IndicatorStatsDefinition;
    /**
    * The number of observations the descriptive statistics are calculated over.
    */
    observations?: number;
    /**
    * For emissions only, a field which matches the <code>[methodTier](/schema/Emission#methodTier)</code> in each Cycle Emission.
    */
    methodTier?: IndicatorMethodTier;
    /**
    * A reference to the [Term](/schema/Term) describing the method or model for calculating these data.
    */
    methodModel?: Term;
    /**
    * A free text field, describing the method or model used for calculating these data. For example, it can be used to specify the version of the method or model, and/or the software used to carry out the assessment.
    */
    methodModelDescription?: string;
    /**
    * For [emissions or resource uses](/schema/ImpactAssessment#emissionsResourceUse) from [Inputs production](/glossary?page=1&query=inputs%20production), the [Term](/schema/Term) describing the Input. For [characterised indicators](/schema/ImpactAssessment#impacts) or [endpoint indicators](/schema/ImpactAssessment#endpoints), if this Indicator represents the quantity of that indicator caused by producing one or more Inputs used by this Cycle, the [Term](/schema/Term) describing the Inputs.
    */
    inputs?: Term[];
    /**
    * For background Emissions, the [Term(s)](/schema/Term) describing the [Animal(s)](/schema/Animal) they are associated with.
    */
    animals?: Term[];
    /**
    * For indicators describing an emission or resource use related to inputs production, the [country](/glossary?termType=region) where the impacts occurred.
    */
    country?: Term;
    /**
    * For [emissions or resource uses](/schema/ImpactAssessment#emissionsResourceUse) created by an [operation](/glossary?termType=operation), the [Term](/schema/Term) describing the operation.
    */
    operation?: Term;
    /**
    * For [land occupation and transformation](/glossary?termType=resourceUse&query=land), the term from the [land cover](/glossary?termType=landCover) glossary that describes the current land cover of the occupied land (e.g., [Cropland](/term/cropland) or [Almond tree](/term/cropland)). This is a required field for land occupation and land transformation resource uses.
    */
    landCover?: Term;
    /**
    * For [land transformation](/glossary?termType=resourceUse&query=transformation) only, the [land cover](/glossary?termType=landCover) term that describes the previous land cover of the transformed land. The transformation period is defined by the term (e.g., 20 years, 100 years). If the land was transformed from multiple different land covers (e.g., 50% from forest to cropland and 50% from cropland to cropland), create one Indicator for each transformation. This is a required field for land transformation resource uses.
    */
    previousLandCover?: Term;
    /**
    * For [emissions or resource uses](/schema/ImpactAssessment#emissionsResourceUse) created during a [Transformation](/schema/Transformation), the [Term](/schema/Term) describing the Transformation.
    */
    transformation?: Term;
    /**
    * A reference to the [Source](/schema/Source) of these data.
    */
    source?: Source;
    /**
    * A list of references to any other [sources](/schema/Source) of these data.
    */
    otherSources?: Source[];
    /**
    * The version of the schema when these data were created.
    */
    schemaVersion?: string;
    /**
    * A list of fields that have been added to the original dataset.
    */
    added?: (string)[];
    /**
    * A list of versions of the model used to add these fields.
    */
    addedVersion?: (string)[];
    /**
    * A list of fields that have been updated on the original dataset.
    */
    updated?: (string)[];
    /**
    * A list of versions of the model used to update these fields.
    */
    updatedVersion?: (string)[];
    /**
    * A list of fields that have been 'aggregated' using data from multiple [Sites](/schema/Site) and [Cycles](/schema/Cycle).
    */
    aggregated?: (string)[];
    /**
    * A list of versions of the aggregation engine corresponding to each aggregated field.
    */
    aggregatedVersion?: (string)[];
}