ThinCentralPlaneDustExtinction

class dysmalpy.models.ThinCentralPlaneDustExtinction(inc=45.0, pa=0.0, xshift=0.0, yshift=0.0, amp_extinct=0.0, **kwargs)

Bases: DustExtinction

Model for extinction due to a thin plane of dust

Parameters:

• inc (float) – Inclination of the dust plane in deg

• pa (float) – Position angle of the dust plane in deg

• xshift (float) – Offset in pixels of the center of the dust plane

• yshift (float) – Offset in pixels of the center of the dust plane

• amp_extinct (float) – Strength of the extinction through the dust plane. Expressed as the fraction of flux that is transmitted through the dust plane. amp_extinct = 1 means 100% attenuation.

Notes

This model places a dust plane within the model cube. All positions that are behind the dust plane relative to the line of sight will have their flux reduced by amp_extinct:

\[F = AF_{\rm intrinsic}\]

where \(A\) is between 0 and 1.

Attributes Summary

amp_extinct
inc
pa
param_names	Names of the parameters that describe models of this type.
xshift
yshift

Methods Summary

attenuation_cube(x, y, z)	Evaluate the flux attenuation (linear multiplier) at all locations of the cube
evaluate(x, y, z, inc, pa, xshift, yshift, ...)	Evaluate the model on some input variables.

Attributes Documentation

amp_extinct = DysmalParameter('amp_extinct', value=0.0, bounds=(0.0, 1.0), prior=<dysmalpy.parameters.UniformPrior object>)

inc = DysmalParameter('inc', value=45.0, bounds=(0, 90), prior=<dysmalpy.parameters.UniformPrior object>)

pa = DysmalParameter('pa', value=0.0, bounds=(-180, 180), prior=<dysmalpy.parameters.UniformPrior object>)

param_names = ('inc', 'pa', 'xshift', 'yshift', 'amp_extinct')

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.

xshift = DysmalParameter('xshift', value=0.0, prior=<dysmalpy.parameters.UniformPrior object>)

yshift = DysmalParameter('yshift', value=0.0, prior=<dysmalpy.parameters.UniformPrior object>)

Methods Documentation

attenuation_cube(x, y, z)

Evaluate the flux attenuation (linear multiplier) at all locations of the cube

static evaluate(x, y, z, inc, pa, xshift, yshift, amp_extinct)

Evaluate the model on some input variables.