lsst::gauss2d::fit::CentroidParameters Class Reference

A Centroid with Parameters for x and y. More...

#include <centroidparameters.h>

Inheritance diagram for lsst::gauss2d::fit::CentroidParameters:

Public Member Functions
ParamRefs &	get_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const override
	Add Parameter refs matching the filter to a vector, in order.
ParamCRefs &	get_parameters_const (ParamCRefs &params, ParamFilter *filter=nullptr) const override
	Same as get_parameters(), but for const refs.
double	get_x () const override
	Get the x value.
double	get_y () const override
	Get the y value.
std::array< double, 2 >	get_xy () const override
	Get the x and y values.
CentroidXParameterD &	get_x_param () const
	Get a ref to the x param.
CentroidYParameterD &	get_y_param () const
	Get a ref to the y param.
std::shared_ptr< CentroidXParameterD >	get_x_param_ptr ()
std::shared_ptr< CentroidYParameterD >	get_y_param_ptr ()
void	set_x (double x) override
void	set_y (double y) override
void	set_xy (const std::array< double, 2 > &xy) override
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.
	CentroidParameters (std::shared_ptr< CentroidXParameterD > x=nullptr, std::shared_ptr< CentroidYParameterD > y=nullptr)
	Construct a CentroidParameters.
	CentroidParameters (double x, double y)
	Construct a CentroidParameters with default-constructed Parameters set to x/y values.
bool	operator== (const CentroidData &other) const
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::string_view	null_str (const std::string_view &namespace_separator)
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 = "."
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 Centroid with Parameters for x and y.

Definition at line 15 of file centroidparameters.h.

Constructor & Destructor Documentation

CentroidParameters() [1/2]

lsst::gauss2d::fit::CentroidParameters::CentroidParameters ( std::shared_ptr< CentroidXParameterD > x = nullptr, std::shared_ptr< CentroidYParameterD > y = nullptr )

explicit

Construct a CentroidParameters.

Parameters

x	The x parameter. Default-constructed if null
y	The y parameter. Default-constructed if null

Definition at line 15 of file centroidparameters.cc.

        : CentroidData(),
          _x(x == nullptr ? std::make_shared<CentroidXParameterD>() : std::move(x)),
          _y(y == nullptr ? std::make_shared<CentroidYParameterD>() : std::move(y)) {}

CentroidParameters() [2/2]

lsst::gauss2d::fit::CentroidParameters::CentroidParameters	(	double	x,
		double	y )

Construct a CentroidParameters with default-constructed Parameters set to x/y values.

Definition at line 21 of file centroidparameters.cc.

        : CentroidData(),
          _x(std::make_shared<CentroidXParameterD>(x)),
          _y(std::make_shared<CentroidYParameterD>(y)) {}

Member Function Documentation

get_parameters()

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

overridevirtual

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)

Implements lsst::gauss2d::fit::Parametric.

Definition at line 26 of file centroidparameters.cc.

                                                                                          {
    return _get_parameters<ParamRefs>(params, filter, this->get_x_param(), this->get_y_param());
}

get_parameters_const()

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

overridevirtual

Same as get_parameters(), but for const refs.

Implements lsst::gauss2d::fit::Parametric.

Definition at line 30 of file centroidparameters.cc.

                                                                                                  {
    return _get_parameters<ParamCRefs>(params, filter, this->get_x_param(), this->get_y_param());
}

get_parameters_const_new()

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

inlineinherited

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

inlineinherited

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;
    }

get_x()

double lsst::gauss2d::fit::CentroidParameters::get_x ( ) const

overridevirtual

Get the x value.

Implements lsst::gauss2d::CentroidData.

Definition at line 34 of file centroidparameters.cc.

{ return _x->get_value(); }

get_x_param()

CentroidXParameterD & lsst::gauss2d::fit::CentroidParameters::get_x_param

(

)

const

Get a ref to the x param.

Definition at line 38 of file centroidparameters.cc.

{ return *_x; }

get_x_param_ptr()

