bground.help

Module: bground.help

Help functions for bground package.

This module is a collecton if simple help functions.
The functions just print a brief textual information on stdout.
The funcs are grouped into classes; each bkgr subtraction method ~ class.
Three functions - intro, more_help, how_it_works - available for all methods.

>>> # Typical access to printed help from bground
>>> # (the help via bground.api
>>> import bground.api as bkg
>>> bkg.Help.intro()
>>> bkg.Help.more_help()
>>> bkg.Help.InteractivePlot()

>>> # Typical access to printed help from ediff
>>> # (bground is usually used within ediff package
>>> # (bground.api is auto-imported as ediff.bkg or ed.bkg
>>> import ediff as ed
>>> ed.bkg.Help.intro()
>>> ed.bkg.Help.more_help()
>>> ed.bkg.Help.InteractivePlot()

View Source

  1'''
  2Module: bground.help
  3--------------------
  4Help functions for bground package.
  5
  6* This module is a collecton if simple help functions.
  7* The functions just print a brief textual information on stdout.
  8* The funcs are grouped into classes; each bkgr subtraction method ~ class.
  9* Three functions - intro, more_help, how_it_works - available for all methods.
 10
 11>>> # Typical access to printed help from bground
 12>>> # (the help via bground.api
 13>>> import bground.api as bkg
 14>>> bkg.Help.intro()
 15>>> bkg.Help.more_help()
 16>>> bkg.Help.InteractivePlot()
 17
 18>>> # Typical access to printed help from ediff
 19>>> # (bground is usually used within ediff package
 20>>> # (bground.api is auto-imported as ediff.bkg or ed.bkg
 21>>> import ediff as ed
 22>>> ed.bkg.Help.intro()
 23>>> ed.bkg.Help.more_help()
 24>>> ed.bkg.Help.InteractivePlot()
 25'''
 26
 27
 28# At the beginning of this module, we define intelligent_detent method.
 29# It performs intelligent de-dentation of multiline Python strings.
 30# This method is used in all help functions below.
 31
 32
 33import re
 34
 35
 36def intelligent_dedent(text: str) -> str:
 37    '''
 38    Intelligent dedentation - print multi-line string reasonably.
 39
 40    Parameters
 41    ----------
 42    text : str
 43        A multi-line string to print.
 44        The initial Python indentation is ignored (Python dedentation).
 45        The internal string indentation is preserved (internal indentation).
 46
 47    Returns
 48    -------
 49    str
 50        Processed string after inteligent dedentation.
 51        
 52    Technical notes
 53    ---------------
 54    * This function is used in printed help.
 55    * The printed help messages are typically multiline texts.
 56    '''
 57    
 58    # The following algorithm created with AI/ChGPT.
 59    # The code was slightly simplified - extra commands removed.
 60    # Original comments were improved + additional comments were added.
 61    
 62    # Split {text} into lines and ignore empty leading/trailing ones
 63    # (note #1: line.strip() returns falsi if it is an empty line
 64    # (note #2: the algorithm can delete 
 65    lines = text.splitlines()
 66    # Remove possible empty line(s) at the beginning
 67    while lines and not lines[0].strip():
 68        lines.pop(0)
 69    # Remove possible empty line(s) at the end
 70    while lines and not lines[-1].strip():
 71        lines.pop()
 72    # Return empty string if the multiline string contained just empty lines
 73    if not lines:
 74        return ""
 75
 76    # Find minimum indentation (tabs or spaces) among non-empty lines.
 77    # (note #1: line.strip() returns false if it is an empty line
 78    # (note #2: re.match(r'^[\t]*',line).groupt(0) = initial tabs = \t chars
 79    # (... line with two tabs contains \t\t at the beginning = 2 chars
 80    # (... the same is done for spaces => we use r'^[ \t]*' - space is there
 81    indent_levels = [
 82        len(re.match(r'^[ \t]*', line).group(0))
 83        for line in lines if line.strip()
 84    ]
 85    min_indent = min(indent_levels)
 86
 87    # Remove {min_indent} characters from the start of each line
 88    # (this is where some unnecessary/extra commands were removed
 89    dedented = [ line[min_indent:] for line in lines ]
 90    return("\n".join(dedented))
 91
 92
 93class GeneralHelp:
 94    '''
 95    Class with help functions.
 96    
 97    * The functions print simple textual help.
 98    * Here: general help to whole bground package.
 99    '''
