IdBC: IdBC (Identity Bias Correction) method

IdBCR Documentation

IdBC (Identity Bias Correction) method

Description

Always return X1 / X0 as correction.

Details

Only for comparison.

Methods

Public methods


Method new()

Create a new IdBC object.

Usage
IdBC$new()
Returns

A new 'IdBC' object.


Method fit()

Fit the bias correction method

Usage
IdBC$fit(Y0, X0, X1 = NULL)
Arguments
Y0

[matrix: n_samples * n_features] Observations in calibration

X0

[matrix: n_samples * n_features] Model in calibration

X1

[matrix: n_samples * n_features] Model in projection, can be NULL for stationary BC method

Returns

NULL


Method predict()

Predict the correction. Use named keywords to use stationary or non-stationary method.

Usage
IdBC$predict(X1 = NULL, X0 = NULL)
Arguments
X1

[matrix: n_samples * n_features or NULL] Model in projection

X0

[matrix: n_samples * n_features or NULL] Model in calibration

Returns

[matrix or list] Return X1 and / or X0


Method clone()

The objects of this class are cloneable with this method.

Usage
IdBC$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

## Three bivariate random variables (rnorm and rexp are inverted between ref
## and bias)
XY = SBCK::dataset_gaussian_exp_2d(2000)
X0 = XY$X0 ## Biased in calibration period
Y0 = XY$Y0 ## Reference in calibration period
X1 = XY$X1 ## Biased in projection period


## Bias correction
## Step 1 : construction of the class IdBC
idbc = SBCK::IdBC$new() 
## Step 2 : Fit the bias correction model
idbc$fit( Y0 , X0 , X1 )
## Step 3 : perform the bias correction
Z = idbc$predict(X1,X0) 
## Z$Z0 # == X0
## Z$Z1 # == X1

SBCK documentation built on Sept. 11, 2023, 5:10 p.m.

Related to IdBC in SBCK...