morphfits.plots
===============

.. py:module:: morphfits.plots

.. autoapi-nested-parse::

   Visualize output data from MorphFITS.



Attributes
----------

.. autoapisummary::

   morphfits.plots.logger
   morphfits.plots.pos
   morphfits.plots.colours
   morphfits.plots.colour_names
   morphfits.plots.JHIVE_CMAP
   morphfits.plots.FIGURE_COLOR
   morphfits.plots.TEXT_COLOR
   morphfits.plots.FIGURE_SIZE
   morphfits.plots.FIGURE_TITLE_SIZE
   morphfits.plots.FIGURE_LABEL_SIZE
   morphfits.plots.TICK_LABEL_SIZE
   morphfits.plots.LINE_STYLES
   morphfits.plots.current_line_style


Functions
---------

.. autoapisummary::

   morphfits.plots.next_line_style
   morphfits.plots.reset_line_style
   morphfits.plots.get_y_ticks
   morphfits.plots.plot_model
   morphfits.plots.plot_histogram
   morphfits.plots.plot_objects


Module Contents
---------------

.. py:data:: logger

   Logger object for processes from this module.

.. py:data:: pos
   :value: [0.0, 0.008, 0.3, 0.5, 0.7, 1.0]


.. py:data:: colours

.. py:data:: colour_names
   :value: ['red', 'green', 'blue']


.. py:data:: JHIVE_CMAP

   Colormap using J-HIVE colors.

.. py:data:: FIGURE_COLOR
   :value: 'black'


.. py:data:: TEXT_COLOR
   :value: 'white'


.. py:data:: FIGURE_SIZE
   :value: (12, 8)


.. py:data:: FIGURE_TITLE_SIZE
   :value: 20


.. py:data:: FIGURE_LABEL_SIZE
   :value: 12


.. py:data:: TICK_LABEL_SIZE
   :value: 8


.. py:data:: LINE_STYLES
   :value: [('solid', '-'), ('dotted', (0, (1, 1))), ('dashed', (0, (5, 5))), ('dashdotted', (0, (3, 5, 1,...


.. py:data:: current_line_style
   :value: 0


   Set default line styles for rotation.

.. py:function:: next_line_style() -> tuple

   Get the next line style in a rotating list.

   :returns: Line style definition for `linestyle` style parameter.
   :rtype: tuple


.. py:function:: reset_line_style()

   Reset the line style iterator.


.. py:function:: get_y_ticks(max_count: int | float, num_ticks: int = 6) -> list[int]

   Get a list of y tick positions based on the maximum value.

   :param max_count: Maximum y tick value.
   :type max_count: int | float
   :param num_ticks: Number of y tick values to generate, by default 6.
   :type num_ticks: int, optional

   :returns: List of y tick positions.
   :rtype: list[int]


.. py:function:: plot_model(output_root: pathlib.Path, product_root: pathlib.Path, field: str, image_version: str, catalog_version: str, filter: str, objects: list[int], wrapper: str, display_progress: bool = False)

   Plot all models for a given FICL.

   :param output_root: Path to root output directory.
   :type output_root: Path
   :param product_root: Path to root products directory.
   :type product_root: Path
   :param field: Field of observation.
   :type field: str
   :param image_version: Image processing version of observation data.
   :type image_version: str
   :param catalog_version: Cataloguing version of objects in observation.
   :type catalog_version: str
   :param filter: Filter band of observation.
   :type filter: str
   :param objects: Objects to be plotted.
   :type objects: list[int]
   :param wrapper: Morphology fitting wrapper program name.
   :type wrapper: str
   :param display_progress: Display progress via tqdm, by default False.
   :type display_progress: bool, optional


.. py:function:: plot_histogram(run_root: pathlib.Path, datetime: datetime.datetime, run_number: int)

   Plot a histogram for each important fitting parameter, across filters,
   for a given run.

   :param run_root: Path to root directory of runs.
   :type run_root: Path
   :param datetime: Datetime of run, in 'yyyymmddThhMMss' format.
   :type datetime: dt
   :param run_number: Number of run if there are multiple of the same datetime.
   :type run_number: int


.. py:function:: plot_objects(output_root: pathlib.Path, product_root: pathlib.Path, field: str, image_version: str, catalog_version: str, filter: str, objects: list[int], columns: int = 8, display_progress: bool = False)

   Plot all objects for a given FICL.

   :param output_root: Path to root output directory.
   :type output_root: Path
   :param product_root: Path to root products directory.
   :type product_root: Path
   :param field: Field of observation.
   :type field: str
   :param image_version: Image processing version of observation data.
   :type image_version: str
   :param catalog_version: Cataloguing version of objects in observation.
   :type catalog_version: str
   :param filter: Filter band of observation.
   :type filter: str
   :param objects: Objects to be plotted.
   :type objects: list[int]
   :param columns: Number of columns in visualization, by default 8.
   :type columns: int, optional
   :param display_progress: Display progress via tqdm, by default False.
   :type display_progress: bool, optional