segmentAnalysis: Segment Analysis

View source: R/segmentAnalysis.R

segmentAnalysisR Documentation

Segment Analysis

Description

Calls the depthmapXcli to carry out Segment Analysis on the currently visible map

Usage

segmentAnalysis(graphFileIn, graphFileOut, analysisType, radii, radiusType,
                tulipBins = NA, weightWithColumn = NA, includeChoice = FALSE,
                cliPath = getDefaultCLILocation(), verbose = FALSE)

Arguments

graphFileIn

The input graph file.

graphFileOut

The output graph file. If ommited will use the input file.

analysisType

The type of analysis. One of: "tulip" (Angular Tulip - Faster), "angular" (Angular Full - Slower), "topological" or "metric"

radii

One or more radii to limit the analysis at.

radiusType

The type of radius to limit the analysus at. One of: "steps", "metric" or "angular".

tulipBins

Number of tulip bins. Can be from 4 to 1024, 1024 approximates full angular.

weightWithColumn

Perform weighted analysis using this attribute (only for Tulip).

includeChoice

Set to TRUE to include choice.

cliPath

Optional. Provide the path to a different CLI.

verbose

Optional. Show more information of the process.

Value

No value returned, process is between files.

Author(s)

Petros Koutsolampros Fani Kostourou


orange-vertex/rdepthmap documentation built on Oct. 26, 2023, 7:40 a.m.