From fd258455b18d56b6cdffb293328aa21729a1cda3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andr=C3=A9=20Offringa?= <offringa@astron.nl>
Date: Tue, 30 May 2023 15:46:37 +0200
Subject: [PATCH] Some documentation changeS
---
doc/source/changelogs/v1.2.rst | 2 +-
doc/source/changelogs/v2.00.rst | 2 +-
doc/source/changelogs/v2.01.rst | 2 +-
doc/source/changelogs/v2.02.rst | 2 +-
doc/source/changelogs/v2.07.rst | 2 +-
doc/source/changelogs/v2.08.rst | 2 +-
imagesets/sdhdfimageset.h | 5 +++++
7 files changed, 11 insertions(+), 6 deletions(-)
diff --git a/doc/source/changelogs/v1.2.rst b/doc/source/changelogs/v1.2.rst
index 07401e13..113322db 100644
--- a/doc/source/changelogs/v1.2.rst
+++ b/doc/source/changelogs/v1.2.rst
@@ -36,5 +36,5 @@ v1.2
* Fixed various rare segmentation faults
* A lot of bug fixes and feature enhancements related to filtering
* A lot of doc fixes
-* Fixed some bugs that caused NDPPP not to work
+* Fixed some bugs that caused DP3 not to work
* Some Mac fixes by Ger van Diepen
diff --git a/doc/source/changelogs/v2.00.rst b/doc/source/changelogs/v2.00.rst
index a174f866..6fc3ece3 100644
--- a/doc/source/changelogs/v2.00.rst
+++ b/doc/source/changelogs/v2.00.rst
@@ -22,4 +22,4 @@ Changes:
* Bug fix: Times along x-axis in rfigui were not correct when splitting the data (reported by Raymond Oonk).
* Performance of dilation algorithm improved (is not used in default strategy).
* Slight performance improvement of SSE SumThreshold method.
-* New library interface: the statistics collector is used by NDPPP to accumulate statistics during averaging (NDPPP and AOFlagger remain independ though).
+* New library interface: the statistics collector is used by DP3 to accumulate statistics during averaging (DP3 and AOFlagger remain independent though).
diff --git a/doc/source/changelogs/v2.01.rst b/doc/source/changelogs/v2.01.rst
index df545da8..cd1ed4d1 100644
--- a/doc/source/changelogs/v2.01.rst
+++ b/doc/source/changelogs/v2.01.rst
@@ -21,7 +21,7 @@ v2.01
* Bug fix: Open button now has key accelerator.
* Bug fix: AOFlagger did not compile on gcc 4.7 (reported by J. Swinbank).
* Bug fix: Toolbar in the Rfigui will now always show both text and icons
-* Bug fix: Interface changed to allow NDPPP to read the raw data, NDPPP's problems fixed that concerned quality collecting.
+* Bug fix: Interface changed to allow DP3 to read the raw data, DP3's problems fixed that concerned quality collecting.
* Performance enhancement: Improved speed of horizontal sumthreshold algorithm with SSE instructions, leading to about 10% improved speed on overal strategy.
* Bug fix: fixed bug in previously mentioned new SumThreshold algorithm causing crashes (reported by J. Swinbank), also adding test case to validate result.
* Performance enhancement: Improved performance of reading meta data of measurement sets.
diff --git a/doc/source/changelogs/v2.02.rst b/doc/source/changelogs/v2.02.rst
index ab30bc8e..3aab6f5a 100644
--- a/doc/source/changelogs/v2.02.rst
+++ b/doc/source/changelogs/v2.02.rst
@@ -16,7 +16,7 @@ List of changes
* The software is no longer depending on the log4cpp library (this used to be required for the LOFAR infrastructure).
* Faster high-pass filtering algorithm using SSE instructions, which has replaced the sliding window algorithm in the default algorithm (3 x faster filtering, 10% benefit in full strategy).
* New reading mode that reads a full set in memory. It is 25% faster compared to indirect when every thing fits in memory (on a 1gb set: Direct: 2m53, Indirect: 1m55, Memory: 1m27). This is now the default reading mode when enough memory is available.
-* New public API. This API exposes a few simple & documented interface classes in a single header, that can be used to integrate the flagger and/or quality collector in an observatory's pipeline. It is used by the Cotter MWA preprocessing pipeline and will hopefully be used by LOFAR's preprocessing pipeline (NDPPP) some time in the future. Latest API docs can be found here: :doc:`../cpp_interface`
+* New public API. This API exposes a few simple & documented interface classes in a single header, that can be used to integrate the flagger and/or quality collector in an observatory's pipeline. It is used by the Cotter MWA preprocessing pipeline and will hopefully be used by LOFAR's preprocessing pipeline (DP3) some time in the future. Latest API docs can be found here: :doc:`../cpp_interface`
* New feature: action that can preliminary calibrate the passband (used in default MWA strategy)
* Bug fix: conversion from XX,YY to Stokes U did not work when no XY,YX polarization were available, as well as some other uncommon conversions.
* Bug fix: allow inverted vertical axes in plots, as well as some other plotting fixes.
diff --git a/doc/source/changelogs/v2.07.rst b/doc/source/changelogs/v2.07.rst
index 33cb8cbf..a6be02f7 100644
--- a/doc/source/changelogs/v2.07.rst
+++ b/doc/source/changelogs/v2.07.rst
@@ -36,7 +36,7 @@ Changes from 2.6 to 2.7
* Feature: Collect time-frequency information in aoquality collect.
* Feature: New colour map, 'fire', going via black to red to yellow to white.
* Feature: Specify data column during collecting.
-* Bugfix: Solving compilation issue when building with shared libraries (-DBUILD_SHARED_LIBS=ON) instead of a static library, to make it possible to link AOFlagger with new NDPPP.
+* Bugfix: Solving compilation issue when building with shared libraries (-DBUILD_SHARED_LIBS=ON) instead of a static library, to make it possible to link AOFlagger with new DP3.
* Bugfix: Adding newer FindCasacore.cmake from LOFAR repository, which supports casacore 2.
* Bugfix: Crash when pressing background or difference button when no image is loaded.
* Bugfix: Fixed all deprecated usage of GTKMM. Everything can now be compiled with '-DGTKMM_DISABLE_DEPRECATED' set (#52).
diff --git a/doc/source/changelogs/v2.08.rst b/doc/source/changelogs/v2.08.rst
index 8ee2427f..faff091c 100644
--- a/doc/source/changelogs/v2.08.rst
+++ b/doc/source/changelogs/v2.08.rst
@@ -10,7 +10,7 @@ This version has no major new features, but some small enhancements and quite a
New features
^^^^^^^^^^^^
-* Functionality in the interface to set a custom error handler and progress reporter (this also fixes exceptions ocurring whilst running within NDPPP).
+* Functionality in the interface to set a custom error handler and progress reporter (this also fixes exceptions ocurring whilst running within DP3).
* New aoqplot interface
* Adding a 'keep window open' checkbutton to the Goto window, requested by F. de Gasperin.
* Make the default size of the goto window somewhat larger.
diff --git a/imagesets/sdhdfimageset.h b/imagesets/sdhdfimageset.h
index 66c4385e..154f87b4 100644
--- a/imagesets/sdhdfimageset.h
+++ b/imagesets/sdhdfimageset.h
@@ -14,6 +14,11 @@ class H5File;
namespace imagesets {
+/**
+ * Implements the single-dish hdf5 format.
+ * The description of the format is here:
+ * https://bitbucket.csiro.au/projects/CPDA/repos/sdhdf_tools/browse/docs
+ */
class SdhdfImageSet final : public ImageSet {
public:
SdhdfImageSet(const std::string& path);
--
GitLab