selCollEvents: Wrapper for filtering collective events

In dmattek/ARCOS: Automatic Recognition of Collective Signalling

Wrapper for filtering collective events

Description

Filter collective events calculated by the trackCollEvents function by size and duration.

Usage

selCollEvents(
  inDTcoll,
  inCols = list(frame = "frame", id = "trackID", collid = "clTrackID"),
  inCollDur,
  inCollTotSz
)

Arguments

inDTcoll	a data.table with collective events in the long format produced by the trackCollEvents function. Consists of 3 columns: integer frame number, object id, id's of collective events.
inCols	a list with column names, list(frame = , id = , collid = ), that correspond to the integer frame number, position, object id and id of collective events, respectively.
inCollDur	a vector with 2 integers that correspond to the minimum and maximum duration of clusters in frame numbers.
inCollTotSz	a vector with 2 integers that correspond to the minimum and maximum total size of clusters in frame numbers. The total size is the number of unique objects involved in a collective event throughout its entire duration.

Value

a data.table as the inDTcoll with collective events within provided duration and size bounds.

Examples

cat("no examples")

dmattek/ARCOS documentation built on Dec. 5, 2024, 11:02 p.m.