search_summary.c File Reference

Prototypes
SearchSummaryTable *	XLALCreateSearchSummaryTableRow (const ProcessTable *process)
	Create a SearchSummaryTable structure. More...
SearchSummaryTable *	XLALDestroySearchSummaryTableRow (SearchSummaryTable *row)
	Destroy a SearchSummaryTable structure. More...
void	XLALDestroySearchSummaryTable (SearchSummaryTable *head)
	Destroy a SearchSummaryTable linked list. More...
int	XLALCompareSearchSummaryByOutTime (const void *a, const void *b)
int	XLALTimeSortSearchSummary (SearchSummaryTable **summHead, int(*comparfunc)(const void *, const void *))
SearchSummaryTable *	XLALIfoScanSearchSummary (SearchSummaryTable *input, CHAR *ifos)
	Scan through a linked list of search_summary row objects and copy rows whose ifos match the given string into a new linked list, and return the address of the first entry in the new list. More...
SearchSummaryTable *	XLALSearchSummaryTableFromLIGOLw (const char *filename)
	Read the search_summary table from a LIGO Light Weight XML file into a linked list of SearchSummaryTable structures. More...
int	XLALWriteLIGOLwXMLSearchSummaryTable (LIGOLwXMLStream *xml, const SearchSummaryTable *search_summary)
	Write a search_summary table to an XML file. More...

Go to the source code of this file.

Function Documentation

XLALCreateSearchSummaryTableRow()

SearchSummaryTable * XLALCreateSearchSummaryTableRow

(

const ProcessTable *

process

)

Create a SearchSummaryTable structure.

Definition at line 41 of file search_summary.c.

XLALDestroySearchSummaryTableRow()

SearchSummaryTable * XLALDestroySearchSummaryTableRow

(

SearchSummaryTable *

row

)

Destroy a SearchSummaryTable structure.

Definition at line 71 of file search_summary.c.

XLALDestroySearchSummaryTable()

void XLALDestroySearchSummaryTable

(

SearchSummaryTable *

head

)

Destroy a SearchSummaryTable linked list.

Definition at line 84 of file search_summary.c.

XLALCompareSearchSummaryByOutTime()

int XLALCompareSearchSummaryByOutTime	(	const void *	a,
		const void *	b
	)

Definition at line 93 of file search_summary.c.

XLALTimeSortSearchSummary()

int XLALTimeSortSearchSummary	(	SearchSummaryTable **	summHead,
		int(*)(const void *, const void *)	comparfunc
	)

Definition at line 127 of file search_summary.c.

XLALIfoScanSearchSummary()

SearchSummaryTable * XLALIfoScanSearchSummary	(	SearchSummaryTable *	input,
		CHAR *	ifos
	)

Scan through a linked list of search_summary row objects and copy rows whose ifos match the given string into a new linked list, and return the address of the first entry in the new list.

Returns NULL if no matching rows are found, or if an error occured (out of memory). Use XLAL error functions to check for an error status code if it matters which condition occured.

Definition at line 175 of file search_summary.c.

XLALSearchSummaryTableFromLIGOLw()

SearchSummaryTable * XLALSearchSummaryTableFromLIGOLw

(

const char *

filename

)

Read the search_summary table from a LIGO Light Weight XML file into a linked list of SearchSummaryTable structures.

Definition at line 211 of file search_summary.c.

XLALWriteLIGOLwXMLSearchSummaryTable()

int XLALWriteLIGOLwXMLSearchSummaryTable	(	LIGOLwXMLStream *	xml,
		const SearchSummaryTable *	search_summary
	)

Write a search_summary table to an XML file.

Definition at line 340 of file search_summary.c.