Introduction

This is a Framework for Noise Cancellation in the context of gravitational wave detection. franc.evaluation provides a framework to analyze and compare the effectiveness of noise mitigation techniques. franc.filtering provides python implementations of different static and adaptive filtering techniques for the prediction of a correlated signal component from witness signals. The main goal is to provide a unified interface for the different filtering techniques.

Version:

0.3.8

Table of Contents

• Concepts and wording
  • Datamodel
  • Concepts
• Evaluating techniques on a dataset
  • Defining a dataset
  • Executing an evaluation run
• Filtering techniques
  • Built-in filtering techniques
  • Minimal example
• Adding filtering techniques
  • Minimal example
• Adding evaluation metrics
  • Adding scalar metrics
  • Adding plotable metrics
  • Adding other metrics
  • Parameterizing metrics
• API Reference
  • franc
    • Submodules
    • Attributes
    • Package Contents