oimBasicFourierComponents

Basic model-components defined in the Fourier plan

Classes:

`oimPt`(**kwargs)	Point Source component defined in the fourier space
`oimBackground`(**kwargs)	Background component defined in the fourier space
`oimUD`(**kwargs)	Uniform Disk component defined in the fourier space
`oimEllipse`(**kwargs)	Uniform Ellipse component defined in the fourier space
`oimGauss`(**kwargs)	Gaussian Disk component defined in the fourier space
`oimEGauss`(**kwargs)	Elliptical Gaussian component defined in the fourier space
`oimIRing`(**kwargs)	Infinitesimal Ring component defined in the fourier space
`oimEIRing`(**kwargs)	Infinitesimal Elliptical Ring component defined in the fourier space
`oimRing`(**kwargs)	Ring component defined in the fourier space
`oimRing2`(**kwargs)	Ring component defined in the fourier space
`oimERing`(**kwargs)	Elliptical Ring component defined in the fourier space
`oimERing2`(**kwargs)	Elliptical Ring component defined in the fourier space
`oimESKIRing`(**kwargs)	Skewed Elliptical Infinitesimal Ring component defined in the fourier space
`oimESKGRing`(**kwargs)	Skewed Elliptical Gaussian Ring component defined in the fourier space
`oimESKRing`(**kwargs)	Skewed Elliptical Ring component defined in the fourier space
`oimLorentz`(**kwargs)	Pseudo-Lorentzian component defined in the fourier space
`oimELorentz`(**kwargs)	Elliptical-Lorentzian component defined in the fourier space
`oimLinearLDD`(**kwargs)	Linear Limb Darkened Disk component defined in the fourier space
`oimQuadLDD`(**kwargs)	Quadratic Limb Darkened Disk component defined in the fourier space
`oimPowerLawLDD`(**kwargs)	Power Law Limb Darkened Disk component defined in the fourier space :Parameters: * x (u.mas \| oimInterp) -- x pos of the component (in mas). The default is 0. * y (u.mas \| oimInterp) -- y pos of the component (in mas). The default is 0. * f (u.dimensionless_unscaled \| oimInterp) -- flux of the component. The default is 1. * d (u.mas \| oimInterp) -- diameter of the ring (in mas). The default is 0. * a (u.dimensionless_unscaled \| oimInterp) -- power law limb darkening exponent * I(mu)/I(1) = mua**.
`oimSqrtLDD`(**kwargs)	Square-root Limb Darkened Disk component defined in the fourier space
`oim4CLDD`(**kwargs)	4 Coefficients Limb Darkened Disk component defined in the fourier space
`oimConvolutor`(component1, component2, **kwargs)	Convolves two components.

class oimodeler.oimBasicFourierComponents.oimPt(**kwargs)

Point Source component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.

name = 'Point source'

shortname = 'Pt'

_visFunction(ucoord, vcoord, rho, wl, t)

_imageFunction(xx, yy, wl, t)

class oimodeler.oimBasicFourierComponents.oimBackground(**kwargs)

Background component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.

name = 'Background'

shortname = 'Bckg'

_visFunction(ucoord, vcoord, rho, wl, t)

_imageFunction(xx, yy, wl, t)

class oimodeler.oimBasicFourierComponents.oimUD(**kwargs)

Uniform Disk component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the disk (in mas). The default is 0.

name = 'Uniform Disk'

shortname = 'UD'

_visFunction(ucoord, vcoord, rho, wl, t)

_imageFunction(xx, yy, wl, t)

class oimodeler.oimBasicFourierComponents.oimEllipse(**kwargs)

Uniform Ellipse component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – major-axis diameter of the ellipse (in mas). The default is 0.
pa (u.deg | oimInterp) – position angle of the major axis of the ellipse (in deg). The default is 0.
elong (u.dimensionless_unscaled | oimInterp) – elongation of the ellipse. The default is 1.

name = 'Uniform Ellipse'

shortname = 'eUD'

elliptic = True

class oimodeler.oimBasicFourierComponents.oimGauss(**kwargs)

Gaussian Disk component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
fwhm (u.mas | oimInterp) – FWHM of the Gaussian (in mas). The default is 0.

name = 'Gaussian Disk'

shortname = 'GD'

_visFunction(xp, yp, rho, wl, t)

_imageFunction(xx, yy, wl, t)

class oimodeler.oimBasicFourierComponents.oimEGauss(**kwargs)

Elliptical Gaussian component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
fwhm (u.mas | oimInterp) – FWHM of the Gaussian (in mas). The default is 0.
pa (u.deg | oimInterp) – position angle of the major axis of the Gaussian (in deg). The default is 0.
elong (u.dimensionless_unscaled | oimInterp) – elongation of the Gaussian. The default is 1.

name = 'Gaussian Ellipse'

shortname = 'EG'

elliptic = True

class oimodeler.oimBasicFourierComponents.oimIRing(**kwargs)

Infinitesimal Ring component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.

name = 'Infinitesimal Ring'

shortname = 'IR'

_visFunction(xp, yp, rho, wl, t)

_imageFunction(xx, yy, wl, t, minPixSize=None)

