likelihood_polarization_fraction Class Reference

Defines a class that constructs a fractional polarization likelihood object. More...

#include "likelihood/likelihood_polarization_fraction.h"

Inheritance diagram for likelihood_polarization_fraction:

Collaboration diagram for likelihood_polarization_fraction:

Public Member Functions
	likelihood_polarization_fraction (data_polarization_fraction &data, model_polarization_fraction &model)
virtual double	operator() (std::vector< double > &x)
	Returns the log-likelihood of a vector of parameters \( \mathbf{x} \).
virtual double	chi_squared (std::vector< double > &x)
	Returns the \( \chi^2 \) of a vector of parameters \( \mathbf{x} \).
virtual void	set_mpi_communicator (MPI_Comm comm)
	Defines a set of processors provided to the model for parallel computation via an MPI communicator. Only facilates code parallelization if the model computation is parallelized via MPI.
Public Member Functions inherited from likelihood_base
virtual std::vector< double >	gradient (std::vector< double > &x, prior &Pr)
void	output_model_data_comparison (std::ostream &out)
void	output_model_data_comparison (std::string filename)

Protected Member Functions
virtual void	output (std::ostream &out)

Private Attributes
data_polarization_fraction &	_data
model_polarization_fraction &	_model

Additional Inherited Members
Protected Attributes inherited from likelihood_base
MPI_Comm	_comm

Detailed Description

This class takes a fractional polarization data object and a fractional polarization model object, and then returns the log likelihood. by direct comparison to the observational data assuming that the measured fractional polarizations has Gaussian Quotient errors with equal errors [see THEMIS code paper].

This class also includes an utility function for computing the \( \chi^2 \) to assess fitquality

Member Function Documentation

void output ( std::ostream &  out )

protectedvirtual

Outputs the data and model, as modified by the likelihood appropriately, to the specified output stream. Useful for comparison later.

Reimplemented from likelihood_base.

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• likelihood/likelihood_polarization_fraction.h
• likelihood/likelihood_polarization_fraction.cpp