LSSTApplications  19.0.0-14-gb0260a2+1b4fc4249b,20.0.0+19029f0d82,20.0.0+66077e84be,20.0.0+b8df9e862d,20.0.0+e2e26847c2,20.0.0+e47e9b3a81,20.0.0-1-g253301a+19029f0d82,20.0.0-1-g2b7511a+46a6078777,20.0.0-1-g3dda6ea+905cef1a44,20.0.0-1-g4d801e7+5fcfd52d2e,20.0.0-1-g5b95a8c+19889959e1,20.0.0-1-gc96f8cb+d5e4df5959,20.0.0-1-gedffbd8+6ca2c30637,20.0.0-10-g0891cd99+caa8c2603a,20.0.0-13-gad96b2d30+614f89f815,20.0.0-17-gcdbda88+2b141d441d,20.0.0-2-g4dae9ad+d5e4df5959,20.0.0-2-g52fdb94+046030bafd,20.0.0-2-g61b8584+85c46248f3,20.0.0-2-g8177d33+f2ab36af31,20.0.0-2-gb780d76+f45b7d88f4,20.0.0-2-gf072044+19029f0d82,20.0.0-22-gdf434b7+d5e4df5959,20.0.0-23-g10eeb28+452d7a9290,20.0.0-23-g8900aa8+a8b4322b0e,20.0.0-3-g1653f94+85c46248f3,20.0.0-3-g4cc78c6+63636aeed8,20.0.0-3-g750bffe+7a989609f2,20.0.0-3-gbd60e8c+ff10c6d78d,20.0.0-33-g078e64d5+a2256d2c79,20.0.0-4-g97dc21a+a8b4322b0e,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-6-g9a5b7a1+3d4d12ed4e,20.0.0-61-g4de25fb+ddf3488217,20.0.0-7-gcda7bf1+dffc53c16b,w.2020.44
LSSTDataManagementBasePackage
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 
32 namespace ast {
33 
99 class FrameSet : public Frame {
100  friend class Frame; // so Frame can call the protected raw ptr constructor
101  friend class Object;
102 
103 public:
104  static int constexpr BASE = AST__BASE;
105  static int constexpr CURRENT = AST__CURRENT;
106  static int constexpr NOFRAME = AST__NOFRAME;
107 
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;
144  FrameSet &operator=(FrameSet &&) = default;
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 
478 protected:
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 
498 private:
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
ast::FrameSet::removeFrame
virtual void removeFrame(int iframe)
Remove a Frame from a FrameSet.
Definition: FrameSet.h:442
ast::FrameSet::~FrameSet
virtual ~FrameSet()
Definition: FrameSet.h:138
from
table::Key< int > from
Definition: TransformMap.cc:348
ast::FrameSet::getNFrame
int getNFrame() const
Get FrameSet_NFrame "NFrame": number of Frames in the FrameSet, starting from 1.
Definition: FrameSet.h:316
ast::FrameSet
A FrameSet consists of a set of one or more Frames (which describe coordinate systems),...
Definition: FrameSet.h:99
std::string
STL class.
Frame.h
std::shared_ptr
STL class.
ast::assertOK
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition: base.cc:49
ast::FrameSet::getVariant
std::string getVariant() const
Variant: name of variant mapping in use by current Frame
Definition: FrameSet.h:323
ast::FrameSet::getFrame
std::shared_ptr< Frame > getFrame(int iframe, bool copy=true) const
Obtain a deep copy of the specified Frame.
Definition: FrameSet.h:270
ast::Mapping
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
ast::FrameSet::NOFRAME
static constexpr int NOFRAME
an invalid frame index
Definition: FrameSet.h:106
ast::FrameSet::setBase
void setBase(int ind)
Set Base: index of base Frame.
Definition: FrameSet.h:471
ast::FrameSet::operator=
FrameSet & operator=(FrameSet &&)=default
ast::FrameSet::mirrorVariants
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
ast::Object
Abstract base class for all AST objects.
Definition: Object.h:51
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
ast::FrameSet::copyPolymorphic
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: FrameSet.h:479
ast::FrameSet::getCurrent
int getCurrent() const
Get Current: index of current Frame, starting from 1.
Definition: FrameSet.h:253
ast::Object::getClassName
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
ast::Frame
Frame is used to represent a coordinate system.
Definition: Frame.h:157
ast::Object::getI
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
ast::FrameSet::CURRENT
static constexpr int CURRENT
index of current frame
Definition: FrameSet.h:105
ast::FrameSet::addVariant
void addVariant(Mapping const &map, std::string const &name)
Store a new variant Mapping with the current Frame.
Definition: FrameSet.h:234
std::runtime_error
STL class.
ast::FrameSet::renameVariant
void renameVariant(std::string const &name)
Rename the current Variant of the current Mapping.
Definition: FrameSet.h:463
std::invalid_argument
STL class.
ast::FrameSet::setCurrent
void setCurrent(int ind)
Set Current: index of current Frame, starting from 1.
Definition: FrameSet.h:476
ast::FrameSet::copy
std::shared_ptr< FrameSet > copy() const
Return a deep copy of this object.
Definition: FrameSet.h:147
ast::FrameSet::remapFrame
void remapFrame(int iframe, Mapping &map)
Modify the relationship (i.e.
Definition: FrameSet.h:410
ast::Mapping::copy
std::shared_ptr< Mapping > copy() const
Return a deep copy of this object.
Definition: Mapping.h:72
std::ostringstream
STL class.
to
table::Key< int > to
Definition: TransformMap.cc:349
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
ast::FrameSet::FrameSet
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
os
std::ostream * os
Definition: Schema.cc:746
ast::FrameSet::FrameSet
FrameSet(Frame const &frame, std::string const &options="")
Construct a FrameSet from a Frame.
Definition: FrameSet.h:117
ast::FrameSet::addAxes
void addAxes(Frame const &frame)
Append the axes from a specified Frame to every existing Frame in this FrameSet.
Definition: FrameSet.h:160
ast::FrameSet::addFrame
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
ast::FrameSet::BASE
static constexpr int BASE
index of base frame
Definition: FrameSet.h:104
base.h
ast::Object::setI
void setI(std::string const &attrib, int value)
Set the value of an attribute as an int.
Definition: Object.h:500
ast::Object::getC
std::string const getC(std::string const &attrib) const
Get the value of an attribute as a string.
Definition: Object.h:361
ast::FrameSet::operator=
FrameSet & operator=(FrameSet const &)=delete
ast::FrameSet::FrameSet
FrameSet(FrameSet const &)=default
Copy constructor: make a deep copy.
ast::Object::getRawPtr
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
ast::FrameSet::getAllVariants
std::string getAllVariants() const
Get AllVariants: a list of all variant mappings stored with the current Frame.
Definition: FrameSet.h:243
ast::FrameSet::FrameSet
FrameSet(AstFrameSet *rawPtr)
Construct a FrameSet from a raw AST pointer.
Definition: FrameSet.h:490
ast::FrameSet::FrameSet
FrameSet(FrameSet &&)=default
ast::FrameSet::getMapping
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
ast::FrameSet::getBase
int getBase() const
Get Base: index of base Frame.
Definition: FrameSet.h:248