rms-picmaker 1.0.0__py3-none-any.whl

picmaker/__init__.py

@@ -0,0 +1,95 @@
+"""rms-picmaker — convert PDS3/VICAR/FITS images to JPEG, TIFF, etc.
+
+The package's public surface is re-exported from this module so that
+consumers can write::
+
+    from picmaker import images_to_pics, read_one_image_array
+
+The top-level pipeline entry point is
+:func:`picmaker.pipeline.images_to_pics`; the single-image reader is
+:func:`picmaker.io.read_one_image_array`. The full set of public
+names is in this module's ``__all__`` list.
+"""
+
+try:
+    from importlib.metadata import PackageNotFoundError
+    from importlib.metadata import version as _version
+
+    __version__ = _version('rms-picmaker')
+except PackageNotFoundError:  # pragma: no cover — only fires when the package isn't installed
+    try:
+        from picmaker._version import __version__
+    except ImportError:
+        __version__ = '0.0.0+unknown'
+
+from picmaker._filters import FILTER_DICT, filter_image
+from picmaker.cli import main
+from picmaker.color import BFUNC, GFUNC, RFUNC, RGB_BY_NM, tinted_colormap
+from picmaker.enhance import (
+    apply_colormap,
+    apply_gamma,
+    fill_zebra_stripes,
+    get_limits,
+)
+from picmaker.geometry import (
+    circle_mask,
+    crop_array,
+    get_size,
+    pad_image,
+    resize_image,
+    rotate_array_rgb,
+    slice_array,
+    wrap_image,
+)
+from picmaker.io import (
+    FilterInfo,
+    ReadResult,
+    get_outfile,
+    read_array,
+    read_image_array,
+    read_one_image_array,
+    read_pds_labeled_image_array,
+    read_pil,
+)
+from picmaker.options import PicmakerOptions
+from picmaker.pil_utils import array_to_pil, pil_to_array, write_pil
+from picmaker.pipeline import find_common_path, images_to_pics, process_images
+
+__all__ = [
+    'BFUNC',
+    'FILTER_DICT',
+    'GFUNC',
+    'RFUNC',
+    'RGB_BY_NM',
+    'FilterInfo',
+    'PicmakerOptions',
+    'ReadResult',
+    '__version__',
+    'apply_colormap',
+    'apply_gamma',
+    'array_to_pil',
+    'circle_mask',
+    'crop_array',
+    'fill_zebra_stripes',
+    'filter_image',
+    'find_common_path',
+    'get_limits',
+    'get_outfile',
+    'get_size',
+    'images_to_pics',
+    'main',
+    'pad_image',
+    'pil_to_array',
+    'process_images',
+    'read_array',
+    'read_image_array',
+    'read_one_image_array',
+    'read_pds_labeled_image_array',
+    'read_pil',
+    'resize_image',
+    'rotate_array_rgb',
+    'slice_array',
+    'tinted_colormap',
+    'wrap_image',
+    'write_pil',
+]

picmaker/_filters.py

