A Bayesian Spectral Line Modeling Framework for Astrophysics
Project description
bayes_spec
A Bayesian Spectral Line Modeling Framework for Astrophysics
bayes_spec
is a framework for user-defined, cloud-based models of astrophysical systems (e.g., the interstellar medium) that enables spectral line simulation and statistical inference. Built in the pymc
probabilistic programming library, bayes_spec
uses Monte Carlo Markov Chain techniques to fit user-defined models to data. The user-defined models can be a simple line profile (e.g., a Gaussian profile) or a complicated physical model. The models are "cloud-based", meaning there can be multiple "clouds" or "components" each with a unique set of the model parameters. bayes_spec
includes algorithms to estimate the optimal number of components in a given dataset.
Read below to get started, and check out the tutorials here: https://bayes-spec.readthedocs.io.
- Installation
- Usage
- Algorithms
- Models
- Syntax & Examples
- Issues and Contributing
- License and Copyright
Installation
Basic Installation
Install with pip:
pip install bayes_spec
Development Installation
Alternatively, download and unpack the latest release, or fork the repository and contribute to the development of bayes_spec
!
Install in a conda
virtual environment:
cd /path/to/bayes_spec
conda env create -f environment.yml
# or, if you would like to use CUDA (nvidia GPU) samplers:
# conda env create -f environment-cuda.yml
conda activate bayes_spec-dev
pip install -e .
Usage
bayes_spec
assumes that the source of spectral line emission can be decomposed into a series of "clouds" or "components", each of which are defined by a unique set of model parameters. For a simple line profile model (like a Gaussian profile), these parameters might be the Gaussian amplitude, center velocity, and line width. For a more complicated model, they might be the optical depth, excitation temperature, and velocity of the cloud. bayes_spec
also supports hyper-parameters: parameters that influence both non-cloud based features in the data (e.g., spectral baseline structure) as well as overall cloud properties (e.g., a property assumed shared among all clouds) or physical relationships (e.g., an empirical scaling law).
Users are responsible for defining and testing their models. Here we briefly describe how to do this, but see Syntax & Examples for some practical demonstrations.
Users must specify the following:
- The data
- Model parameters and hyper-parameters
- The parameter and hyper-parameter prior distributions
- Derived quantities (called "deterministics") that should be saved (e.g., for inference)
- The relationship between the model parameters and spectral observations (i.e., the likelihood)
Data Format
Data must be packaged within a bayes_spec.SpecData
object. SpecData
takes three arguments: the spectral axis (i.e., frequency, velocity), the brightness data (e.g., brightness temperature, flux density), and the noise (in the same units as the brightness data). The noise can either be a scalar value, in which case it is assumed constant across the spectrum, or an array of the same length as the brightness_data.
from bayes_spec import SpecData
spec = SpecData(spectral_axis, brightness_data, noise, xlabel="Velocity", ylabel="Brightness Temperature")
The spectral and brightness data are accessed via spec.spectral
and spec.brightness
, respectively. The noise is accessed via spec.noise
.
The data are passed to a bayes_spec
model in a dictionary, which allows multiple spectra to be included in a single model. For example, if a model is constrained by both an emission-line spectrum and an absorption-line spectrum, then this dictionary might look something like this:
emission = SpecData(emission_spec_axis, emission_data, emission_noise, xlabel="Velocity", ylabel="Brightness Temperature")
absorption = SpecData(absorption_spec_axis, absorption_data, absorption_noise, xlabel="Velocity", ylabel="Optical Depth")
data = {"emission": emission, "absorption": absorption}
The keys of this data dictionary ("emission"
and "absorption"
in this case) are important, you must remember them and use the same keys in your model definition.
Internally, SpecData
normalizes both the spectral axis and the data. Generally, this is only relevant for the polynomial baseline model, which is fit to the normalized data.
Model Specification
Model specification is made though a class that extends the bayes_spec.BaseModel
base model class definition. This class must include three methods: __init__
, which initializes the model, and add_priors
, which adds the priors to the model, and add_likelihood
, which adds the likelihood to the model. These priors and likelihood are specified following the usual pymc
syntax. See the definition of GaussLine
for an example. Alternatively, the class can extend an existing bayes_spec
model, which is convenient for similar models with, for example, added complexity. See the definition of GaussLineNoise
, which extends GaussLine
.
Algorithms
Posterior Sampling: Variational Inference
bayes_spec
can sample from an approximation of model posterior distribution using variational inference (VI). The benefit of VI is that it is fast, but the downside is that it often fails to capture complex posterior topologies. We recommend only using VI for quick model tests or MCMC initialization. Draw posterior samples using VI via model.fit()
.
Posterior Sampling: MCMC
bayes_spec
can also use MCMC to sample the posterior distribution. MCMC sampling tends to be much slower but also more accurate. Draw posterior samples using MCMC via model.sample()
. Since bayes_spec
uses pymc
for sampling, several pymc
samplers are available, including GPU samplers (see "other samplers" example notebook).
Posterior Sampling: SMC
Finally, bayes_spec
implements Sequential Monte Carlo (SMC) sampling via model.sample_smc()
. SMC can significantly improve performance for degenerate models with multi-modal posterior distributions, although it struggles with high dimensional models and models that suffer from a strong labeling degeneracy (see "other samplers" example notebook).
Posterior Clustering: Gaussian Mixture Models
Assuming that we have drawn posterior samples via MCMC or SMC using multiple independent Markov chains, then it is possible that each chain disagrees on the order of clouds. This is known as the labeling degeneracy. For some models (e.g., optically thin radiative transfer), the order of clouds along the line-of-sight is arbitrary so each chain may converge to a different label order.
It is also possible that the model solution is degenerate, the posterior distribution is strongly multi-modal, and each chain converges to different, unique solutions.
bayes_spec
uses Gaussian Mixture Models (GMMs) to break the labeling degeneracy and identify unique solutions. After sampling, execute model.solve()
to fit a GMM to the posterior samples of each chain individually. Unique solutions are identified by discrepant GMM fits, and we break the labeling degeneracy by adopting the most common cloud order amongst chains. The user defines which parameters are used for the GMM clustering.
Optimization
bayes_spec
can optimize the number of clouds in addition to the other model parameters. The Optimize
class will use VI, MCMC, and/or SMC to estimate the preferred number of clouds.
Models
bayes_spec
provides two basic models for convenience.
bayes_spec.models.GaussModel
GaussModel
is a Gaussian line profile model. The model assumes that the emission of each cloud is a Gaussian-shaped spectral line. The SpecData
key must be "observation"
. The following diagram demonstrates the relationship between the free parameters (empty ellipses), deterministic quantities (rectangles), model predictions (filled ellipses), and observations (filled, round rectangles). Many of the parameters are internally normalized (and thus have names like _norm
). The subsequent tables describe the model parameters in more detail.
Cloud Parametervariable |
Parameter | Units | Prior, where ($p_0, p_1, \dots$) = prior_{variable} |
Defaultprior_{variable} |
---|---|---|---|---|
line_area |
Integrated line area | K km s-1 |
$\int T_{B, \rm H} dV \sim {\rm Gamma}(\alpha=2.0, \beta=1.0/p)$ | 100.0 |
fwhm |
FWHM line width | km s-1 |
$\Delta V_{\rm H} \sim {\rm Gamma}(\alpha=3.0, \beta=2.0/p)$ | 20.0 |
velocity |
Center velocity | km s-1 |
$V_{\rm LSR, H} \sim {\rm Normal}(\mu=p_0, \sigma=p_1)$ | [0.0, 25.0] |
baseline_coeffs |
Normalized polynomial baseline coefficients | `` | $\beta_i \sim {\rm Normal}(\mu=0.0, \sigma=p_i)$ | [1.0]*baseline_degree |
bayes_spec.models.GaussNoiseModel
GaussNoiseModel
extends GaussModel
to add an additional free parameter: the spectral rms noise. The SpecData
key must be "observation"
.
Hyper Parametervariable |
Parameter | Units | Prior, where ($p_0, p_1, \dots$) = prior_{variable} |
Defaultprior_{variable} |
---|---|---|---|---|
rms |
Spectral rms noise | K |
${\rm rms} \sim {\rm HalfNormal}(\sigma=p)$ | 1.0 |
ordered_velocity
An additional parameter to set_priors
for these models is ordered_velocity
. By default, this parameter is False
, in which case the order of the clouds is from nearest to farthest. Sampling from these models can be challenging due to the labeling degeneracy: if the order of clouds does not matter (i.e., the emission is optically thin), then each Markov chain could decide on a different, equally-valid order of clouds.
If we assume that the emission is optically thin, then we can set ordered_velocity=True
, in which case the order of clouds is restricted to be increasing with velocity. This assumption can drastically improve sampling efficiency. When ordered_velocity=True
, the velocity
prior is defined differently:
Cloud Parametervariable |
Parameter | Units | Prior, where ($p_0, p_1, \dots$) = prior_{variable} |
Defaultprior_{variable} |
---|---|---|---|---|
velocity |
Center velocity | km s-1 |
$V_i \sim p_0 + \sum_0^{i-1} V_i + {\rm Gamma}(\alpha=2, \beta=1.0/p_1)$ | [0.0, 25.0] |
Syntax & Examples
See the various tutorial notebooks under docs/source/notebooks. Tutorials and the full API are available here: https://bayes-spec.readthedocs.io.
Issues and Contributing
Anyone is welcome to submit issues or contribute to the development of this software via Github.
License and Copyright
Copyright (c) 2024 Trey Wenger
GNU General Public License v3 (GNU GPLv3)
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file bayes_spec-1.5.0.tar.gz
.
File metadata
- Download URL: bayes_spec-1.5.0.tar.gz
- Upload date:
- Size: 64.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b3938d5dcd58b4ccd4546a32de4cda0e1318f3b768d572b6665fd8c7d2b2a3c |
|
MD5 | 350bd9ef1e69728ed543869f4585a6f4 |
|
BLAKE2b-256 | f2b9e3ec41a548d17a6950264d7ac64274ebaa23ad1f31d67fe2a82936a266a9 |
File details
Details for the file bayes_spec-1.5.0-py3-none-any.whl
.
File metadata
- Download URL: bayes_spec-1.5.0-py3-none-any.whl
- Upload date:
- Size: 52.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 533eaf9307648b0b65c207ac44b10314219b65eb3d4a700aac625272e31fb541 |
|
MD5 | f7fd4627c2d323981693c3de63f2d948 |
|
BLAKE2b-256 | 864ff83eec49994d2a187b6aa284878b3e57f2d1c043ab07c2e45ce03eb459b2 |