jaxtronomy.LensModel.Util package

Submodules

jaxtronomy.LensModel.Util.decouple_multi_plane_util module

decoupled_multiplane_class_setup(lens_model_free, x, y, alpha_x_foreground, alpha_y_foreground, alpha_beta_subx, alpha_beta_suby, z_split, coordinate_type='POINT', interp_points=None, x_image=None, y_image=None, method='linear', bounds_error=False, fill_value=None)[source]

This funciton creates the keyword arguments for a LensModel instance that is the decoupled multi-plane approxiamtion for the specified lens model.

Parameters:

  • lens_model_free – the lens model with parameters free to vary

  • x – comoving coordinate at z_split

  • y – comoving coordinate at z_split

  • alpha_x_foreground – ray angles at z_split (not including lens_model_free contribution)

  • alpha_y_foreground – ray angles at z_split (not including lens_model_free contribution)

  • alpha_beta_subx – deflection field from halos at redshift > z_split given the initial guess for the keyword arguments in lens_model_free

  • alpha_beta_suby – deflection field from halos at redshift > z_split given the initial guess for the keyword arguments in lens_model_free

  • z_split – redshift at which the lens model is decoupled from the line of sight

  • coordinate_type – specifies the type of interpolation to use. Options are POINT, GRID, or MULTIPLE_IMAGES. POINT specifies a single point at which to compute the interpolation GRID specifies the interpolation on a regular grid MULTIPLE_IMAGES does interpolation on an array using the NEAREST method.

  • lens_model_free

  • x – transverse comoving distance in x direction of the light rays at the main deflector

  • y – transverse comoving distance in y direction of the light rays at the main deflector

  • alpha_x_foreground – deflection angles from halos at redshift z<=z_split

  • alpha_y_foreground – deflection angles from halos at redshift z<=z_split

  • alpha_beta_subx – deflection angles from halos at redshift z > z_lens

  • alpha_beta_suby – deflection angles from halos at redshift z > z_lens

  • z_split – the redshift where foreground and background halos are split

  • coordinate_type – a string specifying the type of coordinate of x. Options are GRID, POINT, and MULTIPLE_IMAGES

  • interp_points – optional keyword argument passed to GRID method that specifies the interpolation grid

  • x_image – optional keyword argument passed to multiple images argument that specifies the image coordinates

  • y_image – optional keyword argument passed to multiple images argument that specifies the image coordinates

  • method – the interpolation method used by RegularGridInterpolator if coordinate_type==’GRID’

  • bounds_error – passed to RegularGridInterpolater, see documentation there

  • fill_value – passed to RegularGridInterpolator, see documentation there

Returns:

keyword arguments that can be passed into a LensModel class to create a decoupled-multiplane lens model

Module contents