The ABE-library The ABE-library

  • API Docs for Version: 1.0

    • APIs

    Show:

    harvest Class

    Defined in: harvest\salvage.js:1
    Module: abe-lib

    The harvest library includes management operations related to harvesting.

    Methods

    clearcut

    (
    • options
    )
    Object

    Defined in harvest\harvest.js:84

    Clearcut operation, that removes all trees above a minimum diameter

    Parameters:

    • options Object
      • id String

        A unique identifier for the harvest activity (default: 'Clearcut').

      • schedule Object

        schedule of the harvest (default: { minRel: 0.8, optRel: 1, maxRel: 1.2, force: true }).

      • preferenceFunction String

        ranking string for filtering trees, e.g. 'dbh > 10' (default: 'dbh > 0').

      • finalHarvest String | Undefined

        boolean variable to indeicate, if the activity should be interpreted as final harvest (default: true).

      • sendSignal String | Undefined

        signal send out after activity (default: undefined).

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    act - An object describing the harvest activity

    Example:

    lib.harvest.clearcut({
                        schedule: { minRel: 0.7, optRel: 0.9, maxRel: 1.1, force: true },
                        preferenceFunction: dbh > 5
                    });

    CoppiceWithStandard

    (
    • options
    )
    Object

    Defined in harvest\harvest.js:402

    Coppice with standards management system

    Parameters:

    • options Object
      • targetDBH Number

        target DBH for harvesting (default: 80).

      • nStandards Number

        number of remaining trees per hectare (default: 30).

      • interval Number

        time interval between harvests (default: 20).

      • preferenceFunction String

        ranking string for selecting standards, e.g. 'dbh+100*species=quro' (default: 'dbh').

      • sendSignal String | Undefined

        signal send out after each activity (default: undefined).

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    act - An object describing the harvest activity

    Example:

    lib.harvest.CoppiceWithStandard({
                        targetDBH: 70,
                        nStandards: 40,
                        species: 'fasy'
                    });

    femel

    (
    • options
    )
    Object

    Defined in harvest\femel.js:1

    Femel management system

    Parameters:

    • options Object
      • steps Number

        number of consecutive enlargement steps after start (default: 2).

      • interval Number

        number of years between each step (default: 10).

      • growBy Number

        number of "rings" of 10m cells to grow each step (default: 1).

      • finalHarvest String | Undefined

        boolean variable to indeicate, if the activity should be interpreted as final harvest (default: true).

      • harvestAll String | Undefined

        indicate if all trees outside the femel should be removed after final harvest (default: true).

      • internalSignal String | Undefined

        internal signal to start each femel harvest step (default: 'harvest_femel').

      • sendSignal String | Undefined

        signal send out after final femel harvest activity (default: undefined).

      • schedule Object | Undefined

        schedule object (default: undefined).

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    act - An object describing the harvest activity

    Example:

    lib.harvest.femel({
                        steps: 3,
                        interval: 5,
                        growBy: 2,
                        schedule: { start: 10 }
                    });

    HarvestAllBigTrees

    (
    • options
    )
    Object

    Defined in harvest\harvest.js:35

    Harvest all trees above a certain height threshold

    Parameters:

    • options Object
      • id String

        A unique identifier for the harvest activity (default: 'HarvestAllBigTrees').

      • schedule Object

        schedule of the harvest (default: {absolute: true, opt: 3}).

      • preferenceFunction String

        ranking string for filtering trees, e.g. 'height > 10' (default: 'height > 10').

      • sendSignal String | Undefined

        signal send out after activity (default: undefined).

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    act - An object describing the harvest activity

    Example:

    lib.harvest.HarvestAllBigTrees({
                        schedule: {absolute: true, opt: 5},
                        preferenceFunction: 'height > 15'
                    });

    noManagement

    () Object

    Defined in harvest\harvest.js:15

    No harvest management

    Returns:

    Object:

    act - An object describing the harvest activity

    Example:

    lib.harvest.noManagement();

    salvage

    (
    • options
    )
    Object

    Defined in harvest\salvage.js:6

    Disturbance response and salvaging

    Parameters:

    • options Object
      • id String

        A unique identifier for the salvage activity (default: 'Salvage').

      • schedule Object

        default is simply repeating operation, but can be overwritten.

      • salvageCondition Expression | Undefined

        expression that evaluates for each disturbed tree whether to salvage or not. If empty, no salvaging of trees takes place. Default: undefined.

      • thresholdReset Number

        Value between 0 and 1 indicating a disturbance severity threshold. If disturbance is above the threhold, the stand is reset (see other options). What happens depends on the options clearAll, onClear and sendSignal. Default: 0.5

      • clearAll Boolean | Undefined

        If a stand is reset, a simple clearcut is executed when clearAll is true. Default: false

      • onClear Function | Undefined

        If a stand is reset, this custom function is executed (if provided). Default: undefined

      • thresholdIgnoreDamage Number

        threshold m3 volume/ha. if disturbance below, no further tests are executed. Default: 50

      • sendSignal String | Undefined

        If a stand is reset, then this signal is sent if a value is provided. Default: undefined

    Returns:

    Object:
    • An object describing the salvage activity

    Example:

    lib.harvest.salvage({ salvageCondition: 'dbh>10', 
                                             thresholdReset: 0.5, 
                                             clearAll: true });

    shelterwood

    (
    • options
    )
    Object

    Defined in harvest\harvest.js:152

    Shelterwood harvest system

    Parameters:

    • options Object
      • id String

        A unique identifier for the harvest activity (default: 'Shelterwood').

      • schedule Object

        schedule of the harvest (default: { minRel: 0.7, optRel: 0.8, maxRel: 0.9, force: true }).

      • nTrees Number

        Number of seed trees to select (default: 40).

      • nCompetitors Number

        Number of other trees to select - should be all remaining trees and thus really high (default: 1000).

      • speciesSelectivity Object

        species selectivity object (default: {}).

      • preferenceFunction String

        ranking string for selecting seed trees, e.g. 'height' (default: 'height').

      • interval Number

        interval between repeated harvests (default: 5).

      • times Number

        number of repeated harvests (default: 3).

      • finalHarvest String | Undefined

        boolean variable to indeicate, if the activity should be interpreted as final harvest (default: true).

      • internalSignal String | Undefined

        internal signal to start each shelterwood activity (default: 'Shelterwood_remove').

      • sendSignal String | Undefined

        signal send out after last shelterwood activity (default: undefined).

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    program - An object describing the harvest program

    Example:

    lib.harvest.shelterwood({
                        schedule: { minRel: 0.6, optRel: 0.7, maxRel: 0.8, force: true },
                        nTrees: 50,
                        speciesSelectivity: { 'pisy': 1, 'abal': 0.5 }
                    });

    stripCut

    (
    • options
    )
    Object

    Defined in harvest\harvest.js:303

    Strip cut system

    Parameters:

    • options Object
      • id String

        A unique identifier for the harvest activity (default: 'StripCut').

      • harvestDirection Number

        direction of the strips in degrees (not working yet) (default: 120).

      • stripWidth Number

        width of each strip in meters (default: 30).

      • nStrips Number

        number of strips before the next strip is a "first" strip again (default: 5).

      • harvestIntensities Number

        array of harvest intensities for each harvest on the strip (default: [0.7, 0.5, 1]).

      • interval Number

        number of years between each harvest activity (default: 5).

      • sendSignal String | Undefined

        signal send out after each activity (default: undefined).

      • constraint String

        constraint, which strips should be harvested e.g. "topHeight>30" (default: "stand.topHeight>30").

    Returns:

    Object:

    act - An object describing the harvest activity

    Example:

    lib.harvest.stripCut2({
                        harvestDirection: 180,
                        stripWidth: 25,
                        harvestIntensities: [0.5, 0.7, 1],
                        constraint: "stand.basalArea>30"
                    });

    targetDBH

    (
    • options
    )
    Object

    Defined in harvest\harvest.js:468

    Target diameter harvesting system

    Parameters:

    • options Object
      • schedule Object | Undefined

        schedule for the harvest (default: undefined).

      • targetDBH Number

        target DBH for harvesting (default: 50).

      • times Number

        time interval between harvests (default: 5).

      • dbhList Object

        object with DBH thresholds per species (default: {}).

      • sendSignal String | Undefined

        signal send out after each activity (default: undefined).

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    act - An object describing the harvest activity

    Example:

    lib.harvest.targetDBH({
                        targetDBH: 60,
                        times: 10,
                        dbhList: { 'fasy': 50, 'abal': 55 }
                    });

    targetDBHforNo3

    (
    • options
    )
    Object

    Defined in harvest\harvest.js:552

    Target diameter harvesting system for Norway Spruce (No)

    Parameters:

    • options Object
      • targetDBH Number

        target DBH for harvesting (default: 50).

      • times Number

        time interval between harvests (default: 5).

      • dbhList Object

        object with DBH thresholds per species (default: {}).

      • sendSignal String | Undefined

        signal send out after each activity (default: undefined).

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    act - An object describing the harvest activity

    Example:

    lib.harvest.targetDBHforNo3({
                        targetDBH: 55,
                        times: 8,
                        dbhList: { 'fasy': 45, 'abal': 60 }
                    });