clean_by_span: Remove file_sub_traj entries that do not span the full region...

View source: R/utility_functions.R

clean_by_spanR Documentation

Remove file_sub_traj entries that do not span the full region of interest

Description

Remove file_sub_traj entries that do not span the full region of interest

Usage

clean_by_span(
  obj_name,
  axis = "position_length",
  min_value = NULL,
  max_value = NULL,
  tolerance = 0.1
)

Arguments

obj_name

The input viewr object; a tibble or data.frame with attribute pathviewr_steps that includes "viewr"

axis

Along which axis should restrictions be enforced?

min_value

Minimum coordinate value; setting this to NULL will auto-compute the best value

max_value

Maximum coordinate; setting this to NULL will auto-compute the best value

tolerance

As a proporiton of axis value

Value

A viewr object (tibble or data.frame with attribute pathviewr_steps. Trajectories that do not span the full region of interest have been removed; trajectory identities (file_sub_traj) have not been changed.

Author(s)

Vikram B. Baliga

See Also

Other utility functions: insert_treatments(), remove_duplicate_frames(), remove_vel_anomalies(), set_traj_frametime()


pathviewr documentation built on March 31, 2023, 5:47 p.m.