get_prec_under_tb_mm: Calculate Precipitation related to the ForTraCC Tb objects

In salvatirehbein/percolator: ForTraCC Post-Processing Tool

Calculate Precipitation related to the ForTraCC Tb objects

Description

This function calculates the precipitation area and volume under the cloud shield. It overlap the brightness temperature (Tb) objects (clusters) generated by ForTracc with the corresponding precipitation field. Requires monthly input files with hourly precipitation.

This function calculates the precipitation area and volume under the cloud shield. It overlap the brightness temperature (Tb) objects (clusters) generated by ForTracc with the corresponding precipitation field. Requires monthly input files with hourly precipitation.

Usage

get_prec_under_tb_mm(
  day = NULL,
  month = NULL,
  year_start,
  year_end,
  ncols,
  nlins,
  type,
  family_file,
  cluster_prefix,
  pcp_file,
  pcp_varname,
  basename = "fam",
  pcp_time_name = "time",
  path_to_fortracc_clusters,
  path_to_masks_files,
  plot = FALSE,
  area_file = system.file("extdata/grid_area_saag/area_wrf_km2.nc", package =
    "percolator")
)

get_prec_under_tb_mm(
  day = NULL,
  month = NULL,
  year_start,
  year_end,
  ncols,
  nlins,
  type,
  family_file,
  cluster_prefix,
  pcp_file,
  pcp_varname,
  basename = "fam",
  pcp_time_name = "time",
  path_to_fortracc_clusters,
  path_to_masks_files,
  plot = FALSE,
  area_file = system.file("extdata/grid_area_saag/area_wrf_km2.nc", package =
    "percolator")
)

Arguments

day	Integer. Day of the tracking or NULL (default).
month	Integer. Month of the tracking or NULL (default).
year_start	Integer. Starting year of the data.
year_end	Integer. Ending year of the data.
ncols	Integer. Number of columns in the native data.
nlins	Integer. Number of lines in the native data.
type	Character. Type of data used for tracking the MCSs. It will be added at the dataset for identification purposes.
family_file	Character. Path to the family file.
cluster_prefix	Character.
pcp_file	Character. Precipitation monthly file name. Ex: "pathi_to_prec/200101_PREC_ACC_NC-on_IMERG_grid.nc"
pcp_varname	Character. Precipitation variable name. Ex: "PREC_ACC_NC"
basename	Character. It's the basename for the output file. Default is "fam".
pcp_time_name	Character. Time variable name. Default: "time"
path_to_fortracc_clusters	Character. Path to the ForTraCC cluster files.
path_to_masks_files	Character. Path to the masks files.
plot	Logical. If clusters over precipitation should be plotted at the path_to_masks_files. See figs directory inside that path. Default: FALSE.
area_file	Character. Path to the area file.

Value

A csv file.

A csv file.

Examples

## Not run: 
get_prec_under_tb(day=NULL,
            month = 1,
            ncols = 480,
            nlins = 690,
            type = "WRF",
            year_start = 2000,
            year_end = 2000,
            cluster_prefix = "WRF_20y_p_",
            area_file = system.file("extdata/grid_area_saag/area_wrf_km2.nc", package = "percolator"),
            family_file = "diag.txt/fam_SAAG_WRF_20yr_p_0112_s2.txt",
            path_to_prec_file = paste0("DATA/WRF/PREC_ACC_NC/"),
            path_to_fortracc_clusters = "clusters/",
            path_to_masks_files = "MCSs_MASKs/")

## End(Not run) 
## Not run: 
get_prec_under_tb(day=NULL,
            month = 1,
            ncols = 480,
            nlins = 690,
            type = "WRF",
            year_start = 2000,
            year_end = 2000,
            cluster_prefix = "WRF_20y_p_",
            area_file = system.file("extdata/grid_area_saag/area_wrf_km2.nc", package = "percolator"),
            family_file = "diag.txt/fam_SAAG_WRF_20yr_p_0112_s2.txt",
            path_to_prec_file = paste0("DATA/WRF/PREC_ACC_NC/"),
            path_to_fortracc_clusters = "clusters/",
            path_to_masks_files = "MCSs_MASKs/")

## End(Not run) 

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