LightClump

class dysmalpy.models.LightClump(tracer=None, **kwargs)[source]

Bases: LightModel, _DysmalFittable3DModel

Light distribution for a clump following a Sersic profile, at a given galaxy midplane R and azimuthal angle phi.

Parameters:
  • r_center (float) – Radial distance from galaxy center to clump center, in the galaxy midplane, in kpc

  • phi (float) – Azimuthal angle of clump, counter-clockwise from blue major axis. In degrees.

  • theta (float) – Polar angle of clump, from the +z direction. In degrees.

  • L_tot (float) – Total luminsoity of clump. Arbitrary units.

  • r_eff (float) – Effective (half-light) radius of clump in kpc

  • n (float) – Sersic index of clump

  • tracer (string) – (Attribute): Name of the dynamical tracer

Notes

Model formula:

\[I(r) = I_e \exp \left\{ -b_n \left[ \left( \frac{r}{r_{\mathrm{eff}}} \right)^{1/n} -1 \right] \right\}\]

The constant \(b_n\) is defined such that \(r_{\mathrm{eff}}\) contains half the total light, and can be solved for numerically.

\[\Gamma(2n) = 2\gamma (b_n,2n)\]

Attributes Summary

L_tot

n

param_names

Names of the parameters that describe models of this type.

phi

r_center

r_eff

theta

Methods Summary

evaluate(x, y, z, L_tot, r_eff, n, r_center, ...)

Light profile of the clump

light_profile(x, y, z)

Light profile of the clump

Attributes Documentation

L_tot = DysmalParameter('L_tot', value=1.0, bounds=(0, 50), prior=<dysmalpy.parameters.UniformPrior object>)
n = DysmalParameter('n', value=1.0, bounds=(0, 8), prior=<dysmalpy.parameters.UniformPrior object>)
param_names = ('L_tot', 'r_eff', 'n', 'r_center', 'phi', 'theta')

Names of the parameters that describe models of this type.

The parameters in this tuple are in the same order they should be passed in when initializing a model of a specific type. Some types of models, such as polynomial models, have a different number of parameters depending on some other property of the model, such as the degree.

When defining a custom model class the value of this attribute is automatically set by the Parameter attributes defined in the class body.

phi = DysmalParameter('phi', value=0.0, bounds=(0, 360), prior=<dysmalpy.parameters.UniformPrior object>)
r_center = DysmalParameter('r_center', value=0.0, bounds=(0, 30), prior=<dysmalpy.parameters.UniformPrior object>)
r_eff = DysmalParameter('r_eff', value=1.0, bounds=(0, 50), prior=<dysmalpy.parameters.UniformPrior object>)
theta = DysmalParameter('theta', value=90.0, bounds=(0, 180), prior=<dysmalpy.parameters.UniformPrior object>)

Methods Documentation

static evaluate(x, y, z, L_tot, r_eff, n, r_center, phi, theta)[source]

Light profile of the clump

light_profile(x, y, z)[source]

Light profile of the clump

Parameters:
  • x (float or array) – Position at which to calculate the light profile

  • y (float or array) – Position at which to calculate the light profile

  • z (float or array) – Position at which to calculate the light profile

Returns:

light – Relative line flux as a function of radius

Return type:

float or array