LSSTApplications  20.0.0
LSSTDataManagementBasePackage
FittedStar.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * This file is part of jointcal.
4  *
5  * Developed for the LSST Data Management System.
6  * This product includes software developed by the LSST Project
7  * (https://www.lsst.org).
8  * See the COPYRIGHT file at the top-level directory of this distribution
9  * for details of code ownership.
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <https://www.gnu.org/licenses/>.
23  */
24 
25 #ifndef LSST_JOINTCAL_FITTED_STAR_H
26 #define LSST_JOINTCAL_FITTED_STAR_H
27 
28 #include <iostream>
29 #include <fstream>
30 
31 #include "Eigen/Core"
32 #include "lsst/jointcal/BaseStar.h"
33 #include "lsst/jointcal/StarList.h"
34 
35 namespace lsst {
36 namespace jointcal {
37 
38 class MeasuredStar;
39 class RefStar;
40 class AstrometryTransform;
41 
44 
46 struct PmBlock {
47  // proper motion in x and y. Units depend on how you fit them
48  double pmx, pmy;
49  double epmx, epmy, epmxy;
50  double color; // OK it is unrelated, but associated in practice
51  bool mightMove;
52 
53  PmBlock() : pmx(0), pmy(0), epmx(0), epmy(0), epmxy(0), color(0), mightMove(false){};
54 };
55 
61 class FittedStar : public BaseStar, public PmBlock {
62 public:
63  FittedStar() : BaseStar(), _indexInMatrix(-1), _measurementCount(0), _refStar(nullptr) {}
64 
65  FittedStar(const BaseStar& baseStar)
66  : BaseStar(baseStar), _indexInMatrix(0), _measurementCount(0), _refStar(nullptr) {}
67 
69  FittedStar(const MeasuredStar& measuredStar);
70 
73  FittedStar(FittedStar const&) = default;
74  FittedStar(FittedStar&&) = delete;
75  FittedStar& operator=(FittedStar const&) = delete;
77 
80  _indexInMatrix = -1;
81  _measurementCount = 0;
82  _refStar = nullptr;
83  _flux = 0;
84  _fluxErr = 0;
85  _mag = 0;
86  _magErr = 0;
87  }
88 
90  void print(std::ostream& stream = std::cout) const {
91  BaseStar::print(stream);
92  stream << " mcount: " << _measurementCount;
93  }
94 
96  int getMeasurementCount() const { return _measurementCount; }
97  int& getMeasurementCount() { return _measurementCount; }
98 
100  void addMagMeasurement(double magValue, double magWeight);
101 
103  void setIndexInMatrix(Eigen::Index const index) { _indexInMatrix = index; };
104 
106  Eigen::Index getIndexInMatrix() const { return _indexInMatrix; }
107 
109  void setRefStar(const RefStar* _refStar);
110 
112  const RefStar* getRefStar() const { return _refStar; };
113 
114 private:
115  Eigen::Index _indexInMatrix;
116  int _measurementCount;
117  const RefStar* _refStar;
118 };
119 
120 /****** FittedStarList */
121 
123 class FittedStarList : public StarList<FittedStar> {
124 public:
126 
129 };
130 
131 typedef FittedStarList::const_iterator FittedStarCIterator;
132 typedef FittedStarList::iterator FittedStarIterator;
133 
136 const BaseStarList& Fitted2Base(const FittedStarList& This);
137 const BaseStarList* Fitted2Base(const FittedStarList* This);
138 } // namespace jointcal
139 } // namespace lsst
140 
141 #endif // LSST_JOINTCAL_FITTED_STAR_H
lsst::jointcal::PmBlock::mightMove
bool mightMove
Definition: FittedStar.h:51
lsst::jointcal::MeasuredStar
objects measured on actual images.
Definition: MeasuredStar.h:46
lsst::jointcal::FittedStar::print
void print(std::ostream &stream=std::cout) const
utility
Definition: FittedStar.h:90
lsst::jointcal::BaseStar::_mag
double _mag
Definition: BaseStar.h:115
lsst::jointcal::FittedStar::FittedStar
FittedStar(const BaseStar &baseStar)
Definition: FittedStar.h:65
lsst::jointcal::BaseStar::_magErr
double _magErr
Definition: BaseStar.h:116
lsst::jointcal::FittedStar::operator=
FittedStar & operator=(FittedStar const &)=delete
lsst::jointcal::FittedStar::getIndexInMatrix
Eigen::Index getIndexInMatrix() const
Definition: FittedStar.h:106
lsst::jointcal::FittedStar
The objects which have been measured several times.
Definition: FittedStar.h:61
lsst::jointcal::RefStar
Objects used as position anchors, typically USNO stars.
Definition: RefStar.h:39
lsst::jointcal::PmBlock::epmx
double epmx
Definition: FittedStar.h:49
lsst::jointcal::PmBlock::epmy
double epmy
Definition: FittedStar.h:49
lsst::jointcal::FittedStarList::FittedStarList
FittedStarList()
Definition: FittedStar.h:128
lsst::jointcal::Fitted2Base
BaseStarList & Fitted2Base(FittedStarList &This)
Definition: FittedStar.cc:64
lsst::jointcal::PmBlock::color
double color
Definition: FittedStar.h:50
lsst::jointcal::FittedStarList::inTangentPlaneCoordinates
bool inTangentPlaneCoordinates
Definition: FittedStar.h:125
std::ostream
STL class.
lsst::jointcal::PmBlock::pmy
double pmy
Definition: FittedStar.h:48
lsst::jointcal::FittedStar::setRefStar
void setRefStar(const RefStar *_refStar)
Set the astrometric reference star associated with this star.
Definition: FittedStar.cc:46
lsst::jointcal::StarList
std::lists of Stars.
Definition: StarList.h:58
lsst::jointcal::FittedStar::operator=
FittedStar & operator=(FittedStar &&)=delete
lsst::jointcal::FittedStar::FittedStar
FittedStar()
Definition: FittedStar.h:63
lsst::jointcal::FittedStar::setIndexInMatrix
void setIndexInMatrix(Eigen::Index const index)
index is a value that a fit can set and reread....
Definition: FittedStar.h:103
lsst::jointcal::PmBlock::pmx
double pmx
Definition: FittedStar.h:48
lsst::jointcal
Definition: Associations.h:49
lsst::jointcal::PmBlock::PmBlock
PmBlock()
Definition: FittedStar.h:53
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::jointcal::PmBlock::epmxy
double epmxy
Definition: FittedStar.h:49
lsst::jointcal::PmBlock
objects whose position is going to be fitted. Coordinates in Common Tangent Plane.
Definition: FittedStar.h:46
lsst::jointcal::FittedStar::FittedStar
FittedStar(FittedStar &&)=delete
lsst::jointcal::FittedStar::getMeasurementCount
int getMeasurementCount() const
Definition: FittedStar.h:96
lsst::jointcal::FittedStar::getMeasurementCount
int & getMeasurementCount()
Definition: FittedStar.h:97
lsst::jointcal::BaseStar::_flux
double _flux
Definition: BaseStar.h:111
BaseStar.h
lsst::jointcal::FittedStar::addMagMeasurement
void addMagMeasurement(double magValue, double magWeight)
Add a measuredStar on-sky magnitude.
Definition: FittedStar.cc:57
lsst::jointcal::FittedStarCIterator
FittedStarList::const_iterator FittedStarCIterator
Definition: FittedStar.h:131
StarList.h
lsst::jointcal::FittedStarList
A list of FittedStar s. Such a list is typically constructed by Associations.
Definition: FittedStar.h:123
lsst::jointcal::BaseStar
The base class for handling stars. Used by all matching routines.
Definition: BaseStar.h:50
lsst::jointcal::FittedStar::clearBeforeAssoc
void clearBeforeAssoc()
Definition: FittedStar.h:79
lsst::jointcal::FittedStar::FittedStar
FittedStar(FittedStar const &)=default
No move, allow copy constructor: we may copy the fitted StarLists when associating and matching catal...
lsst::jointcal::FittedStar::getRefStar
const RefStar * getRefStar() const
Get the astrometric reference star associated with this star.
Definition: FittedStar.h:112
lsst::jointcal::BaseStar::_fluxErr
double _fluxErr
Definition: BaseStar.h:112
lsst::jointcal::BaseStar::print
virtual void print(std::ostream &out) const
utility
Definition: BaseStar.h:82
lsst::jointcal::FittedStarIterator
FittedStarList::iterator FittedStarIterator
Definition: FittedStar.h:132