lsst::gauss2d::fit::Parametric Class Reference

A parametric object that can return and filter its Parameter instances. More...

#include <parametric.h>

Inheritance diagram for lsst::gauss2d::fit::Parametric:

Public Member Functions
virtual ParamRefs &	get_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const =0
	Add Parameter refs matching the filter to a vector, in order.
virtual ParamCRefs &	get_parameters_const (ParamCRefs &params, ParamFilter *filter=nullptr) const =0
	Same as get_parameters(), but for const refs.
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.
virtual	~Parametric ()=default
virtual std::string	repr (bool name_keywords=false, std::string_view namespace_separator=CC_NAMESPACE_SEPARATOR) const =0
	Return a full, callable string representation of this.
virtual std::string	str () const =0
	Return a brief, human-readable string representation of this.

Static Public Member Functions
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 = "."

Detailed Description

A parametric object that can return and filter its Parameter instances.

Definition at line 13 of file parametric.h.

Constructor & Destructor Documentation

~Parametric()

virtual lsst::gauss2d::fit::Parametric::~Parametric ( )

virtualdefault

Member Function Documentation

get_parameters()

virtual ParamRefs & lsst::gauss2d::fit::Parametric::get_parameters ( ParamRefs & params, ParamFilter * filter = nullptr ) const

pure virtual

Add Parameter refs matching the filter to a vector, in order.

Parameters

params	The vector to add to.
filter	The filter to apply to this Object's parameters.

Returns

A ref to params (for method chaining)

Implemented in lsst::gauss2d::fit::CentroidParameters, lsst::gauss2d::fit::Data< T, I, M >, lsst::gauss2d::fit::EllipticalComponent, lsst::gauss2d::fit::FractionalIntegralModel, lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::GaussianParametricEllipse, lsst::gauss2d::fit::LinearIntegralModel, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::Observation< T, I, M >, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicMixComponent, lsst::gauss2d::fit::SersicParametricEllipse, lsst::gauss2d::fit::Source, and lsst::gauss2d::fit::SersicModelIntegral.

get_parameters_const()

virtual ParamCRefs & lsst::gauss2d::fit::Parametric::get_parameters_const ( ParamCRefs & params, ParamFilter * filter = nullptr ) const

pure virtual

Same as get_parameters(), but for const refs.

Implemented in lsst::gauss2d::fit::CentroidParameters, lsst::gauss2d::fit::Data< T, I, M >, lsst::gauss2d::fit::EllipticalComponent, lsst::gauss2d::fit::FractionalIntegralModel, lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::GaussianParametricEllipse, lsst::gauss2d::fit::LinearIntegralModel, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::Observation< T, I, M >, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicMixComponent, lsst::gauss2d::fit::SersicParametricEllipse, lsst::gauss2d::fit::Source, and lsst::gauss2d::fit::SersicModelIntegral.

get_parameters_const_new()

ParamCRefs lsst::gauss2d::fit::Parametric::get_parameters_const_new ( ParamFilter * filter = nullptr ) const

inline

Same as get_parameters_const(), but returning a new vector.

Definition at line 33 of file parametric.h.

                                                                             {
        ParamCRefs params{};
        get_parameters_const(params, filter);
        return params;
    }

get_parameters_new()

ParamRefs lsst::gauss2d::fit::Parametric::get_parameters_new ( ParamFilter * filter = nullptr ) const

inline

Same as get_parameters(), but returning a new vector.

Definition at line 27 of file parametric.h.

                                                                      {
        ParamRefs params{};
        get_parameters(params, filter);
        return params;
    }

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()

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

pure virtualinherited

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.

