LSST Applications g04a91732dc+146a938ab0,g07dc498a13+80b84b0d75,g0fba68d861+0decac7526,g1409bbee79+80b84b0d75,g1a7e361dbc+80b84b0d75,g1fd858c14a+f6e422e056,g20f46db602+483a84333a,g21d47ad084+4a6cd485de,g35bb328faa+fcb1d3bbc8,g42c1b31a95+a1301e4c20,g4d39ba7253+9b833be27e,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+9b833be27e,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+790117df0f,g89139ef638+80b84b0d75,g8d6b6b353c+9b833be27e,g9125e01d80+fcb1d3bbc8,g989de1cb63+80b84b0d75,g9f33ca652e+9c6b68d7f3,ga9baa6287d+9b833be27e,gaaedd4e678+80b84b0d75,gabe3b4be73+1e0a283bba,gb1101e3267+9f3571abad,gb58c049af0+f03b321e39,gb90eeb9370+691e4ab549,gc741bbaa4f+5f483edd21,gcf25f946ba+790117df0f,gd24842266e+c54cdbdbd2,gd315a588df+5b65d88fe4,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+c99546153d,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,w.2025.10
LSST Data Management Base Package
Loading...
Searching...
No Matches
lsst::modelfit::parameters::Object Class Referenceabstract

A generic object from the parameters library. More...

#include <object.h>

Inheritance diagram for lsst::modelfit::parameters::Object:
lsst::modelfit::parameters::Limits< double > lsst::modelfit::parameters::ParameterBase< double > lsst::modelfit::parameters::Transform< double > lsst::modelfit::parameters::Limits< T > lsst::modelfit::parameters::ParameterBase< T > lsst::modelfit::parameters::Transform< T > lsst::modelfit::parameters::Parameter< double, T > lsst::gauss2d::fit::InverseTransform lsst::gauss2d::fit::JanskyToABMagTransform lsst::gauss2d::fit::Log10Transform lsst::gauss2d::fit::LogTransform lsst::gauss2d::fit::LogitLimitedTransform lsst::gauss2d::fit::LogitTransform lsst::modelfit::parameters::Parameter< T, C > lsst::modelfit::parameters::UnitTransform< T >

Public Member Functions

virtual std::string repr (bool name_keywords=false, const 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.
 
virtual ~Object ()=default
 

Static Public Attributes

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

Friends

std::ostreamoperator<< (std::ostream &out, const Object &obj)
 

Detailed Description

A generic object from the parameters library.

Objects have string representations that are guaranteed to be valid in C++ and should also be valid in Python bindings, if implemented correctly. The interface may be expanded in the future.

Definition at line 39 of file object.h.

Constructor & Destructor Documentation

◆ ~Object()

virtual lsst::modelfit::parameters::Object::~Object ( )
virtualdefault

Member Function Documentation

◆ repr()

virtual std::string lsst::modelfit::parameters::Object::repr ( bool name_keywords = false,
const std::string_view & namespace_separator = CC_NAMESPACE_SEPARATOR ) const
pure virtual

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.

Implemented in lsst::gauss2d::fit::InverseTransform, lsst::gauss2d::fit::JanskyToABMagTransform, lsst::gauss2d::fit::Log10Transform, lsst::gauss2d::fit::LogitLimitedTransform, lsst::gauss2d::fit::LogitTransform, lsst::gauss2d::fit::LogTransform, lsst::gauss2d::fit::NanojanskyToABMagTransform, lsst::modelfit::parameters::Limits< T >, lsst::modelfit::parameters::Limits< double >, lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::UnitTransform< T >.

◆ str()

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & out,
const Object & obj )
friend

Definition at line 65 of file object.h.

65 {
66 out << obj.str();
67 return out;
68 }

Member Data Documentation

◆ CC_NAMESPACE_SEPARATOR

std::string_view lsst::modelfit::parameters::Object::CC_NAMESPACE_SEPARATOR = "::"
staticconstexpr

The C++ namespace separator.

Definition at line 42 of file object.h.


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