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

HESTIA Schema

import { JSON, SchemaType } from './types';
import { Term } from './Term';
import { Property } from './Property';
import { Site } from './Site';
import { Source } from './Source';
import { TermTermType } from './Term';
export declare enum EmissionStatsDefinition {
    animals = "animals",
    cycles = "cycles",
    modelled = "modelled",
    'other observations' = "other observations",
    regions = "regions",
    replications = "replications",
    simulated = "simulated",
    sites = "sites",
    spatial = "spatial",
    time = "time"
}
export declare enum EmissionMethodTier {
    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 Emission.
 * Note: it does not contain the default TermTermType on related Blank Nodes.
 */
export declare const emissionTermTermType: {
    term: TermTermType[];
    inputs: TermTermType[];
    animals: TermTermType[];
    methodModel: TermTermType[];
    country: TermTermType[];
    key: TermTermType[];
    all: TermTermType[];
};
/**
 * Contains all the fields that make the blank nodes unique.
 */
export declare const emissionUniquenessFields: {
    properties: string[];
    inputs: string[];
    animals: string[];
    transport: string[];
};
/**
 * A chemical flow into water, soil, or air occurring during a [Cycle](/schema/Cycle) or [Transformation](/schema/Transformation). Each Emission must be unique and the fields which determine uniqueness are defined in the <code>[emissions](/schema/Cycle#emissions)</code> field of the Cycle or [Transformation](/schema/Transformation#emissions).
 */
export declare class Emission extends JSON<SchemaType.Emission> {
    /**
    * A reference to the [Term](/schema/Term) describing the [Emission](/glossary?termType=emission).
    */
    term?: Term;
    /**
    * A description of the Emission.
    */
    description?: string;
    /**
    * For certain emissions (`Pesticide, to ...`, `Ionising compounds, to`, and `Heavy metals, to...`) the element or compound that was emitted.
    */
    key?: Term;
    /**
    * The quantity of the Emission. If an average, it should always be the mean. Can be a single number (array of length one) or an array of numbers with associated <code>[dates](/schema/Emission#dates)</code> (e.g., representing multiple measurements over time).
    */
    value?: (number | null)[];
    /**
    * An array of up to 1000 random samples from the posterior distribution of <code>[value](/schema/Emission#value)</code. This should describe the entire distribution of the dataset and not the distribution of the mean. Multiple arrays can be nested where each array corresponds to a date from the <code>[dates](/schema/Emission#dates)</code> field.
    */
    distribution?: (number)[] | number[][];
    /**
    * The standard deviation of value.
    */
    sd?: (number | null)[];
    /**
    * The minimum of value.
    */
    min?: (number | null)[];
    /**
    * The maximum of value.
    */
    max?: (number | null)[];
    /**
    * The 10th percentile of <code>[value](/schema/Emission#value)</code>.
    */
    percentile10th?: number;
    /**
    * The 90th percentile of <code>[value](/schema/Emission#value)</code>.
    */
    percentile90th?: number;
    /**
    * What the descriptive statistics (<code>[sd](/schema/Emission#sd)</code>, <code>[min](/schema/Emission#min)</code>, <code>[max](/schema/Emission#max)</code>, and <code>[value](/schema/Emission#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?: EmissionStatsDefinition;
    /**
    * The number of observations the descriptive statistics are calculated over.
    */
    observations?: (number | null)[];
    /**
    * A corresponding array to <code>[value](/schema/Emission#value)</code>, representing the dates of the Emissions in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, YYYY, --MM-DD, --MM, or YYYY-MM-DDTHH:mm:ssZ).
    */
    dates?: (string)[];
    /**
    * For Emissions over periods, the start date of the Emission if different from the start date of the [Cycle](/schema/Cycle) in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
    */
    startDate?: string;
    /**
    * For Emissions over periods, the end date of the Emission if different from the end date of the [Cycle](/schema/Cycle) in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
    */
    endDate?: string;
    /**
    * The duration of the Emissions in days, particularly used for measured Emissions.
    */
    emissionDuration?: number;
    /**
    * For soil Emissions, the upper (shallower) depth at which the Emission was recorded in centimeters, using positive numbers.
    */
    depthUpper?: number;
    /**
    * For soil Emissions, the lower (deeper) depth at which the Emission was recorded in centimeters, using positive numbers.
    */
    depthLower?: number;
    /**
    * <ul class="is-pl-3 is-list-style-disc">  <li>
      <code>background</code> data refer to emissions which do not occur in the
      current [Cycle](/schema/Cycle). They are either drawn from external, secondary, and often
      aggregated datasets such as [ecoinvent](https://www.ecoinvent.org/) or are
      drawn from a linked [Impact Assessment](/schema/Input#impactAssessment).
    </li>
    <li>
      <code>measured</code> refers to emissions which are quantified using physical
      measurement. Terms to describe the measurement technique are contained in the
      [measurement](/glossary?page=1&termType=methodEmissionResourceUse) glossary.
    </li>
    <li>
      <code>tier 1</code> models quantify emissions from activity data (i.e., data on
      [Inputs](/schema/Input), [Practices](/schema/Practice), etc.) using a simple equation with
      parameters which are not country or region specific.
    </li>
    <li>
      <code>tier 2</code> models quantify emissions from activity data using a
      simple equation, often of the same form as the <code>tier 1</code> model, but with
      geographically specific parameters.
    </li>
    <li>
      <code>tier 3</code> models quantify emissions from activity data but use
      equations or algorithms that differ from <code>tier 1</code> and
      <code>tier 2</code> approaches. These approaches include process based models
      and statistical models with various forms.
    </li>
    <li>
      <code>not relevant</code> means this emission is not relevant and in this case
      <code>[value](/schema/Emission#value) = 0</code>.
    </li>
  </ul>
    */
    methodTier?: EmissionMethodTier;
    /**
    * A reference to the [Term](/schema/Term) describing the [method](/glossary?termType=methodEmissionResourceUse) for measuring the Emission or the [model](/glossary?termType=model) used to calculate it.
    */
    methodModel?: Term;
    /**
    * A free text field, describing the [method](/glossary?termType=methodEmissionResourceUse) for measuring the Emission or the [model](/glossary?termType=model) used to calculate it.
    */
    methodModelDescription?: string;
    /**
    * A list of [Properties](/schema/Property) of the Emission, which would override any default properties specified in the <code>[term](/schema/Emission#term)</code>.
    */
    properties?: Property[];
    /**
    * For background Emissions, the [Term(s)](/schema/Term) describing the [Inputs](/schema/Input) they are associated with. This is a required field for background Emissions.
    */
    inputs?: Term[];
    /**
    * For background Emissions, the [Term(s)](/schema/Term) describing the [Animal(s)](/schema/Animal) they are associated with.
    */
    animals?: Term[];
    /**
    * For Emissions created by [transport](/glossary?termType=transport), the [Term(s)](/schema/Term) describing the transport.
    */
    transport?: Term[];
    /**
    * For Emissions created by an [operation](/glossary?termType=operation), the [Term](/schema/Term) describing the operation.
    */
    operation?: Term;
    /**
    * For Emissions created during a [Transformation](/schema/Transformation), the [Term](/schema/Term) describing the [Transformation](/schema/Transformation).
    */
    transformation?: Term;
    /**
    * If the Cycle occurred on multiple [Sites](/schema/Site), the Site where this Emission occurred.
    */
    site?: Site;
    /**
    * The country from the [Glossary](/glossary?termType=region), following [GADM](https://gadm.org/) naming conventions. This is for background emissions (emissions from inputs production) only.
    */
    country?: Term;
    /**
    * A reference to the [Source](/schema/Source) of these data, if different from the <code>[defaultSource](/schema/Cycle#defaultSource)</code> of the [Cycle](/schema/Cycle).
    */
    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 [Cycles](/schema/Cycle).
    */
    aggregated?: (string)[];
    /**
    * A list of versions of the aggregation engine corresponding to each aggregated field.
    */
    aggregatedVersion?: (string)[];
    /**
    * Indicates if this emission has been marked as deleted from the original dataset.
    */
    deleted?: boolean;
}