TrackDataset.filter_storms

TrackDataset.filter_storms(storm=None, year_range=None, date_range=None, thresh={}, domain=None, interpolate_data=False, return_keys=True)[source]

Filters all storms by various thresholds.

Parameters

  • storm (list or str) – Single storm ID or list of storm IDs (e.g., 'AL012022', ['AL012022','AL022022']) to search through. If None, defaults to searching through the entire dataset.

  • year_range (list or tuple) – List or tuple representing the start and end years (e.g., (1950,2018)). Default is start and end years of dataset.

  • date_range (list or tuple) – List or tuple representing the start and end dates as a string in ‘month/day’ format (e.g., ('6/1','8/15')). Default is ('1/1','12/31') or full year.

  • thresh (dict) –

    Keywords include:

    • sample_min - minimum number of storms in a grid box for “request” to be applied. For the functions ‘percentile’ and ‘average’, ‘sample_min’ defaults to 5 and will override any value less than 5.

    • v_min - minimum wind for a given point to be included in “request”.

    • p_max - maximum pressure for a given point to be included in “request”.

    • dv_min - minimum change in wind over dt_window for a given point to be included in “request”.

    • dp_max - maximum change in pressure over dt_window for a given point to be included in “request”.

    • dt_window - time window over which change variables are calculated (hours). Default is 24.

    • dt_align - alignment of dt_window for change variables – ‘start’,’middle’,’end’ – e.g. ‘end’ for dt_window=24 associates a TC point with change over the past 24 hours. Default is middle.

    Units of all wind variables = kt, and pressure variables = hPa. These are added to the subtitle.

  • domain (str) – Geographic domain. Default is entire basin. Please refer to Map Domain Options for available domain options.

  • interpolate_data (bool) – Whether to interpolate track data to hourly. Default is False.

  • return_keys (bool) – If True, returns a list of storm IDs that match the specified criteria. Otherwise returns a pandas.DataFrame object with all matching data points. Default is True.

Returns

list or pandas.DataFrame – Check return_keys for more information.