radial_profiles.RadialProfile.cutoff#

RadialProfile.cutoff(r_cut, k=5)[source]#

Generate a truncated form of the profile.

Parameters:
  • r_cut (float or int) – The cutoff radius beyond which the truncation should dominate the profile behavior [kpc].

  • k (int) – The truncation rate. Higher k will cause the truncation to go to zero faster.

Returns:

The corresponding RadialProfile object with the truncated profile.

Return type:

RadialProfile

Notes

The truncation is achieved by multiplying the profile by the factor

\[1-\frac{1}{1+\exp\left(-2k\left(\frac{r}{r_{cut}}\right)\right)}.\]