LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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
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 {
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
Frame is used to represent a coordinate system.
Definition Frame.h:157
std::shared_ptr< FrameSet > copy() const
Return a deep copy of this object.
Definition FrameSet.h:147
friend class Object
Definition FrameSet.h:101
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
friend class Frame
Definition FrameSet.h:100
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
static std::shared_ptr< Class > fromAstObject(AstObject *rawObj, bool copy)
Given a bare AST object pointer return a shared pointer to an ast::Object of the correct type.
Definition Object.cc:138
std::shared_ptr< T > copyImpl() const
Implementation of deep copy.
Definition Object.h:320
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
T static_pointer_cast(T... args)
T str(T... args)