LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
lsst::jointcal::ChipVisitFluxMapping Class Reference

#include <PhotometryMapping.h>

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

Public Member Functions

 ChipVisitFluxMapping (std::shared_ptr< PhotometryMapping > chipMapping, std::shared_ptr< PhotometryMapping > visitMapping)
 
double transformError (MeasuredStar const &measuredStar, double value, double valueErr) const override
 Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
 
void computeParameterDerivatives (MeasuredStar const &measuredStar, double value, Eigen::Ref< Eigen::VectorXd > derivatives) const override
 Compute the derivatives with respect to the parameters (i.e.
 
std::size_t getNpar () const override
 Number of total parameters in this mapping.
 
double transform (MeasuredStar const &measuredStar, double value) const override
 Return the on-sky transformed flux for measuredStar on ccdImage.
 
void freezeErrorTransform () override
 Once this routine has been called, the error transform is not modified by offsetParams().
 
Eigen::VectorXd getParameters () override
 
void getMappingIndices (IndexVector &indices) const override
 Gets how this set of parameters (of length getNpar()) map into the "grand" fit.
 
void setWhatToFit (bool fittingChips, bool fittingVisits)
 Set whether to fit chips or visits.
 
void print (std::ostream &out) const override
 Print a string representation of the contents of this mapping, for debugging.
 
std::shared_ptr< PhotometryMappinggetChipMapping () const
 
std::shared_ptr< PhotometryMappinggetVisitMapping () const
 
std::size_t getNParChip () const
 
std::size_t getNParVisit () const
 
void setFixed (bool _fixed)
 Make this mapping's parameters fixed (i.e. not varied during fitting).
 
bool isFixed () const
 
Eigen::Index getIndex () const
 Get the index of this mapping in the grand fit.
 
void setIndex (Eigen::Index i)
 Set the index of this mapping in the grand fit.
 

Protected Attributes

std::size_t _nParChip
 
std::size_t _nParVisit
 
std::shared_ptr< PhotometryMapping_chipMapping
 
std::shared_ptr< PhotometryMapping_visitMapping
 
Eigen::Index index
 
bool fixed
 

Detailed Description

Definition at line 290 of file PhotometryMapping.h.

Constructor & Destructor Documentation

◆ ChipVisitFluxMapping()

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

Definition at line 292 of file PhotometryMapping.h.

294 : ChipVisitPhotometryMapping(std::move(chipMapping), std::move(visitMapping)) {}
ChipVisitPhotometryMapping(std::shared_ptr< PhotometryMapping > chipMapping, std::shared_ptr< PhotometryMapping > visitMapping)
T move(T... args)

Member Function Documentation

◆ computeParameterDerivatives()

void lsst::jointcal::ChipVisitFluxMapping::computeParameterDerivatives ( MeasuredStar const & measuredStar,
double value,
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]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 82 of file PhotometryMapping.cc.

83 {
84 // TODO DM-12161: possible optimization is to merge transform and computeDerivatives,
85 // and/or save these intermediate calculations when transforming flux to use in derivatives.
86 // Like what AstrometryMappings do with `computeTransformAndDerivatives` vs. `transformPosAndErrors`.
87
88 double chipScale = _chipMapping->getTransform()->transform(measuredStar.x, measuredStar.y, 1);
89 double visitScale =
90 _visitMapping->getTransform()->transform(measuredStar.getXFocal(), measuredStar.getYFocal(), 1);
91
92 // NOTE: chipBlock is the product of the chip derivatives and the visit transforms, and vice versa.
93 // NOTE: See DMTN-036 for the math behind this.
94 if (getNParChip() > 0 && !_chipMapping->isFixed()) {
95 // The chip derivatives start at 0, independent of the full-fit indices.
96 Eigen::Ref<Eigen::VectorXd> chipBlock = derivatives.segment(0, getNParChip());
97 _chipMapping->getTransform()->computeParameterDerivatives(measuredStar.x, measuredStar.y, instFlux,
98 chipBlock);
99 chipBlock *= visitScale;
100 }
101 if (getNParVisit() > 0) {
102 // The visit derivatives start at the last chip derivative, independent of the full-fit indices.
103 Eigen::Ref<Eigen::VectorXd> visitBlock = derivatives.segment(getNParChip(), getNParVisit());
104 _visitMapping->getTransform()->computeParameterDerivatives(
105 measuredStar.getXFocal(), measuredStar.getYFocal(), instFlux, visitBlock);
106 visitBlock *= chipScale;
107 }
108}
std::shared_ptr< PhotometryMapping > _visitMapping
std::shared_ptr< PhotometryMapping > _chipMapping

◆ freezeErrorTransform()

void lsst::jointcal::ChipVisitPhotometryMapping::freezeErrorTransform ( )
inlineoverridevirtualinherited

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

240 {
241 _chipMapping->freezeErrorTransform();
242 _visitMapping->freezeErrorTransform();
243 }

◆ getChipMapping()

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

Definition at line 275 of file PhotometryMapping.h.

275{ return _chipMapping; }

◆ getIndex()

Eigen::Index lsst::jointcal::PhotometryMappingBase::getIndex ( ) const
inlineinherited

Get the index of this mapping in the grand fit.

Definition at line 121 of file PhotometryMapping.h.

◆ getMappingIndices()

void lsst::jointcal::ChipVisitPhotometryMapping::getMappingIndices ( IndexVector & indices) const
overridevirtualinherited

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

39 {
40 if (indices.size() < getNpar()) indices.resize(getNpar());
41 // If we're fitting the chip mapping, fill those indices.
42 if (_nParChip > 0) {
43 _chipMapping->getMappingIndices(indices);
44 }
45 // If we're fitting the visit mapping, fill those indices.
46 if (_nParVisit > 0) {
47 // TODO DM-12169: there is probably a better way to feed a subpart of a std::vector
48 // (maybe a view or iterators?)
49 IndexVector tempIndices(_visitMapping->getNpar());
50 _visitMapping->getMappingIndices(tempIndices);
51 // We have to insert the visit indices starting after the chip indices.
52 for (std::size_t k = 0; k < _visitMapping->getNpar(); ++k) {
53 indices.at(k + _nParChip) = tempIndices.at(k);
54 }
55 }
56}
T at(T... args)
std::size_t getNpar() const override
Number of total parameters in this mapping.
T resize(T... args)
T size(T... args)

◆ getNpar()

std::size_t lsst::jointcal::ChipVisitPhotometryMapping::getNpar ( ) const
inlineoverridevirtualinherited

Number of total parameters in this mapping.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 230 of file PhotometryMapping.h.

230{ return _nParChip + _nParVisit; }

◆ getNParChip()

std::size_t lsst::jointcal::ChipVisitPhotometryMapping::getNParChip ( ) const
inlineinherited

Definition at line 278 of file PhotometryMapping.h.

278{ return _nParChip; }

◆ getNParVisit()

std::size_t lsst::jointcal::ChipVisitPhotometryMapping::getNParVisit ( ) const
inlineinherited

Definition at line 279 of file PhotometryMapping.h.

279{ return _nParVisit; }

◆ getParameters()

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

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 246 of file PhotometryMapping.h.

246 {
247 Eigen::VectorXd joined(getNpar());
248 joined << _chipMapping->getParameters(), _visitMapping->getParameters();
249 return joined;
250 }

◆ getVisitMapping()

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

Definition at line 276 of file PhotometryMapping.h.

276{ return _visitMapping; }

◆ isFixed()

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

Definition at line 102 of file PhotometryMapping.h.

◆ print()

void lsst::jointcal::ChipVisitPhotometryMapping::print ( std::ostream & out) const
inlineoverridevirtualinherited

Print a string representation of the contents of this mapping, for debugging.

This string representation can be very verbose, as it contains all of the parameters of all of the transforms in this mapping.

Implements lsst::jointcal::PhotometryMappingBase.

Definition at line 267 of file PhotometryMapping.h.

267 {
268 out << "index: " << index << std::endl;
269 out << "chip mapping: ";
270 _chipMapping->print(out);
271 out << std::endl << "visit mapping: ";
272 _visitMapping->print(out);
273 }
T endl(T... args)

◆ setFixed()

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

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

Definition at line 101 of file PhotometryMapping.h.

101{ fixed = _fixed; }

◆ setIndex()

void lsst::jointcal::PhotometryMappingBase::setIndex ( Eigen::Index i)
inlineinherited

Set the index of this mapping in the grand fit.

Definition at line 124 of file PhotometryMapping.h.

124{ index = i; }

◆ setWhatToFit()

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

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

58 {
59 if (fittingChips) {
60 _nParChip = _chipMapping->getNpar();
61 } else {
62 _nParChip = 0;
63 }
64 if (fittingVisits) {
65 _nParVisit = _visitMapping->getNpar();
66 } else {
67 _nParVisit = 0;
68 }
69}

◆ transform()

double lsst::jointcal::ChipVisitPhotometryMapping::transform ( MeasuredStar const & measuredStar,
double value ) const
inlineoverridevirtualinherited

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

233 {
234 double temp = _chipMapping->getTransform()->transform(measuredStar.x, measuredStar.y, value);
235 return _visitMapping->getTransform()->transform(measuredStar.getXFocal(), measuredStar.getYFocal(),
236 temp);
237 }

◆ transformError()

double lsst::jointcal::ChipVisitFluxMapping::transformError ( MeasuredStar const & measuredStar,
double value,
double valueErr ) const
overridevirtual

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

Matches the underlying PhotometryTransform'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 73 of file PhotometryMapping.cc.

74 {
75 // The transformed error is s_m = dM(f,x,y)/df + s_f.
76 double tempFlux =
77 _chipMapping->getTransformErrors()->transform(measuredStar.x, measuredStar.y, instFluxErr);
78 return _visitMapping->getTransformErrors()->transform(measuredStar.getXFocal(), measuredStar.getYFocal(),
79 tempFlux);
80}

Member Data Documentation

◆ _chipMapping

std::shared_ptr<PhotometryMapping> lsst::jointcal::ChipVisitPhotometryMapping::_chipMapping
protectedinherited

Definition at line 286 of file PhotometryMapping.h.

◆ _nParChip

std::size_t lsst::jointcal::ChipVisitPhotometryMapping::_nParChip
protectedinherited

Definition at line 283 of file PhotometryMapping.h.

◆ _nParVisit

std::size_t lsst::jointcal::ChipVisitPhotometryMapping::_nParVisit
protectedinherited

Definition at line 283 of file PhotometryMapping.h.

◆ _visitMapping

std::shared_ptr<PhotometryMapping> lsst::jointcal::ChipVisitPhotometryMapping::_visitMapping
protectedinherited

Definition at line 287 of file PhotometryMapping.h.

◆ fixed

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

Definition at line 130 of file PhotometryMapping.h.

◆ index

Eigen::Index lsst::jointcal::PhotometryMappingBase::index
protectedinherited

Definition at line 128 of file PhotometryMapping.h.


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