class to define the time axis of the completeness time series. More...

#include <completenessbins.h>

Public Member Functions
	CompletenessBins (const libtime::TAbsoluteTime &earliest, const libtime::TAbsoluteTime &latest, const libtime::TRelativeTime &binsize)
	constructor More...

unsigned int	bin (const libtime::TAbsoluteTime &d) const

global query functions
libtime::TAbsoluteTime	earliest () const

libtime::TAbsoluteTime	latest () const

libtime::TAbsoluteTime	firstbin () const

libtime::TRelativeTime	binsize () const

unsigned int	nbins () const

unsigned int	samplesinbin (const libtime::TRelativeTime dt) const
	number of samples to be expected in a bin More...

bin specific query functions
libtime::TAbsoluteTime	bin (const unsigned int &i) const
	beginnig of bin (according to bin raster) More...

libtime::TAbsoluteTime	endofbin (const unsigned int &i) const
	end of bin (will be latest for last bin) More...

libtime::TAbsoluteTime	nextbin (const unsigned int &i) const
	start of bin (will be earliest for fisrt bin) More...

bool	isinbin (const libtime::TAbsoluteTime &d, const unsigned int &i) const

unsigned int	samplesinbin (const unsigned int &i, const libtime::TRelativeTime dt) const
	number of samples to be expected in this bin where absolute limits of the considered time window is earliest and latest. More...

Private Attributes
libtime::TAbsoluteTime	Mfirstbin

libtime::TRelativeTime	Mbinsize

libtime::TAbsoluteTime	Mearliest

libtime::TAbsoluteTime	Mlatest

unsigned int	Mnbins

Detailed Description

class to define the time axis of the completeness time series.

This class provides a time axis for the temporal distirbution of gaps or a statistic of completeness. For the reason of good taste the time axis is aligned to 0 UT. The first bin is aligned at an integer multiple of the bin size after 0 UT which is equal to or earlier than the earliest sample under consideration. The last bin is adjusted such that it contains the latest time under consideration. This means, that the beginning of the last bin plus the binsize is greater than the lastet time under consideration.

To check whether the time of a sample falls in a bin, check whether its time is larger than or equal the beginning of the bin and smaller than the beginning of the next bin.

For the calculation of completeness, we just consider samples which are expected within the earliest sample and the latest sample under consideration. Hence the first and the last bin will be considered complete even if not the whole binsize is filled with samples.

Definition at line 69 of file completenessbins.h.

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

sub/completenessbins.h
sub/completenessbins.cc

Public Member Functions

Private Attributes

Detailed Description