sd_vvp_threshold: Get threshold of the radial velocity standard deviation

View source: R/sd_vvp_threshold.R

sd_vvp_thresholdR Documentation

Get threshold of the radial velocity standard deviation

Description

Returns the current threshold of the radial velocity standard deviation (sd_vvp) of an object in m/s, retrieved by velocity volume processing (VVP).

Usage

sd_vvp_threshold(x)

## S3 method for class 'vp'
sd_vvp_threshold(x)

## S3 method for class 'list'
sd_vvp_threshold(x)

## S3 method for class 'vpts'
sd_vvp_threshold(x)

Arguments

x

A vp, list of vp or vpts object.

Value

The sd_vvp threshold in m/s.

See Also

  • sd_vvp_threshold()<- for setting the sd_vvp threshold of an object.

  • rcs()

Examples

# Get the sd_vvp threshold for a vp
sd_vvp_threshold(example_vp)

# Get the sd_vvp threshold for a vpts
sd_vvp_threshold(example_vpts)

adokter/birdRad documentation built on Feb. 1, 2024, 3:40 p.m.