parameters: (self, mainWS)
return_statement: return flatBkgOption != common.BKG_OFF
docstring: Returns true if flat background subtraction is enabled, false otherwise.
docstring_summary: Returns true if flat background subtraction is enabled, false otherwise.
docstring_tokens: Returns true if flat background subtraction is enabled false otherwise .
function: def _flatBgkEnabled(self, mainWS):
          """Returns true if flat background subtraction is enabled, false otherwise."""
          flatBkgOption = self.getProperty(common.PROP_FLAT_BKG).value
          if flatBkgOption == common.BKG_AUTO:
              instrument = mainWS.getInstrument()
              if instrument.hasParameter('enable_flat_background_subtraction'):
                  enabled = instrument.getBoolParameter('enable_flat_background_subtraction')[0]
                  if not enabled:
                      self._report.notice('Flat background subtraction disabled by the IPF.')
                      return False
              self._report.notice('Flat background subtraction enabled.')
              return True
          return flatBkgOption != common.BKG_OFF
function_tokens: def _flatBgkEnabled ( self , mainWS ) : flatBkgOption = self . getProperty ( common . PROP_FLAT_BKG ) . value if flatBkgOption == common . BKG_AUTO : instrument = mainWS . getInstrument ( ) if instrument . hasParameter ( 'enable_flat_background_subtraction' ) : enabled = instrument . getBoolParameter ( 'enable_flat_background_subtraction' ) [ 0 ] if not enabled : self . _report . notice ( 'Flat background subtraction disabled by the IPF.' ) return False self . _report . notice ( 'Flat background subtraction enabled.' ) return True return flatBkgOption != common . BKG_OFF