LSSTApplications  19.0.0-10-g4a5fae6+14,19.0.0-10-g920eed2+3,19.0.0-11-g48a0200+5,19.0.0-19-g32a200e+8,19.0.0-2-g3b2f90d+5,19.0.0-2-gd671419+10,19.0.0-21-g2644856+27,19.0.0-22-g92e20685,19.0.0-24-g878c510+13,19.0.0-25-g1f84a6d+9,19.0.0-27-gbc613e1+5,19.0.0-27-gf99403173,19.0.0-3-g2b32d65+10,19.0.0-3-g8227491+24,19.0.0-3-g9c54d0d+24,19.0.0-3-gca68e65+21,19.0.0-3-gcfc5f51+10,19.0.0-3-ge110943+23,19.0.0-3-ge74d124,19.0.0-34-gfa6e18e+2,19.0.0-4-g06f5963+10,19.0.0-4-g10df615+9,19.0.0-4-g3d16501+28,19.0.0-4-g4a9c019+10,19.0.0-4-g5a8b323+3,19.0.0-4-g66397f0+4,19.0.0-4-g8557e14+3,19.0.0-4-ge404a01+24,19.0.0-5-g4db63b3+3,19.0.0-5-gb9eeb60+3,19.0.0-5-gc96f8cb+5,19.0.0-5-gfb03ce7+26,19.0.0-6-gbaebbfb+25,19.0.0-65-gd489f3fc,19.0.0-7-g039c0b5+26,19.0.0-7-gbea9075+7,19.0.0-7-gc567de5+26,19.0.0-8-g082faa5,19.0.0-80-g3c4dce0+1,19.0.0-9-g463f923+24,w.2020.25
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 } // namespace ast
148 
149 #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::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