LSSTApplications  18.1.0
LSSTDataManagementBasePackage
BaseStar.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_BASE_STAR_H
26 #define LSST_JOINTCAL_BASE_STAR_H
27 
28 #include <iostream>
29 #include <cstdio>
30 #include <string>
31 #include <sstream>
32 
33 #include "lsst/utils/Magnitude.h"
34 #include "lsst/jointcal/FatPoint.h"
35 #include "lsst/jointcal/StarList.h"
36 
37 namespace lsst {
38 namespace jointcal {
39 
40 namespace {
41 
43 double magErrFromFluxErr(double instFlux, double instFluxErr) {
44  return 2.5 / std::log(10) * (instFluxErr / instFlux);
45 }
46 
47 } // namespace
48 
50 class BaseStar : public FatPoint {
51 public:
53  x = 0;
54  y = 0;
55  _flux = 0;
56  };
58  BaseStar(double xx, double yy, double flux, double fluxErr)
59  : FatPoint(xx, yy),
60  _flux(flux),
61  _fluxErr(fluxErr),
62  _mag(utils::nanojanskyToABMagnitude(flux)),
63  _magErr(magErrFromFluxErr(flux, fluxErr)){};
64  BaseStar(Point const &point, double flux, double fluxErr, double mag, double magErr)
65  : FatPoint(point),
66  _flux(flux),
67  _fluxErr(fluxErr),
68  _mag(utils::nanojanskyToABMagnitude(flux)),
69  _magErr(magErrFromFluxErr(flux, fluxErr)){};
70 
72  double getX() const { return x; }
74  double getY() const { return y; }
75 
78  s.dump(stream);
79  return stream;
80  }
81 
82  virtual void dump(std::ostream &stream = std::cout) const {
83  stream << "x: " << x << " y: " << y << " flux: " << _flux << " fluxErr: " << _fluxErr;
84  }
85 
86  BaseStar &operator=(Point const &point) {
87  x = point.x;
88  y = point.y;
89  return (*this);
90  };
91 
92  static const char *typeName() { return "BaseStar"; }
93 
94  virtual ~BaseStar(){};
95 
96  double getFlux() const { return _flux; }
97  double &getFlux() { return _flux; }
98  void setFlux(double flux) { _flux = flux; }
99 
100  double getFluxErr() const { return _fluxErr; }
101  void setFluxErr(double fluxErr) { _fluxErr = fluxErr; }
102 
103  double getMag() const { return _mag; }
104  double &getMag() { return _mag; }
105 
106  double getMagErr() const { return _magErr; }
107  void setMagErr(double magErr) { _magErr = magErr; }
108 
109 protected:
110  // on-sky flux, in nanojansky
111  double _flux;
112  double _fluxErr;
113 
114  // on-sky magnitude
115  double _mag;
116  double _magErr;
117 };
118 
120 
121 typedef BaseStarList::const_iterator BaseStarCIterator;
122 typedef BaseStarList::iterator BaseStarIterator;
123 } // namespace jointcal
124 } // namespace lsst
125 
126 #endif // LSST_JOINTCAL_BASE_STAR_H
BaseStarList::const_iterator BaseStarCIterator
Definition: BaseStar.h:121
double getX() const
access stuff.
Definition: BaseStar.h:72
virtual void dump(std::ostream &stream=std::cout) const
utility
Definition: BaseStar.h:82
A point in a plane.
Definition: Point.h:36
StarList< BaseStar > BaseStarList
Definition: BaseStar.h:119
T log(T... args)
BaseStarList::iterator BaseStarIterator
Definition: BaseStar.h:122
double getFluxErr() const
Definition: BaseStar.h:100
A Point with uncertainties.
Definition: FatPoint.h:34
double x
coordinate
Definition: Point.h:41
The base class for handling stars. Used by all matching routines.
Definition: BaseStar.h:50
std::lists of Stars.
Definition: StarList.h:58
A base class for image defects.
BaseStar & operator=(Point const &point)
Definition: BaseStar.h:86
static const char * typeName()
Definition: BaseStar.h:92
Utilities for converting between flux and magnitude in C++.
double getMag() const
Definition: BaseStar.h:103
solver_t * s
double getFlux() const
Definition: BaseStar.h:96
void setFluxErr(double fluxErr)
Definition: BaseStar.h:101
double getY() const
Definition: BaseStar.h:74
double nanojanskyToABMagnitude(double flux)
Convert a flux in nanojansky to AB magnitude.
Definition: Magnitude.cc:30
double getMagErr() const
Definition: BaseStar.h:106
void setFlux(double flux)
Definition: BaseStar.h:98
BaseStar(Point const &point, double flux, double fluxErr, double mag, double magErr)
Definition: BaseStar.h:64
friend std::ostream & operator<<(std::ostream &stream, BaseStar const &s)
allows std::cout << aBaseStar;
Definition: BaseStar.h:77
STL class.
void setMagErr(double magErr)
Definition: BaseStar.h:107
BaseStar(double xx, double yy, double flux, double fluxErr)
constructor
Definition: BaseStar.h:58