Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

CLIMATE-241 - Update plotter.py docstring formatting #83

Merged
merged 5 commits into from
Jul 2, 2014
Merged

CLIMATE-241 - Update plotter.py docstring formatting #83

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e867441
CLIMATE-241 - Update draw_taylor_diagram docstring format
MJJoyce Jul 1, 2014
a0fab68
CLIMATE-241 - Update draw_subregions docstring format
MJJoyce Jul 1, 2014
3ac4438
CLIMATE-241 - Update draw_time_series docstring format
MJJoyce Jul 1, 2014
007bc9a
CLIMATE-241 - Update draw_contour_map docstring format
MJJoyce Jul 1, 2014
e5ca869
CLIMATE-241 - Update draw_portrait_diagram docstring format
MJJoyce Jul 1, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
285 changes: 173 additions & 112 deletions ocw/plotter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,27 +152,37 @@ def _fig_size(gridshape, aspect=None):
def draw_taylor_diagram(results, names, refname, fname, fmt='png',
gridshape=(1,1), ptitle='', subtitles=None,
pos='upper right', frameon=True, radmax=1.5):
'''
Purpose::
Draws a Taylor diagram

Input::
results - an Nx2 array containing normalized standard deviations,
correlation coefficients, and names of evaluation results
names - list of names for each evaluated dataset
refname - The name of the reference dataset
fname - a string specifying the filename of the plot
fmt - an optional string specifying the filetype, default is .png
gridshape - optional tuple denoting the desired grid shape (nrows, ncols) for arranging
the subplots.
ptitle - an optional string specifying the plot title
subtitles - an optional list of strings specifying the title for each subplot
pos - an optional string or tuple of float for determining
the position of the legend
frameon - an optional boolean that determines whether to draw a frame
around the legend box
radmax - an optional float to adjust the extent of the axes in terms of
standard deviation.
''' Draw a Taylor diagram.

:param results: An Nx2 array containing normalized standard deviations,
correlation coefficients, and names of evaluation results.
:type results: Numpy Array
:param names: A list of names for each evaluated dataset
:type names: List of strings
:param refname: The name of the reference dataset.
:type refname: string
:param fname: The filename of the plot.
:type fname: string
:param fmt: Optional filetype for the output plot.
:type fmt: string
:param gridshape: Optional tuple denoting the desired grid shape
(num_rows, num_cols) for arranging the subplots.
:type gridshape: Tuple (num_rows, num_cols)
:param ptitle: Optional plot title.
:type ptitle: string
:param subtitles: Optional list of strings specifying the title for each
subplot.
:type subtitles: List of strings
:param pos: Optional string or tuple of floats used to set the position
of the legend. Check the `Matplotlib docs <http://matplotlib.org/api/legend_api.html#matplotlib.legend.Legend>`_
for additional information.
:type pos: string or tuple of floats
:param frameon: Optional boolean specifying whether to draw a frame
around the legend box.
:type frameon: boolean
:param radmax: Optional float to adjust the extent of the axes in terms of
standard deviation.
:type radmax: float
'''
# Handle the single plot case.
if results.ndim == 2:
Expand Down Expand Up @@ -215,22 +225,32 @@ def draw_taylor_diagram(results, names, refname, fname, fmt='png',

def draw_subregions(subregions, lats, lons, fname, fmt='png', ptitle='',
parallels=None, meridians=None, subregion_masks=None):
'''
Purpose::
Function to draw subregion domain(s) on a map

