agentAnalysis: Agent Analysis

View source: R/agentAnalysis.R

agentAnalysisR Documentation

Agent Analysis

Description

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

Usage

agentAnalysis(graphFileIn, graphFileOut = NA, lookMode, timesteps, releaseRate,
              agentFOV, agentSteps, agentLife, originX = NA, originY = NA,
              locationSeed = 0, numberOfTrails = NA, outputType = "graph",
              cliPath = getDefaultCLILocation(), verbose = FALSE)

Arguments

graphFileIn

The input graph file.

graphFileOut

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

lookMode

Agent look mode. One of: "standard", "los-length" (Line of Sight length), "occ-length" (Occluded length), "occ-any" (Any occlusions), "occ-group-45" (Occlusion group bins - 45 degrees), "occ-group-60" (Occlusion group bins - 60 degrees), "occ-furthest" (Furthest occlusion per bin), "bin-far-dist" (Per bin far distance weighted), "bin-angle" (Per bin angle weighted), "bin-far-dist-angle" (Per bin far-distance and angle weighted) or "bin-memory" (Per bin memory).

timesteps

Number of total system timesteps.

releaseRate

Agent release rate (likelyhood of release per timestep).

agentFOV

Agent field-of-view (out of 32 bins = 360).

agentSteps

Agent steps before turn decision.

agentLife

Agent total lifetime (in timesteps).

originX

Agent starting point (x coordinates).

originY

Agent starting point (y coordinates).

locationSeed

Agents to start at random locations with specific seed (0 to 10). Default is 0.

numberOfTrails

Record trails for this amount of agents (set to 0 to record all, with max possible currently = 50).

outputType

Set output type. One of: "graph" (graph file, default), "gatecounts" (csv with cells of grid with gate counts) or "trails" (csv with lines showing path traversed by each agent).

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


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