opticam.plotting.gifs
Functions
|
Create an alignment GIF frame. |
|
Create a GIF file from the frames saved in out_directory. |
Module Contents
- opticam.plotting.gifs.create_gif_frame(file, out_directory, aperture_selector, catalog, key, instrument, transforms, reference_file, rebin_factor, background)
Create an alignment GIF frame.
Parameters
- fileMEFSlice
The MEFSlice instance representing the image.
- out_directoryPath
The output directory.
- aperture_selectorCallable
The aperture selector function.
- catalogQTable
The catalogue.
- keystr
The camera:filter key.
- instrumentInstrument
The instrument that produced the image.
- transformsDict[str, List[float]]
The alignment transformations.
- reference_fileMEFSlice
The MEFSlice instance representing the reference file.
- rebin_factorint
The image rebin factor.
- backgroundBaseBackground
The background estimator.
- Parameters:
file (opticam.mef_slice.MEFSlice)
out_directory (pathlib.Path)
aperture_selector (Callable)
catalog (astropy.table.QTable)
key (str)
instrument (opticam.instruments.Instrument)
transforms (Dict[str, List[float]])
reference_file (opticam.mef_slice.MEFSlice)
rebin_factor (int)
background (opticam.background.global_background.BaseBackground)
- Return type:
None
- opticam.plotting.gifs.compile_gif(out_directory, key, camera_files, keep_frames)
Create a GIF file from the frames saved in out_directory.
Parameters
- out_directoryPath
The output directory.
- keystr
The camera:filter key.
- camera_filesDict[str, List[MEFSlice]]
The image files grouped by filter.
- keep_framesbool
Whether to keep the frames after the GIT file is saved.
- Parameters:
out_directory (pathlib.Path)
key (str)
camera_files (Dict[str, List[opticam.mef_slice.MEFSlice]])
keep_frames (bool)
- Return type:
None