OpticalDepth1D

class spectacle.modeling.OpticalDepth1D(name=None, line_list=None, *args, **kwargs)

Bases: astropy.modeling.Fittable1DModel

Implements a Voigt profile astropy model. This model generates optical depth profiles for absorption features.

Parameters

lambda_0float

Central wavelength in Angstroms.

f_valuefloat

Absorption line oscillator strength.

gammafloat

Absorption line gamma value.

v_dopplerfloat

Doppler b-parameter in km/s.

column_densityfloat

Column density in cm^-2.

delta_vfloat

Velocity offset from lambda_0 in km/s. Default: None (no shift).

delta_lambdafloat

Wavelength offset in Angstrom. Default: None (no shift).

lambda_binsarray-like

Wavelength array for line deposition in Angstroms. If None, one will created using n_lambda and dlambda. Default: None.

n_lambdaint

Size of lambda bins to create if lambda_bins is None. Default: 12000.

dlambdafloat

Lambda bin width in Angstroms if lambda_bins is None. Default: 0.01.

Returns

tau_phiarray-like

An array of optical depth values.

Attributes Summary

column_density
delta_lambda
delta_v
f_value
gamma
input_units	This property is used to indicate what units or sets of units the evaluate method expects, and returns a dictionary mapping inputs to units (or None if any units are accepted).
inputs
lambda_0
outputs
param_names
v_doppler

Methods Summary

__call__(self, x[, model_set_axis, …])	Evaluate this model using the given input(s) and the parameter values that were specified when the model was instantiated.
evaluate(self, x, lambda_0, f_value, gamma, …)	Evaluate the model on some input variables.
fit_deriv(x, x_0, b, gamma, f)
full_width_half_max(self, x)
voigt(a, u)

Attributes Documentation

column_density

delta_lambda

delta_v

f_value

gamma

input_units

This property is used to indicate what units or sets of units the evaluate method expects, and returns a dictionary mapping inputs to units (or None if any units are accepted).

Model sub-classes can also use function annotations in evaluate to indicate valid input units, in which case this property should not be overridden since it will return the input units based on the annotations.

inputs = ('x',)

lambda_0

outputs = ('y',)

param_names = ('lambda_0', 'f_value', 'gamma', 'v_doppler', 'column_density', 'delta_v', 'delta_lambda')

v_doppler

Methods Documentation

__call__(self, x, model_set_axis=None, with_bounding_box=False, fill_value=nan, equivalencies=None)

Evaluate this model using the given input(s) and the parameter values that were specified when the model was instantiated.

evaluate(self, x, lambda_0, f_value, gamma, v_doppler, column_density, delta_v, delta_lambda)

Evaluate the model on some input variables.

static fit_deriv(x, x_0, b, gamma, f)

full_width_half_max(self, x)

static voigt(a, u)