LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
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:
lsst::jointcal::BaseStar lsst::jointcal::FatPoint lsst::jointcal::Point

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. More...
 
 FittedStar (FittedStar &&)=delete
 
FittedStaroperator= (FittedStar const &)=delete
 
FittedStaroperator= (FittedStar &&)=delete
 
void clearBeforeAssoc ()
 
void print (std::ostream &stream=std::cout) const
 
void addMagMeasurement (double magValue, double magWeight)
 Add a measuredStar on-sky magnitude. More...
 
void setIndexInMatrix (Eigen::Index const index)
 index is a value that a fit can set and reread.... More...
 
Eigen::Index getIndexInMatrix () const
 
void setRefStar (const RefStar *_refStar)
 Set the astrometric reference star associated with this star. More...
 
const RefStargetRefStar () const
 Get the astrometric reference star associated with this star. More...
 
double getX () const
 access stuff. More...
 
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
 
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...
 
int getMeasurementCount () const
 The number of MeasuredStars currently associated with this FittedStar. More...
 
int & getMeasurementCount ()
 The number of MeasuredStars currently associated with this FittedStar. 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

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.

52 : 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.

55  : 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.

44  : 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.

57  {
58  _mag = (_mag * _magErr + magValue * magWeight) / (_magErr + magWeight);
59  _magErr += magWeight;
60 }

◆ clearBeforeAssoc()

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

Definition at line 68 of file FittedStar.h.

68  {
69  _indexInMatrix = -1;
70  _measurementCount = 0;
71  _refStar = nullptr;
72  _flux = 0;
73  _fluxErr = 0;
74  _mag = 0;
75  _magErr = 0;
76  }

◆ computeDist2()

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

distance squared to other

Definition at line 56 of file Point.h.

56  {
57  return ((x - other.x) * (x - other.x) + (y - other.y) * (y - other.y));
58  };
double x
coordinate
Definition: Point.h:42

◆ Distance()

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

Definition at line 51 of file Point.h.

51  {
52  return sqrt((x - other.x) * (x - other.x) + (y - other.y) * (y - other.y));
53  };
T sqrt(T... args)

◆ getFlux() [1/2]

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

Definition at line 99 of file BaseStar.h.

99 { return _flux; }

◆ getFlux() [2/2]

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

Definition at line 98 of file BaseStar.h.

98 { return _flux; }

◆ getFluxErr()

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

Definition at line 102 of file BaseStar.h.

102 { return _fluxErr; }

◆ getIndexInMatrix()

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

Definition at line 99 of file FittedStar.h.

99 { return _indexInMatrix; }

◆ getMag() [1/2]

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

Definition at line 106 of file BaseStar.h.

106 { return _mag; }

◆ getMag() [2/2]

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

Definition at line 105 of file BaseStar.h.

105 { return _mag; }

◆ getMagErr()

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

Definition at line 108 of file BaseStar.h.

108 { 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.

89 { 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.

88 { 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.

105 { return _refStar; };

◆ getX()

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

access stuff.

Definition at line 73 of file BaseStar.h.

73 { return x; }

◆ getY()

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

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

◆ 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=() [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.

79  {
80  BaseStar::print(stream);
81  stream << " mcount: " << _measurementCount;
82  }
virtual void print(std::ostream &out) const
Definition: BaseStar.h:83

◆ setFlux()

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

Definition at line 100 of file BaseStar.h.

100 { _flux = flux; }

◆ setFluxErr()

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

Definition at line 103 of file BaseStar.h.

103 { _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.

96 { _indexInMatrix = index; };

◆ setMagErr()

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

Definition at line 109 of file BaseStar.h.

109 { _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.

46  {
47  if ((_refStar != nullptr) && (refStar != nullptr)) {
48  // TODO: should we raise an Exception in this case?
49  LOGLS_ERROR(_log, "FittedStar: " << *this
50  << " is already matched to another RefStar. Clean up your lists.");
51  LOGLS_ERROR(_log, "old refStar: " << *_refStar);
52  LOGLS_ERROR(_log, "new refStar: " << *refStar);
53  } else
54  _refStar = refStar;
55 }
#define LOGLS_ERROR(logger, message)
Log a error-level message using an iostream-based interface.
Definition: Log.h:679

◆ typeName()

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

Definition at line 94 of file BaseStar.h.

94 { 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: