slsim.LOS package

Submodules

slsim.LOS.los_individual module

class slsim.LOS.los_individual.LOSIndividual(kappa=None, gamma=None)[source]

Bases: object

Class to store the quantities of an individual line of sight.

property convergence

Line of sight convergence.

Returns:

kappa

property shear

Line of sight shear.

Returns:

gamma1, gamma2

slsim.LOS.los_pop module

class slsim.LOS.los_pop.LOSPop(los_bool=True, mixgauss_gamma=False, mixgauss_means=None, mixgauss_stds=None, mixgauss_weights=None, nonlinear_los_bool=False, nonlinear_correction_path=None, no_correction_path=None)[source]

Bases: object

Configuration class for setting parameters related to line-of-sight (LOS) effects and Gaussian mixture models in a simulation or analysis context.

Attributes:
mixgauss_gamma (bool): A flag to enable or disable gamma correction in the Gaussian

mixture model. Default is False.

mixgauss_means (list of float or None): The means of the Gaussian mixture components.

If None, no means are specified. Default is None.

mixgauss_stds (list of float or None): The standard deviations of the Gaussian mixture

components. If None, no standard deviations are specified. Default is None.

mixgauss_weights (list of float or None): The weights of the Gaussian mixture components.

If None, no weights are specified. Default is None.

los_bool (bool): A boolean flag to include or exclude line-of-sight distortions in the

analysis. Default is True.

nonlinear_los_bool (bool): A boolean flag to include or exclude non-linear corrections

to line-of-sight distortions. Default is False.

nonlinear_correction_path (str or None): The file path to the non-linear correction

distributions stored in an H5 file. If None, no path is provided. Default is None.

no_correction_path (str or None): The file path to the distributions without non-linear

corrections, stored in an H5 file. If None, no path is provided. Default is None.

Example:
To create an instance of LOSConfig with default settings:

config = LOSConfig() )

draw_los(source_redshift, deflector_redshift)[source]

Calculate line-of-sight distortions in shear and convergence for an individual realisation.

Parameters:

  • source_redshift (float) – redshift of the source galaxy object.

  • deflector_redshift (float) – redshift of the deflector galaxy object.

Returns:

LOSIndividual class instance

Module contents