Skip to content

Commit

Permalink
fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
QRemy committed Jan 29, 2021
1 parent 4a34886 commit 42cdf48
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions gammapy/maps/wcsnd.py
Expand Up @@ -633,17 +633,19 @@ def binary_dilate(self, width, use_fft=True, mode="same"):
width : tuple of `~astropy.units.Quantity`
Angular sizes of the margin in (lon, lat) in that specific order.
If only one value is passed, the same margin is applied in (lon, lat).
use_fft : bool
Use `scipy.signal.fftconvolve` if True (default)
and `ndi.binary_dilation` otherwise.
mode : str {'same', 'full'}
A string indicating the size of the output.
- 'same': The output is the same size as input (Default).
- 'full': The output size is extended by the width
Returns
-------
map : `WcsNDMap`
Dilated mask map
use_fft : bool
Use `scipy.signal.fftconvolve` or `ndi.binary_dilation`.
mode : str {'same', 'full'}
A string indicating the size of the output (used only if use_fft=True).
- 'same': The output is the same size as input (Default).
- 'full': The output size is extended by the width
"""

if use_fft:
Expand Down Expand Up @@ -676,7 +678,8 @@ def convolve(self, kernel, use_fft=True, **kwargs):
kernel : `~gammapy.irf.PSFKernel` or `numpy.ndarray`
Convolution kernel.
use_fft : bool
Use `scipy.signal.fftconvolve` or `ndi.convolve`.
Use `scipy.signal.fftconvolve` if True (default)
and `ndi.convolve` otherwise.
kwargs : dict
Keyword arguments passed to `scipy.signal.fftconvolve` or
`ndi.convolve`.
Expand Down

0 comments on commit 42cdf48

Please sign in to comment.