LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
|
An IntegralModel that returns a Parameter-dependent fraction of the flux of another IntegralModel. More...
#include <fractionalintegralmodel.h>
Classes | |
struct | Shared_enabler |
Public Types | |
typedef std::pair< std::reference_wrapper< const Channel >, std::shared_ptr< ProperFractionParameterD > > | ChannelIntegralParameterD |
typedef std::vector< ChannelIntegralParameterD > | Data |
Public Member Functions | |
FractionalIntegralModel (const FractionalIntegralModel &)=delete | |
FractionalIntegralModel & | operator= (const FractionalIntegralModel &)=delete |
~FractionalIntegralModel () | |
std::shared_ptr< ProperFractionParameterD > | at (const Channel &channel) |
std::shared_ptr< const ProperFractionParameterD > | at (const Channel &channel) const |
Data::iterator | begin () noexcept |
Data::const_iterator | cbegin () const noexcept |
Data::iterator | end () noexcept |
Data::const_iterator | cend () const noexcept |
std::vector< std::reference_wrapper< const Channel > > | get_channels () const override |
Get the set of channels this instance is applicable for. | |
const IntegralModel & | get_parent_model () const |
double | get_integral (const Channel &channel) const override |
Get the value of the integral in a single Channel. | |
std::vector< std::pair< ParamBaseCRef, ExtraParamFactorValues > > | get_integral_derivative_factors (const Channel &channel) const override |
Return the partial derivative of the model w.r.t. | |
double | get_integral_remainder (const Channel &channel) const |
ProperFractionParameterD & | get_parameter_frac (const Channel &channel) const |
ParamRefs & | get_parameters (ParamRefs ¶ms, ParamFilter *filter=nullptr) const override |
Add Parameter refs matching the filter to a vector, in order. | |
ParamCRefs & | get_parameters_const (ParamCRefs ¶ms, ParamFilter *filter=nullptr) const override |
Same as get_parameters(), but for const refs. | |
bool | is_final () const |
size_t | size () 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. | |
ParamRefs | get_parameters_new (ParamFilter *filter=nullptr) const |
Same as get_parameters(), but returning a new vector. | |
ParamCRefs | get_parameters_const_new (ParamFilter *filter=nullptr) const |
Same as get_parameters_const(), but returning a new vector. | |
Static Public Member Functions | |
static std::shared_ptr< FractionalIntegralModel > | find_model (const IntegralModel &model) |
Find the FractionalIntegralModel that depends on a given IntegralModel, if any. | |
static std::shared_ptr< FractionalIntegralModel > | make (std::optional< const Data > data, std::shared_ptr< const IntegralModel > model, bool is_final=false) |
Construct a FractionalIntegralModel and add to registry. | |
static const std::shared_ptr< const FractionalIntegralModel > | make_const (std::optional< const Data > data, std::shared_ptr< const IntegralModel > model, bool is_final=false) |
static std::string_view | null_str (const std::string_view &namespace_separator) |
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 = "." |
An IntegralModel that returns a Parameter-dependent fraction of the flux of another IntegralModel.
FractionalIntegralModel instances can be chained but are registered to enforce having at most one dependent FractionalIntegralModel. Chains should end in a single fixed ProperFractionParameter of value 1; this is not yet fully enforced.
Definition at line 30 of file fractionalintegralmodel.h.
typedef std::pair<std::reference_wrapper<const Channel>, std::shared_ptr<ProperFractionParameterD> > lsst::gauss2d::fit::FractionalIntegralModel::ChannelIntegralParameterD |
Definition at line 33 of file fractionalintegralmodel.h.
Definition at line 34 of file fractionalintegralmodel.h.
|
explicitdelete |
lsst::gauss2d::fit::FractionalIntegralModel::~FractionalIntegralModel | ( | ) |
Definition at line 71 of file fractionalintegralmodel.cc.
std::shared_ptr< ProperFractionParameterD > lsst::gauss2d::fit::FractionalIntegralModel::at | ( | const Channel & | channel | ) |
Definition at line 73 of file fractionalintegralmodel.cc.
std::shared_ptr< const ProperFractionParameterD > lsst::gauss2d::fit::FractionalIntegralModel::at | ( | const Channel & | channel | ) | const |
Definition at line 76 of file fractionalintegralmodel.cc.
|
noexcept |
Definition at line 88 of file fractionalintegralmodel.cc.
|
noexcept |
Definition at line 91 of file fractionalintegralmodel.cc.
|
noexcept |
Definition at line 98 of file fractionalintegralmodel.cc.
|
noexcept |
Definition at line 95 of file fractionalintegralmodel.cc.
|
inlinestatic |
Find the FractionalIntegralModel that depends on a given IntegralModel, if any.
model | The IntegralModel to search for |
Definition at line 56 of file fractionalintegralmodel.h.
|
overridevirtual |
Get the set of channels this instance is applicable for.
Implements lsst::gauss2d::fit::Chromatic.
Definition at line 102 of file fractionalintegralmodel.cc.
|
overridevirtual |
Get the value of the integral in a single Channel.
Implements lsst::gauss2d::fit::IntegralModel.
Definition at line 115 of file fractionalintegralmodel.cc.
|
overridevirtual |
Return the partial derivative of the model w.r.t.
each metaparameter.
This is generally needed only for nonlinear Parameter instances.
channel | The Channel to return derivatives for. |
Implements lsst::gauss2d::fit::IntegralModel.
Definition at line 120 of file fractionalintegralmodel.cc.
double lsst::gauss2d::fit::FractionalIntegralModel::get_integral_remainder | ( | const Channel & | channel | ) | const |
Definition at line 164 of file fractionalintegralmodel.cc.
ProperFractionParameterD & lsst::gauss2d::fit::FractionalIntegralModel::get_parameter_frac | ( | const Channel & | channel | ) | const |
Definition at line 168 of file fractionalintegralmodel.cc.
|
overridevirtual |
Add Parameter refs matching the filter to a vector, in order.
params | The vector to add to. |
filter | The filter to apply to this Object's parameters. |
Implements lsst::gauss2d::fit::Parametric.
Definition at line 172 of file fractionalintegralmodel.cc.
|
overridevirtual |
Same as get_parameters(), but for const refs.
Implements lsst::gauss2d::fit::Parametric.
Definition at line 184 of file fractionalintegralmodel.cc.
|
inlineinherited |
Same as get_parameters_const(), but returning a new vector.
Definition at line 33 of file parametric.h.
|
inlineinherited |
Same as get_parameters(), but returning a new vector.
Definition at line 27 of file parametric.h.
const IntegralModel & lsst::gauss2d::fit::FractionalIntegralModel::get_parent_model | ( | ) | const |
Definition at line 108 of file fractionalintegralmodel.cc.
bool lsst::gauss2d::fit::FractionalIntegralModel::is_final | ( | ) | const |
Definition at line 195 of file fractionalintegralmodel.cc.
|
static |
Construct a FractionalIntegralModel and add to registry.
data | The map of ProperFractionParameter instances for each channel. |
model | The IntegralModel that ProperFractionParameter instances multiply by. |
is_final | Whether these fractions are the last in the chain. |
Definition at line 230 of file fractionalintegralmodel.cc.
|
static |
Definition at line 238 of file fractionalintegralmodel.cc.
|
inlinestaticinherited |
Definition at line 49 of file object.h.
|
delete |
|
overridevirtual |
Return a full, callable string representation of this.
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. |
Implements lsst::gauss2d::Object.
Definition at line 199 of file fractionalintegralmodel.cc.
size_t lsst::gauss2d::fit::FractionalIntegralModel::size | ( | ) | const |
Definition at line 197 of file fractionalintegralmodel.cc.
|
overridevirtual |
Return a brief, human-readable string representation of this.
Implements lsst::gauss2d::Object.
Definition at line 209 of file fractionalintegralmodel.cc.
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |