popsGetObjectsIds: IFC_pops Object Numbers

View source: R/popsGetObjecstIds.R

popsGetObjectsIdsR Documentation

IFC_pops Object Numbers

Description

Retrieves objects ids belonging to a population.

Usage

popsGetObjectsIds(obj, pop = "")

Arguments

obj

an 'IFC_data' object extracted with features extracted.

pop

a population name from 'obj'. Default is "". If left as is or not found an error is thrown displaying all available population in 'obj'.

Value

An integer vector is returned

Examples

if(requireNamespace("IFCdata", quietly = TRUE)) {
  ## use a daf file
  file_daf <- system.file("extdata", "example.daf", package = "IFCdata")
  daf <- ExtractFromDAF(fileName = file_daf)
  obj <- popsGetObjectsIds(obj = daf, pop = names(daf$pops)[length(daf$pops)])
} else {
  message(sprintf('Please run `install.packages("IFCdata", repos = "%s", type = "source")` %s',
                  'https://gitdemont.github.io/IFCdata/',
                  'to install extra files required to run this example.'))
}

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