Skip to content
Snippets Groups Projects
Commit 36d059e4 authored by Martin Reinecke's avatar Martin Reinecke
Browse files

cosmetics

parent fe00fb42
No related branches found
No related tags found
1 merge request!297Spherical Convolution operator
Pipeline #43923 passed
...@@ -106,6 +106,13 @@ class LMSpace(StructuredDomain): ...@@ -106,6 +106,13 @@ class LMSpace(StructuredDomain):
def get_conv_kernel_from_func(self, func): def get_conv_kernel_from_func(self, func):
"""Creates a convolution kernel defined by a function. """Creates a convolution kernel defined by a function.
Parameters
----------
func: function
This function needs to take exactly one argument, which is
colatitude in radians, and return the kernel amplitude at that
colatitude.
Assumes the function to be radially symmetric, Assumes the function to be radially symmetric,
e.g. only dependant on theta in radians""" e.g. only dependant on theta in radians"""
from .gl_space import GLSpace from .gl_space import GLSpace
......
...@@ -32,12 +32,12 @@ def SphericalFuncConvolutionOperator(domain, func): ...@@ -32,12 +32,12 @@ def SphericalFuncConvolutionOperator(domain, func):
Parameters Parameters
---------- ----------
domain: DomainTuple domain: DomainTuple
Domain of the operator. Must have exactly one entry, which is Domain of the operator. Must have exactly one entry, which is
of type `HPSpace` or `GLSpace`. of type `HPSpace` or `GLSpace`.
func: function func: function
This function needs to take exactly one argument, which is This function needs to take exactly one argument, which is
colatitude in radians, and return the kernel amplitude at that colatitude in radians, and return the kernel amplitude at that
colatitude. colatitude.
""" """
if len(domain) != 1: if len(domain) != 1:
raise ValueError("need exactly one domain") raise ValueError("need exactly one domain")
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment