get_odim_object_type: Check the 'data' object contained in a ODIM HDF5 file

View source: R/pvolfile.R

get_odim_object_typeR Documentation

Check the data object contained in a ODIM HDF5 file

Description

Checks which data class is contained in a ODIM HDF5 file. See ODIM specification, Table 2 for a full list of existing ODIM file object types.

Usage

get_odim_object_type(file)

Arguments

file

Character. Path of the file to check.

Value

Character. PVOL for polar volume, VP for vertical profile, otherwise NA.

See Also

  • is.pvolfile()

  • is.vpfile()

Examples

# Locate the polar volume example file
pvolfile <- system.file("extdata", "volume.h5", package = "bioRad")

# Check the data type
get_odim_object_type(pvolfile)

bioRad documentation built on Aug. 31, 2022, 1:05 a.m.