LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+ffe7eabc7e,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g36da64cc00+ea84795170,g3ddfee87b4+955a963fd8,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+955a963fd8,g591dd9f2cf+bac198a2cb,g5ec818987f+420292cfeb,g858d7b2824+d6c9a0a3b8,g876c692160+aabc49a3c3,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+e6cd765486,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+acd47f83f4,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+12c8382528,gba4ed39666+1ac82b564f,gbb8dafda3b+0574160a1f,gbeb006f7da+dea2fbb49f,gc28159a63d+c6dfa2ddaf,gc86a011abf+d6c9a0a3b8,gcf0d15dbbd+955a963fd8,gdaeeff99f8+1cafcb7cd4,gdc0c513512+d6c9a0a3b8,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,gee10cc3b42+90ebb246c7,gf1cff7945b+d6c9a0a3b8,w.2024.13
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst::geom::polynomials::Scaling1d Class Reference

A 1-d affine transform that can be used to map one interval to another. More...

#include <Scaling1d.h>

Public Member Functions

 Scaling1d (double scale, double shift) noexcept
 Construct from the given multiplicative scale and additive shift.
 
 Scaling1d (Scaling1d const &) noexcept=default
 Default copy constructor.
 
 Scaling1d (Scaling1d &&) noexcept=default
 Default move constructor.
 
Scaling1doperator= (Scaling1d const &) noexcept=default
 Default copy assignment.
 
Scaling1doperator= (Scaling1d &&) noexcept=default
 Default move assignment.
 
double applyForward (double x) const noexcept
 Apply the transform in the forward direction.
 
double applyInverse (double y) const noexcept
 Apply the inverse of the forward transform;.
 
double getScale () const noexcept
 Return the multiplicative scaling.
 
double getShift () const noexcept
 Return the additive shift.
 
Scaling1d inverted () const noexcept
 Invert the transform.
 
Scaling1d then (Scaling1d const &second) const noexcept
 Compose two transforms.
 

Detailed Description

A 1-d affine transform that can be used to map one interval to another.

The transform is represented as an additive shift followed by a multiplicative scaling.

Note
This class (and especially its 2-d counterpart, Scaling2d) has a lot in common with geom::AffineTransform, and ideally they should share code and be highly interoperable. Doing that well would require a larger-scale rethink of geom, however, and at present we don't actually have a use case for that interoperability, so it's something we should keep in mind for the future, not a high priority for the present.
Exception Safety
All operations on Scaling1d are noexcept.
See also
makeUnitRangeScaling1d

Definition at line 46 of file Scaling1d.h.

Constructor & Destructor Documentation

◆ Scaling1d() [1/3]

lsst::geom::polynomials::Scaling1d::Scaling1d ( double scale,
double shift )
inlinenoexcept

Construct from the given multiplicative scale and additive shift.

Definition at line 50 of file Scaling1d.h.

50 :
51 _scale(scale),
52 _shift(shift)
53 {}

◆ Scaling1d() [2/3]

lsst::geom::polynomials::Scaling1d::Scaling1d ( Scaling1d const & )
defaultnoexcept

Default copy constructor.

◆ Scaling1d() [3/3]

lsst::geom::polynomials::Scaling1d::Scaling1d ( Scaling1d && )
defaultnoexcept

Default move constructor.

Member Function Documentation

◆ applyForward()

double lsst::geom::polynomials::Scaling1d::applyForward ( double x) const
inlinenoexcept

Apply the transform in the forward direction.

Result is defined to be (x + getShift()) * getScale().

Definition at line 72 of file Scaling1d.h.

72 {
73 return (x + getShift())*getScale();
74 }
double getShift() const noexcept
Return the additive shift.
Definition Scaling1d.h:87
double getScale() const noexcept
Return the multiplicative scaling.
Definition Scaling1d.h:84

◆ applyInverse()

double lsst::geom::polynomials::Scaling1d::applyInverse ( double y) const
inlinenoexcept

Apply the inverse of the forward transform;.

Definition at line 79 of file Scaling1d.h.

79 {
80 return y/_scale - _shift;
81 }
int y
Definition SpanSet.cc:48

◆ getScale()

double lsst::geom::polynomials::Scaling1d::getScale ( ) const
inlinenoexcept

Return the multiplicative scaling.

Definition at line 84 of file Scaling1d.h.

84{ return _scale; }

◆ getShift()

double lsst::geom::polynomials::Scaling1d::getShift ( ) const
inlinenoexcept

Return the additive shift.

Definition at line 87 of file Scaling1d.h.

87{ return _shift; }

◆ inverted()

Scaling1d lsst::geom::polynomials::Scaling1d::inverted ( ) const
inlinenoexcept

Invert the transform.

If r = t.inverted(), then r.applyForward(x) is equivalent to t.applyInverse(x) and r.applyInverse(y) is equivalent to t.applyForward(y).

Definition at line 96 of file Scaling1d.h.

96 {
97 return Scaling1d(1.0/_scale, -_shift*_scale);
98 }
Scaling1d(double scale, double shift) noexcept
Construct from the given multiplicative scale and additive shift.
Definition Scaling1d.h:50

◆ operator=() [1/2]

Scaling1d & lsst::geom::polynomials::Scaling1d::operator= ( Scaling1d && )
defaultnoexcept

Default move assignment.

◆ operator=() [2/2]

Scaling1d & lsst::geom::polynomials::Scaling1d::operator= ( Scaling1d const & )
defaultnoexcept

Default copy assignment.

◆ then()

Scaling1d lsst::geom::polynomials::Scaling1d::then ( Scaling1d const & second) const
inlinenoexcept

Compose two transforms.

If r = a.then(b), then r.applyForward(x) is equivalent to b.applyForward(a.applyForward(x)) and r.applyInverse(y) is equivalent to a.applyInverse(b.applyInverse(y)).

Definition at line 107 of file Scaling1d.h.

107 {
108 return Scaling1d(getScale()*second.getScale(),
109 getShift() + second.getShift()/getScale());
110 }

The documentation for this class was generated from the following file: