LSST Applications g0265f82a02+32fec32616,g0bb0af90fd+f5dc583633,g1e7d6db67d+b5ae400c1a,g1fdc4b6800+6c4785dcad,g26482f50c6+b877b2b840,g2bbee38e9b+32fec32616,g3273194fdb+14984c1173,g36c42b5980+54014c7926,g3eccfa81ec+38f9af2e6a,g4c90b7bd52+7cf7a7847c,g4d318ecf75+22f940484f,g4f7801ab40+32fec32616,g5679e1724d+5b1cbc6d7b,g673ccd32cf+32fec32616,g726579da51+32fec32616,g733a212e47+28ef02efc0,g877625a462+8dbed4964d,g98ffbb4407+8dbed4964d,g9ddcbc5298+d7594c9347,ga1e77700b3+f258a22cbf,ga500d100eb+833bc1611b,gacaae59b5d+0005efa287,gb2715bf1a1+0005efa287,gbac042402a+17dfc79d6b,gbae45e39e2+5e939bd0b5,gc45c8d2e98+a10d610406,gc86a011abf+0005efa287,gcf0d15dbbd+667bae79af,gdaeeff99f8+f78d25140c,gdb4ec4c597+32fec32616,gdc81be3499+0005efa287,ge23793e450+667bae79af,gee31e0d7c8+667bae79af,gf041782ebf+e1018a7e59,w.2023.28
LSST Data Management Base Package
Loading...
Searching...
No Matches
base.h
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#ifndef ASTSHIM_BASE_H
23#define ASTSHIM_BASE_H
24
25#include <string>
26#include <stdexcept>
27#include <vector>
28
29#include "ndarray.h"
30
31extern "C" {
32#include "star/ast.h"
33}
34
35// Do not delete this or free functions and enums will not be documented
37namespace ast {
38
42using Array2D = ndarray::Array<double, 2, 2>;
46using ConstArray2D = ndarray::Array<const double, 2, 2>;
58
62enum class DataType {
63 IntType = AST__INTTYPE,
64 ShortIntType = AST__SINTTYPE,
65 ByteType = AST__BYTETYPE,
66 DoubleType = AST__DOUBLETYPE,
67 FloatType = AST__FLOATTYPE,
68 StringType = AST__STRINGTYPE,
69 ObjectType = AST__OBJECTTYPE,
70 PointerType = AST__POINTERTYPE,
71 UndefinedType = AST__UNDEFTYPE,
72 BadType = AST__BADTYPE
73};
74
95
98
108void assertOK(AstObject *rawPtr1 = nullptr, AstObject *rawPtr2 = nullptr);
109
140inline bool escapes(int include = -1) {
141 assertOK();
142 int ret = astEscapes(include);
143 assertOK();
144 return ret;
145}
146
147inline int ast_version(void) {
148 return astVersion;
149}
150
151} // namespace ast
152
153#endif
AST wrapper classes and functions.
DataType
Data types held by a KeyMap.
Definition base.h:62
int ast_version(void)
Definition base.h:147
bool escapes(int include=-1)
Control whether graphical escape sequences are included in strings.
Definition base.h:140
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition base.cc:49
ConstArray2D arrayFromVector(std::vector< double > const &vec, int nAxes)
Reshape a vector as a 2-dimensional array that shares the same memory.
Definition base.cc:65
ndarray::Array< double, 2, 2 > Array2D
2D array of const double; typically used for lists of const points
Definition base.h:42
ndarray::Array< const double, 2, 2 > ConstArray2D
2D array of const double; typically used for lists of const points
Definition base.h:46