lsst.gauss2d.fit g199a45376c+5e234f8357
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst::gauss2d::fit::GaussianPrior Class Reference

#include <gaussianprior.h>

Inheritance diagram for lsst::gauss2d::fit::GaussianPrior:
lsst::gauss2d::fit::Prior

Public Member Functions

 GaussianPrior (std::shared_ptr< const ParamBase > param, double mean, double stddev, bool transformed)
 
PriorEvaluation evaluate (bool calc_jacobians=false, bool normalize_loglike=false) const override
 
const ParamBase & get_param () const
 
std::vector< double > get_loglike_const_terms () const override
 Return the constant terms of the log likelihood (dependent on stddevs only)
 
double get_mean () const
 
double get_stddev () const
 
bool get_transformed () const
 
void set_mean (double mean)
 
void set_stddev (double stddev)
 
void set_transformed (bool transformed)
 
size_t size () const override
 
std::string repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
 
std::string str () const override
 

Detailed Description

A 1D Gaussian prior for a single Parameter.

Constructor & Destructor Documentation

◆ GaussianPrior()

lsst::gauss2d::fit::GaussianPrior::GaussianPrior ( std::shared_ptr< const ParamBase > param,
double mean,
double stddev,
bool transformed )
explicit

Construct a GaussianPrior from a Parameter and mean/std. deviation.

Parameters
paramThe ParamBase to compute a prior for.
meanThe mean value of the prior.
stddevThe standard deviation of the prior.
transformedWhether the prior is based on the transformed value of param.

Member Function Documentation

◆ evaluate()

PriorEvaluation lsst::gauss2d::fit::GaussianPrior::evaluate ( bool calc_jacobians = false,
bool normalize_loglike = false ) const
overridevirtual

Evaluate the log likelihood and residual-dependent terms.

Parameters
calc_jacobiansWhether to compute the Jacobian and residual terms.
normalize_loglikeWhether to add the constant (sigma-dependent) factors to the log likehood.
Returns
The result of the evaluation.

Implements lsst::gauss2d::fit::Prior.

◆ get_loglike_const_terms()

std::vector< double > lsst::gauss2d::fit::GaussianPrior::get_loglike_const_terms ( ) const
overridevirtual

Return the constant terms of the log likelihood (dependent on stddevs only)

Implements lsst::gauss2d::fit::Prior.

◆ size()

size_t lsst::gauss2d::fit::GaussianPrior::size ( ) const
overridevirtual

Implements lsst::gauss2d::fit::Prior.

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