opticam.plotting.plots
Functions
|
Plot the source catalogs. |
|
Plot the times between files. Useful for identifying gaps. |
|
Plot the time-varying background for each camera. |
|
Plot the background meshes on top of the catalog images. |
|
Plot the growth curves given a (stacked) image and a source catalog. |
Module Contents
- opticam.plotting.plots.plot_catalogs(out_directory, stacked_images, catalogs, show, save)
Plot the source catalogs.
Parameters
- out_directorystr
The directory path to which the resulting plot will be saved.
- filtersList[str]
The catalog filters.
- stacked_imagesDict[str, NDArray]
The stacked images for each filter {filter: image}.
- showbool
Whether to show the plot.
- savebool
Whether to save the plot.
- Parameters:
out_directory (str)
stacked_images (Dict[str, numpy.typing.NDArray])
catalogs (Dict[str, astropy.table.QTable])
show (bool)
save (bool)
- Return type:
None
- opticam.plotting.plots.plot_time_between_files(out_directory, camera_files, bmjds, show, save)
Plot the times between files. Useful for identifying gaps.
Parameters
- out_directorystr
The directory path to which the resulting plot will be saved.
- camera_filesDict[str, List[str]]
The file paths separated by camera {filter: file paths}.
- bmjdsDict[str, float]
The file time stamps {file path: time stamp}.
- showbool
Whether to show the plot.
- savebool
Whether to save the plot.
- Parameters:
out_directory (str)
camera_files (Dict[str, List[str]])
bmjds (Dict[str, float])
show (bool)
save (bool)
- Return type:
None
- opticam.plotting.plots.plot_backgrounds(out_directory, camera_files, background_median, background_rms, bmjds, t_ref, show, save)
Plot the time-varying background for each camera.
Parameters
- camera_filesDict[str, str]
The files for each camera {fltr: file}.
- background_medianDict[str, List]
The median background for each camera.
- background_rmsDict[str, List]
The background RMS for each camera.
- bmjdsDict[str, float]
The Barycentric MJD dates for each image {file: BMJD}.
- t_reffloat
The reference BMJD.
- out_directorystr
The directory to which the resulting files will be saved.
- show: bool
Whether to display the plot.
- savebool
Whether to save the plot.
- Parameters:
out_directory (str)
camera_files (Dict[str, List[str]])
background_median (Dict[str, Dict[str, numpy.typing.NDArray]])
background_rms (Dict[str, Dict[str, numpy.typing.NDArray]])
bmjds (Dict[str, float])
t_ref (float)
show (bool)
save (bool)
- Return type:
None
- opticam.plotting.plots.plot_background_meshes(out_directory, filters, stacked_images, background, show, save)
Plot the background meshes on top of the catalog images.
Parameters
- stacked_imagesDict[str, NDArray]
The stacked images for each camera.
- showbool
Whether to display the plot.
- Parameters:
out_directory (str)
filters (List[str])
stacked_images (Dict[str, numpy.typing.NDArray])
background (opticam.background.global_background.BaseBackground)
show (bool)
save (bool)
- Return type:
None
- opticam.plotting.plots.plot_growth_curves(image, cat, targets, psf_params)
Plot the growth curves given a (stacked) image and a source catalog.
Parameters
- imageNDArray
The image.
- catQTable
The catalog corresponding to image.
- targetsint | List[int]
The target(s) for which growth curves are to be computed.
- psf_paramsDict
The PSF parameters.
Returns
- Figure
The growth curve plots.
- Parameters:
image (numpy.typing.NDArray)
cat (astropy.table.QTable)
targets (int | List[int])
psf_params (Dict)
- Return type:
matplotlib.figure.Figure