LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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: