Load frame files and access data in frames. More...

#include <ffl.h>

Collaboration diagram for ffl:

[legend]

Public Member Functions
bool	ExtractChannels (const unsigned int aGps)
	Extracts channels at a given GPS time.

vector< string >	GetChannelList (const string aFilter="")
	Returns the current channel list.

unsigned int	GetChannelSampling (const string aChannelName)
	Returns the sampling rate of a given channel [Hz].

unsigned int	GetChannelSampling (const string aChannelName, unsigned int &aChannelIndex)
	Returns the sampling rate of a given channel [Hz].

double *	GetData (unsigned int &aSize, const string aChannelName, const double aGpsStart, const double aGpsEnd, const double aMissing=999.0)
	Returns a data vector for a given channel and a GPS range.

string	GetInputFfl (void)
	Returns the path to the input frame file list.

Segments *	GetSegments (void)
	Returns a pointer to the segments covered by the ffl.

bool	GetStatus (void)
	Returns the class status.

bool	IsChannel (const string aChannelName)
	Tests whether a channel exists in the dataset pointed by the ffl.

TGraph *	PlotData (const string aChannelName, const double aGpsStart, const double aGpsEnd)
	Plots a data vector time series.

bool	PrintChannels (const unsigned int aGps=0)
	Prints the list of channels at a given GPS time.

bool	PrintData (const string aChannelName, const double aGpsStart, const double aGpsEnd, string aFileName)
	Prints a data vector in a text file.

void	SetPlotName (const string aName)
	Sets a new name for the plotting structure.

Constructors and destructors
	ffl (const string aFrameFileList, const string aPlotStyle="GWOLLUM", const unsigned int aVerbosity=0, const string aTmpDirPath=".", const unsigned int aNTrials=1, const unsigned int aNSleepSeconds=0)
	Constructor of the ffl class.

virtual	~ffl (void)
	Destructor of the ffl class.

Private Member Functions
void	ReadInputFile (const string aInFile)
	Reads an input file and extracts the list of frame files.

Private Attributes
vector< string >	channels
	List of channels.

vector< unsigned int >	ffl_dur
	Frame file duration.

vector< string >	ffl_framefile
	Frame file path.

vector< unsigned int >	ffl_gps
	Frame file GPS start.

bool	ffl_pure
	Flags a pure FFL file --> no need for a working file.

string	fInFrameFile
	Path to input frame file list.

FrFile *	frfile
	Fr file.

string	fWoFrameFile
	Path to working frame file (always FFL).

TGraph *	G
	Graph.

GwollumPlot *	GP
	Plotting structure.

Monitor *	mon
	Class status.

unsigned int	nsleepsec
	Number of seconds between trials.

unsigned int	ntrials
	Number of trials when accessing the data.

vector< unsigned int >	sampling
	List of sampling frequencies.

Segments *	seg
	Segments covered by the ffl file.

string	srandint
	Random integer string.

Detailed Description

Load frame files and access data in frames.

This class is designed to load frame files and provide methods to access the data. The native format for file registration is the so-called FFL format. A FFL file is a text file where each line identifies a frame file. Each line must contained exactly 5 columns:

path to a frame file
starting GPS time of the frame file
duration of the frame file [s]
unused column [0]
unused column [0]

Note: The FFL format is the native format for this class. However the lalcache format (LCF) is also supported. In that case the LCF file is first converted to a FFL file before processing.

This class is using the Frame Library functions.

Author: Florent Robinet

Constructor & Destructor Documentation

◆ ffl()

ffl::ffl	(	const string	aFrameFileList,
		const string	aPlotStyle = `"GWOLLUM"`,
		const unsigned int	aVerbosity = `0`,
		const string	aTmpDirPath = `"."`,
		const unsigned int	aNTrials = `1`,
		const unsigned int	aNSleepSeconds = `0`
	)

Constructor of the ffl class.

The frame file list is provided. Two formats are supported: the native Frame File List (FFL) and the lalcache format (LCF). For both cases, it is possible to list another file (LCF or FFL) with a line with the following format: file path - GPS start - duration.

