PrepareSubSamples Class Reference

#include <PrepareSubSamples.h>

Inheritance diagram for PrepareSubSamples:

Public Member Functions
	PrepareSubSamples ()
bool	Execute ()
bool	Finalise ()
bool	Initialise (std::string configfile, DataModel &data)

Private Types
enum	LogLevel {   FATAL =-1, ERROR =0, WARN =1, INFO =2,   DEBUG1 =3, DEBUG2 =4, DEBUG3 =5 }

Private Member Functions
bool	CheckSubSampleNeedsSplitting (const SubSample &sample)
	Check whether the SubSample needs to be split. More...
bool	CheckSubSampleVectorNeedsSplitting (const std::vector< SubSample > &samples)
	Check whether any of the SubSamples needs to be split. More...
void	SortSubSampleVector (std::vector< SubSample > &samples)
	Sort the digits in all SubSamples by time. More...
std::vector< SubSample >	SplitSubSampleVector (std::vector< SubSample > &samples)
	Split all SubSamples. More...
void	StreamToLog (int level)

Private Attributes
TimeDelta	m_sample_overlap
	The desired SubSample overlap time. More...
TimeDelta	m_sample_width
	The desired maximum SubSample length. More...
std::stringstream	m_ss
util::Stopwatch *	m_stopwatch
	The stopwatch, if we're using one. More...
std::string	m_stopwatch_file
	Image filename to save the histogram to, if required. More...
int	m_verbose

Detailed Description

Definition at line 11 of file PrepareSubSamples.h.

Member Enumeration Documentation

enum PrepareSubSamples::LogLevel

private

Enumerator
FATAL
ERROR
WARN
INFO
DEBUG1
DEBUG2
DEBUG3

Definition at line 43 of file PrepareSubSamples.h.

Constructor & Destructor Documentation

PrepareSubSamples::PrepareSubSamples

(

)

Definition at line 3 of file PrepareSubSamples.cpp.

Member Function Documentation

bool PrepareSubSamples::CheckSubSampleNeedsSplitting ( const SubSample &  sample )

private

Check whether the SubSample needs to be split.

Definition at line 56 of file PrepareSubSamples.cpp.

bool PrepareSubSamples::CheckSubSampleVectorNeedsSplitting ( const std::vector< SubSample > &  samples )

private

Check whether any of the SubSamples needs to be split.

Definition at line 47 of file PrepareSubSamples.cpp.

bool PrepareSubSamples::Execute

(

)

Definition at line 88 of file PrepareSubSamples.cpp.

bool PrepareSubSamples::Finalise

(

)

Definition at line 113 of file PrepareSubSamples.cpp.

bool PrepareSubSamples::Initialise	(	std::string	configfile,
		DataModel &	data
	)

Definition at line 6 of file PrepareSubSamples.cpp.

void PrepareSubSamples::SortSubSampleVector ( std::vector< SubSample > &  samples )

private

Sort the digits in all SubSamples by time.

Definition at line 39 of file PrepareSubSamples.cpp.

std::vector< SubSample > PrepareSubSamples::SplitSubSampleVector ( std::vector< SubSample > &  samples )

private

Split all SubSamples.

Definition at line 63 of file PrepareSubSamples.cpp.

void PrepareSubSamples::StreamToLog ( int  level )

inlineprivate

Definition at line 38 of file PrepareSubSamples.h.

Member Data Documentation

TimeDelta PrepareSubSamples::m_sample_overlap

private

The desired SubSample overlap time.

Definition at line 27 of file PrepareSubSamples.h.

TimeDelta PrepareSubSamples::m_sample_width

private

The desired maximum SubSample length.

Definition at line 25 of file PrepareSubSamples.h.

std::stringstream PrepareSubSamples::m_ss

private

Definition at line 36 of file PrepareSubSamples.h.

util::Stopwatch* PrepareSubSamples::m_stopwatch

private

The stopwatch, if we're using one.

Definition at line 30 of file PrepareSubSamples.h.

std::string PrepareSubSamples::m_stopwatch_file

private

Image filename to save the histogram to, if required.

Definition at line 32 of file PrepareSubSamples.h.

int PrepareSubSamples::m_verbose

private

Definition at line 34 of file PrepareSubSamples.h.

---

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

• UserTools/PrepareSubSamples/PrepareSubSamples.h
• UserTools/PrepareSubSamples/PrepareSubSamples.cpp