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 BaseStar >	s1
std::shared_ptr< const BaseStar >	s2
double	distance {}
double	chi2 {}

Friends
class	StarMatchList
std::ostream &	operator<< (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.

            : point1(std::move(point1)), point2(std::move(point2)), s1(std::move(star1)), s2(std::move(star2)), distance(0.){};

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.

                                                                        {
    FatPoint tr;
    transform.transformPosAndErrors(point1, tr);
    double vxx = tr.vx + point2.vx;
    double vyy = tr.vy + point2.vy;
    double vxy = tr.vxy + point2.vxy;
    double det = vxx * vyy - vxy * vxy;
    return (vyy * sq(tr.x - point2.x) + vxx * sq(tr.y - point2.y) -
            2 * vxy * (tr.x - point2.x) * (tr.y - point2.y)) /
           det;
}

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.

                                                                       {
        return point2.Distance(transform.apply(point1));
    };

getDistance()

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

inline

returns the value computed by the above one.

Definition at line 88 of file StarMatch.h.

{ return distance; }

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.

{ distance = computeDistance(transform); };

swap()

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

inline

Definition at line 90 of file StarMatch.h.

                {
        std::swap(point1, point2);
        std::swap(s1, s2);
    }

Friends And Related Function Documentation

compareStar1

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

friend

Definition at line 116 of file StarMatch.h.

                                                                     {
    return ((one.s1 == two.s1) ? (one.distance < two.distance) : (&(*one.s1) > &(*two.s1)));
}

compareStar2

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

friend

Definition at line 122 of file StarMatch.h.

                                                                     {
    return ((one.s2 == two.s2) ? (one.distance < two.distance) : (&(*one.s2) > &(*two.s2)));
}

operator<<

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

friend

Definition at line 55 of file StarMatch.cc.

                                                                   {
    stream << match.point1.x << ' ' << match.point1.y << ' ' << match.point2.x << ' ' << match.point2.y << ' '
           << match.distance << std::endl;
    return stream;
}

sameStar1

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

friend

Definition at line 120 of file StarMatch.h.

{ return (one.s1 == two.s1); }

sameStar2

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

friend

Definition at line 126 of file StarMatch.h.

{ return (one.s2 == two.s2); }

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-4.0.1/Linux64/jointcal/ge2d134c3d5+cc4dbb2e3f/include/lsst/jointcal/StarMatch.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-4.0.1/Linux64/jointcal/ge2d134c3d5+cc4dbb2e3f/src/StarMatch.cc