LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
FitsChan.cc
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2017 AURA/LSST.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <https://www.lsstcorp.org/LegalNotices/>.
21 */
22
23#include <complex>
24#include <memory>
25#include <string>
26#include <vector>
27
28#include "astshim/base.h"
29#include "astshim/Object.h"
30#include "astshim/Stream.h"
31#include "astshim/FitsChan.h"
32
33namespace ast {
34
35namespace {
36
40char const *cstrOrNull(std::string const &str) { return str.empty() ? nullptr : str.c_str(); }
41
42} // namespace
43
45 : Channel(reinterpret_cast<AstChannel *>(
46 astFitsChan(detail::source, detail::sink, "%s", options.c_str())),
47 stream, true) {
48 assertOK();
49}
50
52 // when an astFitsChan is destroyed it first writes out any cards, but if I let astFitsChan
53 // do this automatically then it occurs while the Channel and its Source are being destroyed,
54 // which is too late
55 astWriteFits(getRawPtr());
56 // No 'assertOK' here: can't throw in a Dtor.
57}
58
60 std::complex<double> defval) const {
62 // this use of reinterpret_cast is explicitly permitted, for C compatibility
63 double *rawval = reinterpret_cast<double(&)[2]>(val);
64 bool found = astGetFitsCF(getRawPtr(), cstrOrNull(name), rawval);
65 assertOK();
67}
68
70 char *rawval; // astGetFitsCN has its own static buffer for the value
71 bool found = astGetFitsCN(getRawPtr(), cstrOrNull(name), &rawval);
72 assertOK();
73 std::string val = found ? rawval : defval;
74 return FoundValue<std::string>(found, val);
75}
76
77FoundValue<double> FitsChan::getFitsF(std::string const &name, double defval) const {
78 double val = defval;
79 bool found = astGetFitsF(getRawPtr(), cstrOrNull(name), &val);
80 assertOK();
81 return FoundValue<double>(found, val);
82}
83
84FoundValue<int> FitsChan::getFitsI(std::string const &name, int defval) const {
85 int val = defval;
86 bool found = astGetFitsI(getRawPtr(), cstrOrNull(name), &val);
87 assertOK();
88 return FoundValue<int>(found, val);
89}
90
91FoundValue<bool> FitsChan::getFitsL(std::string const &name, bool defval) const {
92 int val = static_cast<int>(defval);
93 bool found = astGetFitsL(getRawPtr(), cstrOrNull(name), &val);
94 assertOK();
95 return FoundValue<bool>(found, static_cast<bool>(val));
96}
97
99 char *rawval; // astGetFitsS has its own static buffer for the value
100 bool found = astGetFitsS(getRawPtr(), cstrOrNull(name), &rawval);
101 assertOK();
102 std::string val = found ? rawval : defval;
103 return FoundValue<std::string>(found, val);
104}
105
107 int const initialIndex = getCard();
108 int const numCards = getNCard();
110 nameList.reserve(numCards);
111 try {
112 for (auto i = 1; i <= numCards; ++i) {
113 setCard(i);
114 nameList.emplace_back(getCardName());
115 }
116 } catch (...) {
117 setCard(initialIndex);
118 throw;
119 }
120 setCard(initialIndex);
121 return nameList;
122}
123
125 std::unique_ptr<char[]> fitsbuf(new char[detail::FITSLEN + 1]);
126 fitsbuf[0] = '\0'; // in case nothing is found
127 bool success = static_cast<bool>(astFindFits(getRawPtr(), name.c_str(), fitsbuf.get(), inc));
128 assertOK();
129 return FoundValue<std::string>(success, std::string(fitsbuf.get()));
130}
131
133 int there;
134 int hasvalue = astTestFits(getRawPtr(), cstrOrNull(name), &there);
135 assertOK();
136 if (hasvalue) {
138 }
140}
141
142} // namespace ast
Channel provides input/output of AST objects.
Definition Channel.h:60
FitsKeyState testFits(std::string const &name="") const
Determine if a card is present, and if so, whether it has a value.
Definition FitsChan.cc:132
std::vector< std::string > getAllCardNames()
Get the name of all cards, in order, starting from the first card.
Definition FitsChan.cc:106
FoundValue< std::string > findFits(std::string const &name, bool inc)
Search for a card in a FitsChan by keyword.
Definition FitsChan.cc:124
FoundValue< std::string > getFitsS(std::string const &name="", std::string defval="") const
Get the value of a string card.
Definition FitsChan.cc:98
virtual ~FitsChan()
Definition FitsChan.cc:51
void setCard(int ind)
Set Card: the index of the current card, where 1 is the first card.
Definition FitsChan.h:1036
FoundValue< bool > getFitsL(std::string const &name="", bool defval=false) const
Get the value of a bool card.
Definition FitsChan.cc:91
int getCard() const
Get Card: the index of the current card, where 1 is the first card.
Definition FitsChan.h:486
std::string getCardName() const
Get CardName: the keyword name of the current card.
Definition FitsChan.h:496
FitsChan(Stream &stream, std::string const &options="")
Construct a channel that uses a provided Stream.
Definition FitsChan.cc:44
FoundValue< int > getFitsI(std::string const &name="", int defval=0) const
Get the value of a int card.
Definition FitsChan.cc:84
int getNCard() const
Get NCard: the number of cards.
Definition FitsChan.h:555
FoundValue< std::complex< double > > getFitsCF(std::string const &name="", std::complex< double > defval={0, 0}) const
Get the value of a complex double card.
Definition FitsChan.cc:59
FoundValue< double > getFitsF(std::string const &name="", double defval=0) const
Get the value of a double card.
Definition FitsChan.cc:77
FoundValue< std::string > getFitsCN(std::string const &name="", std::string defval="") const
Get the value of a CONTINUE card.
Definition FitsChan.cc:69
A value and associated validity flag.
Definition FitsChan.h:69
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition Object.h:292
A stream for ast::Channel.
Definition Stream.h:41
T emplace_back(T... args)
T get(T... args)
AST wrapper classes and functions.
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition base.cc:49
FitsKeyState
Enums describing the presence or absence of a FITS keyword.
Definition FitsChan.h:40
@ NOVALUE
keyword is present, but has no value
@ PRESENT
keyword is present and has a value
@ ABSENT
keyword is not present
T reserve(T... args)
ImageT val
Definition CR.cc:146