CLSMSettings Class Reference

#include <CLSMImage.h>

Public Member Functions
	CLSMSettings (bool skip_before_first_frame_marker=false, bool skip_after_last_frame_marker=false, int reading_routine=CLSM_DEFAULT, int marker_line_start=3, int marker_line_stop=2, std::vector< int > marker_frame_start=std::vector< int >({1}), int marker_event_type=1, int n_pixel_per_line=1, int n_lines=-1)
	CLSMSettings Constructor.

Protected Attributes
bool	skip_before_first_frame_marker = false
	To skip incomplete frames.
bool	skip_after_last_frame_marker = false
int	reading_routine = CLSM_DEFAULT
int	marker_line_start = 0
	Defines the marker for a line start.
int	marker_line_stop = 0
	Defines the marker for a line stop.
std::vector< int >	marker_frame_start = {}
	Vector containing the tttr indices of the frame markers.
int	marker_event_type = 0
	The event type used for the marker.
int	n_pixel_per_line = 0
int	n_lines = 0

Friends
class	CLSMImage

Constructor & Destructor Documentation

CLSMSettings()

CLSMSettings::CLSMSettings ( bool skip_before_first_frame_marker = false, bool skip_after_last_frame_marker = false, int reading_routine = CLSM_DEFAULT, int marker_line_start = 3, int marker_line_stop = 2, std::vector< int > marker_frame_start = std::vector<int>({1}), int marker_event_type = 1, int n_pixel_per_line = 1, int n_lines = -1 )

inlineexplicit

CLSMSettings Constructor.

Constructs a CLSMSettings object with the specified parameters.

Parameters

skip_before_first_frame_marker	If true, skip TTTR events before the first frame marker (default is false).
skip_after_last_frame_marker	If true, skip TTTR events after the last frame marker (default is false).
reading_routine	An integer specifying the reading routine used to read a CLSM image out of a TTTR data stream. A CLSM image can be encoded in various ways in a TTTR stream.
marker_line_start	Routing channel number or micro time channel number serving as a marker for the start of a new line in a frame within the TTTR data stream.
marker_line_stop	Routing channel number or micro time channel number serving as a marker for the stop of a line in a frame within the TTTR data stream.
marker_frame_start	Routing channel numbers (default reading routine) or micro time channel number (SP8 reading routine) serving as a marker for a new frame in the TTTR data stream.
marker_event_type	Event types interpreted as markers for frames and lines.
n_pixel_per_line	Number of pixels into which each line is separated. If set to zero, the number of pixels per line corresponds to the number of lines in the first frame.
n_lines	Number of lines (default is -1, auto-detect based on the first frame).

Friends And Related Symbol Documentation

CLSMImage

friend class CLSMImage

friend

Member Data Documentation

marker_event_type

int CLSMSettings::marker_event_type = 0

protected

The event type used for the marker.

marker_frame_start

std::vector<int> CLSMSettings::marker_frame_start = {}

protected

Vector containing the tttr indices of the frame markers.

marker_line_start

int CLSMSettings::marker_line_start = 0

protected

Defines the marker for a line start.

marker_line_stop

int CLSMSettings::marker_line_stop = 0

protected

Defines the marker for a line stop.

n_lines

int CLSMSettings::n_lines = 0

protected

n_pixel_per_line

int CLSMSettings::n_pixel_per_line = 0

protected

reading_routine

int CLSMSettings::reading_routine = CLSM_DEFAULT

protected

skip_after_last_frame_marker

bool CLSMSettings::skip_after_last_frame_marker = false

protected

skip_before_first_frame_marker

bool CLSMSettings::skip_before_first_frame_marker = false

protected

To skip incomplete frames.

---

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

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