The ABE-library The ABE-library

  • API Docs for Version: 1.0

    • APIs

    Show:

    thinning Class

    Defined in: thinning\thinning.js:2
    Module: abe-lib

    The thinning module include activities thinning operations.

    Methods

    fromBelow

    (
    • options
    )
    Object

    Defined in thinning\thinning.js:15

    Thinning from below

    Parameters:

    • options Object
      • id String

        A unique identifier for the thinning activity (default: 'ThinningFromBelow').

      • schedule Object

        schedule for the repeater (default: {min: 30, opt: 40, max: 50}).

      • interval Number

        interval between repeated thinnings (default: 5).

      • times Number

        number of times to repeat the thinning (default: 5).

      • block Boolean

        block other activities in repeater (default: true).

      • mode String

        mode of thinning, either 'simple' or 'dynamic' (default: 'simple').

      • thinningShare Number | Function

        share of trees to be thinned, can be a number or a function returning a number (default: 0.1).

      • thinningClasses Number

        array defining how much of each thinning class should be removed (default: [60, 25, 15, 0, 0]).

      • speciesSelectivity Number | Undefined

        species list, which species should have a lower probability to get harvested (default: undefined).

      • ranking String

        ranking string for filtering trees, e.g. 'volume' (default: 'volume').

      • sendSignal String

        signal for triggering the thinning (default: 'thinning_execute').

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    program - An object describing the thinning program

    Example:

    lib.thinning.fromBelow({
                        schedule: { min: 25, opt: 35, max: 45 },
                        interval: 10,
                        thinningShare: 0.3
                    });

    plenter

    (
    • options
    )
    Object

    Defined in thinning\thinning.js:218

    Plenter thinning operation

    Parameters:

    • options Object
      • id String

        A unique identifier for the thinning activity (default: 'Plenter').

      • schedule Object | Undefined

        schedule for the thinning (default: undefined).

      • times Number

        number of thinning actions (default: 1000).

      • interval Number

        interval between thinning actions (default: 5).

      • plenterCurve Object

        object defining target diameter distribution i.e. plenter curve.

      • dbhSteps Number

        width of dbh classes to compare with plenterCurve (default: 5).

      • intensity Number

        intensity of thinning activity, specifying which share of trees to remove should be removed (default: 1).

      • block Boolean

        block other activities in repeater (default: true).

      • sendSignal String

        signal for triggering the thinning (default: 'plenter_execute').

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    program - An object describing the plenter thinning program

    Example:

    lib.thinning.plenter({
                        interval: 5,
                        plenterCurve: { 10: 350, 20: 150, 30: 80, 40: 40, 50: 20 },
                           dbhSteps: 10
                    });

    selectiveThinning

    (
    • options
    )
    Object

    Defined in thinning\selective.js:1

    Selective thinning operation

    Parameters:

    • options Object
      • id String

        A unique identifier for the thinning activity (default: 'selective_select_trees').

      • schedule Object | Undefined

        schedule for the thinning (default: undefined).

      • mode String

        mode of thinning, either 'simple' or 'dynamic' (default: 'simple').

      • SpeciesMode String

        mode of species selection, either 'simple' or 'dynamic' (default: 'simple').

      • nTrees Number | Function

        number of trees to select, can be a number or a function returning a number (default: 80).

      • nCompetitors Number | Function

        number of competitor trees to select, can be a number or a function returning a number (default: 4).

      • speciesSelectivity Object | Function

        object defining species selectivity, can be an object or a function returning an object (default: {}).

      • preferenceFunction String | Function

        ranking string for selecting trees, can be a string or a function returning a string (default: 'height').

      • interval Number

        interval between repeated thinnings (default: 5).

      • times Number

        number of times to repeat the thinning (default: 5).

      • sendSignal String

        signal send out in each thinning activity (default: 'selective_thinning_remove').

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    program - An object describing the thinning program

    Example:

    lib.thinning.selectiveThinning({
                        schedule: { start: 30, end: 100 },
                        mode: 'dynamic',
                        SpeciesMode: 'dynamic',
                        nTrees: function() { return stand.flag('nTrees') || 100; },
                        nCompetitors: function() { return stand.flag('nCompetitors') || 5; }
                    });

    tending

    (
    • options
    )
    Object

    Defined in thinning\thinning.js:139

    Tending operation

    Parameters:

    • options Object
      • id String

        A unique identifier for the tending activity (default: 'Tending').

      • schedule Object | Undefined

        schedule for the tending (default: undefined).

      • times Number

        number of tending actions (default: 3).

      • interval Number

        interval between tending actions (default: 2).

      • speciesSelectivity Object

        object defining species selectivity, e.g. { 'fasy': 0.9, 'abal': 0.8, 'rest': 0.2 } (default: { 'rest': 0.9 }).

      • intensity Number

        intensity of tending (default: 10).

      • block Boolean

        block other activities in repeater (default: true).

      • sendSignal String

        signal for triggering the tending (default: 'tending_execute').

      • constraint String | Undefined

        constraint (default: undefined).

    Returns:

    Object:

    program - An object describing the tending program

    Example:

    lib.thinning.tending({
                        times: 5,
                        interval: 3,
                        speciesSelectivity: { 'piab': 0.7, 'lade': 0.6 }
                    });