ExtractImages_toMatrix: Shortcut for Batch Images Extraction to Matrices/Arrays

View source: R/ExtractToFuns.R

ExtractImages_toMatrixR Documentation

Shortcut for Batch Images Extraction to Matrices/Arrays

Description

Function to shortcut extraction, normalization and eventually colorization of images to matrix ! excludes mask.

Usage

ExtractImages_toMatrix(..., objects, offsets, display_progress = TRUE)

Arguments

...

arguments to be passed to objectExtract with the exception of 'ifd' and 'bypass'(=TRUE).
/!\ If not any of 'fileName', 'info' and 'param' can be found in '...' then attr(offsets, "fileName_image") will be used as 'fileName' input parameter to pass to objectParam.

objects

integer vector, IDEAS objects ids numbers to use. This argument is not mandatory, if missing, the default, all objects will be used.

offsets

object of class 'IFC_offset'. This argument is not mandatory but it may allow to save time for repeated image export on same file.
If 'offsets' are not provided, extra arguments can also be passed with '...' to getOffsets.

display_progress

whether to display a progress bar. Default is TRUE.

Details

If 'param' is provided in '...', 'param$export'<-"matrix" only will be overwritten.

Value

A list of matrices/arrays of images corresponding to objects extracted.

Note

Arguments of objectExtract will be deduced from ExtractImages_toMatrix input arguments.


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