lsst::jointcal::RefStar Class Reference

Objects used as position/flux anchors (e.g. More...

#include <RefStar.h>

Inheritance diagram for lsst::jointcal::RefStar:

Public Member Functions
	RefStar (double xx, double yy, double flux, double fluxErr)
	RefStar (RefStar const &)=delete
	No copy: each RefStar is unique, and should be accessed/managed via shared_ptr. More...
	RefStar (RefStar &&)=default
RefStar &	operator= (RefStar const &)=delete
RefStar &	operator= (RefStar &&)=default
void	setProperMotion (ProperMotion const &properMotion)
void	setProperMotion (std::unique_ptr< ProperMotion const > &&properMotion)
Point	applyProperMotion (Point star, double timeDeltaYears) const
	Apply proper motion correction to the input star, returning a star with PM-corrected coordinates and coordinate errors. More...
double	getX () const
	access stuff. More...
double	getY () const
virtual void	print (std::ostream &out) const
double	getFlux () const
double &	getFlux ()
void	setFlux (double flux)
double	getFluxErr () const
void	setFluxErr (double fluxErr)
double	getMag () const
double &	getMag ()
double	getMagErr () const
void	setMagErr (double magErr)
double	Distance (const Point &other) const
	More...
double	computeDist2 (const Point &other) const
	distance squared to other More...
Point	operator+ (const Point &Right) const
	Sum. More...
Point	operator- (const Point &Right) const
	Difference. More...

Static Public Member Functions
static const char *	typeName ()

Public Attributes
double	vx
double	vy
double	vxy
double	x
	coordinate More...
double	y

Protected Attributes
double	_flux
double	_fluxErr
double	_mag
double	_magErr

Detailed Description

Objects used as position/flux anchors (e.g.

Gaia DR2 stars). Coordinate system should match that of the fittedStars these are associated with; typically the common tangent plane.

RefStars should have their proper motion and parallax corrections pre-applied, so that they are at the same epoch as is stored in Associations.

Definition at line 45 of file RefStar.h.

Constructor & Destructor Documentation

RefStar() [1/3]

lsst::jointcal::RefStar::RefStar ( double  xx, double  yy, double  flux, double  fluxErr  )

inline

Definition at line 47 of file RefStar.h.

: BaseStar(xx, yy, flux, fluxErr) {}

RefStar() [2/3]

lsst::jointcal::RefStar::RefStar ( RefStar const &  )

delete

No copy: each RefStar is unique, and should be accessed/managed via shared_ptr.

RefStar() [3/3]

lsst::jointcal::RefStar::RefStar ( RefStar &&  )

default

Member Function Documentation

applyProperMotion()

Point lsst::jointcal::RefStar::applyProperMotion	(	Point	star,
		double	timeDeltaYears
	)		const

Apply proper motion correction to the input star, returning a star with PM-corrected coordinates and coordinate errors.

Star is returned unchanged if no proper motion data is available.

Parameters

star	The star to correct for this proper motion.
timeDeltaYears	The difference in time from the correction epoch to correct for, in years.

Returns

The star with corrected coordinates.

Definition at line 34 of file RefStar.cc.

                                                                        {
    if (!_properMotion) {
        return star;
    } else {
        return _properMotion->apply(star, timeDeltaYears);
    }
}

computeDist2()

double lsst::jointcal::Point::computeDist2 ( const Point &  other ) const

inlineinherited

distance squared to other

Definition at line 56 of file Point.h.

                                                  {
        return ((x - other.x) * (x - other.x) + (y - other.y) * (y - other.y));
    };

Distance()

double lsst::jointcal::Point::Distance ( const Point &  other ) const

inlineinherited

Definition at line 51 of file Point.h.

                                              {
        return sqrt((x - other.x) * (x - other.x) + (y - other.y) * (y - other.y));
    };

getFlux() [1/2]

double& lsst::jointcal::BaseStar::getFlux ( )

inlineinherited

Definition at line 99 of file BaseStar.h.

{ return _flux; }

getFlux() [2/2]

double lsst::jointcal::BaseStar::getFlux ( ) const

inlineinherited

Definition at line 98 of file BaseStar.h.

{ return _flux; }

getFluxErr()

double lsst::jointcal::BaseStar::getFluxErr ( ) const

inlineinherited

Definition at line 102 of file BaseStar.h.

{ return _fluxErr; }

getMag() [1/2]

double& lsst::jointcal::BaseStar::getMag ( )

inlineinherited

Definition at line 106 of file BaseStar.h.

{ return _mag; }

getMag() [2/2]

double lsst::jointcal::BaseStar::getMag ( ) const

inlineinherited

Definition at line 105 of file BaseStar.h.

{ return _mag; }

getMagErr()

double lsst::jointcal::BaseStar::getMagErr ( ) const

inlineinherited

Definition at line 108 of file BaseStar.h.

{ return _magErr; }

getX()

double lsst::jointcal::BaseStar::getX ( ) const

inlineinherited

access stuff.

Definition at line 73 of file BaseStar.h.

{ return x; }

getY()

double lsst::jointcal::BaseStar::getY ( ) const

inlineinherited

Definition at line 75 of file BaseStar.h.

{ return y; }

operator+()

Point lsst::jointcal::Point::operator+ ( const Point &  Right ) const

inlineinherited

Sum.

Definition at line 61 of file Point.h.

{ return Point(x + Right.x, y + Right.y); }

operator-()

Point lsst::jointcal::Point::operator- ( const Point &  Right ) const

inlineinherited

Difference.

Definition at line 64 of file Point.h.

{ return Point(x - Right.x, y - Right.y); }

operator=() [1/2]

RefStar& lsst::jointcal::RefStar::operator= ( RefStar &&  )

default

operator=() [2/2]

RefStar& lsst::jointcal::RefStar::operator= ( RefStar const &  )

delete

print()

virtual void lsst::jointcal::BaseStar::print ( std::ostream &  out ) const

inlinevirtualinherited

Reimplemented from lsst::jointcal::Point.

Reimplemented in lsst::jointcal::FittedStar, and lsst::jointcal::MeasuredStar.

Definition at line 83 of file BaseStar.h.

                                              {
        FatPoint::print(out);
        out << " flux: " << std::setprecision(9) << _flux << " fluxErr: " << _fluxErr;
    }

setFlux()

void lsst::jointcal::BaseStar::setFlux ( double  flux )

inlineinherited

Definition at line 100 of file BaseStar.h.

{ _flux = flux; }

setFluxErr()

void lsst::jointcal::BaseStar::setFluxErr ( double  fluxErr )

inlineinherited

Definition at line 103 of file BaseStar.h.

{ _fluxErr = fluxErr; }

setMagErr()

void lsst::jointcal::BaseStar::setMagErr ( double  magErr )

inlineinherited

Definition at line 109 of file BaseStar.h.

{ _magErr = magErr; }

setProperMotion() [1/2]

void lsst::jointcal::RefStar::setProperMotion ( ProperMotion const &  properMotion )

inline

Definition at line 56 of file RefStar.h.

                                                           {
        _properMotion = std::make_unique<ProperMotion>(properMotion);
    }

setProperMotion() [2/2]

void lsst::jointcal::RefStar::setProperMotion ( std::unique_ptr< ProperMotion const > &&  properMotion )

inline

Definition at line 59 of file RefStar.h.

                                                                           {
        _properMotion = std::move(properMotion);
    }

typeName()

static const char* lsst::jointcal::BaseStar::typeName ( )

inlinestaticinherited

Definition at line 94 of file BaseStar.h.

{ return "BaseStar"; }

Member Data Documentation

_flux

double lsst::jointcal::BaseStar::_flux

protectedinherited

Definition at line 113 of file BaseStar.h.

_fluxErr

double lsst::jointcal::BaseStar::_fluxErr

protectedinherited

Definition at line 114 of file BaseStar.h.

_mag

double lsst::jointcal::BaseStar::_mag

protectedinherited

Definition at line 117 of file BaseStar.h.

_magErr

double lsst::jointcal::BaseStar::_magErr

protectedinherited

Definition at line 118 of file BaseStar.h.

vx

double lsst::jointcal::FatPoint::vx

inherited

Definition at line 36 of file FatPoint.h.

vxy

double lsst::jointcal::FatPoint::vxy

inherited

Definition at line 36 of file FatPoint.h.

vy

double lsst::jointcal::FatPoint::vy

inherited

Definition at line 36 of file FatPoint.h.

x

double lsst::jointcal::Point::x

inherited

coordinate

Definition at line 42 of file Point.h.

y

double lsst::jointcal::Point::y

inherited

Definition at line 42 of file Point.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/jointcal/22.0.1-25-g5bf6245+3ad8ecd50b/include/lsst/jointcal/RefStar.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/jointcal/22.0.1-25-g5bf6245+3ad8ecd50b/src/RefStar.cc