Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
ProfileManager.h
1 /*
2  * The MIT License (MIT)
3  *
4  * Copyright (c) 2016 The SKA organisation
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef SKA_CHEETAH_GENERATORS_PROFILEMANAGER_H
25 #define SKA_CHEETAH_GENERATORS_PROFILEMANAGER_H
26 
27 #include "cheetah/generators/pulse_profile/PulsarProfile.h"
28 #include "cheetah/generators/pulse_profile/PulsarProfileId.h"
29 #include "cheetah/data/Units.h"
30 
31 #include <map>
32 #include <list>
33 
34 namespace ska {
35 namespace cheetah {
36 namespace generators {
37 
38 class PulsarProfileConfig;
39 
47 {
48  public:
49  typedef boost::units::quantity<data::MilliSeconds, double> PeriodUnitType;
50 
51  public:
53  ~ProfileManager();
54 
58  PulsarProfile profile(PulsarProfileId const&) const ;
60 
69  void add(PulsarProfileId id, PulsarProfile profile);
70 
71  private:
72  std::map<PulsarProfileId, PulsarProfile> _profiles;
73  std::list<PulsarProfileId> _pulsar_id;
74 };
75 
76 
77 } // namespace generators
78 } // namespace cheetah
79 } // namespace ska
80 
81 #endif // SKA_CHEETAH_GENERATORS_PROFILEMANAGER_H
An API for accessing pulsar pulse profiles.
PulsarProfile profile(PulsarProfileId const &) const
return a profile of a known pulsar
A simple intensity profile representing a pulse shape.
Definition: PulsarProfile.h:43
void add(PulsarProfileId id, PulsarProfile profile)
return the list of known pulsar profiles std::list<PulsarProfileId> const& profile_list() const; ...
Some limits and constants for FLDO.
Definition: Brdz.h:35
placeholder for specifying pulsar profile database URI
define pulsar profiles in a config