Andreoffringa

AOFlagger: Public Interface API

AOFlagger Public Interface API

These pages document the C++ API of the AOFlagger public interface. It lets you add the flagger to an observatory pipeline with very little effort, so there is no need to understand the flagger's internal workings.

When integrating the flagger into a pipeline, start with the class description for aoflagger::AOFlagger. The same interface is also offered as a Python wrapper.

Getting Started with libaoflagger

  • Include #include <aoflagger.h> in your C++ source file.
  • Link your program to the library with -laoflagger.
  • For setup help, see the installation instructions on the website.

The full official documentation lives on the AOFlagger Read the Docs site. The LOFAR imaging cookbook also provides plenty of background on running the flagger.

Documentation Notes

These pages were generated for AOFlagger on Sun Jan 28 2024 22:13:46 using Doxygen 1.9.4.

Doxygen

The public interface keeps pipeline integration simple: include the header, link against libaoflagger, and drive the flagger through the aoflagger::AOFlagger class. The same entry point is available from Python, and the linked Read the Docs site and LOFAR imaging cookbook cover the full details.