autogalaxy.profiles.light.standard.GaussianMultipole#
- class GaussianMultipole[source]#
Bases:
_LightProfileMultipoleMixin,GaussianThe elliptical Gaussian light profile with m=3 and m=4 Fourier multipole perturbations on the eccentric radius.
- Parameters:
centre (
Tuple[float,float]) – The (y,x) arc-second coordinates of the profile centre.ell_comps (
Tuple[float,float]) – The first and second ellipticity components of the elliptical coordinate system. The multipole perturbation is applied to the eccentric radius and therefore follows this ellipticity.intensity (
float) – Overall intensity normalisation of the light profile.sigma (
float) – The sigma value of the Gaussian.multipole_3_comps (
Tuple[float,float]) – The(cos, sin)components of the m=3 Fourier perturbation. Defaults to(0.0, 0.0)which reduces the profile toGaussian.multipole_4_comps (
Tuple[float,float]) – The(cos, sin)components of the m=4 Fourier perturbation. Defaults to(0.0, 0.0)which reduces the profile toGaussian.
Methods
angleThe 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_radiansThe 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_fromThe angle between each angle theta on the grid and the profile, in radians.
axis_ratioThe ratio of the minor-axis to major-axis (b/a) of the ellipse defined by profile (0.0 > q > 1.0).
blurred_image_2d_fromEvaluate the light object's 2D image from a input 2D grid of coordinates and convolve it with a PSF.
eccentric_radii_grid_fromConvert 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_fromConvert a grid of (y,x) coordinates to their elliptical radii values: :math: (x^2 + (y^2/q))^0.5
hasReturns True if any attribute of this profile is an instance of the input class cls, else False.
Returns the 2D image of the multipole-perturbed Gaussian profile.
Returns the 2D Gaussian image evaluated at the input radial values.
luminosity_integralRoutine to integrate the luminosity of an elliptical light profile.
luminosity_within_circle_fromIntegrate the light profile to compute the total luminosity within a circle of specified radius.
padded_image_2d_fromEvaluate 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.
perturbed_radii_fromReturns the eccentric radii of
gridperturbed by the m=3 and m=4 Fourier multipoles, as a raw backend array (numpy or jax.numpy).radial_grid_fromConvert 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_fromRotate 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_fromTransform a grid of (y,x) coordinates from the reference frame of the profile to the original observer reference frame.
transformed_to_reference_frame_grid_fromTransform a grid of (y,x) coordinates to the reference frame of the profile.
unmasked_blurred_image_2d_fromEvaluate 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.
visibilities_fromEvaluate 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.
Attributes
coefficient_tagA short string tag used to label the intensity coefficient when this profile is used inside a Basis object (e.g. for multi-Gaussian expansion or shapelet decomposition).
half_light_radiusThe radius that contains half of the total light of the profile (the half-light radius).
multipole_3_compsmultipole_4_comps- image_2d_via_radii_from(grid_radii, xp=<module 'numpy' from '/home/docs/checkouts/readthedocs.org/user_builds/pyautolens/envs/latest/lib/python3.12/site-packages/numpy/__init__.py'>, **kwargs)[source]#
Returns the 2D Gaussian image evaluated at the input radial values.
Unlike
Gaussian.image_2d_via_radii_from, this override accepts a raw backend array (the output ofperturbed_radii_from) rather than an autoarray-wrapped grid, since the perturbation step strips the wrapper.