autogalaxy.profiles.mass.SMBHBinary

class SMBHBinary

Bases: MassProfile

Parameters:

• centre (Tuple[float, float]) – The (y,x) arc-second coordinates of the binary mid-point.

• separation (float) – The angular separation between the two SMBHs in arcseconds.

• angle_binary (float) – The orientation angle of the binary axis relative to the positive x-axis (degrees, anticlockwise).

• mass (float) – The total mass of the binary system in solar masses \(M_\odot\).

• mass_ratio (float) – The mass ratio \(q_m = M_0 / M_1\) (\(q_m \geq 1\) by convention).

• redshift_object (float) – The redshift of the SMBH binary (lens plane).

• redshift_source (float) – The redshift of the lensed source galaxy.

Methods

angle	The position angle in degrees of the major-axis of the ellipse defined by profile, defined counter clockwise from the positive x-axis (0.0 > angle > 180.0).
angle_radians	The position angle in radians of the major-axis of the ellipse defined by profile, defined counter clockwise from the positive x-axis (0.0 > angle > 2pi).
angle_to_profile_grid_from	The angle between each angle theta on the grid and the profile, in radians.
axis_ratio	The ratio of the minor-axis to major-axis (b/a) of the ellipse defined by profile (0.0 > q > 1.0).
convergence_2d_from	Returns the two dimensional projected convergence on a grid of (y,x) arc-second coordinates.
convergence_func	Returns the convergence of the mass profile as a function of the radial coordinate.
deflections_2d_via_potential_2d_from	Returns the 2D deflection angles of the mass profile by numerically differentiating the lensing potential on the input grid.
deflections_yx_2d_from	Returns the two dimensional deflection angles on a grid of (y,x) arc-second coordinates.
density_between_circular_annuli	Calculate the mass between two circular annuli and compute the density by dividing by the annuli surface area.
eccentric_radii_grid_from	Convert a grid of (y,x) coordinates to an eccentric radius: :math: axis_ratio^0.5 (x^2 + (y^2/q))^0.5
elliptical_radii_grid_from	Convert a grid of (y,x) coordinates to their elliptical radii values: :math: (x^2 + (y^2/q))^0.5
extract_attribute	Returns an attribute of a class and its children profiles in the galaxy as a ValueIrregular or Grid2DIrregular object.
has	Returns True if any attribute of this profile is an instance of the input class cls, else False.
mass_angular_within_circle_from	Integrate the mass profiles's convergence profile to compute the total mass within a circle of specified radius.
mass_integral	Integrand used by mass_angular_within_circle_from to compute the total projected mass within a circle.
potential_2d_from	Returns the two dimensional projected potential on a grid of (y,x) arc-second coordinates.
potential_func	Returns the integrand of the lensing potential at a single point, used in numerical integration schemes for computing the potential from the mass profile's convergence.
radial_deflection_from
radial_grid_from	Convert a grid of (y, x) coordinates, to their radial distances from the profile centre (e.g. :math: r = sqrt(x**2 + y**2)).
rotated_grid_from_reference_frame_from	Rotate a grid of (y,x) coordinates which have been transformed to the elliptical reference frame of a profile back to the original unrotated coordinate grid reference frame.
transformed_from_reference_frame_grid_from	Transform a grid of (y,x) coordinates from the reference frame of the profile to the original observer reference frame.
transformed_to_reference_frame_grid_from	Transform a grid of (y,x) coordinates to the reference frame of the profile.
vmapped_deflections_from

Attributes

angle_binary_radians	The angle between the two SMBHs in radians.
average_convergence_of_1_radius	The radius a critical curve forms for this mass profile, e.g. where the mean convergence is equal to 1.0.
ellipticity_rescale	A rescaling factor applied to account for the ellipticity of the mass profile when computing the Einstein radius from the average convergence equals unity criterion.

property angle_binary_radians: float

The angle between the two SMBHs in radians.

convergence_2d_from(grid, xp=<module 'numpy' from '/home/docs/checkouts/readthedocs.org/user_builds/pyautolens/envs/latest/lib/python3.12/site-packages/numpy/__init__.py'>, **kwargs)

Returns the two dimensional projected convergence on a grid of (y,x) arc-second coordinates.

The convergence is computed as the sum of the convergence of the two individual SMBH profiles in the binary.

Parameters:

grid (Union[ndarray, Grid2D, Grid2DIrregular]) – The grid of (y,x) arc-second coordinates the convergence is computed on.

potential_2d_from(grid, xp=<module 'numpy' from '/home/docs/checkouts/readthedocs.org/user_builds/pyautolens/envs/latest/lib/python3.12/site-packages/numpy/__init__.py'>, **kwargs)

Returns the two dimensional projected potential on a grid of (y,x) arc-second coordinates.

The potential is computed as the sum of the potential of the two individual SMBH profiles in the binary.

Parameters:

grid (Union[ndarray, Grid2D, Grid2DIrregular]) – The grid of (y,x) arc-second coordinates the potential is computed on.

deflections_yx_2d_from(grid, xp=<module 'numpy' from '/home/docs/checkouts/readthedocs.org/user_builds/pyautolens/envs/latest/lib/python3.12/site-packages/numpy/__init__.py'>, **kwargs)

Returns the two dimensional deflection angles on a grid of (y,x) arc-second coordinates.

The deflection angles are computed as the sum of the convergence of the two individual SMBH profiles in the binary.

Parameters:

grid (Union[ndarray, Grid2D, Grid2DIrregular]) – The grid of (y,x) arc-second coordinates the deflection angles are computed on.