reV.qa_qc.summary.ExclusionsMask

class ExclusionsMask(excl_mask)[source]

Bases: PlotBase

Plot Exclusions mask as a heat map data for QA/QC

Parameters:: excl_mask (str | ndarray) – Exclusions mask or path to .npy file containing final mask

Methods

`exclusions_plot`([cmap, plot_step, out_path])	Plot exclusions mask as a seaborn heatmap
`exclusions_plotly`([cmap, plot_step, out_path])	Plot exclusions mask as a plotly heatmap
`plot`(mask, out_dir[, plot_type, cmap, plot_step])	Plot exclusions mask and save to out_dir

Attributes

`data`	Data to plot
`mask`	Final Exclusions mask

property mask

Final Exclusions mask

exclusions_plot(cmap='Viridis', plot_step=100, out_path=None, **kwargs)[source]

Plot exclusions mask as a seaborn heatmap

Parameters:

cmap (str | px.color, optional) – Continuous color scale to use, by default ‘Viridis’
plot_step (int) – Step between points to plot
out_path (str, optional) – File path to save plot to, can be a .html or static image, by default None
kwargs (dict) – Additional kwargs for plotting.colormaps.heatmap_plot

exclusions_plotly(cmap='Viridis', plot_step=100, out_path=None, **kwargs)[source]

Plot exclusions mask as a plotly heatmap

Parameters:

cmap (str | px.color, optional) – Continuous color scale to use, by default ‘Viridis’
plot_step (int) – Step between points to plot
out_path (str, optional) – File path to save plot to, can be a .html or static image, by default None
kwargs (dict) – Additional kwargs for plotly.express.imshow

classmethod plot(mask, out_dir, plot_type='plotly', cmap='Viridis', plot_step=100, **kwargs)[source]

Plot exclusions mask and save to out_dir

Parameters:

mask (ndarray) – ndarray of final exclusions mask
out_dir (str) – Output directory to save plots to
plot_type (str, optional) – plot_type of plot to create ‘plot’ or ‘plotly’, by default ‘plotly’
cmap (str, optional) – Colormap name, by default ‘viridis’
plot_step (int) – Step between points to plot
kwargs (dict) – Additional plotting kwargs

property data

Data to plot