class oimodeler.oimBasicFourierComponents.oimEIRing(**kwargs)

Infinitesimal Elliptical Ring component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.
pa (u.deg | oimInterp) – position angle of the major axis of the ring (in deg). The default is 0.
elong (u.dimensionless_unscaled | oimInterp) – elongation of the ring. The default is 1.

name = 'Ellitical Infinitesimal Ring'

shortname = 'EIR'

elliptic = True

class oimodeler.oimBasicFourierComponents.oimRing(**kwargs)

Ring component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
din (u.mas | oimInterp) – inner diameter of the ring (in mas). The default is 0.
dout (u.mas | oimInterp) – outer diameter of the ring (in mas). The default is 0.

name = 'Ring'

shortname = 'R'

_visFunction(xp, yp, rho, wl, t)

_imageFunction(xx, yy, wl, t)

class oimodeler.oimBasicFourierComponents.oimRing2(**kwargs)

Ring component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.
width (u.mas | oimInterp) – width of the ring (in mas). The default is 0.

name = 'IRing convolved with UD'

shortname = 'R2'

_visFunction(xp, yp, rho, wl, t)

_imageFunction(xx, yy, wl, t)

class oimodeler.oimBasicFourierComponents.oimERing(**kwargs)

Elliptical Ring component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.
width (u.mas | oimInterp) – width of the ring (in mas). The default is 0.
pa (u.deg | oimInterp) – position angle of the major axis of the ring (in deg). The default is 0.
elong (u.dimensionless_unscaled | oimInterp) – elongation of the ring. The default is 1.

name = 'Elliptical Ring'

shortname = 'ER'

elliptic = True

class oimodeler.oimBasicFourierComponents.oimERing2(**kwargs)

Elliptical Ring component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.
width (u.mas | oimInterp) – width of the ring (in mas). The default is 0.
pa (u.deg | oimInterp) – position angle of the major axis of the ring (in deg). The default is 0.
elong (u.dimensionless_unscaled | oimInterp) – elongation of the ring. The default is 1.

name = 'Elliptical Ring2'

shortname = 'ER2'

elliptic = True

class oimodeler.oimBasicFourierComponents.oimESKIRing(**kwargs)

Skewed Elliptical Infinitesimal Ring component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.
skw (u.dimensionless_unscaled | oimInterp) – skew of the ring. The default is 0.
skwPa (u.deg | oimInterp) – elongation of the ring. The default is 1.

name = 'Skewed Elliptical Infinitesimal Ring'

shortname = 'SKEIR'

elliptic = True

_visFunction(xp, yp, rho, wl, t)

_imageFunction(xx, yy, wl, t)

class oimodeler.oimBasicFourierComponents.oimESKGRing(**kwargs)

Skewed Elliptical Gaussian Ring component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d u.mas | oimInterp – diameter of the ring (in mas). The default is 0.
fwhm (u.mas | oimInterp) – outer diameter of the ring (in mas). The default is 0.
skw (u.dimensionless_unscaled | oimInterp) – skew of the ring. The default is 0.
skwPa (u.deg | oimInterp) – elongation of the ring. The default is 1.

name = 'Skewed Elliptical Ring'

shortname = 'SKER'

elliptic = True

_visFunction(xp, yp, rho, wl, t)

class oimodeler.oimBasicFourierComponents.oimESKRing(**kwargs)

Skewed Elliptical Ring component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
din (u.mas | oimInterp) – inner diameter of the ring (in mas). The default is 0.
dout (u.mas | oimInterp) – outer diameter of the ring (in mas). The default is 0.
skw (u.dimensionless_unscaled | oimInterp) – skew of the ring. The default is 0.
skwPa (u.deg | oimInterp) – elongation of the ring. The default is 1.

name = 'Skewed Elliptical Ring'

shortname = 'SKER'

elliptic = True

_visFunction(xp, yp, rho, wl, t)

class oimodeler.oimBasicFourierComponents.oimLorentz(**kwargs)

Pseudo-Lorentzian component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
fwhm (u.mas | oimInterp) – FWHM of the Lorentzian (in mas). The default is 0.

name = 'Pseudo Lorentzian'

shortname = 'LZ'

_visFunction(xp, yp, rho, wl, t)

_imageFunction(xx, yy, wl, t)

class oimodeler.oimBasicFourierComponents.oimELorentz(**kwargs)

Elliptical-Lorentzian component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
fwhm (u.mas | oimInterp) – FWHM of the Lorentzian (in mas). The default is 0.
pa (u.deg | oimInterp) – position angle of the major axis of the Lorentzian (in deg). The default is 0.
elong (u.dimensionless_unscaled | oimInterp) – elongation of the Lorentzian. The default is 1.

name = 'Elliptical Pseudo Lorentzian'

shortname = 'ELZ'

elliptic = True

class oimodeler.oimBasicFourierComponents.oimLinearLDD(**kwargs)

Linear Limb Darkened Disk component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.
a (u.dimensionless_unscaled | oimInterp) – linear limb darkening coefficient
I(mu)/I(1) = 1 - a(1-mu)

