Aquila-Consortium/csiborgtools
0
0
Fork 0
mirror of https://github.com/Richard-Sti/csiborgtools_public.git synced 2025-05-20 17:41:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Delete boring comments

Browse source
This commit is contained in:
rstiskalek 2023-10-19 14:11:38 +01:00
parent 154e7375d1
commit e5815b83be
1 changed files with 3 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

36
csiborgtools/match/match.py
View file

@ -30,21 +30,13 @@ from ..read import load_halo_particles
class BaseMatcher(ABC): class BaseMatcher(ABC):
""" """Base class for `RealisationsMatcher` and `ParticleOverlap`."""
Base class for `RealisationsMatcher` and `ParticleOverlap`.
"""
_box_size = None _box_size = None
_bckg_halfsize = None _bckg_halfsize = None
@property @property
def box_size(self): def box_size(self):
""" """Number of cells in the box."""
Number of cells in the box.
Returns
-------
box_size : int
"""
if self._box_size is None: if self._box_size is None:
raise RuntimeError("`box_size` has not been set.") raise RuntimeError("`box_size` has not been set.")
return self._box_size return self._box_size
@ -64,10 +56,6 @@ class BaseMatcher(ABC):
grid distance from the center of the box to each side over which to grid distance from the center of the box to each side over which to
evaluate the background density field. Must be less than or equal to evaluate the background density field. Must be less than or equal to
half the box size. half the box size.
Returns
-------
bckg_halfsize : int
""" """
if self._bckg_halfsize is None: if self._bckg_halfsize is None:
raise RuntimeError("`bckg_halfsize` has not been set.") raise RuntimeError("`bckg_halfsize` has not been set.")
@ -130,10 +118,6 @@ class RealisationsMatcher(BaseMatcher):
""" """
Multiplier of the sum of the initial Lagrangian patch sizes of a halo Multiplier of the sum of the initial Lagrangian patch sizes of a halo
pair. Determines the range within which neighbors are returned. pair. Determines the range within which neighbors are returned.
Returns
-------
nmult : float
""" """
return self._nmult return self._nmult
@ -148,10 +132,6 @@ class RealisationsMatcher(BaseMatcher):
""" """
Tolerance on the absolute logarithmic mass difference of potential Tolerance on the absolute logarithmic mass difference of potential
matches. matches.
Returns
-------
float
""" """
return self._dlogmass return self._dlogmass
@ -166,10 +146,6 @@ class RealisationsMatcher(BaseMatcher):
""" """
Mass kind whose similarity is to be checked. Must be a valid key in the Mass kind whose similarity is to be checked. Must be a valid key in the
halo catalogue. halo catalogue.
Returns
-------
str
""" """
return self._mass_kind return self._mass_kind
@ -181,13 +157,7 @@ class RealisationsMatcher(BaseMatcher):
@property @property
def overlapper(self): def overlapper(self):
""" """The overlapper object."""
The overlapper object.
Returns
-------
:py:class:`csiborgtools.match.ParticleOverlap`
"""
return self._overlapper return self._overlapper
def cross(self, cat0, catx, particles0, particlesx, halo_map0, halo_mapx, def cross(self, cat0, catx, particles0, particlesx, halo_map0, halo_mapx,