autolens.Tracer#

class Tracer[source]#

Bases: ABC, OperateImageGalaxies, OperateDeflections

Performs gravitational lensing ray-tracing calculations based on an input list of galaxies and a cosmology.

The tracer stores the input galaxies in their input order, which may not be in ascending redshift order. However, for all ray-tracing calculations, the tracer orders the input galaxies in ascending order of redshift, as this is required for the multi-plane ray-tracing calculations.

The tracer then creates a series of planes, where each plane is a collection of galaxies at the same redshift.

The redshifts of these planes are determined by the redshifts of the galaxies, such that there is a unique plane redshift for every unique galaxy redshift (galaxies with identical redshifts are put in the same plane).

Gravitational lensing calculations are then performed individually for each plane and combined to produce the correct overall lensing calculation. This includes the calculations like the deflection angles, create images of the galaxies at different planes, and the overall lensed image of all galaxies.

Multi-plane ray-tracing work natively, whereby the redshifts of the planes are used to perform multi-plane ray-tracing calculations. This uses the input cosmology so that deflection-angles are rescaled according to the lens-geometry of the multi-plane system.

The Tracer object is also the core of the lens modeling API, whereby a model tracer is created via the PyAutoFit af.Model object.

Parameters:

galaxies (Union[List[Galaxy], ModelInstance]) – The list of galaxies which make up the gravitational lensing ray-tracing system.
cosmology (LensingCosmology) – The cosmology used to perform ray-tracing calculations.
run_time_dict (Optional[Dict]) – A dictionary of information on the run-times of function calls, including the total time and time spent on different calculations.

Methods

