lsst.gauss2d.fit g199a45376c+3b7b3fd841
 
Loading...
Searching...
No Matches
lsst::gauss2d::fit::ShapePrior Class Reference

#include <shapeprior.h>

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

Public Member Functions

 ShapePrior (std::shared_ptr< const ParametricEllipse > ellipse, std::shared_ptr< ParametricGaussian1D > prior_size=nullptr, std::shared_ptr< ParametricGaussian1D > prior_axrat=nullptr, std::shared_ptr< ShapePriorOptions > options=nullptr)
 
PriorEvaluation evaluate (bool calc_jacobians=false, bool normalize_loglike=false) const override
 
std::shared_ptr< ParametricGaussian1Dget_prior_size () const
 
std::shared_ptr< ParametricGaussian1Dget_prior_axrat () const
 
std::vector< double > get_loglike_const_terms () const override
 Return the constant terms of the log likelihood (dependent on stddevs only)
 
void set_prior_size (std::shared_ptr< ParametricGaussian1D > prior_size)
 
void set_prior_axrat (std::shared_ptr< ParametricGaussian1D > prior_axrat)
 
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 two-part prior on the shape of a parametric ellipse.

Note
The size and axis ratio priors are separate and optional.
The size prior applies to the major-axis size.

Constructor & Destructor Documentation

◆ ShapePrior()

lsst::gauss2d::fit::ShapePrior::ShapePrior ( std::shared_ptr< const ParametricEllipse > ellipse,
std::shared_ptr< ParametricGaussian1D > prior_size = nullptr,
std::shared_ptr< ParametricGaussian1D > prior_axrat = nullptr,
std::shared_ptr< ShapePriorOptions > options = nullptr )
explicit

Construct a ShapePrior from a Parameter and mean_size/std. deviation.

Parameters
ellipseThe ParametricEllipse to compute a prior for.
mean_sizeThe mean value of the size prior.
stddev_sizeThe standard deviation of the size prior.

Member Function Documentation

◆ evaluate()

PriorEvaluation lsst::gauss2d::fit::ShapePrior::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::ShapePrior::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::ShapePrior::size ( ) const
overridevirtual

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