OxAnalysis Class Reference

Ox cross-correlation analysis. More...

#include <OxAnalysis.h>

Collaboration diagram for OxAnalysis:

Public Member Functions
bool	PostProcess (void)
	Post-processing of Ox files.
bool	Process (Segments *aInSeg1, Segments *aInSeg2)
	Runs the cross-correlation analysis over a list of time segments.
Constructors and destructors
	OxAnalysis (const string aOptionFile, const unsigned int aGpsRef)
	Constructor of the OxAnalysis class.
virtual	~OxAnalysis (void)
	Destructor of the OxAnalysis class.

Private Attributes
unsigned int	ox_nproc
	Global counter to save output files.
GwollumOptions *	ox_opt
	List of options.
OxResults *	ox_results
	Ox results.

Detailed Description

Ox cross-correlation analysis.

This class is designed to run a cross-correlation analysis between time-frequency maps produced with Omicron.

After the OxAnalysis object is constructed, run the Omicron cross-correlation analysis with Process().

Constructor & Destructor Documentation

OxAnalysis()

OxAnalysis::OxAnalysis	(	const string	aOptionFile,
		const unsigned int	aGpsRef
	)

Constructor of the OxAnalysis class.

The Ox analysis is initialized. Options are read and the OxEvent object is created.

The list of options is given in a text file. They are identified with a set of tag and key words:

• OX NPERFILE: Number of analysis windows to save in an Ox file (default = 10). The first detector serves as a reference.
• OX LAGS: List of lag indices to process. This option is interpreted differently depending on the number of option parameters:
  • 0 parameters (missing option): only process the lag l=0.
  • 1 parameter L0: process only one lag with the index l=L0.
  • 2 parameters L0 L1: process all the lags between l=L0 and l=L1, l=L1 being included.
  • N parameters L0 L1 ... LN: process the lags l=L0 l=L1 ... and l=LN.

For other options, see OxResults::OxResults().

Parameters

[in]	aOptionFile	Path to the option file.
[in]	aGpsRef	Reference GPS time to intiate Omicron objects.

~OxAnalysis()

OxAnalysis::~OxAnalysis ( void  )

virtual

Destructor of the OxAnalysis class.

Member Function Documentation

PostProcess()

bool OxAnalysis::PostProcess

(

void

)

Post-processing of Ox files.

First, an Ox result file is open with OxResults::CreateOutputFile(). Ox events are processed with OxResults::Process(). The result of this analysis is saved in the new output file.

Finally, OxResults::SavePlots() and OxResults::MakeHtml() are called to save results in the output directory.

Process()

bool OxAnalysis::Process	(	Segments *	aInSeg1,
		Segments *	aInSeg2
	)

Runs the cross-correlation analysis over a list of time segments.

The Omicron analysis over the two detectors is performed in parallel. The list of input segments for detector 1 is processed sequentially, chunk by chunk. Two consecutive chunks overlaps by 50% (i.e the data is analyzed twice). For each chunk, multiple analysis chunks for detector 2 are considered accordingly to the list of lags specified in the option file: see OxAnalysis::OxAnalysis(). Only chunks within the input segment list for detector 2 are considered. See OxOmicron::Process().

Then, for each pair of Omicron spectrograms, the cross-correlation is processed with OxCorr::Process().

Finally, the Ox events are saved with SaveEvents(). The Ox files are saved in the output directory.

Parameters

[in]	aInSeg1	List of valid time segments for detector 1.
[in]	aInSeg2	List of valid time segments for detector 2.

Member Data Documentation

ox_nproc

unsigned int OxAnalysis::ox_nproc

private

Global counter to save output files.

ox_opt

GwollumOptions* OxAnalysis::ox_opt

private

List of options.

ox_results

OxResults* OxAnalysis::ox_results

private

Ox results.

---

The documentation for this class was generated from the following files:

• src/OxAnalysis.h
• src/OxAnalysis.cc