Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
SigProcFileStream.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_SIGPROC_SIGPROCFILESTREAM_H
25 #define SKA_CHEETAH_SIGPROC_SIGPROCFILESTREAM_H
26 
27 #include "panda/Producer.h"
28 #include "cheetah/data/TimeFrequency.h"
29 #include "cheetah/sigproc/SigProcHeader.h"
30 #include "cheetah/sigproc/Config.h"
31 #include <fstream>
32 #include <string>
33 #include <vector>
34 
35 namespace ska {
36 namespace cheetah {
37 namespace sigproc {
45 class SigProcFileStream : public ska::panda::Producer<SigProcFileStream, data::TimeFrequency<Cpu, uint8_t>>
46 {
47  public:
48  SigProcFileStream(Config const& config);
50 
54  bool process();
55 
56  protected:
61  std::size_t number_of_data_samples() const;
62 
63  private:
64  void transfer_header_info(data::TimeFrequency<Cpu, uint8_t>& chunk);
65  bool fill_chunk(data::TimeFrequency<Cpu, uint8_t>& chunk, std::size_t offset, data::TimeFrequency<Cpu, uint8_t>::iterator& it );
66 
67  private:
68  bool next_file();
69  std::ifstream _file_stream;
70 
71  private:
72  Config const& _config;
73  SigProcHeader _header;
74  utils::ModifiedJulianClock::time_point _start_time;
75 
76  mutable std::size_t _nsamples; // calculated number of samples from header info and file size
77  std::vector<std::string> _filenames;
78  std::vector<std::string>::const_iterator _file_it;
79 };
80 
81 } // namespace sigproc
82 } // namespace cheetah
83 } // namespace ska
84 
85 #endif // SKA_CHEETAH_SIGPROC_SIGPROCFILESTREAM_H
SigProc configuration parameters.
Definition: Config.h:39
std::size_t number_of_data_samples() const
return the number of samples (time * channels) in the currently opened file
Some limits and constants for FLDO.
Definition: Brdz.h:35
struct for the header information of a SigProc file
Definition: SigProcHeader.h:43
Read in a SigProc format input file and generate a series of data chunks.