LSST Applications g0265f82a02+d6b5cd48b5,g02d81e74bb+a41d3748ce,g1470d8bcf6+6be6c9203b,g2079a07aa2+14824f138e,g212a7c68fe+a4f2ea4efa,g2305ad1205+72971fe858,g295015adf3+ab2c85acae,g2bbee38e9b+d6b5cd48b5,g337abbeb29+d6b5cd48b5,g3ddfee87b4+31b3a28dff,g487adcacf7+082e807817,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+b2918d57ae,g5a732f18d5+66d966b544,g64a986408d+a41d3748ce,g858d7b2824+a41d3748ce,g8a8a8dda67+a6fc98d2e7,g99cad8db69+7fe4acdf18,g9ddcbc5298+d4bad12328,ga1e77700b3+246acaaf9c,ga8c6da7877+84af8b3ff8,gb0e22166c9+3863383f4c,gb6a65358fc+d6b5cd48b5,gba4ed39666+9664299f35,gbb8dafda3b+d8d527deb2,gc07e1c2157+b2dbe6b631,gc120e1dc64+61440b2abb,gc28159a63d+d6b5cd48b5,gcf0d15dbbd+31b3a28dff,gdaeeff99f8+a38ce5ea23,ge6526c86ff+39927bb362,ge79ae78c31+d6b5cd48b5,gee10cc3b42+a6fc98d2e7,gf1cff7945b+a41d3748ce,v24.1.5.rc1
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.
ndarray::Array< const double, 2, 2 > ConstArray2D
2D array of const double; typically used for lists of const points
Definition base.h:46
DataType
Data types held by a KeyMap.
Definition base.h:62
int ast_version(void)
Definition base.h:147
ndarray::Array< double, 2, 2 > Array2D
2D array of const double; typically used for lists of const points
Definition base.h:42
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