LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
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: