__author__ = "Jwely"
__all__ = ["raster_fig"]
# standard imports
import matplotlib.pyplot as plt
class raster_fig:
[docs] """
raster_fig objects are used for heads up displays of raster
data to the user.
:param numpy_rast: a numpy array representing araster dataset
:param title: title to put on the raster figure plot
"""
def __init__(self, numpy_rast, title = False):
""" initializes the raster figure """
self.numpy_rast = numpy_rast
self.title = title
self.make_fig()
return
def make_fig(self):
[docs] """ function to set up an initial figure """
self.fig, ax = plt.subplots()
self.fig.show()
self.im = ax.imshow(self.numpy_rast)
if self.title:
self.fig.suptitle(self.title, fontsize = 20)
self.im.set_data(self.numpy_rast)
self.fig.canvas.draw()
return
def update_fig(self, numpy_rast, title = False):
[docs] """
Function to update a figure that already exists.
:param numpy_rast: a numpy array representing a raster dataset
:param title: title to put on the raster figure object
"""
if title:
self.fig.suptitle(title, fontsize = 20)
self.im.set_data(numpy_rast)
self.fig.canvas.draw()
return
def close_fig(self):
[docs] """ closes an active figure """
plt.close(self.fig)
return