wobble_movie¶
- irispy.utils.wobble_movie(files: list | str | Path, *, outdir: str | Path = './', trim: bool = False, timestamp: bool = True, wobble_cadence: int = 180, ffmpeg_path: str | Path | None = None, **kwargs) None [source]¶
Creates a wobble movie from a list of files.
..note:
This requires FFMPEG to be installed and discoverable. If FFMPEG is not found, you can pass it as an argument called
ffmpeg_path
.- Parameters:
files (Union[list, str, Path]) – Files to create a wobble movie from. If a string or Path is passed, it will encapsulated in a list.
outdir (Union[str,Path], optional) – Location to save the movie(s). Defaults to the current working directory.
trim (
bool
, optional) – Movie is trimmed to include only area that has data in all frames, by default Falsetimestamp (
bool
, optional) – IfTrue
, will add a timestamp to the wobble movie. Optional, defaults toTrue
.wobble_cadence (
int
, optional) – Sets the cadence of the wobble movie in seconds. Optional, defaults to 180 seconds.ffmpeg_path (Union[str,Path], optional) – Path to FFMPEG executable, by default
None
. In theory you will not need to do this but matplotlib might not be able to find the ffmpeg exe.**kwargs (
dict
, optional) – Keyword arguments to passed toFuncAnimation
.
- Returns:
A list of the movies created.
- Return type:
Notes
This is designed to be used on IRIS Level 2 SJI data.
2832 is considered the best wavelength to use for wobble movies.
Timestamps take the main header cadence and add that to the “DATEOBS”. They do not use the information in the AUX array.