Module: visualizer#

class kbmod.analysis.visualizer.Visualizer(im_stack, results)[source]#

A class for visualizing from a given ImageStack and Results set.

Attributes:
im_stackkbmod.search.ImageStack

ImageStack associated with the results.

resultskbmod.Results

The loaded Results.

Methods

count_num_days()

Counts the number of days that a given result has valid data in and adds a new column called num_days to the results table.

generate_all_stamps([radius])

Creates a stamp cutout for each image for each result.

plot_daily_coadds(result_idx[, filename, ...])

Plots a coadded stamp for each day of valid observations for a given result.

count_num_days()[source]#

Counts the number of days that a given result has valid data in and adds a new column called num_days to the results table.

generate_all_stamps(radius=10)[source]#

Creates a stamp cutout for each image for each result. Also creates a new column in the results table called all_stamps.

Parameters:
radiusint

radius of the stamp.

plot_daily_coadds(result_idx, filename=None, cmap=None, clim=None)[source]#

Plots a coadded stamp for each day of valid observations for a given result.

Parameters:
result_idxint

Index of the result to plot.

filenamestr or None

If filename is provided, write out the plot to an image file.

cmapstr or None

Colormap to use for the plot.

climtuple or None

Color limits for the plot. (vmin and vmax)

Raises:
RuntimeError if num_days or all_stamps are not in the
results table (i.e. not been generated with count_num_days or
generate_all_stamps).