Retrieve First Order Region (FOR) Data from SeaSondeRCS Object — seasonder_getSeaSondeRCS

This function extracts the First Order Region (FOR) data from a SeaSondeRCS object. If the FOR data is not found in the object's attributes, it is initialized using seasonder_initSeaSondeRCS_FOR().

Usage

seasonder_getSeaSondeRCS_FOR(seasonder_cs_object)

Arguments

seasonder_cs_object: A SeaSondeRCS object containing FOR-related data.

Value

The FOR data structure.

Details

The function attempts to retrieve the 'FOR' element from the object's "FOR_data" attribute. If it does not exist, it calls seasonder_initSeaSondeRCS_FOR() to initialize the FOR data.

Examples

# Minimal example for seasonder_getSeaSondeRCS_FOR
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.
FOR_data <- seasonder_getSeaSondeRCS_FOR(cs_obj)
head(FOR_data)
#> $range_001
#> $range_001$negative_FOR
#> integer(0)
#> 
#> $range_001$positive_FOR
#> integer(0)
#> 
#> 
#> $range_002
#> $range_002$negative_FOR
#> integer(0)
#> 
#> $range_002$positive_FOR
#> integer(0)
#> 
#> 
#> $range_003
#> $range_003$negative_FOR
#> [1] 336 337 338 339 340 341
#> 
#> $range_003$positive_FOR
#> integer(0)
#> 
#> 
#> $range_004
#> $range_004$negative_FOR
#>  [1] 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
#> [20] 341 342 343 344 345
#> 
#> $range_004$positive_FOR
#>  [1] 674 675 676 677 678 679 680 681 682 683 684 685
#> 
#> 
#> $range_005
#> $range_005$negative_FOR
#>  [1] 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
#> [20] 337 338 339 340 341 342 343 344 345 346 347 348 349 350
#> 
#> $range_005$positive_FOR
#>  [1] 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
#> [20] 688 689 690 691 692 693 694 695 696 697 698 699
#> 
#> 
#> $range_006
#> $range_006$negative_FOR
#>  [1] 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
#> [20] 344 345 346 347 348 349 350 351 352
#> 
#> $range_006$positive_FOR
#>  [1] 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
#> [20] 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
#> 
#>