LSSTApplications  21.0.0+75b29a8a7f,21.0.0+e70536a077,21.0.0-1-ga51b5d4+62c747d40b,21.0.0-11-ga6ea59e8e+47cba9fc36,21.0.0-2-g103fe59+914993bf7c,21.0.0-2-g1367e85+e2614ded12,21.0.0-2-g45278ab+e70536a077,21.0.0-2-g4bc9b9f+7b2b5f8678,21.0.0-2-g5242d73+e2614ded12,21.0.0-2-g54e2caa+6403186824,21.0.0-2-g7f82c8f+3ac4acbffc,21.0.0-2-g8dde007+04a6aea1af,21.0.0-2-g8f08a60+9402881886,21.0.0-2-ga326454+3ac4acbffc,21.0.0-2-ga63a54e+81dd751046,21.0.0-2-gc738bc1+5f65c6e7a9,21.0.0-2-gde069b7+26c92b3210,21.0.0-2-gecfae73+0993ddc9bd,21.0.0-2-gfc62afb+e2614ded12,21.0.0-21-gba890a8+5a4f502a26,21.0.0-23-g9966ff26+03098d1af8,21.0.0-3-g357aad2+8ad216c477,21.0.0-3-g4be5c26+e2614ded12,21.0.0-3-g6d51c4a+4d2fe0280d,21.0.0-3-g7d9da8d+75b29a8a7f,21.0.0-3-gaa929c8+522e0f12c2,21.0.0-3-ge02ed75+4d2fe0280d,21.0.0-4-g3300ddd+e70536a077,21.0.0-4-gc004bbf+eac6615e82,21.0.0-4-gccdca77+f94adcd104,21.0.0-4-gd1c1571+18b81799f9,21.0.0-5-g7b47fff+4d2fe0280d,21.0.0-5-gb155db7+d2632f662b,21.0.0-5-gdf36809+637e4641ee,21.0.0-6-g722ad07+28c848f42a,21.0.0-7-g959bb79+522e0f12c2,21.0.0-7-gfd72ab2+cf01990774,21.0.0-9-g87fb7b8d+e2ab11cdd6,w.2021.04
LSSTDataManagementBasePackage
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 
33 namespace ast {
34 
35 namespace {
36 
40 char const *cstrOrNull(std::string const &str) { return str.empty() ? nullptr : str.c_str(); }
41 
42 } // namespace
43 
44 FitsChan::FitsChan(Stream &stream, std::string const &options)
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 
77 FoundValue<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 
85  int val = defval;
86  bool found = astGetFitsI(getRawPtr(), cstrOrNull(name), &val);
87  assertOK();
88  return FoundValue<int>(found, val);
89 }
90 
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();
109  std::vector<std::string> nameList;
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) {
137  return FitsKeyState::PRESENT;
138  }
139  return there ? FitsKeyState::NOVALUE : FitsKeyState::ABSENT;
140 }
141 
142 } // namespace ast
ast::FitsChan::getFitsCN
FoundValue< std::string > getFitsCN(std::string const &name="", std::string defval="") const
Get the value of a CONTINUE card.
Definition: FitsChan.cc:69
std::string
STL class.
ast::assertOK
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition: base.cc:49
std::vector::reserve
T reserve(T... args)
ast::FoundValue
A value and associated validity flag.
Definition: FitsChan.h:69
std::vector< std::string >
ast::FitsChan::findFits
FoundValue< std::string > findFits(std::string const &name, bool inc)
Search for a card in a FitsChan by keyword.
Definition: FitsChan.cc:124
std::unique_ptr::get
T get(T... args)
ast::FitsChan::getCardName
std::string getCardName() const
Get CardName: the keyword name of the current card.
Definition: FitsChan.h:496
val
ImageT val
Definition: CR.cc:146
ast::FitsChan::getAllCardNames
std::vector< std::string > getAllCardNames()
Get the name of all cards, in order, starting from the first card.
Definition: FitsChan.cc:106
ast::FitsChan::getNCard
int getNCard() const
Get NCard: the number of cards.
Definition: FitsChan.h:555
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
ast::FitsChan::FitsChan
FitsChan(Stream &stream, std::string const &options="")
Construct a channel that uses a provided Stream.
Definition: FitsChan.cc:44
ast::FitsChan::setCard
void setCard(int ind)
Set Card: the index of the current card, where 1 is the first card.
Definition: FitsChan.h:1036
ast::Channel
Channel provides input/output of AST objects.
Definition: Channel.h:60
ast::Stream
A stream for ast::Channel.
Definition: Stream.h:41
ast::FitsChan::getFitsCF
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
FitsChan.h
ast::detail::source
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
ast::FitsChan::getFitsI
FoundValue< int > getFitsI(std::string const &name="", int defval=0) const
Get the value of a int card.
Definition: FitsChan.cc:84
ast::FitsChan::testFits
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
lsst.pipe.tasks.cli.cmd.commands.str
str
Definition: commands.py:50
ast::FitsChan::getFitsS
FoundValue< std::string > getFitsS(std::string const &name="", std::string defval="") const
Get the value of a string card.
Definition: FitsChan.cc:98
base.h
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
std::vector::emplace_back
T emplace_back(T... args)
ast::FitsChan::getFitsF
FoundValue< double > getFitsF(std::string const &name="", double defval=0) const
Get the value of a double card.
Definition: FitsChan.cc:77
ast::FitsChan::~FitsChan
virtual ~FitsChan()
Definition: FitsChan.cc:51
ast::FitsChan::getCard
int getCard() const
Get Card: the index of the current card, where 1 is the first card.
Definition: FitsChan.h:486
std::complex< double >
ast::Object::getRawPtr
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
ast::FitsKeyState
FitsKeyState
Enums describing the presence or absence of a FITS keyword.
Definition: FitsChan.h:40
Object.h
std::unique_ptr
STL class.
ast::FitsKeyState::PRESENT
@ PRESENT
keyword is present and has a value
ast::FitsChan::getFitsL
FoundValue< bool > getFitsL(std::string const &name="", bool defval=false) const
Get the value of a bool card.
Definition: FitsChan.cc:91
ast::detail::sink
void sink(const char *cstr)
Sink function that allows astChannel to sink to a Stream.
Definition: Stream.h:239
Stream.h