tropycal.recon.hdobs

class tropycal.recon.hdobs(storm, data=None, update=False)[source]

Creates an instance of an HDOBs object containing all recon High Density Observations (HDOBs) for a single storm.

Parameters

  • storm (tropycal.tracks.Storm) – Requested storm.

  • data (str, optional) – Filepath of pickle file containing HDOBs data retrieved from hdobs.to_pickle(). If provided, data will be retrieved from the local pickle file instead of the NHC server.

  • update (bool) – If True, search for new data, following existing data in the dropsonde object, and concatenate. Default is False.

Returns

Dataset – An instance of HDOBs, initialized with a dataframe of HDOB.

Notes

Warning

Recon data is currently only available from 1989 onwards.

There are two recommended ways of retrieving an hdob object. Since the ReconDataset, hdobs, dropsondes and vdms classes are storm-centric, a Storm object is required for both methods.

#Retrieve Hurricane Michael (2018) from TrackDataset
basin = tracks.TrackDataset()
storm = basin.get_storm(('michael',2018))

The first method is to use the empty instance of ReconDataset already initialized in the Storm object, which has a get_hdobs() method thus allowing all of the hdobs attributes and methods to be accessed from the Storm object. As a result, a Storm object does not need to be provided as an argument.

#Retrieve all HDOBs for this storm
storm.recon.get_hdobs()

#Retrieve the raw HDOBs data
storm.recon.hdobs.data

#Use the plot_points() method of hdobs
storm.recon.hdobs.plot_points()

The second method is to use the hdobs class independently of the other recon classes:

from tropycal.recon import hdobs

#Retrieve all HDOBs for this storm, passing the Storm object as an argument
hdobs_obj = hdobs(storm)

#Retrieve the raw HDOBs data
hdobs_obj.data

#Use the plot_points() method of hdobs
hdobs_obj.plot_points()

Methods Summary

hdobs.gridded_stats(request[, thresh, ...])

Creates a plot of gridded statistics.

hdobs.plot_hovmoller([varname, radlim, ...])

Creates a hovmoller plot of azimuthally-averaged recon data.

hdobs.plot_maps([time, varname, ...])

Creates maps of interpolated recon data.

hdobs.plot_points([varname, domain, radlim, ...])

Creates a plot of recon data points.

hdobs.plot_swath([time, varname, ...])

Creates a map plot of a swath of interpolated recon data.

hdobs.plot_time_series([varname, mission, ...])

Plots a time series of one or two variables on an axis.

hdobs.sel([mission, time, domain, plane_p, ...])

Select a subset of HDOBs by any of its parameters and return a new hdobs object.

hdobs.to_pickle(filename)

Save HDOB data (Pandas dataframe) to a pickle file.

hdobs.update()

Update with the latest data for an ongoing storm.