getImagesValues: RIF/CIF Image Values Extraction

View source: R/getImagesValues.R

getImagesValuesR Documentation

RIF/CIF Image Values Extraction

Description

Extracts the image values from RIF or CIF as what can be found in DAF files

Usage

getImagesValues(
  fileName,
  offsets,
  objects,
  display_progress = FALSE,
  fast = TRUE,
  ...
)

Arguments

fileName

path to file.

offsets

Object of class ‘IFC_offset'. If missing, the default, ’offsets' will be extracted from 'fileName'.
This param is not mandatory but it may allow to save time when exporting repeated image value on same file.

objects

integer vector, IDEAS objects ids numbers to extract.
If missing, the default, images values from all objects will be extracted.

display_progress

whether to display a progress bar. Default is FALSE.

fast

when no 'offsets' are provided whether to fast extract 'objects' or not. Default is TRUE.
Meaning that 'objects' will be extracted expecting that 'objects' are stored in ascending order.
Only apply when 'offsets' are not provided.
Note that a warning will be sent if an object is found at an unexpected order.

...

other arguments to be passed.

Value

A data.frame is returned.


IFC documentation built on Sept. 14, 2023, 1:08 a.m.