Computes the cross-correlation between two profiles. More...

#include <Correlate.h>

Inheritance diagram for Pulsar::Correlate:

Public Member Functions
void	transform (Profile *argument) override
	Set argument amplitudes equal to the cross-correlation between argument and operand.
void	set_normalize (bool flag)
	Modify the behaviour of subsequent calls to transform method.
Public Member Functions inherited from Pulsar::Combination< Profile >
void	set_operand (const Profile *o)
	Set the Container from which data will be taken during tranformation.
const Profile *	get_operand () const
	Get the Container from which data will be taken during transformation.
Public Member Functions inherited from Pulsar::Transformation< Profile >
void	operator() (Profile *container)
	Functor interface.
Public Member Functions inherited from Reference::Able
	Able (const Able &)
Able &	operator= (const Able &)
unsigned	get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)
HeapTracked &	operator= (const HeapTracked &)
bool	__is_on_heap () const

Protected Attributes
bool	normalize = true
	By default, call Profile::correlate_normalized to compute the power-normalized cross-correlation.
Protected Attributes inherited from Pulsar::Combination< Profile >
Reference::To< const Profile >	operand

Additional Inherited Members
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()
Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)
static void	operator delete (void location, void ptr)
static void	operator delete (void *location)
static size_t	get_heap_queue_size ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Computes the cross-correlation between two profiles.

Member Function Documentation

void Pulsar::Correlate::set_normalize ( bool flag )

inline

Modify the behaviour of subsequent calls to transform method.

If true, call Profile::correlate_normalized to compute the power-normalized cross-correlation If false, call Profile::correlate

References normalize.

void Pulsar::Correlate::transform ( Profile * argument )

overridevirtual

Set argument amplitudes equal to the cross-correlation between argument and operand.

operand is a member of the Combination<Profile> base class

The documentation for this class was generated from the following files: