Welcome to Sharp’s documentation!

Code documentation

• sharp
  • sharp package
    • Subpackages
      • sharp.config package
        • Subpackages
          • sharp.config.default package
            • Submodules
              • sharp.config.default.channels module
              • sharp.config.default.tasks module
        • Submodules
          • sharp.config.load module
          • sharp.config.spec module
      • sharp.data package
        • Subpackages
          • sharp.data.files package
            • Submodules
              • sharp.data.files.base module
              • sharp.data.files.evaluation module
              • sharp.data.files.figure module
              • sharp.data.files.neuralnet module
              • sharp.data.files.neuralynx module
              • sharp.data.files.numpy module
              • sharp.data.files.stdlib module
          • sharp.data.hardcoded package
            • Subpackages
              • sharp.data.hardcoded.filters package
                • Submodules
                  • sharp.data.hardcoded.filters.base module
                  • sharp.data.hardcoded.filters.best module
                  • sharp.data.hardcoded.filters.literature module
                  • sharp.data.hardcoded.filters.util module
            • Submodules
              • sharp.data.hardcoded.style module
          • sharp.data.types package
            • Subpackages
              • sharp.data.types.evaluation package
                • Submodules
                  • sharp.data.types.evaluation.sweep module
                  • sharp.data.types.evaluation.threshold module
            • Submodules
              • sharp.data.types.aliases module
              • sharp.data.types.intersection module
              • sharp.data.types.neuralnet module
              • sharp.data.types.signal module
              • sharp.data.types.slice module
              • sharp.data.types.split module
      • sharp.tasks package
        • Subpackages
          • sharp.tasks.evaluate package
            • Submodules
              • sharp.tasks.evaluate.multi_envelope module
              • sharp.tasks.evaluate.sweep module
              • sharp.tasks.evaluate.threshold module
          • sharp.tasks.multilin package
            • Submodules
              • sharp.tasks.multilin.apply module
              • sharp.tasks.multilin.base module
              • sharp.tasks.multilin.train module
          • sharp.tasks.neuralnet package
            • Submodules
              • sharp.tasks.neuralnet.apply module
              • sharp.tasks.neuralnet.base module
              • sharp.tasks.neuralnet.select module
              • sharp.tasks.neuralnet.train module
              • sharp.tasks.neuralnet.util module
          • sharp.tasks.plot package
            • Subpackages
              • sharp.tasks.plot.misc package
                • Submodules
                  • sharp.tasks.plot.misc.F_score module
                  • sharp.tasks.plot.misc.approx_lit_BPF module
                  • sharp.tasks.plot.misc.data_summary module
                  • sharp.tasks.plot.misc.filter_theory_searchlines module
                  • sharp.tasks.plot.misc.gevec_principle module
                  • sharp.tasks.plot.misc.offline_steps module
                  • sharp.tasks.plot.misc.reference module
                  • sharp.tasks.plot.misc.searchlines module
                  • sharp.tasks.plot.misc.training module
              • sharp.tasks.plot.paper package
                • Submodules
                  • sharp.tasks.plot.paper.PR_curve module
                  • sharp.tasks.plot.paper.grid module
                  • sharp.tasks.plot.paper.latency module
                  • sharp.tasks.plot.paper.signals module
              • sharp.tasks.plot.results package
                • Subpackages
                  • sharp.tasks.plot.results.searchgrid package
                    • Submodules
                      • sharp.tasks.plot.results.searchgrid.PR module
                      • sharp.tasks.plot.results.searchgrid.base module
                      • sharp.tasks.plot.results.searchgrid.latency module
                  • sharp.tasks.plot.results.searchlines package
                    • Submodules
                      • sharp.tasks.plot.results.searchlines.BPF module
                      • sharp.tasks.plot.results.searchlines.GEVec module
                      • sharp.tasks.plot.results.searchlines.base module
                • Submodules
                  • sharp.tasks.plot.results.PR_and_latency module
                  • sharp.tasks.plot.results.base module
                  • sharp.tasks.plot.results.envelopes module
                  • sharp.tasks.plot.results.latency_info module
                  • sharp.tasks.plot.results.latency_scatter module
                  • sharp.tasks.plot.results.weights module
              • sharp.tasks.plot.util package
                • Submodules
                  • sharp.tasks.plot.util.annotations module
                  • sharp.tasks.plot.util.arrow module
                  • sharp.tasks.plot.util.channelmap module
                  • sharp.tasks.plot.util.legend module
                  • sharp.tasks.plot.util.scalebar module
                  • sharp.tasks.plot.util.signal module
                  • sharp.tasks.plot.util.sizing module
            • Submodules
              • sharp.tasks.plot.base module
          • sharp.tasks.signal package
            • Submodules
              • sharp.tasks.signal.base module
              • sharp.tasks.signal.downsample module
              • sharp.tasks.signal.online_bpf module
              • sharp.tasks.signal.reference module
              • sharp.tasks.signal.util module
          • sharp.tasks.text package
            • Submodules
              • sharp.tasks.text.evaluation_info module
              • sharp.tasks.text.offline_steps_info module
              • sharp.tasks.text.online_BPF_info module
        • Submodules
          • sharp.tasks.base module
      • sharp.util package
        • Submodules
          • sharp.util.misc module
          • sharp.util.startup module

