pyrad.proc.process_keep_roi#

pyrad.proc.process_keep_roi(procstatus, dscfg, radar_list=None)[source]#

keep only data within a region of interest and mask anything else

Parameters:

  • procstatus (int) – Processing status: 0 initializing, 1 processing volume, 2 post-processing

  • dscfg (dictionary of dictionaries) –

    data set configuration. Accepted Configuration Keywords:

    datatype : string. Dataset keyword
    The data type where we want to extract the point measurement
trtfile : str. Dataset keyword
    TRT file from which to extract the region of interest
time_tol : float. Dataset keyword
    Time tolerance between the TRT file date and the nominal radar
    volume time
lon_roi, lat_roi : float array. Dataset keyword
    latitude and longitude positions defining a region of interest
alt_min, alt_max : float. Dataset keyword
    Minimum and maximum altitude of the region of interest. Can be
    None
cercle : boolean. Dataset keyword
    If True the region of interest is going to be defined as a cercle
    centered at a particular point. Default False
lon_centre, lat_centre : Float. Dataset keyword
    The position of the centre of the cercle. If None, that of the
    radar will be used
rad_cercle : Float. Dataset keyword
    The radius of the cercle in m. Default 1000.
res_cercle : int. Dataset keyword
    Number of points used to define a quarter of cercle. Default 16
box : boolean. Dataset keyword
    If True the region of interest is going to be defined by a
    rectangle
lon_point, lat point : Float
    The position of the point of rotation of the box. If None the
    position of the radar is going to be used
rotation : float
    The angle of rotation. Positive is counterclockwise from North in
    deg. Default 0.
we_offset, sn_offset : float
    west-east and south-north offset from rotation position in m.
    Default 0
we_length, sn_length : float
    west-east and south-north rectangle lengths in m. Default 1000.
origin : str
    origin of rotation. Can be center: center of the rectangle or
    mid_south. East-west mid-point at the south of the rectangle.
    Default center
use_latlon : Bool. Dataset keyword
    If True the coordinates used to find the radar gates within the
    ROI will be lat/lon. If false it will use Cartesian Coordinates
    with origin the radar position. Default True

  • radar_list (list of Radar objects) – Optional. list of radar objects

Returns:

  • new_dataset (dict) – dictionary containing the data and metadata at the point of interest

  • ind_rad (int) – radar index