100    
101    
102    def brief_intro():
103        '''
104        BGROUND printed help :: Brief introduction
105        '''
106        
107        help_text = '''
108        =====================================================================
109        BGROUND :: (semi)automated background subtraction for XY-data
110        ---------------------------------------------------------------------
111        * input data = XY-data (two columns)
112            - text file or object with two (or more) columns
113            - one of the columns = X-data, some other column = Y-data
114            - allowed types of input (user specified input types and columns)
115              text file, np.array or pd.DataFrame or ediff.io.Profile
116        * output data = XY-data (four columns)
117            - text file(s) and/or ediff.io.Profile object with four columns
118            - cols in the text file: X, Y=Iraw, Ibkg, I=(Iraw-Ibkg)
119            - cols in ELD = Profile: ELD.Pixels, ELD.Iraw, ELD.Ibkg, ELD.I 
120        * semi-automated background subtraction:
121            - computer opens an interactive plot
122            - user defines background points with a mouse and keyboard
123            - computer calculates the background + saves it as/when requested
124        * fully-automated background subtraction:
125            - user selects a method for background subtraction
126            - computer calculates tha background and saves the output data
127            - the output data are saved to file(s) and/or ediff.io.Profile
128        * ediff.io.Profile
129            - a specific type of input/output data
130            - an object comming from our super-package ediff
131            - the object is a 1D-profile from powder electron diffractogram 
132        =====================================================================
133        '''
134        
135        print(intelligent_dedent(help_text))
136        
137    
138    def more_help():
139        '''
140        BGROUND printed help :: Where to find additional help
141        '''
142        
143        help_text = '''
144        ==================================================================
145        BGROUND package :: where to find more help
146        ------------------------------------------------------------------
147        Documentation + examples in www:
148        * GitHub pages : https://mirekslouf.github.io/bground
149        * GitHub docum : https://mirekslouf.github.io/bground/docs
150        ------------------------------------------------------------------
151        Additional help to the individual bkgr subtraction methods:
152        >>> import bground.api as bkg
153        >>> bkg.InteractivePlot.Help.how_it_works()
154        ------------------------------------------------------------------
155        Alternative access to help functions within ediff package
156        >>> import ediff as ed
157        >>> ed.bkg.InteractivePlot.Help.how_it_works()
158        ==================================================================
159        '''
160        
161        print(intelligent_dedent(help_text))
162
163
164class InteractivePlot:
165    '''
166    Class with help functions.
167    
168    * The functions print simple textual help.
169    * Here: help to {InteractivePlot} backgound subtraction method.
170    '''
171    
172    
173    def how_it_works():
174        '''
175        BGROUND printed help :: InteractivePlot :: How it works
176        '''
177        
178        help_text = '''
179        ===============================================================
180        BGROUND :: InteractivePlot :: How it works
181        ---------------------------------------------------------------
182        * BGROUND opens Matplotlib interactive plot
183        * the user defines backround points with mouse and keyboard
184        * mouse actions/events are Matplotlib UI defaults
185        * keyboard shortcuts/actions/events are defined by the program
186          - keys for background definition: 1,2,3,4,5,6
187          - keys for saving the results   : a,b,t,s,u
188          - basic help is printed when the interactive plot opens
189        --------------------------------------------------------------
190        Complete help on keyboard shortcuts with detailed explanation:
191        >>> import bground.api as bkg
192        >>> bkg.InteractivePlot.Help.keyboard_shortcuts()
193        --------------------------------------------------------------
194        Alternative access to help from EDIFF package:
195        >>> import ediff as ed
196        >>> ed.bkg.InteractivePlot.Help.keyboard_shortcuts()
197        ===============================================================
198        '''
199        
200        print(intelligent_dedent(help_text))
201    
202    
203    def keyboard_shortcuts( output_file='some_file' ):
204        '''
205        BGROUND printed help :: InteractivePlot :: Keyboard shortcuts
206        '''
207        
208        # (1) Define output file names
209        # (objective: all should have correct extensions
210        # (but we want to avoid double TXT extension for the main TXT file
211        TXTfile = output_file
212        BKGfile = output_file + '.bp'
213        PNGfile = output_file + '.png'
214        if not(TXTfile.lower().endswith('.txt')): TXTfile = TXTfile + '.txt'
215        
216        # (2) Print help including the above defined output file names
217        
218        help_text = f'''
219        ============================================================
220        BGROUND :: Interactive plot :: Keyboard shortcuts
221        ------------------------------------------------------------
222        1 = add a background point (at the mouse cursor position)
223        2 = delete a background point (close to the mouse cursor)
224        3 = show the plot with all background points
225        4 = show the plot with linear spline background
226        5 = show the plot with quadratic spline background
227        6 = show the plot with cubic spline background
228        ------------------------------------------------------------
229        a = background points :: load the previously saved
230        b = background points :: save to BKG-file'
231        (BKG-file = {BKGfile}
232        --------
233        s = save current plot to PNG-file:
234        (PNG-file = {PNGfile}
235        (note: Matplotlib UI shortcut; optional output
236        --------
237        t = subtract current background & save data to TXT-file
238        (TXT-file = {TXTfile}
239        (note: this is a universal output, applicable in all cases
240        --------
241        u = subtract current background & update ediff.io.Profile
242        (ediff.io.Profile = (alternative) object with i/o data
243        (note: the object is from ediff package; ignore if not used
244        ------------------------------------------------------------
245        Standard Matplotlib UI tools and shortcuts work as well.
246        See: https://matplotlib.org/stable/users/interactive.html
247        ============================================================
248        '''
249        
250        print(intelligent_dedent(help_text))
251        
252
253class RestoreFromPoints:
254    '''
255    Class with help functions.
256    
257    * The functions print simple textual help.
258    * Here: help to {RestoreFromPoints} backgound subtraction method.
259    '''
260     
261    
262    def how_it_works():
263        '''
264        BGROUND printed help :: RestoreFromPoints :: How it works
265        '''
266        
267        # TODO: brief text explanation
268        # (analogy of the same method in InterativePlot class above
269        print("Not implemented yet ...")
270
271
272class SimpleFunc:
273    '''
274    Class with help functions.
275    
276    * The functions print simple textual help.
277    * Here: help to {SimpleFunc} backgound subtraction methods.
278    '''
279     
280    
281    def how_it_works():
282        '''
283        BGROUND printed help :: SimpleFunc :: How it works
284        '''
285        
286        # TODO: brief text explanation
287        # (analogy of the same method in InterativePlot class above
288        print("Not implemented yet ...")
289        
290
291class BaseLines:
292    '''
293    Class with help functions.
294    
295    * The functions print simple textual help.
296    * Here: help to {BaseLines} backgound subtraction method.
297    '''
298     
299    
300    def how_it_works():
301        '''
302        BGROUND printed help :: BaseLines :: How it works
303        '''
304        
305        # TODO: brief text explanation
306        # (analogy of the same method in InterativePlot class above
307        print("Not implemented yet ...")
308
309
310class WaveletMethod:
311    '''
312    Class with help functions.
313    
314    * The functions print simple textual help.
315    * Here: help to {WaveletMethod} backgound subtraction method.
316    '''
317     
318    
319    def how_it_works():
320        '''
321        BGROUND printed help :: WaveletMethod :: How it works
322        '''
323        
324        # TODO: brief text explanation
325        # (analogy of the same method in InterativePlot class above
326        print("Not implemented yet ...")