Data

• sharp.data package
  • Subpackages
    • sharp.data.files package
      • Submodules
        • sharp.data.files.base module
        • sharp.data.files.evaluation module
        • sharp.data.files.figure module
        • sharp.data.files.neuralnet module
        • sharp.data.files.neuralynx module
        • sharp.data.files.numpy module
        • sharp.data.files.stdlib module
    • sharp.data.hardcoded package
      • Subpackages
        • sharp.data.hardcoded.filters package
          • Submodules
            • sharp.data.hardcoded.filters.base module
            • sharp.data.hardcoded.filters.best module
            • sharp.data.hardcoded.filters.literature module
            • sharp.data.hardcoded.filters.util module
      • Submodules
        • sharp.data.hardcoded.style module
    • sharp.data.types package
      • Subpackages
        • sharp.data.types.evaluation package
          • Submodules
            • sharp.data.types.evaluation.sweep module
            • sharp.data.types.evaluation.threshold module
      • Submodules
        • sharp.data.types.aliases module
        • sharp.data.types.intersection module
        • sharp.data.types.neuralnet module
        • sharp.data.types.signal module
        • sharp.data.types.slice module
        • sharp.data.types.split module
• sharp.data.files package
  • Submodules
    • sharp.data.files.base module
    • sharp.data.files.evaluation module
    • sharp.data.files.figure module
    • sharp.data.files.neuralnet module
    • sharp.data.files.neuralynx module
    • sharp.data.files.numpy module
    • sharp.data.files.stdlib module
• sharp.data.types package
  • Subpackages
    • sharp.data.types.evaluation package
      • Submodules
        • sharp.data.types.evaluation.sweep module
        • sharp.data.types.evaluation.threshold module
  • Submodules
    • sharp.data.types.aliases module
    • sharp.data.types.intersection module
    • sharp.data.types.neuralnet module
    • sharp.data.types.signal module
    • sharp.data.types.slice module
    • sharp.data.types.split module

Tasks