name = 'Linear Limb Darkened Disk '

shortname = 'LLDD'

_visFunction(xp, yp, rho, wl, t)

class oimodeler.oimBasicFourierComponents.oimQuadLDD(**kwargs)

Quadratic Limb Darkened Disk component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.
a1 (u.dimensionless_unscaled | oimInterp) – first quadratic limb darkening coefficient
a2 (u.dimensionless_unscaled | oimInterp) – second quadratic limb darkening coefficient
I(mu)/I(1) = 1 - a1(1-mu) - a2(1 - mu)**2

name = 'Quadratic Limb Darkened Disk '

shortname = 'QLDD'

_visFunction(xp, yp, rho, wl, t)

class oimodeler.oimBasicFourierComponents.oimPowerLawLDD(**kwargs)

Power Law Limb Darkened Disk component defined in the fourier space :Parameters: * x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.

y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.

f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.

d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.

a (u.dimensionless_unscaled | oimInterp) – power law limb darkening exponent

I(mu)/I(1) = mu**a

name = 'Power Law Limb Darkened Disk '

shortname = 'PLLDD'

_visFunction(xp, yp, rho, wl, t)

class oimodeler.oimBasicFourierComponents.oimSqrtLDD(**kwargs)

Square-root Limb Darkened Disk component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.
a1 (u.dimensionless_unscaled | oimInterp) – first square-root limb darkening coefficient
a2 (u.dimensionless_unscaled | oimInterp) – second square-root darkening coefficient
I(mu)/I(1) = 1 - a1 (1-mu) - a2 (1 - sqrt(mu))

name = 'square-root Limb Darkened Disk '

shortname = 'SLDD'

_visFunction(xp, yp, rho, wl, t)

class oimodeler.oimBasicFourierComponents.oim4CLDD(**kwargs)

4 Coefficients Limb Darkened Disk component defined in the fourier space

Parameters:

x (u.mas | oimInterp) – x pos of the component (in mas). The default is 0.
y (u.mas | oimInterp) – y pos of the component (in mas). The default is 0.
f (u.dimensionless_unscaled | oimInterp) – flux of the component. The default is 1.
d (u.mas | oimInterp) – diameter of the ring (in mas). The default is 0.
a1 (u.dimensionless_unscaled | oimInterp) – first 4 Coefficients limb darkening coefficient
a2 (u.dimensionless_unscaled | oimInterp) – second 4 Coefficients limb darkening coefficient
a3 (u.dimensionless_unscaled | oimInterp) – third 4 Coefficients limb darkening coefficient
a4 (u.dimensionless_unscaled | oimInterp) – forth 4 Coefficients limb darkening coefficient
I(mu)/I(1) = 1 - a1(1-mu**0.5) - a2(1 - mu) –
- a3(1 - mu**1.5) - a4(1 - mu**2)

name = '4 Coefficients Limb Darkened Disk '

shortname = '4CLDD'

_visFunction(xp, yp, rho, wl, t)

class oimodeler.oimBasicFourierComponents.oimConvolutor(component1: oimComponentFourier, component2: oimComponentFourier, **kwargs)

Convolves two components.

Parameters:

component1 (oimComponentFourier) – first fourier component of the convolution
component2 (oimComponentFourier) – first fourier component of the convolution

Variables:

components (list of oimComponentFourier) – The components that are to be convolved.
params (dict) – Dictionary with the convolutors parameters.

Warning

This component overloads the methods “getComplexCoherentFlux” and “getImage” and does not use “_visFunction” and “_imageFunction”, beware during usage.

name = 'Convolution Component'

shortname = 'Conv'

_visFunction(ucoord, vcoord, rho, wl, t)

getComplexCoherentFlux(ucoord, vcoord, wl=None, t=None)

Compute and return the complex coherent flux for an array of u,v (and optionally wavelength and time ) coordinates

Parameters:

u (list or numpy array) – spatial coordinate u (in cycles/rad)
v (list or numpy array) – spatial coordinate vu (in cycles/rad) .
wl (list or numpy array, optional) – wavelength(s) in meter. The default is None.
t (list or numpy array, optional) – time in s (mjd). The default is None.

Returns:

The complex coherent flux.

Return type:

A numpy array of the same size as u & v

_imageFunction(xx, yy, wl, t)

getImage(dim, pixSize, wl=None, t=None)

Compute and return an image or and image cube (if wavelength and time are given).

The returned image as the x,y dimension dim in pixel with an angular pixel size pixSize in rad. Image is returned as a numpy array unless the keyword fits is set to True. In that case the image is returned as an astropy.io.fits hdu

Parameters:

dim (integer) – image x & y dimension in pixels
pixSize (float) – pixel angular size in rad
wl (integer, list or numpy array, optional) – wavelength(s) in meter. The default is None
t (integer, list or numpy array, optional) – time in s (mjd). The default is None
fits (bool, optional) – if True returns result as a fits hdu. The default is False

Returns:

a numpy 2D array (or 3 or 4D array if wl, t or both are given) or an
astropy.io.fits hdu. image hdu if fits=True. – The image of the component with given size in pixels and rad