Header menu logo bristlecone

PlantIndividual Module

Types

Type Description

PlantIndividual<'growth, 'date, 'timeunit, 'timespan>

A representation of a plant individual and
 the environmental conditions local to it.

Trait<'date, 'timeunit, 'timespan>

Functions and values

Function or value Description

PlantIndividual.bound plant

Full Usage: PlantIndividual.bound plant

Parameters:
Returns: PlantIndividual<'u, 'a, 'b, 'c>
plant : PlantIndividual<'u, 'a, 'b, 'c>
Returns: PlantIndividual<'u, 'a, 'b, 'c>

PlantIndividual.commonTimeline plant

Full Usage: PlantIndividual.commonTimeline plant

Parameters:
Returns: PlantIndividual<'u, 'a, 'b, 'c>
Where a plant has associated environmental data, only keep observations
 where growth and environment time-series are present.
plant : PlantIndividual<'u, 'a, 'b, 'c>
Returns: PlantIndividual<'u, 'a, 'b, 'c>

PlantIndividual.enforceMinimumSize minSize plant

Full Usage: PlantIndividual.enforceMinimumSize minSize plant

Parameters:
Returns: PlantIndividual<'growthUnit, 'date, 'timeunit, 'timespan>
minSize : float<'growthUnit>
plant : PlantIndividual<'growthUnit, 'date, 'timeunit, 'timespan>
Returns: PlantIndividual<'growthUnit, 'date, 'timeunit, 'timespan>

PlantIndividual.tailGrowth plant

Full Usage: PlantIndividual.tailGrowth plant

Parameters:
Returns: PlantIndividual<'growthUnit, 'date, 'timeunit, 'timespan>
plant : PlantIndividual<'growthUnit, 'date, 'timeunit, 'timespan>
Returns: PlantIndividual<'growthUnit, 'date, 'timeunit, 'timespan>

PlantIndividual.toSubannual plant

Full Usage: PlantIndividual.toSubannual plant

Parameters:
Returns: PlantIndividual<'growthUnit, DateTime, int<MeasureProduct<year, MeasureOne>>, TimeSpan>

Adapt an annual dendro-series to work with sub-annual resolution environmental data. Assumes that growth rings are discrete and that annual wood production has ended by 31st December (i.e. northern hemisphere).

plant : PlantIndividual<'growthUnit, Annual, int<MeasureProduct<year, MeasureOne>>, int<MeasureProduct<year, MeasureOne>>>
Returns: PlantIndividual<'growthUnit, DateTime, int<MeasureProduct<year, MeasureOne>>, TimeSpan>

PlantIndividual.zipEnvironment envName envData plant

Full Usage: PlantIndividual.zipEnvironment envName envData plant

Parameters:
Returns: PlantIndividual<'growthUnit, 'date, 'timeunit, 'timespan>
Attach an environmental time-series to a plant individual,
 for example for a local environmental condition or resource.
envName : StateId<'u>
envData : TimeSeries<float<'u>, 'date, 'timeunit, 'timespan>
plant : PlantIndividual<'growthUnit, 'date, 'timeunit, 'timespan>
Returns: PlantIndividual<'growthUnit, 'date, 'timeunit, 'timespan>

PlantIndividual.zipEnvironments envName env plants

Full Usage: PlantIndividual.zipEnvironments envName env plants

Parameters:
Returns: PlantIndividual<'v, 'a, 'b, 'c> seq
Assigns local environmental conditions to each plant in a sequence,
 given a sequence of environmental time-series where each time-series
 has the code of the plant associated with it.
envName : StateId<'u>
env : (string * TimeSeries<float<'u>, 'a, 'b, 'c>) seq
plants : PlantIndividual<'v, 'a, 'b, 'c> seq
Returns: PlantIndividual<'v, 'a, 'b, 'c> seq

Type something to start searching.