LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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 {
61 std::complex<double> val = defval;
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();
66 return FoundValue<std::complex<double>>(found, val);
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(Stream &stream, std::string const &options="")
Construct a channel that uses a provided Stream.
Definition Channel.cc:31
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
Definition FitsChan.h:42
@ PRESENT
keyword is present and has a value
Definition FitsChan.h:43
@ ABSENT
keyword is not present
Definition FitsChan.h:41
T reserve(T... args)