DirectionDetector Class Reference

The DirectionDetector class keeps track of the observed fragment directions (forward-reverse or reverse-forward) and whether they are paired or single-end. More...

#include <directiondetector.h>

List of all members.

Public Member Functions
	DirectionDetector ()
	The DirectionDetector constructor sets all counts to 0.
void	add_fragment (Fragment *f)
	Adds counts for the alignments of the given Fragment.
bool	report_if_improper_direction ()
	Throws a warning if a disproportionate number of alignments are in one direction and the proper flag has not been specified.

---

Detailed Description

The DirectionDetector class keeps track of the observed fragment directions (forward-reverse or reverse-forward) and whether they are paired or single-end.

It can then determine if the numbers in each direction are distributed disproportionately and throw a warning if the proper direction flag has not been specified. Unable to detect when a directional flag has been chosen incorrectly since the incompatible alignments will have been discarded.

Author:

Adam Roberts

Date:

2012 Artistic License 2.0

Definition at line 29 of file directiondetector.h.

---

Member Function Documentation

void DirectionDetector::add_fragment

(

Fragment *

f

)

Adds counts for the alignments of the given Fragment.

Parameters:

f	a pointer to the Fragment to count the direction of its alignments.

Definition at line 20 of file directiondetector.cpp.

bool DirectionDetector::report_if_improper_direction

(

)

Throws a warning if a disproportionate number of alignments are in one direction and the proper flag has not been specified.

Returns:

True iff a warning is thrown.

Definition at line 44 of file directiondetector.cpp.

---

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

• src/directiondetector.h
• src/directiondetector.cpp