`area_within_curve_list_from`	rtype: `List`[`float`]
`blurred_image_2d_from`	Evaluate the light object's 2D image from a input 2D grid of coordinates and convolve it with a PSF.
`blurred_image_2d_list_from`	Evaluate the light object's list of 2D images from a input 2D grid of coordinates and convolve each image with a PSF.
`cls_list_from`	Returns a list of objects in the tracer which are an instance of the input cls.
`convergence_2d_from`	Returns the summed 2D convergence of all galaxies in the tracer from a 2D grid of Cartesian (y,x) coordinates.
`convergence_2d_via_hessian_from`	Returns the convergence of the lensing object, which is computed from the 2D deflection angle map via the Hessian using the expression (see equation 56 https://inspirehep.net/literature/419263):
`convergence_2d_via_jacobian_from`	Returns the convergence of the lensing object, which is computed from the 2D deflection angle map via the Jacobian using the expression (see equation 58 https://inspirehep.net/literature/419263):
`convolve_via_convolver`
`deflections_between_planes_from`	Returns the summed 2D deflections angles between two input planes in the tracer, accounting for multi-plane ray tracing, from a 2D grid of Cartesian (y,x) coordinates.
`deflections_of_planes_summed_from`	Returns the summed 2D deflections angles of all galaxies in the tracer, not accounting for multi-plane ray tracing, from a 2D grid of Cartesian (y,x) coordinates.
`deflections_yx_2d_from`	Returns the 2D deflection angles of all galaxies in the tracer, from the image-plane to the source-plane, accounting for multi-plane ray tracing and from a 2D grid of Cartesian (y,x) coordinates.
`einstein_mass_angular_from`	Returns the Einstein radius corresponding to the area within the tangential critical curve.
`einstein_mass_angular_list_from`	Returns a list of the angular Einstein massses corresponding to the area within each tangential critical curve.
`einstein_radius_from`	Returns the Einstein radius corresponding to the area within the tangential critical curve.
`einstein_radius_list_from`	Returns a list of the Einstein radii corresponding to the area within each tangential critical curve.
`extract_attribute`	Returns an extracted attribute of a class in the tracer as a ValueIrregular or Grid2DIrregular object.
`extract_attributes_of_galaxies`	Returns an attribute of a class in the tracer as a list of ValueIrregular or Grid2DIrregular objects, where the indexes of the list correspond to the tracer's galaxies.
`extract_attributes_of_planes`	Returns an extracted attribute of a class in the tracer as a list of ValueIrregular or Grid2DIrregular objects, where the indexes of the list correspond to the tracer's planes.
`extract_plane_index_of_profile`	Returns the plane index of a profile (e.g.
`extract_profile`	Returns a profile (e.g.
`galaxy_blurred_image_2d_dict_from`	Evaluate the light object's dictionary mapping galaixes to their corresponding 2D images and convolve each image with a PSF.
`galaxy_image_2d_dict_from`	Returns a dictionary associating every Galaxy object in the Tracer with its corresponding 2D image, using the instance of each galaxy as the dictionary keys.
`galaxy_visibilities_dict_from`	Evaluate the light object's dictionary mapping galaixes to their corresponding 2D images and transform each image to arrays of visibilities using a autoarray.operators.transformer.Transformer object and therefore a Fourier Transform.
`grid_2d_at_redshift_from`	Returns a ray-traced grid of 2D Cartesian (y,x) coordinates, which accounts for multi-plane ray-tracing, at a specified input redshift which may be different to the redshifts of all planes.
`has`	Returns a bool specifying whether this tracer has a galaxy with a certain class type.
`hessian_from`	Returns the Hessian of the lensing object, where the Hessian is the second partial derivatives of the potential (see equation 55 https://inspirehep.net/literature/419263):
`image_2d_from`	Returns the 2D image of this ray-tracing strong lens system from a 2D grid of Cartesian (y,x) coordinates.
`image_2d_list_from`	Returns a list of the 2D images for each plane from a 2D grid of Cartesian (y,x) coordinates.
`image_2d_via_input_plane_image_from`	Returns the lensed image of a plane or galaxy, where the input image is uniform and interpolated to compute the lensed image.
`jacobian_from`	Returns the Jacobian of the lensing object, which is computed by taking the gradient of the 2D deflection angle map in four direction (positive y, negative y, positive x, negative x).
`magnification_2d_from`	Returns the 2D magnification map of lensing object, which is computed as the inverse of the determinant of the jacobian.
`magnification_2d_via_hessian_from`	Returns the 2D magnification map of lensing object, which is computed from the 2D deflection angle map via the Hessian using the expressions (see equation 60 https://inspirehep.net/literature/419263):
`padded_image_2d_from`	Evaluate the light object's 2D image from a input 2D grid of padded coordinates, where this padding is sufficient to encapsulate all surrounding pixels that will blur light into the original image given the 2D shape of the PSF's kernel.
`potential_2d_from`	Returns the summed 2D potential of all galaxies in the tracer from a 2D grid of Cartesian (y,x) coordinates.
`radial_caustic_list_from`	Returns all radial caustics of the lensing system, which are computed as follows:
`radial_critical_curve_area_list_from`	Returns the surface area within each radial critical curve as a list, the calculation of which is described in the function radial_critical_curve_list_from().
`radial_critical_curve_list_from`	Returns all radial critical curves of the lensing system, which are computed as follows:
`radial_eigen_value_from`	Returns the radial eigen values of lensing jacobian, which are given by the expression:
`set_snr_of_snr_light_profiles`	Iterate over every LightProfileSNR in the tracer and set their intensity values to values which give their input signal_to_noise_ratio value, which is performed as follows:
`shear_yx_2d_via_hessian_from`	Returns the 2D (y,x) shear vectors of the lensing object, which are computed from the 2D deflection angle map via the Hessian using the expressions (see equation 57 https://inspirehep.net/literature/419263):
`shear_yx_2d_via_jacobian_from`	Returns the 2D (y,x) shear vectors of the lensing object, which are computed from the 2D deflection angle map via the Jacobian using the expression (see equation 58 https://inspirehep.net/literature/419263):
`sliced_tracer_from`	Returns a tracer where the lens system is split into planes with specified redshift distances between them.
`tangential_caustic_list_from`	Returns all tangential caustics of the lensing system, which are computed as follows:
`tangential_critical_curve_area_list_from`	Returns the surface area within each tangential critical curve as a list, the calculation of which is described in the function tangential_critical_curve_list_from().
`tangential_critical_curve_list_from`	Returns all tangential critical curves of the lensing system, which are computed as follows:
`tangential_eigen_value_from`	Returns the tangential eigen values of lensing jacobian, which are given by the expression:
`traced_grid_2d_list_from`	Returns a ray-traced grid of 2D Cartesian (y,x) coordinates which accounts for multi-plane ray-tracing.
`unmasked_blurred_image_2d_from`	Evaluate the light object's 2D image from a input 2D grid of coordinates and convolve it with a PSF, using a grid which is not masked.
`unmasked_blurred_image_2d_list_from`	Evaluate the light object's list of 2D images from a input 2D grid of coordinates and convolve it with a PSF, using a grid which is not masked.
`visibilities_from`	Evaluate the light object's 2D image from a input 2D grid of coordinates and transform this to an array of visibilities using a autoarray.operators.transformer.Transformer object and therefore a Fourier Transform.
`visibilities_list_from`	Evaluate the light object's list of 2D image from a input 2D grid of coordinates and transform each image to arrays of visibilities using a autoarray.operators.transformer.Transformer object and therefore a Fourier Transform.

Attributes

`galaxies_ascending_redshift`	Returns the galaxies in the tracer in ascending redshift order.
`perform_inversion`	Returns a bool specifying whether this fit object performs an inversion.
`plane_indexes_with_pixelizations`
`plane_redshifts`	Returns a list of plane redshifts from a list of galaxies, using the redshifts of the galaxies to determine the unique redshifts of the planes.
`planes`	Returns a list of list of galaxies grouped into their planes, where planes contained all galaxies at the same unique redshift.
`total_planes`	rtype: `int`
`upper_plane_index_with_light_profile`	Returns the index of the highest redshift plane in the tracer which has a light profile.

property galaxies_ascending_redshift: List[Galaxy]#

Returns the galaxies in the tracer in ascending redshift order.

Multi-plane ray tracing calculations begin from the first lowest redshift plane and perform calculations in planes of increasing redshift. Thus, the galaxies are sorted by redshift in ascending order to aid this calculation.

Return type:: The galaxies in the tracer in ascending redshift order.

property plane_redshifts: List[float]#

Returns a list of plane redshifts from a list of galaxies, using the redshifts of the galaxies to determine the unique redshifts of the planes.

Each plane redshift corresponds to a unique redshift in the list of galaxies, such that the returned list of redshifts contains no duplicate values. This means multiple galaxies at the same redshift are assigned to the same plane.

For example, if the input is three galaxies, two at redshift 1.0 and one at redshift 2.0, the returned list of redshifts would be [1.0, 2.0].

Parameters:: galaxies – The list of galaxies used to determine the unique redshifts of the planes.
Return type:: The list of unique redshifts of the planes.

property planes#

Returns a list of list of galaxies grouped into their planes, where planes contained all galaxies at the same unique redshift.

If the plane redshifts are not input, the redshifts of the galaxies are used to determine the unique redshifts of the planes.

For example, if the input is three galaxies, two at redshift 1.0 and one at redshift 2.0, the returned list of list of galaxies would be [[g1, g2], g3]].

Parameters:

galaxies – The list of galaxies used to determine the unique redshifts of the planes.
plane_redshifts – The redshifts of the planes, which are used to group the galaxies into their respective planes. If not input, the redshifts of the galaxies are used to determine the unique redshifts of the planes.

Return type:

The list of list of galaxies grouped into their planes.

classmethod sliced_tracer_from(lens_galaxies, line_of_sight_galaxies, source_galaxies, planes_between_lenses, cosmology=Planck15(name='Planck15', H0=<Quantity 67.74 km / (Mpc s)>, Om0=0.3075, Tcmb0=<Quantity 2.7255 K>, Neff=3.046, m_nu=<Quantity [0., 0., 0.06] eV>, Ob0=0.0486))[source]#

Returns a tracer where the lens system is split into planes with specified redshift distances between them.

This is used for ray-tracing systems with many galaxies at different redshifts (e.g. hundreds or more). If each galaxy redshift is treated indepedently, this would require many planes to be created, and the multi-plane ray-tracing calculation would be computationally slow.

To speed the calculation up, the galaxies are grouped into planes with redshifts separated by the inputs. To achieve this, the galaxies have their redshifts reassigned from their original values to the nearest value of a sliced plane redshift. This ensures that every galaxy is in a subset of planes.

The redshifts of the planes are determines as follows:

Use the redshifts of the lens galaxies to determine the redshifts of the planes, where a lens galaxy is

expected to have a large mass and thus contribute to a significant portion of the overall lensing. This ensures the main lens galaxies have a redshift and plane to themselves, ensuring calculation accuracy.

Use the redshift of the source galaxies to determine the redshift of the source plane, ensuring the source

galaxies also have a dedicated redshift and plane for calculation accuracy.

Create N planes between Earth and the first lens galaxy, the lens galaxy and the next lens galaxy (and so on)

up to the source galaxy. The number of planes between each set of galaxies is specified by the input planes_between_lenses, where for a lens / source system planes_between_lenses=[2,3] would mean there are 2 planes between Earth and the lens galaxy and 3 planes between the lens and source galaxy.

The line_of_sight_galaxies are placed in the planes corresponding to their closest redshift.

Parameters:

lens_galaxies (List[Galaxy]) – The lens galaxies in the ray-tracing calculation. Most use cases will have only one lens galaxy, but the API supports multiple lens galaxies (e.g. double Einstein ring systems).
line_of_sight_galaxies (List[Galaxy]) – The galaxies in the line-of-sight to the primary lens galaxy, which may have many different redshifts and therefore create computational expensive multi-plane ray-tracing calculations without the plane grouping provided by this method.
source_galaxies (List[Galaxy]) – The source galaxies in the ray-tracing calculation. The API only supports one source galaxy (input multiple lens galaxies to build a multi-plane system).
planes_between_lenses (List[int]) – The number of slices between each main plane. The first entry in this list determines the number of slices between Earth (redshift 0.0) and the first lens galaxy, the next between the lens and source, etc.
cosmology (LensingCosmology) – The cosmology used to perform ray-tracing calculations.

traced_grid_2d_list_from(grid, plane_index_limit=<class 'NoneType'>)[source]#

Returns a ray-traced grid of 2D Cartesian (y,x) coordinates which accounts for multi-plane ray-tracing.

This uses the redshifts and mass profiles of the galaxies contained within the tracer to perform the multi-plane ray-tracing calculation.

This function returns a list of 2D (y,x) grids, corresponding to each redshift in the input list of planes. The plane redshifts are determined from the redshifts of the galaxies in each plane, whereby there is a unique plane at each redshift containing all galaxies at the same redshift.

For example, if the planes list contains three lists of galaxies with redshift’s z0.5, z=1.0 and z=2.0, the returned list of traced grids will contain three entries corresponding to the input grid after ray-tracing to redshifts 0.5, 1.0 and 2.0.

An input AstroPy cosmology object can change the cosmological model, which is used to compute the scaling factors between planes (which are derived from their redshifts and angular diameter distances). It is these scaling factors that account for multi-plane ray tracing effects.

The calculation can be terminated early by inputting a plane_index_limit. All planes whose integer indexes are above this value are omitted from the calculation and not included in the returned list of grids (the size of this list is reduced accordingly).

For example, if planes has 3 lists of galaxies, but plane_index_limit=1, the third plane (corresponding to index 2) will not be calculated. The plane_index_limit is used to avoid uncessary ray tracing calculations of higher redshift planes whose galaxies do not have mass profile (and only have light profiles).

see autolens.lens.tracer.tracer_util.traced_grid_2d_list_from() for the full calculation.

Parameters:

grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y, x) coordinates on which multi-plane ray-tracing calculations are performed.
plane_index_limit (int) – The integer index of the last plane which is used to perform ray-tracing, all planes with an index above this value are omitted.

Returns:

A list of 2D (y,x) grids each of which are the input grid ray-traced to a redshift of the input list of planes.

Return type:

traced_grid_list

grid_2d_at_redshift_from(grid, redshift)[source]#

Returns a ray-traced grid of 2D Cartesian (y,x) coordinates, which accounts for multi-plane ray-tracing, at a specified input redshift which may be different to the redshifts of all planes.

Given a list of galaxies whose redshifts define a multi-plane lensing system and an input grid of (y,x) arc-second coordinates (e.g. an image-plane grid), ray-trace the grid to an input redshift in of the multi-plane system.

This is performed using multi-plane ray-tracing and a list of galaxies which are converted into a list of planes at a set of redshift. The galaxy mass profiles are used to compute deflection angles. Any redshift can be input even if a plane does not exist there, including redshifts before the first plane of the lens system.

There are two ways the calculation may be performed:

1) If the input redshift is the same as the redshift of a plane in the multi-plane system, the grid is ray-traced to that plane and the traced grid returned.

2) If the input redshift is not the same as the redshift of a plane in the multi-plane system, a plane is inserted at this redshift and the grid is ray-traced to this plane.

For example, the input list galaxies may contained three Galaxy objects at redshifts z=0.5, z=1.0 and z=2.0. We can input an image-plane grid and request that its coordinates are ray-traced to a plane at z=1.75 in this multi-plane system. This will insert a plane at z=1.75 and use the galaxy’s at z=0.5 and z=1.0 to compute deflection angles, alongside accounting for multi-plane lensing effects via the angular diameter distances between the different galaxy redshifts.

Parameters:

redshift (float) – The redshift the input (image-plane) grid is traced too.
galaxies – A list of galaxies which make up a multi-plane strong lens ray-tracing system.
grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y, x) coordinates which is ray-traced to the input redshift.
cosmology – The cosmology used for ray-tracing from which angular diameter distances between planes are computed.

Return type:

Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]

property upper_plane_index_with_light_profile: int#

Returns the index of the highest redshift plane in the tracer which has a light profile.

When computing the image of a tracer, we only need to trace rays to the highest redshift plane which has a light profile. This upper index is therefore used to do this, and ensure faster computation by avoiding ray-tracing to planes which do not have light profiles.

Return type:: The index of the highest redshift plane in the tracer which has a light profile.

image_2d_list_from(grid, operated_only=None)[source]#

Returns a list of the 2D images for each plane from a 2D grid of Cartesian (y,x) coordinates.

The image of each plane is computed by summing the images of all galaxies in that plane. If a plane has no galaxies, or if the galaxies in a plane has no light profiles, a numpy array of zeros is returned.

For example, if the tracer’s planes contain galaxies at redshifts z=0.5, z=1.0 and z=2.0, and the galaxies at redshifts z=0.5 and z=1.0 have light and mass profiles, the returned list of images will be the image of the galaxies at z=0.5 and z=1.0, where the image at redshift z=1.0 will include the lensing effects of the galaxies at z=0.5. The image at redshift z=2.0 will be a numpy array of zeros.

The images output by this function do not include instrument operations, such as PSF convolution (for imaging data) or a Fourier transform (for interferometer data).

Inherited methods in the autogalaxy.operate.image package can apply these operations to the images. These functions may have the operated_only input passed to them, which is why this function includes the operated_only input.

If the operated_only input is included, the function omits light profiles which are parents of the LightProfileOperated object, which signifies that the light profile represents emission that has already had the instrument operations (e.g. PSF convolution, a Fourier transform) applied to it and therefore that operation is not performed again.

See the autogalaxy.profiles.light package for details of how images are computed from a light profile.

Parameters:

grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y, x) coordinates where values of the image are evaluated.
operated_only (Optional[bool]) – The returned list from this function contains all light profile images, and they are never operated on (e.g. via the imaging PSF). However, inherited methods in the autogalaxy.operate.image package can apply these operations to the images, which may have the operated_only input passed to them. This input therefore is used to pass the operated_only input to these methods.

Return type:

List[Array2D]

image_2d_from(grid, operated_only=None)[source]#

Returns the 2D image of this ray-tracing strong lens system from a 2D grid of Cartesian (y,x) coordinates.

This function first computes the image of each plane in the tracer, via the function image_2d_list_from. The images are then summed to give the overall image of the tracer.

Refer to the function image_2d_list_from for a full description of the calculation and how the operated_only input is used.

Parameters:

grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y, x) coordinates where values of the image are evaluated.
operated_only (Optional[bool]) – The returned list from this function contains all light profile images, and they are never operated on (e.g. via the imaging PSF). However, inherited methods in the autogalaxy.operate.image package can apply these operations to the images, which may have the operated_only input passed to them. This input therefore is used to pass the operated_only input to these methods.

