h5reg-utils: Read information about h5reg transformations from file

In natverse/nat.h5reg: Neuroanatomy Toolbox Support for Saalfeld/Bogovic HDF5 Registration Format

Read information about h5reg transformations from file

Description

is.h5reg checks if a file (or bytes in memory) looks like h5reg file.

Usage

read.h5reg.info(x, ...)

is.h5reg(f = NULL, bytes = NULL)

Arguments

x	path to a .h5 file
...	Currently ignored
f	Path to a file on disk
bytes	A set of bytes that are at least as big as the HDF5 magic value.

Details

if bytes is passed a raw byte array, then is.h5reg can do a very quick check to ensure that it is actually an HDF5 file, before inspect the contents of the file itself in more detail.

Value

a named list describing the contents of an h5reg file.

Logical indicating whether the file is an HDF5 encoded registration file ('codeh5reg)

See Also

h5reg

Examples

h5f <- system.file('samples/complexdummyh5reg.h5', package = 'nat.h5reg')
read.h5reg.info(h5f)
is.h5reg(h5f)

natverse/nat.h5reg documentation built on Nov. 20, 2023, 7:52 a.m.