LSSTApplications  19.0.0-14-gb0260a2+f7b33f63ed,20.0.0+028ca7aeb5,20.0.0+578ca8d785,20.0.0+95fe209e70,20.0.0+d1f8484762,20.0.0+ec0eb203f4,20.0.0-1-g253301a+95fe209e70,20.0.0-1-g2b7511a+ce6f728470,20.0.0-1-g5b95a8c+36cabaa438,20.0.0-1-gedffbd8+08e3982e2f,20.0.0-11-gd9dafd18+ee11e5b92d,20.0.0-16-gfab17e72e+f119078cbc,20.0.0-19-gb3c8180+76b8b4580d,20.0.0-2-g4dae9ad+b9c65d2db1,20.0.0-2-g61b8584+62d102034e,20.0.0-2-gb780d76+f45b7d88f4,20.0.0-2-ged6426c+c16e0e6c56,20.0.0-2-gf072044+95fe209e70,20.0.0-2-gf1f7952+b9c65d2db1,20.0.0-22-gdf434b7+b9c65d2db1,20.0.0-23-g10eeb28+266feae6ef,20.0.0-25-g3dcad98+7edba9c73c,20.0.0-3-g1653f94+62d102034e,20.0.0-3-g4cc78c6+1c0c6df15e,20.0.0-3-g8f21e14+cae0a2a29f,20.0.0-3-gbd60e8c+eb59cfae10,20.0.0-3-gbecbe05+a2681a7a86,20.0.0-36-g96d5af2b+330d9ff9b7,20.0.0-4-g97dc21a+7edba9c73c,20.0.0-4-gb4befbc+0084b8bcb8,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-5-gdfe0fee+88049eac2d,20.0.0-6-g64f541c+f45b7d88f4,20.0.0-6-g9a5b7a1+db91213b54,20.0.0-67-g32d6278+0d86c2e7cd,20.0.0-9-g4aef684+e9f4309ef0,w.2020.44
LSSTDataManagementBasePackage
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 
31 extern "C" {
32 #include "star/ast.h"
33 }
34 
35 // Do not delete this or free functions and enums will not be documented
37 namespace ast {
38 
42 using Array2D = ndarray::Array<double, 2, 2>;
46 using ConstArray2D = ndarray::Array<const double, 2, 2>;
58 
62 enum 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 
94 ConstArray2D arrayFromVector(std::vector<double> const &vec, int nAxes);
95 
98 
108 void assertOK(AstObject *rawPtr1 = nullptr, AstObject *rawPtr2 = nullptr);
109 
140 inline bool escapes(int include = -1) {
141  assertOK();
142  int ret = astEscapes(include);
143  assertOK();
144  return ret;
145 }
146 
147 inline int ast_version(void) {
148  return astVersion;
149 }
150 
151 } // namespace ast
152 
153 #endif
ast::DataType::DoubleType
@ DoubleType
ast::escapes
bool escapes(int include=-1)
Control whether graphical escape sequences are included in strings.
Definition: base.h:140
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< int >
ast::DataType::UndefinedType
@ UndefinedType
ast::DataType::ByteType
@ ByteType
ast::DataType::ShortIntType
@ ShortIntType
ast::DataType::StringType
@ StringType
ast::DataType::ObjectType
@ ObjectType
ast::Array2D
ndarray::Array< double, 2, 2 > Array2D
2D array of const double; typically used for lists of const points
Definition: base.h:42
ast::DataType::BadType
@ BadType
ast::DataType::IntType
@ IntType
ast::ast_version
int ast_version(void)
Definition: base.h:147
ast::DataType::FloatType
@ FloatType
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
ast::arrayFromVector
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
ast::DataType
DataType
Data types held by a KeyMap.
Definition: base.h:62
ast::DataType::PointerType
@ PointerType
ast::ConstArray2D
ndarray::Array< const double, 2, 2 > ConstArray2D
2D array of const double; typically used for lists of const points
Definition: base.h:46