MRIaggr-selectNormalization: Extract the normalization values

Description Usage Arguments Details Value See Also Examples

Description

Extract the normalization values from a MRIaggr object.

Usage

1
2
3
## S4 method for signature 'MRIaggr'
selectNormalization(object, type = NULL, mu = TRUE, sigma = TRUE,
         hemisphere = "both", num = NULL, param = NULL)

Arguments

object

an object of class MRIaggr. REQUIRED.

type

the type of normalization. Must be on of "global", "slice", "3slices" or NULL leading to select all types of normalization.

mu

should the centering values for the normalization be returned. logical. Active only if type is "slice" or "3slices".

sigma

should the scaling values for the normalization be returned. logical. Active only if type is "slice" or "3slices".

num

the slices to extract. numeric vector or NULL.

hemisphere

the hemisphere to extract. character.

param

the contrast parameters for which the normalization values should be extracted. character vector or NULL indicating all available contrast parameters.

Details

ARGUMENTS:
Information about the num argument can be found in the details section of initNum.

Information about the hemisphere argument can be found in the details section of selectContrast.

Value

A data.frame or a list.

See Also

calcNormalization to compute and allocate the normalisation values.
allocNormalization<- to alloacte the normalization values when obtained from an external source.
calcHemisphere to identify the hemispheres.
allocHemisphere<- and allocContrast<- to allocate hemispheres obtained from an external source.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
## load a MRIaggr object
data("MRIaggr.Pat1_red", package = "MRIaggr")

## select all normalization values
res <- selectNormalization(MRIaggr.Pat1_red)
names(res)

## select specific normalization normalization values 
# computed on the whole brain
res <- selectNormalization(MRIaggr.Pat1_red, type = "global", 
         mu = TRUE, sigma = FALSE, hemisphere = "both")
# idem but only for DWI_t0
res <- selectNormalization(MRIaggr.Pat1_red, type = "global",
         mu = TRUE, sigma = FALSE, param = "DWI_t0") 

# computed by slice
res <- selectNormalization(MRIaggr.Pat1_red, type="slice", 
         mu = TRUE,sigma = FALSE, hemisphere = "both") 
# idem for slice 1
res <- selectNormalization(MRIaggr.Pat1_red, type = "slice", 
         mu = TRUE, sigma = FALSE, num = 1) 

# computed on 3 consecutive slices
res <- selectNormalization(MRIaggr.Pat1_red, type = "3slices", mu = FALSE, sigma = TRUE, 
                           hemisphere = "left", num = 2, param = "T2_FLAIR_t2")

bozenne/MRIaggr documentation built on May 13, 2019, 1:39 a.m.