lsst-utils 29.2025.1700__py3-none-any.whl → 29.2025.1900__py3-none-any.whl

lsst/utils/plotting/publication_plots.py

@@ -11,10 +11,19 @@
 """Utilities for making publication-quality figures."""
 
 __all__ = [
+    "accent_color",
+    "divergent_cmap",
+    "galaxies_cmap",
+    "galaxies_color",
     "get_band_dicts",
+    "mk_colormap",
     "set_rubin_plotstyle",
+    "stars_cmap",
+    "stars_color",
 ]
 
+import numpy as np
+
 from . import (
     get_multiband_plot_colors,
     get_multiband_plot_linestyles,
@@ -31,6 +40,112 @@ def set_rubin_plotstyle() -> None:
     style.use("lsst.utils.plotting.rubin")
 
 
+def mk_colormap(colorNames):  # type: ignore
+    """Make a colormap from the list of color names.
+
+    Parameters
+    ----------
+    colorNames : `list`
+        A list of strings that correspond to matplotlib named colors.
+
+    Returns
+    -------
+    cmap : `matplotlib.colors.LinearSegmentedColormap`
+        A colormap stepping through the supplied list of names.
+    """
+    from matplotlib import colors
+
+    blues = []
+    greens = []
+    reds = []
+    alphas = []
+
+    if len(colorNames) == 1:
+        # Alpha is between 0 and 1 really but
+        # using 1.5 saturates out the top of the
+        # colorscale, this looks good for ComCam data
+        # but might want to be changed in the future.
+        alphaRange = [0.2, 1.0]
+        nums = np.linspace(0, 1, len(alphaRange))
+        r, g, b = colors.colorConverter.to_rgb(colorNames[0])
+        for num, alpha in zip(nums, alphaRange):
+            blues.append((num, b, b))
+            greens.append((num, g, g))
+            reds.append((num, r, r))
+            alphas.append((num, alpha, alpha))
+
+    else:
+        nums = np.linspace(0, 1, len(colorNames))
+        if len(colorNames) == 3:
+            alphaRange = [1.0, 0.3, 1.0]
+        elif len(colorNames) == 5:
+            alphaRange = [1.0, 0.7, 0.3, 0.7, 1.0]
+        else:
+            alphaRange = np.ones(len(colorNames))
+
+        for num, color, alpha in zip(nums, colorNames, alphaRange):
+            r, g, b = colors.colorConverter.to_rgb(color)
+            blues.append((num, b, b))
+            greens.append((num, g, g))
+            reds.append((num, r, r))
+            alphas.append((num, alpha, alpha))
+
+    colorDict = {"blue": blues, "red": reds, "green": greens, "alpha": alphas}
+    cmap = colors.LinearSegmentedColormap("newCmap", colorDict)
+    return cmap
+
+
+def divergent_cmap():  # type: ignore
+    """
+    Make a divergent color map.
+    """
+    import seaborn as sns
+    from matplotlib.colors import ListedColormap
+
+    cmap = ListedColormap(sns.color_palette("icefire", 256))
+
+    return cmap
+
+
+def stars_cmap(single_color=False):  # type: ignore
+    """Make a color map for stars."""
+    import seaborn as sns
+    from matplotlib.colors import ListedColormap
+
+    if single_color:
+        cmap = mk_colormap([stars_color()])
+    else:
+        cmap = ListedColormap(sns.color_palette("mako", 256))
+    return cmap
+
+
+def stars_color() -> str:
+    """Return the star color string for lines"""
+    return "#357BA3"
+
+
+def accent_color() -> str:
+    """Return a contrasting color for overplotting,
+    black is the best for this but if you need two colors
+    this works well on blue.
+    """
+    return "#DE8F05"
+
+
+def galaxies_cmap(single_color=False):  # type: ignore
+    """Make a color map for galaxies."""
+    if single_color:
+        cmap = mk_colormap([galaxies_color()])
+    else:
+        cmap = "inferno"
+    return cmap
+
+
+def galaxies_color() -> str:
+    """Return the galaxy color string for lines"""
+    return "#961A45"
+
+
 def get_band_dicts() -> dict:
     """
     Define palettes, from RTN-045. This includes dicts for colors (bandpass

lsst/utils/plotting/rubin.mplstyle

@@ -1,19 +1,19 @@
 axes.labelweight: normal
 figure.titleweight : normal
 axes.labelsize : large
-axes.linewidth: 2
+axes.linewidth: 1
 axes.titleweight: normal
 axes.titlesize : small
 figure.titlesize: small
 errorbar.capsize: 3.0
 
-lines.linewidth : 3
+lines.linewidth : 2
 lines.markersize : 10
 
-xtick.labelsize : large
-ytick.labelsize : large
+xtick.labelsize : small
+ytick.labelsize : small
 
-figure.dpi : 150.0
+figure.dpi : 300.0
 figure.facecolor: White
 figure.figsize : 6.4, 4.8
 
@@ -24,16 +24,16 @@ patch.facecolor: 006BA4
 font.size : 14
 legend.fontsize: x-small
 
-xtick.major.width: 2.0
-xtick.minor.width: 1.5
+xtick.major.width: 1.0
+xtick.minor.width: 0.5
 xtick.major.size: 7
 xtick.minor.size: 4
 xtick.minor.visible: True
 xtick.direction: in
 xtick.top: True
 xtick.bottom: True
-ytick.major.width: 2.0
-ytick.minor.width: 1.5
+ytick.major.width: 1.0
+ytick.minor.width: 0.5
 ytick.major.size: 7
 ytick.minor.size: 4
 ytick.minor.visible: True

lsst/utils/timer.py

@@ -16,6 +16,7 @@ from __future__ import annotations
 
 __all__ = ["duration_from_timeMethod", "logInfo", "profile", "timeMethod", "time_this"]
 
+import dataclasses
 import datetime
 import functools
 import logging
@@ -338,6 +339,18 @@ def timeMethod(
         return decorator_timer(_func)
 
 
+@dataclasses.dataclass
+class _TimerResult:
+    duration: float = 0.0
+    """Duration of context in seconds."""
+    mem_current_usage: float | None = None
+    """Memory usage at end of context in requested units."""
+    mem_peak_delta: float | None = None
+    """Peak differential between entering and leaving context."""
+    mem_current_delta: float | None = None
+    """Difference in usage between entering and leaving context."""
+
+
 @contextmanager
 def time_this(
     log: LsstLoggers | None = None,
@@ -349,7 +362,8 @@ def time_this(
     mem_child: bool = False,
     mem_unit: u.Quantity = u.byte,
     mem_fmt: str = ".0f",
-) -> Iterator[None]:
+    force_mem_usage: bool = False,
+) -> Iterator[_TimerResult]:
     """Time the enclosed block and issue a log message.
 
     Parameters
@@ -372,7 +386,8 @@ def time_this(
         written to ``msg``.
     mem_usage : `bool`, optional
         Flag indicating whether to include the memory usage in the report.
-        Defaults, to False.
+        Defaults, to False. Does nothing if the log message will not be
+        generated.
     mem_child : `bool`, optional
         Flag indication whether to include memory usage of the child processes.
     mem_unit : `astropy.units.Unit`, optional
@@ -380,6 +395,16 @@ def time_this(
     mem_fmt : `str`, optional
         Format specifier to use when displaying values related to memory usage.
         Defaults to '.0f'.
+    force_mem_usage : `bool`, optional
+        If `True` memory usage is always calculated even if the log message
+        will not be delivered. Use this if you want the information recorded
+        by the context manager.
+
+    Yields
+    ------
+    timer_result : `_TimerResult`
+        Simple data class containing the duration of the block in seconds via
+        the ``duration`` property.
     """
     if log is None:
         log = logging.getLogger()
@@ -391,14 +416,17 @@ def time_this(
 
     if mem_usage and not log.isEnabledFor(level):
         mem_usage = False
+    if force_mem_usage:
+        mem_usage = True
 
     if mem_usage:
         current_usages_start = get_current_mem_usage()
         peak_usages_start = get_peak_mem_usage()
 
+    timer_result = _TimerResult()
     errmsg = ""
     try:
-        yield
+        yield timer_result
     except BaseException as e:
         frame, lineno = list(traceback.walk_tb(e.__traceback__))[-1]
         errmsg = f"{e!r} @ {frame.f_code.co_filename}:{lineno}"
@@ -416,9 +444,12 @@ def time_this(
         # mypy stop complaining when additional parameters will be added below.
         params = list(args) if args else []
 
+        duration = end - start
+        timer_result.duration = duration
+
         # Specify stacklevel to ensure the message is reported from the
         # caller (1 is this file, 2 is contextlib, 3 is user)
-        params += (": " if msg else "", end - start)
+        params += (": " if msg else "", duration)
         msg += "%sTook %.4f seconds"
         if errmsg:
             params += (f" (timed code triggered exception of {errmsg!r})",)
@@ -442,10 +473,18 @@ def time_this(
                 _LOG.warning("Invalid memory unit '%s', using '%s' instead", mem_unit, u.byte)
                 mem_unit = u.byte
 
+            current_usage = current_usage.to(mem_unit)
+            current_delta = current_delta.to(mem_unit)
+            peak_delta = peak_delta.to(mem_unit)
+
+            timer_result.mem_current_usage = float(current_usage.value)
+            timer_result.mem_current_delta = float(current_delta.value)
+            timer_result.mem_peak_delta = float(peak_delta.value)
+
             msg += (
-                f"; current memory usage: {current_usage.to(mem_unit):{mem_fmt}}"
-                f", delta: {current_delta.to(mem_unit):{mem_fmt}}"
-                f", peak delta: {peak_delta.to(mem_unit):{mem_fmt}}"
+                f"; current memory usage: {current_usage:{mem_fmt}}"
+                f", delta: {current_delta:{mem_fmt}}"
+                f", peak delta: {peak_delta:{mem_fmt}}"
             )
         log.log(level, msg, *params, stacklevel=3)
 

lsst/utils/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "29.2025.1700"
+__version__ = "29.2025.1900"

{lsst_utils-29.2025.1700.dist-info → lsst_utils-29.2025.1900.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lsst-utils
-Version: 29.2025.1700
+Version: 29.2025.1900
 Summary: Utility functions from Rubin Observatory Data Management for the Legacy Survey of Space and Time (LSST).
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License: BSD 3-Clause License
@@ -27,6 +27,7 @@ Provides-Extra: test
 Requires-Dist: pytest>=3.2; extra == "test"
 Provides-Extra: plotting
 Requires-Dist: matplotlib; extra == "plotting"
+Requires-Dist: seaborn; extra == "plotting"
 Dynamic: license-file
 
 ==========

{lsst_utils-29.2025.1700.dist-info → lsst_utils-29.2025.1900.dist-info}/RECORD

@@ -14,19 +14,19 @@ lsst/utils/packages.py,sha256=D2eD2Qy3P_Os7RbUKsG2mPyLoSLjqejUX6lNhaC16wg,27455
 lsst/utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lsst/utils/tests.py,sha256=1cjyXtEL2LNhnPKjtiTt9cdPmlaEWgaWBx9BfM-xSmA,39152
 lsst/utils/threads.py,sha256=WNl3uvbE7bx5UyxTX0fwN5AkU3Yty_m8y_pMKcMCdv8,2551
-lsst/utils/timer.py,sha256=i7MCe6AeGPuHi4SReELJK5fQER-tHOA-1PreQoo83X4,18472
+lsst/utils/timer.py,sha256=Vt5yTuyGL-EAQ9ZE9rtzYLNRQDQ3njN97J5_kZn9Kh4,19923
 lsst/utils/usage.py,sha256=qunydx-KlcbNp-vFcBtvBayWwZAa0tHtSWvz5BycvLA,4598
-lsst/utils/version.py,sha256=k6PcnewHb2vETZCsCS6q8mJ_uyMg-otfwuQ8B0oDDwQ,55
+lsst/utils/version.py,sha256=duakYcQBT5t4KBaOX14WCtq_sSvpoXvNcxi3sUb8GvI,55
 lsst/utils/wrappers.py,sha256=KCvsrGXziLQ5pC8ytiFEXeDH9mBSo8eCZ8g08f7s404,19209
 lsst/utils/plotting/__init__.py,sha256=OEAZv2W12UAcUfDxH5H_k8v7cK4fVTOssuqNksZTuIs,507
 lsst/utils/plotting/figures.py,sha256=dPJfP0W-GkRhv6bEiPzH7kLV0a4MIrtavmLbGv7Wt9E,4167
 lsst/utils/plotting/limits.py,sha256=6ilPmb4wg4aVtjlBgm75FPBrjDVSkW_ywZrj_QIQD2U,5839
-lsst/utils/plotting/publication_plots.py,sha256=rWHxe4PL3R0UpacmlJ8NCLLDgbUZyxXCd08ru6OFLs8,1607
-lsst/utils/plotting/rubin.mplstyle,sha256=S1h7MX5KeMIrEWuOO6e_jF27AOYJ5hZ1hjCKQkwgHLg,1084
-lsst_utils-29.2025.1700.dist-info/licenses/COPYRIGHT,sha256=I6Bxnp_LkIqDjafZNIXM8jfjYWC4XIlpNpZ7jkdeZK0,361
-lsst_utils-29.2025.1700.dist-info/licenses/LICENSE,sha256=7wrtgl8meQ0_RIuv2TjIKpAnNrl-ODH-QLwyHe9citI,1516
-lsst_utils-29.2025.1700.dist-info/METADATA,sha256=Xrb6Tn9mbUETSnUq38spw-L4oUcCgoOiok282-3DrPY,1647
-lsst_utils-29.2025.1700.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-lsst_utils-29.2025.1700.dist-info/top_level.txt,sha256=eUWiOuVVm9wwTrnAgiJT6tp6HQHXxIhj2QSZ7NYZH80,5
-lsst_utils-29.2025.1700.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-lsst_utils-29.2025.1700.dist-info/RECORD,,
+lsst/utils/plotting/publication_plots.py,sha256=nwttKC3818okJFZrquuRDDsnOys3WflGGZOmpZ0hcLI,4739
+lsst/utils/plotting/rubin.mplstyle,sha256=SaonqdWUIOT8Z4f5oplS21Z6wmYVjuCs--PyJnjS8us,1084
+lsst_utils-29.2025.1900.dist-info/licenses/COPYRIGHT,sha256=I6Bxnp_LkIqDjafZNIXM8jfjYWC4XIlpNpZ7jkdeZK0,361
+lsst_utils-29.2025.1900.dist-info/licenses/LICENSE,sha256=7wrtgl8meQ0_RIuv2TjIKpAnNrl-ODH-QLwyHe9citI,1516
+lsst_utils-29.2025.1900.dist-info/METADATA,sha256=ANxPW4PKoqla8ES6HaY8F90hyFSo9FDLoWSgrprRwA8,1691
+lsst_utils-29.2025.1900.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+lsst_utils-29.2025.1900.dist-info/top_level.txt,sha256=eUWiOuVVm9wwTrnAgiJT6tp6HQHXxIhj2QSZ7NYZH80,5
+lsst_utils-29.2025.1900.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+lsst_utils-29.2025.1900.dist-info/RECORD,,

{lsst_utils-29.2025.1700.dist-info → lsst_utils-29.2025.1900.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (79.0.1)
+Generator: setuptools (80.3.1)
 Root-Is-Purelib: true
 Tag: py3-none-any