Return type:

Array2D

image_2d_via_input_plane_image_from(grid, plane_image, plane_index=-1, include_other_planes=True)[source]#

Returns the lensed image of a plane or galaxy, where the input image is uniform and interpolated to compute the lensed image.

The typical use case is inputting the image of an irregular galaxy in the source-plane (whose values are on a uniform array) and using this function computing the lensed image of this source galaxy.

By default, this function computes the lensed image of the final plane, which is the source-plane, by using plane_index=-1. For multi-plane lens systems, the lensed image of any planes can be computed by setting plane_index to the index of the plane in the lens system.

The emission of all other planes and galaxies can be included or omitted setting the include_other_planes bool. If there are multiple planes in a multi-plane lens system, the emission of the other planes are fully lensed.

__Source Plane Interpolation__

We use the scipy interpolation function griddata to create the lensed source galaxy image.

In brief, we trace light rays to the source plane and calculate values based on where those light rays land in the source plane via interpolation.

In more detail:

points: The 2D grid of (y,x) coordinates representing the location of every pixel of the source galaxy image in the source-plane, from which we are creating the lensed source image. These coordinates are the uniform source-plane grid computed after interpolating the irregular mesh the original source reconstruction used.
values: The intensity values of the source galaxy image which is used to create the lensed source image.
These values are the flux values of the interpolated source galaxy image computed after interpolating the irregular mesh the original source reconstruction used.
xi: The image-plane grid ray traced to the source-plane. This evaluates the flux of each image-plane lensed source-pixel by ray-tracing it to the source-plane grid and computing its value by interpolating the source galaxy image.

