linkOTB: Locate and set up 'Orfeo ToolBox' API bindings

In link2GI: Linking Geographic Information Systems, Remote Sensing and Other Command Line Tools

Locate and set up 'Orfeo ToolBox' API bindings

Description

Locate and set up 'Orfeo ToolBox' API bindings

Usage

linkOTB(
  bin_OTB = NULL,
  root_OTB = NULL,
  type_OTB = NULL,
  searchLocation = NULL,
  ver_select = FALSE,
  quiet = TRUE,
  returnPaths = TRUE
)

Arguments

bin_OTB	string contains path to where the otb binaries are located
root_OTB	string provides the root folder of the bin_OTB
type_OTB	string
searchLocation	string hard drive letter (Windows) or mounting point (Linux) default for Windows is C:, default for Linux is ~
ver_select	Boolean, default is FALSE. If there is more than one 'OTB' installation and ver_select = TRUE the user can interactively select the preferred 'OTB' version, conversely if FALSE the latest version is automatically selected.
quiet	Boolean switch for suppressing messages default is TRUE
returnPaths	Boolean, if set to FALSE the paths of the selected version are written. in the PATH variable only, otherwise all paths and versions of the installed OTB versions are returned.

Details

It looks for the otb_cli.bat file. If the file is found in a bin folder it is assumed to be a valid 'OTB' binary installation.

if called without any parameter linkOTB() it performs a full search over the hard drive C:. If it finds one or more 'OTB' binaries it will take the first hit. You have to set ver_select = TRUE for an interactive selection of the preferred version.

Value

add otb paths to the environment and creates global variables path_OTB

Note

You may also set the path manually. Using a 'OSGeo4W64' https://trac.osgeo.org/osgeo4w/ installation it is typically C:/OSGeo4W64/bin/

Author(s)

Chris Reudenbach

Examples

## Not run: 
# call if you do not have any idea if and where OTB is installed
otb<-linkOTB()
if (otb$exist) {
# call it for a default OSGeo4W installation of the OTB
print(otb)
}

## End(Not run)

link2GI documentation built on Oct. 28, 2024, 5:06 p.m.