smurf: Allow following flat to be used via a parameter

Defaults to current behaviour and the parameter is not sticky.
Starlink · Aug 29, 2012 · b3431dc · b3431dc
1 parent 31e2cb7
commit b3431dc
Show file tree

Hide file tree

Showing 11 changed files with 184 additions and 1 deletion.
diff --git a/applications/smurf/libsmf/smf_find_science.c b/applications/smurf/libsmf/smf_find_science.c
@@ -165,6 +165,8 @@
 *     2012-04-03 (TIMJ):
 *        No longer set status to bad if we have a bad flat. Report the problem
 *        and rely on downstream to complain.
+*     2012-08-29 (TIMJ):
+*        Allow the user to control whether the following flat should be used.
 
 *  Copyright:
 *     Copyright (C) 2008-2011 Science and Technology Facilities Council.
@@ -212,6 +214,8 @@
 #include "ast.h"
 #include "star/one.h"
 #include "prm_par.h"
+#include "par_err.h"
+#include "par.h"
 
 /* SMURF routines */
 #include "smf.h"
@@ -571,6 +575,7 @@ void smf_find_science(const Grp * ingrp, Grp **outgrp, int reverttodark,
               size_t ngood = 0;
               int itemp;
               int utdate = 0;
+              int ratioFlats = 0;
 
               /* Get the UT date - we do not compare flatfields after
                  the time we enabled heater tracking at each sequence. */
@@ -580,8 +585,24 @@ void smf_find_science(const Grp * ingrp, Grp **outgrp, int reverttodark,
               astMapGet0I( infomap, "NGOOD", &itemp );
               ngood = itemp;
 
+              /* Decide if we want to do the ratio test. We default to
+                 not doing it between 20110901 and 20120827 which is
+                 the period when we did mini-heater tracks before each
+                 flat. ! indicates that we choose based on date. */
+              if (*status == SAI__OK) {
+                parGet0l( "FLATUSENEXT", &ratioFlats, status );
+                if ( *status == PAR__NULL ) {
+                  errAnnul( status );
+                  if (utdate >= 20110901 || utdate <= 20120827 ) {
+                    ratioFlats = 0;
+                  } else {
+                    ratioFlats = 1;
+                  }
+                }
+              }
+
               /* Can we compare with the next flatfield? */
-              if (ngood < SMF__MINSTATSAMP || utdate >= 20110901 ) {
+              if (ngood < SMF__MINSTATSAMP || !ratioFlats ) {
                 /* no point doing all the ratio checking for this */
               } else if ( nelem - nf >= 2 ) {
                 AstKeyMap * nextmap = kmaps[nf+1];

diff --git a/applications/smurf/libsmurf/smurf_calcnoise.c b/applications/smurf/libsmurf/smurf_calcnoise.c
@@ -89,6 +89,14 @@
 *          Signal-to-noise ratio threshold to use when filtering the
 *          responsivity data to determine valid bolometers for the
 *          flatfield. [3.0]
+*     FLATUSENEXT = _LOGICAL (Read)
+*          If true the previous and following flatfield will be used to
+*          determine the overall flatfield to apply to a sequence. If false
+*          only the previous flatfield will be used. A null default will
+*          use both flatfields for data when we did not heater track
+*          at the end, and will use a single flatfield when we did heater
+*          track. The parameter value is not sticky and will revert to
+*          the default unless explicitly over-ridden. [!]
 *     FLOW = _DOUBLE (Given)
 *          Frequency to use when determining noise ratio image. The noise
 *          ratio image is determined by dividing the power at this frequency

diff --git a/applications/smurf/libsmurf/smurf_extinction.c b/applications/smurf/libsmurf/smurf_extinction.c
@@ -55,6 +55,14 @@
 *          Signal-to-noise ratio threshold to use when filtering the
 *          responsivity data to determine valid bolometers for the
 *          flatfield. [3.0]
+*     FLATUSENEXT = _LOGICAL (Read)
+*          If true the previous and following flatfield will be used to
+*          determine the overall flatfield to apply to a sequence. If false
+*          only the previous flatfield will be used. A null default will
+*          use both flatfields for data when we did not heater track
+*          at the end, and will use a single flatfield when we did heater
+*          track. The parameter value is not sticky and will revert to
+*          the default unless explicitly over-ridden. [!]
 *     HASSKYREM = _LOGICAL (Read)
 *          Indicate that the data have been sky removed even if the
 *          fact can not be verified. This is useful for the case where

diff --git a/applications/smurf/libsmurf/smurf_flatfield.c b/applications/smurf/libsmurf/smurf_flatfield.c
@@ -52,6 +52,14 @@
 *          Signal-to-noise ratio threshold to use when filtering the
 *          responsivity data to determine valid bolometers for the
 *          flatfield. [3.0]
+*     FLATUSENEXT = _LOGICAL (Read)
+*          If true the previous and following flatfield will be used to
+*          determine the overall flatfield to apply to a sequence. If false
+*          only the previous flatfield will be used. A null default will
+*          use both flatfields for data when we did not heater track
+*          at the end, and will use a single flatfield when we did heater
+*          track. The parameter value is not sticky and will revert to
+*          the default unless explicitly over-ridden. [!]
 *     IN = NDF (Read)
 *          Input files to be uncompressed and flatfielded. Any darks provided
 *          will be ignored.

diff --git a/applications/smurf/libsmurf/smurf_makemap.c b/applications/smurf/libsmurf/smurf_makemap.c
@@ -120,6 +120,14 @@
 *          Signal-to-noise ratio threshold to use when filtering the
 *          responsivity data to determine valid bolometers for the
 *          flatfield. [3.0]
+*     FLATUSENEXT = _LOGICAL (Read)
+*          If true the previous and following flatfield will be used to
+*          determine the overall flatfield to apply to a sequence. If false
+*          only the previous flatfield will be used. A null default will
+*          use both flatfields for data when we did not heater track
+*          at the end, and will use a single flatfield when we did heater
+*          track. The parameter value is not sticky and will revert to
+*          the default unless explicitly over-ridden. [!]
 *     FTL( ) = _DOUBLE (Write)
 *          Sky coordinates (radians) of the top left corner of the
 *          output map (the corner with the smallest PIXEL dimension for

diff --git a/applications/smurf/libsmurf/smurf_remsky.c b/applications/smurf/libsmurf/smurf_remsky.c
@@ -47,6 +47,14 @@
 *          Signal-to-noise ratio threshold to use when filtering the
 *          responsivity data to determine valid bolometers for the
 *          flatfield. [3.0]
+*     FLATUSENEXT = _LOGICAL (Read)
+*          If true the previous and following flatfield will be used to
+*          determine the overall flatfield to apply to a sequence. If false
+*          only the previous flatfield will be used. A null default will
+*          use both flatfields for data when we did not heater track
+*          at the end, and will use a single flatfield when we did heater
+*          track. The parameter value is not sticky and will revert to
+*          the default unless explicitly over-ridden. [!]
 *     GROUP = _LOGICAL (Read)
 *          If true, group related files together for processing as a
 *          single data set, else process each file independently. [FALSE]

diff --git a/applications/smurf/libsmurf/smurf_sc2clean.c b/applications/smurf/libsmurf/smurf_sc2clean.c
@@ -101,6 +101,14 @@
 *          Signal-to-noise ratio threshold to use when filtering the
 *          responsivity data to determine valid bolometers for the
 *          flatfield. [3.0]
+*     FLATUSENEXT = _LOGICAL (Read)
+*          If true the previous and following flatfield will be used to
+*          determine the overall flatfield to apply to a sequence. If false
+*          only the previous flatfield will be used. A null default will
+*          use both flatfields for data when we did not heater track
+*          at the end, and will use a single flatfield when we did heater
+*          track. The parameter value is not sticky and will revert to
+*          the default unless explicitly over-ridden. [!]
 *     GAI  = NDF (Write)
 *          If COMPREPROCESS is set in the configuration file, the common mode
 *          is calculated and removed from the bolometer data. The GAI adam

diff --git a/applications/smurf/libsmurf/smurf_sc2concat.c b/applications/smurf/libsmurf/smurf_sc2concat.c
@@ -46,6 +46,14 @@
 *          Signal-to-noise ratio threshold to use when filtering the
 *          responsivity data to determine valid bolometers for the
 *          flatfield. [3.0]
+*     FLATUSENEXT = _LOGICAL (Read)
+*          If true the previous and following flatfield will be used to
+*          determine the overall flatfield to apply to a sequence. If false
+*          only the previous flatfield will be used. A null default will
+*          use both flatfields for data when we did not heater track
+*          at the end, and will use a single flatfield when we did heater
+*          track. The parameter value is not sticky and will revert to
+*          the default unless explicitly over-ridden. [!]
 *     IN = NDF (Read)
 *          Input file(s).
 *     MAXLEN = _DOUBLE (Read)

diff --git a/applications/smurf/libsmurf/smurf_sc2fft.c b/applications/smurf/libsmurf/smurf_sc2fft.c
@@ -61,6 +61,14 @@
 *          Signal-to-noise ratio threshold to use when filtering the
 *          responsivity data to determine valid bolometers for the
 *          flatfield. [3.0]
+*     FLATUSENEXT = _LOGICAL (Read)
+*          If true the previous and following flatfield will be used to
+*          determine the overall flatfield to apply to a sequence. If false
+*          only the previous flatfield will be used. A null default will
+*          use both flatfields for data when we did not heater track
+*          at the end, and will use a single flatfield when we did heater
+*          track. The parameter value is not sticky and will revert to
+*          the default unless explicitly over-ridden. [!]
 *     IN = NDF (Read)
 *          Input files to be transformed.
 *     INVERSE = _LOGICAL (Read)

diff --git a/applications/smurf/libsmurf/smurf_sc2pca.c b/applications/smurf/libsmurf/smurf_sc2pca.c
@@ -59,6 +59,14 @@
 *          Signal-to-noise ratio threshold to use when filtering the
 *          responsivity data to determine valid bolometers for the
 *          flatfield. [3.0]
+*     FLATUSENEXT = _LOGICAL (Read)
+*          If true the previous and following flatfield will be used to
+*          determine the overall flatfield to apply to a sequence. If false
+*          only the previous flatfield will be used. A null default will
+*          use both flatfields for data when we did not heater track
+*          at the end, and will use a single flatfield when we did heater
+*          track. The parameter value is not sticky and will revert to
+*          the default unless explicitly over-ridden. [!]
 *     IN = NDF (Read)
 *          Input files to be uncompressed and flatfielded. Any darks provided
 *          will be subtracted prior to flatfielding.

diff --git a/applications/smurf/smurf.ifd.in b/applications/smurf/smurf.ifd.in
@@ -674,6 +674,15 @@ package @PACKAGE@ {
                 helpkey *
             }
 
+            parameter flatusenext {
+                type _LOGICAL
+                vpath DEFAULT
+                ppath DEFAULT
+                default !
+                prompt {Should we compare with following flatfield?}
+                helpkey *
+            }
+
             parameter resist {
                 type LITERAL
                 access READ
@@ -888,6 +897,15 @@ package @PACKAGE@ {
                 helpkey *
             }
 
+            parameter flatusenext {
+                type _LOGICAL
+                vpath DEFAULT
+                ppath DEFAULT
+                default !
+                prompt {Should we compare with following flatfield?}
+                helpkey *
+            }
+
             parameter resist {
                 type LITERAL
                 access READ
@@ -1366,6 +1384,15 @@ package @PACKAGE@ {
                 helpkey *
             }
 
+            parameter flatusenext {
+                type _LOGICAL
+                vpath DEFAULT
+                ppath DEFAULT
+                default !
+                prompt {Should we compare with following flatfield?}
+                helpkey *
+            }
+
             parameter resist {
                 type LITERAL
                 access READ
@@ -1803,6 +1830,15 @@ package @PACKAGE@ {
                 helpkey *
             }
 
+            parameter flatusenext {
+                type _LOGICAL
+                vpath DEFAULT
+                ppath DEFAULT
+                default !
+                prompt {Should we compare with following flatfield?}
+                helpkey *
+            }
+
             parameter resist {
                 type LITERAL
                 access READ
@@ -3226,6 +3262,15 @@ package @PACKAGE@ {
                 helpkey *
             }
 
+            parameter flatusenext {
+                type _LOGICAL
+                vpath DEFAULT
+                ppath DEFAULT
+                default !
+                prompt {Should we compare with following flatfield?}
+                helpkey *
+            }
+
             parameter resist {
                 type LITERAL
                 access READ
@@ -3474,6 +3519,15 @@ package @PACKAGE@ {
                 helpkey *
             }
 
+            parameter flatusenext {
+                type _LOGICAL
+                vpath DEFAULT
+                ppath DEFAULT
+                default !
+                prompt {Should we compare with following flatfield?}
+                helpkey *
+            }
+
             parameter resist {
                 type LITERAL
                 access READ
@@ -3643,6 +3697,15 @@ package @PACKAGE@ {
                 helpkey *
             }
 
+            parameter flatusenext {
+                type _LOGICAL
+                vpath DEFAULT
+                ppath DEFAULT
+                default !
+                prompt {Should we compare with following flatfield?}
+                helpkey *
+            }
+
             parameter resist {
                 type LITERAL
                 access READ
@@ -3779,6 +3842,15 @@ package @PACKAGE@ {
                 helpkey *
             }
 
+            parameter flatusenext {
+                type _LOGICAL
+                vpath DEFAULT
+                ppath DEFAULT
+                default !
+                prompt {Should we compare with following flatfield?}
+                helpkey *
+            }
+
             parameter resist {
                 type LITERAL
                 access READ
@@ -3985,6 +4057,15 @@ package @PACKAGE@ {
                 helpkey *
             }
 
+            parameter flatusenext {
+                type _LOGICAL
+                vpath DEFAULT
+                ppath DEFAULT
+                default !
+                prompt {Should we compare with following flatfield?}
+                helpkey *
+            }
+
             parameter resist {
                 type LITERAL
                 access READ
@@ -4271,6 +4352,15 @@ package @PACKAGE@ {
                 helpkey *
             }
 
+            parameter flatusenext {
+                type _LOGICAL
+                vpath DEFAULT
+                ppath DEFAULT
+                default !
+                prompt {Should we compare with following flatfield?}
+                helpkey *
+            }
+
             parameter resist {
                 type LITERAL
                 access READ