NeighboringGridPoints.c File Reference

A helper function for wide-sky-area search codes validation. More...

#include "DopplerScan.h"
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <errno.h>
#include <lal/LALStdio.h>
#include <lal/LALStdlib.h>
#include <lal/LALDatatypes.h>
#include <lal/LALConstants.h>
#include <lal/StringInput.h>

Include dependency graph for NeighboringGridPoints.c:

Go to the source code of this file.

Defines
#define	NEIGHBORINGGRIDPOINTSH_ENULL   1
#define	NEIGHBORINGGRIDPOINTSH_ENONULL   2
#define	NEIGHBORINGGRIDPOINTSH_ESUB   3
#define	NEIGHBORINGGRIDPOINTSH_EMEM   4
#define	NEIGHBORINGGRIDPOINTSH_MSGENULL   "Arguments contained an unexpected null pointer"
#define	NEIGHBORINGGRIDPOINTSH_MSGENONULL   "Output pointer is not NULL"
#define	NEIGHBORINGGRIDPOINTSH_MSGESUB   "Failure in a subroutine call."
#define	NEIGHBORINGGRIDPOINTSH_MSGEMEM   "Memory allocation error."
Functions
	NRCSID (NEIGHBORINGGRIDPOINTSC,"$Id: NeighboringGridPoints.c,v 1.1 2007/11/05 20:07:09 reinhard Exp $")
void	RefineSkyRegion (LALStatus *status, DopplerScanInit *scanInit, DopplerScanState *scanState, SkyPosition *skyPosition, REAL8 *ratio)
void	ComputeCenterOfMass (LALStatus *status, SkyPosition *skyPosition, SkyRegion *skyRegion)
void	InitDopplerScanOnRefinedGrid (LALStatus *status, DopplerScanState *theScan,DopplerScanInit *scanInit)
	Refine the skyRegion to search only at neighboring grid points of the center of the original skyRegion.
Variables
INT4	lalDebugLevel
	DECLARE AND SET GLOBAL DEBUG LEVEL.

---

Detailed Description

A helper function for wide-sky-area search codes validation.

Author:

Itoh, Yousuke

Id

NeighboringGridPoints.c,v 1.1 2007/11/05 20:07:09 reinhard Exp

Note:

[1] A helper function for metric validations. At the same time, this is a wrapper for the Reinhard's InitDopplerScan(). This routine refine a usre-specified skyRegion so that the number of the grid points inside the region will be about a (hard-coded) desired value.

[2] Purpose When we search around a sky position, it may happen that we need to use numbers, "targetNumGridPoints", of sky grid points around the position. Taking the DopplerScanInit variable "scanInit", we try "maxTrial" times to refine the initial skyRegion "scanInit->skyRegion" so that the refined sky region contains "targetNumGridPoints +- tolerance" grid points. The output is a DopplerScanState variable "theScan".

The input/output are same as InitDopplerScan to cope with it and NOT to introduce additional command line arguments to ComputeFStatistic.

Revision

1.1

Todo:

• Make this code take a set of parameters: targetNumGridPoints, tolerance, maxTrial.
• Currently the refining algorithm assumes flat geometry. Make it appropriate to the celestial sphere

Definition in file NeighboringGridPoints.c.

---

Define Documentation

#define NEIGHBORINGGRIDPOINTSH_ENULL   1

Definition at line 73 of file NeighboringGridPoints.c.

#define NEIGHBORINGGRIDPOINTSH_ENONULL   2

Definition at line 74 of file NeighboringGridPoints.c.

#define NEIGHBORINGGRIDPOINTSH_ESUB   3

Definition at line 75 of file NeighboringGridPoints.c.

#define NEIGHBORINGGRIDPOINTSH_EMEM   4

Definition at line 76 of file NeighboringGridPoints.c.

#define NEIGHBORINGGRIDPOINTSH_MSGENULL   "Arguments contained an unexpected null pointer"

Definition at line 78 of file NeighboringGridPoints.c.

#define NEIGHBORINGGRIDPOINTSH_MSGENONULL   "Output pointer is not NULL"

Definition at line 79 of file NeighboringGridPoints.c.

#define NEIGHBORINGGRIDPOINTSH_MSGESUB   "Failure in a subroutine call."

Definition at line 80 of file NeighboringGridPoints.c.

#define NEIGHBORINGGRIDPOINTSH_MSGEMEM   "Memory allocation error."

Definition at line 81 of file NeighboringGridPoints.c.

---

Function Documentation

NRCSID	(	NEIGHBORINGGRIDPOINTSC	,
		"$Id: NeighboringGridPoints.	c,
		v 1.1 2007/11/05 20:07:09 reinhard Exp $"
	)

void RefineSkyRegion	(	LALStatus *	status,
		DopplerScanInit *	scanInit,
		DopplerScanState *	scanState,
		SkyPosition *	skyPosition,
		REAL8 *	ratio
	)

Computes ratio-scaled vertices

Parameters:

scanInit	output: includes scaled vertices
scanState	input: includes skyPosition to be scaled
centerOfMass	input: geometrical center of the skyRegion
ratio	input: ratio by which the skyRegion will be scaled

Definition at line 248 of file NeighboringGridPoints.c.

void ComputeCenterOfMass	(	LALStatus *	status,
		SkyPosition *	skyPosition,
		SkyRegion *	skyRegion
	)

Compute the geometrical center of the given skyRegion

Parameters:

skyposCM	output: center of mass of the vertices pointed by scanInit
skyRegion	input: Initial vertices.

Definition at line 201 of file NeighboringGridPoints.c.

void InitDopplerScanOnRefinedGrid	(	LALStatus *	status,
		DopplerScanState *	theScan,
		DopplerScanInit *	scanInit
	)

Refine the skyRegion to search only at neighboring grid points of the center of the original skyRegion.

refine the original skyRegion so that there are about "targetNumGridPoints" grid points within a new skyRegion. Return the new skyRegion

Parameters:

theScan	Output DopplerScanState variable includes a refined skyRegion
scanInit	Input DopplerScanInit variable includes the original skyRegion

Definition at line 99 of file NeighboringGridPoints.c.

---

Variable Documentation

INT4 lalDebugLevel

DECLARE AND SET GLOBAL DEBUG LEVEL.

see the section (currently 7.4.1) of the LSD on "Status-reporting objects" for a list of predefined debug levels

Definition at line 62 of file BCVSpinTemplates.c.

---