Window.h File Reference

#include <lal/LALDatatypes.h>

Include dependency graph for Window.h:

Go to the source code of this file.

Data Structures
struct	tagREAL4Window
struct	tagREAL8Window
struct	tagLALWindowParams
Typedefs
typedef tagREAL4Window	REAL4Window
typedef tagREAL8Window	REAL8Window
typedef tagLALWindowParams	LALWindowParams
Enumerations
enum	WindowType {   Rectangular, Hann, Welch, Bartlett,   Parzen, Papoulis, Hamming, Kaiser,   Creighton, Tukey, BARTLETT = 1, HANN,   RECTANGULAR, WELCH }
Functions
	NRCSID (WINDOWH,"$Id: Window.h,v 1.21 2008/10/06 04:28:04 kipp Exp $")
REAL4Window *	XLALCreateREAL4WindowFromSequence (REAL4Sequence *sequence)
	Single-precision version of XLALCreateREAL8WindowFromSequence().
REAL8Window *	XLALCreateREAL8WindowFromSequence (REAL8Sequence *sequence)
	Constructs a new REAL8Window from a REAL8Sequence.
REAL4Window *	XLALCreateRectangularREAL4Window (UINT4 length)
REAL4Window *	XLALCreateHannREAL4Window (UINT4 length)
REAL4Window *	XLALCreateWelchREAL4Window (UINT4 length)
REAL4Window *	XLALCreateBartlettREAL4Window (UINT4 length)
REAL4Window *	XLALCreateParzenREAL4Window (UINT4 length)
REAL4Window *	XLALCreatePapoulisREAL4Window (UINT4 length)
REAL4Window *	XLALCreateHammingREAL4Window (UINT4 length)
REAL4Window *	XLALCreateKaiserREAL4Window (UINT4 length, REAL4 beta)
REAL4Window *	XLALCreateCreightonREAL4Window (UINT4 length, REAL4 beta)
REAL4Window *	XLALCreateTukeyREAL4Window (UINT4 length, REAL4 beta)
REAL4Window *	XLALCreateGaussREAL4Window (UINT4 length, REAL4 beta)
REAL8Window *	XLALCreateRectangularREAL8Window (UINT4 length)
REAL8Window *	XLALCreateHannREAL8Window (UINT4 length)
REAL8Window *	XLALCreateWelchREAL8Window (UINT4 length)
REAL8Window *	XLALCreateBartlettREAL8Window (UINT4 length)
REAL8Window *	XLALCreateParzenREAL8Window (UINT4 length)
REAL8Window *	XLALCreatePapoulisREAL8Window (UINT4 length)
REAL8Window *	XLALCreateHammingREAL8Window (UINT4 length)
REAL8Window *	XLALCreateKaiserREAL8Window (UINT4 length, REAL8 beta)
REAL8Window *	XLALCreateCreightonREAL8Window (UINT4 length, REAL8 beta)
REAL8Window *	XLALCreateTukeyREAL8Window (UINT4 length, REAL8 beta)
REAL8Window *	XLALCreateGaussREAL8Window (UINT4 length, REAL8 beta)
void	XLALDestroyREAL4Window (REAL4Window *window)
void	XLALDestroyREAL8Window (REAL8Window *window)
REAL4Sequence *	XLALUnitaryWindowREAL4Sequence (REAL4Sequence *sequence, const REAL4Window *window)
	Single-precision version of XLALUnitaryWindowREAL8Sequence().
COMPLEX8Sequence *	XLALUnitaryWindowCOMPLEX8Sequence (COMPLEX8Sequence *sequence, const REAL4Window *window)
	Single-precision complex version of XLALUnitaryWindowREAL8Sequence().
REAL8Sequence *	XLALUnitaryWindowREAL8Sequence (REAL8Sequence *sequence, const REAL8Window *window)
	Multiply a REAL8Sequence by a REAL8Window with a normalization that preserves the RMS of stationary noise.
COMPLEX16Sequence *	XLALUnitaryWindowCOMPLEX16Sequence (COMPLEX16Sequence *sequence, const REAL8Window *window)
	Double-precision complex version of XLALUnitaryWindowREAL8Sequence().
void	LALWindow (LALStatus *, REAL4Vector *, LALWindowParams *)
void	LALCreateREAL4Window (LALStatus *, REAL4Window **, LALWindowParams *)

---

Typedef Documentation

typedef struct tagREAL4Window REAL4Window

typedef struct tagREAL8Window REAL8Window

typedef struct tagLALWindowParams LALWindowParams

---

Enumeration Type Documentation

enum WindowType

Enumerator:

Rectangular
Hann
Welch
Bartlett
Parzen
Papoulis
Hamming
Kaiser
Creighton
Tukey
BARTLETT
HANN
RECTANGULAR
WELCH

Definition at line 90 of file Window.h.

---

Function Documentation

NRCSID	(	WINDOWH	,
		"$Id: Window.	h,
		v 1.21 2008/10/06 04:28:04 kipp Exp $"
	)

REAL4Window* XLALCreateREAL4WindowFromSequence

(

REAL4Sequence *

sequence

)

Single-precision version of XLALCreateREAL8WindowFromSequence().

Definition at line 240 of file Window.c.