Implemented in lsst::gauss2d::CentroidValues, lsst::gauss2d::Image< idx_type, Indices >, lsst::gauss2d::Image< t, Data >, lsst::gauss2d::Image< T, Image< T > >, lsst::gauss2d::Image< T, VectorImage< T > >, lsst::gauss2d::Image< T, C >, lsst::gauss2d::ImageArray< t, Data >, lsst::gauss2d::ImageArray< T, Data >, lsst::gauss2d::ImageArray< T, C >, lsst::gauss2d::fit::SersicEllipseData, lsst::gauss2d::fit::SersicModelIntegral, lsst::gauss2d::Centroid, lsst::gauss2d::CoordinateSystem, lsst::gauss2d::Covariance, lsst::gauss2d::EllipseValues, lsst::gauss2d::Ellipse, lsst::gauss2d::EllipseMajor, lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >, lsst::gauss2d::GaussianEvaluator< T, Data, Indices >, lsst::gauss2d::GaussianIntegralValue, lsst::gauss2d::Gaussian, lsst::gauss2d::Gaussians, lsst::gauss2d::ConvolvedGaussian, lsst::gauss2d::ConvolvedGaussians, lsst::gauss2d::fit::CentroidParameters, lsst::gauss2d::fit::Channel, lsst::gauss2d::fit::Data< T, I, M >, lsst::gauss2d::fit::EllipticalComponent, lsst::gauss2d::fit::FractionalIntegralModel, lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::GaussianModelIntegral, lsst::gauss2d::fit::GaussianParametricEllipse, lsst::gauss2d::fit::GaussianPrior, lsst::gauss2d::fit::LinearIntegralModel, lsst::gauss2d::fit::LinearSersicMixInterpolator, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::Observation< T, I, M >, lsst::gauss2d::fit::ParametricGaussian1D, lsst::gauss2d::fit::PriorEvaluation, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::IntegralSize, lsst::gauss2d::fit::SersicMixValues, lsst::gauss2d::fit::SersicMixComponent, lsst::gauss2d::fit::SersicParametricEllipse, lsst::gauss2d::fit::ShapePriorOptions, lsst::gauss2d::fit::ShapePrior, lsst::gauss2d::fit::Source, lsst::gauss2d::CentroidData, lsst::gauss2d::EllipseData, and lsst::gauss2d::GaussianIntegral.

str()

virtual std::string lsst::gauss2d::Object::str ( ) const

pure virtualinherited

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

Implemented in lsst::gauss2d::CentroidValues, lsst::gauss2d::Centroid, lsst::gauss2d::CoordinateSystem, lsst::gauss2d::Covariance, lsst::gauss2d::EllipseValues, lsst::gauss2d::Ellipse, lsst::gauss2d::EllipseMajor, lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >, lsst::gauss2d::GaussianEvaluator< T, Data, Indices >, lsst::gauss2d::GaussianIntegralValue, lsst::gauss2d::Gaussian, lsst::gauss2d::Gaussians, lsst::gauss2d::ConvolvedGaussian, lsst::gauss2d::ConvolvedGaussians, lsst::gauss2d::Image< idx_type, Indices >, lsst::gauss2d::Image< t, Data >, lsst::gauss2d::Image< T, Image< T > >, lsst::gauss2d::Image< T, VectorImage< T > >, lsst::gauss2d::Image< T, C >, lsst::gauss2d::ImageArray< t, Data >, lsst::gauss2d::ImageArray< T, Data >, lsst::gauss2d::ImageArray< T, C >, lsst::gauss2d::fit::CentroidParameters, lsst::gauss2d::fit::Channel, lsst::gauss2d::fit::Data< T, I, M >, lsst::gauss2d::fit::EllipticalComponent, lsst::gauss2d::fit::FractionalIntegralModel, lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::GaussianModelIntegral, lsst::gauss2d::fit::GaussianParametricEllipse, lsst::gauss2d::fit::GaussianPrior, lsst::gauss2d::fit::LinearIntegralModel, lsst::gauss2d::fit::LinearSersicMixInterpolator, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::Observation< T, I, M >, lsst::gauss2d::fit::ParametricGaussian1D, lsst::gauss2d::fit::PriorEvaluation, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::IntegralSize, lsst::gauss2d::fit::SersicMixValues, lsst::gauss2d::fit::SersicMixComponent, lsst::gauss2d::fit::SersicParametricEllipse, lsst::gauss2d::fit::ShapePriorOptions, lsst::gauss2d::fit::ShapePrior, lsst::gauss2d::fit::Source, lsst::gauss2d::fit::SersicEllipseData, lsst::gauss2d::fit::SersicModelIntegral, lsst::gauss2d::CentroidData, lsst::gauss2d::EllipseData, and lsst::gauss2d::GaussianIntegral.

Member Data Documentation

CC_NAMESPACE_SEPARATOR

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

staticconstexprinherited

The C++ namespace separator.

Definition at line 45 of file object.h.

NULL_STR_GENERAL

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

staticconstexprinherited

Definition at line 46 of file object.h.

PY_NAMESPACE_SEPARATOR

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

staticconstexprinherited

Definition at line 47 of file object.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d_fit/gb58c049af0+d64f4d3760/include/lsst/gauss2d/fit/parametric.h