LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
LSST Data Management Base Package
Loading...
Searching...
No Matches
FrameSet.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_FRAMESET_H
23#define ASTSHIM_FRAMESET_H
24
25#include <memory>
26#include <sstream>
27#include <stdexcept>
28
29#include "astshim/base.h"
30#include "astshim/Frame.h"
31
32namespace ast {
33
99class FrameSet : public Frame {
100 friend class Frame; // so Frame can call the protected raw ptr constructor
101 friend class Object;
102
103public:
104 static int constexpr BASE = AST__BASE;
105 static int constexpr CURRENT = AST__CURRENT;
106 static int constexpr NOFRAME = AST__NOFRAME;
117 explicit FrameSet(Frame const &frame, std::string const &options = "")
118 : FrameSet(astFrameSet(frame.copy()->getRawPtr(), "%s", options.c_str())) {
119 assertOK();
120 }
121
132 explicit FrameSet(Frame const &baseFrame, Mapping const &mapping, Frame const &currentFrame,
133 std::string const &options = "")
134 : FrameSet(baseFrame, options) {
135 _basicAddFrame(1, mapping, currentFrame);
136 }
137
138 virtual ~FrameSet() {}
139
141 FrameSet(FrameSet const &) = default;
142 FrameSet(FrameSet &&) = default;
143 FrameSet &operator=(FrameSet const &) = delete;
145
147 std::shared_ptr<FrameSet> copy() const { return std::static_pointer_cast<FrameSet>(copyPolymorphic()); }
148
160 void addAxes(Frame const &frame) {
161 astAddFrame(getRawPtr(), AST__ALLFRAMES, nullptr, frame.getRawPtr());
162 assertOK();
163 }
164
210 virtual void addFrame(int iframe, Mapping const &map, Frame const &frame) {
211 _basicAddFrame(iframe, map, frame);
212 }
213
234 void addVariant(Mapping const &map, std::string const &name) {
235 astAddVariant(getRawPtr(), map.getRawPtr(), name.c_str());
236 assertOK();
237 }
238
243 std::string getAllVariants() const { return getC("AllVariants"); }
244
248 int getBase() const { return getI("Base"); }
249
253 int getCurrent() const { return getI("Current"); }
254
270 std::shared_ptr<Frame> getFrame(int iframe, bool copy = true) const {
271 auto *rawFrame = reinterpret_cast<AstObject *>(astGetFrame(getRawPtr(), iframe));
272 assertOK(rawFrame);
273 if (!rawFrame) {
274 throw std::runtime_error("getFrame failed (returned a null frame)");
275 }
276 return Object::fromAstObject<Frame>(rawFrame, copy);
277 }
278
304 std::shared_ptr<Mapping> getMapping(int from = BASE, int to = CURRENT) const {
305 AstObject *rawMap = reinterpret_cast<AstObject *>(astGetMapping(getRawPtr(), from, to));
306 assertOK(rawMap);
307 if (!rawMap) {
308 throw std::runtime_error("getMapping failed (returned a null mapping)");
309 }
310 return Object::fromAstObject<Mapping>(rawMap, true);
311 }
312
316 int getNFrame() const { return getI("NFrame"); }
317
323 std::string getVariant() const { return getC("Variant"); }
324
367 void mirrorVariants(int iframe) {
368 astMirrorVariants(getRawPtr(), iframe);
369 assertOK();
370 }
371
410 void remapFrame(int iframe, Mapping &map) {
411 astRemapFrame(getRawPtr(), iframe, map.copy()->getRawPtr());
412 assertOK();
413 };
414
442 virtual void removeFrame(int iframe) {
443 astRemoveFrame(getRawPtr(), iframe);
444 assertOK();
445 }
446
463 void renameVariant(std::string const &name) {
464 astAddVariant(getRawPtr(), nullptr, name.c_str());
465 assertOK();
466 }
467
471 void setBase(int ind) { setI("Base", ind); }
472
476 void setCurrent(int ind) { setI("Current", ind); }
477
478protected:
479 virtual std::shared_ptr<Object> copyPolymorphic() const override {
480 return copyImpl<FrameSet, AstFrameSet>();
481 }
482
490 explicit FrameSet(AstFrameSet *rawPtr) : Frame(reinterpret_cast<AstFrame *>(rawPtr)) {
491 if (!astIsAFrameSet(getRawPtr())) {
493 os << "this is a " << getClassName() << ", which is not a FrameSet";
494 throw std::invalid_argument(os.str());
495 }
496 }
497
498private:
499 // non-virtual version of addFrame for use by constructors
500 void _basicAddFrame(int iframe, Mapping const &map, Frame const &frame) {
501 if (iframe == AST__ALLFRAMES) {
502 throw std::runtime_error("iframe = AST__ALLFRAMES; call addAxes instead");
503 }
504 // astAddFrame makes deep copies of the map and frame, so no need to do anything extra
505 astAddFrame(getRawPtr(), iframe, map.getRawPtr(), frame.getRawPtr());
506 assertOK();
507 }
508
509};
510
511} // namespace ast
512
513#endif
std::ostream * os
Definition Schema.cc:557
Frame is used to represent a coordinate system.
Definition Frame.h:157
A FrameSet consists of a set of one or more Frames (which describe coordinate systems),...
Definition FrameSet.h:99
std::shared_ptr< FrameSet > copy() const
Return a deep copy of this object.
Definition FrameSet.h:147
void setBase(int ind)
Set Base: index of base Frame.
Definition FrameSet.h:471
FrameSet(Frame const &frame, std::string const &options="")
Construct a FrameSet from a Frame.
Definition FrameSet.h:117
FrameSet(FrameSet &&)=default
FrameSet & operator=(FrameSet &&)=default
virtual void addFrame(int iframe, Mapping const &map, Frame const &frame)
Add a new Frame and an associated Mapping to this FrameSet so as to define a new coordinate system,...
Definition FrameSet.h:210
void setCurrent(int ind)
Set Current: index of current Frame, starting from 1.
Definition FrameSet.h:476
FrameSet(Frame const &baseFrame, Mapping const &mapping, Frame const &currentFrame, std::string const &options="")
Construct a FrameSet from two frames and a mapping that connects them.
Definition FrameSet.h:132
std::string getAllVariants() const
Get AllVariants: a list of all variant mappings stored with the current Frame.
Definition FrameSet.h:243
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition FrameSet.h:479
void mirrorVariants(int iframe)
Indicates that all access to the Variant attribute of the current Frame should should be forwarded to...
Definition FrameSet.h:367
int getBase() const
Get Base: index of base Frame.
Definition FrameSet.h:248
void renameVariant(std::string const &name)
Rename the current Variant of the current Mapping.
Definition FrameSet.h:463
FrameSet(AstFrameSet *rawPtr)
Construct a FrameSet from a raw AST pointer.
Definition FrameSet.h:490
std::string getVariant() const
Variant: name of variant mapping in use by current Frame
Definition FrameSet.h:323
void addAxes(Frame const &frame)
Append the axes from a specified Frame to every existing Frame in this FrameSet.
Definition FrameSet.h:160
FrameSet(FrameSet const &)=default
Copy constructor: make a deep copy.
std::shared_ptr< Mapping > getMapping(int from=BASE, int to=CURRENT) const
Obtain a Mapping that converts between two Frames in a FrameSet.
Definition FrameSet.h:304
void remapFrame(int iframe, Mapping &map)
Modify the relationship (i.e.
Definition FrameSet.h:410
std::shared_ptr< Frame > getFrame(int iframe, bool copy=true) const
Obtain a deep copy of the specified Frame.
Definition FrameSet.h:270
void addVariant(Mapping const &map, std::string const &name)
Store a new variant Mapping with the current Frame.
Definition FrameSet.h:234
FrameSet & operator=(FrameSet const &)=delete
int getCurrent() const
Get Current: index of current Frame, starting from 1.
Definition FrameSet.h:253
static int constexpr CURRENT
index of current frame
Definition FrameSet.h:105
int getNFrame() const
Get FrameSet_NFrame "NFrame": number of Frames in the FrameSet, starting from 1.
Definition FrameSet.h:316
static int constexpr NOFRAME
an invalid frame index
Definition FrameSet.h:106
virtual void removeFrame(int iframe)
Remove a Frame from a FrameSet.
Definition FrameSet.h:442
virtual ~FrameSet()
Definition FrameSet.h:138
static int constexpr BASE
index of base frame
Definition FrameSet.h:104
An abstract base class for objects which transform one set of coordinates to another.
Definition Mapping.h:59
std::shared_ptr< Mapping > copy() const
Return a deep copy of this object.
Definition Mapping.h:72
Abstract base class for all AST objects.
Definition Object.h:51
std::string const getC(std::string const &attrib) const
Get the value of an attribute as a string.
Definition Object.h:361
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition Object.h:139
void setI(std::string const &attrib, int value)
Set the value of an attribute as an int.
Definition Object.h:496
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition Object.cc:178
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition Object.h:292
AST wrapper classes and functions.
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition base.cc:49