LSSTApplications  20.0.0
LSSTDataManagementBasePackage
SphMap.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_SPHMAP_H
23 #define ASTSHIM_SPHMAP_H
24 
25 #include <memory>
26 
27 #include "astshim/base.h"
28 #include "astshim/Mapping.h"
29 
30 namespace ast {
31 
54 class SphMap : public Mapping {
55  friend class Object;
56 
57 public:
63  explicit SphMap(std::string const &options = "")
64  : Mapping(reinterpret_cast<AstMapping *>(astSphMap("%s", options.c_str()))) {
65  assertOK();
66  }
67 
68  virtual ~SphMap() {}
69 
71  SphMap(SphMap const &) = default;
72  SphMap(SphMap &&) = default;
73  SphMap &operator=(SphMap const &) = delete;
74  SphMap &operator=(SphMap &&) = default;
75 
77  std::shared_ptr<SphMap> copy() const { return std::static_pointer_cast<SphMap>(copyPolymorphic()); }
78 
80  bool getUnitRadius() const { return getB("UnitRadius"); }
81 
83  double getPolarLong() const { return getD("PolarLong"); }
84 
85 protected:
86  virtual std::shared_ptr<Object> copyPolymorphic() const override {
87  return copyImpl<SphMap, AstSphMap>();
88  }
89 
91  explicit SphMap(AstSphMap *rawptr) : Mapping(reinterpret_cast<AstMapping *>(rawptr)) {
92  if (!astIsASphMap(getRawPtr())) {
94  os << "this is a " << getClassName() << ", which is not a SphMap";
95  throw std::invalid_argument(os.str());
96  }
97  }
98 };
99 
100 } // namespace ast
101 
102 #endif
ast::Object::getB
bool getB(std::string const &attrib) const
Get the value of an attribute as a bool.
Definition: Object.h:348
std::string
STL class.
std::shared_ptr
STL class.
ast::SphMap::SphMap
SphMap(std::string const &options="")
Construct a SphMap.
Definition: SphMap.h:63
ast::SphMap::~SphMap
virtual ~SphMap()
Definition: SphMap.h:68
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::Mapping
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
ast::SphMap::getUnitRadius
bool getUnitRadius() const
Get UnitRadius: input vectors lie on a unit sphere?
Definition: SphMap.h:80
base.h
ast::Object
Abstract base class for all AST objects.
Definition: Object.h:51
ast::SphMap::getPolarLong
double getPolarLong() const
Get PolarLong: the longitude value to assign to either pole (radians).
Definition: SphMap.h:83
ast::Object::getClassName
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
ast::SphMap::SphMap
SphMap(SphMap const &)=default
Copy constructor: make a deep copy.
ast::SphMap::operator=
SphMap & operator=(SphMap &&)=default
std::invalid_argument
STL class.
ast::SphMap::SphMap
SphMap(SphMap &&)=default
ast::SphMap
A SphMap is a Mapping which transforms points from a 3-dimensional Cartesian coordinate system into a...
Definition: SphMap.h:54
ast::SphMap::operator=
SphMap & operator=(SphMap const &)=delete
std::ostringstream
STL class.
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
os
std::ostream * os
Definition: Schema.cc:746
ast::Object::getD
double getD(std::string const &attrib) const
Get the value of an attribute as a double.
Definition: Object.h:374
Mapping.h
ast::Object::getRawPtr
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
ast::SphMap::SphMap
SphMap(AstSphMap *rawptr)
Construct a SphMap from a raw AST pointer.
Definition: SphMap.h:91
ast::SphMap::copy
std::shared_ptr< SphMap > copy() const
Return a deep copy of this object.
Definition: SphMap.h:77
ast::SphMap::copyPolymorphic
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: SphMap.h:86