def intelligent_dedent(text: str) -> str: View Source

37def intelligent_dedent(text: str) -> str:
38    '''
39    Intelligent dedentation - print multi-line string reasonably.
40
41    Parameters
42    ----------
43    text : str
44        A multi-line string to print.
45        The initial Python indentation is ignored (Python dedentation).
46        The internal string indentation is preserved (internal indentation).
47
48    Returns
49    -------
50    str
51        Processed string after inteligent dedentation.
52        
53    Technical notes
54    ---------------
55    * This function is used in printed help.
56    * The printed help messages are typically multiline texts.
57    '''
58    
59    # The following algorithm created with AI/ChGPT.
60    # The code was slightly simplified - extra commands removed.
61    # Original comments were improved + additional comments were added.
62    
63    # Split {text} into lines and ignore empty leading/trailing ones
64    # (note #1: line.strip() returns falsi if it is an empty line
65    # (note #2: the algorithm can delete 
66    lines = text.splitlines()
67    # Remove possible empty line(s) at the beginning
68    while lines and not lines[0].strip():
69        lines.pop(0)
70    # Remove possible empty line(s) at the end
71    while lines and not lines[-1].strip():
72        lines.pop()
73    # Return empty string if the multiline string contained just empty lines
74    if not lines:
75        return ""
76
77    # Find minimum indentation (tabs or spaces) among non-empty lines.
78    # (note #1: line.strip() returns false if it is an empty line
79    # (note #2: re.match(r'^[\t]*',line).groupt(0) = initial tabs = \t chars
80    # (... line with two tabs contains \t\t at the beginning = 2 chars
81    # (... the same is done for spaces => we use r'^[ \t]*' - space is there
82    indent_levels = [
83        len(re.match(r'^[ \t]*', line).group(0))
84        for line in lines if line.strip()
85    ]
86    min_indent = min(indent_levels)
87
88    # Remove {min_indent} characters from the start of each line
89    # (this is where some unnecessary/extra commands were removed
90    dedented = [ line[min_indent:] for line in lines ]
91    return("\n".join(dedented))

