API

Core

These functions make up the core of the TAMS algorithm:

tams.identify(ctt, *[, size_filter, ...])	Identify clouds in 2-D (lat/lon) or 3-D (lat/lon + time) cloud-top temperature data ctt.
tams.track(contours_sets, times, *[, ...])	Assign group IDs to the CEs identified at each time, returning a single CE frame.
tams.classify(cs)	Classify the CE groups into MCS classes, adding a categorical 'mcs_class' column to the input frame.

The helper function tams.run() combines the above plus additional processing, including computing stats on gridded data within the identified cloud element regions.

tams.run(ds, *[, parallel, u_projection, ...])

Run all TAMS steps, including precip assignment.

Lower level functions used in the above include:

tams.calc_ellipse_eccen(p)	Compute the (first) eccentricity of the least-squares best-fit ellipse to the coordinates of the polygon's exterior.
tams.contours(x, value, *[, unstructured])	Find contour definitions for data x at value value.
tams.data_in_contours(data, contours, *[, ...])	Compute statistics on data within the shapes of contours.
tams.overlap(a, b, *[, norm])	For each contour in a, determine those in b that overlap and by how much.
tams.project(df, *[, u, dt])	Project the coordinates by u * dt meters in the x direction.

Data

tams.load_example_tb()	Load the example derived satellite brightness temperature data.
tams.load_example_mpas()	Load the example MPAS dataset.
tams.load_example_mpas_ug()	Load the example MPAS unstructured grid dataset.
tams.load_mpas_precip(paths, *[, parallel])	Derive a TAMS input dataset from post-processed MPAS runs for the PRECIP field campaign.
tams.data.download_examples(*[, clobber])	Download the example datasets.
tams.data.load_example_ir()	Load the example satellite infrared radiance data.
tams.data.tb_from_ir(r, ch)	Compute brightness temperature from IR satellite radiances (r) in channel ch of the EUMETSAT MSG SEVIRI instrument.

Utilities

tams.plot_tracked(cs, *[, alpha, ...])

Plot CEs at a range of times (colors) with CE group ID (MCS ID) identified.