Changeset 30191 for trunk/ippToPsps/src/Batch.c

Timestamp:

Dec 28, 2010, 10:39:03 AM (15 years ago)

Author:

rhenders

Message:

added comments

File:

• trunk/ippToPsps/src/Batch.c (modified) (5 diffs)

trunk/ippToPsps/src/Batch.c

@@ -2 +2 @@
  *
  *  @ingroup ippToPsps
+ *
+ *  Source for all methods in the Batch class
  *
  *  @author IfA
@@ -25 +27 @@
 static bool haveSurveyType = false;
 
-
+// some getter methods
 static bool gotResultsPath() {return haveResultsPath;}
 static bool gotFitsInPath() {return haveFitsInPath;}
@@ -35 +37 @@
   Gets uncalibrated instrumental flux from magnitude
   */
-__inline bool getFlux(const float exposureTime, const float magnitude, float* flux, const float magnitudeErr, float* fluxErr) {
+__inline bool getFlux(
+        const float exposureTime, 
+        const float magnitude, 
+        float* flux,
+        const float magnitudeErr,
+        float* fluxErr) {
 
     *flux = powf(10.0, -0.4*magnitude) / exposureTime;
     if (!isfinite(*flux) || *flux < 0.000001) return false;
     if (fluxErr) *fluxErr = fabsf((magnitudeErr * *flux)/1.085736);
-//      if (fluxErr)    printf("Mag = %03.03f, Flux = %03.03f, Mag err = %03.03f, Flux Err = %03.03f\n", magnitude, *flux, magnitudeErr, *fluxErr);
 
     return true;
@@ -87 +93 @@
 
     psFree(this->pmconfig);
-
 
     for(uint32_t i=0; i<this->numOfInputFiles; i++) free(this->inputFiles[i]);
@@ -335 +340 @@
 
 /**
-  Constructor
+  Constructor. Takes a Batch object and initialises it.
   */
 bool new_Batch(Batch *this) {