jan/gridlock
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clean up documentation and default values

Browse Source
This commit is contained in:
jan 2016-05-25 21:29:57 -07:00
parent 0a95bcda1b
commit 4e0e71fad9
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
gridlock/grid.py
View File

@ -171,7 +171,7 @@ class Grid(object):
def ind2pos(self, def ind2pos(self,
ind: numpy.ndarray or List, ind: numpy.ndarray or List,
which_shifts: int or None=None, which_shifts: int = None,
round_ind: bool = True, round_ind: bool = True,
check_bounds: bool = True check_bounds: bool = True
) -> numpy.ndarray: ) -> numpy.ndarray:
@ -753,7 +753,7 @@ class Grid(object):
:param center: Scalar specifying position along surface_normal axis. :param center: Scalar specifying position along surface_normal axis.
:param which_shifts: Which grid to display. Default is the first grid (0). :param which_shifts: Which grid to display. Default is the first grid (0).
:param sample_period: Period for down-sampling the image. Default 1 (disabled) :param sample_period: Period for down-sampling the image. Default 1 (disabled)
:param finalize: Whether to call pyplot.show() after constructing the plot. :param finalize: Whether to call pyplot.show() after constructing the plot. Default True
""" """
from matplotlib import pyplot from matplotlib import pyplot
@ -790,6 +790,7 @@ class Grid(object):
:param which_shifts: Which grid to display. Default is the first grid (0). :param which_shifts: Which grid to display. Default is the first grid (0).
:param sample_period: Period for down-sampling the image. Default 1 (disabled) :param sample_period: Period for down-sampling the image. Default 1 (disabled)
:param show_edges: Whether to draw triangle edges. Default True :param show_edges: Whether to draw triangle edges. Default True
:param finalize: Whether to call pyplot.show() after constructing the plot. Default True
""" """
from matplotlib import pyplot from matplotlib import pyplot
import skimage.measure import skimage.measure