LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
LSST Data Management Base Package
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
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
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
table::Key< std::string > name
Definition: Amplifier.cc:116
std::ostream * os
Definition: Schema.cc:557
table::Key< int > from
table::Key< int > to
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
static constexpr int CURRENT
index of current frame
Definition: FrameSet.h:105
static constexpr int BASE
index of base frame
Definition: FrameSet.h:104
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
static constexpr int NOFRAME
an invalid frame index
Definition: FrameSet.h:106
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
int getNFrame() const
Get FrameSet_NFrame "NFrame": number of Frames in the FrameSet, starting from 1.
Definition: FrameSet.h:316
virtual void removeFrame(int iframe)
Remove a Frame from a FrameSet.
Definition: FrameSet.h:442
virtual ~FrameSet()
Definition: FrameSet.h:138
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:500
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
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