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:

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

typedef std::map<ParamBaseCRef, std::vector<double> > lsst::gauss2d::fit::PriorEvaluation::Jacobians

Definition at line 18 of file prior.h.

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.

        : loglike(loglike_), residuals(residuals_), jacobians(jacobians_) {
    const auto n_resid = residuals.size();
    if (!((n_resid > 0) || (jacobians.size() == 0))) {
        throw std::invalid_argument("residuals cannot be empty unless jacobians are too");
    }
    if (check_size) {
        for (const auto& [paramref, values] : jacobians) {
            if (values.size() != n_resid) {
                throw std::invalid_argument(paramref.get().str()
                                            + " jacobian size=" + std::to_string(values.size())
                                            + " != n_resid=" + std::to_string(n_resid));
            }
        }
    } else {
    }
}

~PriorEvaluation()

lsst::gauss2d::fit::PriorEvaluation::~PriorEvaluation

(

)

Definition at line 65 of file prior.cc.

{};

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.

                                                                                          {
    double dll_dx = 0;
    auto jacobian = this->jacobians.find(param);
    if (jacobian != this->jacobians.end()) {
        // jacobian is dresidual/dx
        // loglike is -residual^2/2
        // dloglike/dx = -residual*dresidual/dx
        const auto& jacobian_values = (*jacobian).second;
        for (size_t idx = 0; idx < jacobian_values.size(); ++idx) {
            dll_dx -= jacobian_values[idx] * residuals.at(idx);
        }
    }
    if (!transformed) dll_dx /= param.get_transform_derivative();
    return dll_dx;
}

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.

                                                                              {
        return namespace_separator == CC_NAMESPACE_SEPARATOR ? "nullptr" : NULL_STR_GENERAL;
    }

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_keywords	Whether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separator	The 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.

                                                                                            {
    return type_name_str<PriorEvaluation>(false, namespace_separator) + "("
           + (name_keywords ? "loglike=" : "") + to_string_float(loglike) + ", "
           + (name_keywords ? "residuals=" : "") + to_string_float_iter(residuals) + ", "
           + (name_keywords ? "jacobians=" : "") + str_jacobians(jacobians) + ")";
}

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.

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

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/gauss2d_fit/g199a45376c+5137f08352/include/lsst/gauss2d/fit/prior.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/gauss2d_fit/g199a45376c+5137f08352/src/prior.cc