starplot 0.18.3__py2.py3-none-any.whl → 0.19.2__py2.py3-none-any.whl

starplot/plotters/dsos.py

@@ -15,6 +15,7 @@ from starplot.models.dso import (
 )
 from starplot.styles import MarkerSymbolEnum
 from starplot.profile import profile
+from starplot.plotters.text import CollisionHandler
 
 
 class DsoPlotterMixin:
@@ -147,33 +148,37 @@ class DsoPlotterMixin:
         self,
         where: list = None,
         where_labels: list = None,
-        true_size: bool = True,
+        where_true_size: list = None,
         legend_labels: Mapping[DsoType, str] = DSO_LEGEND_LABELS,
         alpha_fn: Callable[[DSO], float] = None,
         label_fn: Callable[[DSO], str] = DSO.get_label,
         sql: str = None,
         sql_labels: str = None,
         catalog: Catalog = OPEN_NGC,
+        collision_handler: CollisionHandler = None,
     ):
         """
-        Plots Deep Sky Objects (DSOs), from OpenNGC
+        Plots Deep Sky Objects (DSOs).
 
         Args:
             where: A list of expressions that determine which DSOs to plot. See [Selecting Objects](/reference-selecting-objects/) for details.
-            where_labels: A list of expressions that determine which DSOs are labeled on the plot. See [Selecting Objects](/reference-selecting-objects/) for details.
-            true_size: If True, then each DSO will be plotted as its true apparent size in the sky (note: this increases plotting time). If False, then the style's marker size will be used. Also, keep in mind not all DSOs have a defined size (according to OpenNGC) -- so these will use the style's marker size.
-            labels: A dictionary that maps DSO names (as specified in OpenNGC) to the label that'll be plotted for that object. By default, the DSO's name in OpenNGC will be used as the label. If you want to hide all labels, then set this arg to `None`.
+            where_labels: A list of expressions that determine which DSOs are labeled on the plot. By default all DSOs are labeled. See [Selecting Objects](/reference-selecting-objects/) for details.
+            where_true_size: A list of expressions that determine which DSOs are plotted as their true apparent size in the sky. By default all DSOs are plotted as their true size.
             legend_labels: A dictionary that maps a `DsoType` to the legend label that'll be plotted for that type of DSO. If you want to hide all DSO legend labels, then set this arg to `None`.
             alpha_fn: Callable for calculating the alpha value (aka "opacity") of each DSO. If `None`, then the marker style's alpha will be used.
             label_fn: Callable for determining the label of each DSO.
             sql: SQL query for selecting DSOs (table name is `_`). This query will be applied _after_ any filters in the `where` kwarg.
             sql_labels: SQL query for selecting DSOs that will be labeled (table name is `_`). Applied _after_ any filters in the `where_labels` kwarg.
+            catalog: The catalog of DSOs to use -- see [catalogs overview](/data/overview/) for details
+            collision_handler: An instance of [CollisionHandler][starplot.CollisionHandler] that describes what to do on label collisions with other labels, markers, etc. If `None`, then the collision handler of the plot will be used.
         """
 
         # TODO: add kwarg styles
 
         where = where or []
         where_labels = where_labels or []
+        where_true_size = where_true_size or []
+        handler = collision_handler or self.collision_handler
 
         if legend_labels is None:
             legend_labels = {}
@@ -183,21 +188,23 @@ class DsoPlotterMixin:
         extent = self._extent_mask()
         dso_results = load(extent=extent, filters=where, sql=sql, catalog=catalog)
 
-        dso_results_labeled = dso_results
+        dsos_labeled = dso_results
         for f in where_labels:
-            dso_results_labeled = dso_results_labeled.filter(f)
+            dsos_labeled = dsos_labeled.filter(f)
+
+        dsos_true_size = dso_results
+        for f in where_true_size:
+            dsos_true_size = dsos_true_size.filter(f)
 
         if sql_labels:
-            result = (
-                dso_results_labeled.alias("_").sql(sql_labels).select("pk").execute()
-            )
+            result = dsos_labeled.alias("_").sql(sql_labels).select("pk").execute()
             pks = result["pk"].to_list()
-            dso_results_labeled = dso_results_labeled.filter(_.pk.isin(pks))
+            dsos_labeled = dsos_labeled.filter(_.pk.isin(pks))
 
-        label_pks = dso_results_labeled.to_pandas()["pk"].tolist()
+        label_pks = dsos_labeled.select("pk").to_pandas()["pk"].tolist()
+        true_size_pks = dsos_true_size.select("pk").to_pandas()["pk"].tolist()
 
-        results_df = dso_results.to_pandas()
-        results_df = results_df.replace({np.nan: None})
+        results_df = dso_results.to_pandas().replace({np.nan: None})
 
         for d in results_df.itertuples():
             ra = d.ra
