LSST Applications g013ef56533+b8d55c8942,g083dd6704c+a047e97985,g199a45376c+0ba108daf9,g1fd858c14a+7a3b874d60,g210f2d0738+7416ca6900,g262e1987ae+1d557ba9a3,g29ae962dfc+519d34895e,g2cef7863aa+aef1011c0b,g30d7c61c20+36d16ea71a,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+cb326ad149,g47891489e3+f459a6810c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+890c8e1e5d,g5a60e81ecd+6240c63dbc,g64539dfbff+7416ca6900,g67b6fd64d1+f459a6810c,g6ebf1fc0d4+8c5ae1fdc5,g74acd417e5+0bae3c876a,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+f459a6810c,g8d7436a09f+dee7680868,g8ea07a8fe4+81eaaadc04,g90f42f885a+34c0557caf,g97be763408+14b8164b5b,g98a1a72a9c+8389601a76,g98df359435+fff771c62d,gb8cb2b794d+6728931916,gbf99507273+8c5ae1fdc5,gc2a301910b+7416ca6900,gca7fc764a6+f459a6810c,gd7ef33dd92+f459a6810c,gdab6d2f7ff+0bae3c876a,ge410e46f29+f459a6810c,ge41e95a9f2+7416ca6900,geaed405ab2+e3b4b2a692,gf9a733ac38+8c5ae1fdc5,w.2025.43
LSST Data Management Base Package
Loading...
Searching...
No Matches
lsst::gauss2d::fit::PriorEvaluation Class Reference

Results from the evaluation of a prior probability function. More...

#include <prior.h>

Inheritance diagram for lsst::gauss2d::fit::PriorEvaluation:
lsst::gauss2d::Object

Public Types

typedef std::map< ParamBaseCRef, std::vector< double > > Jacobians
 

Public Member Functions

double compute_dloglike_dx (const ParamBase &param, bool transformed=true) const
 
std::string repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
 Return a full, callable string representation of this.
 
std::string str () const override
 Return a brief, human-readable string representation of this.
 
 PriorEvaluation (double loglike, std::vector< double > residuals={}, Jacobians jacobians={}, bool check_size=true)
 
 ~PriorEvaluation ()
 

Static Public Member Functions

static std::string_view null_str (const std::string_view &namespace_separator)
 

Public Attributes

double loglike
 
std::vector< double > residuals
 
Jacobians jacobians
 

Static Public Attributes

static constexpr std::string_view CC_NAMESPACE_SEPARATOR = "::"
 The C++ namespace separator.
 
static constexpr std::string_view NULL_STR_GENERAL = "None"
 
static constexpr std::string_view PY_NAMESPACE_SEPARATOR = "."
 

Detailed Description

Results from the evaluation of a prior probability function.

Definition at line 16 of file prior.h.

Member Typedef Documentation

◆ Jacobians

Constructor & Destructor Documentation

◆ PriorEvaluation()

lsst::gauss2d::fit::PriorEvaluation::PriorEvaluation ( double loglike,
std::vector< double > residuals = {},
PriorEvaluation::Jacobians jacobians_ = {},
bool check_size = true )

Definition at line 46 of file prior.cc.

48 : loglike(loglike_), residuals(residuals_), jacobians(jacobians_) {
49 const auto n_resid = residuals.size();
50 if (!((n_resid > 0) || (jacobians.size() == 0))) {
51 throw std::invalid_argument("residuals cannot be empty unless jacobians are too");
52 }
53 if (check_size) {
54 for (const auto& [paramref, values] : jacobians) {
55 if (values.size() != n_resid) {
56 throw std::invalid_argument(paramref.get().str()
57 + " jacobian size=" + std::to_string(values.size())
58 + " != n_resid=" + std::to_string(n_resid));
59 }
60 }
61 } else {
62 }
63}
std::vector< double > residuals
Definition prior.h:21
T to_string(T... args)

◆ ~PriorEvaluation()

lsst::gauss2d::fit::PriorEvaluation::~PriorEvaluation ( )

Definition at line 65 of file prior.cc.

65{};

Member Function Documentation

◆ compute_dloglike_dx()

double lsst::gauss2d::fit::PriorEvaluation::compute_dloglike_dx ( const ParamBase & param,
bool transformed = true ) const

Definition at line 67 of file prior.cc.

