cpp_cleanse: Matrix Cleanser

View source: R/RcppExports.R

cpp_cleanseR Documentation

Matrix Cleanser

Description

Replaces values in matrix mat according to mask msk. Depending of 'add_noise' parameter, values of 'mat' will be replaced with noise or not.

Arguments

mat

a NumericMatrix.

msk

a IntegerMatrix.

add_noise

bool, whether to add normal noise or not, Rcpp::Rf_rnorm(bg, sd) function is used. Default is true.

bg

double, mean value of the background added if 'add_noise' is true. Default is 0.0.

sd

double, standard deviation of the background added if 'add_noise' is true. Default is 0.0.

Value

a NumericMatrix cleansed according to 'msk'.


IFC documentation built on Sept. 14, 2023, 1:08 a.m.