@@ -221,7 +228,9 @@ class DsoPlotterMixin:
             if _dso.pk not in label_pks:
                 label = None
 
-            if true_size and d.size is not None:
+            _true_size = _dso.pk in true_size_pks
+
+            if _true_size and d.size is not None:
                 if "Polygon" == str(d.geometry.geom_type):
                     self._plot_dso_polygon(d.geometry, style)
 
@@ -257,7 +266,14 @@ class DsoPlotterMixin:
                         )
 
                 if label:
-                    self.text(label, ra, dec, style.label, gid=f"dso-{d.type}-label")
+                    self.text(
+                        label,
+                        ra,
+                        dec,
+                        style.label,
+                        collision_handler=handler,
+                        gid=f"dso-{d.type}-label",
+                    )
 
                 self._add_legend_handle_marker(legend_label, style.marker)
 
@@ -269,6 +285,7 @@ class DsoPlotterMixin:
                     style=style,
                     label=label,
                     legend_label=legend_label,
+                    collision_handler=handler,
                     skip_bounds_check=True,
                     gid_marker=f"dso-{d.type}-marker",
                     gid_label=f"dso-{d.type}-label",

starplot/plotters/experimental.py

@@ -716,7 +716,6 @@ class ExperimentalPlotterMixin:
                 ra,
                 dec,
                 style,
-                hide_on_collision=self.hide_colliding_labels,
                 area=MultiPolygon(polygons_sorted[:3])
                 if len(polygons_sorted)
                 else constellation.boundary,

starplot/plotters/milkyway.py

@@ -1,32 +1,41 @@
 from shapely.ops import unary_union
 
+from ibis import _
+
 from starplot.data import db
+from starplot.data.catalogs import Catalog, MILKY_WAY
 from starplot.styles import PolygonStyle
 from starplot.styles.helpers import use_style
 from starplot.geometry import split_polygon_at_zero
 from starplot.profile import profile
+from starplot.models.milky_way import from_tuple
 
 
 class MilkyWayPlotterMixin:
     @profile
     @use_style(PolygonStyle, "milky_way")
-    def milky_way(self, style: PolygonStyle = None):
+    def milky_way(self, style: PolygonStyle = None, catalog: Catalog = MILKY_WAY):
         """
         Plots the Milky Way
 
         Args:
             style: Styling of the Milky Way. If None, then the plot's style (specified when creating the plot) will be used
+            catalog: Catalog to use for Milky Way polygons
         """
         con = db.connect()
-        mw = con.table("milky_way")
+        mw = catalog._load(connection=con, table_name="milky_way")
+        mw = mw.mutate(
+            geometry=_.geometry.cast("geometry"),  # cast WKB to geometry type
+        )
 
         extent = self._extent_mask()
-        result = mw.filter(mw.geometry.intersects(extent)).to_pandas()
+        df = mw.filter(_.geometry.intersects(extent)).to_pandas()
 
-        polygons = []
+        milky_ways = [from_tuple(m) for m in df.itertuples()]
 
-        for row in result.itertuples():
-            polygons.extend(split_polygon_at_zero(row.geometry))
+        polygons = []
+        for milky_way in milky_ways:
+            polygons.extend(split_polygon_at_zero(milky_way.geometry))
 
         mw_union = unary_union(polygons)
 

starplot/plotters/stars.py

@@ -4,7 +4,7 @@ from typing import Callable
 import rtree
 import numpy as np
 from ibis import _ as ibis_table
-from skyfield.api import Star as SkyfieldStar, wgs84
+from skyfield.api import Star as SkyfieldStar
 
 from starplot import callables
 from starplot.data import stars
@@ -13,6 +13,7 @@ from starplot.data.translations import translate
 from starplot.models.star import Star, from_tuple
 from starplot.styles import ObjectStyle, use_style
 from starplot.profile import profile
+from starplot.plotters.text import CollisionHandler
 
 
 class StarPlotterMixin:
@@ -65,6 +66,7 @@ class StarPlotterMixin:
         bayer_labels: bool,
         flamsteed_labels: bool,
         label_fn: Callable[[Star], str],
+        collision_handler: CollisionHandler,
     ):
         _bayer = []
         _flamsteed = []
@@ -100,7 +102,7 @@ class StarPlotterMixin:
                         marker_size=star_sizes[i],
                         scale=self.scale,
                     ),
-                    hide_on_collision=self.hide_colliding_labels,
+                    collision_handler=collision_handler,
                     gid="stars-label-name",
                 )
 
@@ -121,7 +123,7 @@ class StarPlotterMixin:
                     marker_size=star_size,
                     scale=self.scale,
                 ),
