Convert a NeuroVol to GDS

Import a single neuroim2::NeuroVol (3D brain volume) as a GDS object. The volume becomes a single subject with a single contrast.

Usage

# S3 method for class 'NeuroVol'
as_gds(
  x,
  assay_name = "beta",
  subject = "subject1",
  contrast = "contrast1",
  mask = NULL,
  ...
)

# S3 method for class 'DenseNeuroVol'
as_gds(
  x,
  assay_name = "beta",
  subject = "subject1",
  contrast = "contrast1",
  mask = NULL,
  ...
)

Arguments

x

A neuroim2::NeuroVol object.

assay_name

Name for the assay (default: "beta").

subject

Subject identifier (default: "subject1").

contrast

Contrast identifier (default: "contrast1").

mask

Optional mask. Can be:

• NULL: use all non-zero voxels as mask

• A NeuroVol: use as binary mask

• A logical array: use directly as mask

• "none": include all voxels (no masking)

...

Additional arguments passed to new_gds().

Value

A gds object with voxel space.

Examples

if (requireNamespace("neuroim2", quietly = TRUE)) {
  sp <- neuroim2::NeuroSpace(c(4, 4, 2), spacing = c(2, 2, 2))
  vol <- neuroim2::NeuroVol(array(rnorm(32), c(4, 4, 2)), sp)
  gds_obj <- as_gds(vol, subject = "sub-01", contrast = "faces")
  print(gds_obj)
}
#> GDS
#>   dims: 32 x 1 x 1 [sample x subject x contrast]
#>   space: voxel dim=4x4x2, storage=packed
#>   subjects: 1 (sub-01)
#>   contrasts: 1 (faces)
#>   assays: beta[location], var[variance]