Spread probability for the pixels of one ELF

spreadProbOneELF(
  covs,
  params,
  covMinMax,
  yr,
  maxFireSpread,
  lowerSpreadProb,
  covCentre = NULL,
  climateRef = NULL,
  powerLawGamma = NULL,
  powerLawShape = fireSenseUtils::spreadPowerLawShape,
  link = if (!is.null(powerLawGamma)) "powerLaw",
  lowerAsymptote = fireSenseUtils::spreadProbFloor,
  richardsNu = fireSenseUtils::spreadRichardsNu
)

Arguments

covs

data.table of this ELF's pixels: pixelID and covariates (as fireSense_dataPrepPredict makes them; fuel biomass logged). It can hold more than the fit used (every ELF's covariates, or a term the spread formula has but the fit does not); only the covariates named in params are used.

params

one-row data.frame: the ELF's parameter set for this replicate (paramSetForRep()).

covMinMax

the ELF's covMinMax_spread (ledgerCovMinMax()): the ranges the fit rescaled its covariates with. Every fitted covariate must be a column of it, or it is left unscaled.

yr, maxFireSpread, lowerSpreadProb

as for fireSenseUtils::spreadProbFromIntegerCovs() and fireSenseUtils::logisticAll().

covCentre

the ELF's covCentre_spread (ledgerCovCentre()): the covariate means the fit subtracted from the rescaled covariates; NULL (a fit without an intercept, or an older ledger row) centres nothing. A parameter set with fireSenseUtils::spreadInterceptTxt has an intercept, added as a column of 1s after the covariates are rescaled and centred, as in the fit. A coefficient named a:b is an interaction: covs must have a and b, and fireSenseUtils::spreadProbFromIntegerCovs() multiplies them after each is rescaled and centred (0 where youngAge cleared the fuel), exactly as in the fit.

climateRef

the ELF's climateRef_spread (ledgerClimateRef()): with a fit made with climate outside the maxAsymptote ceiling (fireSense_spreadFit's spreadLink = "climateOutside"), the reference value of each climate covariate; fireSenseUtils::spreadProbFromCovs() then applies that link, exactly as the fit did. NULL (a fit with climate under the ceiling, or an older ledger row) is the link as it always was.

powerLawGamma

the ELF's powerLawGamma_spread (ledgerPowerLawGamma()): with a fit made with fireSense_spreadFit's spreadLink = "powerLaw", its gamma; fireSenseUtils::spreadProbFromCovs() then applies that link (fireSenseUtils::powerLawLink(), with maxAsymptote as p_c), exactly as the fit did. NULL (any other link) is the link as it always was.

powerLawShape

the ELF's powerLawShape_spread (ledgerPowerLawShape()): the shape of the link, with powerLawGamma; 1 (the original link) by default.

the ELF's link when it is one of fireSenseUtils::spreadLinearLinks (ledgerLinkArgs()); NULL (any other link). By default "powerLaw" when powerLawGamma is given, the link of a row written before the others existed.

lowerAsymptote, richardsNu

the ELF's lowerAsymptote_spread and richardsNu_spread (ledgerLowerAsymptote(), ledgerRichardsNu()): with "powerLawSmooth" and "richards", the lower asymptote, and nu of "richards".

Value

data.table with pixelID and spreadProb, from the one parameter set in params; with a link also linearPredictor, the x that spreadProb is the link of.