lsst.meas.astrom  14.0-7-g0d69b06+3
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
lsst::meas::astrom::SipTransformBase Class Reference

Base class for SIP transform objects. More...

#include <SipTransform.h>

Inheritance diagram for lsst::meas::astrom::SipTransformBase:
lsst::meas::astrom::SipForwardTransform lsst::meas::astrom::SipReverseTransform

Public Member Functions

afw::geom::Point2D const & getPixelOrigin () const
 Return the pixel origin (CRPIX, but zero-indexed) of the transform. More...
 
afw::geom::LinearTransform const & getCdMatrix () const
 Return the CD matrix of the transform. More...
 
PolynomialTransform const & getPoly () const
 Return the polynomial component of the transform (A,B) or (AP,BP). More...
 

Protected Member Functions

 SipTransformBase (afw::geom::Point2D const &pixelOrigin, afw::geom::LinearTransform const &cdMatrix, PolynomialTransform const &poly)
 Construct a SipTransformBase from its components. More...
 
 SipTransformBase (SipTransformBase const &other)=default
 
 SipTransformBase (SipTransformBase &&other)=default
 
SipTransformBaseoperator= (SipTransformBase const &other)=default
 
SipTransformBaseoperator= (SipTransformBase &&other)=default
 
void swap (SipTransformBase &other)
 
void transformPixelsInPlace (afw::geom::AffineTransform const &s)
 

Protected Attributes

afw::geom::Point2D _pixelOrigin
 
afw::geom::LinearTransform _cdMatrix
 
PolynomialTransform _poly
 

Detailed Description

Base class for SIP transform objects.

This class simply provides some getters for its derived classes. It should not be used directly, and does not define a polymorphic interface.

Definition at line 52 of file SipTransform.h.

Constructor & Destructor Documentation

◆ SipTransformBase() [1/3]

lsst::meas::astrom::SipTransformBase::SipTransformBase ( afw::geom::Point2D const &  pixelOrigin,
afw::geom::LinearTransform const &  cdMatrix,
PolynomialTransform const &  poly 
)
inlineprotected

Construct a SipTransformBase from its components.

See SipForwardTransform and SipReverseTransform for more extensive definitions.

Parameters
[in]pixelOriginCRPIX \((u_0,v_0)\) (zero-indexed)
[in]cdMatrixCD matrix \(Z\)
[in]polyEither the forward or reverse SIP polynomial (depending on the derived class).

Definition at line 84 of file SipTransform.h.

◆ SipTransformBase() [2/3]

lsst::meas::astrom::SipTransformBase::SipTransformBase ( SipTransformBase const &  other)
protecteddefault

◆ SipTransformBase() [3/3]

lsst::meas::astrom::SipTransformBase::SipTransformBase ( SipTransformBase &&  other)
protecteddefault

Member Function Documentation

◆ getCdMatrix()

afw::geom::LinearTransform const& lsst::meas::astrom::SipTransformBase::getCdMatrix ( ) const
inline

Return the CD matrix of the transform.

Definition at line 63 of file SipTransform.h.

◆ getPixelOrigin()

afw::geom::Point2D const& lsst::meas::astrom::SipTransformBase::getPixelOrigin ( ) const
inline

Return the pixel origin (CRPIX, but zero-indexed) of the transform.

Definition at line 58 of file SipTransform.h.

◆ getPoly()

PolynomialTransform const& lsst::meas::astrom::SipTransformBase::getPoly ( ) const
inline

Return the polynomial component of the transform (A,B) or (AP,BP).

Definition at line 68 of file SipTransform.h.

◆ operator=() [1/2]

SipTransformBase& lsst::meas::astrom::SipTransformBase::operator= ( SipTransformBase const &  other)
protecteddefault

◆ operator=() [2/2]

SipTransformBase& lsst::meas::astrom::SipTransformBase::operator= ( SipTransformBase &&  other)
protecteddefault

◆ swap()

void lsst::meas::astrom::SipTransformBase::swap ( SipTransformBase other)
inlineprotected

Definition at line 98 of file SipTransform.h.

◆ transformPixelsInPlace()

void lsst::meas::astrom::SipTransformBase::transformPixelsInPlace ( afw::geom::AffineTransform const &  s)
protected

Definition at line 34 of file SipTransform.cc.

Member Data Documentation

◆ _cdMatrix

afw::geom::LinearTransform lsst::meas::astrom::SipTransformBase::_cdMatrix
protected

Definition at line 107 of file SipTransform.h.

◆ _pixelOrigin

afw::geom::Point2D lsst::meas::astrom::SipTransformBase::_pixelOrigin
protected

Definition at line 106 of file SipTransform.h.

◆ _poly

PolynomialTransform lsst::meas::astrom::SipTransformBase::_poly
protected

Definition at line 108 of file SipTransform.h.


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