std::shared_ptr< CentroidXParameterD > lsst::gauss2d::fit::CentroidParameters::get_x_param_ptr

(

)

Definition at line 41 of file centroidparameters.cc.

{ return _x; }

get_xy()

std::array< double, 2 > lsst::gauss2d::fit::CentroidParameters::get_xy ( ) const

overridevirtual

Get the x and y values.

Implements lsst::gauss2d::CentroidData.

Definition at line 36 of file centroidparameters.cc.

{ return {this->get_x(), this->get_y()}; }

get_y()

double lsst::gauss2d::fit::CentroidParameters::get_y ( ) const

overridevirtual

Get the y value.

Implements lsst::gauss2d::CentroidData.

Definition at line 35 of file centroidparameters.cc.

{ return _y->get_value(); }

get_y_param()

CentroidYParameterD & lsst::gauss2d::fit::CentroidParameters::get_y_param

(

)

const

Get a ref to the y param.

Definition at line 39 of file centroidparameters.cc.

{ return *_y; }

get_y_param_ptr()

std::shared_ptr< CentroidYParameterD > lsst::gauss2d::fit::CentroidParameters::get_y_param_ptr

(

)

Definition at line 42 of file centroidparameters.cc.

{ return _y; }

null_str() [1/2]

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;
    }

null_str() [2/2]

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;
    }

operator==()

bool lsst::gauss2d::CentroidData::operator== ( const CentroidData & other ) const

inlineinherited

Definition at line 56 of file centroid.h.

                                                     {
        return (get_x() == other.get_x()) && (get_y() == other.get_y());
    };

repr()

std::string lsst::gauss2d::fit::CentroidParameters::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::CentroidData.

Definition at line 51 of file centroidparameters.cc.

                                                                                               {
    return type_name_str<CentroidParameters>(false, namespace_separator) + "(" + (name_keywords ? "x=" : "")
           + _x->repr(name_keywords, namespace_separator) + ", " + (name_keywords ? "y=" : "")
           + _y->repr(name_keywords, namespace_separator) + ")";
}

set_x()

void lsst::gauss2d::fit::CentroidParameters::set_x ( double x )

overridevirtual

Implements lsst::gauss2d::CentroidData.

Definition at line 44 of file centroidparameters.cc.

{ _x->set_value(x); }

set_xy()

void lsst::gauss2d::fit::CentroidParameters::set_xy ( const std::array< double, 2 > & xy )

overridevirtual

Implements lsst::gauss2d::CentroidData.

Definition at line 46 of file centroidparameters.cc.

                                                             {
    this->set_x(xy[0]);
    this->set_y(xy[1]);
}

set_y()

void lsst::gauss2d::fit::CentroidParameters::set_y ( double y )

overridevirtual

Implements lsst::gauss2d::CentroidData.

Definition at line 45 of file centroidparameters.cc.

{ _y->set_value(y); }

str()

std::string lsst::gauss2d::fit::CentroidParameters::str ( ) const

overridevirtual

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

Implements lsst::gauss2d::CentroidData.

Definition at line 57 of file centroidparameters.cc.

                                        {
    return type_name_str<CentroidParameters>(true) + "(x=" + _x->str() + ", y=" + _y->str() + ")";
}

Member Data Documentation

CC_NAMESPACE_SEPARATOR [1/2]

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

staticconstexprinherited

The C++ namespace separator.

Definition at line 45 of file object.h.

CC_NAMESPACE_SEPARATOR [2/2]

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 [1/2]

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

staticconstexprinherited

Definition at line 46 of file object.h.

NULL_STR_GENERAL [2/2]

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

staticconstexprinherited

Definition at line 46 of file object.h.

PY_NAMESPACE_SEPARATOR [1/2]

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

staticconstexprinherited

Definition at line 47 of file object.h.

PY_NAMESPACE_SEPARATOR [2/2]

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 files:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/gauss2d_fit/g199a45376c+0ba108daf9/include/lsst/gauss2d/fit/centroidparameters.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/gauss2d_fit/g199a45376c+0ba108daf9/src/centroidparameters.cc