oimCustomComponents

Custom model components added by the community

If you add python files with custom components in the oimCustomComponents directory add the import here so that all component will be available through the customComponent module

Classes:

oimAEIRing(**kwargs)

oimBox(**kwargs)

oimExpRing(**kwargs)

oimFastRotator(**kwargs)

oimFastRotatorLLDD(**kwargs)

oimFastRotatorQuadLDD(**kwargs)

oimFastRotatorNLLDD(**kwargs)

oimFastRotatorMasse(**kwargs)

oimGaussLorentz(**kwargs)

oimRadialRing(**kwargs)

A ring defined by a radial intensity profile in r^p.

oimRadialRing2(**kwargs)

A ring defined by a radial intensity profile in r^p.

oimSpiral(**kwargs)

oimStarHaloGaussLorentz(**kwargs)

oimStarHaloIRing(**kwargs)

oimTempGrad(**kwargs)

A ring defined by a radial temperature profile in r^q and a radial dust surface density profile in r^p.

oimKinematicDisk(**kwargs)

oimBinaryOrbit(**kwargs)

oimDisco(**kwargs)

oimBipolar(**kwargs)

class oimodeler.oimCustomComponents.oimAEIRing(**kwargs)
_imageFunction(xx, yy, wl, t)
_visFunction(xp, yp, rho, wl, t)
elliptic = True
name = 'Asymmetrical Elliptical Infinitesimal Ring'
shorname = 'AEIR'
class oimodeler.oimCustomComponents.oimBox(**kwargs)
_imageFunction(xx, yy, wl, t)
_visFunction(ucoord, vcoord, rho, wl, t)
name = 'Rectangular Box'
shortname = 'BOX'
class oimodeler.oimCustomComponents.oimExpRing(**kwargs)
property _r
_radialProfileFunction(r, wl, t)
elliptic = True
name = 'Exponential Ring'
shortname = 'ExpR'
class oimodeler.oimCustomComponents.oimFastRotator(**kwargs)
_internalImage()
name = 'Fast Rotator'
shortname = 'FRot'
class oimodeler.oimCustomComponents.oimFastRotatorLLDD(**kwargs)
_internalImage()
name = 'Fast Rotator'
shortname = 'FRot'
class oimodeler.oimCustomComponents.oimFastRotatorQuadLDD(**kwargs)
_internalImage()
name = 'Fast Rotator'
shortname = 'FRot'
class oimodeler.oimCustomComponents.oimFastRotatorNLLDD(**kwargs)
_internalImage()
name = 'Fast Rotator'
shortname = 'FRot'
class oimodeler.oimCustomComponents.oimFastRotatorMasse(**kwargs)
_internalImage()
name = 'Fast Rotator'
shortname = 'FRot'
class oimodeler.oimCustomComponents.oimGaussLorentz(**kwargs)
_imageFunction(xx, yy, wl, t)
_visFunction(xp, yp, rho, wl, t)

The visibility function for the Gauss-Lorentzian model.

elliptic = True
name = 'Gauss-Lorentzian'
shortname = 'GL'
class oimodeler.oimCustomComponents.oimRadialRing(**kwargs)

A ring defined by a radial intensity profile in r^p.

It accounts for elongation and rotation.

Parameters:
  • din (float) – Inner radius of the disk [mas].

  • dout (float) – Outer radius of the disk [mas].

  • p (float) – Power-law exponent for the radial profile.

  • pa (float) – Positional angle.

  • elong (float) – Elongation of the disk.

  • dim (float) – Dimension of the image.

Variables:
  • params (dict with keys of str and values of oimParam) – Dictionary of parameters.

  • _wl (array_like) – Wavelengths.

  • _t (array_like) – Times.

  • _r (array_like) – Radial grid.

_radialProfileFunction(xx, yy, wl, t)

Calculates a radial power law profile.

property _r

Gets the radial profile [mas].

_radialProfileFunction(r: ndarray, wl: ndarray, t: ndarray) ndarray

Calculates a radial power law profile.

Parameters:
  • r (numpy.ndarray) – Radial grid.

  • wl (numpy.ndarray) – Wavelengths.

  • t (numpy.ndarray) – Times.

Returns:

radial_profile

Return type:

numpy.ndarray

elliptic = True
name = 'Radial Ring'
shortname = 'RadRing'
class oimodeler.oimCustomComponents.oimRadialRing2(**kwargs)

A ring defined by a radial intensity profile in r^p.

It accounts for elongation and rotation.

Parameters:
  • din (float) – Inner diameter of the ring [mas].

  • w (float) – width of the ring [mas].

  • p (float) – Power-law exponent for the radial profile.

  • pa (float) – Positional angle.

  • elong (float) – Elongation of the disk.

  • dim (float) – Dimension of the image.

Variables:
  • params (dict with keys of str and values of oimParam) – Dictionary of parameters.

  • _wl (array_like) – Wavelengths.

  • _t (array_like) – Times.

  • _r (array_like) – Radial grid.

