Added PrintProgressBar function (utilities.cpp) and use of it in bootstrap resampling mode.

Updated make_export.sh to use updated Vagrant VM directories.

Author: perwin

CHANGELOG.md

@@ -21,6 +21,12 @@ at this point.
 
 ### Changed:
 
+- When doing bootstrap resampling, a one-line progress bar (with updating
+iteration count and percentage completion) is drawn to stdout; this replaces
+the printing of individual iteration numbers in previous versions, which
+could end up spilling over many lines of output. (Thanks to Iskren Georgiev
+for suggesting this.)
+
 - The SConstruct file has been updated to allow compiling on a Mac using
 Apple's Clang compiler, which (apparently since late 2017) finally has
 support for OpenMP! This *does*, however, require installing`libomp` (e.g., `brew

core/bootstrap_errors.cpp

@@ -9,7 +9,7 @@
  * nonlinfit (imfit's conceptual predecessor), so yay for reuse!
  */
 
-// Copyright 2013-2018 by Peter Erwin.
+// Copyright 2013-2019 by Peter Erwin.
 // 
 // This file is part of Imfit.
 // 
@@ -48,11 +48,13 @@
 #include "bootstrap_errors.h"
 #include "statistics.h"
 #include "print_results.h"
+#include "utilities_pub.h"
 
 using namespace std;
 
 
 const int MIN_ITERATIONS_FOR_STATISTICS = 3;
+const int PROGRESS_BAR_WIDTH = 80;
 
 
 /* ------------------- Function Prototypes ----------------------------- */
@@ -195,13 +197,15 @@ int BootstrapErrorsBase( const double *bestfitParams, vector<mp_par> parameterLi
 					double **outputParamArray, FILE *outputFile_ptr, unsigned long rngSeed )
 {
   double  *paramsVect, *paramOffsets;
-  int  i, status, nIter, nSuccessfulIters;
+  double  progress;
+  int  i, status, nIter, nDone, nSuccessfulIters;
+  int  progressBarPos;
   int  nParams = theModel->GetNParams();
   int  nValidPixels = theModel->GetNValidPixels();
   int  verboseLevel = -1;   // ensure minimizer stays silent
   bool  saveToFile = false;
-  string  outputLine;
-  
+  string  outputLine, iterTemplate;
+
   if (outputFile_ptr != NULL)
     saveToFile = true;
 
@@ -221,18 +225,21 @@ int BootstrapErrorsBase( const double *bestfitParams, vector<mp_par> parameterLi
   }
 
   if ((whichStatistic == FITSTAT_CHISQUARE) || (whichStatistic == FITSTAT_POISSON_MLR))
-    printf("\nStarting bootstrap iterations (L-M solver): ");
+    printf("Starting bootstrap iterations (L-M solver):\n");
   else
 #ifndef NO_NLOPT
-    printf("\nStarting bootstrap iterations (N-M simplex solver): ");
+    printf("Starting bootstrap iterations (N-M simplex solver):\n");
 #else
-    printf("\nStarting bootstrap iterations (DE solver): ");
+    printf("Starting bootstrap iterations (DE solver):\n");
 #endif
 
+
+  int  nDigits = floor(log10(nIterations)) + 1;
+  iterTemplate = PrintToString("] %%%dd", nDigits) + " (%3.1f%%)\r";
+
   // Bootstrap iterations:
   nSuccessfulIters = 0;
   for (nIter = 0; nIter < nIterations; nIter++) {
-    printf("%d...  ", nIter + 1);
     fflush(stdout);
     theModel->MakeBootstrapSample();
     for (i = 0; i < nParams; i++)
@@ -265,7 +272,25 @@ int BootstrapErrorsBase( const double *bestfitParams, vector<mp_par> parameterLi
       }
       nSuccessfulIters += 1;
     }
+    
+    // print/update progress bar
+    nDone = nIter + 1;
+    PrintProgressBar(nDone, nIterations, iterTemplate, PROGRESS_BAR_WIDTH);
+//     progress = nDone / (1.0*nIterations);
+//     progressBarPos = PROGRESS_BAR_WIDTH * progress;
+//     printf("[");
+//     for (int j = 0; j < PROGRESS_BAR_WIDTH; j++) {
+//       if (j < progressBarPos)
+//         printf("=");
+//       else if (j == progressBarPos)
+//         printf(">");
+//       else
+//         printf(" ");
+//     }
+//     printf(iterTemplate.c_str(), nDone, (100.0 * progress));
+//     fflush(stdout);
   }
+  printf("\n");
 
 
   free(paramsVect);

core/utilities.cpp

@@ -174,6 +174,30 @@ void PrintParametersSimple( ModelObject *model, double *parameters )
 
 
 
+/* ---------------- FUNCTION: PrintProgressBar() ------------------- */
+/// Prints an updated progress bar.
+///    printTemplate should be a string with one "%d" and one "%d" formatting
+///    sequences -- e.g., " niter = %3d (%.1f%%)"
+///    barWidth = full width of progress bar in characters
+void PrintProgressBar( int nDone, int nTotal, string printTemplate, int barWidth )
+{
+  double  progress = nDone / (1.0*nTotal);
+  int  progressBarPos = (int)(progress * barWidth);
+  
+  printf("[");
+  for (int i = 0; i < barWidth; i++) {
+    if (i < progressBarPos)
+      printf("=");
+    else if (i == progressBarPos)
+      printf(">");
+    else
+      printf(" ");
+  }
+  printf(printTemplate.c_str(), nDone, (100.0 * progress));
+  fflush(stdout);
+}
+
+
 
 /* ---------------- FUNCTION: SplitString() ------------------------ */
 /// This function tokenizes a string, splitting it into substrings using

core/utilities_pub.h

@@ -51,6 +51,9 @@ void PrepareImageComments( vector<string> *comments, const string &programName,
 ///        with names) to stdout
 void PrintParametersSimple( ModelObject *model, double *parameters );
 
+/// \brief Utility function to draw/update a progress bar by printing to stdout
+void PrintProgressBar( int nDone, int nTotal, string printTemplate, int barWidth );
+
 
 
 

make_export.sh

@@ -3,11 +3,13 @@
 # Script to bundle up current repo (renamed to imfit-export) and copy it 
 # to Vagrant directory for compiling Linux version
 
-linux_vm_dest="/Users/erwin/vagrant/ubuntu-16_test"
+linux_vm_dest64="/Users/erwin/vagrant/ubuntu64-16_dev/transfer"
+linux_vm_dest32="/Users/erwin/vagrant/ubuntu32-16_dev/transfer"
 
 cd /Users/erwin/coding
 rm imfit-export.tar.gz
 rm -rf imfit-export
 hg clone imfit imfit-export
 tar -cf imfit-export.tar imfit-export && gzip imfit-export.tar
-cp imfit-export.tar.gz ${linux_vm_dest}
+cp imfit-export.tar.gz ${linux_vm_dest1}
+cp imfit-export.tar.gz ${linux_vm_dest2}

tests/imfit_reference/imfit_textout5e_tail

@@ -1,6 +1,6 @@
-Now doing bootstrap resampling (5 iterations) to estimate errors...
+Starting bootstrap iterations (L-M solver):
+[================>                                                               ] 1 (20.0%)[================================>                                               ] 2 (40.0%)[================================================>                               ] 3 (60.0%)[================================================================>               ] 4 (80.0%)[================================================================================] 5 (100.0%)
 
-Starting bootstrap iterations (L-M solver): 1...  2...  3...  4...  5...  
 Statistics for parameter values from bootstrap resampling (5 successful iterations):
 Best-fit		 Bootstrap      [68% conf.int., half-width]; (mean +/- standard deviation)
 X0 = 32.9497  +0.0547039, -0.00239716    [32.9473 -- 33.0044, 0.0285506];  (32.9758 +/- 0.0255166)
@@ -13,6 +13,6 @@ r_e = 58.0709  +3.24553, -1.56195    [56.509 -- 61.3164, 2.40374];  (58.3155 +/-
 Bootstrap-resampling output saved to file "temptest/temp_bootstrap_output2.dat".
 Saving best-fit parameters in file "bestfit_parameters_imfit.dat"
 
-(Elapsed time: 0.049036 sec for fit, 0.068760 for bootstrap, 0.121389 sec total)
+(Elapsed time: 0.133669 sec for fit, 0.198461 for bootstrap, 0.342853 sec total)
 Done!