-                hide_on_collision=self.hide_colliding_labels,
+                collision_handler=collision_handler,
                 gid="stars-label-bayer",
             )
 
@@ -135,7 +137,7 @@ class StarPlotterMixin:
                     marker_size=star_size,
                     scale=self.scale,
                 ),
-                hide_on_collision=self.hide_colliding_labels,
+                collision_handler=collision_handler,
                 gid="stars-label-flamsteed",
             )
 
@@ -163,22 +165,15 @@ class StarPlotterMixin:
         flamsteed_labels: bool = False,
         sql: str = None,
         sql_labels: str = None,
-        *args,
-        **kwargs,
+        collision_handler: CollisionHandler = None,
     ):
         """
         Plots stars
 
-        Labels for stars are determined in this order:
-
-        1. Return value from `label_fn`
-        2. Value for star's HIP id in `labels`
-        3. IAU-designated name, as listed in the [data reference](/data/star-designations/)
-
         Args:
             where: A list of expressions that determine which stars to plot. See [Selecting Objects](/reference-selecting-objects/) for details.
             where_labels: A list of expressions that determine which stars are labeled on the plot (this includes all labels: name, Bayer, and Flamsteed). If you want to hide **all** labels, then set this arg to `[False]`. See [Selecting Objects](/reference-selecting-objects/) for details.
-            catalog: The catalog of stars to use: "big-sky-mag11", or "big-sky" -- see [star catalogs](/data/star-catalogs/) for details
+            catalog: The catalog of stars to use -- see [catalogs overview](/data/overview/) for details
             style: If `None`, then the plot's style for stars will be used
             size_fn: Callable for calculating the marker size of each star. If `None`, then the marker style's size will be used.
             alpha_fn: Callable for calculating the alpha value (aka "opacity") of each star. If `None`, then the marker style's alpha will be used.
@@ -189,6 +184,7 @@ class StarPlotterMixin:
             flamsteed_labels: If True, then Flamsteed number labels for stars will be plotted.
             sql: SQL query for selecting stars (table name is `_`). This query will be applied _after_ any filters in the `where` kwarg.
             sql_labels: SQL query for selecting stars that will be labeled (table name is `_`). Applied _after_ any filters in the `where_labels` kwarg.
+            collision_handler: An instance of [CollisionHandler][starplot.CollisionHandler] that describes what to do on label collisions with other labels, markers, etc. If `None`, then the collision handler of the plot will be used.
         """
 
         # fallback to style if callables are None
@@ -199,6 +195,7 @@ class StarPlotterMixin:
         alpha_fn = alpha_fn or (lambda d: style.marker.alpha)
         color_fn = color_fn or (lambda d: color_hex)
 
+        handler = collision_handler or self.collision_handler
         where = where or []
         where_labels = where_labels or []
         stars_to_index = []
@@ -221,30 +218,15 @@ class StarPlotterMixin:
         stars_df = star_results.to_pandas()
         stars_df["ra_hours"], stars_df["dec_degrees"] = (stars_df.ra / 15, stars_df.dec)
 
-        if getattr(self, "projection", None) == "zenith":
-            # filter stars for zenith plots to only include those above horizon
-            self.location = self.earth + wgs84.latlon(
-                self.observer.lat, self.observer.lon
-            )
-            stars_apparent = (
-                self.location.at(self.observer.timescale)
-                .observe(SkyfieldStar.from_dataframe(stars_df))
-                .apparent()
-            )
-            # we only need altitude
-            stars_alt, _, _ = stars_apparent.altaz()
-            stars_df["alt"] = stars_alt.degrees
-            stars_df = stars_df[stars_df["alt"] > 0]
-        else:
-            nearby_stars = SkyfieldStar.from_dataframe(stars_df)
-            astrometric = self.earth.at(self.observer.timescale).observe(nearby_stars)
-            stars_ra, stars_dec, _ = astrometric.radec()
-            stars_df["ra"], stars_df["dec"] = (
-                stars_ra.hours * 15,
-                stars_dec.degrees,
-            )
-
+        nearby_stars = SkyfieldStar.from_dataframe(stars_df)
+        astrometric = self.earth.at(self.observer.timescale).observe(nearby_stars)
+        stars_ra, stars_dec, _ = astrometric.radec()
+        stars_df["ra"], stars_df["dec"] = (
+            stars_ra.hours * 15,
+            stars_dec.degrees,
+        )
         stars_df = self._prepare_star_coords(stars_df)
+
         starz = []
         rtree_id = 1
 
@@ -330,4 +312,5 @@ class StarPlotterMixin:
             bayer_labels,
             flamsteed_labels,
             label_fn,
+            handler,
         )