lsst.jointcal g043fd6e71d+ac1b31c4de
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Friends | List of all members
lsst::jointcal::BaseStar Class Reference

The base class for handling stars. Used by all matching routines. More...

#include <BaseStar.h>

Inheritance diagram for lsst::jointcal::BaseStar:
lsst::jointcal::FatPoint lsst::jointcal::Point lsst::jointcal::FittedStar lsst::jointcal::MeasuredStar lsst::jointcal::RefStar

Public Member Functions

 BaseStar ()
 
 BaseStar (double xx, double yy, double flux, double fluxErr)
 constructor
 
 BaseStar (Point const &point, double flux, double fluxErr, double mag, double magErr)
 
double getX () const
 access stuff.
 
double getY () const
 
virtual void print (std::ostream &out) const
 
BaseStaroperator= (Point const &point)
 
virtual ~BaseStar ()=default
 
double getFlux () const
 
doublegetFlux ()
 
void setFlux (double flux)
 
double getFluxErr () const
 
void setFluxErr (double fluxErr)
 
double getMag () const
 
doublegetMag ()
 
double getMagErr () const
 
void setMagErr (double magErr)
 
double Distance (const Point &other) const
 

 
double computeDist2 (const Point &other) const
 distance squared to other
 
Point operator+ (const Point &Right) const
 Sum.
 
Point operator- (const Point &Right) const
 Difference.
 

Static Public Member Functions

static const chartypeName ()
 

Public Attributes

double vx
 
double vy
 
double vxy
 
double x
 coordinate
 
double y
 

Protected Attributes

double _flux
 
double _fluxErr {}
 
double _mag {}
 
double _magErr {}
 

Friends

std::ostreamoperator<< (std::ostream &stream, BaseStar const &s)
 allows std::cout << aBaseStar;
 

Detailed Description

The base class for handling stars. Used by all matching routines.

Definition at line 51 of file BaseStar.h.

Constructor & Destructor Documentation

◆ BaseStar() [1/3]

lsst::jointcal::BaseStar::BaseStar ( )
inline

Definition at line 53 of file BaseStar.h.

◆ BaseStar() [2/3]

lsst::jointcal::BaseStar::BaseStar ( double  xx,
double  yy,
double  flux,
double  fluxErr 
)
inline

constructor

Definition at line 59 of file BaseStar.h.

◆ BaseStar() [3/3]

lsst::jointcal::BaseStar::BaseStar ( Point const point,
double  flux,
double  fluxErr,
double  mag,
double  magErr 
)
inline

Definition at line 65 of file BaseStar.h.

◆ ~BaseStar()

virtual lsst::jointcal::BaseStar::~BaseStar ( )
virtualdefault

Member Function Documentation

◆ computeDist2()

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

distance squared to other

Definition at line 56 of file Point.h.

◆ Distance()

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

Definition at line 51 of file Point.h.

◆ getFlux() [1/2]

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

Definition at line 99 of file BaseStar.h.

◆ getFlux() [2/2]

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

Definition at line 98 of file BaseStar.h.

◆ getFluxErr()

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

Definition at line 102 of file BaseStar.h.

◆ getMag() [1/2]

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

Definition at line 106 of file BaseStar.h.

◆ getMag() [2/2]

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

Definition at line 105 of file BaseStar.h.

◆ getMagErr()

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

Definition at line 108 of file BaseStar.h.

◆ getX()

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

access stuff.

Definition at line 73 of file BaseStar.h.

◆ getY()

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

Definition at line 75 of file BaseStar.h.

◆ operator+()

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

Sum.

Definition at line 61 of file Point.h.

◆ operator-()

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

Difference.

Definition at line 64 of file Point.h.

◆ operator=()

BaseStar & lsst::jointcal::BaseStar::operator= ( Point const point)
inline

Definition at line 88 of file BaseStar.h.

◆ print()

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

Reimplemented from lsst::jointcal::Point.

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

Definition at line 83 of file BaseStar.h.

◆ setFlux()

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

Definition at line 100 of file BaseStar.h.

◆ setFluxErr()

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

Definition at line 103 of file BaseStar.h.

◆ setMagErr()

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

Definition at line 109 of file BaseStar.h.

◆ typeName()

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

Definition at line 94 of file BaseStar.h.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream stream,
BaseStar const s 
)
friend

allows std::cout << aBaseStar;

Definition at line 78 of file BaseStar.h.

Member Data Documentation

◆ _flux

double lsst::jointcal::BaseStar::_flux
protected

Definition at line 113 of file BaseStar.h.

◆ _fluxErr

double lsst::jointcal::BaseStar::_fluxErr {}
protected

Definition at line 114 of file BaseStar.h.

◆ _mag

double lsst::jointcal::BaseStar::_mag {}
protected

Definition at line 117 of file BaseStar.h.

◆ _magErr

double lsst::jointcal::BaseStar::_magErr {}
protected

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 file: