Package 'rumi'

Close a Rumi dataset

Description

Close a Rumi dataset

Usage

rumi_close(file)

Arguments

file	A dataset returned by rumi_open().

---

Inspect a Rumi dataset

Description

Inspect a Rumi dataset

Usage

rumi_info(file)

Arguments

file	A dataset returned by rumi_open().

---

Open a Rumi source

Description

path and its external header stay paired for every partial read. Opening validates the header against the source and reads its metadata.

Usage

rumi_open(path, header)

Arguments

path	Local path, URI or VSI path.
header	Raw external-header bytes.

Value

A rumi_dataset.

---

Read a partial Rumi array

Description

bands, time and window origins use R's one-based indexing. window is ⁠(row, column, height, width)⁠. The returned Image is ⁠(X, Y, Band)⁠ and a Cube is ⁠(X, Y, Band, Time)⁠, matching R's column-major memory order.

Usage

rumi_read(
  file,
  header = NULL,
  bands = NULL,
  time = NULL,
  window = NULL,
  pattern = NULL
)

Arguments

file	A dataset returned by rumi_open(). Alternatively, a path when header is supplied.
header	External header when file is a path.
bands, time	One-based indices, in output order, or NULL for all.
window	One-based ⁠(row, column, height, width)⁠, or NULL for all.
pattern	Optional Rumi output pattern.

---

Read one window from several Rumi datasets

Description

Read one window from several Rumi datasets

Usage

rumi_read_many(
  files,
  windows = NULL,
  bands = NULL,
  time = NULL,
  pattern = NULL
)

Arguments

files	A list of datasets from rumi_open().
windows	A list or matrix with one ⁠(row, column, height, width)⁠ row per dataset. All windows have the same height and width.
bands, time	One-based indices, in output order, or NULL for all.
pattern	Optional Rumi output pattern.

---