ocetrac.measures.ShapeMeasures

class ocetrac.measures.ShapeMeasures(lat_resolution: float = 110.574, lon_resolution: float = 111.32, use_decorators: bool = True)

Calculates shape characteristics of labeled geospatial objects.

__init__(lat_resolution: float = 110.574, lon_resolution: float = 111.32, use_decorators: bool = True)

Initializes the ShapeMeasures class with latitude and longitude resolutions and decorater usage.

Parameters

lat_resolutionfloat

Resolution in kilometers for latitude (default is 110.574 km)

lon_resolutionfloat

Resolution in kilometers for longitude (default is 111.320 km)

use_decoratorsbool

If True, decorators will be used to log execution time (default is True)

Methods

__init__([lat_resolution, lon_resolution, ...])

Initializes the ShapeMeasures class with latitude and longitude resolutions and decorater usage.

calc_circularity(area, perimeter)

Calculates circularity given area and perimeter.

calc_complement_to_deformation(coords_full, ...)

Calculates complement to deformation ratio for consecutive timesteps.

calc_deformation(shared_area_ratios)

Calculates deformation as 1 - shared area ratio.

calc_perimeter(one_obj)

Calculates the perimeter of objects using contour detection.

calc_ratio_convexhullarea_vs_area(one_obj)

Calculates the ratio of object area to convex hull area.

calc_spatial_extents(one_obj)

Calculates spatial extents and summary statistics for event.

calculate_area(lats, lons)

Calculates area in square kilometers.