Intelligent dedentation - print multi-line string reasonably.

Parameters

text (str): A multi-line string to print. The initial Python indentation is ignored (Python dedentation). The internal string indentation is preserved (internal indentation).

Returns

str: Processed string after inteligent dedentation.

Technical notes

This function is used in printed help.
The printed help messages are typically multiline texts.

class GeneralHelp: View Source

 94class GeneralHelp:
 95    '''
 96    Class with help functions.
 97    
 98    * The functions print simple textual help.
 99    * Here: general help to whole bground package.
100    '''
101    
102    
103    def brief_intro():
104        '''
105        BGROUND printed help :: Brief introduction
106        '''
107        
108        help_text = '''
109        =====================================================================
110        BGROUND :: (semi)automated background subtraction for XY-data
111        ---------------------------------------------------------------------
112        * input data = XY-data (two columns)
113            - text file or object with two (or more) columns
114            - one of the columns = X-data, some other column = Y-data
115            - allowed types of input (user specified input types and columns)
116              text file, np.array or pd.DataFrame or ediff.io.Profile
117        * output data = XY-data (four columns)
118            - text file(s) and/or ediff.io.Profile object with four columns
119            - cols in the text file: X, Y=Iraw, Ibkg, I=(Iraw-Ibkg)
120            - cols in ELD = Profile: ELD.Pixels, ELD.Iraw, ELD.Ibkg, ELD.I 
121        * semi-automated background subtraction:
122            - computer opens an interactive plot
123            - user defines background points with a mouse and keyboard
124            - computer calculates the background + saves it as/when requested
125        * fully-automated background subtraction:
126            - user selects a method for background subtraction
127            - computer calculates tha background and saves the output data
128            - the output data are saved to file(s) and/or ediff.io.Profile
129        * ediff.io.Profile
130            - a specific type of input/output data
131            - an object comming from our super-package ediff
132            - the object is a 1D-profile from powder electron diffractogram 
133        =====================================================================
134        '''
135        
136        print(intelligent_dedent(help_text))
137        
138    
139    def more_help():
140        '''
141        BGROUND printed help :: Where to find additional help
142        '''
143        
144        help_text = '''
145        ==================================================================
146        BGROUND package :: where to find more help
147        ------------------------------------------------------------------
148        Documentation + examples in www:
149        * GitHub pages : https://mirekslouf.github.io/bground
150        * GitHub docum : https://mirekslouf.github.io/bground/docs
151        ------------------------------------------------------------------
152        Additional help to the individual bkgr subtraction methods:
153        >>> import bground.api as bkg
154        >>> bkg.InteractivePlot.Help.how_it_works()
155        ------------------------------------------------------------------
156        Alternative access to help functions within ediff package
157        >>> import ediff as ed
158        >>> ed.bkg.InteractivePlot.Help.how_it_works()
159        ==================================================================
160        '''
161        
162        print(intelligent_dedent(help_text))

Class with help functions.

The functions print simple textual help.
Here: general help to whole bground package.

def brief_intro(): View Source