When working with LCF files or when working with secondary files, a working FFL file will be created. In that case, a tmp directory must be provided.

Note: It is possible to perform several attemps when accessing the frame file data. You can configure the number of attemps and the time distance between attempts.

Parameters

[in]	aFrameFileList	Path to frame file list
[in]	aPlotStyle	Plotting style
[in]	aVerbosity	Verbosity level
[in]	aTmpDirPath	Path to temporary directory. If needed, this path is used to build a working FFL file.
[in]	aNTrials	Number of trials to access the data.
[in]	aNSleepSeconds	Number of seconds between trials.

◆ ~ffl()

ffl::~ffl ( void )

virtual

Destructor of the ffl class.

Member Function Documentation

◆ ExtractChannels()

bool ffl::ExtractChannels ( const unsigned int aGps )

Extracts channels at a given GPS time.

Only ADC, PROC, SIM and SER channels are extracted. Only channels with a sampling rate above or equal to 1Hz are extracted.

Note: The data is retrieved several times, as configured by the number of trials.

Parameters

[in] aGps GPS time where to scan the channel list.

Returns: true if the channel list was correctly loaded, false otherwise.

◆ GetChannelList()

vector< string > ffl::GetChannelList ( const string aFilter = "" )

Returns the current channel list.

It is possible to return a subset of channels using a filter. This filter is a string containing wildcards, e.g. "V1:DQ_*_FLAG_* V1:ENV_*".

Parameters

[in] aFilter Channel name filter. Use "" for no filter.

◆ GetChannelSampling() [1/2]

unsigned int ffl::GetChannelSampling ( const string aChannelName )

inline

Returns the sampling rate of a given channel [Hz].

Returns: 0 if the channel is not found.

Note: To target a given GPS time, use ExtractChannels() first.

Parameters

[in] aChannelName Channel name.

◆ GetChannelSampling() [2/2]

unsigned int ffl::GetChannelSampling	(	const string	aChannelName,
		unsigned int &	aChannelIndex
	)

inline

Returns the sampling rate of a given channel [Hz].

Returns: 0 if the channel is not found.

Note: To target a given GPS time, use ExtractChannels() first.

Parameters

[in]	aChannelName	Channel name.
[out]	aChannelIndex	Channel index.

◆ GetData()

double * ffl::GetData	(	unsigned int &	aSize,
		const string	aChannelName,
		const double	aGpsStart,
		const double	aGpsEnd,
		const double	aMissing = `999.0`
	)

Returns a data vector for a given channel and a GPS range.

A pointer to the data vector is returned. The size of the vector is returned. If the data cannot be read, a pointer to NULL is returned and the data size is set to 0.

Note: The data access is tried several times, as configured with the constructor.

If there are missing data in the requested time stretch, no data vector is returned by default (aMissing=999.0). For any other value for aMissing, the data vector is returned and the missing sample are given the value aMissing.

Note: The user is in charge of deleting the returned vector.

Parameters

[out]	aSize	Number of samples in the returned vector.
[in]	aChannelName	Channel name.
[in]	aGpsStart	Starting GPS time.
[in]	aGpsEnd	Ending GPS time.
[in]	aMissing	Special value to flag missing samples. If =999.0, no flagging, the function returns NULL.

◆ GetInputFfl()

string ffl::GetInputFfl ( void )

inline

Returns the path to the input frame file list.

◆ GetSegments()

Segments * ffl::GetSegments ( void )

inline

Returns a pointer to the segments covered by the ffl.

Warning: DO NOT DELETE OR MODIFY! This object is internally used by the class.

◆ GetStatus()

bool ffl::GetStatus ( void )

inline

Returns the class status.

◆ IsChannel()

bool ffl::IsChannel ( const string aChannelName )

inline

Tests whether a channel exists in the dataset pointed by the ffl.

Returns: true if the channel exists, false otherwise.

Warning: Make sure that the channel list was extracted at the correct GPS time. See ExtractChannels().

