kinms_fitter.warp_funcs

Module Contents

Classes

warp_funcs

Creates position angle/inclination warps as a function of radius.

class kinms_fitter.warp_funcs.warp_funcs

Creates position angle/inclination warps as a function of radius.

class linear(guesses, minimums, maximums, priors=None, precisions=None, fixed=None, labels_prefix='PA')

Creates a warp thats linear with radius (optionally: that also flattens after some radius).

guessesndarray of float

Initial guesses. Two or three elements [Gradient, Intercept, (optionally Cutoff_Radius)]. Units of deg/arcsec, deg, (arcsec).

minimumsndarray of float

Minimums for the given parameters.

maximumsndarray of float

Maximums for the given parameters.

priorsndarray of objects

Optional- Priors for the given parameters (see GAStimator priors).

precisionsndarray of float

Optional - Precision you want to reach for the given parameters. [Default = 10 percent of range]

fixed: ndarray of bool

Optional - Fix this parameter to the input value in guesses. [Default = All False]

__repr__()

Return repr(self).

__call__(x, args)

Returns the required warp profile.

xndarray of float

Input radial array in arcseconds

argsndarray of float

Input arguments to evalue the profile with

class flat(guesses, minimums, maximums, priors=None, precisions=None, fixed=None, labels=['PA'], units=['deg'])

No warp- inc/PA flat with radius.

guessesndarray of float

Initial guess. One element, units of degrees.

minimumsndarray of float

Minimums for the given parameters.

maximumsndarray of float

Maximums for the given parameters.

priorsndarray of objects

Optional- Priors for the given parameters (see GAStimator priors).

precisionsndarray of float

Optional - Precision you want to reach for the given parameters. [Default = 10 percent of range]

fixed: ndarray of bool

Optional - Fix this parameter to the input value in guesses. [Default = All False]

__repr__()

Return repr(self).

__call__(x, args)

Returns the required warp profile.

xndarray of float

Input radial array in arcseconds

argsndarray of float

Input arguments to evalue the profile with

class tilted_rings(bincentroids, guesses, minimums, maximums, priors=None, precisions=None, fixed=None, labels_prefix='PA')

Arbitary warp using the tilted ring formalism.

bincentroids: ndarray of float

Radii at which to constrain the profile. Linearly interpolated between these points.

guessesndarray of float

Initial guesses. Size of bincentroids, units of degrees.

minimumsndarray of float

Minimums for the given parameters.

maximumsndarray of float

Maximums for the given parameters.

priorsndarray of objects

Optional- Priors for the given parameters (see GAStimator priors).

precisionsndarray of float

Optional - Precision you want to reach for the given parameters. [Default = 10 percent of range]

fixed: ndarray of bool

Optional - Fix this parameter to the input value in guesses. [Default = All False]

__repr__()

Return repr(self).

__call__(x, args, **kwargs)

Returns the required warp profile.

xndarray of float

Input radial array in arcseconds

argsndarray of float

Input arguments to evalue the profile with

eval(r, params)

Evaluates a list of warp functions.

modellistlist of objects

List of warp_funcs objects, or objects that have the same methods/inputs.

r: ndarray of floats

Radius array, units of arcseconds.

params: ndarray of floats

Parameters to use in each model in the list.

outndarray of floats

Output combined warp profile.