• sharp.tasks package
  • Subpackages
    • sharp.tasks.evaluate package
      • Submodules
        • sharp.tasks.evaluate.multi_envelope module
        • sharp.tasks.evaluate.sweep module
        • sharp.tasks.evaluate.threshold module
    • sharp.tasks.multilin package
      • Submodules
        • sharp.tasks.multilin.apply module
        • sharp.tasks.multilin.base module
        • sharp.tasks.multilin.train module
    • sharp.tasks.neuralnet package
      • Submodules
        • sharp.tasks.neuralnet.apply module
        • sharp.tasks.neuralnet.base module
        • sharp.tasks.neuralnet.select module
        • sharp.tasks.neuralnet.train module
        • sharp.tasks.neuralnet.util module
    • sharp.tasks.plot package
      • Subpackages
        • sharp.tasks.plot.misc package
          • Submodules
            • sharp.tasks.plot.misc.F_score module
            • sharp.tasks.plot.misc.approx_lit_BPF module
            • sharp.tasks.plot.misc.data_summary module
            • sharp.tasks.plot.misc.filter_theory_searchlines module
            • sharp.tasks.plot.misc.gevec_principle module
            • sharp.tasks.plot.misc.offline_steps module
            • sharp.tasks.plot.misc.reference module
            • sharp.tasks.plot.misc.searchlines module
            • sharp.tasks.plot.misc.training module
        • sharp.tasks.plot.paper package
          • Submodules
            • sharp.tasks.plot.paper.PR_curve module
            • sharp.tasks.plot.paper.grid module
            • sharp.tasks.plot.paper.latency module
            • sharp.tasks.plot.paper.signals module
        • sharp.tasks.plot.results package
          • Subpackages
            • sharp.tasks.plot.results.searchgrid package
              • Submodules
                • sharp.tasks.plot.results.searchgrid.PR module
                • sharp.tasks.plot.results.searchgrid.base module
                • sharp.tasks.plot.results.searchgrid.latency module
            • sharp.tasks.plot.results.searchlines package
              • Submodules
                • sharp.tasks.plot.results.searchlines.BPF module
                • sharp.tasks.plot.results.searchlines.GEVec module
                • sharp.tasks.plot.results.searchlines.base module
          • Submodules
            • sharp.tasks.plot.results.PR_and_latency module
            • sharp.tasks.plot.results.base module
            • sharp.tasks.plot.results.envelopes module
            • sharp.tasks.plot.results.latency_info module
            • sharp.tasks.plot.results.latency_scatter module
            • sharp.tasks.plot.results.weights module
        • sharp.tasks.plot.util package
          • Submodules
            • sharp.tasks.plot.util.annotations module
            • sharp.tasks.plot.util.arrow module
            • sharp.tasks.plot.util.channelmap module
            • sharp.tasks.plot.util.legend module
            • sharp.tasks.plot.util.scalebar module
            • sharp.tasks.plot.util.signal module
            • sharp.tasks.plot.util.sizing module
      • Submodules
        • sharp.tasks.plot.base module
    • sharp.tasks.signal package
      • Submodules
        • sharp.tasks.signal.base module
        • sharp.tasks.signal.downsample module
        • sharp.tasks.signal.online_bpf module
        • sharp.tasks.signal.reference module
        • sharp.tasks.signal.util module
    • sharp.tasks.text package
      • Submodules
        • sharp.tasks.text.evaluation_info module
        • sharp.tasks.text.offline_steps_info module
        • sharp.tasks.text.online_BPF_info module
  • Submodules
    • sharp.tasks.base module
• sharp.tasks.signal package
  • Submodules
    • sharp.tasks.signal.base module
    • sharp.tasks.signal.downsample module
    • sharp.tasks.signal.online_bpf module
    • sharp.tasks.signal.reference module
    • sharp.tasks.signal.util module
• sharp.tasks.multilin package
  • Submodules
    • sharp.tasks.multilin.apply module
    • sharp.tasks.multilin.base module
    • sharp.tasks.multilin.train module
• sharp.tasks.neuralnet package
  • Submodules
    • sharp.tasks.neuralnet.apply module
    • sharp.tasks.neuralnet.base module
    • sharp.tasks.neuralnet.select module
    • sharp.tasks.neuralnet.train module
    • sharp.tasks.neuralnet.util module
• sharp.tasks.evaluate package
  • Submodules
    • sharp.tasks.evaluate.multi_envelope module
    • sharp.tasks.evaluate.sweep module
    • sharp.tasks.evaluate.threshold module
