lsst.jointcal  master-g52a623bc1f+3
Public Member Functions | Public Attributes | List of all members
lsst::jointcal::StarMatchList Class Reference

#include <StarMatch.h>

Inheritance diagram for lsst::jointcal::StarMatchList:

Public Member Functions

void refineTransfo (double nSigmas)
 removes pairs beyond nSigmas in distance (where the sigma scale is set by the fit) and iterates until stabilization of the number of pairs. More...
 
void applyTransfo (StarMatchList &transformed, const Gtransfo *priorTransfo, const Gtransfo *posteriorTransfo=nullptr) const
 enables to get a transformed StarMatchList. More...
 
 StarMatchList ()
 
std::shared_ptr< const GtransfogetTransfo () const
 carries out a fit with outlier rejection More...
 
double getDist2 () const
 access to the sum of squared residuals of the last call to refineTransfo. More...
 
double getChi2 () const
 access to the chi2 of the last call to refineTransfo. More...
 
int getTransfoOrder () const
 returns the order of the used transfo More...
 
void swap ()
 swaps elements 1 and 2 of each starmatch in std::list. More...
 
double computeResidual () const
 returns the average 1d Residual (last call to refineTransfo) More...
 
unsigned removeAmbiguities (const Gtransfo &gtransfo, int which=3)
 cleans up the std::list of pairs for pairs that share one of their stars, keeping the closest one. More...
 
void setTransfo (const Gtransfo *gtransfo)
 sets a transfo between the 2 std::lists and deletes the previous or default one. No fit. More...
 
void setTransfo (const Gtransfo &gtransfo)
 
void setTransfo (std::shared_ptr< Gtransfo > gtransfo)
 
void setTransfoOrder (int order)
 set transfo according to the given order. More...
 
std::unique_ptr< GtransfoinverseTransfo ()
 returns the inverse transfo (swap, fit(refineTransfo) , and swap). More...
 
void setDistance (const Gtransfo &gtransfo)
 Sets the distance (residual) field of all std::list elements. Mandatory before sorting on distances. More...
 
void cutTail (int nKeep)
 deletes the tail of the match std::list More...
 
int recoveredNumber (double mindist) const
 count the number of elements for which distance is < mindist More...
 
void dumpTransfo (std::ostream &stream=std::cout) const
 print the matching transformation quality (transfo, chi2, residual) More...
 
 ~StarMatchList ()
 

Public Attributes

elements
 STL member. More...
 

Detailed Description

Definition at line 127 of file StarMatch.h.

Constructor & Destructor Documentation

◆ StarMatchList()

lsst::jointcal::StarMatchList::StarMatchList ( )
inline

Definition at line 143 of file StarMatch.h.

◆ ~StarMatchList()

lsst::jointcal::StarMatchList::~StarMatchList ( )
inline

Definition at line 195 of file StarMatch.h.

Member Function Documentation

◆ applyTransfo()

void lsst::jointcal::StarMatchList::applyTransfo ( StarMatchList transformed,
const Gtransfo priorTransfo,
const Gtransfo posteriorTransfo = nullptr 
) const

enables to get a transformed StarMatchList.

Only positions are transformed, not attached stars. const routine: "this" remains unchanged.

Definition at line 187 of file StarMatch.cc.

◆ computeResidual()

double lsst::jointcal::StarMatchList::computeResidual ( ) const

returns the average 1d Residual (last call to refineTransfo)

Definition at line 109 of file StarMatch.cc.

◆ cutTail()

void lsst::jointcal::StarMatchList::cutTail ( int  nKeep)

deletes the tail of the match std::list

Definition at line 164 of file StarMatch.cc.

◆ dumpTransfo()

void lsst::jointcal::StarMatchList::dumpTransfo ( std::ostream &  stream = std::cout) const

print the matching transformation quality (transfo, chi2, residual)

Definition at line 203 of file StarMatch.cc.

◆ getChi2()

double lsst::jointcal::StarMatchList::getChi2 ( ) const
inline

access to the chi2 of the last call to refineTransfo.

Definition at line 154 of file StarMatch.h.

◆ getDist2()

double lsst::jointcal::StarMatchList::getDist2 ( ) const
inline

access to the sum of squared residuals of the last call to refineTransfo.

Definition at line 151 of file StarMatch.h.

◆ getTransfo()

std::shared_ptr<const Gtransfo> lsst::jointcal::StarMatchList::getTransfo ( ) const
inline

carries out a fit with outlier rejection

enables to access the fitted transformation.

Definition at line 148 of file StarMatch.h.

◆ getTransfoOrder()

int lsst::jointcal::StarMatchList::getTransfoOrder ( ) const
inline

returns the order of the used transfo

Definition at line 157 of file StarMatch.h.

◆ inverseTransfo()

std::unique_ptr< Gtransfo > lsst::jointcal::StarMatchList::inverseTransfo ( )

returns the inverse transfo (swap, fit(refineTransfo) , and swap).

The caller should delete the returned pointer.

Definition at line 147 of file StarMatch.cc.

◆ recoveredNumber()

int lsst::jointcal::StarMatchList::recoveredNumber ( double  mindist) const

count the number of elements for which distance is < mindist

Definition at line 178 of file StarMatch.cc.

◆ refineTransfo()

void lsst::jointcal::StarMatchList::refineTransfo ( double  nSigmas)

removes pairs beyond nSigmas in distance (where the sigma scale is set by the fit) and iterates until stabilization of the number of pairs.

If the transfo is not assigned, it will be set to a GtransfoLinear. User can set an other type/degree using setTransfo() before call.

Definition at line 68 of file StarMatch.cc.

◆ removeAmbiguities()

unsigned lsst::jointcal::StarMatchList::removeAmbiguities ( const Gtransfo gtransfo,
int  which = 3 
)

cleans up the std::list of pairs for pairs that share one of their stars, keeping the closest one.

The distance is computed using gtransfo. which = 1 (2) removes ambiguities on the first (second) term of the match. which=3 does both.

Definition at line 118 of file StarMatch.cc.

◆ setDistance()

void lsst::jointcal::StarMatchList::setDistance ( const Gtransfo gtransfo)

Sets the distance (residual) field of all std::list elements. Mandatory before sorting on distances.

Definition at line 114 of file StarMatch.cc.

◆ setTransfo() [1/3]

void lsst::jointcal::StarMatchList::setTransfo ( const Gtransfo gtransfo)
inline

sets a transfo between the 2 std::lists and deletes the previous or default one. No fit.

Definition at line 171 of file StarMatch.h.

◆ setTransfo() [2/3]

void lsst::jointcal::StarMatchList::setTransfo ( const Gtransfo gtransfo)
inline

Definition at line 173 of file StarMatch.h.

◆ setTransfo() [3/3]

void lsst::jointcal::StarMatchList::setTransfo ( std::shared_ptr< Gtransfo gtransfo)
inline

Definition at line 174 of file StarMatch.h.

◆ setTransfoOrder()

void lsst::jointcal::StarMatchList::setTransfoOrder ( int  order)

set transfo according to the given order.

Definition at line 133 of file StarMatch.cc.

◆ swap()

void lsst::jointcal::StarMatchList::swap ( )

swaps elements 1 and 2 of each starmatch in std::list.

Definition at line 172 of file StarMatch.cc.

Member Data Documentation

◆ elements

T std::list< T >::elements
inherited

STL member.


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