87char *option[N_OPTIONS] = {
103 "sddsexpfit [<inputfile>] [<outputfile>]\n"
104 " [-pipe=[input][,output]]\n"
106 " -columns=<x-name>,<y-name>[,ySigma=<name>]\n"
107 " [-tolerance=<value>]\n"
108 " [-verbosity=<integer>]\n"
109 " [-clue={grows|decays}]\n"
110 " [-guess=<constant>,<factor>,<rate>]\n"
111 " [-startValues=[constant=<value>][,factor=<value>][,rate=<value>]]\n"
112 " [-fixValue=[constant=<value>][,factor=<value>][,rate=<value>]]\n"
114 " [-limits=[evaluations=<number>][,passes=<number>]]\n"
115 " [-majorOrder=row|column]\n\n"
116 "Performs an exponential fit of the form y = <constant> + <factor> * exp(<rate> * x).\n\n"
117 "Program by Michael Borland. (" __DATE__
" " __TIME__
", SVN revision: " SVN_VERSION
")\n";
119static double *xData, *yData, *syData;
121static double yMin, yMax, xMin, xMax;
124double fitFunction(
double *a,
long *invalid);
125void report(
double res,
double *a,
long pass,
long n_eval,
long n_dimen);
126void setupOutputFile(
SDDS_DATASET *OutputTable,
long *xIndex,
long *yIndex,
long *fitIndex,
long *residualIndex,
char *output,
long fullOutput,
SDDS_DATASET *InputTable,
char *xName,
char *yName,
short columnMajorOrder);
127char *makeInverseUnits(
char *units);
129#define START_CONSTANT_GIVEN 0x0001
130#define FIX_CONSTANT_GIVEN (0x0001 << 3)
131#define START_FACTOR_GIVEN 0x0002
132#define FIX_FACTOR_GIVEN (0x0002 << 3)
133#define START_RATE_GIVEN 0x0004
134#define FIX_RATE_GIVEN (0x0004 << 3)
138#define N_CLUE_TYPES 2
139char *clue_name[N_CLUE_TYPES] = {
146int main(
int argc,
char **argv) {
147 double tolerance, result, chiSqr, sigLevel;
148 int32_t nEvalMax = 5000, nPassMax = 100;
151 double alo[3], ahi[3];
152 long n_dimen = 3, guessGiven, startGiven;
155 long i_arg, clue, fullOutput;
157 char *input, *output, *xName, *yName, *syName;
158 long xIndex, yIndex, fitIndex, residualIndex, retval;
159 double *fitData, *residualData, rmsResidual;
160 unsigned long guessFlags, pipeFlags, dummyFlags, majorOrderFlag;
161 double constantStart, factorStart, rateStart;
162 short disable[3] = {0, 0, 0};
163 short autoOffset = 0;
164 short columnMajorOrder = -1;
167 argc =
scanargs(&s_arg, argc, argv);
168 if (argc < 2 || argc > (2 + N_OPTIONS))
171 input = output = NULL;
173 verbosity = fullOutput = guessGiven = startGiven = 0;
175 xName = yName = syName = NULL;
176 pipeFlags = guessFlags = 0;
177 constantStart = factorStart = rateStart = 0;
179 for (i_arg = 1; i_arg < argc; i_arg++) {
180 if (s_arg[i_arg].arg_type == OPTION) {
181 switch (
match_string(s_arg[i_arg].list[0], option, N_OPTIONS, 0)) {
182 case SET_MAJOR_ORDER:
184 s_arg[i_arg].n_items--;
185 if (s_arg[i_arg].n_items > 0 && (!
scanItemList(&majorOrderFlag, s_arg[i_arg].list + 1, &s_arg[i_arg].n_items, 0,
"row", -1, NULL, 0, SDDS_ROW_MAJOR_ORDER,
"column", -1, NULL, 0, SDDS_COLUMN_MAJOR_ORDER, NULL)))
186 SDDS_Bomb(
"invalid -majorOrder syntax/values");
187 if (majorOrderFlag & SDDS_COLUMN_MAJOR_ORDER)
188 columnMajorOrder = 1;
189 else if (majorOrderFlag & SDDS_ROW_MAJOR_ORDER)
190 columnMajorOrder = 0;
196 if (s_arg[i_arg].n_items != 2 || sscanf(s_arg[i_arg].list[1],
"%lf", &tolerance) != 1)
197 SDDS_Bomb(
"incorrect -tolerance syntax");
200 if (s_arg[i_arg].n_items != 2 || sscanf(s_arg[i_arg].list[1],
"%ld", &verbosity) != 1)
201 SDDS_Bomb(
"incorrect -verbosity syntax");
204 if (s_arg[i_arg].n_items != 2 || (clue =
match_string(s_arg[i_arg].list[1], clue_name, N_CLUE_TYPES, 0)) < 0)
209 SDDS_Bomb(
"can't have -startValues and -guess at once");
210 if (s_arg[i_arg].n_items != 4 || sscanf(s_arg[i_arg].list[1],
"%lf", guess + 0) != 1 || sscanf(s_arg[i_arg].list[2],
"%lf", guess + 1) != 1 || sscanf(s_arg[i_arg].list[3],
"%lf", guess + 2) != 1)
214 case SET_STARTVALUES:
215 if (s_arg[i_arg].n_items < 2)
216 SDDS_Bomb(
"incorrect -startValues syntax");
218 SDDS_Bomb(
"can't have -startValues and -guess at once");
219 s_arg[i_arg].n_items -= 1;
220 dummyFlags = guessFlags;
221 if (!
scanItemList(&guessFlags, s_arg[i_arg].list + 1, &s_arg[i_arg].n_items, 0,
"constant",
SDDS_DOUBLE, &constantStart, 1, START_CONSTANT_GIVEN,
"factor",
SDDS_DOUBLE, &factorStart, 1, START_FACTOR_GIVEN,
"rate",
SDDS_DOUBLE, &rateStart, 1, START_RATE_GIVEN, NULL))
223 if ((dummyFlags >> 3) & (guessFlags))
224 SDDS_Bomb(
"can't have -fixValue and -startValue for the same item");
225 guessFlags |= dummyFlags;
229 if (s_arg[i_arg].n_items < 2)
231 s_arg[i_arg].n_items -= 1;
232 dummyFlags = guessFlags;
233 if (!
scanItemList(&guessFlags, s_arg[i_arg].list + 1, &s_arg[i_arg].n_items, 0,
"constant",
SDDS_DOUBLE, &constantStart, 1, FIX_CONSTANT_GIVEN,
"factor",
SDDS_DOUBLE, &factorStart, 1, FIX_FACTOR_GIVEN,
"rate",
SDDS_DOUBLE, &rateStart, 1, FIX_RATE_GIVEN, NULL))
235 if ((dummyFlags) & (guessFlags >> 3))
236 SDDS_Bomb(
"can't have -fixValue and -startValue for the same item");
237 guessFlags |= dummyFlags;
240 if (s_arg[i_arg].n_items != 3 && s_arg[i_arg].n_items != 4)
242 xName = s_arg[i_arg].list[1];
243 yName = s_arg[i_arg].list[2];
244 s_arg[i_arg].n_items -= 3;
245 if (!
scanItemList(&dummyFlags, s_arg[i_arg].list + 3, &s_arg[i_arg].n_items, 0,
"ysigma",
SDDS_STRING, &syName, 1, 0, NULL))
252 if (!
processPipeOption(s_arg[i_arg].list + 1, s_arg[i_arg].n_items - 1, &pipeFlags))
256 if (s_arg[i_arg].n_items < 2)
258 s_arg[i_arg].n_items -= 1;
259 if (!
scanItemList(&dummyFlags, s_arg[i_arg].list + 1, &s_arg[i_arg].n_items, 0,
"evaluations",
SDDS_LONG, &nEvalMax, 1, 0,
"passes",
SDDS_LONG, &nPassMax, 1, 0, NULL) || nEvalMax <= 0 || nPassMax <= 0)
263 fprintf(stderr,
"error: unknown/ambiguous option: %s\n", s_arg[i_arg].list[0]);
269 input = s_arg[i_arg].list[0];
270 else if (output == NULL)
271 output = s_arg[i_arg].list[0];
279 for (i = 0; i < 3; i++) {
280 if ((guessFlags >> 3) & (1 << i)) {
285 if (!xName || !yName)
286 SDDS_Bomb(
"-columns option must be given");
292 setupOutputFile(&OutputTable, &xIndex, &yIndex, &fitIndex, &residualIndex, output, fullOutput, &InputTable, xName, yName, columnMajorOrder);
295 fitData = residualData = NULL;
296 xData = yData = syData = NULL;
304 if (xData[0] > xData[nData - 1])
305 fputs(
"warning: data reverse-ordered", stderr);
309 for (i = 0; i < nData; i++)
316 if (clue == CLUE_GROWS) {
317 a[0] = 0.9 * yData[0];
318 a[1] = yData[nData - 1] - yData[0];
319 a[2] = 1 / (xData[nData - 1] - xData[0]);
325 }
else if (clue == CLUE_DECAYS) {
326 a[0] = 0.9 * yData[nData - 1];
327 a[1] = yData[0] - yData[nData - 1];
345 if (guessFlags & (START_CONSTANT_GIVEN + FIX_CONSTANT_GIVEN))
346 a[0] = constantStart;
347 if (guessFlags & (START_FACTOR_GIVEN + FIX_FACTOR_GIVEN))
349 if (guessFlags & (START_RATE_GIVEN + FIX_RATE_GIVEN))
352 da[0] = da[1] = fabs(a[1] - a[0]) / 20.0;
353 da[2] = 0.1 / (xData[nData - 1] - xData[0]);
355 fprintf(stderr,
"starting guess: %e, %e, %e\n", a[0], a[1], a[2]);
357 simplexMin(&result, a, da, alo, ahi, disable, n_dimen, -DBL_MAX, tolerance, fitFunction, (verbosity > 0 ? report : NULL), nEvalMax, nPassMax, 12, 3, 1.0, 0);
362 simplexMin(&result, a, da, alo, ahi, disable, n_dimen, -DBL_MAX, tolerance, fitFunction, (verbosity > 0 ? report : NULL), nEvalMax, nPassMax, 12, 3, 1.0, 0);
366 a[1] *= exp(-a[2] * xMin);
367 for (i = 0; i < nData; i++)
371 fitData =
trealloc(fitData,
sizeof(*fitData) * nData);
372 residualData =
trealloc(residualData,
sizeof(*residualData) * nData);
373 for (i = result = 0; i < nData; i++) {
374 fitData[i] = a[0] + a[1] * exp(a[2] * xData[i]);
375 residualData[i] = yData[i] - fitData[i];
376 result += sqr(residualData[i]);
378 rmsResidual = sqrt(result / nData);
380 for (i = chiSqr = 0; i < nData; i++)
381 chiSqr += sqr(residualData[i] / syData[i]);
384 sy2 = result / (nData - 3);
385 for (i = chiSqr = 0; i < nData; i++)
386 chiSqr += sqr(residualData[i]) / sy2;
390 fprintf(stderr,
"RMS deviation: %.15e\n", rmsResidual);
391 fprintf(stderr,
"(RMS deviation)/(largest value): %.15e\n", rmsResidual / MAX(fabs(yMin), fabs(yMax)));
393 fprintf(stderr,
"Significance level: %.5e\n", sigLevel);
396 fprintf(stderr,
"coefficients of fit to the form y = a0 + a1*exp(a2*x), a = \n");
397 for (i = 0; i < 3; i++)
398 fprintf(stderr,
"%.8e ", a[i]);
399 fprintf(stderr,
"\n");
404 !
SDDS_SetColumn(&OutputTable, SDDS_SET_BY_INDEX, xData, nData, xIndex) ||
405 !
SDDS_SetColumn(&OutputTable, SDDS_SET_BY_INDEX, fitData, nData, fitIndex) ||
407 "expfitConstant", a[0],
408 "expfitFactor", a[1],
410 "expfitRmsResidual", rmsResidual,
411 "expfitSigLevel", sigLevel, NULL) ||
412 (fullOutput && (!
SDDS_SetColumn(&OutputTable, SDDS_SET_BY_INDEX, yData, nData, yIndex) ||
413 !
SDDS_SetColumn(&OutputTable, SDDS_SET_BY_INDEX, residualData, nData, residualIndex))) ||
434void setupOutputFile(
SDDS_DATASET *OutputTable,
long *xIndex,
long *yIndex,
long *fitIndex,
long *residualIndex,
char *output,
long fullOutput,
SDDS_DATASET *InputTable,
char *xName,
char *yName,
short columnMajorOrder) {
435 char *name, *yUnits, *description, *xUnits, *inverse_xUnits;
437 static char *residualNamePart =
"Residual";
438 static char *residualDescriptionPart =
"Residual of exponential fit to ";
450 if (columnMajorOrder != -1)
451 OutputTable->layout.data_mode.column_major = columnMajorOrder;
453 OutputTable->layout.data_mode.column_major = InputTable->layout.data_mode.column_major;
455 name =
tmalloc(
sizeof(*name) * (strlen(yName) + strlen(residualNamePart) + 1));
456 description =
tmalloc(
sizeof(*name) * (strlen(yName) + strlen(residualDescriptionPart) + 1));
463 sprintf(name,
"%s%s", yName, residualNamePart);
464 sprintf(description,
"%s%s", yName, residualDescriptionPart);
469 sprintf(name,
"%sFit", yName);
470 sprintf(description,
"Exponential fit to %s", yName);
474 inverse_xUnits = makeInverseUnits(xUnits);
476 if (
SDDS_DefineParameter(OutputTable,
"expfitConstant", NULL, yUnits,
"Constant term from exponential fit",
480 SDDS_DefineParameter(OutputTable,
"expfitRate", NULL, inverse_xUnits,
"Rate from exponential fit",
482 SDDS_DefineParameter(OutputTable,
"expfitRmsResidual", NULL, yUnits,
"RMS residual from exponential fit",
490char *makeInverseUnits(
char *units) {
495 inverseUnits =
tmalloc(
sizeof(*inverseUnits) * (strlen(units) + 5));
497 if (strncmp(units,
"1/(", 3) == 0 && units[strlen(units) - 1] ==
')') {
499 strcpy(inverseUnits, units + 3);
500 inverseUnits[strlen(inverseUnits) - 1] =
'\0';
501 }
else if (!strchr(units,
' ')) {
503 sprintf(inverseUnits,
"1/%s", units);
506 sprintf(inverseUnits,
"1/(%s)", units);
512double fitFunction(
double *a,
long *invalid) {
514 double chi = 0.0, diff;
515 static double min_chi;
520 for (i = 0; i < nData; i++) {
521 diff = yData[i] - (a[0] + a[1] * exp(a[2] * xData[i]));
526 if (isnan(chi) || isinf(chi))
529 fprintf(stderr,
"trial: a = %e, %e, %e --> chi = %e, invalid = %ld\n", a[0], a[1], a[2], chi, *invalid);
536 fprintf(stderr,
"new best chi = %e: a = %e, %e, %e\n", chi, fit[0], fit[1], fit[2]);
541void report(
double y,
double *x,
long pass,
long nEval,
long n_dimen) {
544 fprintf(stderr,
"Pass %ld, after %ld evaluations: result = %.16e\na = ", pass, nEval, y);
545 for (i = 0; i < n_dimen; i++)
546 fprintf(stderr,
"%.8e ", x[i]);
SDDS (Self Describing Data Set) Data Types Definitions and Function Prototypes.
int32_t SDDS_CopyParameters(SDDS_DATASET *SDDS_target, SDDS_DATASET *SDDS_source)
int32_t SDDS_StartPage(SDDS_DATASET *SDDS_dataset, int64_t expected_n_rows)
int32_t SDDS_SetParameters(SDDS_DATASET *SDDS_dataset, int32_t mode,...)
int32_t SDDS_SetColumn(SDDS_DATASET *SDDS_dataset, int32_t mode, void *data, int64_t rows,...)
Sets the values for one data column in the current data table of an SDDS dataset.
int32_t SDDS_ChangeColumnInformation(SDDS_DATASET *SDDS_dataset, char *field_name, void *memory, int32_t mode,...)
Modifies a specific field in a column definition within the SDDS dataset.
int32_t SDDS_GetColumnInformation(SDDS_DATASET *SDDS_dataset, char *field_name, void *memory, int32_t mode,...)
Retrieves information about a specified column in the SDDS dataset.
int32_t SDDS_InitializeOutput(SDDS_DATASET *SDDS_dataset, int32_t data_mode, int32_t lines_per_row, const char *description, const char *contents, const char *filename)
Initializes the SDDS output dataset.
int32_t SDDS_WritePage(SDDS_DATASET *SDDS_dataset)
Writes the current data table to the output file.
int32_t SDDS_DefineColumn(SDDS_DATASET *SDDS_dataset, const char *name, const char *symbol, const char *units, const char *description, const char *format_string, int32_t type, int32_t field_length)
Defines a data column within the SDDS dataset.
int32_t SDDS_WriteLayout(SDDS_DATASET *SDDS_dataset)
Writes the SDDS layout header to the output file.
int32_t SDDS_DefineParameter(SDDS_DATASET *SDDS_dataset, const char *name, const char *symbol, const char *units, const char *description, const char *format_string, int32_t type, char *fixed_value)
Defines a data parameter with a fixed string value.
int32_t SDDS_TransferColumnDefinition(SDDS_DATASET *target, SDDS_DATASET *source, char *name, char *newName)
Transfers a column definition from a source dataset to a target dataset.
int32_t SDDS_TransferAllParameterDefinitions(SDDS_DATASET *SDDS_target, SDDS_DATASET *SDDS_source, uint32_t mode)
Transfers all parameter definitions from a source dataset to a target dataset.
int32_t SDDS_GetColumnIndex(SDDS_DATASET *SDDS_dataset, char *name)
Retrieves the index of a named column in the SDDS dataset.
void SDDS_PrintErrors(FILE *fp, int32_t mode)
Prints recorded error messages to a specified file stream.
void SDDS_RegisterProgramName(const char *name)
Registers the executable program name for use in error messages.
int32_t SDDS_StringIsBlank(char *s)
Checks if a string is blank (contains only whitespace characters).
void SDDS_Bomb(char *message)
Terminates the program after printing an error message and recorded errors.
#define SDDS_STRING
Identifier for the string data type.
#define SDDS_LONG
Identifier for the signed 32-bit integer data type.
#define SDDS_DOUBLE
Identifier for the double data type.
void * trealloc(void *old_ptr, uint64_t size_of_block)
Reallocates a memory block to a new size.
void * tmalloc(uint64_t size_of_block)
Allocates a memory block of the specified size with zero initialization.
void bomb(char *error, char *usage)
Reports error messages to the terminal and aborts the program.
void fill_double_array(double *array, long n, double value)
Fills a double array with the specified value.
int find_min_max(double *min, double *max, double *list, int64_t n)
Finds the minimum and maximum values in a list of doubles.
long match_string(char *string, char **option, long n_options, long mode)
Matches a given string against an array of option strings based on specified modes.
int scanargs(SCANNED_ARG **scanned, int argc, char **argv)
long processPipeOption(char **item, long items, unsigned long *flags)
void processFilenames(char *programName, char **input, char **output, unsigned long pipeFlags, long noWarnings, long *tmpOutputUsed)
long scanItemList(unsigned long *flags, char **item, long *items, unsigned long mode,...)
Scans a list of items and assigns values based on provided keywords and types.
double ChiSqrSigLevel(double ChiSquared0, long nu)
Computes the probability that a chi-squared variable exceeds a given value.
long simplexMin(double *yReturn, double *xGuess, double *dxGuess, double *xLowerLimit, double *xUpperLimit, short *disable, long dimensions, double target, double tolerance, double(*func)(double *x, long *invalid), void(*report)(double ymin, double *xmin, long pass, long evals, long dims), long maxEvaluations, long maxPasses, long maxDivisions, double divisorFactor, double passRangeFactor, unsigned long flags)
Top-level convenience function for simplex-based minimization.