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

#include <BaseStar.h>

Inheritance diagram for lsst::jointcal::BaseStar:

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

BaseStar &	operator= (Point const &point)

virtual	~BaseStar ()=default

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


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 char *	typeName ()

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::ostream &	operator<< (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.

               {
        x = 0;
        y = 0;
        _flux = 0;
    };

◆ 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.

            : FatPoint(xx, yy),
              _flux(flux),
              _fluxErr(fluxErr),
              _mag(utils::nanojanskyToABMagnitude(flux)),
              _magErr(magErrFromFluxErr(flux, fluxErr)){};

◆ 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.

            : FatPoint(point),
              _flux(flux),
              _fluxErr(fluxErr),
              _mag(utils::nanojanskyToABMagnitude(flux)),
              _magErr(magErrFromFluxErr(flux, fluxErr)){};

◆ ~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.

                                                  {
        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 ( )

inline

Definition at line 99 of file BaseStar.h.

99{ return _flux; }

◆ getFlux() [2/2]

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

inline

Definition at line 98 of file BaseStar.h.

98{ return _flux; }

◆ getFluxErr()

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

inline

Definition at line 102 of file BaseStar.h.

102{ return _fluxErr; }

◆ getMag() [1/2]

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

inline

Definition at line 106 of file BaseStar.h.

106{ return _mag; }

◆ getMag() [2/2]

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

inline

Definition at line 105 of file BaseStar.h.

105{ return _mag; }

◆ getMagErr()

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

inline

Definition at line 108 of file BaseStar.h.

108{ return _magErr; }

◆ getX()

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

inline

access stuff.

Definition at line 73 of file BaseStar.h.

73{ return x; }

◆ getY()

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

inline

Definition at line 75 of file BaseStar.h.

75{ return y; }

◆ operator+()

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

inlineinherited

Sum.

Definition at line 61 of file Point.h.

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

lsst::jointcal::Point::Point

Point()

Definition Point.h:45

◆ operator-()

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

inlineinherited

Difference.

Definition at line 64 of file Point.h.

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

◆ operator=()

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

inline

Definition at line 88 of file BaseStar.h.

                                            {
        x = point.x;
        y = point.y;
        return (*this);
    };

◆ 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.

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

◆ setFlux()

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

inline

Definition at line 100 of file BaseStar.h.

100{ _flux = flux; }

◆ setFluxErr()

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

inline

Definition at line 103 of file BaseStar.h.

103{ _fluxErr = fluxErr; }

◆ setMagErr()

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

inline

Definition at line 109 of file BaseStar.h.

109{ _magErr = magErr; }

◆ typeName()

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

inlinestatic

Definition at line 94 of file BaseStar.h.

94{ return "BaseStar"; }

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.

                                                                         {
        s.print(stream);
        return stream;
    }

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.

114{};

◆ _mag

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

protected

Definition at line 117 of file BaseStar.h.

117{};

◆ _magErr

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

protected

Definition at line 118 of file BaseStar.h.

118{};

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/jointcal/gbb8dafda3b+69d3c0e320/include/lsst/jointcal/BaseStar.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BaseStar() [1/3]

◆ BaseStar() [2/3]

◆ BaseStar() [3/3]

◆ ~BaseStar()

Member Function Documentation

◆ computeDist2()

◆ Distance()

◆ getFlux() [1/2]

◆ getFlux() [2/2]

◆ getFluxErr()

◆ getMag() [1/2]

◆ getMag() [2/2]

◆ getMagErr()

◆ getX()

◆ getY()

◆ operator+()

◆ operator-()

◆ operator=()

◆ print()

◆ setFlux()

◆ setFluxErr()

◆ setMagErr()

◆ typeName()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ _flux

◆ _fluxErr

◆ _mag

◆ _magErr

◆ vx

◆ vxy

◆ vy

◆ x

◆ y