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

Hestia Schema

import { JSON, SchemaType } from './types';
import { Term } from './Term';
import { TermTermType } from './Term';
export declare enum IndicatorStatsDefinition {
    cycles = "cycles",
    impactAssessments = "impactAssessments",
    modelled = "modelled",
    otherObservations = "otherObservations",
    regions = "regions",
    replications = "replications",
    simulated = "simulated",
    sites = "sites",
    spatial = "spatial"
}
/**
 * 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[];
    all: TermTermType[];
};
/**
 * An emission, resource use, or characterised environmental impact indicator which is expressed per unit of [Product].
 */
export declare class Indicator extends JSON<SchemaType.Indicator> {
    /**
    * A reference to the [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;
    /**
    * The quantity. If an average, it should always be the mean.
    */
    value?: number | null;
    /**
    * An array of random draws from the posterior distribution of the Indicator.
    */
    distribution?: (number)[];
    /**
    * The standard deviation of value.
    */
    sd?: number;
    /**
    * The minimum of value.
    */
    min?: number;
    /**
    * The maximum of value.
    */
    max?: number;
    /**
    * What the descriptive statistics (sd, min, max, and value) are calculated across, or whether they are simulated or the output of a model. Spatial is descriptive statistics calculated across spatial units (e.g., pixels) within a region or country.
    */
    statsDefinition?: IndicatorStatsDefinition;
    /**
    * The number of observations the descriptive statistics are calculated over.
    */
    observations?: number;
    /**
    * A reference to the [Term] describing the method or model for calculating these data. This is a required field for characterised indicators.
    */
    methodModel?: Term;
    /**
    * A free text field, describing the method or model used for calculating these data.
    */
    methodModelDescription?: string;
    /**
    * The [Terms](./Term) describing the [Inputs](./Input) they are associated with.
    */
    inputs?: Term[];
    /**
    * For Emissions created during a [Transformation], the [Term] describing the [Transformation].
    */
    transformation?: Term;
    /**
    * 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](./Site) and [Cycles](./Cycle).
    */
    aggregated?: (string)[];
    /**
    * A list of versions of the aggregation engine corresponding to each aggregated field.
    */
    aggregatedVersion?: (string)[];
}