parsers.reliability2_exporter.Reliability2Exporter Class Reference

This calss writes details about a check2 object (a unit of data from the Reliability2 App) to a CSV file. More...

Inheritance diagram for parsers.reliability2_exporter.Reliability2Exporter:

Public Member Functions
def	__init__
	Constructor. More...
def	export
	This method extracts data from the Check2 object and writes it to the csv file in a nicely formatted manner. More...
def	close
	Closes this parser. More...

Public Attributes
	out_file
	in_file
	check2

Detailed Description

This calss writes details about a check2 object (a unit of data from the Reliability2 App) to a CSV file.

Definition at line 9 of file reliability2_exporter.py.

Constructor & Destructor Documentation

def parsers.reliability2_exporter.Reliability2Exporter.__init__	(		self,
			write_filename,
			check2
	)

Constructor.

Parameters

self
write_filename	(string) path to the csv file we will write the data to
check2	(Check2) a Check2 object containing the data to write - see data_structs.Check2

Definition at line 14 of file reliability2_exporter.py.

Member Function Documentation

def parsers.reliability2_exporter.Reliability2Exporter.close

(

self

)

Closes this parser.

This just closes all the open files that it is using. Calling this method is necessary to ensure that all of the data that was written to the csv file is actually flushed to disk.

Parameters

self

Definition at line 89 of file reliability2_exporter.py.

def parsers.reliability2_exporter.Reliability2Exporter.export	(		self,
			include_trans,
			progress_update_fcn = None,
			progress_next_fcn = None
	)

This method extracts data from the Check2 object and writes it to the csv file in a nicely formatted manner.

Parameters

self
include_trans	(boolean) If True, the method will append an extra CSV column containing the actual transcription text that was entered by the user for each clip.
progress_update_fcn	(function=None) function accepting a value in [0,1] to display as a progress bar - see utils.ProgressDialog. This value is used to indicate the level of completeness of the current phase
progress_next_phase_fcn(function=None)	- moves the progress bar to the next phase, which causes new text to be displayed in the bar - see utils.ProgressDialog

Definition at line 26 of file reliability2_exporter.py.

Member Data Documentation

parsers.reliability2_exporter.Reliability2Exporter.check2

Definition at line 18 of file reliability2_exporter.py.

parsers.reliability2_exporter.Reliability2Exporter.in_file

Definition at line 16 of file reliability2_exporter.py.

parsers.reliability2_exporter.Reliability2Exporter.out_file

Definition at line 15 of file reliability2_exporter.py.

---

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

• C:/Users/Wayne/Documents/baby-lab/bll_app/parsers/reliability2_exporter.py