Parameters:

grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The image-plane grid which is traced to the plane where the image is computed, where these values are used to perform the interpolation.
plane_image (Array2D) – The image of the plane or galaxy which is interpolated to compute the lensed image.
plane_index (int) – The index of the plane the image is computed, where the default (-1) computes the image in the last plane and therefore the source-plane.

Return type:

The lensed image of the plane or galaxy computed by interpolating its image to the image-plane.

galaxy_image_2d_dict_from(grid, operated_only=None)[source]#

Returns a dictionary associating every Galaxy object in the Tracer with its corresponding 2D image, using the instance of each galaxy as the dictionary keys.

This object is used for adaptive-features, which use the image of each galaxy in a model-fit in order to adapt quantities like a pixelization or regularization scheme to the surface brightness of the galaxies being fitted.

By inheriting from OperateImageGalaxies functions which apply operations of this dictionary are accessible, for example convolving every image with a PSF or applying a Fourier transform to create a galaxy-visibilities dictionary.

Parameters:: grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y,x) coordinates of the (masked) grid, in its original geometric reference frame.
Return type:: A dictionary associated every galaxy in the tracer with its corresponding 2D image.

deflections_yx_2d_from(grid)[source]#

Returns the 2D deflection angles of all galaxies in the tracer, from the image-plane to the source-plane, accounting for multi-plane ray tracing and from a 2D grid of Cartesian (y,x) coordinates.

