opticam.plotting.gifs

Functions

create_gif_frame(file, out_directory, ...)
compile_gif(out_directory, fltr, camera_files, ...)	Create a gif from the frames saved in out_directory.

Module Contents

opticam.plotting.gifs.create_gif_frame(file, out_directory, aperture_selector, catalog, fltr, gains, transforms, reference_file, flat_corrector, rebin_factor, remove_cosmic_rays, background)

Parameters:

• file (str)

• out_directory (str)

• aperture_selector (Callable)

• catalog (astropy.table.QTable)

• fltr (str)

• gains (Dict[str, float])

• transforms (Dict[str, List[float]])

• reference_file (str)

• flat_corrector (opticam.correctors.flat_field_corrector.FlatFieldCorrector | None)

• rebin_factor (int)

• remove_cosmic_rays (bool)

• background (opticam.background.global_background.BaseBackground)

Return type:

None

opticam.plotting.gifs.compile_gif(out_directory, fltr, camera_files, keep_frames, verbose)

Create a gif from the frames saved in out_directory.

Parameters

fltrstr

The filter.

keep_framesbool

Whether to keep the frames after the gif is saved.

Parameters:

• out_directory (str)

• fltr (str)

• camera_files (Dict[str, List[str]])

• keep_frames (bool)

• verbose (bool)

Return type:

None