comparison Syncopation models/parameter_setter.py @ 28:5de1cb45c145

Parameters setting implemented.

 '''
 Author: Chunyang Song
 Institution: Centre for Digital Music, Queen Mary University of London
 '''
 
-# Set the parameters: subdivision_seq, weight_seq, L_max, strong_beat_level
+# Set the parameters: time-signature, subdivision-sequence, strong-beat-level; Lmax; weight-sequence
+# Important condition: Lmax needs to be no less than the length of subdivision-sequence and the length of weight-sequence
+
 
 # {'key': time-signature} :  
-# {'value': [subdivision_seq, theoretical beat-level represented by index in the subdivision_seq list]}
+# {'value': [subdivision-sequence, theoretical beat-level represented by index in the subdivision-sequence list]}
 timeSignatureBase = {
 	'2/2': [[1,2,2,2,2,2],1],
 	'3/2': [[1,3,2,2,2,2],1],
 	'4/2': [[1,2,2,2,2,2],1],
 	'2/4': [[1,2,2,2,2,2],1],

 	'5/8': [[1,5,2,2,2,2],1],
 	'6/8': [[1,2,3,2,2,2],1],
 	'9/8': [[1,3,3,2,2,2],1],
 	'12/8':[[1,2,2,3,2,2],2],	
 }
+
 
 def add_time_signature(timeSignature, subdivisionSequence, beatLevel):
 	if is_time_signature_valid(timeSignature,subdivisionSequence,beatLevel):
 		if timeSignature in timesigBase:
 			print 'This time-signature is existed already.'

 def print_time_signature_base():
 	data = read_time_signature()
 	for timeSignature, settings in data.items():
 		print timeSignature, settings
 
-# def get_subdivision_seq(timeSignature):
-# 	if timeSignature in readTimesig():
-# 		return timesigBase[timesig][0]
-# 	else:
-# 		print 'Error: the subdivision sequence for this time-signature is not defined.'
-# 		return None
 
-# def get_beat_level(timesig):
-# 	if timesig in readTimesig():
-# 		return timesigBase[timesig][1]
-# 	else:
-# 		print 'Error: the subdivision sequence for this time-signature is not defined.'
-# 		return None
+def are_parameters_valid(Lmax, weightSequence, subdivisionSequence):
+
+	# is_Lmax_valid() checks:
+	# 1. if Lmax is a non-negative integer
+	# 2. if Lmax is higher than the length of weightSequence and subdivisionSequence 
+	def is_Lmax_valid():
+		isValid = False
+		if isinstance(Lmax,int) and Lmax > 0:
+			if Lmax <= len(subdivisionSequence):
+				if Lmax <= len(weightSequence):
+					isValid = True
+				else:
+					print """Error: Lmax exceeds the length of subdivision-sequence. 
+					Either reduce Lmax, or extend subdivision-sequence through updating time-signature (refer to update_time_signature function). """
+			else:
+				print """Error: Lmax exceeds the length of weight-sequence. Either reduce Lmax, or provide a new weight-sequence
+				whose length is greater or equal to Lmax."""
+		else:	
+			print 'Error: Lmax needs to be a positive integer.'
+		return isValid
+
+	# is_weight_sequence_valid() checks:
+	# 1. weightSequence is a list of numbers
+	# 2. the length of weightSequence is no less than Lmax
+	def is_weight_sequence_valid():
+		isValid = False
+		if isinstance(weightSequence,list) and weightSequence == [i for i in weightSequence if isinstance(i,int)]:
+			if len(weightSequence) >= Lmax:
+				isValid = True
+			else:
+				print 'Error: the length of weight-sequence needs to be greater or equal to Lmax.'
+		else:
+			print 'Error: the weight-sequence needs to be a list of integers.'
+		return isValid
+
+
+	if is_Lmax_valid() and is_weight_sequence_valid():
+		return True
+	else:
+		return False