API reference
=============

Every name below is exported from the top-level ``pyvcad_medical`` package.

.. currentmodule:: pyvcad_medical

Color palettes
--------------

.. py:data:: raw_color_palettes
   :type: dict[str, list[tuple[int, int, int]]]

   Named color palettes: ``"grayscale"``, ``"jet"``, ``"rainbow"``, ``"viridis"``, ``"cividis"``
   and ``"magma"``. Each value is a list of ``(r, g, b)`` stops with channels in 0-255, ordered from
   the low end of the scale to the high end. Add an entry to make a custom palette available to
   :func:`get_color_palette`.

.. autofunction:: get_color_palette

.. autofunction:: interp_color

.. autofunction:: lerp

Opacity curves
--------------

.. autofunction:: linear_opacity_base

.. autofunction:: sigmoid_opacity_base

.. autofunction:: re_range_opacity

.. autofunction:: plot_opacity_function

HU lookup tables
----------------

.. autofunction:: create_linear_gradient_hu_map

.. autofunction:: plot_hu_color_map

DICOM inspection
----------------

.. autofunction:: print_loaded_dicom_info