REAL8Window* XLALCreateREAL8WindowFromSequence

(

REAL8Sequence *

sequence

)

Constructs a new REAL8Window from a REAL8Sequence.

The window "owns" the sequence, when the window is destroyed the sequence will be destroyed with it. If this function fails, the sequence is destroyed. The return value is the address of the newly allocated REAL8Window or NULL on failure.

Definition at line 216 of file Window.c.

REAL4Window* XLALCreateRectangularREAL4Window

(

UINT4

length

)

Definition at line 730 of file Window.c.

REAL4Window* XLALCreateHannREAL4Window

(

UINT4

length

)

Definition at line 738 of file Window.c.

REAL4Window* XLALCreateWelchREAL4Window

(

UINT4

length

)

Definition at line 746 of file Window.c.

REAL4Window* XLALCreateBartlettREAL4Window

(

UINT4

length

)

Definition at line 754 of file Window.c.

REAL4Window* XLALCreateParzenREAL4Window

(

UINT4

length

)

Definition at line 762 of file Window.c.

REAL4Window* XLALCreatePapoulisREAL4Window

(

UINT4

length

)

Definition at line 770 of file Window.c.

REAL4Window* XLALCreateHammingREAL4Window

(

UINT4

length

)

Definition at line 778 of file Window.c.

REAL4Window* XLALCreateKaiserREAL4Window	(	UINT4	length,
		REAL4	beta
	)

Definition at line 786 of file Window.c.

REAL4Window* XLALCreateCreightonREAL4Window	(	UINT4	length,
		REAL4	beta
	)

Definition at line 794 of file Window.c.

REAL4Window* XLALCreateTukeyREAL4Window	(	UINT4	length,
		REAL4	beta
	)

Definition at line 802 of file Window.c.

REAL4Window* XLALCreateGaussREAL4Window	(	UINT4	length,
		REAL4	beta
	)

Definition at line 810 of file Window.c.

REAL8Window* XLALCreateRectangularREAL8Window

(

UINT4

length

)

Definition at line 379 of file Window.c.

REAL8Window* XLALCreateHannREAL8Window

(

UINT4

length

)

Definition at line 399 of file Window.c.

REAL8Window* XLALCreateWelchREAL8Window

(

UINT4

length

)

Definition at line 419 of file Window.c.

REAL8Window* XLALCreateBartlettREAL8Window

(

UINT4

length

)

Definition at line 440 of file Window.c.

REAL8Window* XLALCreateParzenREAL8Window

(

UINT4

length

)

Definition at line 462 of file Window.c.

REAL8Window* XLALCreatePapoulisREAL8Window

(

UINT4

length

)

Definition at line 486 of file Window.c.

REAL8Window* XLALCreateHammingREAL8Window

(

UINT4

length

)

Definition at line 508 of file Window.c.

REAL8Window* XLALCreateKaiserREAL8Window	(	UINT4	length,
		REAL8	beta
	)

Definition at line 528 of file Window.c.

REAL8Window* XLALCreateCreightonREAL8Window	(	UINT4	length,
		REAL8	beta
	)

Definition at line 615 of file Window.c.

REAL8Window* XLALCreateTukeyREAL8Window	(	UINT4	length,
		REAL8	beta
	)

Definition at line 652 of file Window.c.

REAL8Window* XLALCreateGaussREAL8Window	(	UINT4	length,
		REAL8	beta
	)

Definition at line 681 of file Window.c.

void XLALDestroyREAL4Window

(

REAL4Window *

window

)

Definition at line 818 of file Window.c.

void XLALDestroyREAL8Window

(

REAL8Window *

window

)

Definition at line 711 of file Window.c.

REAL4Sequence* XLALUnitaryWindowREAL4Sequence	(	REAL4Sequence *	sequence,
		const REAL4Window *	window
	)

Single-precision version of XLALUnitaryWindowREAL8Sequence().

Definition at line 328 of file Window.c.

COMPLEX8Sequence* XLALUnitaryWindowCOMPLEX8Sequence	(	COMPLEX8Sequence *	sequence,
		const REAL4Window *	window
	)

Single-precision complex version of XLALUnitaryWindowREAL8Sequence().

Definition at line 351 of file Window.c.

REAL8Sequence* XLALUnitaryWindowREAL8Sequence	(	REAL8Sequence *	sequence,
		const REAL8Window *	window
	)

Multiply a REAL8Sequence by a REAL8Window with a normalization that preserves the RMS of stationary noise.

If the window's length is N and its sum-of-squares is S, then the input sequence is multiplied by the window and {N / S}. Returns the address of the REAL8Sequence or NULL on failure.

Definition at line 282 of file Window.c.

COMPLEX16Sequence* XLALUnitaryWindowCOMPLEX16Sequence	(	COMPLEX16Sequence *	sequence,
		const REAL8Window *	window
	)

Double-precision complex version of XLALUnitaryWindowREAL8Sequence().

Definition at line 305 of file Window.c.

void LALWindow	(	LALStatus *	,
		REAL4Vector *	,
		LALWindowParams *
	)

Definition at line 902 of file Window.c.

void LALCreateREAL4Window	(	LALStatus *	,
		REAL4Window **	,
		LALWindowParams *
	)

Definition at line 928 of file Window.c.

---