tobac 1.6.2__py3-none-any.whl

tobac/__init__.py

@@ -0,0 +1,112 @@
+# from .tracking import maketrack
+import sys
+
+if sys.version_info < (3, 7):
+    warning = """ \n\n 
+    Support for Python versions less than 3.7 is deprecated. 
+    Version 1.5 of tobac will require Python 3.7 or later.
+   Python {py} detected. \n\n
+    """.format(
+        py=".".join(str(v) for v in sys.version_info[:3])
+    )
+
+    print(warning)
+
+from tobac.segmentation.watershed_segmentation import (
+    segmentation_3D,
+    segmentation_2D,
+    watershedding_3D,
+    watershedding_2D,
+)
+from .centerofgravity import (
+    calculate_cog,
+    calculate_cog_untracked,
+    calculate_cog_domain,
+)
+from .plotting import (
+    plot_tracks_mask_field,
+    plot_tracks_mask_field_loop,
+    plot_mask_cell_track_follow,
+    plot_mask_cell_track_static,
+    plot_mask_cell_track_static_timeseries,
+    plot_lifetime_histogram,
+    plot_lifetime_histogram_bar,
+    plot_histogram_cellwise,
+    plot_histogram_featurewise,
+    plot_mask_cell_track_3Dstatic,
+    plot_mask_cell_track_2D3Dstatic,
+    plot_mask_cell_individual_static,
+    plot_mask_cell_individual_3Dstatic,
+    animation_mask_field,
+    make_map,
+    map_tracks,
+)
+from tobac.analysis.cell_analysis import (
+    cell_statistics,
+    cog_cell,
+    lifetime_histogram,
+    histogram_cellwise,
+    velocity_histogram,
+    calculate_overlap,
+)
+from tobac.analysis.feature_analysis import (
+    histogram_featurewise,
+    calculate_nearestneighbordistance,
+    nearestneighbordistance_histogram,
+    area_histogram,
+)
+from tobac.analysis.spatial import (
+    calculate_velocity,
+    calculate_distance,
+    calculate_area,
+)
+from .utils.mask import (
+    mask_cell,
+    mask_cell_surface,
+    mask_cube_cell,
+    mask_cube_untracked,
+    mask_cube,
+    column_mask_from2D,
+    mask_features,
+    mask_features_surface,
+    mask_cube_features,
+)
+from .utils.general import (
+    get_bounding_box,
+    add_coordinates,
+    get_spacings,
+)
+from .feature_detection import feature_detection_multithreshold
+from .tracking import linking_trackpy
+from .wrapper import maketrack
+from .wrapper import tracking_wrapper
+from . import merge_split
+import importlib.metadata
+import pathlib
+
+# default version number
+__version__ = "unknown_dev_version"
+
+# Set version number
+# This version should work without needing the package installed
+try:
+    __version__ = importlib.metadata.version(__package__ or __name__)
+except importlib.metadata.PackageNotFoundError:
+    # need to get version directly from text file
+    try:
+        import tomllib
+
+        pyproject_toml_file_name = (
+            pathlib.Path(__file__).parent.parent / "pyproject.toml"
+        )
+        if pyproject_toml_file_name.exists() and pyproject_toml_file_name.is_file():
+            with open(pyproject_toml_file_name, "rb") as f:
+                toml_data = tomllib.load(f)
+                if "project" in toml_data and "version" in toml_data["project"]:
+                    __version__ = toml_data["project"]["version"]
+
+    except ImportError:
+        # on python <3.11 but not installing tobac.
+        # don't bother giving precise version number.
+        __version__ = "unknown_dev_version"
+    pass

tobac/analysis/__init__.py

@@ -0,0 +1,31 @@
+"""Provide tools to analyse and visualize the tracked objects.
+This module provides a set of routines that enables performing analyses
+and deriving statistics for individual tracks, such as the time series
+of integrated properties and vertical profiles. It also provides
+routines to calculate summary statistics of the entire population of
+tracked features in the field like histograms of areas/volumes
+or mass and a detailed cell lifetime analysis. These analysis
+routines are all built in a modular manner. Thus, users can reuse the
+most basic methods for interacting with the data structure of the
+package in their own analysis procedures in Python. This includes
+functions performing simple tasks like looping over all identified
+objects or trajectories and masking arrays for the analysis of
+individual features. Plotting routines include both visualizations
+for individual convective cells and their properties. [1]_
+
+References
+----------
+.. Heikenfeld, M., Marinescu, P. J., Christensen, M.,
+   Watson-Parris, D., Senf, F., van den Heever, S. C.
+   & Stier, P. (2019). tobac 1.2: towards a flexible
+   framework for tracking and analysis of clouds in
+   diverse datasets. Geoscientific Model Development,
+   12(11), 4551-4570.
+
+Notes
+-----
+"""
+
+from tobac.analysis.cell_analysis import *
+from tobac.analysis.feature_analysis import *
+from tobac.analysis.spatial import *