@@ -0,0 +1,60 @@
+"""PIL filter dispatch helpers."""
+
+from typing import Any
+
+from PIL import ImageFilter
+
+FILTER_DICT: dict[str, Any] = {
+    'NONE': None,
+    'BLUR': ImageFilter.BLUR,
+    'CONTOUR': ImageFilter.CONTOUR,
+    'DETAIL': ImageFilter.DETAIL,
+    'EDGE_ENHANCE': ImageFilter.EDGE_ENHANCE,
+    'EDGE_ENHANCE_MORE': ImageFilter.EDGE_ENHANCE_MORE,
+    'EMBOSS': ImageFilter.EMBOSS,
+    'FIND_EDGES': ImageFilter.FIND_EDGES,
+    'SMOOTH': ImageFilter.SMOOTH,
+    'SMOOTH_MORE': ImageFilter.SMOOTH_MORE,
+    'SHARPEN': ImageFilter.SHARPEN,
+    'MEDIAN_3': ImageFilter.MedianFilter(3),
+    'MEDIAN_5': ImageFilter.MedianFilter(5),
+    'MEDIAN_7': ImageFilter.MedianFilter(7),
+    'MINIMUM_3': ImageFilter.MinFilter(3),
+    'MINIMUM_5': ImageFilter.MinFilter(5),
+    'MINIMUM_7': ImageFilter.MinFilter(7),
+    'MAXIMUM_3': ImageFilter.MaxFilter(3),
+    'MAXIMUM_5': ImageFilter.MaxFilter(5),
+    'MAXIMUM_7': ImageFilter.MaxFilter(7),
+}
+
+
+def filter_image(image: Any, filter_name: str) -> Any:
+    """Apply an arbitrary filter to a PIL image.
+
+    Two-byte (16-bit) images are not supported and raise ``ValueError``.
+
+    Parameters:
+        image: A PIL image as 8-bit RGB or grayscale.
+        filter_name: Name of the filter to be applied. Valid choices are the
+            keys of ``FILTER_DICT`` (case-insensitive). ``'NONE'`` returns
+            the input image unchanged.
+
+    Returns:
+        The filtered PIL image. For ``filter_name='NONE'`` the input
+        image is returned unchanged.
+
+    Raises:
+        ValueError: If ``image`` is a list (16-bit two-byte image).
+        KeyError: If ``filter_name`` (case-folded) is not a key of
+            :data:`picmaker._filters.FILTER_DICT`.
+    """
+    if isinstance(image, list):
+        raise ValueError('filtering of 2-byte images is not supported')
+
+    filter_method = FILTER_DICT[filter_name.upper()]
+    if filter_method:
+        image = image.filter(filter_method)
+    return image
+
+
+__all__ = ['FILTER_DICT', 'filter_image']

picmaker/_rgb.py

@@ -0,0 +1,37 @@
+"""Wavelength → RGB lookup tables.
+
+Maps wavelengths in the 380-750 nm range to an ``(R, G, B)`` triple
+suitable for tinting a grayscale image. ``RGB_BY_NM`` holds the raw
+table; ``RFUNC``, ``GFUNC``, and ``BFUNC`` are
+:class:`tabulation.Tabulation` splines that interpolate between
+adjacent rows so the caller can query at any wavelength.
+
+This module imports nothing from the rest of :mod:`picmaker`, which
+lets :mod:`picmaker.color` and :mod:`picmaker.instruments.hst` both
+read the same tables without forming an import cycle.
+"""
+
+import numpy as np
+from numpy.typing import NDArray
+from tabulation import Tabulation
+
+# [wavelength_nm, r, g, b] — values are floats (RGB channels can fall
+# between 60.5 and 255.999), so the dtype is float64, not uint8.
+RGB_BY_NM: NDArray[np.float64] = np.array(
+    [
+        [380.0, 200.500, 60.500, 255.999],  # uv
+        [410.0, 200.500, 110.500, 255.999],  # violet
+        [480.0, 110.500, 110.500, 255.999],  # blue
+        [540.0, 110.500, 255.999, 110.500],  # green
+        [580.0, 255.999, 255.999, 110.500],  # yellow
+        [610.0, 255.999, 180.500, 110.500],  # orange
+        [650.0, 255.999, 110.500, 110.500],  # red
+        [750.0, 255.999, 60.500, 60.500],  # ir
+    ]
+)
+
+RFUNC: Tabulation = Tabulation(RGB_BY_NM[:, 0], RGB_BY_NM[:, 1])
+GFUNC: Tabulation = Tabulation(RGB_BY_NM[:, 0], RGB_BY_NM[:, 2])
+BFUNC: Tabulation = Tabulation(RGB_BY_NM[:, 0], RGB_BY_NM[:, 3])
+
+__all__ = ['BFUNC', 'GFUNC', 'RFUNC', 'RGB_BY_NM']

picmaker/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '1.0.0'
+__version_tuple__ = version_tuple = (1, 0, 0)
+
+__commit_id__ = commit_id = None