Detailed Description

Computes statistics of the Hough maps.

Author: Krishnan, B., Sintes, A.M.

Synopsis

#include <lal/Statistics.h>

Given a total Hough map, this calculates the maximum number count, minimum number count, average and standard deviation and produces a histogram of the number counts.

Prototypes
void	LALHoughStatistics (LALStatus status, HoughStats out, HOUGHMapTotal *in)
	This function calculates the maximum number count, minimum number count, average and standard deviation of a given total Hough map. More...

void	LALHoughHistogram (LALStatus status, UINT8Vector out, HOUGHMapTotal *in)
	Produces a histogram of the number counts in a total Hough map. More...

void	LALHoughmapMeanVariance (LALStatus status, REAL8 mean, REAL8 variance, HOUGHMapTotal in)

Data Structures
struct	HoughStats
	Structure for storing statistical information about a Hough map. More...

Files
file	StatisticsTest.c
	Tests the statistics and the histogram number count of a given total Hough map.

Error Codes
#define	STATISTICSH_ENULL 1

#define	STATISTICSH_EVAL 2

#define	STATISTICSH_MSGENULL "Null Pointer"

#define	STATISTICSH_MSGEVAL "Invalid Value"

Function Documentation

◆ LALHoughStatistics()

void LALHoughStatistics	(	LALStatus *	status,
		HoughStats *	out,
		HOUGHMapTotal *	in
	)

This function calculates the maximum number count, minimum number count, average and standard deviation of a given total Hough map.

Calculates max, min, average and standard deviation of Hough number counts.

The input HOUGHMapTotal *in is a total Hough map and the output is a structure HoughStats *out.

Parameters

status	pointer to LALStatus structure
out	output containing statistics
in	hough map

Definition at line 33 of file lib/Statistics.c.

◆ LALHoughHistogram()

void LALHoughHistogram	(	LALStatus *	status,
		UINT8Vector *	out,
		HOUGHMapTotal *	in
	)

Produces a histogram of the number counts in a total Hough map.

Calculates number count histogram.

The input is of type HOUGHMapTotal *in and the output UINT4Vector *out.

Parameters

status	pointer to LALStatus structure
out	histogram
in	hough map

Definition at line 182 of file lib/Statistics.c.

◆ LALHoughmapMeanVariance()

void LALHoughmapMeanVariance	(	LALStatus *	status,
		REAL8 *	mean,
		REAL8 *	variance,
		HOUGHMapTotal *	in
	)

Definition at line 126 of file lib/Statistics.c.

Macro Definition Documentation

◆ STATISTICSH_ENULL

#define STATISTICSH_ENULL 1

Definition at line 64 of file lib/Statistics.h.

◆ STATISTICSH_EVAL

#define STATISTICSH_EVAL 2

Definition at line 65 of file lib/Statistics.h.

◆ STATISTICSH_MSGENULL

#define STATISTICSH_MSGENULL "Null Pointer"

Definition at line 66 of file lib/Statistics.h.

◆ STATISTICSH_MSGEVAL

#define STATISTICSH_MSGEVAL "Invalid Value"

Definition at line 67 of file lib/Statistics.h.