initIndex: Index initialization

Description

Check and initialize index. For internal use.

Usage

initIndex(object, index, num, hemisphere = "both", numeric2logical, indexNum = NULL, outline.default, cex.default, pch.default, col.default, filter.default, method)

Arguments

object

an object of class MRIaggr or NULL .

index

the coordinates of additionnal points to display. data.frame or list.

num

the slices to display. numeric vector or NULL.

hemisphere

the hemisphere to display. character.

numeric2logical

if a parameter is specified for the index arguments, should it be converted to logical ? logical.

indexNum

the number associated to the index (for display). numeric.

outline.default

the default display for the spatial group (edge or entire group). logical.

cex.default

the default expansion factor used to plot the observations. numeric.

pch.default

the default label used to plot the observations. numeric.

col.default

the default color used to plot the observations. character vector.

filter.default

the default filter used to define the neighbourhood. character.

method

the name of the function that called the initializer. character.

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.

Possible values for index are:

NULL : the argument is skiped, no additional points are displayed.
character : the name of a logical parameter contained in the object (if called by an MRIaggr method)
data.frame with 3 columns named "i","j","k" containing the coordinates of the points to display.
list with an element named "data" containing the coordinates of the points to display (see previous point) or the name of a logical parameter (if called by an MRIaggr method). It can also contain "cex", "pch" and "col" component to specify the how the points should be displayed. To only display the outline of the spatial group instead of the spatial group itself, the list must contains an element named "outline" that have for value TRUE. The type of neighbourhood used to determine the outline can be specified with a "filter" element in the list. The default neighbourhood is "2D_N4".