ananke.ExtinctionDriver module#

Contains the ExtinctionDriver class definition

Please note that this module is private. The ExtinctionDriver class is available in the main ananke namespace - use that instead.

class ananke.ExtinctionDriver.ExtinctionDriver(ananke: Ananke, **kwargs: Dict[str, Any])[source]#

Bases: object

Proxy to the utilities for given extinction parameters.

__init__(ananke: Ananke, **kwargs: Dict[str, Any]) → None[source]#

Parameters:

ananke (Ananke object) – The Ananke object that utilizes this ExtinctionDriver object
q_dust (float) – Ratio of total neutral hydrogen column density to color excess or reddening N_H/E(B-V). Default to 2.5e+22
total_to_selective (float) – Optical total-to-selective extinction ratio between extinction and reddenning A_V/E(B-V). Default to 3.1
mw_model (str) – Optional, can be used to request a specific MW extinction model. The only available model is “Marshall2006”, future updates may expand model availability.
extinction_coeff (function [df –> dict(band: coefficient)]) – Use to specify a function that returns extinction coefficients per band from characterisitics of the extinguished star given in a dataframe format. The function must return the coefficients per band in a dictionary format with keys corresponding to the band names returned by Galaxia (use property galaxia_catalogue_mag_names of the Ananke object). By default, the class will query the chosen photometric system to check if it has a default function to use. If it doesn’t find one it will simply fill extinction with nan values.

property extinction_coeff: List[Callable[[DataFrame | DataFrame], Dict[str, ndarray[Any, dtype[_ScalarType_co]]]] | Dict[str, float]]#