Input::
subregions - a list of subRegion objects
lats - array of latitudes
lons - array of longitudes
fname - a string specifying the filename of the plot
fmt - an optional string specifying the filetype, default is .png
ptitle - an optional string specifying plot title
parallels - an optional list of ints or floats for the parallels to be drawn
meridians - an optional list of ints or floats for the meridians to be drawn
subregion_masks - optional dictionary of boolean arrays for each subRegion
for giving finer control of the domain to be drawn, by default
the entire domain is drawn.
''' Draw subregion domain(s) on a map.

:param subregions: The subregion objects to plot on the map.
:type subregions: List of subregion objects
:param lats: Array of latitudes values.
:type lats: Numpy Array
:param lons: Array of longitudes values.
:type lons: Numpy Array
:param fname: The filename of the plot.
:type fname: string
:param fmt: Optional filetype for the output.
:type fmt: string
:param ptitle: Optional plot title.
:type ptitle: string
:param parallels: Optional list of ints or floats for the parallels to
be drawn. See the `Basemap documentation <http://matplotlib.org/basemap/users/graticule.html>`_
for additional information.
:type parallels: List of ints or floats
:param meridians: Optional list of ints or floats for the meridians to
be drawn. See the `Basemap documentation <http://matplotlib.org/basemap/users/graticule.html>`_
for additional information.
:type meridians: List of ints or floats
:param subregion_masks: Optional dictionary of boolean arrays for each
subregion for giving finer control of the domain to be drawn, by default
the entire domain is drawn.
:type subregion_masks: Dictionary of boolean arrays
'''
# Set up the figure
fig = plt.figure()
Expand Down Expand Up @@ -310,27 +330,39 @@ def draw_subregions(subregions, lats, lons, fname, fmt='png', ptitle='',
def draw_time_series(results, times, labels, fname, fmt='png', gridshape=(1, 1),
xlabel='', ylabel='', ptitle='', subtitles=None,
label_month=False, yscale='linear', aspect=None):
'''
Purpose::
Function to draw a time series plot

Input::
results - a 3d array of time series
times - a list of python datetime objects
labels - a list of strings with the names of each set of data
fname - a string specifying the filename of the plot
fmt - an optional string specifying the output filetype
gridshape - optional tuple denoting the desired grid shape (nrows, ncols) for arranging
the subplots.
xlabel - a string specifying the x-axis title
ylabel - a string specifying the y-axis title
ptitle - a string specifying the plot title
subtitles - an optional list of strings specifying the title for each subplot
label_month - optional bool to toggle drawing month labels
yscale - optional string for setting the y-axis scale, 'linear' for linear
and 'log' for log base 10.
aspect - Float denoting approximate aspect ratio of each subplot
(width / height). Default is 8.5 / 5.5
''' Draw a time series plot.

:param results: 3D array of time series data.
:type results: Numpy Array
:param times: List of Python datetime objects used by Matplotlib to handle
axis formatting.
:type times: List of datetime objects
:param labels: List of names for each data being plotted.
:type labels: List of string
:param fname: Filename of the plot.
:type fname: string
:param fmt: Optional filetype for the output.
:type fmt: string
:param gridshape: Optional tuple denoting the desired grid shape
(num_rows, num_cols) for arranging the subplots.
:type gridshape: Tuple (num_rows, num_cols)
:param xlabel: Optional x-axis title.
:type xlabel: string
:param ylabel: Optional y-ayis title.
:type ylabel: string
:param ptitle: Optional plot title.
:type ptitle: string
:param subtitles: Optional list of titles for each subplot.
:type subtitles: List of strings
:param label_month: Optional flag to toggle drawing month labels on the
x-axis.
:type label_month: boolean
:param yscale: Optional y-axis scale value, 'linear' for linear and 'log'
for log base 10.
:type yscale: string
:param aspect: Optional approximate aspect ratio of each subplot
(width / height). Default is 8.5 / 5.5
:type aspect: float
'''
# Handle the single plot case.
if results.ndim == 2:
Expand Down Expand Up @@ -430,31 +462,47 @@ def draw_contour_map(dataset, lats, lons, fname, fmt='png', gridshape=(1, 1),
clabel='', ptitle='', subtitles=None, cmap=None,
clevs=None, nlevs=10, parallels=None, meridians=None,
extend='neither', aspect=8.5/2.5):
'''
Purpose::
Create a multiple panel contour map plot.

Input::
dataset - 3d array of the field to be plotted with shape (nT, nLon, nLat)
lats - array of latitudes
lons - array of longitudes
fname - a string specifying the filename of the plot
fmt - an optional string specifying the filetype, default is .png
gridshape - optional tuple denoting the desired grid shape (nrows, ncols) for arranging
the subplots.
clabel - an optional string specifying the colorbar title
ptitle - an optional string specifying plot title
subtitles - an optional list of strings specifying the title for each subplot
cmap - an string or optional matplotlib.colors.LinearSegmentedColormap instance
denoting the colormap
clevs - an optional list of ints or floats specifying contour levels
nlevs - an optional integer specifying the target number of contour levels if
clevs is None
parallels - an optional list of ints or floats for the parallels to be drawn
meridians - an optional list of ints or floats for the meridians to be drawn
extend - an optional string to toggle whether to place arrows at the colorbar
boundaries. Default is 'neither', but can also be 'min', 'max', or
'both'. Will be automatically set to 'both' if clevs is None.
''' Draw a multiple panel contour map plot.

:param dataset: 3D array of data to be plotted with shape (nT, nLon, nLat).
:type dataset: Numpy Array
:param lats: Array of latitudes values.
:type lats: Numpy Array
:param lons: Array of longitudes
:type lons: Numpy Array
:param fname: The filename of the plot.
:type fname: string
:param fmt: Optional filetype for the output.
:type fmt: string
:param gridshape: Optional tuple denoting the desired grid shape
(num_rows, num_cols) for arranging the subplots.
:type gridshape: Tuple (num_rows, num_cols)
:param clabel: Optional colorbar title.
:type clabel: string
:param ptitle: Optional plot title.
:type ptitle: string
:param subtitles: Optional list of titles for each subplot.
:type subtitles: List of strings
:param cmap: Optional string or matplotlib.colors.LinearSegmentedColormap
instance denoting the colormap. This must be able to be recognized by
`Matplotlib's get_cmap function <http://matplotlib.org/api/cm_api.html#matplotlib.cm.get_cmap>`_.
:type cmap: string or LinearSegmentedColormap object
:param clevs: Optional contour levels values.
:type clevs: List of ints or floats
:param nlevs: Optional target number of contour levels if clevs is None.
:type nlevs: int
:param parallels: Optional list of ints or floats for the parallels to
be drawn. See the `Basemap documentation <http://matplotlib.org/basemap/users/graticule.html>`_
for additional information.
:type parallels: List of ints or floats
:param meridians: Optional list of ints or floats for the meridians to
be drawn. See the `Basemap documentation <http://matplotlib.org/basemap/users/graticule.html>`_
for additional information.
:type meridians: List of ints or floats
:param extend: Optional flag to toggle whether to place arrows at the colorbar
boundaries. Default is 'neither', but can also be 'min', 'max', or
'both'. Will be automatically set to 'both' if clevs is None.
:type extend: string
'''
# Handle the single plot case. Meridians and Parallels are not labeled for
# multiple plots to save space.
Expand Down Expand Up @@ -574,35 +622,48 @@ def draw_portrait_diagram(results, rowlabels, collabels, fname, fmt='png',
gridshape=(1, 1), xlabel='', ylabel='', clabel='',
ptitle='', subtitles=None, cmap=None, clevs=None,
nlevs=10, extend='neither', aspect=None):
'''
Purpose::
Makes a portrait diagram plot.

Input::
results - 3d array of the field to be plotted. The second dimension
should correspond to the number of rows in the diagram and the
third should correspond to the number of columns.
rowlabels - a list of strings denoting labels for each row
collabels - a list of strings denoting labels for each column
fname - a string specifying the filename of the plot
fmt - an optional string specifying the output filetype
gridshape - optional tuple denoting the desired grid shape (nrows, ncols) for arranging
the subplots.
xlabel - an optional string specifying the x-axis title
ylabel - an optional string specifying the y-axis title
clabel - an optional string specifying the colorbar title
ptitle - a string specifying the plot title
subtitles - an optional list of strings specifying the title for each subplot
cmap - an optional string or matplotlib.colors.LinearSegmentedColormap instance
denoting the colormap
clevs - an optional list of ints or floats specifying colorbar levels
nlevs - an optional integer specifying the target number of contour levels if
clevs is None
extend - an optional string to toggle whether to place arrows at the colorbar
boundaries. Default is 'neither', but can also be 'min', 'max', or
'both'. Will be automatically set to 'both' if clevs is None.
aspect - Float denoting approximate aspect ratio of each subplot
(width / height). Default is 8.5 / 5.5
''' Draw a portrait diagram plot.

:param results: 3D array of the fields to be plotted. The second dimension
should correspond to the number of rows in the diagram and the
third should correspond to the number of columns.
:type results: Numpy Array
:param rowlabels: Labels for each row.
:type rowlabels: List of strings
:param collabels: Labels for each row.
:type collabels: List of strings
:param fname: Filename of the plot.
:type fname: string
:param fmt: Optional filetype for the output.
:type fmt: string
:param gridshape: Optional tuple denoting the desired grid shape
(num_rows, num_cols) for arranging the subplots.
:type gridshape: Tuple (num_rows, num_cols)
:param xlabel: Optional x-axis title.
:type xlabel: string
:param ylabel: Optional y-ayis title.
:type ylabel: string
:param clabel: Optional colorbar title.
:type clabel: string
:param ptitle: Optional plot title.
:type ptitle: string
:param subtitles: Optional list of titles for each subplot.
:type subtitles: List of strings
:param cmap: Optional string or matplotlib.colors.LinearSegmentedColormap
instance denoting the colormap. This must be able to be recognized by
`Matplotlib's get_cmap function <http://matplotlib.org/api/cm_api.html#matplotlib.cm.get_cmap>`_.
:type cmap: string or LinearSegmentedColormap object
:param clevs: Optional contour levels values.
:type clevs: List of ints or floats
:param nlevs: Optional target number of contour levels if clevs is None.
:type nlevs: int
:param extend: Optional flag to toggle whether to place arrows at the colorbar
boundaries. Default is 'neither', but can also be 'min', 'max', or
'both'. Will be automatically set to 'both' if clevs is None.
:type extend: string
:param aspect: Optional approximate aspect ratio of each subplot
(width / height). Default is 8.5 / 5.5
:type aspect: float
'''
# Handle the single plot case.
if results.ndim == 2:
Expand Down