103    def brief_intro():
104        '''
105        BGROUND printed help :: Brief introduction
106        '''
107        
108        help_text = '''
109        =====================================================================
110        BGROUND :: (semi)automated background subtraction for XY-data
111        ---------------------------------------------------------------------
112        * input data = XY-data (two columns)
113            - text file or object with two (or more) columns
114            - one of the columns = X-data, some other column = Y-data
115            - allowed types of input (user specified input types and columns)
116              text file, np.array or pd.DataFrame or ediff.io.Profile
117        * output data = XY-data (four columns)
118            - text file(s) and/or ediff.io.Profile object with four columns
119            - cols in the text file: X, Y=Iraw, Ibkg, I=(Iraw-Ibkg)
120            - cols in ELD = Profile: ELD.Pixels, ELD.Iraw, ELD.Ibkg, ELD.I 
121        * semi-automated background subtraction:
122            - computer opens an interactive plot
123            - user defines background points with a mouse and keyboard
124            - computer calculates the background + saves it as/when requested
125        * fully-automated background subtraction:
126            - user selects a method for background subtraction
127            - computer calculates tha background and saves the output data
128            - the output data are saved to file(s) and/or ediff.io.Profile
129        * ediff.io.Profile
130            - a specific type of input/output data
131            - an object comming from our super-package ediff
132            - the object is a 1D-profile from powder electron diffractogram 
133        =====================================================================
134        '''
135        
136        print(intelligent_dedent(help_text))

BGROUND printed help :: Brief introduction

def more_help(): View Source

139    def more_help():
140        '''
141        BGROUND printed help :: Where to find additional help
142        '''
143        
144        help_text = '''
145        ==================================================================
146        BGROUND package :: where to find more help
147        ------------------------------------------------------------------
148        Documentation + examples in www:
149        * GitHub pages : https://mirekslouf.github.io/bground
150        * GitHub docum : https://mirekslouf.github.io/bground/docs
151        ------------------------------------------------------------------
152        Additional help to the individual bkgr subtraction methods:
153        >>> import bground.api as bkg
154        >>> bkg.InteractivePlot.Help.how_it_works()
155        ------------------------------------------------------------------
156        Alternative access to help functions within ediff package
157        >>> import ediff as ed
158        >>> ed.bkg.InteractivePlot.Help.how_it_works()
159        ==================================================================
160        '''
161        
162        print(intelligent_dedent(help_text))

BGROUND printed help :: Where to find additional help

class InteractivePlot: View Source

165class InteractivePlot:
166    '''
167    Class with help functions.
168    
169    * The functions print simple textual help.
170    * Here: help to {InteractivePlot} backgound subtraction method.
171    '''
172    
173    
174    def how_it_works():
175        '''
176        BGROUND printed help :: InteractivePlot :: How it works
177        '''
178        
179        help_text = '''
180        ===============================================================
181        BGROUND :: InteractivePlot :: How it works
182        ---------------------------------------------------------------
183        * BGROUND opens Matplotlib interactive plot
184        * the user defines backround points with mouse and keyboard
185        * mouse actions/events are Matplotlib UI defaults
186        * keyboard shortcuts/actions/events are defined by the program
187          - keys for background definition: 1,2,3,4,5,6
188          - keys for saving the results   : a,b,t,s,u
189          - basic help is printed when the interactive plot opens
190        --------------------------------------------------------------
191        Complete help on keyboard shortcuts with detailed explanation:
192        >>> import bground.api as bkg
193        >>> bkg.InteractivePlot.Help.keyboard_shortcuts()
194        --------------------------------------------------------------
195        Alternative access to help from EDIFF package:
196        >>> import ediff as ed
197        >>> ed.bkg.InteractivePlot.Help.keyboard_shortcuts()
198        ===============================================================
199        '''
200        
201        print(intelligent_dedent(help_text))
202    
203    
204    def keyboard_shortcuts( output_file='some_file' ):
205        '''
206        BGROUND printed help :: InteractivePlot :: Keyboard shortcuts
207        '''
208        
209        # (1) Define output file names
210        # (objective: all should have correct extensions
211        # (but we want to avoid double TXT extension for the main TXT file
212        TXTfile = output_file
213        BKGfile = output_file + '.bp'
214        PNGfile = output_file + '.png'
215        if not(TXTfile.lower().endswith('.txt')): TXTfile = TXTfile + '.txt'
216        
217        # (2) Print help including the above defined output file names
218        
219        help_text = f'''
220        ============================================================
221        BGROUND :: Interactive plot :: Keyboard shortcuts
222        ------------------------------------------------------------
223        1 = add a background point (at the mouse cursor position)
224        2 = delete a background point (close to the mouse cursor)
225        3 = show the plot with all background points
226        4 = show the plot with linear spline background
227        5 = show the plot with quadratic spline background
228        6 = show the plot with cubic spline background
229        ------------------------------------------------------------
230        a = background points :: load the previously saved
231        b = background points :: save to BKG-file'
232        (BKG-file = {BKGfile}
233        --------
234        s = save current plot to PNG-file:
235        (PNG-file = {PNGfile}
236        (note: Matplotlib UI shortcut; optional output
237        --------
238        t = subtract current background & save data to TXT-file
239        (TXT-file = {TXTfile}
240        (note: this is a universal output, applicable in all cases
241        --------
242        u = subtract current background & update ediff.io.Profile
243        (ediff.io.Profile = (alternative) object with i/o data
244        (note: the object is from ediff package; ignore if not used
245        ------------------------------------------------------------
246        Standard Matplotlib UI tools and shortcuts work as well.
247        See: https://matplotlib.org/stable/users/interactive.html
248        ============================================================
249        '''
250        
251        print(intelligent_dedent(help_text))