_radialProfileFunction(xx, yy, wl, t)

Calculates a radial power law profile.

property _r

Gets the radial profile [mas].

_radialProfileFunction(r: ndarray, wl: ndarray, t: ndarray) ndarray

Calculates a radial power law profile.

Parameters:
  • r (numpy.ndarray) – Radial grid.

  • wl (numpy.ndarray) – Wavelengths.

  • t (numpy.ndarray) – Times.

Returns:

radial_profile

Return type:

numpy.ndarray

elliptic = False
name = 'Radial Ring2'
shortname = 'RadRing2'
class oimodeler.oimCustomComponents.oimSpiral(**kwargs)
_imageFunction(xx, yy, wl, t)
elliptic = True
getPixelSize()
name = 'Spiral component'
shorname = 'Sp'
class oimodeler.oimCustomComponents.oimStarHaloGaussLorentz(**kwargs)
_imageFunction(xx, yy, wl, t)
_image_gauss_lorentz(xx, yy, wl, t)
_visFunction(xp, yp, rho, wl, t)
_vis_gauss_lorentz(xp, yp, rho, wl, t)
elliptic = True
name = 'Star and Halo component with Gauss-Lorentzian disk'
shortname = 'SHGL'
class oimodeler.oimCustomComponents.oimStarHaloIRing(**kwargs)
_imageFunction(xx, yy, wl, t)
_image_gauss_lorentz(xx, yy, wl, t)
_visFunction(xp, yp, rho, wl, t)
_vis_gauss_lorentz(xp, yp, rho, wl, t)
name = 'Star and Halo component with Gauss-Lorentzian ring convolved disk'
shortname = 'SHGLR'
class oimodeler.oimCustomComponents.oimTempGrad(**kwargs)

A ring defined by a radial temperature profile in r^q and a radial dust surface density profile in r^p.

Parameters:
  • rin (float) – Inner radius of the disk [au].

  • rout (float) – Outer radius of the disk [au].

  • r0 (float) – Reference radius for power-laws [au].

  • T0 (float) – Temperature at reference radius r0 [K].

  • sigma0 (float) – Dust surface density at reference radius r0 [M_sun].

  • Mdust (float) – Mass of the dusty disk [M_sun].

  • q (float) – Power-law exponent of the temperature profile.

  • p (float) – Power-law exponent of the dust surface density profile.

  • dist (float) – Distance of the star [pc].

Variables:
  • params (dict with keys of str and values of oimParam) – Dictionary of parameters.

  • rin (oimParam) – Inner radius of the disk [au].

  • rout (oimParam) – Outer radius of the disk [au].

  • r0 (oimParam) – Reference radius for power-laws [au].

  • T0 (oimParam) – Temperature at reference radius r0 [K].

  • Tin (float) – Temperature at inner radius rin [K].

  • sigma0 (oimParam) – Dust surface density at reference radius r0 [M_sun].

  • Mdust (oimParam) – Mass of the dusty disk [M_sun].

  • q (oimParam) – Power-law exponent of the temperature profile.

  • p (oimParam) – Power-law exponent of the dust surface density profile.

  • _r (numpy.ndarray) – Radii [mas].

  • _wl (numpy.ndarray) – Wavelengths [micron].

  • _t (numpy.ndarray) – Times [second].

_radialProfileFunction(r, wl, t)

Calculates a radial temperature gradient profile via a dust-surface density- and temperature profile.

property Tin: float

Gets the temperature at the inner radius.

property _r

Gets the radial profile (mas).

_radialProfileFunction(r: ndarray, wl: ndarray, t: ndarray) ndarray

Calculates a radial temperature gradient profile via a dust-surface density- and temperature profile.

Parameters:
  • r (numpy.ndarray) – Radial grid [mas].

  • wl (numpy.ndarray) – Wavelengths [m].

  • t (numpy.ndarray) – Times [second].

  • Results

  • ——-

  • radial_profile (numpy.ndarray)

compute_sigma0 = True
elliptic = True
name = 'Temperature Gradient'
shortname = 'TempGrad'
class oimodeler.oimCustomComponents.oimKinematicDisk(**kwargs)
_internalImage()
elliptic = False
name = 'kinematic disk component'
shorname = 'kinDisk'
class oimodeler.oimCustomComponents.oimBinaryOrbit(**kwargs)
_T0inMJD()
_params = {}
_visFunction(ucoord, vcoord, rho, wl, t)
getPrimaryRadialVelocity(t)
getRadialVelocities(t)
getSeparation(t, mas=False)
getTotalMass(dist)
name = 'Binary Orbit'
property normalizeFlux
property params
property primary
property secondary
shortname = 'orbit'
class oimodeler.oimCustomComponents.oimDisco(**kwargs)
_internalImage()
getPixelSize(mas=False)
name = 'DISCO gaseous disk model'
shortname = 'Disco'
class oimodeler.oimCustomComponents.oimBipolar(**kwargs)
_internalImage()
elliptic = False
name = 'Bipolar nebula '
shorname = 'bipolar'