Detailed Description

Nearest-neighbor interpolation.

Perform trivial, nearest-neighbor interpolation. Always sets *tmax = 0, *ymax = data[0].

Warning: It is an error to request a nearest-neighbor workspace with a window size not equal to 0.

Prototypes
NearestNeighborTriggerInterpolant *	XLALCreateNearestNeighborTriggerInterpolant (unsigned int window)
	Constructor. More...

void	XLALDestroyNearestNeighborTriggerInterpolant (NearestNeighborTriggerInterpolant *)
	Destructor. More...

int	XLALCOMPLEX16ApplyNearestNeighborTriggerInterpolant (NearestNeighborTriggerInterpolant interp, double tmax, COMPLEX16 ymax, const COMPLEX16 y)
	Perform interpolation using the allocated workspace. More...

int	XLALCOMPLEX8ApplyNearestNeighborTriggerInterpolant (NearestNeighborTriggerInterpolant interp, double tmax, COMPLEX8 ymax, const COMPLEX8 y)

int	XLALREAL8ApplyNearestNeighborTriggerInterpolant (NearestNeighborTriggerInterpolant interp, double tmax, REAL8 ymax, const REAL8 y)

int	XLALREAL4ApplyNearestNeighborTriggerInterpolant (NearestNeighborTriggerInterpolant interp, double tmax, REAL4 ymax, const REAL4 y)

Function Documentation

◆ XLALCreateNearestNeighborTriggerInterpolant()

NearestNeighborTriggerInterpolant* XLALCreateNearestNeighborTriggerInterpolant ( unsigned int window )

Constructor.

Allocate a new interpolation workspace and return a pointer to it, or NULL if an error occurs.

Warning: It is an error to request a nearest-neighbor workspace with a window size not equal to 0.

Definition at line 564 of file TriggerInterpolation.c.

◆ XLALDestroyNearestNeighborTriggerInterpolant()

void XLALDestroyNearestNeighborTriggerInterpolant ( NearestNeighborTriggerInterpolant * interp )

Destructor.

If the workspace is non-NULL, deallocate it.

Definition at line 583 of file TriggerInterpolation.c.

◆ XLALCOMPLEX16ApplyNearestNeighborTriggerInterpolant()

int XLALCOMPLEX16ApplyNearestNeighborTriggerInterpolant	(	NearestNeighborTriggerInterpolant *	interp,
		double *	tmax,
		COMPLEX16 *	ymax,
		const COMPLEX16 *	y
	)

Perform interpolation using the allocated workspace.

Perform interpolation around the matched-filter output data pointed to by y. There should exist window samples before and window samples after this pointer.

On success, set *tmax to the interpolated time, *ymax to the complex interpolated signal, and return 0. On failure, return a non-zero GSL error code.

◆ XLALCOMPLEX8ApplyNearestNeighborTriggerInterpolant()

int XLALCOMPLEX8ApplyNearestNeighborTriggerInterpolant	(	NearestNeighborTriggerInterpolant *	interp,
		double *	tmax,
		COMPLEX8 *	ymax,
		const COMPLEX8 *	y
	)

Definition at line 601 of file TriggerInterpolation.c.

◆ XLALREAL8ApplyNearestNeighborTriggerInterpolant()

int XLALREAL8ApplyNearestNeighborTriggerInterpolant	(	NearestNeighborTriggerInterpolant *	interp,
		double *	tmax,
		REAL8 *	ymax,
		const REAL8 *	y
	)

Definition at line 613 of file TriggerInterpolation.c.

◆ XLALREAL4ApplyNearestNeighborTriggerInterpolant()

int XLALREAL4ApplyNearestNeighborTriggerInterpolant	(	NearestNeighborTriggerInterpolant *	interp,
		double *	tmax,
		REAL4 *	ymax,
		const REAL4 *	y
	)

Definition at line 625 of file TriggerInterpolation.c.