seasonder_readSeaSondeRCSSWFile: Read SeaSonde RCSSW File and Create SeaSondeRCS Object

In SeaSondeR: Radial Metrics from SeaSonde HF-Radar Data

Read SeaSonde RCSSW File and Create SeaSondeRCS Object

Description

This function reads a SeaSonde RCSSW file from a specified file path and parses its content into a SeaSondeRCS object. The file is processed by reading its header and body sections using CSSW specifications provided via a YAML file.

Usage

seasonder_readSeaSondeRCSSWFile(
  filepath,
  specs_path = seasonder_defaultSpecsFilePath("CSSW"),
  endian = "big"
)

Arguments

filepath	A character string specifying the path to the SeaSonde RCSSW file.
specs_path	A character string specifying the path to the YAML file containing CSSW specifications. Defaults to the output of seasonder_defaultSpecsFilePath("CSSW").
endian	A character string indicating the byte order used in the file. Defaults to "big".

Details

The function executes the following steps:

1. Sets up error handling parameters specific to the function.

2. Retrieves YAML specifications for the key size block from the CSSW spec file.

3. Attempts to open the file in binary mode ("rb") with warnings suppressed.

4. Reads the file key and uses it to extract file specs.

5. Reads the header key, retrieves header specs, and parses the CSSW header.

6. Converts the CSSW header into a valid SeaSondeRCS header.

7. Reads the body key, retrieves body specs, and parses the CSSW body.

8. Transforms the CSSW body into a SeaSondeRCS data structure.

9. Combines the header and data into a SeaSondeRCS object.

Value

A SeaSondeRCS object containing the parsed header and data.

SeaSondeR documentation built on June 8, 2025, 10:50 a.m.