67 {
68 double dll_dx = 0;
69 auto jacobian = this->jacobians.find(param);
70 if (jacobian != this->jacobians.end()) {
71 // jacobian is dresidual/dx
72 // loglike is -residual^2/2
73 // dloglike/dx = -residual*dresidual/dx
74 const auto& jacobian_values = (*jacobian).second;
75 for (size_t idx = 0; idx < jacobian_values.size(); ++idx) {
76 dll_dx -= jacobian_values[idx] * residuals.at(idx);
77 }
78 }
79 if (!transformed) dll_dx /= param.get_transform_derivative();
80 return dll_dx;
81}
@ jacobian
Compute the model Jacobian.
Definition model.h:37

◆ null_str()

static std::string_view lsst::gauss2d::Object::null_str ( const std::string_view & namespace_separator)
inlinestaticinherited

Definition at line 49 of file object.h.

49 {
50 return namespace_separator == CC_NAMESPACE_SEPARATOR ? "nullptr" : NULL_STR_GENERAL;
51 }
static constexpr std::string_view CC_NAMESPACE_SEPARATOR
The C++ namespace separator.
Definition object.h:45
static constexpr std::string_view NULL_STR_GENERAL
Definition object.h:46

◆ repr()

std::string lsst::gauss2d::fit::PriorEvaluation::repr ( bool name_keywords = false,
std::string_view namespace_separator = Object::CC_NAMESPACE_SEPARATOR ) const
overridevirtual

Return a full, callable string representation of this.

Parameters
name_keywordsWhether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separatorThe string to use to delimit namespaces, i.e. :: in C++ and . in Python.
Returns
A callable string representation of this, which should return an an identical object to this.
Note
The representation with name_keywords=false must be callable in C++. The representation with name_keywords=true should be callable in Python, if there are any bindings.

Implements lsst::gauss2d::Object.

Definition at line 83 of file prior.cc.

83 {
84 return type_name_str<PriorEvaluation>(false, namespace_separator) + "("
85 + (name_keywords ? "loglike=" : "") + to_string_float(loglike) + ", "
86 + (name_keywords ? "residuals=" : "") + to_string_float_iter(residuals) + ", "
87 + (name_keywords ? "jacobians=" : "") + str_jacobians(jacobians) + ")";
88}
std::string str_jacobians(const std::map< ParamBaseCRef, std::vector< double > > &jacobians, bool python_style=true)
Definition prior.cc:35
std::string type_name_str(bool strip_namespace=false, std::string_view namespace_str=detail::NAMESPACE_SEPARATOR)
Get a string representation of an arbitrary C++ type, potentially modifying its namespace prefix.
Definition type_name.h:104
std::string to_string_float_iter(const Container< Value > &container, const int precision=6, const bool scientific=true)
Definition to_string.h:28
std::string to_string_float(const T value, const int precision=6, const bool scientific=true)
Definition to_string.h:15

◆ str()

std::string lsst::gauss2d::fit::PriorEvaluation::str ( ) const
overridevirtual

Return a brief, human-readable string representation of this.

Implements lsst::gauss2d::Object.

Definition at line 90 of file prior.cc.

90 {
91 return type_name_str<PriorEvaluation>(true) + "(loglike=" + to_string_float(loglike) + ", residuals="
92 + to_string_float_iter(residuals) + ", jacobians=" + str_jacobians(jacobians) + ")";
93}

Member Data Documentation

◆ CC_NAMESPACE_SEPARATOR

std::string_view lsst::gauss2d::Object::CC_NAMESPACE_SEPARATOR = "::"
staticconstexprinherited

The C++ namespace separator.

Definition at line 45 of file object.h.

◆ jacobians

Jacobians lsst::gauss2d::fit::PriorEvaluation::jacobians

Definition at line 22 of file prior.h.

◆ loglike

double lsst::gauss2d::fit::PriorEvaluation::loglike

Definition at line 20 of file prior.h.

◆ NULL_STR_GENERAL

std::string_view lsst::gauss2d::Object::NULL_STR_GENERAL = "None"
staticconstexprinherited

Definition at line 46 of file object.h.

◆ PY_NAMESPACE_SEPARATOR

std::string_view lsst::gauss2d::Object::PY_NAMESPACE_SEPARATOR = "."
staticconstexprinherited

Definition at line 47 of file object.h.

◆ residuals

std::vector<double> lsst::gauss2d::fit::PriorEvaluation::residuals

Definition at line 21 of file prior.h.


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