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
	Return the derivative of this tranform at the value x.
double	forward (double x) const override
	Return the transformed value of x.
double	reverse (double x) const override
	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()

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

inlineoverridevirtual

Return the derivative of this tranform at the value x.

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

Definition at line 76 of file transforms.h.

{ return 1 / x; }

description()

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

inlineoverridevirtual

Return a description of this transform.

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

Definition at line 68 of file transforms.h.

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

forward()

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

inlineoverridevirtual

Return the transformed value of x.

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

Definition at line 77 of file transforms.h.

{ return log(x); }

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()

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

inlineoverridevirtual

Return the original value of x given a transformed value.

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

Definition at line 78 of file transforms.h.

{ return exp(x); }

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

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-10.0.0/Linux64/gauss2d_fit/gf35d7ec915+97dd712d81/include/lsst/gauss2d/fit/transforms.h