ZHeightGauss

class dysmalpy.models.ZHeightGauss(**kwargs)

Bases: ZHeightProfile

Gaussian flux distribution in the z-direction

Parameters:

sigmaz (float) – Dispersion of the Gaussian in kpc

Notes

Model formula:

\[F_z = \exp\left\{\frac{-z^2}{2\sigma_z^2}\right\}\]

Attributes Summary

param_names	Names of the parameters that describe models of this type.
sigmaz
z_scalelength	Evaluate the flux attenuation (linear multiplier) at all locations of the cube

Methods Summary

evaluate(z, sigmaz)

Evaluate the model on some input variables.

Attributes Documentation

param_names = ('sigmaz',)

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.

sigmaz = DysmalParameter('sigmaz', value=1.0, fixed=True, bounds=(0, 10), prior=<dysmalpy.parameters.UniformPrior object>)

z_scalelength

Methods Documentation

static evaluate(z, sigmaz)

Evaluate the model on some input variables.