The multi-plane ray tracing calculations are performed in the function traced_2d_grid_list_from and its sub-functions in the tracer_util module. This includes performing recursive ray-tracing between planes based on the planes redshifts and using the cosmological distances between them to scale the deflection angles. Users should refer to these functions for details on how the ray-tracing is performed.

This function simply computes the corresponding multi-plane deflection angles by subtracting the image-plane grid (e.g. before lensing) from the source-plane grid (e.g. after lensing).

If there is only one plane in the tracer, the deflections are computed by summation of the deflections of all galaxies in that plane. This is identical too, but computationally faster than, using the multi-plane ray-tracing calculation.

See the autogalaxy.profiles.mass package for details of how deflections are computed from a mass profile.

Parameters:: grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y, x) coordinates where values of the deflections are evaluated.
Return type:: Union[VectorYX2D, VectorYX2DIrregular]

deflections_of_planes_summed_from(grid)[source]#

Returns the summed 2D deflections angles of all galaxies in the tracer, not accounting for multi-plane ray tracing, from a 2D grid of Cartesian (y,x) coordinates.

The deflections of each plane is computed by summing the deflections of all galaxies in that plane. If a plane has no galaxies, or if the galaxies in a plane has no mass profiles, a numpy array of zeros is returned.

This calculation does not account for multi-plane ray-tracing effects, it is simply the sum of the deflections of all galaxies. The function deflections_between_planes_from performs the calculation whilst accounting for multi-plane ray-tracing effects.