Class with help functions.

The functions print simple textual help.
Here: help to {InteractivePlot} backgound subtraction method.

def how_it_works(): View Source

174    def how_it_works():
175        '''
176        BGROUND printed help :: InteractivePlot :: How it works
177        '''
178        
179        help_text = '''
180        ===============================================================
181        BGROUND :: InteractivePlot :: How it works
182        ---------------------------------------------------------------
183        * BGROUND opens Matplotlib interactive plot
184        * the user defines backround points with mouse and keyboard
185        * mouse actions/events are Matplotlib UI defaults
186        * keyboard shortcuts/actions/events are defined by the program
187          - keys for background definition: 1,2,3,4,5,6
188          - keys for saving the results   : a,b,t,s,u
189          - basic help is printed when the interactive plot opens
190        --------------------------------------------------------------
191        Complete help on keyboard shortcuts with detailed explanation:
192        >>> import bground.api as bkg
193        >>> bkg.InteractivePlot.Help.keyboard_shortcuts()
194        --------------------------------------------------------------
195        Alternative access to help from EDIFF package:
196        >>> import ediff as ed
197        >>> ed.bkg.InteractivePlot.Help.keyboard_shortcuts()
198        ===============================================================
199        '''
200        
201        print(intelligent_dedent(help_text))

BGROUND printed help :: InteractivePlot :: How it works

def keyboard_shortcuts(output_file='some_file'): View Source

204    def keyboard_shortcuts( output_file='some_file' ):
205        '''
206        BGROUND printed help :: InteractivePlot :: Keyboard shortcuts
207        '''
208        
209        # (1) Define output file names
210        # (objective: all should have correct extensions
211        # (but we want to avoid double TXT extension for the main TXT file
212        TXTfile = output_file
213        BKGfile = output_file + '.bp'
214        PNGfile = output_file + '.png'
215        if not(TXTfile.lower().endswith('.txt')): TXTfile = TXTfile + '.txt'
216        
217        # (2) Print help including the above defined output file names
218        
219        help_text = f'''
220        ============================================================
221        BGROUND :: Interactive plot :: Keyboard shortcuts
222        ------------------------------------------------------------
223        1 = add a background point (at the mouse cursor position)
224        2 = delete a background point (close to the mouse cursor)
225        3 = show the plot with all background points
226        4 = show the plot with linear spline background
227        5 = show the plot with quadratic spline background
228        6 = show the plot with cubic spline background
229        ------------------------------------------------------------
230        a = background points :: load the previously saved
231        b = background points :: save to BKG-file'
232        (BKG-file = {BKGfile}
233        --------
234        s = save current plot to PNG-file:
235        (PNG-file = {PNGfile}
236        (note: Matplotlib UI shortcut; optional output
237        --------
238        t = subtract current background & save data to TXT-file
239        (TXT-file = {TXTfile}
240        (note: this is a universal output, applicable in all cases
241        --------
242        u = subtract current background & update ediff.io.Profile
243        (ediff.io.Profile = (alternative) object with i/o data
244        (note: the object is from ediff package; ignore if not used
245        ------------------------------------------------------------
246        Standard Matplotlib UI tools and shortcuts work as well.
247        See: https://matplotlib.org/stable/users/interactive.html
248        ============================================================
249        '''
250        
251        print(intelligent_dedent(help_text))

