lsst.jointcal  19.0.0-6-gce3e386+3
Public Member Functions | Public Attributes | List of all members
lsst::jointcal::StarMatchList Class Reference

#include <StarMatch.h>

Inheritance diagram for lsst::jointcal::StarMatchList:
std::list< StarMatch >

Public Member Functions

void refineTransform (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 applyTransform (StarMatchList &transformed, const AstrometryTransform *priorTransform, const AstrometryTransform *posteriorTransform=nullptr) const
 enables to get a transformed StarMatchList. More...
 
 StarMatchList ()
 
std::shared_ptr< const AstrometryTransformgetTransform () const
 carries out a fit with outlier rejection More...
 
double getDist2 () const
 access to the sum of squared residuals of the last call to refineTransform. More...
 
double getChi2 () const
 access to the chi2 of the last call to refineTransform. More...
 
int getTransformOrder () const
 returns the order of the used transform 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 refineTransform) More...
 
unsigned removeAmbiguities (const AstrometryTransform &transform, int which=3)
 cleans up the std::list of pairs for pairs that share one of their stars, keeping the closest one. More...
 
void setTransform (const AstrometryTransform *transform)
 sets a transform between the 2 std::lists and deletes the previous or default one. No fit. More...
 
void setTransform (const AstrometryTransform &transform)
 
void setTransform (std::shared_ptr< AstrometryTransform > transform)
 
void setTransformOrder (int order)
 set transform according to the given order. More...
 
std::unique_ptr< AstrometryTransforminverseTransform ()
 returns the inverse transform (swap, fit(refineTransform) , and swap). More...
 
void setDistance (const AstrometryTransform &transform)
 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 printTransform (std::ostream &stream=std::cout) const
 print the matching transformation quality (transform, chi2, residual) More...
 
 ~StarMatchList ()
 
StarMatch pop_front (StarMatch ... args)
 
StarMatch push_back (StarMatch ... args)
 
StarMatch splice (StarMatch ... args)
 
StarMatch crbegin (StarMatch ... args)
 
StarMatch erase (StarMatch ... args)
 
StarMatch emplace_front (StarMatch ... args)
 
StarMatch insert (StarMatch ... args)
 
StarMatch reverse (StarMatch ... args)
 
StarMatch back (StarMatch ... args)
 
StarMatch end (StarMatch ... args)
 
StarMatch remove (StarMatch ... args)
 
StarMatch emplace_back (StarMatch ... args)
 
StarMatch pop_back (StarMatch ... args)
 
StarMatch cbegin (StarMatch ... args)
 
StarMatch front (StarMatch ... args)
 
StarMatch unique (StarMatch ... args)
 
StarMatch size (StarMatch ... args)
 
StarMatch resize (StarMatch ... args)
 
StarMatch push_front (StarMatch ... args)
 
StarMatch rbegin (StarMatch ... args)
 
StarMatch crend (StarMatch ... args)
 
StarMatch assign (StarMatch ... args)
 
StarMatch sort (StarMatch ... args)
 
StarMatch merge (StarMatch ... args)
 
StarMatch empty (StarMatch ... args)
 
StarMatch remove_if (StarMatch ... args)
 
StarMatch cend (StarMatch ... args)
 
StarMatch swap (StarMatch ... args)
 
StarMatch max_size (StarMatch ... args)
 
StarMatch rend (StarMatch ... args)
 
StarMatch get_allocator (StarMatch ... args)
 
StarMatch clear (StarMatch ... args)
 
StarMatch emplace (StarMatch ... args)
 
StarMatch begin (StarMatch ... args)
 

Public Attributes

StarMatch elements
 STL member. More...
 

Detailed Description

Definition at line 149 of file StarMatch.h.

Constructor & Destructor Documentation

◆ StarMatchList()

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

Definition at line 159 of file StarMatch.h.

◆ ~StarMatchList()

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

Definition at line 211 of file StarMatch.h.

Member Function Documentation

◆ applyTransform()

void lsst::jointcal::StarMatchList::applyTransform ( StarMatchList transformed,
const AstrometryTransform priorTransform,
const AstrometryTransform posteriorTransform = nullptr 
) const

enables to get a transformed StarMatchList.

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

Definition at line 214 of file StarMatch.cc.

◆ computeResidual()

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

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

Definition at line 136 of file StarMatch.cc.

◆ cutTail()

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

deletes the tail of the match std::list

Definition at line 191 of file StarMatch.cc.

◆ getChi2()

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

access to the chi2 of the last call to refineTransform.

Definition at line 170 of file StarMatch.h.

◆ getDist2()

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

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

Definition at line 167 of file StarMatch.h.

◆ getTransform()

std::shared_ptr<const AstrometryTransform> lsst::jointcal::StarMatchList::getTransform ( ) const
inline

carries out a fit with outlier rejection

enables to access the fitted transformation.

Definition at line 164 of file StarMatch.h.

◆ getTransformOrder()

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

returns the order of the used transform

Definition at line 173 of file StarMatch.h.

◆ inverseTransform()

std::unique_ptr< AstrometryTransform > lsst::jointcal::StarMatchList::inverseTransform ( )

returns the inverse transform (swap, fit(refineTransform) , and swap).

The caller should delete the returned pointer.

Definition at line 174 of file StarMatch.cc.

◆ printTransform()

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

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

Definition at line 230 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 205 of file StarMatch.cc.

◆ refineTransform()

void lsst::jointcal::StarMatchList::refineTransform ( 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 transform is not assigned, it will be set to a AstrometryTransformLinearear. User can set an other type/order using setTransform() before call.

Definition at line 94 of file StarMatch.cc.

◆ removeAmbiguities()

unsigned lsst::jointcal::StarMatchList::removeAmbiguities ( const AstrometryTransform transform,
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 transform. which = 1 (2) removes ambiguities on the first (second) term of the match. which=3 does both.

Definition at line 145 of file StarMatch.cc.

◆ setDistance()

void lsst::jointcal::StarMatchList::setDistance ( const AstrometryTransform transform)

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

Definition at line 141 of file StarMatch.cc.

◆ setTransform() [1/3]

void lsst::jointcal::StarMatchList::setTransform ( const AstrometryTransform transform)
inline

Definition at line 189 of file StarMatch.h.

◆ setTransform() [2/3]

void lsst::jointcal::StarMatchList::setTransform ( const AstrometryTransform transform)
inline

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

Definition at line 187 of file StarMatch.h.

◆ setTransform() [3/3]

void lsst::jointcal::StarMatchList::setTransform ( std::shared_ptr< AstrometryTransform transform)
inline

Definition at line 190 of file StarMatch.h.

◆ setTransformOrder()

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

set transform according to the given order.

Definition at line 160 of file StarMatch.cc.

◆ swap()

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

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

Definition at line 199 of file StarMatch.cc.

Member Data Documentation

◆ elements

StarMatch std::list< StarMatch >::elements
inherited

STL member.


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