lsst.jointcal  16.0-20-g17d57d5+3
Public Member Functions | Protected Attributes | List of all members
lsst::jointcal::PhotometryMapping Class Reference

A mapping containing a single photometryTransfo. More...

#include <PhotometryMapping.h>

Inheritance diagram for lsst::jointcal::PhotometryMapping:
lsst::jointcal::PhotometryMappingBase

Public Member Functions

 PhotometryMapping (std::shared_ptr< PhotometryTransfo > transfo)
 Value transform takes ownership of transfo, error transform aliases it. More...
 
unsigned getNpar () const override
 Number of total parameters in this mapping. More...
 
double transform (MeasuredStar const &measuredStar, double value) const override
 Return the on-sky transformed flux for measuredStar on ccdImage. More...
 
double transformError (MeasuredStar const &measuredStar, double value, double valueErr) const override
 Return the on-sky transformed flux uncertainty for measuredStar on ccdImage. More...
 
void freezeErrorTransform () override
 Once this routine has been called, the error transform is not modified by offsetParams(). More...
 
void computeParameterDerivatives (MeasuredStar const &measuredStar, double value, Eigen::Ref< Eigen::VectorXd > derivatives) const override
 Compute the derivatives with respect to the parameters (i.e. More...
 
void offsetParams (Eigen::VectorXd const &delta)
 Offset the transfo parameters by delta. More...
 
Eigen::VectorXd getParameters () override
 
void getMappingIndices (std::vector< unsigned > &indices) const override
 Gets how this set of parameters (of length getNpar()) map into the "grand" fit. More...
 
void dump (std::ostream &stream=std::cout) const override
 Dump the contents of the transfos, for debugging. More...
 
std::shared_ptr< PhotometryTransfogetTransfo () const
 
std::shared_ptr< PhotometryTransfogetTransfoErrors () const
 
void setFixed (bool _fixed)
 Make this mapping's parameters fixed (i.e. not varied during fitting). More...
 
bool isFixed ()
 
unsigned getIndex ()
 Get the index of this mapping in the grand fit. More...
 
void setIndex (unsigned i)
 Set the index of this mapping in the grand fit. More...
 

Protected Attributes

unsigned index
 
bool fixed
 

Detailed Description

A mapping containing a single photometryTransfo.

Definition at line 107 of file PhotometryMapping.h.

Constructor & Destructor Documentation

◆ PhotometryMapping()

lsst::jointcal::PhotometryMapping::PhotometryMapping ( std::shared_ptr< PhotometryTransfo transfo)
inlineexplicit

Value transform takes ownership of transfo, error transform aliases it.

Call freezeErrorTransform() to unalias the error transform.

Definition at line 114 of file PhotometryMapping.h.

Member Function Documentation

◆ computeParameterDerivatives()

void lsst::jointcal::PhotometryMapping::computeParameterDerivatives ( MeasuredStar const &  measuredStar,
double  value,
Eigen::Ref< Eigen::VectorXd >  derivatives 
) const
inlineoverridevirtual

Compute the derivatives with respect to the parameters (i.e.

the coefficients).

Parameters
[in]measuredStarThe measured star position to transform.
[in]valueThe instrument flux or magnitude to compute the derivative at.
[out]derivativesThe computed derivatives, in the same order as the deltas in offsetParams.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 142 of file PhotometryMapping.h.

◆ dump()

void lsst::jointcal::PhotometryMapping::dump ( std::ostream stream = std::cout) const
inlineoverridevirtual

Dump the contents of the transfos, for debugging.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 171 of file PhotometryMapping.h.

◆ freezeErrorTransform()

void lsst::jointcal::PhotometryMapping::freezeErrorTransform ( )
inlineoverridevirtual

Once this routine has been called, the error transform is not modified by offsetParams().

The routine can be called when the mappings are roughly in place. After the call, the transformations used to propagate errors are no longer affected when updating the mappings. This allows an exactly linear fit, which can be necessary for some model+data combinations.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 137 of file PhotometryMapping.h.

◆ getIndex()

unsigned lsst::jointcal::PhotometryMappingBase::getIndex ( )
inlineinherited

Get the index of this mapping in the grand fit.

Definition at line 92 of file PhotometryMapping.h.

◆ getMappingIndices()

void lsst::jointcal::PhotometryMapping::getMappingIndices ( std::vector< unsigned > &  indices) const
inlineoverridevirtual

Gets how this set of parameters (of length getNpar()) map into the "grand" fit.

Expects that indices has enough space reserved.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 163 of file PhotometryMapping.h.

◆ getNpar()

unsigned lsst::jointcal::PhotometryMapping::getNpar ( ) const
inlineoverridevirtual

Number of total parameters in this mapping.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 118 of file PhotometryMapping.h.

◆ getParameters()

Eigen::VectorXd lsst::jointcal::PhotometryMapping::getParameters ( )
inlineoverridevirtual

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 160 of file PhotometryMapping.h.

◆ getTransfo()

std::shared_ptr<PhotometryTransfo> lsst::jointcal::PhotometryMapping::getTransfo ( ) const
inline

Definition at line 176 of file PhotometryMapping.h.

◆ getTransfoErrors()

std::shared_ptr<PhotometryTransfo> lsst::jointcal::PhotometryMapping::getTransfoErrors ( ) const
inline

Definition at line 178 of file PhotometryMapping.h.

◆ isFixed()

bool lsst::jointcal::PhotometryMappingBase::isFixed ( )
inlineinherited

Definition at line 78 of file PhotometryMapping.h.

◆ offsetParams()

void lsst::jointcal::PhotometryMapping::offsetParams ( Eigen::VectorXd const &  delta)
inline

Offset the transfo parameters by delta.

Parameters
[in]deltavector to offset transfo parameters. Same ordering as derivatives in computeParameterDerivatives();

Definition at line 157 of file PhotometryMapping.h.

◆ setFixed()

void lsst::jointcal::PhotometryMappingBase::setFixed ( bool  _fixed)
inlineinherited

Make this mapping's parameters fixed (i.e. not varied during fitting).

Definition at line 77 of file PhotometryMapping.h.

◆ setIndex()

void lsst::jointcal::PhotometryMappingBase::setIndex ( unsigned  i)
inlineinherited

Set the index of this mapping in the grand fit.

Definition at line 95 of file PhotometryMapping.h.

◆ transform()

double lsst::jointcal::PhotometryMapping::transform ( MeasuredStar const &  measuredStar,
double  value 
) const
inlineoverridevirtual

Return the on-sky transformed flux for measuredStar on ccdImage.

Parameters
[in]measuredStarThe measured star position to transform.
[in]valueThe instrument flux or magnitude to transform.
Returns
The on-sky value () transformed from value at measuredStar's position.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 127 of file PhotometryMapping.h.

◆ transformError()

double lsst::jointcal::PhotometryMapping::transformError ( MeasuredStar const &  measuredStar,
double  value,
double  valueErr 
) const
inlineoverridevirtual

Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.

Matches the underlying PhotometryTransfo's transformError() until freezeErrorTransform() is called.

Parameters
[in]measuredStarThe measured star position to transform.
[in]valueThe flux or magnitude to transform.
[in]valueErrThe flux or magnitude uncertainty to transform.
Returns
The on-sky value transformed from value at measuredStar's position.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 132 of file PhotometryMapping.h.

Member Data Documentation

◆ fixed

bool lsst::jointcal::PhotometryMappingBase::fixed
protectedinherited

Definition at line 101 of file PhotometryMapping.h.

◆ index

unsigned lsst::jointcal::PhotometryMappingBase::index
protectedinherited

Definition at line 99 of file PhotometryMapping.h.


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