BGROUND printed help :: InteractivePlot :: Keyboard shortcuts

class RestoreFromPoints: View Source

254class RestoreFromPoints:
255    '''
256    Class with help functions.
257    
258    * The functions print simple textual help.
259    * Here: help to {RestoreFromPoints} backgound subtraction method.
260    '''
261     
262    
263    def how_it_works():
264        '''
265        BGROUND printed help :: RestoreFromPoints :: How it works
266        '''
267        
268        # TODO: brief text explanation
269        # (analogy of the same method in InterativePlot class above
270        print("Not implemented yet ...")

Class with help functions.

The functions print simple textual help.
Here: help to {RestoreFromPoints} backgound subtraction method.

def how_it_works(): View Source

263    def how_it_works():
264        '''
265        BGROUND printed help :: RestoreFromPoints :: How it works
266        '''
267        
268        # TODO: brief text explanation
269        # (analogy of the same method in InterativePlot class above
270        print("Not implemented yet ...")

BGROUND printed help :: RestoreFromPoints :: How it works

class SimpleFunc: View Source

273class SimpleFunc:
274    '''
275    Class with help functions.
276    
277    * The functions print simple textual help.
278    * Here: help to {SimpleFunc} backgound subtraction methods.
279    '''
280     
281    
282    def how_it_works():
283        '''
284        BGROUND printed help :: SimpleFunc :: How it works
285        '''
286        
287        # TODO: brief text explanation
288        # (analogy of the same method in InterativePlot class above
289        print("Not implemented yet ...")

Class with help functions.

The functions print simple textual help.
Here: help to {SimpleFunc} backgound subtraction methods.

def how_it_works(): View Source

282    def how_it_works():
283        '''
284        BGROUND printed help :: SimpleFunc :: How it works
285        '''
286        
287        # TODO: brief text explanation
288        # (analogy of the same method in InterativePlot class above
289        print("Not implemented yet ...")

BGROUND printed help :: SimpleFunc :: How it works

class BaseLines: View Source

292class BaseLines:
293    '''
294    Class with help functions.
295    
296    * The functions print simple textual help.
297    * Here: help to {BaseLines} backgound subtraction method.
298    '''
299     
300    
301    def how_it_works():
302        '''
303        BGROUND printed help :: BaseLines :: How it works
304        '''
305        
306        # TODO: brief text explanation
307        # (analogy of the same method in InterativePlot class above
308        print("Not implemented yet ...")

Class with help functions.

The functions print simple textual help.
Here: help to {BaseLines} backgound subtraction method.

def how_it_works(): View Source

301    def how_it_works():
302        '''
303        BGROUND printed help :: BaseLines :: How it works
304        '''
305        
306        # TODO: brief text explanation
307        # (analogy of the same method in InterativePlot class above
308        print("Not implemented yet ...")

BGROUND printed help :: BaseLines :: How it works

class WaveletMethod: View Source

311class WaveletMethod:
312    '''
313    Class with help functions.
314    
315    * The functions print simple textual help.
316    * Here: help to {WaveletMethod} backgound subtraction method.
317    '''
318     
319    
320    def how_it_works():
321        '''
322        BGROUND printed help :: WaveletMethod :: How it works
323        '''
324        
325        # TODO: brief text explanation
326        # (analogy of the same method in InterativePlot class above
327        print("Not implemented yet ...")

Class with help functions.

The functions print simple textual help.
Here: help to {WaveletMethod} backgound subtraction method.

def how_it_works(): View Source

320    def how_it_works():
321        '''
322        BGROUND printed help :: WaveletMethod :: How it works
323        '''
324        
325        # TODO: brief text explanation
326        # (analogy of the same method in InterativePlot class above
327        print("Not implemented yet ...")

BGROUND printed help :: WaveletMethod :: How it works