lsst.jointcal g47fe537ac6+42c45a23ae
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Friends | List of all members
lsst::jointcal::StarMatch Class Reference

A hanger for star associations. More...

#include <StarMatch.h>

Public Member Functions

 StarMatch (FatPoint point1, FatPoint point2, std::shared_ptr< const BaseStar > star1, std::shared_ptr< const BaseStar > star2)
 constructor. More...
 
double computeDistance (const AstrometryTransform &transform) const
 returns the distance from transform(point1) to point2. More...
 
double computeChi2 (const AstrometryTransform &transform) const
 returns the chi2 (using errors in the FatPoint's) More...
 
void setDistance (const AstrometryTransform &transform)
 to be used before sorting on distances. More...
 
double getDistance () const
 returns the value computed by the above one. More...
 
void swap ()
 
 StarMatch ()=default
 
 ~StarMatch ()=default
 

Public Attributes

FatPoint point1
 
FatPoint point2
 2 points More...
 
std::shared_ptr< const BaseStars1
 
std::shared_ptr< const BaseStars2
 
double distance {}
 
double chi2 {}
 

Friends

class StarMatchList
 
std::ostreamoperator<< (std::ostream &stream, const StarMatch &Match)
 
bool compareStar1 (const StarMatch &one, const StarMatch &two)
 
bool sameStar1 (const StarMatch &one, const StarMatch &two)
 
bool compareStar2 (const StarMatch &one, const StarMatch &two)
 
bool sameStar2 (const StarMatch &one, const StarMatch &two)
 

Detailed Description

A hanger for star associations.

Definition at line 55 of file StarMatch.h.

Constructor & Destructor Documentation

◆ StarMatch() [1/2]

lsst::jointcal::StarMatch::StarMatch ( FatPoint  point1,
FatPoint  point2,
std::shared_ptr< const BaseStar star1,
std::shared_ptr< const BaseStar star2 
)
inline

constructor.

gives 2 points (that contain the geometry), plus pointers to the Star objects (which are there for user convenience).

Definition at line 70 of file StarMatch.h.

◆ StarMatch() [2/2]

lsst::jointcal::StarMatch::StarMatch ( )
explicitdefault

◆ ~StarMatch()

lsst::jointcal::StarMatch::~StarMatch ( )
default

Member Function Documentation

◆ computeChi2()

double lsst::jointcal::StarMatch::computeChi2 ( const AstrometryTransform transform) const

returns the chi2 (using errors in the FatPoint's)

Definition at line 43 of file StarMatch.cc.

◆ computeDistance()

double lsst::jointcal::StarMatch::computeDistance ( const AstrometryTransform transform) const
inline

returns the distance from transform(point1) to point2.

Definition at line 78 of file StarMatch.h.

◆ getDistance()

double lsst::jointcal::StarMatch::getDistance ( ) const
inline

returns the value computed by the above one.

Definition at line 88 of file StarMatch.h.

◆ setDistance()

void lsst::jointcal::StarMatch::setDistance ( const AstrometryTransform transform)
inline

to be used before sorting on distances.

Definition at line 86 of file StarMatch.h.

◆ swap()

void lsst::jointcal::StarMatch::swap ( )
inline

Definition at line 90 of file StarMatch.h.

Friends And Related Function Documentation

◆ compareStar1

bool compareStar1 ( const StarMatch one,
const StarMatch two 
)
friend

Definition at line 116 of file StarMatch.h.

◆ compareStar2

bool compareStar2 ( const StarMatch one,
const StarMatch two 
)
friend

Definition at line 122 of file StarMatch.h.

◆ operator<<

std::ostream & operator<< ( std::ostream stream,
const StarMatch Match 
)
friend

Definition at line 55 of file StarMatch.cc.

◆ sameStar1

bool sameStar1 ( const StarMatch one,
const StarMatch two 
)
friend

Definition at line 120 of file StarMatch.h.

◆ sameStar2

bool sameStar2 ( const StarMatch one,
const StarMatch two 
)
friend

Definition at line 126 of file StarMatch.h.

◆ StarMatchList

friend class StarMatchList
friend

Definition at line 56 of file StarMatch.h.

Member Data Documentation

◆ chi2

double lsst::jointcal::StarMatch::chi2 {}

Definition at line 65 of file StarMatch.h.

◆ distance

double lsst::jointcal::StarMatch::distance {}

Definition at line 64 of file StarMatch.h.

◆ point1

FatPoint lsst::jointcal::StarMatch::point1

Definition at line 61 of file StarMatch.h.

◆ point2

FatPoint lsst::jointcal::StarMatch::point2

2 points

the Star pointers (the pointer is in fact generic, pointed data is never used).

Definition at line 61 of file StarMatch.h.

◆ s1

std::shared_ptr<const BaseStar> lsst::jointcal::StarMatch::s1

Definition at line 63 of file StarMatch.h.

◆ s2

std::shared_ptr<const BaseStar> lsst::jointcal::StarMatch::s2

Definition at line 63 of file StarMatch.h.


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