get_mcs_masks: Post-processing ForTraCC outputs to obtain MCSs using the...

In salvatirehbein/percolator: ForTraCC Post-Processing Tool

Post-processing ForTraCC outputs to obtain MCSs using the SAAG Deep Convection Group criteria

Description

The function performs the following steps:

- Filtering by Tb (brightness temperature) thresholds. - Filtering by size criteria. - Filtering by precipitation (PCP) criteria. - Data processing and preparation. - Mask creation for MCSs.

Usage

get_mcs_masks(
  year_start,
  month_start,
  day_start,
  hour_start,
  year_end,
  month_end,
  day_end,
  hour_end,
  ncols,
  nlins,
  family_file,
  path_to_fortracc_clusters,
  cluster_prefix,
  ofile_mask,
  attribute = "Tb MCSs Masks from ForTraCC-percolator",
  reference_file = system.file("extdata/merg_2011010100_4km-pixel.nc", package =
    "percolator")
)

Arguments

year_start	Integer. Starting year for filtering the data.
month_start	Integer. Starting month for filtering the data.
day_start	Integer. Starting day for filtering the data.
hour_start	Integer. Starting hour for filtering the data.
year_end	Integer. Ending year for filtering the data.
month_end	Integer. Ending month for filtering the data.
day_end	Integer. Ending day for filtering the data.
hour_end	Integer. Ending hour for filtering the data.
ncols	Integer. Number of columns relative to the native data.
nlins	Integer. Number of lines relative to the native data.
family_file	Character. Path to the family file obtained by get_mcs_csv.R
path_to_fortracc_clusters	Character. Path to the directory containing Fortracc clusters.
cluster_prefix	Character. Prefix for cluster files.
ofile_mask	Character. Output NetCDF file path for masks.
attribute	Character. Description of the attribute for the NetCDF file.
reference_file	Character. Path to the reference file.

Details

This function identifies and filters Mesoscale Convective Systems (MCSs) based on specific criteria established by the SAAG Deep Convection Working Group. It creates masks for further analysis or visualization.

Value

netCDF

Examples

## Not run: 
get_mcs_masks(year_start = 2001,
            month_start = 1,
            day_start = 1,
            hour_start = 0,
            year_end = 2001,
            month_end = 1,
            day_end = 31,
            hour_end = 23,
            ncols = 480,
            nlins = 690,
            family_file = "MCSs_MASK/MCS_SAAG_WRF_p_2000.csv",
            path_to_fortracc_clusters = "clusters/",
            cluster_prefix = "WRF_20y_p_",
            ofile_mask = "MCSs_MASK/2000_p_WRF_SAAG-MCS-mask-file.nc",
            attribute = "Description of the attribute",
            reference_file = system.file("extdata/merg_2011010100_4km-pixel.nc", 
                                         package = "percolator")
) 
## End(Not run)

salvatirehbein/percolator documentation built on June 3, 2024, 7:16 a.m.