Skip to contents

Retrieve FOR Noise Factor (noisefact)

Source: R/SeaSondeRCS_FOR.R
seasonder_getFOR_noisefact.Rd

This function retrieves the noise factor ('noisefact') used in FOR processing from a SeaSondeRCS object.

Usage

seasonder_getFOR_noisefact(seasonder_cs_object)

Arguments

seasonder_cs_object

A SeaSondeRCS object containing FOR parameters.

Value

The value of the 'noisefact' parameter.

Examples

# Minimal example for seasonder_getFOR_noisefact
cs_file <- system.file("css_data/CSS_TORA_24_04_04_0700.cs", package = "SeaSondeR")
apm_file <- system.file("css_data/MeasPattern.txt", package = "SeaSondeR")
apm_obj <- seasonder_readSeaSondeRAPMFile(apm_file)
#> seasonder_createSeaSondeRAPM:  APM object created successfully.
cs_obj <- seasonder_createSeaSondeRCS(cs_file, seasonder_apm_object = apm_obj)
#> new_SeaSondeRCS:  SeaSondeRCS object created successfully.
noise_factor <- seasonder_getFOR_noisefact(cs_obj)
print(noise_factor)
#> [1] 3.981072