Skip to content

Commit

Permalink
Fix typos in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
aymgal committed Nov 23, 2023
1 parent 155778e commit a0fc1e4
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
6 changes: 3 additions & 3 deletions coolest/api/composable_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ def __init__(self, coolest_object, coolest_directory=None, **kwargs_selection):
**kwargs_selection)

def evaluate_deflection(self, x, y):
"""Evaluates the surface brightness at given coordinates"""
"""Evaluates the lensing deflection field at given coordinates"""
alpha_x, alpha_y = np.zeros_like(x), np.zeros_like(x)
for k, (profile, params) in enumerate(zip(self.profile_list, self.param_list)):
a_x, a_y = profile.deflection(x, y, **params)
Expand All @@ -253,14 +253,14 @@ def evaluate_deflection(self, x, y):
return alpha_x, alpha_y

def evaluate_convergence(self, x, y):
"""Evaluates the surface brightness at given coordinates"""
"""Evaluates the lensing convergence (i.e., 2D mass density) at given coordinates"""
kappa = np.zeros_like(x)
for k, (profile, params) in enumerate(zip(self.profile_list, self.param_list)):
kappa += profile.convergence(x, y, **params)
return kappa

def evaluate_magnification(self, x, y):
"""Evaluates the surface brightness at given coordinates"""
"""Evaluates the lensing magnification at given coordinates"""
H_xx_sum = np.zeros_like(x)
H_xy_sum = np.zeros_like(x)
H_yx_sum = np.zeros_like(x)
Expand Down
2 changes: 1 addition & 1 deletion coolest/api/profiles/light.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def units(self):
@property
def template_class(self):
if self._template_class is None:
raise RuntimeError("No template class has been set by mass profile class")
raise RuntimeError("No template class has been set by light profile class")
return self._template_class

@property
Expand Down
3 changes: 3 additions & 0 deletions coolest/template/classes/parameter.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ class Parameter(APIBaseObject):
Prior assigned the parameter, if any, by default None
latex_str : str, optional
LaTeX representation of the parameter, by default None
#TODO: for parameters like orientation / axis ratio, add a class method to compute
related quantities like ellipticity parameters.
"""
def __init__(self,
documentation: str,
Expand Down

0 comments on commit a0fc1e4

Please sign in to comment.