For example, if the tracer’s planes contain galaxies at redshifts z=0.5, z=1.0 and z=2.0, and the galaxies at redshifts z=0.5 and z=1.0 have mass profiles, the returned deflections will be the sum of the deflections of the galaxies at z=0.5 and z=1.0.

The deflections of a tracer do not depend on ray-tracing between grids. This is why the deflections of the tracer is the sum of the deflections of all planes, and does not need to account for multi-plane ray-tracing effects (in the way that deflection angles and images do).

See the autogalaxy.profiles.mass package for details of how deflections are computed from a mass profile.

Parameters:: grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y, x) coordinates where values of the deflections are evaluated.
Return type:: Union[VectorYX2D, VectorYX2DIrregular]

deflections_between_planes_from(grid, plane_i=0, plane_j=-1)[source]#

Returns the summed 2D deflections angles between two input planes in the tracer, accounting for multi-plane ray tracing, from a 2D grid of Cartesian (y,x) coordinates.

This function simply computes the corresponding multi-plane deflection angles by subtracting the grid of index plane_i to that of index plane_j. The default inputs subtract the image-plane grid plane_i=0 (e.g. before lensing) from the source-plane grid plane_j=-1 (e.g. after lensing).

See the autogalaxy.profiles.mass package for details of how deflections are computed from a mass profile.

Parameters:: grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y, x) coordinates where values of the deflections are evaluated.
Return type:: Union[VectorYX2D, VectorYX2DIrregular]

convergence_2d_from(grid)[source]#

Returns the summed 2D convergence of all galaxies in the tracer from a 2D grid of Cartesian (y,x) coordinates.

The convergence of each plane is computed by summing the convergences of all galaxies in that plane. If a plane has no galaxies, or if the galaxies in a plane has no mass profiles, a numpy array of zeros is returned.

For example, if the tracer’s planes contain galaxies at redshifts z=0.5, z=1.0 and z=2.0, and the galaxies at redshifts z=0.5 and z=1.0 have mass profiles, the returned convergence will be the sum of the convergences of the galaxies at z=0.5 and z=1.0.

The convergences of a tracer do not depend on ray-tracing between grids. This is why the convergence of the tracer is the sum of the convergences of all planes, and does not need to account for multi-plane ray-tracing effects (in the way that deflection angles and images do).