• sharp.tasks.plot package
  • Subpackages
    • sharp.tasks.plot.misc package
      • Submodules
        • sharp.tasks.plot.misc.F_score module
        • sharp.tasks.plot.misc.approx_lit_BPF module
        • sharp.tasks.plot.misc.data_summary module
        • sharp.tasks.plot.misc.filter_theory_searchlines module
        • sharp.tasks.plot.misc.gevec_principle module
        • sharp.tasks.plot.misc.offline_steps module
        • sharp.tasks.plot.misc.reference module
        • sharp.tasks.plot.misc.searchlines module
        • sharp.tasks.plot.misc.training module
    • sharp.tasks.plot.paper package
      • Submodules
        • sharp.tasks.plot.paper.PR_curve module
        • sharp.tasks.plot.paper.grid module
        • sharp.tasks.plot.paper.latency module
        • sharp.tasks.plot.paper.signals module
    • sharp.tasks.plot.results package
      • Subpackages
        • sharp.tasks.plot.results.searchgrid package
          • Submodules
            • sharp.tasks.plot.results.searchgrid.PR module
            • sharp.tasks.plot.results.searchgrid.base module
            • sharp.tasks.plot.results.searchgrid.latency module
        • sharp.tasks.plot.results.searchlines package
          • Submodules
            • sharp.tasks.plot.results.searchlines.BPF module
            • sharp.tasks.plot.results.searchlines.GEVec module
            • sharp.tasks.plot.results.searchlines.base module
      • Submodules
        • sharp.tasks.plot.results.PR_and_latency module
        • sharp.tasks.plot.results.base module
        • sharp.tasks.plot.results.envelopes module
        • sharp.tasks.plot.results.latency_info module
        • sharp.tasks.plot.results.latency_scatter module
        • sharp.tasks.plot.results.weights module
    • sharp.tasks.plot.util package
      • Submodules
        • sharp.tasks.plot.util.annotations module
        • sharp.tasks.plot.util.arrow module
        • sharp.tasks.plot.util.channelmap module
        • sharp.tasks.plot.util.legend module
        • sharp.tasks.plot.util.scalebar module
        • sharp.tasks.plot.util.signal module
        • sharp.tasks.plot.util.sizing module
  • Submodules
    • sharp.tasks.plot.base module

Tasks.Plot

• sharp.tasks.plot.results package
  • Subpackages
    • sharp.tasks.plot.results.searchgrid package
      • Submodules
        • sharp.tasks.plot.results.searchgrid.PR module
        • sharp.tasks.plot.results.searchgrid.base module
        • sharp.tasks.plot.results.searchgrid.latency module
    • sharp.tasks.plot.results.searchlines package
      • Submodules
        • sharp.tasks.plot.results.searchlines.BPF module
        • sharp.tasks.plot.results.searchlines.GEVec module
        • sharp.tasks.plot.results.searchlines.base module
  • Submodules
    • sharp.tasks.plot.results.PR_and_latency module
    • sharp.tasks.plot.results.base module
    • sharp.tasks.plot.results.envelopes module
    • sharp.tasks.plot.results.latency_info module
    • sharp.tasks.plot.results.latency_scatter module
    • sharp.tasks.plot.results.weights module
• sharp.tasks.plot.misc package
  • Submodules
    • sharp.tasks.plot.misc.F_score module
    • sharp.tasks.plot.misc.approx_lit_BPF module
    • sharp.tasks.plot.misc.data_summary module
    • sharp.tasks.plot.misc.filter_theory_searchlines module
    • sharp.tasks.plot.misc.gevec_principle module
    • sharp.tasks.plot.misc.offline_steps module
    • sharp.tasks.plot.misc.reference module
    • sharp.tasks.plot.misc.searchlines module
    • sharp.tasks.plot.misc.training module
• sharp.tasks.plot.util package
  • Submodules
    • sharp.tasks.plot.util.annotations module
    • sharp.tasks.plot.util.arrow module
    • sharp.tasks.plot.util.channelmap module
    • sharp.tasks.plot.util.legend module
    • sharp.tasks.plot.util.scalebar module
    • sharp.tasks.plot.util.signal module
    • sharp.tasks.plot.util.sizing module