LSST Applications g0f08755f38+82efc23009,g12f32b3c4e+e7bdf1200e,g1653933729+a8ce1bb630,g1a0ca8cf93+50eff2b06f,g28da252d5a+52db39f6a5,g2bbee38e9b+37c5a29d61,g2bc492864f+37c5a29d61,g2cdde0e794+c05ff076ad,g3156d2b45e+41e33cbcdc,g347aa1857d+37c5a29d61,g35bb328faa+a8ce1bb630,g3a166c0a6a+37c5a29d61,g3e281a1b8c+fb992f5633,g414038480c+7f03dfc1b0,g41af890bb2+11b950c980,g5fbc88fb19+17cd334064,g6b1c1869cb+12dd639c9a,g781aacb6e4+a8ce1bb630,g80478fca09+72e9651da0,g82479be7b0+04c31367b4,g858d7b2824+82efc23009,g9125e01d80+a8ce1bb630,g9726552aa6+8047e3811d,ga5288a1d22+e532dc0a0b,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc28159a63d+37c5a29d61,gcf0d15dbbd+2acd6d4d48,gd7358e8bfb+778a810b6e,gda3e153d99+82efc23009,gda6a2b7d83+2acd6d4d48,gdaeeff99f8+1711a396fd,ge2409df99d+6b12de1076,ge79ae78c31+37c5a29d61,gf0baf85859+d0a5978c5a,gf3967379c6+4954f8c433,gfb92a5be7c+82efc23009,gfec2e1e490+2aaed99252,w.2024.46
LSST Data Management Base Package
Loading...
Searching...
No Matches
FrameDict.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_FRAMEDICT_H
23#define ASTSHIM_FRAMEDICT_H
24
25#include <cassert>
26#include <memory>
27#include <set>
28#include <sstream>
29#include <stdexcept>
30#include <unordered_map>
31
32#include "astshim/base.h"
34#include "astshim/Frame.h"
35#include "astshim/FrameSet.h"
36
37namespace ast {
38
67class FrameDict : public FrameSet {
68 friend class Object;
69
70public:
81 explicit FrameDict(Frame const &frame, std::string const &options = "") : FrameSet(frame, options) {
82 _domainIndexDict = _makeNewDict(*this);
83 }
84
97 explicit FrameDict(Frame const &baseFrame, Mapping const &mapping, Frame const &currentFrame,
98 std::string const &options = "")
99 : FrameSet(baseFrame, mapping, currentFrame) {
100 _domainIndexDict = _makeNewDict(*this);
101 }
102
110 explicit FrameDict(FrameSet const &frameSet) : FrameSet(frameSet), _domainIndexDict() {
111 _domainIndexDict = _makeNewDict(*this);
112 }
113
114 virtual ~FrameDict() {}
115
117 FrameDict(FrameDict const &) = default;
118 FrameDict(FrameDict &&) = default;
119 FrameDict &operator=(FrameDict const &) = delete;
121
123 std::shared_ptr<FrameDict> copy() const { return std::static_pointer_cast<FrameDict>(copyPolymorphic()); }
124
131 void addFrame(int iframe, Mapping const &map, Frame const &frame) override;
132
137 void addFrame(std::string const &domain, Mapping const &map, Frame const &frame);
138
143
144 using FrameSet::getFrame;
145
151 std::shared_ptr<Frame> getFrame(std::string const &domain, bool copy = true) const {
152 return getFrame(getIndex(domain), copy);
153 }
154
156
163 return getMapping(from, getIndex(to));
164 }
165
172 return getMapping(getIndex(from), to);
173 }
174
181 return getMapping(getIndex(from), getIndex(to));
182 }
183
189 int getIndex(std::string const &domain) const {
190 auto domainUpper = detail::stringToUpper(domain);
191 auto it = _domainIndexDict.find(domainUpper);
192 if (it == _domainIndexDict.end()) {
193 throw std::out_of_range("No frame found with domain " + domain);
194 }
195 return it->second;
196 }
197
201 bool hasDomain(std::string const &domain) const { return _domainIndexDict.count(domain) > 0; }
202
204
210 void mirrorVariants(std::string const &domain) { mirrorVariants(getIndex(domain)); }
211
213
219 void remapFrame(std::string const &domain, Mapping &map) { remapFrame(getIndex(domain), map); }
220
222 void removeFrame(int iframe) override;
223
229 void removeFrame(std::string const &domain);
230
231 using FrameSet::setBase;
232
238 void setBase(std::string const &domain) { setBase(getIndex(domain)); }
239
241
247 void setCurrent(std::string const &domain) { setCurrent(getIndex(domain)); }
248
254 void setDomain(std::string const &domain) override;
255
256protected:
257 virtual std::shared_ptr<Object> copyPolymorphic() const override {
258 return copyImpl<FrameDict, AstFrameSet>();
259 }
260
274 return std::static_pointer_cast<FrameSet>(copyImpl<FrameSet, AstFrameSet>());
275 }
276
278 explicit FrameDict(AstFrameSet *rawptr);
279
280private:
281 /*
282 Build a new domain:index dict from a FrameSet
283 */
284 static std::unordered_map<std::string, int> _makeNewDict(FrameSet const &frameSet);
285
286 /*
287 Update the internal data using the supplied frameSet, which is swapped with the old data.
288
289 Build a new domain::index dict from frameSet. If successful, replace the current dict
290 and swap frameSet with the old frame set data.
291
292 If any exception is thrown this FrameDict (and the frameSet argument) is unchanged.
293 */
294 void _update(FrameSet &frameSet) {
295 _domainIndexDict = _makeNewDict(frameSet);
296 this->swapRawPointers(frameSet);
297 }
298
299 std::unordered_map<std::string, int> _domainIndexDict; // Dict of frame domain:index
300};
301
302} // namespace ast
303
304#endif
table::Key< table::Array< std::uint8_t > > frameSet
A FrameSet whose frames can be referenced by domain name.
Definition FrameDict.h:67
void addFrame(int iframe, Mapping const &map, Frame const &frame) override
Add a new Frame and an associated Mapping to this FrameSet so as to define a new coordinate system,...
Definition FrameDict.cc:32
void mirrorVariants(std::string const &domain)
Variant of mirrorVariants(int) with the frame specified by domain.
Definition FrameDict.h:210
bool hasDomain(std::string const &domain) const
Return True if a frame in this FrameDict has the specified domain.
Definition FrameDict.h:201
std::shared_ptr< Mapping > getMapping(int from, std::string const &to) const
Variant of FrameSet::getMapping with the second frame specified by domain.
Definition FrameDict.h:162
std::shared_ptr< FrameDict > copy() const
Return a deep copy of this object.
Definition FrameDict.h:123
std::shared_ptr< Mapping > getMapping(std::string const &from, int to) const
Variant of FrameSet::getMapping with the first frame specified by domain.
Definition FrameDict.h:171
virtual ~FrameDict()
Definition FrameDict.h:114
void setCurrent(std::string const &domain)
Variant of setCurrent(int) with the frame specified by domain.
Definition FrameDict.h:247
std::set< std::string > getAllDomains() const
Get the domain names for all contained Frames (excluding frames with empty or defaulted domain names)...
Definition FrameDict.cc:45
FrameDict & operator=(FrameDict const &)=delete
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition FrameDict.h:257
FrameDict & operator=(FrameDict &&)=default
std::shared_ptr< FrameSet > getFrameSet() const
Return a deep copy as a FrameSet.
Definition FrameDict.h:273
FrameDict(FrameDict &&)=default
FrameDict(Frame const &frame, std::string const &options="")
Construct a FrameDict from a single Frame.
Definition FrameDict.h:81
void removeFrame(int iframe) override
Remove a Frame from a FrameSet.
Definition FrameDict.cc:53
std::shared_ptr< Mapping > getMapping(std::string const &from, std::string const &to) const
Variant of FrameSet::getMapping with the both frames specified by domain.
Definition FrameDict.h:180
FrameDict(FrameDict const &)=default
Copy constructor: make a deep copy.
void remapFrame(std::string const &domain, Mapping &map)
Variant of remapFrame(int, Mapping&) with the frame specified by domain.
Definition FrameDict.h:219
FrameDict(Frame const &baseFrame, Mapping const &mapping, Frame const &currentFrame, std::string const &options="")
Construct a FrameDict from two frames and a mapping that connects them.
Definition FrameDict.h:97
std::shared_ptr< Frame > getFrame(std::string const &domain, bool copy=true) const
Variant of getFrame(int, bool) where the frame is specified by domain name.
Definition FrameDict.h:151
FrameDict(FrameSet const &frameSet)
Construct a FrameDict from a FrameSet.
Definition FrameDict.h:110
int getIndex(std::string const &domain) const
Get the index of a frame specified by domain.
Definition FrameDict.h:189
void setBase(std::string const &domain)
Variant of setBase(int) with the frame specified by domain.
Definition FrameDict.h:238
void setDomain(std::string const &domain) override
Set the domain of the current frame (and update the internal dict).
Definition FrameDict.cc:61
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
void setBase(int ind)
Set Base: index of base Frame.
Definition FrameSet.h:471
void setCurrent(int ind)
Set Current: index of current Frame, starting from 1.
Definition FrameSet.h:476
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
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
An abstract base class for objects which transform one set of coordinates to another.
Definition Mapping.h:59
Abstract base class for all AST objects.
Definition Object.h:51
friend class FrameDict
Definition Object.h:53
T count(T... args)
T end(T... args)
T find(T... args)
std::string stringToUpper(std::string const &str)
Return a copy of a string in which all characters are uppercase.
Definition utils.h:108
AST wrapper classes and functions.