LSSTApplications  20.0.0
LSSTDataManagementBasePackage
JointcalControl.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_JOINTCAL_CONTROL_H
26 #define LSST_JOINTCAL_JOINTCAL_CONTROL_H
27 
28 #include <cmath>
29 #include <string>
30 #include <vector>
31 #include <tuple>
32 
33 #include "lsst/pex/config.h"
34 #include "lsst/afw/table/Source.h"
35 
36 namespace lsst {
37 namespace jointcal {
38 
40  LSST_CONTROL_FIELD(sourceFluxField, std::string, "name of flux field in source catalog");
41 
42  explicit JointcalControl(std::string const& sourceFluxField = "slot_CalibFlux")
43  : // Set sourceFluxType to the value used in the source selector.
45  validate();
46  }
47 
49 
50  void validate() const {
51  if (sourceFluxField.empty()) {
52  throw LSST_EXCEPT(pexExcept::InvalidParameterError, "sourceFluxField must be specified");
53  }
54  }
55 };
56 } // namespace jointcal
57 } // namespace lsst
58 
59 #endif // LSST_JOINTCAL_JOINTCAL_CONTROL_H
std::string
STL class.
lsst::jointcal::JointcalControl::validate
void validate() const
Definition: JointcalControl.h:50
LSST_CONTROL_FIELD
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:43
lsst::jointcal::JointcalControl::~JointcalControl
~JointcalControl()
Definition: JointcalControl.h:48
lsst::jointcal
Definition: Associations.h:49
Source.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
lsst::jointcal::JointcalControl::JointcalControl
JointcalControl(std::string const &sourceFluxField="slot_CalibFlux")
Definition: JointcalControl.h:42
lsst::pex::exceptions::InvalidParameterError
Reports invalid arguments.
Definition: Runtime.h:66
lsst::jointcal::JointcalControl::sourceFluxField
std::string sourceFluxField
"name of flux field in source catalog" ;
Definition: JointcalControl.h:40
lsst::jointcal::JointcalControl
Definition: JointcalControl.h:39
std::string::empty
T empty(T... args)
config.h