morphfits.plots#

Visualize output data from MorphFITS.

Attributes#

`logger`	Logger object for processes from this module.
`pos`
`colours`
`colour_names`
`JHIVE_CMAP`	Colormap using J-HIVE colors.
`FIGURE_COLOR`
`TEXT_COLOR`
`FIGURE_SIZE`
`FIGURE_TITLE_SIZE`
`FIGURE_LABEL_SIZE`
`TICK_LABEL_SIZE`
`LINE_STYLES`
`current_line_style`	Set default line styles for rotation.

Functions#

`next_line_style`(→ tuple)	Get the next line style in a rotating list.
`reset_line_style`()	Reset the line style iterator.
`get_y_ticks`(→ list[int])	Get a list of y tick positions based on the maximum value.
`plot_model`(output_root, product_root, field, ...[, ...])	Plot all models for a given FICL.
`plot_histogram`(run_root, datetime, run_number)	Plot a histogram for each important fitting parameter, across filters,
`plot_objects`(output_root, product_root, field, ...[, ...])	Plot all objects for a given FICL.

Module Contents#

morphfits.plots.logger#: Logger object for processes from this module.

morphfits.plots.pos = [0.0, 0.008, 0.3, 0.5, 0.7, 1.0]#

morphfits.plots.colours#

morphfits.plots.colour_names = ['red', 'green', 'blue']#

morphfits.plots.JHIVE_CMAP#: Colormap using J-HIVE colors.

morphfits.plots.FIGURE_COLOR = 'black'#

morphfits.plots.TEXT_COLOR = 'white'#

morphfits.plots.FIGURE_SIZE = (12, 8)#

morphfits.plots.FIGURE_TITLE_SIZE = 20#

morphfits.plots.FIGURE_LABEL_SIZE = 12#

morphfits.plots.TICK_LABEL_SIZE = 8#

morphfits.plots.LINE_STYLES = [('solid', '-'), ('dotted', (0, (1, 1))), ('dashed', (0, (5, 5))), ('dashdotted', (0, (3, 5, 1,...#

morphfits.plots.current_line_style = 0#: Set default line styles for rotation.

morphfits.plots.next_line_style() → tuple#

Get the next line style in a rotating list.

Returns:: Line style definition for linestyle style parameter.
Return type:: tuple

morphfits.plots.reset_line_style()#: Reset the line style iterator.

morphfits.plots.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.

Parameters:

max_count (int | float) – Maximum y tick value.
num_ticks (int, optional) – Number of y tick values to generate, by default 6.

Returns:

List of y tick positions.

Return type:

list[int]

morphfits.plots.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.

Parameters:

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

morphfits.plots.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.

Parameters:

run_root (Path) – Path to root directory of runs.
datetime (dt) – Datetime of run, in ‘yyyymmddThhMMss’ format.
run_number (int) – Number of run if there are multiple of the same datetime.

morphfits.plots.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.

Parameters:

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