added a string representation for data type FilterOptions

This commit is contained in:
Sebastian Wehling-Benatelli 2014-10-27 12:14:59 +01:00
parent c3e072e952
commit 4f440d282d

View File

@ -134,21 +134,21 @@ class AutoPickParameter(object):
class FilterOptions(object): class FilterOptions(object):
''' '''
FilterOptions is a parameter object type providing Butterworth filter option FilterOptions is a parameter object type providing Butterworth filter
parameter for PyLoT. Its easy to access properties helps to manage file option parameter for PyLoT. Its easy to access properties helps to manage
based as well as parameter manipulation within the GUI. file based as well as parameter manipulation within the GUI.
:type filtertype: str, optional :type filtertype: str, optional
:param filtertype: String containing the desired filtertype For information :param filtertype: String containing the desired filtertype For information
about the supported filter types see _`Supported Filter` section . about the supported filter types see _`Supported Filter` section .
:type freq: list, optional :type freq: list, optional
:param freq: list of float(s) describing the cutoff limits of the filter :param freq: list of float(s) describing the cutoff limits of the filter
:type order: int, optional :type order: int, optional
:param order: Integer value describing the order of the desired Butterworth :param order: Integer value describing the order of the desired Butterworth
filter. filter.
.. rubric:: _`Supported Filter` .. rubric:: _`Supported Filter`
``'bandpass'`` ``'bandpass'``
@ -170,6 +170,16 @@ class FilterOptions(object):
self._setFreq(freq) self._setFreq(freq)
self._setOrder(order) self._setOrder(order)
def __str__(self):
hrs = '''\n\tFilter parameter:\n
Type:\t\t{ftype}\n
Frequencies:\t{freq}\n
Order:\t\t{order}\n
'''.format(ftype=self.filterType,
freq=self.freq,
order=self.order)
return hrs
def _getFreq(self): def _getFreq(self):
return self.__filterInformation['freq'] return self.__filterInformation['freq']