Commit 36d059e4 authored by Martin Reinecke's avatar Martin Reinecke

cosmetics

parent fe00fb42
Pipeline #43923 passed with stages
in 8 minutes and 6 seconds
......@@ -106,6 +106,13 @@ class LMSpace(StructuredDomain):
def get_conv_kernel_from_func(self, func):
"""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,
e.g. only dependant on theta in radians"""
from .gl_space import GLSpace
......
......@@ -32,12 +32,12 @@ def SphericalFuncConvolutionOperator(domain, func):
Parameters
----------
domain: DomainTuple
Domain of the operator. Must have exactly one entry, which is
of type `HPSpace` or `GLSpace`.
func: function
This function needs to take exactly one argument, which is
colatitude in radians, and return the kernel amplitude at that
colatitude.
Domain of the operator. Must have exactly one entry, which is
of type `HPSpace` or `GLSpace`.
func: function
This function needs to take exactly one argument, which is
colatitude in radians, and return the kernel amplitude at that
colatitude.
"""
if len(domain) != 1:
raise ValueError("need exactly one domain")
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment