TTTRMask Class Reference

#include <TTTRMask.h>

Public Member Functions
	~TTTRMask ()=default
	TTTRMask ()=default
	TTTRMask (TTTR *data)
int	size ()
void	flip ()
void	set_mask (std::vector< bool > mask)
std::vector< bool > &	get_mask ()
void	set_tttr (TTTR *tttr)
void	select_channels (TTTR *tttr, signed char *routing_channels, int n_routing_channels, bool mask=false)
	Selects a subset of indices by a list of routing channel numbers.
void	select_count_rate (TTTR *tttr, double time_window, int n_ph_max, bool invert)
void	select_microtime_ranges (TTTR *tttr, std::vector< std::pair< int, int > > micro_time_ranges=std::vector< std::pair< int, int > >())
std::vector< int >	get_indices (bool selected=true)
std::vector< int >	get_selected_ranges ()

Friends
class	TTTR

Constructor & Destructor Documentation

~TTTRMask()

TTTRMask::~TTTRMask ( )

default

TTTRMask() [1/2]

TTTRMask::TTTRMask ( )

default

TTTRMask() [2/2]

TTTRMask::TTTRMask

(

TTTR *

data

)

Member Function Documentation

flip()

void TTTRMask::flip ( )

inline

get_indices()

std::vector< int > TTTRMask::get_indices

(

bool

selected = true

)

Parameters

selected

if selected is true returns selected (unmasked) indices otherwise masked indices are returned

Returns

get_mask()

std::vector< bool > & TTTRMask::get_mask ( )

inline

get_selected_ranges()

std::vector< int > TTTRMask::get_selected_ranges

(

)

select_channels()

void TTTRMask::select_channels	(	TTTR *	tttr,
		signed char *	routing_channels,
		int	n_routing_channels,
		bool	mask = false )

Selects a subset of indices by a list of routing channel numbers.

The returned set of indices will have routing channel numbers that are in the list of the provided routing channel numbers.

Parameters

tttr	Pointer to TTTR object.
routing_channels	Array of routing channel numbers. A subset of this array will be selected by the input.
n_routing_channels	Length of the routing channel number array.
mask	Default value if a channel is selected.

select_count_rate()

void TTTRMask::select_count_rate	(	TTTR *	tttr,
		double	time_window,
		int	n_ph_max,
		bool	invert )

Selects a subset of indices a count rate of a sliding time-window

Parameters

tttr	pointer to TTTR object
time_window	time window size in units of seconds
n_ph_max	maximum number of photons in time window
invert	boolean used to invert selection

select_microtime_ranges()

void TTTRMask::select_microtime_ranges	(	TTTR *	tttr,
		std::vector< std::pair< int, int > >	micro_time_ranges = std::vector< std::pair< int, int > >() )

Masks outside the provides micro time ranges

Parameters

tttr
micro_time_ranges
mask

set_mask()

void TTTRMask::set_mask ( std::vector< bool > mask )

inline

set_tttr()

void TTTRMask::set_tttr

(

TTTR *

tttr

)

size()

int TTTRMask::size ( )

inline

Friends And Related Symbol Documentation

TTTR

friend class TTTR

friend

---

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

• /builds/skf/tttrlib/include/TTTRMask.h