See the autogalaxy.profiles.mass package for details of how convergences are computed from a mass profile.

Parameters:: grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y, x) coordinates where values of the convergence are evaluated.
Return type:: Array2D

potential_2d_from(grid)[source]#

Returns the summed 2D potential of all galaxies in the tracer from a 2D grid of Cartesian (y,x) coordinates.

The potential of each plane is computed by summing the potentials of all galaxies in that plane. If a plane has no galaxies, or if the galaxies in a plane has no mass profiles, a numpy array of zeros is returned.

For example, if the tracer’s planes contain galaxies at redshifts z=0.5, z=1.0 and z=2.0, and the galaxies at redshifts z=0.5 and z=1.0 have mass profiles, the returned potential will be the sum of the potentials of the galaxies at z=0.5 and z=1.0.

The potentials of a tracer do not depend on ray-tracing between grids. This is why the potential of the tracer is the sum of the potentials of all planes, and does not need to account for multi-plane ray-tracing effects (in the way that deflection angles and images do).

See the autogalaxy.profiles.mass package for details of how potentials are computed from a mass profile.

Parameters:: grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y, x) coordinates where values of the potential are evaluated.
Return type:: Array2D

has(cls)[source]#

Returns a bool specifying whether this tracer has a galaxy with a certain class type.

For example, for the input cls=ag.LightProfile, this function returns True if any galaxy in the tracer has a light profile and false if no galaxy has a light profile.

This function is used to check for mass profiles and specific types of profiles, like the linear light profile.

Parameters:: cls (Type) – The class type of the galaxy which is checked for in the tracer.
Return type:: True if any galaxy in the tracer has the input class type, else False.

cls_list_from(cls)[source]#

Returns a list of objects in the tracer which are an instance of the input cls.

For example:

If the input is cls=ag.LightProfile, a list containing all light profiles in the tracer is returned.

Return type:: The list of objects in the tracer that inherit from input cls.

property perform_inversion: bool#

Returns a bool specifying whether this fit object performs an inversion.

This is based on whether any of the galaxies have a Pixelization or LightProfileLinear object, in which case an inversion is performed.

Return type:: A bool which is True if an inversion is performed.

extract_attribute(cls, attr_name, filter_nones=False)[source]#

Returns an extracted attribute of a class in the tracer as a ValueIrregular or Grid2DIrregular object.

For example, if a tracer has a galaxy with two light profiles, the input:

tracer.extract_attribute(cls=LightProfile, name=”axis_ratio”)

Returns

ArrayIrregular(values=[axis_ratio_0, axis_ratio_1])

If the image plane has two galaxies with two mass profiles and the source plane another galaxy with a mass profile, the input:

tracer.extract_attribute(cls=MassProfile, name=”centre”)

Returns

GridIrregular2D(grid=[(centre_y_0, centre_x_0), (centre_y_1, centre_x_1), (centre_y_2, centre_x_2)])

The primary use of this function is to extract the attributes of profiles for visualization, for example plotting the centres of all mass profiles colored by their profile over the tracer’s image.

Parameters:

cls (Type) – The class type of object whose attribute is extracted (e.g. light profile, mass profile).
attr_name (str) – The name of the attribute which is extracted from the class type (e.g. axis_ratio, centre).

Return type:

List[Union[ArrayIrregular, Grid2DIrregular]]

extract_attributes_of_planes(cls, attr_name, filter_nones=False)[source]#

Returns an extracted attribute of a class in the tracer as a list of ValueIrregular or Grid2DIrregular objects, where the indexes of the list correspond to the tracer’s planes.

For example, if a tracer has an image-plane with a galaxy with a light profile and a source-plane with a galaxy with a light profile, the input:

tracer.extract_attributes_of_planes(cls=LightProfile, name=”axis_ratio”)

Returns:: [ArrayIrregular(values=[axis_ratio_0]), ArrayIrregular(values=[axis_ratio_1])]

If the image plane has two galaxies with a mass profile each and the source plane another galaxy with a mass profile, input:

tracer.extract_attributes_of_planes(cls=MassProfile, name=”centres”)

Return type:

List[Union[ArrayIrregular, Grid2DIrregular]]

Returns:

[: Grid2DIrregular(values=[(centre_y_0, centre_x_0)]), Grid2DIrregular(values=[(centre_y_0, centre_x_0), (centre_y_1, centre_x_1)])

]

If a profile does not have a certain entry, it is replaced with a None. The Nones can be removed by setting filter_nones=True.

The primary use of this function is to extract the attributes of profiles for visualization, for example plotting the centres of all mass profiles colored by their profile over the tracer’s image.

Parameters:

