allocNormalization: Allocate normalization values

Description

Allocate normalization values to a MRIaggr object.

Usage

"allocNormalization"(object,  overwrite = FALSE, verbose = optionsMRIaggr("verbose")) <- value

Arguments

object

an object of class MRIaggr. REQUIRED.

value

the normalisation values. A list of data.frame. REQUIRED.

overwrite

if normalization values are already stored in object, can they be overwritten ? logical.

verbose

should the execution of the function be traced ? logical.

Value

None.

Details

ARGUMENTS: To enable other methods of the package to use the normalization values the value argument should match the result of the calcNormalization function. This function only partially control the validity of the value argument. A valid value argument should be composed a list of data.frame with the following names :

"norm_global" : it should have 6 rows named "mu_both" "mu_left" "mu_right" "sigma_both" "sigma_left" "sigma_right".
"normMu_slice_both" :
"normSigma_slice_both"
"normMu_slice_left"
"normSigma_slice_left"
"normMu_slice_right"
"normSigma_slice_right"
"normMu_3slices_both"
"normSigma_3slices_both"
"normMu_3slices_left"
"normSigma_3slices_left"
"normMu_3slices_right"
"normSigma_3slices_right".

All the elements of the list must have column names that match the contrast parameters present in the object. Appart from the first element of the list, all elements should have as many rows as slices contained in the object.

Examples

Run this code

## load a MRIaggr object
data("MRIaggr.Pat1_red", package = "MRIaggr")

## parameters to normalize
param <- c("DWI_t0","T2_FLAIR_t2","T2_GRE_t0","TTP_t0")

## manual allocation
resNormalization <- calcNormalization(MRIaggr.Pat1_red, param = param)
allocNormalization(MRIaggr.Pat1_red, overwrite = TRUE) <- resNormalization

## automatic allocation
resNormalization <- calcNormalization(MRIaggr.Pat1_red, param = param,
                                      update.object = TRUE, overwrite = TRUE)