read.nrrd: Read NRRD files/headers into memory

In natverse/nat: NeuroAnatomy Toolbox for Analysis of 3D Image Data

Read NRRD files/headers into memory

Description

read.nrrd reads data into a raw array. If you wish to generate a im3d object that includes spatial calibration (but is limited to representing 3D data) then you should use read.im3d.

nrrd.datafiles returns the path to the separate data files listed in a detached NRRD header file.

Usage

read.nrrd(
  file,
  origin = NULL,
  ReadData = TRUE,
  AttachFullHeader = TRUE,
  Verbose = FALSE,
  ReadByteAsRaw = c("unsigned", "all", "none")
)

read.nrrd.header(file, Verbose = FALSE)

nrrd.datafiles(file, full.names = TRUE)

Arguments

file	Path to a nrrd (or a connection for read.nrrd.header)
origin	Add a user specified origin (x,y,z) to the returned object
ReadData	When FALSE just return attributes (i.e. the nrrd header)
AttachFullHeader	Include the full nrrd header as an attribute of the returned object (default TRUE)
Verbose	Status messages while reading
ReadByteAsRaw	Either a character vector or a logical vector specifying when R should read 8 bit data as an R raw vector rather than integer vector.
full.names	Whether to return the full paths to each data file (by analogy with list.files)

Details

ReadByteAsRaw="unsigned" (the default) only reads unsigned byte data as a raw array. This saves quite a bit of space and still allows data to be used for logical indexing.

Value

An array object, optionally with attributes from the nrrd header.

A list with elements for the key nrrd header fields

See Also

write.nrrd, read.im3d

Other nrrd: is.nrrd(), nrrd.voxdims(), write.nrrd()

natverse/nat documentation built on Feb. 19, 2024, 7:19 a.m.