Skip to content
Snippets Groups Projects
Commit b44daa9f authored by Philipp Arras's avatar Philipp Arras
Browse files

Adjust docstring

parent 347b9832
Branches
Tags
1 merge request!29Allow frequency domain to be defined on log scale
...@@ -106,12 +106,14 @@ class MfResponse(ift.LinearOperator): ...@@ -106,12 +106,14 @@ class MfResponse(ift.LinearOperator):
observation : Observation observation : Observation
Instance of the :class:`Observation` that represents the measured data. Instance of the :class:`Observation` that represents the measured data.
frequency_domain : IRGSpace frequency_domain : IRGSpace
Contains the :class:`IRGSpace` for the frequencies. Contains the :class:`IRGSpace` for the frequencies. The coordinates of
the space can be either frequencies or normalized log-frequencies. In
the latter case set `log_freq` to True.
position_domain : nifty8.RGSpace position_domain : nifty8.RGSpace
Contains the the :class:`nifty8.RGSpace` for the positions. Contains the the :class:`nifty8.RGSpace` for the positions.
log_freq : bool log_freq : bool
Set to true if the coordinates in the frequency domain are normalized by the mean frequency and in log-scale. If true, the coordinates of `frequency_domain` are interpreted to be
Default is False. normalized log-frequencies. Default is False.
""" """
def __init__(self, observation, frequency_domain, position_domain, log_freq=False): def __init__(self, observation, frequency_domain, position_domain, log_freq=False):
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment