lsst.jointcal  14.0-15-gc2c14a3
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)
 
unsigned getNpar () const override
 Number of total parameters in this mapping. More...
 
double transform (MeasuredStar const &measuredStar, double instFlux) const override
 Return the on-sky transformed flux at (x,y). More...
 
void computeParameterDerivatives (MeasuredStar const &measuredStar, double instFlux, Eigen::Ref< Eigen::VectorXd > derivatives) const override
 Compute the derivatives with respect to the parameters (i.e. More...
 
void offsetParams (Eigen::VectorXd const &delta) override
 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
 
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 95 of file PhotometryMapping.h.

Constructor & Destructor Documentation

◆ PhotometryMapping()

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

Definition at line 97 of file PhotometryMapping.h.

Member Function Documentation

◆ computeParameterDerivatives()

void lsst::jointcal::PhotometryMapping::computeParameterDerivatives ( MeasuredStar const &  measuredStar,
double  instFlux,
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]instFluxThe instrument flux 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 115 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 139 of file PhotometryMapping.h.

◆ getIndex()

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

Get the index of this mapping in the grand fit.

Definition at line 80 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 131 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 101 of file PhotometryMapping.h.

◆ getParameters()

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

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 128 of file PhotometryMapping.h.

◆ getTransfo()

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

Definition at line 144 of file PhotometryMapping.h.

◆ isFixed()

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

Definition at line 66 of file PhotometryMapping.h.

◆ offsetParams()

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

Offset the transfo parameters by delta.

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

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 125 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 65 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 83 of file PhotometryMapping.h.

◆ transform()

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

Return the on-sky transformed flux at (x,y).

Parameters
[in]measuredStarThe measured star position to transform.
[in]instFluxThe instrument flux to transform.
Returns
The on-sky flux transformed from instFlux at measuredStar's position.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 110 of file PhotometryMapping.h.

Member Data Documentation

◆ fixed

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

Definition at line 89 of file PhotometryMapping.h.

◆ index

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

Definition at line 87 of file PhotometryMapping.h.


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