lsst::jointcal::FittedStar Class Reference

FittedStars are objects whose position or flux is going to be fitted, and which come from the association of multiple MeasuredStars. More...

#include <FittedStar.h>

Inheritance diagram for lsst::jointcal::FittedStar:

Public Member Functions
	FittedStar ()
	FittedStar (const BaseStar &baseStar)
	FittedStar (const MeasuredStar &measuredStar)
	FittedStar (FittedStar const &)=default
	No move, allow copy constructor: we may copy the fitted StarLists when associating and matching catalogs, otherwise Stars should be managed by shared_ptr only.
	FittedStar (FittedStar &&)=delete
FittedStar &	operator= (FittedStar const &)=delete
FittedStar &	operator= (FittedStar &&)=delete
void	clearBeforeAssoc ()
void	print (std::ostream &stream=std::cout) const
void	addMagMeasurement (double magValue, double magWeight)
	Add a measuredStar on-sky magnitude.
void	setIndexInMatrix (Eigen::Index const index)
	index is a value that a fit can set and reread....
Eigen::Index	getIndexInMatrix () const
void	setRefStar (const RefStar *_refStar)
	Set the astrometric reference star associated with this star.
const RefStar *	getRefStar () const
	Get the astrometric reference star associated with this star.
double	getX () const
	access stuff.
double	getY () 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
double	computeDist2 (const Point &other) const
	distance squared to other
Point	operator+ (const Point &Right) const
	Sum.
Point	operator- (const Point &Right) const
	Difference.
int	getMeasurementCount () const
	The number of MeasuredStars currently associated with this FittedStar.
int &	getMeasurementCount ()
	The number of MeasuredStars currently associated with this FittedStar.

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 {}

Detailed Description

FittedStars are objects whose position or flux is going to be fitted, and which come from the association of multiple MeasuredStars.

x/y Coordinates are in the Common Tangent Plane (degrees). MeasuredStars from different CcdImages that represent the same on-sky object all point to one FittedStar.

Definition at line 50 of file FittedStar.h.

Constructor & Destructor Documentation

FittedStar() [1/5]

lsst::jointcal::FittedStar::FittedStar ( )

inline

Definition at line 52 of file FittedStar.h.

: BaseStar(), _indexInMatrix(-1), _measurementCount(0), _refStar(nullptr) {}

FittedStar() [2/5]

lsst::jointcal::FittedStar::FittedStar ( const BaseStar & baseStar )

inline

Definition at line 54 of file FittedStar.h.

            : BaseStar(baseStar), _indexInMatrix(0), _measurementCount(0), _refStar(nullptr) {}

FittedStar() [3/5]

lsst::jointcal::FittedStar::FittedStar

(

const MeasuredStar &

measuredStar

)

Definition at line 43 of file FittedStar.cc.

        : BaseStar(measuredStar), _indexInMatrix(-1), _measurementCount(0), _refStar(nullptr) {}

FittedStar() [4/5]

lsst::jointcal::FittedStar::FittedStar ( FittedStar const & )

default

No move, allow copy constructor: we may copy the fitted StarLists when associating and matching catalogs, otherwise Stars should be managed by shared_ptr only.

FittedStar() [5/5]

lsst::jointcal::FittedStar::FittedStar ( FittedStar && )

delete

Member Function Documentation

addMagMeasurement()

void lsst::jointcal::FittedStar::addMagMeasurement	(	double	magValue,
		double	magWeight )

Add a measuredStar on-sky magnitude.

Definition at line 57 of file FittedStar.cc.

                                                                    {
    _mag = (_mag * _magErr + magValue * magWeight) / (_magErr + magWeight);
    _magErr += magWeight;
}

clearBeforeAssoc()

void lsst::jointcal::FittedStar::clearBeforeAssoc ( )

inline

Definition at line 68 of file FittedStar.h.

                            {
        _indexInMatrix = -1;
        _measurementCount = 0;
        _refStar = nullptr;
        _flux = 0;
        _fluxErr = 0;
        _mag = 0;
        _magErr = 0;
    }

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; }

getIndexInMatrix()

Eigen::Index lsst::jointcal::FittedStar::getIndexInMatrix ( ) const

inline

Definition at line 99 of file FittedStar.h.

{ return _indexInMatrix; }

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; }

getMeasurementCount() [1/2]

int & lsst::jointcal::FittedStar::getMeasurementCount ( )

inline

The number of MeasuredStars currently associated with this FittedStar.

Definition at line 89 of file FittedStar.h.

{ return _measurementCount; }

getMeasurementCount() [2/2]

int lsst::jointcal::FittedStar::getMeasurementCount ( ) const

inline

The number of MeasuredStars currently associated with this FittedStar.

Definition at line 88 of file FittedStar.h.

{ return _measurementCount; }

getRefStar()

const RefStar * lsst::jointcal::FittedStar::getRefStar ( ) const

inline

Get the astrometric reference star associated with this star.

Definition at line 105 of file FittedStar.h.

{ return _refStar; };

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]

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

delete

operator=() [2/2]

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

delete

print()

void lsst::jointcal::FittedStar::print ( std::ostream & stream = std::cout ) const

inlinevirtual

Reimplemented from lsst::jointcal::BaseStar.

Definition at line 79 of file FittedStar.h.

                                                   {
        BaseStar::print(stream);
        stream << " mcount: " << _measurementCount;
    }

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; }

setIndexInMatrix()

void lsst::jointcal::FittedStar::setIndexInMatrix ( Eigen::Index const index )

inline

index is a value that a fit can set and reread....

Definition at line 96 of file FittedStar.h.

{ _indexInMatrix = index; };

setMagErr()

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

inlineinherited

Definition at line 109 of file BaseStar.h.

{ _magErr = magErr; }

setRefStar()

void lsst::jointcal::FittedStar::setRefStar

(

const RefStar *

_refStar

)

Set the astrometric reference star associated with this star.

Definition at line 46 of file FittedStar.cc.

                                                  {
    if ((_refStar != nullptr) && (refStar != nullptr)) {
        // TODO: should we raise an Exception in this case?
        LOGLS_ERROR(_log, "FittedStar: " << *this
                                         << " is already matched to another RefStar. Clean up your lists.");
        LOGLS_ERROR(_log, "old refStar: " << *_refStar);
        LOGLS_ERROR(_log, "new refStar: " << *refStar);
    } else
        _refStar = refStar;
}

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-12.0.0/Linux/jointcal/g29ae962dfc+83d129e820/include/lsst/jointcal/FittedStar.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/jointcal/g29ae962dfc+83d129e820/src/FittedStar.cc