dspReduction.h
1//-*-C++-*-
2/***************************************************************************
3 *
4 * Copyright (C) 2003 by Willem van Straten
5 * Licensed under the Academic Free License version 2.1
6 *
7 ***************************************************************************/
8
9// psrchive/Base/Extensions/Pulsar/dspReduction.h
10
11#ifndef __dspReduction_h
12#define __dspReduction_h
13
14#include "Pulsar/ArchiveExtension.h"
15
16namespace Pulsar {
17
19
23
24 public:
25
27 dspReduction ();
28
30 dspReduction (const dspReduction& extension);
31
33 const dspReduction& operator= (const dspReduction& extension);
34
37
39 dspReduction* clone () const;
40
43
44 // Text interface to a dspReduction instance
45 class Interface : public TextInterface::To<dspReduction>
46 {
47 public:
48 Interface( dspReduction *s_instance = NULL );
49 };
50
52 std::string get_short_name () const { return "dspsr"; }
53
55 //
56 // Backend implementation
57 //
59
61 std::string get_software () const { return software; }
62
64 void set_software (const std::string& soft) { software = soft; }
65
71
73 uint64_t get_total_samples () const { return total_samples; }
75 void set_total_samples (uint64_t _total_samples)
76 { total_samples= _total_samples; }
77
79 uint64_t get_block_size () const { return block_size; }
81 void set_block_size (uint64_t _block_size)
82 { block_size = _block_size; }
83
85 uint64_t get_overlap () const { return overlap; }
87 void set_overlap (uint64_t _overlap)
88 { overlap = _overlap; }
89
91 Signal::State get_state () const { return state; }
94 { state = _state; }
95
97
103
105 unsigned get_nsamp_fft () const { return nsamp_fft; }
107 void set_nsamp_fft (unsigned _nsamp_fft)
108 { nsamp_fft = _nsamp_fft; }
109
111 unsigned get_nsamp_overlap_pos () const { return nsamp_overlap_pos; }
113 void set_nsamp_overlap_pos (unsigned _nsamp_overlap_pos)
114 { nsamp_overlap_pos = _nsamp_overlap_pos; }
115
117 unsigned get_nsamp_overlap_neg () const { return nsamp_overlap_neg; }
119 void set_nsamp_overlap_neg (unsigned _nsamp_overlap_neg)
120 { nsamp_overlap_neg = _nsamp_overlap_neg; }
121
123
129
131 unsigned get_nchan () const { return nchan; }
133 void set_nchan (unsigned _nchan)
134 { nchan = _nchan; }
135
137 unsigned get_freq_res () const { return freq_res; }
139 void set_freq_res (unsigned _freq_res)
140 { freq_res= _freq_res; }
141
143 unsigned get_time_res () const { return time_res; }
145 void set_time_res (unsigned _time_res)
146 { time_res= _time_res; }
147
149
150
156
158 unsigned get_ScrunchFactor () const { return ScrunchFactor; }
160 void set_ScrunchFactor (unsigned _ScrunchFactor)
161 { ScrunchFactor = _ScrunchFactor; }
162
163
165
171
173 double get_scale () const { return scale; }
175 void set_scale (double _scale)
176 { scale = _scale; }
177
179
180
181 protected:
182
184 std::string software;
185
191
194
196 uint64_t block_size;
197
199 uint64_t overlap;
200
203
205
211
213 unsigned nsamp_fft;
214
217
220
222
228
230 unsigned nchan;
231
233 unsigned freq_res;
234
236 unsigned time_res;
237
239
240
246
249
251
257
259 double scale;
260
262
263 };
264
265
266}
267
268#endif
Definition ArchiveExtension.h:24
void set_nsamp_overlap_pos(unsigned _nsamp_overlap_pos)
Number of time samples in wrap-around region, left-hand side.
Definition dspReduction.h:113
uint64_t block_size
The number of time samples in each block.
Definition dspReduction.h:196
std::string software
The software information.
Definition dspReduction.h:184
void set_state(Signal::State _state)
The state of the signal from Input::info.
Definition dspReduction.h:93
unsigned freq_res
Frequency resolution.
Definition dspReduction.h:233
void set_scale(double _scale)
Pulsar::Profiles are normalized by Observation::scale.
Definition dspReduction.h:175
unsigned get_ScrunchFactor() const
Time resolution reduction factor.
Definition dspReduction.h:158
double get_scale() const
Pulsar::Profiles are normalized by Observation::scale.
Definition dspReduction.h:173
~dspReduction()
Destructor.
Definition dspReduction.C:77
Signal::State get_state() const
The state of the signal from Input::info.
Definition dspReduction.h:91
void set_block_size(uint64_t _block_size)
The number of time samples in each block.
Definition dspReduction.h:81
unsigned time_res
Time resolution.
Definition dspReduction.h:236
unsigned nsamp_fft
Number of time samples in each FFT.
Definition dspReduction.h:213
void set_overlap(uint64_t _overlap)
The number of time samples by which consecutive blocks overlap.
Definition dspReduction.h:87
unsigned nsamp_overlap_neg
Number of time samples in wrap-around region, right-hand side.
Definition dspReduction.h:219
unsigned get_nsamp_fft() const
Number of time samples in each FFT.
Definition dspReduction.h:105
uint64_t total_samples
The total number of time samples.
Definition dspReduction.h:193
unsigned nsamp_overlap_pos
Number of time samples in wrap-around region, left-hand side.
Definition dspReduction.h:216
std::string get_short_name() const
Return a short name.
Definition dspReduction.h:52
void set_nchan(unsigned _nchan)
Number of frequency channels.
Definition dspReduction.h:133
dspReduction * clone() const
Clone method.
Definition dspReduction.C:43
void set_time_res(unsigned _time_res)
Time resolution.
Definition dspReduction.h:145
unsigned get_nchan() const
Number of frequency channels.
Definition dspReduction.h:131
void set_ScrunchFactor(unsigned _ScrunchFactor)
Time resolution reduction factor.
Definition dspReduction.h:160
TextInterface::Parser * get_interface()
get the text interface
Definition dspReduction.C:81
double scale
Pulsar::Profiles are normalized by Observation::scale.
Definition dspReduction.h:259
uint64_t get_block_size() const
The number of time samples in each block.
Definition dspReduction.h:79
unsigned ScrunchFactor
Time resolution reduction factor.
Definition dspReduction.h:248
uint64_t get_overlap() const
The number of time samples by which consecutive blocks overlap.
Definition dspReduction.h:85
dspReduction()
Default constructor.
Definition dspReduction.C:11
void set_software(const std::string &soft)
Set the software information.
Definition dspReduction.h:64
uint64_t get_total_samples() const
The total number of time samples.
Definition dspReduction.h:73
unsigned get_time_res() const
Time resolution.
Definition dspReduction.h:143
void set_nsamp_fft(unsigned _nsamp_fft)
Number of time samples in each FFT.
Definition dspReduction.h:107
Signal::State state
The state of the signal from Input::info.
Definition dspReduction.h:202
const dspReduction & operator=(const dspReduction &extension)
Assignment operator.
Definition dspReduction.C:53
std::string get_software() const
Get the software information.
Definition dspReduction.h:61
void set_total_samples(uint64_t _total_samples)
The total number of time samples.
Definition dspReduction.h:75
unsigned nchan
Number of frequency channels.
Definition dspReduction.h:230
unsigned get_freq_res() const
Frequency resolution.
Definition dspReduction.h:137
unsigned get_nsamp_overlap_pos() const
Number of time samples in wrap-around region, left-hand side.
Definition dspReduction.h:111
void set_freq_res(unsigned _freq_res)
Frequency resolution.
Definition dspReduction.h:139
unsigned get_nsamp_overlap_neg() const
Number of time samples in wrap-around region, right-hand side.
Definition dspReduction.h:117
void set_nsamp_overlap_neg(unsigned _nsamp_overlap_neg)
Number of time samples in wrap-around region, right-hand side.
Definition dspReduction.h:119
uint64_t overlap
The number of time samples by which consecutive blocks overlap.
Definition dspReduction.h:199
Defines the PSRCHIVE library.
Definition CalSource.h:17

Generated using doxygen 1.14.0