lsst::modelfit::parameters::Transform< T > Class Template Reference

A reversible transformation of a real scalar value. More...

#include <transform.h>

Inheritance diagram for lsst::modelfit::parameters::Transform< T >:

Public Member Functions
virtual std::string	description () const =0
	Return a description of this transform.
virtual T	derivative (T x) const =0
	Return the derivative of this tranform at the value x.
virtual T	forward (T x) const =0
	Return the transformed value of x.
virtual T	reverse (T x) const =0
	Return the original value of x given a transformed value.
virtual	~Transform ()=default
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.

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

Detailed Description

template<class T>
class lsst::modelfit::parameters::Transform< T >

A reversible transformation of a real scalar value.

The transformation should be differentiable, ideally analytically.

Template Parameters

T	The type of the value. Only floating point values are tested.

Definition at line 45 of file transform.h.

Constructor & Destructor Documentation

~Transform()

template<class T >

virtual lsst::modelfit::parameters::Transform< T >::~Transform ( )

virtualdefault

Member Function Documentation

derivative()

template<class T >

virtual T lsst::modelfit::parameters::Transform< T >::derivative ( T x ) const

pure virtual

Return the derivative of this tranform at the value x.

Implemented in lsst::modelfit::parameters::UnitTransform< T >.

description()

template<class T >

virtual std::string lsst::modelfit::parameters::Transform< T >::description ( ) const

pure virtual

Return a description of this transform.

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

forward()

template<class T >

virtual T lsst::modelfit::parameters::Transform< T >::forward ( T x ) const

pure virtual

Return the transformed value of x.

Implemented in lsst::modelfit::parameters::UnitTransform< T >.

repr()

virtual std::string lsst::modelfit::parameters::Object::repr ( bool name_keywords = false, const 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::modelfit::parameters::Limits< double >, lsst::modelfit::parameters::Limits< T >, lsst::modelfit::parameters::Parameter< T, C >, lsst::gauss2d::fit::InverseTransform, lsst::gauss2d::fit::JanskyToABMagTransform, lsst::gauss2d::fit::NanojanskyToABMagTransform, lsst::gauss2d::fit::LogTransform, lsst::gauss2d::fit::Log10Transform, lsst::gauss2d::fit::LogitTransform, lsst::gauss2d::fit::LogitLimitedTransform, and lsst::modelfit::parameters::UnitTransform< T >.

reverse()

template<class T >

virtual T lsst::modelfit::parameters::Transform< T >::reverse ( T x ) const

pure virtual

Return the original value of x given a transformed value.

Implemented in lsst::modelfit::parameters::UnitTransform< T >.

str()

virtual std::string lsst::modelfit::parameters::Object::str ( ) const

pure virtualinherited

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

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

Member Data Documentation

CC_NAMESPACE_SEPARATOR

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

staticconstexprinherited

The C++ namespace separator.

Definition at line 42 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/modelfit_parameters/g35bb328faa+34a971ddd9/include/lsst/modelfit/parameters/transform.h