Correlate.h
1//-*-C++-*-
2/***************************************************************************
3 *
4 * Copyright (C) 2012 by Willem van Straten
5 * Licensed under the Academic Free License version 2.1
6 *
7 ***************************************************************************/
8
9// psrchive/psrchive/More/General/Pulsar/Correlate.h
10
11#ifndef __Pulsar_Correlate_h
12#define __Pulsar_Correlate_h
13
14#include "Pulsar/Combination.h"
15#include "Pulsar/Profile.h"
16
17namespace Pulsar {
18
20 class Correlate : public Combination<Profile>
21 {
22 public:
23
25
26 void transform (Profile* argument) override;
27
29
31 void set_normalize(bool flag) { normalize = flag; }
32
33 protected:
34
36 bool normalize = true;
37 };
38
39}
40
41#endif
Binary transformations that combine data from another Container.
Definition Combination.h:21
Computes the cross-correlation between two profiles.
Definition Correlate.h:21
bool normalize
By default, call Profile::correlate_normalized to compute the power-normalized cross-correlation.
Definition Correlate.h:36
void set_normalize(bool flag)
Modify the behaviour of subsequent calls to transform method.
Definition Correlate.h:31
void transform(Profile *argument) override
Set argument amplitudes equal to the cross-correlation between argument and operand.
Definition Correlate.C:13
Any quantity recorded as a function of pulse phase.
Definition Profile.h:40
Defines the PSRCHIVE library.
Definition CalSource.h:17

Generated using doxygen 1.14.0