Skip to contents

Saves a NeuroVol to an HDF5 file with minimal necessary metadata to reconstruct an H5NeuroVol.

Usage

# S4 method for class 'NeuroVol'
as_h5(
  object,
  file = NULL,
  data_type = "FLOAT",
  chunk_dim = NULL,
  compression = 6
)

Arguments

object

A NeuroVol object (3D)

file

Path to the output file (if NULL, uses tempfile)

data_type

Character: "FLOAT", "DOUBLE", "INT", etc.

chunk_dim

Numeric vector specifying chunk sizes

compression

Integer [1..9], default 6

Value

A new H5NeuroVol referencing the written file. The returned object contains an open read-mode HDF5 handle. **Important:** The user is responsible for closing this handle using close() on the returned object when finished.