About the API

These pages describe the C++ API of the public interface. This interface can be used to integrate the flagger into an observatory pipeline in an easy way, without having to know the internals of the flagger. If this flagger is to be integrated in a pipeline, the best place to start is to read the class description of class aoflagger::AOFlagger. This interface has also been wrapped in a Python interface.

To use libaoflagger, add an "#include <aoflagger.h>" to your C++ program and link with "-laoflagger". For installation instructions, check the website.

The official webpage of the full documentation is http://aoflagger.readthedocs.io/ . Additionally, the LOFAR imaging cookbook contains a lot of general info about running the flagger.