Aquila-Consortium/csiborgtools
0
0
Fork 0
mirror of https://github.com/Richard-Sti/csiborgtools.git synced 2024-12-23 02:48:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

remove not good comments

Browse source
This commit is contained in:
rstiskalek 2022-11-25 11:45:47 +00:00
parent 9fe745b0b4
commit 91bddb1d3a
1 changed files with 6 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
csiborgtools/fits/halo.py
View file

@ -290,8 +290,7 @@ class Clump:
Returns Returns
------- -------
pos : 2-dimensional array pos : 2-dimensional array of shape `(n_particles, 3)`.
Array of shape `(n_particles, 3)`.
""" """
return self._pos return self._pos
@ -312,8 +311,7 @@ class Clump:
Returns Returns
------- -------
r : 1-dimensional array r : 1-dimensional array of shape `(n_particles, )`.
Array of shape `(n_particles, )`.
""" """
return self._r return self._r
@ -325,7 +323,6 @@ class Clump:
Returns Returns
------- -------
rmin : float rmin : float
The minimum distance.
""" """
return self._rmin return self._rmin
@ -337,7 +334,6 @@ class Clump:
Returns Returns
------- -------
rmin : float rmin : float
The maximum distance.
""" """
return self._rmax return self._rmax
@ -349,7 +345,6 @@ class Clump:
Returns Returns
------- -------
Npart : int Npart : int
Number of particles.
""" """
return self._Npart return self._Npart
@ -360,8 +355,7 @@ class Clump:
Returns Returns
------- -------
pos : 1-dimensional array pos : 1-dimensional array of shape `(3, )`
Array of shape `(3, )`.
""" """
return self._clump_pos return self._clump_pos
@ -381,7 +375,6 @@ class Clump:
Returns Returns
------- -------
mass : float mass : float
Clump mass.
""" """
if self._clump_mass is None: if self._clump_mass is None:
raise ValueError("Clump mass `clump_mass` has not been set.") raise ValueError("Clump mass `clump_mass` has not been set.")
@ -401,8 +394,7 @@ class Clump:
Returns Returns
------- -------
vel : 2-dimensional array vel : 2-dimensional array of shape (`n_particles, 3`)
Array of shape (`n_particles, 3`).
""" """
if self._vel is None: if self._vel is None:
raise ValueError("Velocities `vel` have not been set.") raise ValueError("Velocities `vel` have not been set.")
@ -443,7 +435,7 @@ class Clump:
Returns Returns
------- -------
cm : 1-dimensional array cm : 1-dimensional array of shape `(3, )`
""" """
return numpy.average(self.pos, axis=0, weights=self.m) return numpy.average(self.pos, axis=0, weights=self.m)
@ -455,7 +447,6 @@ class Clump:
Returns Returns
------- -------
hindex : int hindex : int
The index.
""" """
if self._index is None: if self._index is None:
raise ValueError("Halo index `hindex` has not been set.") raise ValueError("Halo index `hindex` has not been set.")
@ -476,7 +467,6 @@ class Clump:
Returns Returns
------- -------
rhoc : float rhoc : float
The critical density.
""" """
if self._rhoc is None: if self._rhoc is None:
raise ValueError("The critical density `rhoc` has not been set.") raise ValueError("The critical density `rhoc` has not been set.")
@ -497,7 +487,6 @@ class Clump:
Returns Returns
------- -------
tot_mass : float tot_mass : float
The summed mass.
""" """
return numpy.sum(self.m) return numpy.sum(self.m)
@ -508,8 +497,7 @@ class Clump:
Returns Returns
------- -------
pos : 1-dimensional array pos : 1-dimensional array of shape `(3, )`
Array of shape `(3, )`.
""" """
return numpy.mean(self.pos + self.clump_pos, axis=0) return numpy.mean(self.pos + self.clump_pos, axis=0)
@ -546,7 +534,6 @@ class Clump:
Returns Returns
------- -------
vol : float vol : float
The enclosed volume.
""" """
return 4 * numpy.pi / 3 * (rmax**3 - rmin**3) return 4 * numpy.pi / 3 * (rmax**3 - rmin**3)
@ -642,7 +629,6 @@ class Clump:
Returns Returns
------- -------
clump : `Clump` clump : `Clump`
An initialised clump object.
""" """
x, y, z, m = (particles[p] for p in ["x", "y", "z", "M"]) x, y, z, m = (particles[p] for p in ["x", "y", "z", "M"])
x0, y0, z0, cl_mass, hindex = ( x0, y0, z0, cl_mass, hindex = (