"""
=============================
Plotting a RippleImageSeries
=============================

A RippleImageSeries is simply a container class for a list of RippleImages.

This example demonstrates how to plot a RippleImageSeries using inbuilt plotting methods.
"""

from matplotlib import pyplot as plt

from ripplemapper.analyse import (add_a_star_contours, add_boundary_contours,
                                  add_chan_vese_contours)
from ripplemapper.classes import RippleImageSeries
from ripplemapper.data.example import example_dir
from ripplemapper.io import load_dir_to_obj

#################################################################
#
# We can create a list of RippleImages from a list of image files.
# In this example we use the load_dir_to_obj method to load all images in a directory into RippleImage objects.
#
# Passing this list to the RippleImageSeries constructor will create a RippleImageSeries object.

ripple_images = load_dir_to_obj(example_dir)
series = RippleImageSeries(ripple_images)
add_boundary_contours(series, sigma=2)
add_a_star_contours(series)
add_chan_vese_contours(series)

#################################################################
#
# We can produce an animation with the `RippleImageSeries.animate` method.
#
# Passing a file name to the method will save the animation to a file.
# Disable the plotting of ripple contours by setting `include_contours=False`.

animation = series.animate()
plt.show()