cls (Type) – The class type of object whose attribute is extracted (e.g. light profile, mass profile).
attr_name (str) – The name of the attribute which is extracted from the class type (e.g. axis_ratio, centre).
filter_nones (Optional[bool]) – If True, None entries are removed from the list.

extract_attributes_of_galaxies(cls, attr_name, filter_nones=False)[source]#

Returns an attribute of a class in the tracer as a list of ValueIrregular or Grid2DIrregular objects, where the indexes of the list correspond to the tracer’s galaxies. If a plane has multiple galaxies it will have a list with each galaxy as an entry.

For example, if a tracer has an image-plane with a galaxy with a light profile and a source-plane with a galaxy with a light profile, the input:

tracer.extract_attributes_of_galaxies(cls=LightProfile, name=”axis_ratio”)

Returns:: [ArrayIrregular(values=[axis_ratio_0]), ArrayIrregular(values=[axis_ratio_1])]

If the image plane has two galaxies with a mass profile each and the source plane another galaxy with a mass profile, the input:

tracer.extract_attributes_of_galaxies(cls=MassProfile, name=”centres”)

Return type:

List[Union[ArrayIrregular, Grid2DIrregular]]

Returns:

[: Grid2DIrregular(values=[(centre_y_0, centre_x_0)]), Grid2DIrregular(values=[(centre_y_0, centre_x_0)]) Grid2DIrregular(values=[(centre_y_0, centre_x_0)])

]

If the first galaxy in the image plane in the example above had two mass profiles as well as the galaxy in the source plane it would return:

[
Grid2DIrregular(values=[(centre_y_0, centre_x_0), (centre_y_1, centre_x_1)]), Grid2DIrregular(values=[(centre_y_0, centre_x_0)]) Grid2DIrregular(values=[(centre_y_0, centre_x_0, (centre_y_1, centre_x_1))])

]

If a profile does not have a certain entry, it is replaced with a None. The Nones can be removed by setting filter_nones=True.

The primary use of this function is to extract the attributes of profiles for visualization, for example plotting the centres of all mass profiles colored by their profile over the tracer’s image.

Parameters:

cls (Type) – The class type of object whose attribute is extracted (e.g. light profile, mass profile).
attr_name (str) – The name of the attribute which is extracted from the class type (e.g. axis_ratio, centre).
filter_nones (Optional[bool]) –

extract_profile(profile_name)[source]#

Returns a profile (e.g. a LightProfile, MassProfile, Point) from the tracer using the name of that component.

For example, if a tracer has two galaxies named lens and source, where lens has a light profile named light_0 and source has a light profile named light_1, the input:

tracer.extract_profile(profile_name=”light_1”)

Return the light profile of the source galaxy.

This primarily used for point-source modeling, where the locations that the point-sources tracer to in different planes must be paired to their corresponding point-source Point profile.

Parameters:: profile_name (str) – The name of the profile component in the tracer.
Return type:: GeometryProfile

extract_plane_index_of_profile(profile_name)[source]#

Returns the plane index of a profile (e.g. a LightProfile, MassProfile, Point) from the tracer using the name of that component.

For example, if a tracer has two galaxies named lens and source, where lens has a light profile named light_0 and source has a light profile named light_1, the input:

tracer.extract_profile(profile_name=”light_1”)

Would return plane_index=1 corresponding to the profile in the source plane.

This primarily used for point-source modeling, where the locations that the point-sources tracer to in different planes must be paired to their corresponding point-source Point profile.

Parameters:: profile_name (str) – The name of the profile component in the tracer.
Return type:: int

set_snr_of_snr_light_profiles(grid, exposure_time, background_sky_level=0.0, psf=None)[source]#

Iterate over every LightProfileSNR in the tracer and set their intensity values to values which give their input signal_to_noise_ratio value, which is performed as follows:

Evaluate the image of each light profile on the input grid.
Blur this image with a PSF, if included.
Take the value of the brightest pixel.
Use an input exposure_time and background_sky (e.g. from the SimulatorImaging object) to determine what value of intensity gives the desired signal to noise ratio for the image.

The intensity is set using an input grid, meaning that for strong lensing calculations the ray-traced grid can be used such that the S/N accounts for the magnification of a source galaxy.

Parameters:

grid (Union[ndarray, Grid2D, Grid2DIterate, Grid2DIrregular]) – The (y, x) coordinates in the original reference frame of the grid.
exposure_time (float) – The exposure time of the simulated imaging.
background_sky_level (float) – The level of the background sky of the simulated imaging.
psf (Optional[Kernel2D]) – The psf of the simulated imaging which can change the S/N of the light profile due to spreading out the emission.