API for the glworia.amp.contour module

contour_integral

A class for computing the amplification factor by contour integration.

Attributes:

Name	Type	Description
y	ndarray	2D impact parameter. The second component is ignored for now.
y0	float	1D impact parameter.
lens_params	ndarray	The lens parameters. Only one parameter is supported for now.
T0_min_out_segments	List[ndarray]	A list of the arrays of time delay values for the contours passing to the right of the minimum image.
T0_sad_max_segment	ndarray	The time delay values for the contours passing between the saddle and the maximum image.
x_im	ndarray	The image positions in 1D. The order of the images are from the left to the right, i.e. saddle, maximum, minimum.
mus	ndarray	The magnification of the images.
u_min_out	List[ndarray]	A list of arrays of the time domain amplification for the contours passing to the right of the minimum image, corresponding to the time delays T0_min_out_segments.
u_sad_max	ndarray	The time domain amplification for the contours passing between the saddle and the maximum image, corresponding to the time delays T0_sad_max_segment.
T_vir	float	The time delay at the maximum value of the time domain amplification.

__init__(x_im, multi_image, T_funcs, y, lens_params, critical=False, T0_min_out_segments=None, T0_sad_max_segment=None, singular=False)

Parameters:

Name	Type	Description	Default
x_im	ndarray	The image positions in 1D. The order of the images are from the left to the right, i.e. saddle, maximum, minimum.	required
multi_image	bool	A boolean indicating whether there are multiple images.	required
T_funcs	Dict[str, Callable]	A dictionary of functions derived from the Fermat Potential.	required
y	ndarray	2D impact parameter. The second component is ignored for now.	required
lens_params	ndarray	The lens parameters. Only one parameter is supported for now.	required
critical	bool	A boolean indicating whether the supplied impact parameter lies on the caustic.	False
T0_min_out_segments	Optional[List[ndarray]]	A list of the arrays of time delay values for the contours passing to the right of the minimum image.	None
T0_sad_max_segment	Optional[ndarray]	The time delay values for the contours passing between the saddle and the maximum image.	None
singular	bool	A boolean indicating whether the lens is singular at the origion.	False

contour_integrate(contour_cond_fun, contour_step_fun)

Computes the contour integral

Parameters:

Name	Type	Description	Default
contour_cond_fun	Callable	The condition function for terminating the contour integral.	required
contour_step_fun	Callable	The step function for the contour integral.	required