From 8de25cc1496340168c4d3ca880648dca54773ea4 Mon Sep 17 00:00:00 2001
From: Sebastian Wehling <sebastianw@minos01.geophysik.ruhr-uni-bochum.de>
Date: Thu, 17 Jul 2014 10:28:29 +0200
Subject: [PATCH] modified: docstring for class FilterOptions established using
 Sphinx-markups

---
 pylot/core/read/inputs.py | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/pylot/core/read/inputs.py b/pylot/core/read/inputs.py
index cf827b19..8ae0c8fb 100644
--- a/pylot/core/read/inputs.py
+++ b/pylot/core/read/inputs.py
@@ -133,7 +133,36 @@ class AutoPickParameter(object):
 
 
 class FilterOptions(object):
+    '''
+    FilterOptions is a parameter object type providing Butterworth filter option
+    parameter for PyLoT. Its easy to access properties helps to manage file
+    based as well as parameter manipulation within the GUI.
+    
+    :type filtertype: str, optional
+    :param filtertype: String containing the desired filtertype For information
+    about the supported filter types see _`Supported Filter` section .
+    
+    :type freq: list, optional
+    :param freq: list of float(s) describing the cutoff limits of the filter
+    
+    :type order: int, optional
+    :param order: Integer value describing the order of the desired Butterworth
+    filter.
+    
+    .. rubric:: _`Supported Filter`
 
+        ``'bandpass'``
+            Butterworth-Bandpass
+
+        ``'bandstop'``
+            Butterworth-Bandstop
+
+        ``'lowpass'``
+            Butterworth-Lowpass
+
+        ``'highpass'``
+            Butterworth-Highpass
+    '''
     def __init__(self, filtertype='bandpass', freq=[2., 5.], order=3,
                  **kwargs):
         self.__filterInformation = {}