ffcontrol.ffcontrol Namespace Reference

Classes
class	c_block
class	dstats
class	FFControlStructureBase
	general records and utils More...
class	gat_struct
class	istats

Functions
def	append_control_file (control_filename, output_filename, cf_lines)
def	append_control_file_with_find_and_replace (control_filename, output_filename, cf_lines, original_string_list, replacement_string_list)
def	get_control_block (filename, baseline, source, fgroup, time)
def	get_control_file_hash (filename)
def	get_fcode_index (freq_char)
def	load_ffcontrol_library ()
def	prepend_control_file_with_find_and_replace (control_filename, output_filename, cf_lines, original_string_list, replacement_string_list)
def	remove_lines_and_append_control_file (control_filename, output_filename, cf_lines, remove_string_list)

Variables
int	AP_BY_AP = 2
string	COMCHAR = '*'
int	DISCARD = 1
int	DSB = 3
int	EACH_MINUTE = 2
int	ITERATE = 1
int	KEEP = 32767
int	LSB = 2
int	MANUAL = 3
int	MAX_SAMP = 16
int	MAXFREQ = 64
	compiler defines from control.h TODO: clean these globals up More...
int	MAXNOTCH = 8*MAXFREQ
int	MODEL = 1
int	MULTITONE = 4
int	NORMAL = 1
int	NULLCHAR = 0
float	NULLFLOAT = 508.4482826
int	NULLINT = -12345
int	PHYLE = 3
int	POLYNOMIAL = 2
int	SBD = 2
int	SCAN_START = 1
int	SIMUL = 2
int	SINEWAVE = 1
int	USB = 1
string	WILDCARD = '?'

Detailed Description

module accessing fourfit control file data via c-library 

Function Documentation

append_control_file()

def ffcontrol.ffcontrol.append_control_file	(		control_filename,
			output_filename,
			cf_lines
	)

 append a list of strings to a control file 

append_control_file_with_find_and_replace()

def ffcontrol.ffcontrol.append_control_file_with_find_and_replace	(		control_filename,
			output_filename,
			cf_lines,
			original_string_list,
			replacement_string_list
	)

find and replace matching strings in a control file, and then append a list of strings to a control file 

get_control_block()

def ffcontrol.ffcontrol.get_control_block	(		filename,
			baseline,
			source,
			fgroup,
			time
	)

 construct a control block from the specified control file, baseline, source, frequency group, and time 

get_control_file_hash()

def ffcontrol.ffcontrol.get_control_file_hash

(

filename

)

 compute a simple hash value for a specified control file 

get_fcode_index()

def ffcontrol.ffcontrol.get_fcode_index

(

freq_char

)

load_ffcontrol_library()

def ffcontrol.ffcontrol.load_ffcontrol_library

(

)

 load the c-library needed for parsing control files 

prepend_control_file_with_find_and_replace()

def ffcontrol.ffcontrol.prepend_control_file_with_find_and_replace	(		control_filename,
			output_filename,
			cf_lines,
			original_string_list,
			replacement_string_list
	)

prepend a control file with a list of strings, then find and replace matching strings in a control file

remove_lines_and_append_control_file()

def ffcontrol.ffcontrol.remove_lines_and_append_control_file	(		control_filename,
			output_filename,
			cf_lines,
			remove_string_list
	)

remove lines containing matching strings, and then append a list of strings to a control file 

Variable Documentation

AP_BY_AP

int ffcontrol.ffcontrol.AP_BY_AP = 2

COMCHAR

string ffcontrol.ffcontrol.COMCHAR = '*'

DISCARD

int ffcontrol.ffcontrol.DISCARD = 1

DSB

int ffcontrol.ffcontrol.DSB = 3

EACH_MINUTE

int ffcontrol.ffcontrol.EACH_MINUTE = 2

ITERATE

int ffcontrol.ffcontrol.ITERATE = 1

KEEP

int ffcontrol.ffcontrol.KEEP = 32767

LSB

int ffcontrol.ffcontrol.LSB = 2

MANUAL

int ffcontrol.ffcontrol.MANUAL = 3

MAX_SAMP

int ffcontrol.ffcontrol.MAX_SAMP = 16

MAXFREQ

int ffcontrol.ffcontrol.MAXFREQ = 64

compiler defines from control.h TODO: clean these globals up

MAXNOTCH

int ffcontrol.ffcontrol.MAXNOTCH = 8*MAXFREQ

MODEL

int ffcontrol.ffcontrol.MODEL = 1

MULTITONE

int ffcontrol.ffcontrol.MULTITONE = 4

NORMAL

int ffcontrol.ffcontrol.NORMAL = 1

NULLCHAR

int ffcontrol.ffcontrol.NULLCHAR = 0

NULLFLOAT

float ffcontrol.ffcontrol.NULLFLOAT = 508.4482826

NULLINT

int ffcontrol.ffcontrol.NULLINT = -12345

PHYLE

int ffcontrol.ffcontrol.PHYLE = 3

POLYNOMIAL

int ffcontrol.ffcontrol.POLYNOMIAL = 2

SBD

int ffcontrol.ffcontrol.SBD = 2

SCAN_START

int ffcontrol.ffcontrol.SCAN_START = 1

SIMUL

int ffcontrol.ffcontrol.SIMUL = 2

SINEWAVE

int ffcontrol.ffcontrol.SINEWAVE = 1

USB

int ffcontrol.ffcontrol.USB = 1

WILDCARD

string ffcontrol.ffcontrol.WILDCARD = '?'