Parameters

[in] aChannelName Channel name to test.

◆ PlotData()

TGraph * ffl::PlotData	(	const string	aChannelName,
		const double	aGpsStart,
		const double	aGpsEnd
	)

Plots a data vector time series.

This function, when run interactively, plots the time series of a given channel between two GPS times.

Returns: A pointer to the resulting graph is returned. Do not modify or delete this object as it is internally used by the class. NULL is returned if this function fails.

Parameters

[in]	aChannelName	Channel name.
[in]	aGpsStart	Starting GPS time.
[in]	aGpsEnd	Ending GPS time.

◆ PrintChannels()

bool ffl::PrintChannels ( const unsigned int aGps = 0 )

inline

Prints the list of channels at a given GPS time.

Two columns are printed: the channel name and the sampling frequency [Hz].

Parameters

[in] aGps GPS time. Use 0 to print the channels in the first frame file.

◆ PrintData()

bool ffl::PrintData	(	const string	aChannelName,
		const double	aGpsStart,
		const double	aGpsEnd,
		string	aFileName
	)

Prints a data vector in a text file.

This function prints the time series of a given channel between two GPS times in an text file.

Parameters

[in]	aChannelName	Channel name.
[in]	aGpsStart	Starting GPS time.
[in]	aGpsEnd	Ending GPS time.
	aFileName	Output text file name.

◆ ReadInputFile()

void ffl::ReadInputFile ( const string aInFile )

private

Reads an input file and extracts the list of frame files.

Parameters

[in] aInFile Path to the input file.

◆ SetPlotName()

void ffl::SetPlotName ( const string aName )

Sets a new name for the plotting structure.

Parameters

[in] aName Plot name.

Member Data Documentation

◆ channels

vector<string> ffl::channels

private

List of channels.

◆ ffl_dur

vector<unsigned int> ffl::ffl_dur

private

Frame file duration.

◆ ffl_framefile

vector<string> ffl::ffl_framefile

private

Frame file path.

◆ ffl_gps

vector<unsigned int> ffl::ffl_gps

private

Frame file GPS start.

◆ ffl_pure

bool ffl::ffl_pure

private

Flags a pure FFL file --> no need for a working file.

◆ fInFrameFile

string ffl::fInFrameFile

private

Path to input frame file list.

◆ frfile

FrFile* ffl::frfile

private

Fr file.

◆ fWoFrameFile

string ffl::fWoFrameFile

private

Path to working frame file (always FFL).

◆ G

TGraph* ffl::G

private

Graph.

◆ GP

GwollumPlot* ffl::GP

private

Plotting structure.

◆ mon

Monitor* ffl::mon

private

Class status.

◆ nsleepsec

unsigned int ffl::nsleepsec

private

Number of seconds between trials.

◆ ntrials

unsigned int ffl::ntrials

private

Number of trials when accessing the data.

◆ sampling

vector<unsigned int> ffl::sampling

private

List of sampling frequencies.

◆ seg

Segments* ffl::seg

private

Segments covered by the ffl file.

◆ srandint

string ffl::srandint

private

Random integer string.

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

src/Streams/ffl.h
src/Streams/ffl.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ffl()

◆ ~ffl()

Member Function Documentation

◆ ExtractChannels()

◆ GetChannelList()

◆ GetChannelSampling() [1/2]

◆ GetChannelSampling() [2/2]

◆ GetData()

◆ GetInputFfl()

◆ GetSegments()

◆ GetStatus()

◆ IsChannel()

◆ PlotData()

◆ PrintChannels()

◆ PrintData()

◆ ReadInputFile()

◆ SetPlotName()

Member Data Documentation

◆ channels

◆ ffl_dur

◆ ffl_framefile

◆ ffl_gps

◆ ffl_pure

◆ fInFrameFile

◆ frfile

◆ fWoFrameFile

◆ G

◆ GP

◆ mon

◆ nsleepsec

◆ ntrials

◆ sampling

◆ seg

◆ srandint