lsst::gauss2d::fit::LogTransform Struct Reference

#include <transforms.h>

Inheritance diagram for lsst::gauss2d::fit::LogTransform:

Public Member Functions
std::string	description () const override
	Return a description of this transform.
std::string	repr (bool name_keywords=false, const std::string_view &namespace_separator=parameters::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.
double	derivative (double x) const override
double	forward (double x) const override
double	reverse (double x) const override
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.

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

Detailed Description

Definition at line 67 of file transforms.h.

Member Function Documentation

derivative() [1/2]

double lsst::gauss2d::fit::LogTransform::derivative ( double x ) const

inlineoverride

Definition at line 76 of file transforms.h.

{ return 1 / x; }

derivative() [2/2]

template<class T >

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

pure virtualinherited

Return the derivative of this tranform at the value x.

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

description()

std::string lsst::gauss2d::fit::LogTransform::description ( ) const

inlineoverridevirtual

Return a description of this transform.

Implements lsst::modelfit::parameters::Transform< T >.

Definition at line 68 of file transforms.h.

{ return "Natural (base e) logarithmic transform"; }

forward() [1/2]

double lsst::gauss2d::fit::LogTransform::forward ( double x ) const

inlineoverride

Definition at line 77 of file transforms.h.

{ return log(x); }

forward() [2/2]

template<class T >

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

pure virtualinherited

Return the transformed value of x.

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

repr()

std::string lsst::gauss2d::fit::LogTransform::repr ( bool name_keywords = false, const std::string_view & namespace_separator = parameters::Object::CC_NAMESPACE_SEPARATOR ) const

inlineoverridevirtual

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::modelfit::parameters::Object.

Definition at line 69 of file transforms.h.

                                                                              {
        return parameters::type_name_str<LogTransform>(false, namespace_separator) + "()";
    }

reverse() [1/2]

double lsst::gauss2d::fit::LogTransform::reverse ( double x ) const

inlineoverride

Definition at line 78 of file transforms.h.

{ return exp(x); }

reverse() [2/2]

template<class T >

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

pure virtualinherited

Return the original value of x given a transformed value.

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

str()

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

inlineoverridevirtual

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

Implements lsst::modelfit::parameters::Object.

Definition at line 74 of file transforms.h.

{ return parameters::type_name_str<LogTransform>(true) + "()"; }

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 struct was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d_fit/gb58c049af0+ace264a4f2/include/lsst/gauss2d/fit/transforms.h