lsst.jointcal  16.0-7-g6e35192+1
Public Member Functions | Protected Attributes | List of all members
lsst::jointcal::ChipVisitPhotometryMapping Class Reference

A two-level photometric transform: one for the ccd and one for the visit. More...

#include <PhotometryMapping.h>

Inheritance diagram for lsst::jointcal::ChipVisitPhotometryMapping:
lsst::jointcal::PhotometryMappingBase

Public Member Functions

 ChipVisitPhotometryMapping (std::shared_ptr< PhotometryMapping > chipMapping, std::shared_ptr< PhotometryMapping > visitMapping)
 
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 for measuredStar on ccdImage. More...
 
double transformError (MeasuredStar const &measuredStar, double instFlux, double instFluxErr) 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 instFlux, Eigen::Ref< Eigen::VectorXd > derivatives) const override
 Compute the derivatives with respect to the parameters (i.e. 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 setWhatToFit (bool const fittingChips, bool const fittingVisits)
 Set whether to fit chips or visits. More...
 
void dump (std::ostream &stream=std::cout) const override
 Dump the contents of the transfos, for debugging. More...
 
std::shared_ptr< PhotometryMappinggetChipMapping () const
 
std::shared_ptr< PhotometryMappinggetVisitMapping () 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 two-level photometric transform: one for the ccd and one for the visit.

Definition at line 190 of file PhotometryMapping.h.

Constructor & Destructor Documentation

◆ ChipVisitPhotometryMapping()

lsst::jointcal::ChipVisitPhotometryMapping::ChipVisitPhotometryMapping ( std::shared_ptr< PhotometryMapping chipMapping,
std::shared_ptr< PhotometryMapping visitMapping 
)
inline

Definition at line 192 of file PhotometryMapping.h.

Member Function Documentation

◆ computeParameterDerivatives()

void lsst::jointcal::ChipVisitPhotometryMapping::computeParameterDerivatives ( MeasuredStar const &  measuredStar,
double  instFlux,
Eigen::Ref< Eigen::VectorXd >  derivatives 
) const
overridevirtual

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 13 of file PhotometryMapping.cc.

◆ dump()

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

Dump the contents of the transfos, for debugging.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 246 of file PhotometryMapping.h.

◆ freezeErrorTransform()

void lsst::jointcal::ChipVisitPhotometryMapping::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 215 of file PhotometryMapping.h.

◆ getChipMapping()

std::shared_ptr<PhotometryMapping> lsst::jointcal::ChipVisitPhotometryMapping::getChipMapping ( ) const
inline

Definition at line 253 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::ChipVisitPhotometryMapping::getMappingIndices ( std::vector< unsigned > &  indices) const
overridevirtual

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 51 of file PhotometryMapping.cc.

◆ getNpar()

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

Number of total parameters in this mapping.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 201 of file PhotometryMapping.h.

◆ getParameters()

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

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 225 of file PhotometryMapping.h.

◆ getVisitMapping()

std::shared_ptr<PhotometryMapping> lsst::jointcal::ChipVisitPhotometryMapping::getVisitMapping ( ) const
inline

Definition at line 254 of file PhotometryMapping.h.

◆ isFixed()

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

Definition at line 78 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.

◆ setWhatToFit()

void lsst::jointcal::ChipVisitPhotometryMapping::setWhatToFit ( bool const  fittingChips,
bool const  fittingVisits 
)

Set whether to fit chips or visits.

This must be called before anything that depends on knowing the number of parameters in the fit, such as offsetParams(), getParameters(), or computeParameterDerivatives().

Parameters
fittingChipsFit the chip transform.
fittingVisitsFit the visit transform.

Definition at line 67 of file PhotometryMapping.cc.

◆ transform()

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

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

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 204 of file PhotometryMapping.h.

◆ transformError()

double lsst::jointcal::ChipVisitPhotometryMapping::transformError ( MeasuredStar const &  measuredStar,
double  instFlux,
double  instFluxErr 
) const
overridevirtual

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 value to transform.
[in]valueErrThe value uncertainty to transform.
Returns
The on-sky flux transformed from instFlux at measuredStar's position.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 42 of file PhotometryMapping.cc.

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 files: