Index: unk/psLib/src/astronomy/.cvsignore =================================================================== --- /trunk/psLib/src/astronomy/.cvsignore (revision 4545) +++ (revision ) @@ -1,7 +1,0 @@ -Makefile.in -.deps -.libs -Makefile -*.lo -*.la - Index: unk/psLib/src/astronomy/Makefile.am =================================================================== --- /trunk/psLib/src/astronomy/Makefile.am (revision 4545) +++ (revision ) @@ -1,32 +1,0 @@ -#Makefile for astronomy functions of psLib -# -AM_CFLAGS=$(CFLAGS) -DPS_CONFIG_FILE_DEFAULT=\"$(sysconfdir)/pslib/psTime.config\" - -INCLUDES = \ - -I$(top_srcdir)/src/collections \ - -I$(top_srcdir)/src/dataManip \ - -I$(top_srcdir)/src/dataIO \ - -I$(top_srcdir)/src/image \ - -I$(top_srcdir)/src/sysUtils \ - $(all_includes) - -noinst_LTLIBRARIES = libpslibastronomy.la -libpslibastronomy_la_SOURCES = \ - psTime.c \ - psCoord.c \ - psAstrometry.c - -BUILT_SOURCES = psAstronomyErrors.h - -EXTRA_DIST = psAstronomyErrors.dat psAstronomyErrors.h astronomy.i - -psAstronomyErrors.h: psAstronomyErrors.dat - $(top_srcdir)/src/psParseErrorCodes --data=$? $@ - -pslibincludedir = $(includedir) -pslibinclude_HEADERS = \ - psTime.h \ - psCoord.h \ - psAstrometry.h \ - psPhotometry.h - Index: unk/psLib/src/astronomy/astronomy.i =================================================================== --- /trunk/psLib/src/astronomy/astronomy.i (revision 4545) +++ (revision ) @@ -1,23 +1,0 @@ -/* astronomy headers */ -%include "psAstrometry.h" -%include "psAstronomyErrors.h" -%include "psCoord.h" - -%include "psMetadata.h" -%extend psMetadataItem { - const char *get_STR(void) { - if (self->type != PS_META_STR) { - return NULL; - } else { - return self->data.V; - } - } -} - -%apply unsigned int *OUTPUT { unsigned int *nFail }; /* for psMetadataParseConfig */ -%include "psMetadataIO.h" -%clear psU32 *nFail; - -%include "psPhotometry.h" -%include "psTime.h" - Index: unk/psLib/src/astronomy/psAstrometry.c =================================================================== --- /trunk/psLib/src/astronomy/psAstrometry.c (revision 4545) +++ (revision ) @@ -1,826 +1,0 @@ -/** @file psAstrometry.c - * - * @brief This file defines the basic types for astronomical coordinate - * transformation - * - * @ingroup AstroImage - * - * @author GLG, MHPCC - * - * @version $Revision: 1.70 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-25 02:02:04 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -/******************************************************************************/ -/* INCLUDE FILES */ -/******************************************************************************/ -#include -#include - -#include "psFunctions.h" -#include "psAstrometry.h" -#include "psMemory.h" -#include "psError.h" -#include "psConstants.h" -#include "psAstronomyErrors.h" -#include "psMatrix.h" -#include "psTrace.h" -#include "psLogMsg.h" - -/***************************************************************************** -checkValidImageCoords(): this is a private function which simply -determines if the supplied x,y coordinates are in the range for the supplied -psImage. - *****************************************************************************/ -static psS32 checkValidImageCoords(double x, - double y, - psImage* tmpImage) -{ - PS_ASSERT_IMAGE_NON_NULL(tmpImage, 0); - - if ((x < 0.0) || (x > (double)tmpImage->numCols) || - (y < 0.0) || (y > (double)tmpImage->numRows)) { - return (0); - } - - return (1); -} - - -static void FPAFree(psFPA* fpa) -{ - if (fpa != NULL) { - psFree(fpa->chips); - psFree(fpa->grommit); - psFree(fpa->exposure); - psFree(fpa->metadata); - psFree(fpa->fromTangentPlane); - psFree(fpa->toTangentPlane); - psFree(fpa->pattern); - psFree(fpa->colorPlus); - psFree(fpa->colorMinus); - psFree(fpa->projection); - } -} - -static void chipFree(psChip* chip) -{ - if (chip != NULL) { - psFree(chip->cells); - psFree(chip->metadata); - psFree(chip->toFPA); - psFree(chip->fromFPA); - } -} - -static void cellFree(psCell* cell) -{ - if (cell != NULL) { - psFree(cell->readouts); - psFree(cell->metadata); - psFree(cell->toChip); - psFree(cell->fromChip); - psFree(cell->toFPA); - psFree(cell->toTP); - psFree(cell->toSky); - } -} - -static void readoutFree(psReadout* readout) -{ - if (readout != NULL) { - psFree(readout->image); - psFree(readout->mask); - psFree(readout->objects); - psFree(readout->metadata); - } -} - -static void observatoryFree(psObservatory* obs) -{ - if (obs != NULL) { - psFree(obs->name); - } -} - -static void exposureFree(psExposure* exp) -{ - if (exp != NULL) { - psFree(exp->time); - psFree(exp->observatory); - psFree(exp->cameraName); - psFree(exp->telescopeName); - } -} - -static void fixedPatternFree(psFixedPattern* fp) -{ - if (fp != NULL) { - for (psS32 i = 0; i < fp->p_ps_xRows; i++) { - psFree(fp->x[i]); - } - - for (psS32 j = 0; j < fp->p_ps_yRows; j++) { - psFree(fp->y[j]); - } - - psFree(fp->x); - psFree(fp->y); - } -} - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - PUBLIC */ -/*****************************************************************************/ - -/* - * XXX: Verify that you interpreted the SDR correctly. - * - * XXX: This assumes that x,y must be of type F64 - */ -psFixedPattern* psFixedPatternAlloc(double x0, - double y0, - double xScale, - double yScale, - const psImage *x, - const psImage *y) -{ - psFixedPattern *tmp; - psS32 i; - psS32 j; - - PS_ASSERT_IMAGE_NON_NULL(x, NULL); - PS_ASSERT_IMAGE_NON_NULL(y, NULL); - PS_ASSERT_IMAGE_TYPE(x, PS_TYPE_F64, NULL); - PS_ASSERT_IMAGE_TYPE(y, PS_TYPE_F64, NULL); - - tmp = (psFixedPattern *) psAlloc(sizeof(psFixedPattern)); - // XXX: Is this correct? - tmp->nX = (x->numCols * x->numRows); - tmp->nY = (y->numCols * y->numRows); - tmp->x0 = x0; - tmp->y0 = y0; - tmp->xScale = xScale; - tmp->yScale = yScale; - tmp->p_ps_xRows = x->numRows; - tmp->p_ps_xCols = x->numCols; - tmp->p_ps_yRows = y->numRows; - tmp->p_ps_yCols = y->numCols; - tmp->x = (double **) psAlloc(x->numRows * sizeof(double *)); - for (i=0;inumRows;i++) { - (tmp->x)[i] = (double *) psAlloc(x->numCols * sizeof(double)); - } - for (i=0;inumRows;i++) { - for (j=0;jnumCols;j++) { - (tmp->x)[i][j] = x->data.F64[i][j]; - } - } - - tmp->y = (double **) psAlloc(y->numRows * sizeof(double *)); - for (i=0;inumRows;i++) { - (tmp->y)[i] = (double *) psAlloc(y->numCols * sizeof(double)); - } - for (i=0;inumRows;i++) { - for (j=0;jnumCols;j++) { - (tmp->y)[i][j] = y->data.F64[i][j]; - } - } - - psMemSetDeallocator(tmp,(psFreeFunc)fixedPatternFree); - - return(tmp); -} - - -psExposure* psExposureAlloc(double ra, - double dec, - double hourAngle, - double zenithDistance, - double azimuth, - const psTime* time, - float rotAngle, - float temperature, - float pressure, - float humidity, - float exposureTime, - float wavelength, - const psObservatory* observatory) -{ - PS_ASSERT_PTR_NON_NULL(observatory, NULL); - - psExposure* exp = psAlloc(sizeof(psExposure)); - *(double *)&exp->ra = ra; - *(double *)&exp->dec = dec; - *(double *)&exp->hourAngle = hourAngle; - *(double *)&exp->zenithDistance = zenithDistance; - *(double *)&exp->azimuth = azimuth; - *(float *)&exp->rotAngle = rotAngle; - *(float *)&exp->temperature = temperature; - *(float *)&exp->pressure = pressure; - *(float *)&exp->humidity = humidity; - *(float *)&exp->exposureTime = exposureTime; - *(float *)&exp->wavelength = wavelength; - - exp->time = psMemIncrRefCounter((psPtr)time); - exp->observatory = psMemIncrRefCounter((psPtr)observatory); - - // XXX: how is this value derived? - *(double *)&exp->lst = psTimeToLMST((psTime*)time,observatory->longitude); - *(float *)&exp->positionAngle = 0.0f; // XXX: need input, see Bug #207 - *(float *)&exp->parallacticAngle = 0.0f; // XXX: need input, see Bug #207 - *(float *)&exp->airmass = 0.0f; // XXX: needs calculation! = slaAirmas(zenithDistance); - *(float *)&exp->parallacticFactor = 0.0f; - exp->cameraName = NULL; - exp->telescopeName = NULL; - - psMemSetDeallocator(exp,(psFreeFunc)exposureFree); - - return exp; -} - -psObservatory* psObservatoryAlloc(const char* name, - double latitude, - double longitude, - double height, - double tlr) -{ - psObservatory* obs = psAlloc(sizeof(psObservatory)); - - if (name == NULL) { - obs->name = NULL; - } else { - obs->name = psAlloc(strlen(name)+1); - strcpy((char*)obs->name, name); - } - - *(double *)&obs->latitude = latitude; - *(double *)&obs->longitude = longitude; - *(double *)&obs->height = height; - *(double *)&obs->tlr = tlr; - - psMemSetDeallocator(obs,(psFreeFunc)observatoryFree); - - return obs; -} - -psFPA* psFPAAlloc(psS32 nChips, - const psExposure* exp) -{ - PS_ASSERT_INT_NONNEGATIVE(nChips, NULL); - - psFPA* newFPA = psAlloc(sizeof(psFPA)); - - // create array of NULL chips of the size nChips - newFPA->chips = psArrayAlloc(nChips); - psPtr* chips = newFPA->chips->data; - for (psS32 i=0;ichips->n = 0; // per requirement - - newFPA->metadata = NULL; - newFPA->fromTangentPlane = NULL; - newFPA->toTangentPlane = NULL; - newFPA->pattern = NULL; - - if (exp != NULL) { - newFPA->exposure = psMemIncrRefCounter((psExposure*)exp); - newFPA->grommit = psGrommitAlloc(exp); - } else { - newFPA->exposure = NULL; - newFPA->grommit = NULL; - } - - newFPA->colorPlus = NULL; - newFPA->colorMinus = NULL; - newFPA->projection = NULL; - - newFPA->rmsX = 0.0f; - newFPA->rmsY = 0.0f; - newFPA->chi2 = 0.0f; - - psMemSetDeallocator(newFPA,(psFreeFunc)FPAFree); - - return newFPA; -} - -/* - * psChip constructor - */ -psChip* psChipAlloc(psS32 nCells, - psFPA *parentFPA) -{ - PS_ASSERT_INT_NONNEGATIVE(nCells, NULL); - - psChip* chip = psAlloc(sizeof(psChip)); - - // create array of NULL psCells - int n = (nCells > 0) ? nCells : 1; - chip->cells = psArrayAlloc(n); - psPtr* cells = chip->cells->data; - for (psS32 i=0;icells->n = 0; // per requirement - - *(int*)&chip->row0 = 0; - *(int*)&chip->col0 = 0; - - chip->metadata = NULL; - - chip->toFPA = NULL; - chip->fromFPA = NULL; - - chip->parent = parentFPA; - - psMemSetDeallocator(chip,(psFreeFunc)chipFree); - - return chip; - -} - -/* - * psCell constructor - */ -psCell* psCellAlloc(psS32 nReadouts, - psChip* parentChip) -{ - PS_ASSERT_INT_NONNEGATIVE(nReadouts, NULL); - - psCell* cell = psAlloc(sizeof(psCell)); - - // create array of NULL psReadouts - int n = (nReadouts > 0) ? nReadouts : 1; - cell->readouts = psArrayAlloc(n); - psPtr* readouts = cell->readouts->data; - for (psS32 i=0;ireadouts->n = 0; // per requirement - - *(int*)&cell->row0 = 0; - *(int*)&cell->col0 = 0; - - cell->metadata = NULL; - - cell->toChip = NULL; - cell->fromChip = NULL; - cell->toFPA = NULL; - cell->toTP = NULL; - cell->toSky = NULL; - - cell->parent = parentChip; - - psMemSetDeallocator(cell,(psFreeFunc)cellFree); - - return cell; - - -} - -psReadout* psReadoutAlloc() -{ - psReadout* readout = psAlloc(sizeof(psReadout)); - - *(psU32*)&readout->colBins = 1; - *(psU32*)&readout->rowBins = 1; - *(psU32*)&readout->rowParity = 0; - *(psU32*)&readout->colParity = 0; - *(psS32*)&readout->col0 = 0; - *(psS32*)&readout->row0 = 0; - - readout->image = NULL; - readout->mask = NULL; - readout->objects = NULL; - readout->metadata = NULL; - - psMemSetDeallocator(readout,(psFreeFunc)readoutFree); - - return readout; -} - -psGrommit* psGrommitAlloc(const psExposure* exp) -{ - PS_ASSERT_PTR_NON_NULL(exp, NULL); - - psSphere* polarMotion = p_psTimeGetPoleCoords(exp->time); - - psGrommit* grommit = (psGrommit* ) psAlloc(sizeof(psGrommit)); - - *(double*)&grommit->latitude = exp->observatory->latitude; - *(double*)&grommit->longitude = exp->observatory->longitude; - *(double*)&grommit->height = exp->observatory->height; - *(double*)&grommit->abberationMag = 0.0; // XXX: need to figure out what to set here. - *(double*)&grommit->temperature = exp->temperature; - *(double*)&grommit->pressure = exp->pressure; - *(double*)&grommit->humidity = exp->humidity; - *(double*)&grommit->wavelength = exp->wavelength; - *(double*)&grommit->lapseRate = exp->observatory->tlr; - *(double*)&grommit->refractA = polarMotion->r; // XXX: need to figure out what to set here too. - *(double*)&grommit->refractB = polarMotion->d; // XXX: need to figure out what to set here too. - *(double*)&grommit->siderealTime = psTimeToMJD(exp->time); // XXX: this is probably not correct - - psFree(polarMotion); - - return (grommit); -} - -psCell* psCellInFPA(const psPlane* fpaCoord, - const psFPA* FPA) -{ - PS_ASSERT_PTR_NON_NULL(fpaCoord, NULL); - PS_ASSERT_PTR_NON_NULL(FPA, NULL); - - psChip* tmpChip = NULL; - psPlane chipCoord; - psCell* outCell = NULL; - - // Determine which chip contains the fpaCoords. - tmpChip = psChipInFPA(fpaCoord, FPA); - if (tmpChip == NULL) { - return(NULL); - } - - // Convert to those chip coordinates. - psCoordFPAToChip(&chipCoord, fpaCoord, tmpChip); - - // Determine which cell contains those chip coordinates. - outCell = psCellInChip(&chipCoord, tmpChip); - - return (outCell); -} - -psChip* psChipInFPA(const psPlane* fpaCoord, - const psFPA* FPA) -{ - PS_ASSERT_PTR_NON_NULL(fpaCoord, NULL); - PS_ASSERT_PTR_NON_NULL(FPA, NULL); - PS_ASSERT_PTR_NON_NULL(FPA->chips, NULL); - - psArray* chips = FPA->chips; - psS32 nChips = chips->n; - psPlane chipCoord; - psCell *tmpCell = NULL; - - // Loop through every chip in this FPA. Convert the original FPA - // coordinates to chip coordinates for that chip. Then, determine if any - // cells in that chip contain those chip coordinates. - - for (psS32 i = 0; i < nChips; i++) { - psChip* tmpChip = chips->data[i]; - PS_ASSERT_PTR_NON_NULL(tmpChip, NULL); - PS_ASSERT_PTR_NON_NULL(tmpChip->fromFPA, NULL); - - psPlaneTransformApply(&chipCoord, tmpChip->fromFPA, fpaCoord); - - tmpCell = psCellInChip(&chipCoord, tmpChip); - if (tmpCell != NULL) { - return(tmpChip); - } - } - - // XXX: Print warning here? - return (NULL); -} - -psCell* psCellInChip(const psPlane* chipCoord, - const psChip* chip) -{ - PS_ASSERT_PTR_NON_NULL(chipCoord, NULL); - PS_ASSERT_PTR_NON_NULL(chip, NULL); - - psPlane cellCoord; - psArray* cells; - - cells = chip->cells; - if (cells == NULL) { - return NULL; - } - - // We loop over each cell in the chip. We transform the chipCoord into - // a cellCoord for that cell and determine if that cellCoord is valid. - // If so, then we return that cell. - - for (psS32 i = 0; i < cells->n; i++) { - psCell* tmpCell = (psCell* ) cells->data[i]; - PS_ASSERT_PTR_NON_NULL(tmpCell, NULL); - PS_ASSERT_PTR_NON_NULL(tmpCell->fromChip, NULL); - psArray* readouts = tmpCell->readouts; - - if (readouts != NULL) { - for (psS32 j = 0; j < readouts->n; j++) { - psReadout* tmpReadout = readouts->data[j]; - PS_ASSERT_READOUT_NON_NULL(tmpReadout, NULL); - - psPlaneTransformApply(&cellCoord, - tmpCell->fromChip, - chipCoord); - - if (checkValidImageCoords(cellCoord.x, - cellCoord.y, - tmpReadout->image)) { - return (tmpCell); - } - } - } - } - - return (NULL); -} - -psPlane* psCoordCellToChip(psPlane* outCoord, - const psPlane* inCoord, - const psCell* cell) -{ - PS_ASSERT_PTR_NON_NULL(inCoord, NULL); - PS_ASSERT_PTR_NON_NULL(cell, NULL); - - return (psPlaneTransformApply(outCoord, cell->toChip, inCoord)); -} - -psPlane* psCoordChipToFPA(psPlane* outCoord, - const psPlane* inCoord, - const psChip* chip) -{ - PS_ASSERT_PTR_NON_NULL(inCoord, NULL); - PS_ASSERT_PTR_NON_NULL(chip, NULL); - - return (psPlaneTransformApply(outCoord, chip->toFPA, inCoord)); -} - -psPlane* psCoordFPAToTP(psPlane* outCoord, - const psPlane* inCoord, - double color, - double magnitude, - const psFPA* fpa) -{ - PS_ASSERT_PTR_NON_NULL(inCoord, NULL); - PS_ASSERT_PTR_NON_NULL(fpa, NULL); - - return(psPlaneDistortApply(outCoord, fpa->toTangentPlane, inCoord, - color, magnitude)); -} - -/***************************************************************************** -XXX: What about units for the (x,y) coords? - *****************************************************************************/ -psSphere* psCoordTPToSky(psSphere* outSphere, - const psPlane* tpCoord, - const psGrommit* grommit) -{ - PS_ASSERT_PTR_NON_NULL(tpCoord, NULL); - PS_ASSERT_PTR_NON_NULL(grommit, NULL); - - if (outSphere == NULL) { - outSphere = (psSphere* ) psAlloc(sizeof(psSphere)); - } - - // XXX: this was done by a SLALIB call -- needs to be reimplemented - psWarning("Warning! psCoordTPToSky functionality is no longer implemented"); - /* slaAopqk(tpCoord->x, tpCoord->y, (double*)grommit, - &AOB, &ZOB, &HOB, &outSphere->r, &outSphere->d); */ - - return (outSphere); -} - -psPlane* psCoordCellToFPA(psPlane* fpaCoord, - const psPlane* cellCoord, - const psCell* cell) -{ - PS_ASSERT_PTR_NON_NULL(cellCoord, NULL); - PS_ASSERT_PTR_NON_NULL(cell, NULL); - - return (psPlaneTransformApply(fpaCoord, cell->toFPA, cellCoord)); -} - -psSphere* psCoordCellToSky(psSphere* skyCoord, - const psPlane* cellCoord, - double color, - double magnitude, - const psCell* cell) -{ - PS_ASSERT_PTR_NON_NULL(cellCoord, NULL); - PS_ASSERT_PTR_NON_NULL(cell, NULL); - PS_ASSERT_PTR_NON_NULL(cell->toFPA, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent->parent, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent->parent->toTangentPlane, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent->parent->exposure, NULL); - - psPlane* fpaCoord = NULL; - psPlane* tpCoord = NULL; - psFPA* parFPA = (cell->parent)->parent; - psGrommit* tmpGrommit = NULL; - - // Convert the input cell coordinates to FPA coordinates. - fpaCoord = psPlaneTransformApply(fpaCoord, cell->toFPA, cellCoord); - - // Convert the FPA coordinates to tangent plane Coordinates. - tpCoord = psPlaneDistortApply(tpCoord, parFPA->toTangentPlane, - fpaCoord, color, magnitude); - - // Generate a grommit for this FPA. - tmpGrommit = psGrommitAlloc(parFPA->exposure); - - // Convert the tangent plane Coordinates to sky coordinates. - skyCoord = psCoordTPToSky(skyCoord, tpCoord, tmpGrommit); - - psFree(fpaCoord); - psFree(tpCoord); - psFree(tmpGrommit); - - return(skyCoord); -} - -psSphere* psCoordCellToSkyQuick(psSphere* outSphere, - const psPlane* cellCoord, - const psCell* cell) -{ - PS_ASSERT_PTR_NON_NULL(cellCoord, NULL); - PS_ASSERT_PTR_NON_NULL(cell, NULL); - PS_ASSERT_PTR_NON_NULL(cell->toSky, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent->parent, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent->parent->projection, NULL); - if (cell->toSky) { - // XXX: Should we use toTP or toSky? - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: psCoordCellToSkyQuick(): The cell->toSky transform is ignored. The cell->toTP transform is being used."); - } - - psPlane *tpCoord = NULL; - psChip *chip = cell->parent; - psFPA *FPA = chip->parent; - psProjectionType oldProjectionType; - - if (outSphere == NULL) { - outSphere = (psSphere* ) psAlloc(sizeof(psSphere)); - } - - // Determine the tangent plane coordinates. - tpCoord = psPlaneTransformApply(NULL, cell->toTP, cellCoord); - - // Save the old projection type and set the new projection type to TAN. - oldProjectionType = FPA->projection->type; - FPA->projection->type = PS_PROJ_TAN; - - // Deproject the tangent plane coordinates a sphere. - outSphere = psDeproject(tpCoord, FPA->projection); - - // Restore old projection type. Free memory. - FPA->projection->type = oldProjectionType; - psFree(tpCoord); - - return (outSphere); -} - -/***************************************************************************** -XXX: What about units for the (x,y) coords? - *****************************************************************************/ -psPlane* psCoordSkyToTP(psPlane* tpCoord, - const psSphere* in, - const psGrommit* grommit) -{ - PS_ASSERT_PTR_NON_NULL(in, NULL); - PS_ASSERT_PTR_NON_NULL(grommit, NULL); - - // char* type = "RA"; - - if (tpCoord == NULL) { - tpCoord = (psPlane* ) psAlloc(sizeof(psPlane)); - } - - // XXX: this was done by a SLALIB call -- needs to be reimplemented - psWarning("Warning! psCoordSkyToTP functionality is no longer implemented"); - /* slaOapqk(type, in->r, in->d, (double*)grommit, &tpCoord->x, &tpCoord->y); */ - - return(tpCoord); -} - - -psPlane* psCoordTPToFPA(psPlane* fpaCoord, - const psPlane* tpCoord, - double color, - double magnitude, - const psFPA* fpa) -{ - PS_ASSERT_PTR_NON_NULL(tpCoord, NULL); - PS_ASSERT_PTR_NON_NULL(fpa, NULL); - PS_ASSERT_PTR_NON_NULL(fpa->fromTangentPlane, NULL); - - return (psPlaneDistortApply(fpaCoord, fpa->fromTangentPlane, - tpCoord, color, magnitude)); -} - -psPlane* psCoordFPAToChip(psPlane* chipCoord, - const psPlane* fpaCoord, - const psChip* chip) -{ - PS_ASSERT_PTR_NON_NULL(fpaCoord, NULL); - PS_ASSERT_PTR_NON_NULL(chip, NULL); - PS_ASSERT_PTR_NON_NULL(chip->fromFPA, NULL); - - chipCoord = psPlaneTransformApply(chipCoord, chip->fromFPA, fpaCoord); - return(chipCoord); -} - -psPlane* psCoordChipToCell(psPlane* cellCoord, - const psPlane* chipCoord, - const psCell* cell) -{ - PS_ASSERT_PTR_NON_NULL(chipCoord, NULL); - PS_ASSERT_PTR_NON_NULL(cell, NULL); - PS_ASSERT_PTR_NON_NULL(cell->fromChip, NULL); - - cellCoord = psPlaneTransformApply(cellCoord, cell->fromChip, chipCoord); - return(cellCoord); -} - -psPlane* psCoordSkyToCell(psPlane* cellCoord, - const psSphere* skyCoord, - double color, - double magnitude, - const psCell* cell) -{ - PS_ASSERT_PTR_NON_NULL(skyCoord, NULL); - PS_ASSERT_PTR_NON_NULL(cell, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent->parent, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent->parent->grommit, NULL); - - psChip *parChip = cell->parent; - psFPA *parFPA = parChip->parent; - psGrommit* grommit = parFPA->grommit; - - // Convert the skyCoords to tangent plane coords. - psPlane *tpCoord = psCoordSkyToTP(tpCoord, skyCoord, grommit); - - // Convert the tangent plane coords to FPA coords. - psPlane *fpaCoord = psCoordTPToFPA(fpaCoord, tpCoord, color, - magnitude, parFPA); - - // Convert the FPA coords to chip coords. - psPlane *chipCoord = psCoordFPAToChip(chipCoord, fpaCoord, parChip); - - // Convert the chip coords to cell coords. - cellCoord = psCoordChipToCell(cellCoord, chipCoord, cell); - - psFree(tpCoord); - psFree(fpaCoord); - psFree(chipCoord); - - return (cellCoord); -} - -psPlane* psCoordSkyToCellQuick(psPlane* cellCoord, - const psSphere* skyCoord, - const psCell* cell) -{ - PS_ASSERT_PTR_NON_NULL(skyCoord, NULL); - PS_ASSERT_PTR_NON_NULL(cell, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent->parent, NULL); - PS_ASSERT_PTR_NON_NULL(cell->parent->parent->projection, NULL); - PS_ASSERT_PTR_NON_NULL(cell->toTP, NULL); - if (cell->toSky) { - // XXX: Should we use toTP or toSky? - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: psCoordSkyToCellQuick(): The cell->toSky transform is ignored. The cell->toTP transform is being used."); - } - - psPlane *tpCoord = NULL; - psChip *whichChip = cell->parent; - psFPA *whichFPA = whichChip->parent; - psProjectionType oldProjectionType; - psPlaneTransform *TPtoCell = NULL; - - // Save the old projection type and set the new projection type to TAN. - oldProjectionType = whichFPA->projection->type; - whichFPA->projection->type = PS_PROJ_TAN; - - if (cellCoord == NULL) { - cellCoord = (psPlane* ) psAlloc(sizeof(psPlane)); - } - - tpCoord = psProject(skyCoord, whichFPA->projection); - - // generate an error if cell->toTP is not linear. - if (0 == p_psIsProjectionLinear(cell->toTP)) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psAstrometry_NONLINEAR_TRANSFORM, - "cell to tangent plane"); - } - - TPtoCell = p_psPlaneTransformLinearInvert(cell->toTP); - cellCoord = psPlaneTransformApply(cellCoord, TPtoCell, tpCoord); - - // Restore old projection type. Free memory. - whichFPA->projection->type = oldProjectionType; - psFree(tpCoord); - return (cellCoord); -} - - - Index: unk/psLib/src/astronomy/psAstrometry.h =================================================================== --- /trunk/psLib/src/astronomy/psAstrometry.h (revision 4545) +++ (revision ) @@ -1,534 +1,0 @@ -/** @file psAstrometry.h -* -* @brief This file defines the basic types for astronomical coordinate -* transformation -* -* @ingroup AstroImage -* -* @author GLG, MHPCC -* -* @version $Revision: 1.41 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#ifndef PS_ASTROMETRY_H -#define PS_ASTROMETRY_H - -#include "psType.h" -#include "psImage.h" -#include "psArray.h" -#include "psList.h" -#include "psFunctions.h" -#include "psMetadata.h" -#include "psCoord.h" -#include "psPhotometry.h" - -struct psCell; -struct psChip; -struct psFPA; -struct psExposure; - -/// @addtogroup AstroImage -/// @{ - -/** Wallace's Grommit - * - * SLALib requires several elements to perform the transformations between - * the tangent plane and the sky. Pre-computing these quantities for each - * exposure means that subsequent transformations are faster. For historical - * reasons, this structure is known colloquially as "Wallace's Grommit". - * - */ -typedef struct -{ - const double latitude; ///< geodetic latitude (radians) - const double longitude; ///< longitude + ... (radians) - const double height; ///< height (HM) - const double abberationMag; ///< magnitude of diurnal aberration vector - const double temperature; ///< ambient temperature (TDK) - const double pressure; ///< pressure (PMB) - const double humidity; ///< relative humidity (RH) - const double wavelength; ///< wavelength (WL) - const double lapseRate; ///< lapse rate (TLR) - const double refractA, refractB; ///< refraction constants A and B (radians) - const double siderealTime; ///< local apparent sidereal time (radians) -} -psGrommit; - -/** Fixed Pattern Corrections - * - * The fixed pattern is a correction to the general astrometric solution - * formed by summing the residuals from many observations. The intent is to - * correct for higher-order distortions in the camera system on a coarse - * grid (larger than individual pixels, but smaller than a single cell). - * Hence, in addition to the offsets, we need to specify the size and scale - * of the grid in x and y as well as the origin of the grid. - */ -typedef struct -{ - psS32 nX; ///< Number of elements in x direction - psS32 nY; ///< Number of elements in y direction - double x0; ///< X Position of 0,0 corner on focal plane - double y0; ///< Y Position of 0,0 corner on focal plane - double xScale; ///< Scale of the grid in x direction - double yScale; ///< Scale of the grid in x direction - /// XXX: I added the following memvers to facilitate the psFreeing of the x,y data structures. - psS32 p_ps_xRows; ///< Number of rows in the x member - psS32 p_ps_xCols; ///< Number of cols in the x member - psS32 p_ps_yRows; ///< Number of rows in the y member - psS32 p_ps_yCols; ///< Number of cols in the y member - double **x; ///< The grid of offsets in x - double **y; ///< The grid of offsets in y -} -psFixedPattern; - -/** Readout data structure. - * - * A readout is the result of a single read of a cell (or a portion thereof). - * It contains a pointer to the pixel data, and additional pointers to the - * objects found in the readout, and the readout metadata. It also contains - * the offset from the lower-left corner of the chip, in the case that the - * CCD was windowed. - * - */ -typedef struct -{ - const psS32 col0; ///< Offset from the left of chip. - const psS32 row0; ///< Offset from the bottom of chip. - - const int colParity; ///< Column Readout Direction - const int rowParity; ///< Row Readout Direction - - const psU32 colBins; ///< Amount of binning in x-dimension - const psU32 rowBins; ///< Amount of binning in y-dimension - - psImage* image; ///< Imaging area of readout - psImage* mask; ///< Mask area for readout - psList* objects; ///< Objects derived from Readout - psMetadata* metadata; ///< Readout-level metadata -} -psReadout; - -/** Cell data structure - * - * A cell consists of one or more readouts. It also contains a pointer to the - * cell's metadata, and its parent chip. On the astrometry side, it also - * contains coordinate transforms from the cell to chip, from the cell to - * focal-plane, as well as a "quick and dirty" tranform from the cell to - * sky coordinates. - * - */ -typedef struct -{ - const psS32 col0; ///< Offset from the left of chip - const psS32 row0; ///< Offset from the bottom of chip - - psArray* readouts; ///< readouts from the cell - - psMetadata* metadata; ///< cell-level metadata - - psPlaneTransform* toChip; ///< transformations from cell to chip coordinates - psPlaneTransform* fromChip; ///< transformations from cell to chip coordinates - psPlaneTransform* toFPA; ///< transformations from cell to FPA coordinates - psPlaneTransform* toTP; ///< transformations from cell to FPA coordinates - psPlaneTransform* toSky; ///< transformations from cell to tangent plane coordinates - - struct psChip* parent; ///< chip in which contains this cell -} -psCell; - -/** Chip data structure - * - * A chip consists of one or more cells (according to the number of amplifiers - * on the CCD). It contains a pointer to the chip's metadata, and a pointer - * to the parent focal plane. For astrometry, it contains a coordinate - * transform from the chip to the focal plane, and vis-versa. - * - */ -typedef struct psChip -{ - const psS32 col0; ///< Offset from the left of FPA - const psS32 row0; ///< Offset from the bottom of FPA - - psArray* cells; ///< cells in the chip - - psMetadata* metadata; ///< chip-level metadata - - psPlaneTransform* toFPA; ///< transformation from chip to FPA coordinates - psPlaneTransform* fromFPA; ///< transformation from FPA to chip coordinates - - struct psFPA* parent; ///< FPA which contains this chip -} -psChip; - -/** A Focal-Plane - * - * A focal plane consists of one or more chips (according to the number of - * contiguous silicon). It contains pointers to the focal-plane's metadata - * and the exposure information. For astrometry, it contains a transformation - * from the focal plane to the tangent plane and the fixed pattern residuals. - * Since colors are involved in the transformation, it is necessary to specify - * the color the transformation is defined. We also include some values to - * characterize the quality of the transformation: the root square deviation - * for the x and y transformation fits, and the chi-squared for the - * transformation fit. - * - */ -typedef struct psFPA -{ - psArray* chips; ///< chips in the focal plane array - psMetadata* metadata; ///< focal-plane's metadata - - psPlaneDistort* fromTangentPlane; ///< transformation from tangent plane to focal plane - psPlaneDistort* toTangentPlane; ///< transformation from focal plane to tangent plane - psFixedPattern* pattern; ///< fixed pattern residual offsets - - const struct psExposure* exposure; ///< information about this exposure - psGrommit *grommit; ///< Wallace's grommit - - psPhotSystem* colorPlus; ///< Color reference - psPhotSystem* colorMinus; ///< Color reference - psProjection *projection; ///< projection - - float rmsX; ///< RMS for x transformation fits - float rmsY; ///< RMS for y transformation fits - float chi2; ///< chi^2 of astrometric solution -} -psFPA; - -/** Observatory Information - * - * A container for the observatory data that doesn't change per exposure. - * - */ -typedef struct -{ - const char* name; ///< Name of observatory - const double latitude; ///< Latitude of observatory, east positive (degrees?) - const double longitude; ///< Longitude of observatory (degrees?) - const double height; ///< Height of observatory in meters - const double tlr; ///< Tropospheric Lapse Rate -} -psObservatory; - -/** Exposure Information - * - * Several quantities from the telescope in order to make a first guess at - * the astrometric solution. From these quantities, further quantities can - * be derivedand stored for later use. - * - */ -typedef struct psExposure -{ - const double ra; ///< Telescope boresight, right ascention - const double dec; ///< Telescope boresight, declination - const double hourAngle; ///< Hour angle - const double zenithDistance; ///< Zenith distance - const double azimuth; ///< Azimuth - const psTime* time; ///< Time of observation - const float rotAngle; ///< Rotator position angle in degrees? XXX: see bug#209 - const float temperature; ///< Air temperature in Kelvin - const float pressure; ///< Air pressure in mB - const float humidity; ///< Relative humidity, for refraction - const float exposureTime; ///< Exposure time - const float wavelength; ///< Wavelength in microns - const psObservatory* observatory; ///< Observatory data - - /* Derived quantities */ - const double lst; ///< Local Sidereal Time - const float positionAngle; ///< Position angle - const float parallacticAngle; ///< Parallactic angle - const float airmass; ///< Airmass, calculated from zenith distance - const float parallacticFactor; ///< Parallactic factor - const char* cameraName; ///< name of camera which provided exposure - const char* telescopeName; ///< name of telescope which provided exposure -} -psExposure; - -/** Allocator for psFixedPattern struct - * - * Allocates a new psFixedPattern struct with the attributes coorsponding - * to the parameters set to the said input values. - * - * @return psFixedPattern* New psFixedPattern struct. - */ -psFixedPattern* psFixedPatternAlloc( - double x0, ///< X Position of 0,0 corner on focal plane - double y0, ///< Y Position of 0,0 corner on focal plane - double xScale, ///< Scale of the grid in x direction - double yScale, ///< Scale of the grid in x direction - const psImage *x, ///< The grid of offsets in x - const psImage *y ///< The grid of offsets in y -); - - -/** Allocator for psExposure - * - * We need several quantities from the telescope in order to make a first - * guess at the astrometric solution. From these quantities, further - * quantities can be derived and stored for later use. - * - * @return psExposure* New psExposure struct - */ -psExposure* psExposureAlloc( - double ra, ///< Telescope boresight, right ascention - double dec, ///< Telescope boresight, declination - double hourAngle, ///< Hour angle - double zenithDistance, ///< Zenith distance - double azimuth, ///< Azimuth - const psTime* time, ///< time of observation - float rotAngle, ///< Rotator position angle - float temperature, ///< Temperature - float pressure, ///< Pressure - float humidity, ///< Relative humidity - float exposureTime, ///< Exposure time - float wavelength, ///< wavelength - const psObservatory* observatory ///< Observatory data -); - -/** Allocator for psObservatory - * - * This function shall construct a new psObservatory with attributes - * cooresponding to the function parameters. - * - * @return psObservatory* new psObservatory struct - */ -psObservatory* psObservatoryAlloc( - const char* name, ///< Name of observatory - double latitude, ///< Latitude of observatory, east positive - double longitude, ///< Longitude of observatory - double height, ///< Height of observatory - double tlr ///< Tropospheric Lapse Rate -); - -/** Allocator for psFPA - * - * This function shall make an empty psFPA, with the nChips allocated - * pointers to psChips being set to NULL; all other pointers in the structure - * shall be initialized to NULL, apart from the grommit, which shall be - * constructed on the basis of the exp parameter. - * - * @return psFPA* a newly allocated psFPA - */ -psFPA* psFPAAlloc( - psS32 nChips, ///< number of chips in the FPA - const psExposure* exp ///< the exposure information -); - -/** Allocates a psChip - * - * This allocator shall make an empty psChip, with the nCells allocated - * pointers to psCells being set to NULL; all other pointers in the structure - * shall be initialized to NULL. - * - * @return psChip* newly allocated psChip - */ -psChip* psChipAlloc( - psS32 nCells, ///< number of cells in Chip - psFPA* parentFPA ///< parent FPA -); - -/** Allocates a psCell - * - * The constructor shall make an empty psCell, with the nReadouts allocated - * pointers to psReadouts being set to NULL; all other pointers in the - * structure shall be initialized to NULL. - * - * @return psCell* newly allocated psCell - */ -psCell* psCellAlloc( - psS32 nReadouts, ///< number of readouts in cell - psChip* parentChip ///< parent Chip -); - -/** Allocates a psReadout - * - * All pointers in the structure other than the image shall be initialized - * to NULL. - * - * @return psReadout* newly allocated psReadout with all internal pointers set to NULL - */ -psReadout* psReadoutAlloc(); - -/** Allocates a Wallace's Grommit structure. - * - * The psGrommit is calculated from telescope information for the particular - * exposure. - * - * @return psGrommit* New grommit structure. - */ -psGrommit* psGrommitAlloc( - const psExposure* exp ///< the cooresponding exposure structure. -); - -/** Find cooresponding cell for given FPA coordinate - * - * @return psCell* the cell cooresponding to the coord in FPA - */ -psCell* psCellInFPA( - const psPlane* coord, ///< the coordinate in FPA plane - const psFPA* FPA ///< the FPA to search for the cell -); - -/** Find cooresponding chip for given FPA coordinate - * - * @return psChip* the chip cooresponding to coord - */ -psChip* psChipInFPA( - const psPlane* coord, ///< the coordinate in FPA plane - const psFPA* FPA ///< the FPA to search for the cell -); - -/** Find cooresponding cell for given Chip coordinate - * - * @return psCell* the cell cooresponding to coord - */ -psCell* psCellInChip( - const psPlane* coord, ///< the coordinate in Chip plane - const psChip* chip ///< the chip to search for the cell -); - -/** Translate a cell coordinate into a chip coordinate - * - * @return psPlane* the resulting chip coordinate - */ -psPlane* psCoordCellToChip( - psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created - const psPlane* in, ///< the coordinate within Cell - const psCell* cell ///< the Cell in interest -); - -/** Translate a chip coordinate into a FPA coordinate - * - * @return psPlane* the resulting FPA coordinate - */ -psPlane* psCoordChipToFPA( - psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created - const psPlane* in, ///< the coordinate within Chip - const psChip* chip ///< the chip in interest -); - -/** Translate a FPA coordinate into a Tangent Plane coordinate - * - * @return psPlane* the resulting Tangent Plane coordinate - */ -psPlane* psCoordFPAToTP( - psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created - const psPlane* in, ///< the coordinate within FPA - double color, ///< Color of source - double magnitude, ///< Magnitude of source - const psFPA* fpa ///< the FPA in interest -); - -/** Translate a Tangent Plane coordinate into a Sky coordinate - * - * @return psSphere* the resulting Sky coordinate - */ -psSphere* psCoordTPToSky( - psSphere* out, ///< a sphere struct to recycle. If NULL, a new struct is created - const psPlane* in, ///< the coordinate within Tangent Plane - const psGrommit* grommit ///< the grommit of the tangent plane -); - -/** Translate a cell coordinate into a FPA coordinate - * - * @return psPlane* the resulting FPA coordinate - */ -psPlane* psCoordCellToFPA( - psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created - const psPlane* in, ///< the coordinate within cell - const psCell* cell ///< the cell in interest -); - -/** Translate a cell coordinate into a Sky coordinate - * - * @return psSphere* the resulting Sky coordinate - */ -psSphere* psCoordCellToSky( - psSphere* out, ///< a sphere struct to recycle. If NULL, a new struct is created - const psPlane* in, ///< the coordinate within cell - double color, ///< Color of source - double magnitude, ///< Magnitude of source - const psCell* cell ///< the cell in interest -); - -/** Translate a cell coordinate into a Sky coordinate using a 'quick and - * dirty' method - * - * @return psSphere* the resulting Sky coordinate - */ -psSphere* psCoordCellToSkyQuick( - psSphere* out, ///< a sphere struct to recycle. If NULL, a new struct is created - const psPlane* in, ///< the coordinate within cell - const psCell* cell ///< the cell in interest -); - -/** Translate a Sky coordinate into a Tangent Plane coordinate - * - * @return psPlane* the resulting Tangent Plane coordinate - */ -psPlane* psCoordSkyToTP( - psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created - const psSphere* in, ///< the sky coordinate - const psGrommit* grommit ///< the grommit -); - -/** Translate a Tangent Plane coordinate into a FPA coordinate - * - * @return psPlane* the resulting FPA coordinate - */ -psPlane* psCoordTPToFPA( - psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created - const psPlane* in, ///< the coordinate within tangent plane - double color, ///< Color of source - double magnitude, ///< Magnitude of source - const psFPA* fpa ///< the FPA of interest -); - -/** Translate a FPA coordinate into a chip coordinate - * - * @return psPlane* the resulting chip coordinate - */ -psPlane* psCoordFPAToChip( - psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created - const psPlane* in, ///< the FPA coordinate - const psChip* chip ///< the chip of interest -); - -/** Translate a chip coordinate into a cell coordinate - * - * @return psPlane* the resulting cell coordinate - */ -psPlane* psCoordChipToCell( - psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created - const psPlane* in, ///< the Chip coordinate - const psCell* cell ///< the cell of interest -); - -/** Translate a sky coordinate into a cell coordinate - * - * @return psPlane* the resulting cell coordinate - */ -psPlane* psCoordSkyToCell( - psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created - const psSphere* in, ///< the Sky coordinate - double color, ///< Color of source - double magnitude, ///< Magnitude of source - const psCell* cell ///< the cell of interest -); - -/** Translate a sky coordinate into a cell coordinate using a 'quick and - * dirty' method - * - * @return psPlane* the resulting cell coordinate - */ -psPlane* psCoordSkyToCellQuick( - psPlane* out, ///< a plane struct to recycle. If NULL, a new struct is created - const psSphere* in, ///< the Sky coordinate - const psCell* cell ///< the cell of interest -); - - -#endif // #ifndef PS_ASTROMETRY_H Index: unk/psLib/src/astronomy/psAstronomyErrors.dat =================================================================== --- /trunk/psLib/src/astronomy/psAstronomyErrors.dat (revision 4545) +++ (revision ) @@ -1,69 +1,0 @@ -# -# This file is used to generate psAstronomyErrors.h content -# -# Format is: -# ERRORNAME(one word) ERROR_TEXT -# -# N.B. in code, the ERRORNAME appears as PS_ERRORTEXT_ERRORNAME -#################################################################### -psTime_FILE_NOT_FOUND Failed to open file %s. -psTime_FILE_TOO_MANY_ROWS Too many rows found in file %s. Max number of rows allowed is %d. -psTime_TIME_POSTDATES_TABLE Specified psTime postdates (%g) the table of %s information. -psTime_TIME_PREDATES_TABLE Specified psTime predates (%g) the table of %s information. -psTime_TIME_POSTDATES_TABLES Specified psTime postdates (%g) all tables of %s information. -psTime_TIME_PREDATES_TABLES Specified psTime predates (%g) all tables of %s information. -psTime_TABLE_DUPLICATE_ROWS The %s table was found to have two rows of the same time value. -psTime_TYPE_UNKNOWN Specified type, %d, is not supported. -psTime_TYPE_INCORRECT Specified type, %d, is incorrect. -psTime_TYPE_MISMATCH Specified psTime parameters must have same type. -psTime_GET_TOD_FAILED Failed to determine the current time from gettimeofday function. -psTime_CONVERT_TIME_TO_STRING_FAILED Failed to convert a time via strftime function. -psTime_APPEND_MSEC_FAILED Failed to append millisecond to time string with snprintf function. -psTime_USEC_INVALID The psTime usec attribute value, %u, is invalid. Must be less than 1e6. -psTime_ISOTIME_MALFORMED Specified ISO Time string, '%s', is malformed. Must be in 'YYYY-MM-DDThh:mm:ss.sss' format. -psTime_INTERPOLATION_FAILED Failed time table interpolation. -psTime_INTERPOLATION_FAILED_NAME Failed time table interpolation for '%s'. -psTime_LOOKUP_METADATA_FAILED Failed find '%s' in time metadata. -psTime_BAD_TABLE_COUNT Incorrect number of table files entered. Found: %d. Expected: %d. -psTime_BAD_VECTOR Incorrect vector size. Size: %d, Expected %d. -# -psCoord_PROJECTION_TYPE_UNDEFINED The projection type, %s, is undefined. -psCoord_PROJECTION_TYPE_UNKNOWN The projection type, %d, is unknown. -psCoord_UNITS_UNKNOWN Specified units, 0x%x, is not supported. -psCoord_OFFSET_MODE_UNKNOWN Specified offset mode, 0x%x, is not supported. -psCoord_INVALID_MJD Specified time is less than 1900. -# -psAstrometry_NONLINEAR_TRANSFORM The %s transfrom is not linear. Only linear transforms are supported. -# -psMetadata_METATYPE_INVALID Specified psMetadataType, %d, is not supported. -psMetadata_FORMAT_INVALID Specified print format, %%%c, is not supported. -psMetadata_METATYPE_MISMATCH Specified psMetadataType, %d, is incorrect. Expected %d. -psMetadata_ADD_LIST_FAILED Failed to add metadata item, %s, to items list. -psMetadata_ADD_TABLE_FAILED Failed to add metadata item, %s, to items table. -psMetadata_REMOVE_LIST_FAILED Failed to remove metadata item, %s, from metadata list. -psMetadata_REMOVE_LIST_INDEX_FAILED Failed to remove metadata item, at index %d, from metadata list. -psMetadata_REMOVE_TABLE_FAILED Failed to remove metadata item, %s, from metadata table. -psMetadata_ADD_COLLECTION_FAILED Failed to add metadata item, %s, to metadata collection list. -psMetadata_ADD_FAILED Failed to add metadata item to metadata collection list. -psMetadata_FIND_FAILED Could not find metadata item, %s. -psMetadata_FIND_INDEX_FAILED Could not find metadata item at index %d. -psMetadata_DUPLICATE_NOT_ALLOWED Duplicate metadata item name is not allowed. Use a psMetadataFlags option to allow such action. -psMetadata_REGEX_INVALID Specified regular expression is invalid. %s. -psMetadata_LOCATION_INVALID Specified location, %d, is invalid. -# -psMetadataIO_TYPE_INVALID Specified type, %d, is not supported. -psMetadataIO_EXTNUM_NOTPOSITIVE Specified extension number, %d, is invalid. Value must be positive if no extension name is given. -psMetadataIO_FITS_METATYPE_INVALID Specified FITS metadata type, %c, is not supported. -psMetadataIO_ADD_FAILED Failed to add metadata item, %s. -psMetadataIO_FILE_OPEN_FAILED Failed to open file '%s'. Check if it exists and it has the proper permissions. -psMetadataIO_FILE_MULTIPLE_CHAR More than one '%c' character not allowed. Found on line %u of %s. -psMetadataIO_FILE_ELEMENT_NULL Failed to read a metadata %s on line %u of %s. -psMetadataIO_FILE_TYPE_INVALID Metadata type '%s', found on line %u of %s, is invalid. -psMetadataIO_OVERWRITE_ITEM Duplicate Metadata item, %s, found on line %u of %s. Overwrite not allowed. -psMetadataIO_PARSE_FAILED Failed to parse the value '%s' of metadata item %s, type %s, on line %u of %s. -psMetadataIO_NO_NAME Failed to find key 'name' in table on line %u of %s. -psMetadataIO_TYPE_INVALID_LINE_FILE Specified type, %s, is not supported on line %u of %s. -psMetadataIO_TAG_MISMATCH Start tag, %s and end tag, %s do not agree. -psMetadataIO_TAG_UNKNOWN Invalid end tag name, %s. -psMetadataIO_TYPE_DUPLICATE Specified type, %s, on line %u of %s is already defined. -psMetadataIO_DUPLICATE_MULTI Duplicate MULTI specifier on line %u of %s. Index: unk/psLib/src/astronomy/psAstronomyErrors.h =================================================================== --- /trunk/psLib/src/astronomy/psAstronomyErrors.h (revision 4545) +++ (revision ) @@ -1,89 +1,0 @@ -/** @file psAstronomyErrors.h - * - * @brief Contains the error text for the astronomy functions - * - * @ingroup ErrorHandling - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_ASTRONOMY_ERRORS_H -#define PS_ASTRONOMY_ERRORS_H - -/* N.B., lines between '//~Start' and '//~End' are automatic generated from - * the template following the '//~Start'. The template is used to generate - * the other lines by, for each error text in psAstronomyErrors.dat, the following - * substitutions are made: - * $1 The error text macro name (first word in the psAstronomyErrors.dat lines) - * $2 The error text (rest of the line in psAstronomyErrors.dat) - * $n The order of the source line in psAstronomyErrors.dat (comments excluded) - * - * DO NOT EDIT THE LINES BETWEEN //~Start and //~End! ANY CHANGES WILL BE OVERWRITTEN. - */ - -//~Start #define PS_ERRORTEXT_$1 "$2" -#define PS_ERRORTEXT_psTime_FILE_NOT_FOUND "Failed to open file %s." -#define PS_ERRORTEXT_psTime_FILE_TOO_MANY_ROWS "Too many rows found in file %s. Max number of rows allowed is %d." -#define PS_ERRORTEXT_psTime_TIME_POSTDATES_TABLE "Specified psTime postdates (%g) the table of %s information." -#define PS_ERRORTEXT_psTime_TIME_PREDATES_TABLE "Specified psTime predates (%g) the table of %s information." -#define PS_ERRORTEXT_psTime_TIME_POSTDATES_TABLES "Specified psTime postdates (%g) all tables of %s information." -#define PS_ERRORTEXT_psTime_TIME_PREDATES_TABLES "Specified psTime predates (%g) all tables of %s information." -#define PS_ERRORTEXT_psTime_TABLE_DUPLICATE_ROWS "The %s table was found to have two rows of the same time value." -#define PS_ERRORTEXT_psTime_TYPE_UNKNOWN "Specified type, %d, is not supported." -#define PS_ERRORTEXT_psTime_TYPE_INCORRECT "Specified type, %d, is incorrect." -#define PS_ERRORTEXT_psTime_TYPE_MISMATCH "Specified psTime parameters must have same type." -#define PS_ERRORTEXT_psTime_GET_TOD_FAILED "Failed to determine the current time from gettimeofday function." -#define PS_ERRORTEXT_psTime_CONVERT_TIME_TO_STRING_FAILED "Failed to convert a time via strftime function." -#define PS_ERRORTEXT_psTime_APPEND_MSEC_FAILED "Failed to append millisecond to time string with snprintf function." -#define PS_ERRORTEXT_psTime_USEC_INVALID "The psTime usec attribute value, %u, is invalid. Must be less than 1e6." -#define PS_ERRORTEXT_psTime_ISOTIME_MALFORMED "Specified ISO Time string, '%s', is malformed. Must be in 'YYYY-MM-DDThh:mm:ss.sss' format." -#define PS_ERRORTEXT_psTime_INTERPOLATION_FAILED "Failed time table interpolation." -#define PS_ERRORTEXT_psTime_INTERPOLATION_FAILED_NAME "Failed time table interpolation for '%s'." -#define PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED "Failed find '%s' in time metadata." -#define PS_ERRORTEXT_psTime_BAD_TABLE_COUNT "Incorrect number of table files entered. Found: %d. Expected: %d." -#define PS_ERRORTEXT_psTime_BAD_VECTOR "Incorrect vector size. Size: %d, Expected %d." -#define PS_ERRORTEXT_psCoord_PROJECTION_TYPE_UNDEFINED "The projection type, %s, is undefined." -#define PS_ERRORTEXT_psCoord_PROJECTION_TYPE_UNKNOWN "The projection type, %d, is unknown." -#define PS_ERRORTEXT_psCoord_UNITS_UNKNOWN "Specified units, 0x%x, is not supported." -#define PS_ERRORTEXT_psCoord_OFFSET_MODE_UNKNOWN "Specified offset mode, 0x%x, is not supported." -#define PS_ERRORTEXT_psCoord_INVALID_MJD "Specified time is less than 1900." -#define PS_ERRORTEXT_psAstrometry_NONLINEAR_TRANSFORM "The %s transfrom is not linear. Only linear transforms are supported." -#define PS_ERRORTEXT_psMetadata_METATYPE_INVALID "Specified psMetadataType, %d, is not supported." -#define PS_ERRORTEXT_psMetadata_FORMAT_INVALID "Specified print format, %%%c, is not supported." -#define PS_ERRORTEXT_psMetadata_METATYPE_MISMATCH "Specified psMetadataType, %d, is incorrect. Expected %d." -#define PS_ERRORTEXT_psMetadata_ADD_LIST_FAILED "Failed to add metadata item, %s, to items list." -#define PS_ERRORTEXT_psMetadata_ADD_TABLE_FAILED "Failed to add metadata item, %s, to items table." -#define PS_ERRORTEXT_psMetadata_REMOVE_LIST_FAILED "Failed to remove metadata item, %s, from metadata list." -#define PS_ERRORTEXT_psMetadata_REMOVE_LIST_INDEX_FAILED "Failed to remove metadata item, at index %d, from metadata list." -#define PS_ERRORTEXT_psMetadata_REMOVE_TABLE_FAILED "Failed to remove metadata item, %s, from metadata table." -#define PS_ERRORTEXT_psMetadata_ADD_COLLECTION_FAILED "Failed to add metadata item, %s, to metadata collection list." -#define PS_ERRORTEXT_psMetadata_ADD_FAILED "Failed to add metadata item to metadata collection list." -#define PS_ERRORTEXT_psMetadata_FIND_FAILED "Could not find metadata item, %s." -#define PS_ERRORTEXT_psMetadata_FIND_INDEX_FAILED "Could not find metadata item at index %d." -#define PS_ERRORTEXT_psMetadata_DUPLICATE_NOT_ALLOWED "Duplicate metadata item name is not allowed. Use a psMetadataFlags option to allow such action." -#define PS_ERRORTEXT_psMetadata_REGEX_INVALID "Specified regular expression is invalid. %s." -#define PS_ERRORTEXT_psMetadata_LOCATION_INVALID "Specified location, %d, is invalid." -#define PS_ERRORTEXT_psMetadataIO_TYPE_INVALID "Specified type, %d, is not supported." -#define PS_ERRORTEXT_psMetadataIO_EXTNUM_NOTPOSITIVE "Specified extension number, %d, is invalid. Value must be positive if no extension name is given." -#define PS_ERRORTEXT_psMetadataIO_FITS_METATYPE_INVALID "Specified FITS metadata type, %c, is not supported." -#define PS_ERRORTEXT_psMetadataIO_ADD_FAILED "Failed to add metadata item, %s." -#define PS_ERRORTEXT_psMetadataIO_FILE_OPEN_FAILED "Failed to open file '%s'. Check if it exists and it has the proper permissions." -#define PS_ERRORTEXT_psMetadataIO_FILE_MULTIPLE_CHAR "More than one '%c' character not allowed. Found on line %u of %s." -#define PS_ERRORTEXT_psMetadataIO_FILE_ELEMENT_NULL "Failed to read a metadata %s on line %u of %s." -#define PS_ERRORTEXT_psMetadataIO_FILE_TYPE_INVALID "Metadata type '%s', found on line %u of %s, is invalid." -#define PS_ERRORTEXT_psMetadataIO_OVERWRITE_ITEM "Duplicate Metadata item, %s, found on line %u of %s. Overwrite not allowed." -#define PS_ERRORTEXT_psMetadataIO_PARSE_FAILED "Failed to parse the value '%s' of metadata item %s, type %s, on line %u of %s." -#define PS_ERRORTEXT_psMetadataIO_NO_NAME "Failed to find key 'name' in table on line %u of %s." -#define PS_ERRORTEXT_psMetadataIO_TYPE_INVALID_LINE_FILE "Specified type, %s, is not supported on line %u of %s." -#define PS_ERRORTEXT_psMetadataIO_TAG_MISMATCH "Start tag, %s and end tag, %s do not agree." -#define PS_ERRORTEXT_psMetadataIO_TAG_UNKNOWN "Invalid end tag name, %s." -#define PS_ERRORTEXT_psMetadataIO_TYPE_DUPLICATE "Specified type, %s, on line %u of %s is already defined." -#define PS_ERRORTEXT_psMetadataIO_DUPLICATE_MULTI "Duplicate MULTI specifier on line %u of %s." -//~End - -#endif // #ifndef PS_ASTRONOMY_ERRORS_H Index: unk/psLib/src/astronomy/psCoord.c =================================================================== --- /trunk/psLib/src/astronomy/psCoord.c (revision 4545) +++ (revision ) @@ -1,1265 +1,0 @@ -/** @file psCoord.c -* -* @brief Contains basic coordinate transformation definitions and operations -* -* This file defines the basic types for astronomical coordinate -* transformation -* -* @ingroup CoordinateTransform -* -* @author GLG, MHPCC -* -* @version $Revision: 1.79 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-12 19:12:00 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ -/******************************************************************************/ -/* INCLUDE FILES */ -/******************************************************************************/ -#include "psType.h" -#include "psCoord.h" -#include "psMemory.h" -#include "psTime.h" -#include "psConstants.h" -#include "psError.h" -#include "psLogMsg.h" -#include "psAstronomyErrors.h" -#include "psAstrometry.h" -#include "psMatrix.h" -#include -#include - -// Modified Julian Day 01/01/1900 00:00:00 -#define MJD_1900 15021.0 - -// Days in Julian century -#define JULIAN_CENTURY 36525.0 - -static void planeFree(psPlane *p) -{ - // There are non dynamic allocated items -} - -static void sphereFree(psSphere *s) -{ - // There are non dynamic allocated items -} - -static void planeTransformFree(psPlaneTransform *pt) -{ - psFree(pt->x); - psFree(pt->y); -} - -static void planeDistortFree(psPlaneDistort *pt) -{ - psFree(pt->x); - psFree(pt->y); -} - -static void projectionFree(psProjection *p) -{ - // There are no dynamically allocated items -} - -/***************************************************************************** -p_psPlaneTransformLinearInvert(transform): : this is a private function which -simply inverts the supplied psPlaneTransform transform. It assumes that -"transform" is linear. - -This program assumes that the inverse of the following linear equations: - X2 = A + (B * X1) + (C * Y1); - Y2 = D + (E * X1) + (F * Y1); -is - Y1 = (Y2 - ((E/B) * X2) - D + ((E*A)/B)) / (F - ((C*E)/B)); - X1 = (Y2 - ((F/C) * X2) - D + ((F*A)/C)) / (E - ((F*B)/C)); -or - X1 = (-D + ((F*A)/C)) / (E - ((F*B)/C)) + - (X2 * -((F/C) / (E - ((F*B)/C)))) + - (Y2 * (1.0 / (E - ((F*B)/C)))); - Y1 = (-D + ((E*A)/B))/(F - ((C*E)/B)) + - (X2 * -((E/B) / (F - ((C*E)/B)))) + - (Y2 * (1.0 / (F - ((C*E)/B)))); - -XXX: Since there is now a general psPlaneTransformInvert() function, we -should rename this. - *****************************************************************************/ -psPlaneTransform *p_psPlaneTransformLinearInvert(psPlaneTransform *transform) -{ - PS_ASSERT_PTR_NON_NULL(transform, 0); - PS_ASSERT_PTR_NON_NULL(transform->x, 0); - PS_ASSERT_PTR_NON_NULL(transform->y, 0); - - psF64 A = 0.0; - psF64 B = 0.0; - psF64 C = 0.0; - psF64 D = 0.0; - psF64 E = 0.0; - psF64 F = 0.0; - - A = transform->x->coeff[0][0]; - if (transform->x->nX >= 2) { - B = transform->x->coeff[1][0]; - } - if (transform->x->nY >= 2) { - C = transform->x->coeff[0][1]; - } - D = transform->y->coeff[0][0]; - if (transform->y->nX >= 2) { - E = transform->y->coeff[1][0]; - } - if (transform->y->nY >= 2) { - F = transform->y->coeff[0][1]; - } - - psPlaneTransform *out = psPlaneTransformAlloc(2, 2); - - /* This is sample code from IfA. It didn't work initially, and I did not - spend any time debugging it. - - psF64 a = transform->x->coeff[1][0]; - psF64 b = transform->x->coeff[0][1]; - psF64 c = transform->y->coeff[1][0]; - psF64 d = transform->y->coeff[0][1]; - psF64 e = transform->x->coeff[0][0]; - psF64 f = transform->y->coeff[0][0]; - - psF64 invDet = 1.0 / (a * d - b * c); // Inverse of the determinant - - // Not entirely sure why this works, but it appears to do so....................................! - out->x->coeff[1][0] = invDet * a; - out->x->coeff[0][1] = - invDet * b; - out->y->coeff[1][0] = - invDet * c; - out->y->coeff[0][1] = invDet * d; - - out->x->coeff[0][0] = - invDet * (d * e + c * f); - out->y->coeff[0][0] = - invDet * (b * e + a * f); - */ - out->x->coeff[0][0] = (-D + ((F*A)/C)) / (E - ((F*B)/C)); - out->x->coeff[1][0] = -(F/C) / (E - ((F*B)/C)); - out->x->coeff[0][1] = 1.0 / (E - ((F*B)/C)); - out->y->coeff[0][0] = (-D + ((E*A)/B)) / (F - ((C*E)/B)); - out->y->coeff[1][0] = -(E/B) / (F - ((C*E)/B)); - out->y->coeff[0][1] = 1.0 / (F - ((C*E)/B)); - - return(out); -} - -/***************************************************************************** -p_psIsProjectionLinear(): this is a private function which simply determines -if the supplied psPlaneTransform transform is linear: if any of the -cooefficients of order 2 are higher are non-zero, then it is not linear. - *****************************************************************************/ -psS32 p_psIsProjectionLinear(psPlaneTransform *transform) -{ - PS_ASSERT_PTR_NON_NULL(transform, 0); - PS_ASSERT_PTR_NON_NULL(transform->x, 0); - PS_ASSERT_PTR_NON_NULL(transform->y, 0); - - for (psS32 i=0;i<(transform->x->nX);i++) { - for (psS32 j=0;j<(transform->x->nY);j++) { - if (transform->x->coeff[i][j] != 0.0) { - if (!(((i == 0) && (j == 0)) || - ((i == 0) && (j == 1)) || - ((i == 1) && (j == 0)))) { - return(0); - } - } - } - } - - for (psS32 i=0;i<(transform->y->nX);i++) { - for (psS32 j=0;j<(transform->y->nY);j++) { - if (transform->y->coeff[i][j] != 0.0) { - if (!(((i == 0) && (j == 0)) || - ((i == 0) && (j == 1)) || - ((i == 1) && (j == 0)))) { - return(0); - } - } - } - } - - return(1); -} - -// XXX: Must test psPlaneAlloc() and planeFree(). -// XXX: Must rewrite code and tests to use these functions. -psPlane* psPlaneAlloc(void) -{ - psPlane *p = psAlloc(sizeof(psPlane)); - - psMemSetDeallocator(p, (psFreeFunc) planeFree); - return(p); -} - -psSphere* psSphereAlloc(void) -{ - psSphere *s = psAlloc(sizeof(psSphere)); - - psMemSetDeallocator(s, (psFreeFunc) sphereFree); - return(s); -} - -psSphereRot* psSphereRotAlloc(double alphaP, - double deltaP, - double phiP) -{ - psSphereRot* rot = psAlloc(sizeof(psSphereRot)); - - double cosDelta = cos(deltaP); - double halfPhi = phiP / 2.0; - double sinHalfPhi = sin(halfPhi); - - // equations are directly from ADD - double vx = cosDelta*cos(alphaP); - double vy = cosDelta*sin(alphaP); - double vz = sin(deltaP); - - rot->q0 = vx*sinHalfPhi; - rot->q1 = vy*sinHalfPhi; - rot->q2 = vz*sinHalfPhi; - rot->q3 = cos(halfPhi); - - return rot; -} - -psSphereRot* psSphereRotQuat(double q0, - double q1, - double q2, - double q3) -{ - psSphereRot* rot = psAlloc(sizeof(psSphereRot)); - - double len = sqrt(q0*q0 + q1*q1 + q2*q2 + q3*q3); - rot->q0 = q0 / len; - rot->q1 = q1 / len; - rot->q2 = q2 / len; - rot->q3 = q3 / len; - - return rot; -} - -psPlaneTransform* psPlaneTransformAlloc(int n1, int n2) -{ - PS_ASSERT_INT_NONNEGATIVE(n1, NULL); - PS_ASSERT_INT_NONNEGATIVE(n2, NULL); - - psPlaneTransform *pt = psAlloc(sizeof(psPlaneTransform)); - pt->x = psDPolynomial2DAlloc(n1, n2, PS_POLYNOMIAL_ORD); - pt->y = psDPolynomial2DAlloc(n1, n2, PS_POLYNOMIAL_ORD); - - psMemSetDeallocator(pt, (psFreeFunc) planeTransformFree); - return(pt); -} - -psPlane* psPlaneTransformApply(psPlane* out, - const psPlaneTransform* transform, - const psPlane* coords) -{ - PS_ASSERT_PTR_NON_NULL(transform, NULL); - PS_ASSERT_PTR_NON_NULL(transform->x, NULL); - PS_ASSERT_PTR_NON_NULL(transform->y, NULL); - PS_ASSERT_PTR_NON_NULL(coords, NULL); - - if (out == NULL) { - out = (psPlane* ) psAlloc(sizeof(psPlane)); - } - - out->x = psDPolynomial2DEval( - transform->x, - coords->x, - coords->y - ); - - out->y = psDPolynomial2DEval( - transform->y, - coords->x, - coords->y - ); - - return (out); -} - -psPlaneDistort* psPlaneDistortAlloc(int n1, int n2, int n3, int n4) -{ - PS_ASSERT_INT_NONNEGATIVE(n1, NULL); - PS_ASSERT_INT_NONNEGATIVE(n2, NULL); - PS_ASSERT_INT_NONNEGATIVE(n3, NULL); - PS_ASSERT_INT_NONNEGATIVE(n4, NULL); - - psPlaneDistort *pt = psAlloc(sizeof(psPlaneDistort)); - pt->x = psDPolynomial4DAlloc(n1, n2, n3, n4, PS_POLYNOMIAL_ORD); - pt->y = psDPolynomial4DAlloc(n1, n2, n3, n4, PS_POLYNOMIAL_ORD); - - psMemSetDeallocator(pt, (psFreeFunc) planeDistortFree); - return(pt); -} - -/****************************************************************************** -This transformation takes into account parameters beyond an objects spatial -coordinates: term3 and term4 (magnitude and color). - *****************************************************************************/ -psPlane* psPlaneDistortApply(psPlane* out, - const psPlaneDistort* distort, - const psPlane* coords, - float mag, - float color) -{ - PS_ASSERT_PTR_NON_NULL(distort, NULL); - PS_ASSERT_PTR_NON_NULL(distort->x, NULL); - PS_ASSERT_PTR_NON_NULL(distort->y, NULL); - PS_ASSERT_PTR_NON_NULL(coords, NULL); - - if (out == NULL) { - out = (psPlane* ) psAlloc(sizeof(psPlane)); - } - out->x = psDPolynomial4DEval( - distort->x, - coords->x, - coords->y, - mag, - color - ); - out->y = psDPolynomial4DEval( - distort->y, - coords->x, - coords->y, - mag, - color - ); - return (out); -} - -/****************************************************************************** -XXX: We convert Right Ascension angles to the range 0:PI. Is that acceptable? -XXX: Should we do something for Declination as well? - *****************************************************************************/ -psSphere* psSphereRotApply(psSphere* out, - const psSphereRot* transform, - const psSphere* coord) -{ - PS_ASSERT_PTR_NON_NULL(transform, NULL); - PS_ASSERT_PTR_NON_NULL(coord, NULL); - - if (out == NULL) { - out = psSphereAlloc(); - } - - - // apply the transform by creating a new psSphereRot from the input coord - // and combining it with the input transform (see ADD) - psSphereRot* coordRot = psSphereRotAlloc(coord->r, coord->d, 0); - coordRot->q3 = 0.0; - coordRot = psSphereRotCombine(coordRot, transform, coordRot); - // N.B., we can recycle coordRot right away due to the implementation of - // psSphereRotCombine puts the values of coordRot in a local variable first - - out->r = atan2(coordRot->q1,coordRot->q0); - out->d = atan2(coordRot->q2,sqrt(coordRot->q1*coordRot->q1+coordRot->q0*coordRot->q0)); - - return out; -} - -psSphereRot* psSphereRotCombine(psSphereRot* out, - const psSphereRot* rot1, - const psSphereRot* rot2) -{ - PS_ASSERT_PTR_NON_NULL(rot1, NULL); - PS_ASSERT_PTR_NON_NULL(rot2, NULL); - - if (out == NULL) { - out = (psSphereRot* ) psAlloc(sizeof(psSphereRot)); - } - - double a0 = rot1->q0; - double a1 = rot1->q1; - double a2 = rot1->q2; - double a3 = rot1->q3; - double b0 = rot2->q0; - double b1 = rot2->q1; - double b2 = rot2->q2; - double b3 = rot2->q3; - - // following came from ADD - out->q0 = b3*a0 + b2*a1 - b1*a2 + b0*a3; - out->q1 = b3*a1 - b2*a0 + b1*a3 + b0*a2; - out->q2 = b3*a2 + b2*a3 + b1*a0 - b0*a1; - out->q3 = b3*a3 - b3*a2 - b1*a1 - b0*a0; - - return out; -} - -psSphereRot *psSphereRotInvert(psSphereRot *rot) -{ - PS_ASSERT_PTR_NON_NULL(rot, NULL); - - double norm = sqrt(rot->q0*rot->q0 + rot->q1*rot->q1 + rot->q2*rot->q2 + rot->q3*rot->q3); - rot->q1 = -rot->q1 / norm; - rot->q2 = -rot->q2 / norm; - rot->q3 = -rot->q3 / norm; - - return rot; -} - -psSphereRot* psSphereRotICRSToEcliptic(const psTime *time) -{ - psF64 T; - - // Check for null parameter - PS_ASSERT_PTR_NON_NULL(time, NULL); - - // Convert psTime to MJD - psF64 MJD = psTimeToMJD(time); - - // Check the specified MJD is greater than 1900 - if ( MJD < MJD_1900 ) { - psError(PS_ERR_BAD_PARAMETER_TYPE,true,PS_ERRORTEXT_psCoord_INVALID_MJD); - return NULL; - } - - // Calculate number of Julian centuries since 1900 - T = ( MJD - MJD_1900 ) / JULIAN_CENTURY; - - psF64 alphaP = 0.0; - psF64 deltaP = DEG_TO_RAD(23.0) + - MIN_TO_RAD(27.0) + - SEC_TO_RAD(8.26) - - (SEC_TO_RAD(46.845) * T) - - (SEC_TO_RAD(0.0059) * T * T) + - (SEC_TO_RAD(0.00181) * T * T * T); - psF64 phiP = 0.0; - - // Don't neglect the minus sign on deltaP (bug 244): - return (psSphereRotAlloc(alphaP, deltaP, phiP)); -} - - -psSphereRot* psSphereRotEclipticToICRS(const psTime *time) -{ - psF64 T; - - // Check for null parameter - PS_ASSERT_PTR_NON_NULL(time, NULL); - - // Convert psTime to MJD - psF64 MJD = psTimeToMJD(time); - - // Check the specified MJD is greater than 1900 - if ( MJD < MJD_1900 ) { - psError(PS_ERR_BAD_PARAMETER_TYPE,true,PS_ERRORTEXT_psCoord_INVALID_MJD); - return NULL; - } - - // Calculate number of Julian centuries since 1900 - T = ( MJD - MJD_1900 ) / JULIAN_CENTURY; - - psF64 alphaP = 0.0; - psF64 deltaP = DEG_TO_RAD(23.0) + - MIN_TO_RAD(27.0) + - SEC_TO_RAD(8.26) - - (SEC_TO_RAD(46.845) * T) - - (SEC_TO_RAD(0.0059) * T * T) + - (SEC_TO_RAD(0.00181) * T * T * T); - psF64 phiP = 0.0; - - return (psSphereRotAlloc(alphaP, -deltaP, phiP)); -} - -// XXX: This is bug 245: alphaP swaps with phiP from psSphereTransformGalacticToICRS() -psSphereRot* psSphereRotGalacticToICRS(void) -{ - psF64 alphaP = DEG_TO_RAD(32.93192); - psF64 deltaP = DEG_TO_RAD(-62.87175); - psF64 phiP = DEG_TO_RAD(282.85948); - - return (psSphereRotAlloc(alphaP, deltaP, phiP)); -} - -psSphereRot* psSphereRotICRSToGalactic(void) -{ - psF64 alphaP = DEG_TO_RAD(282.85948); - psF64 deltaP = DEG_TO_RAD(62.87175); - psF64 phiP = DEG_TO_RAD(32.93192); - - return (psSphereRotAlloc(alphaP, deltaP, phiP)); -} - -psProjection* psProjectionAlloc( - double R, - double D, - double Xs, - double Ys, - psProjectionType type) -{ - psProjection *p = psAlloc(sizeof(psProjection)); - p->D = D; - p->R = R; - p->Xs = Xs; - p->Ys = Ys; - p->type = type; - - psMemSetDeallocator(p, (psFreeFunc) projectionFree); - return(p); -} - -psPlane* psProject(const psSphere* coord, - const psProjection* projection) -{ - PS_ASSERT_PTR_NON_NULL(coord, NULL); - PS_ASSERT_PTR_NON_NULL(projection, NULL); - - psF64 theta = 0.0; - psF64 phi = 0.0; - - // Allocate return value - psPlane* out = psPlaneAlloc(); - - // Convert to projection spherical coordinate system - theta = asin( sin(coord->d)*sin(projection->D) + - cos(coord->d)*cos(projection->D)*cos(coord->r-projection->R)); - phi = atan2( -1.0*cos(coord->d)*sin(coord->r-projection->R), - sin(coord->d)*cos(projection->D) - cos(coord->d)*sin(projection->D)*cos(coord->r-projection->R) ); - - // Perform the specified projection - // Gnomonic projection - if (projection->type == PS_PROJ_TAN) { - out->x = (cos(theta)*sin(phi))/sin(theta); - out->y = (-1.0*cos(theta)*cos(phi))/sin(theta); - // Othrographic projection - } else if (projection->type == PS_PROJ_SIN) { - out->x = cos(theta)*sin(phi); - out->y = -1.0*cos(theta)*cos(phi); - // Hammer-Aitoff projection - } else if ( projection->type == PS_PROJ_AIT) { - psF64 zeta = 1.0/sqrt(0.5*(1.0+cos(theta)*cos(phi/2.0))); - out->x = 2.0*zeta*cos(theta)*sin(phi/2.0); - out->y = zeta*sin(theta); - // Parabolic projection - } else if ( projection->type == PS_PROJ_PAR) { - out->x = phi*(2.0*cos(2.0*theta/3.0) - 1.0); - out->y = M_PI*sin(theta/3.0); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psCoord_PROJECTION_TYPE_UNKNOWN, - projection->type); - psFree(out); - return NULL; - } - - // Apply plate scales - out->x *= projection->Xs; - out->y *= projection->Ys; - - // Return output - return out; -} - -psSphere* psDeproject(const psPlane* coord, - const psProjection* projection) -{ - PS_ASSERT_PTR_NON_NULL(coord, NULL); - PS_ASSERT_PTR_NON_NULL(projection, NULL); - - psF64 theta = 0.0; - psF64 phi = 0.0; - - // Allocate return sphere structure - psSphere* out = psSphereAlloc(); - - // Remove plate scales - psF64 x = coord->x/projection->Xs; - psF64 y = coord->y/projection->Ys; - - // Perform inverse projection - // Gnonomic deprojection - if ( projection->type == PS_PROJ_TAN) { - phi = atan(-1.0*x/y); - theta = atan(1.0/sqrt(x*x+y*y)); - // Orhtographic deprojection - } else if ( projection->type == PS_PROJ_SIN) { - phi = atan((-1.0*x)/y); - theta = atan( sqrt(1.0-(x*x+y*y)) / sqrt(x*x+y*y)); - // Hammer-Aitoff deprojection - } else if ( projection->type == PS_PROJ_AIT) { - psF64 z = sqrt(1.0 - ((x/4.0)*(x/4.0)) - ((y/2.0)*(y/2.0))); - phi = 2.0*atan((z*x) / (2.0*(2.0*z*z-1.0)) ); - theta = asin(y*z); - // Parabolic deprojection - } else if ( projection->type == PS_PROJ_PAR) { - psF64 rho = y/M_PI; - phi = x/(1.0 - 4.0*rho*rho); - theta = 3.0*asin(rho); - // Invalid deprojection type - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psCoord_PROJECTION_TYPE_UNKNOWN, - projection->type); - psFree(out); - return NULL; - } - - // Convert from projection spherical coordinates - out->d = asin( sin(theta)*sin(projection->D) + - cos(theta)*cos(projection->D)*cos(phi) ); - out->r = projection->R + atan2( -1.0*cos(theta)*sin(phi), - sin(theta)*cos(projection->D) - - cos(theta)*sin(projection->D)*cos(phi) ); - - // Return sphere coordinate - return out; -} - -/****************************************************************************** -The basic idea is to project both positions onto the linear plane, with -position1 at the center, then calculate the linear offset between those -projections. - -XXX: Do I need to check for unacceptable transformation parameters? Maybe, - if the points are on the North/South Pole, etc? - -XXX: Do I need to somehow scale this projection? - -XXX: Does PS_LINEAR mode make sense? The result must be returned in psSphere - regardless of the mode. - -XXX: How to compound errors? - *****************************************************************************/ -psSphere* psSphereGetOffset(const psSphere* position1, - const psSphere* position2, - psSphereOffsetMode mode, - psSphereOffsetUnit unit) -{ - PS_ASSERT_PTR_NON_NULL(position1, NULL); - PS_ASSERT_PTR_NON_NULL(position2, NULL); - - // Check positions near 90 degree and issue warnings if necessary - if (position1->d >= DEG_TO_RAD(90.0)) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: psDeproject(): position1->d is larger than 90 degrees. Returning NULL."); - return NULL; - } - if (position2->d >= DEG_TO_RAD(90.0)) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: psDeproject(): position2->d is larger than 90 degrees. Returning NULL."); - return NULL; - } - - // Allocate return structure - psSphere* tmp = psSphereAlloc(); - - // Mode is LINEAR - Use first position as projection center and project second point - // onto tangent plane, set point projected into psSphere structure x->r y->d - if (mode == PS_LINEAR) { - psProjection* proj = psProjectionAlloc(position1->r, - position1->d, - 1.0, - 1.0, - PS_PROJ_TAN); - - // Perform projection onto tangent plane - psPlane* lin = psProject(position2, proj); - - // Set return values - tmp->r = lin->x; - tmp->d = lin->y; - - // Free data structures allocated - psFree(proj); - psFree(lin); - - // Mode is SPHERICAL - Get difference between positiion 1 and position 2 and convert - // offset value from radians to desired units and return - } else if (mode == PS_SPHERICAL) { - tmp->r = position2->r - position1->r; - tmp->d = position2->d - position1->d; - - // Wrap these to an acceptable range. This assumes that all - // angles are in radians. - tmp->r = fmod(tmp->r, 2*M_PI); - tmp->d = fmod(tmp->d, 2*M_PI); - tmp->rErr = 0.0; - tmp->dErr = 0.0; - - // Convert to desired units - if (unit == PS_ARCSEC) { - tmp->r = RAD_TO_SEC(tmp->r); - tmp->d = RAD_TO_SEC(tmp->d); - } else if (unit == PS_ARCMIN) { - tmp->r = RAD_TO_MIN(tmp->r); - tmp->d = RAD_TO_MIN(tmp->d); - } else if (unit == PS_DEGREE) { - tmp->r = RAD_TO_DEG(tmp->r); - tmp->d = RAD_TO_DEG(tmp->d); - } else if (unit == PS_RADIAN) {} - else { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psCoord_UNITS_UNKNOWN, - unit); - psFree(tmp); - return NULL; - } - // Invalid mode - } else { - - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psCoord_OFFSET_MODE_UNKNOWN, - mode); - psFree(tmp); - return NULL; - } - - // Return value - return tmp; -} - -/****************************************************************************** -XXX: Do we need to check for unacceptable transformation parameters? Maybe, - if the points are on the North/South Pole, etc? - -XXX: Do we need to somehow scale this projection? - -XXX: I copied the algorithm from the ADD exactly. - -XXX: Should we compound errors? - *****************************************************************************/ - -psSphere* psSphereSetOffset(const psSphere* position, - const psSphere* offset, - psSphereOffsetMode mode, - psSphereOffsetUnit unit) -{ - PS_ASSERT_PTR_NON_NULL(position, NULL); - PS_ASSERT_PTR_NON_NULL(offset, NULL); - - psSphere* tmp; - psF64 tmpR = 0.0; - psF64 tmpD = 0.0; - - // If mode is linear then set position to projection center - // and offset to linear coordinate then deproject to obtain - // new sphere coordinate - if (mode == PS_LINEAR) { - - // Allocate plane coordinate and set coordinate - psPlane* lin = psPlaneAlloc(); - lin->x = offset->r; - lin->y = offset->d; - - // Allocate and set projection structure - psProjection* proj = psProjectionAlloc(position->r, - position->d, - 1.0, - 1.0, - PS_PROJ_TAN); - - // Project tangent plane coord to spherical coord - tmp = psDeproject(lin, proj); - - // Free data structures used - psFree(proj); - psFree(lin); - - // If mode is spherical then convert offset to radians, add the offset - // to the position and wrap to 0 to 2pi - } else if (mode == PS_SPHERICAL) { - - // Convert offset unit to radians - if (unit == PS_ARCSEC) { - tmpR = SEC_TO_RAD(offset->r); - tmpD = SEC_TO_RAD(offset->d); - } else if (unit == PS_ARCMIN) { - tmpR = MIN_TO_RAD(offset->r); - tmpD = MIN_TO_RAD(offset->d); - } else if (unit == PS_DEGREE) { - tmpR = DEG_TO_RAD(offset->r); - tmpD = DEG_TO_RAD(offset->d); - } else if (unit == PS_RADIAN) { - tmpR = offset->r; - tmpD = offset->d; - } else { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psCoord_UNITS_UNKNOWN, - unit); - return NULL; - } - - // Allocate sphere structure to return - tmp = psSphereAlloc(); - - // Add offset and wrap to 0 to 2PI if necessary - tmp->r = position->r + tmpR; - tmp->r = fmod(tmp->r, 2.0*M_PI); - tmp->d = position->d + tmpD; - tmp->d = fmod(tmp->d, 2.0*M_PI); - tmp->rErr = 0.0; - tmp->dErr = 0.0; - - // Invalid mode report error - } else { - - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psCoord_OFFSET_MODE_UNKNOWN, - mode); - return NULL; - } - - return tmp; -} - - - -/****************************************************************************** -psSpherePrecess(coords, fromTime, toTime): - -XXX: Use static memory for tmpST. - *****************************************************************************/ -psSphere *psSpherePrecess(psSphere *coords, - const psTime *fromTime, - const psTime *toTime) -{ - // Check input for NULL pointers - PS_ASSERT_PTR_NON_NULL(coords, NULL); - PS_ASSERT_PTR_NON_NULL(fromTime, NULL); - PS_ASSERT_PTR_NON_NULL(toTime, NULL); - - // Calculate Julian centuries - psF64 fromMJD = psTimeToMJD(fromTime); - psF64 toMJD = psTimeToMJD(toTime); - psF64 T = (toMJD - fromMJD) / JULIAN_CENTURY; - - // Calculate conversion constants - psF64 alphaP = DEG_TO_RAD(90.0) - ((DEG_TO_RAD(0.6406161) * T) + - (DEG_TO_RAD(0.0000839) * T * T) + - (DEG_TO_RAD(0.000005) * T * T * T)); - - psF64 deltaP = (DEG_TO_RAD(0.5567530) * T) - - (DEG_TO_RAD(0.0001185) * T * T) - - (DEG_TO_RAD(0.0000116) * T * T * T); - - psF64 phiP = DEG_TO_RAD(90.0) + ((DEG_TO_RAD(0.6406161) * T) + - (DEG_TO_RAD(0.0003041) * T * T) + - (DEG_TO_RAD(0.0000051) * T * T * T)); - - // Create transform with proper constants - psSphereRot* tmpST = psSphereRotAlloc(alphaP, deltaP, phiP); - - // Apply transform to coordinates - psSphere *out = psSphereRotApply(NULL, tmpST, coords); - - psFree(tmpST); - - return(out); -} - -/***************************************************************************** -multiplyDPoly2D(trans1, trans2): Takes two 2-D polynomials as input and -multiplies them. Basically, for each non-zero coeff in the trans1 coeff[][] -array, you must multiply by all non-zero coeffs in trans2. - -XXX: Inefficient in that the out polynomial is allocated every time. - *****************************************************************************/ - -static psDPolynomial2D *multiplyDPoly2D(psDPolynomial2D *trans1, - psDPolynomial2D *trans2) -{ - //TRACE: printf("multiplyDPoly2D(%d %d: %d %d)\n", trans1->nX, trans1->nY, trans2->nX, trans2->nY); - psS32 orderX = (trans1->nX + trans2->nX) - 1; - psS32 orderY = (trans1->nY + trans2->nY) - 1; - - psDPolynomial2D *out = psDPolynomial2DAlloc(orderX, orderY, PS_POLYNOMIAL_ORD); - //TRACE: printf("Creating poly (%d, %d)\n", orderX, orderY); - for (psS32 i = 0 ; i < out->nX; i++) { - for (psS32 j = 0 ; j < out->nY; j++) { - out->coeff[i][j] = 0.0; - out->mask[i][j] = 0; - } - } - - for (psS32 t1x = 0 ; t1x < trans1->nX ; t1x++) { - for (psS32 t1y = 0 ; t1y < trans1->nY ; t1y++) { - if (0.0 != trans1->coeff[t1x][t1y]) { - for (psS32 t2x = 0 ; t2x < trans2->nX ; t2x++) { - for (psS32 t2y = 0 ; t2y < trans2->nY ; t2y++) { - /* Possible debug-only macro which checks these coords? - if ((t1x+t2x) >= orderX) - printf("BAD 1\n"); - if ((t1y+t2y) >= orderY) - printf("BAD 2\n"); - */ - out->coeff[t1x+t2x][t1y+t2y]+= (trans1->coeff[t1x][t1y] * trans2->coeff[t2x][t2y]); - } - } - } - } - } - return(out); -} - - -/***************************************************************************** -psPlaneTransformCombine(out, trans1, trans2) - -XXX: Much room for optimization. Currently, we call the polyMultiply -routine far too many times. - *****************************************************************************/ -psPlaneTransform *psPlaneTransformCombine(psPlaneTransform *out, - const psPlaneTransform *trans1, - const psPlaneTransform *trans2, - psRegion region, - int nSamples) -{ - - // XXX: This does not yet use region and nSamples: need to modify -rdd - - PS_ASSERT_PTR_NON_NULL(trans1, NULL); - PS_ASSERT_PTR_NON_NULL(trans2, NULL); - //TRACE: printf("psPlaneTransformCombine(%d, %d, %d, %d: %d, %d, %d, %d)\n", trans1->x->nX, trans1->x->nY, trans1->y->nX, trans1->y->nY, trans2->x->nX, trans2->x->nY, trans2->y->nX, trans2->y->nY); - // - // Determine the size of the new psPlaneTransform. - // - // PS_MAX( Number of x terms in T2->x * number of x terms in T1->x, - // Number of y terms in T2->x * number of x terms in T1->y, - psS32 orderXnX = PS_MAX((trans2->x->nX * trans1->x->nX), - (trans2->x->nY * trans1->y->nX)); - psS32 orderXnY = PS_MAX((trans2->x->nX * trans1->x->nY), - (trans2->x->nY * trans1->y->nY)); - - psS32 orderYnX = PS_MAX((trans2->y->nX * trans1->x->nX), - (trans2->y->nY * trans1->y->nX)); - psS32 orderYnY = PS_MAX((trans2->y->nX * trans1->x->nY), - (trans2->y->nY * trans1->y->nY)); - psS32 orderX = PS_MAX(orderXnX, orderYnX); - psS32 orderY = PS_MAX(orderXnY, orderYnY); - - // - // Allocate the new psPlaneTransform, if necessary. - // - psPlaneTransform *myPT = NULL; - if (out == NULL) { - myPT = psPlaneTransformAlloc(orderX, orderY); - } else { - if ((out->x->nX == orderX) && (out->x->nY == orderY) && - (out->y->nX == orderX) && (out->y->nY == orderY)) { - myPT = out; - } else { - psFree(out); - myPT = psPlaneTransformAlloc(orderX, orderY); - } - } - - // - // Initialize the new psPlaneTransform, if necessary. - // - for (psS32 i = 0 ; i < orderX ; i++) { - for (psS32 j = 0 ; j < orderY ; j++) { - myPT->x->coeff[i][j] = 0.0; - myPT->x->mask[i][j] = 0; - myPT->y->coeff[i][j] = 0.0; - myPT->y->mask[i][j] = 0; - } - } - - // - // For each term (a * x^i * y^j) in trans2, we substitute the appropriate - // equation from trans1, and raise it to the appropriate power. This is - // done via the multiplyDPoly2D(). The result is a polynomial (currPoly) - // and its coefficients are added into the myPT coeff matrix. - // - // XXX: This is horribly inefficient in that the trans1 polys are repeatedly - // multiplied against themselves. This can easily be improved. - // - - for (psS32 t2x = 0 ; t2x < trans2->x->nX ; t2x++) { - for (psS32 t2y = 0 ; t2y < trans2->x->nY ; t2y++) { - psDPolynomial2D *currPoly = psDPolynomial2DAlloc(1, 1, PS_POLYNOMIAL_ORD); - - currPoly->coeff[0][0] = 1.0; - currPoly->mask[0][0] = 0; - psDPolynomial2D *newPoly = NULL; - - if (trans2->x->mask[t2x][t2y] == 0) { - // Must raise trans1->y to the t2y-power. - for (psS32 c = 0 ; c < t2y; c++) { - newPoly = multiplyDPoly2D(currPoly, trans1->y); - psFree(currPoly); - currPoly = newPoly; - } - - // Must raise trans1->x to the t2x-power. - for (psS32 c = 0 ; c < t2x; c++) { - newPoly = multiplyDPoly2D(currPoly, trans1->x); - psFree(currPoly); - currPoly = newPoly; - } - - // Set the appropriate coeffs in myPT->x - for (psS32 i = 0 ; i < currPoly->nX ; i++) { - for (psS32 j = 0 ; j < currPoly->nY ; j++) { - myPT->x->coeff[i][j]+= currPoly->coeff[i][j] * trans2->x->coeff[t2x][t2y]; - } - } - } - psFree(currPoly); - } - } - - - for (psS32 t2x = 0 ; t2x < trans2->y->nX ; t2x++) { - for (psS32 t2y = 0 ; t2y < trans2->y->nY ; t2y++) { - psDPolynomial2D *currPoly = psDPolynomial2DAlloc(1, 1, PS_POLYNOMIAL_ORD); - currPoly->coeff[0][0] = 1.0; - currPoly->mask[0][0] = 0; - psDPolynomial2D *newPoly = NULL; - - if (trans2->y->mask[t2x][t2y] == 0) { - - // Must raise trans1->y to the t2y-power. - for (psS32 c = 0 ; c < t2y; c++) { - newPoly = multiplyDPoly2D(currPoly, trans1->y); - psFree(currPoly); - currPoly = newPoly; - } - - // Must raise trans1->x to the t2x-power. - for (psS32 c = 0 ; c < t2x; c++) { - newPoly = multiplyDPoly2D(currPoly, trans1->x); - psFree(currPoly); - currPoly = newPoly; - } - - // Set the appropriate coeffs in myPT->x - for (psS32 i = 0 ; i < currPoly->nX ; i++) { - for (psS32 j = 0 ; j < currPoly->nY ; j++) { - myPT->y->coeff[i][j]+= currPoly->coeff[i][j] * trans2->y->coeff[t2x][t2y]; - } - } - } - psFree(currPoly); - } - } - - //TRACE: printf("Exiting combine()\n"); - return(myPT); -} - -/***************************************************************************** -psPlaneTransformFit(trans, source, dest, nRejIter, sigmaClip) - -XXX: What about nRejIter? Iterations? -XXX: Use static vectors for internal data. -XXX: This code has problems with data that corresponds to a non-linear fit. - *****************************************************************************/ -bool psPlaneTransformFit(psPlaneTransform *trans, - const psArray *source, - const psArray *dest, - int nRejIter, - float sigmaClip) -{ - PS_ASSERT_PTR_NON_NULL(trans, NULL); - PS_ASSERT_PTR_NON_NULL(source, NULL); - PS_ASSERT_PTR_NON_NULL(dest, NULL); - - psS32 numCoords = PS_MIN(source->n, dest->n); - psS32 order = PS_MAX(trans->x->nX, trans->x->nY); - order = PS_MAX(order, trans->y->nX); - order = PS_MAX(order, trans->y->nY); - - // - // Create fake polynomial to use in evaluation - // - psDPolynomial2D *fakePoly = psDPolynomial2DAlloc(order, order, PS_POLYNOMIAL_ORD); - for (int i = 0; i < order; i++) { - for (int j = 0; j < order; j++) { - fakePoly->coeff[i][j] = 1.0; - fakePoly->mask[i][j] = 1; // Mask all coefficients; unmask to evaluate - } - } - - // - // Initialize the matrix and vectors - // - psS32 nCoeff = order * (order + 1) / 2; // Number of polynomial coefficients - psImage *matrix = psImageAlloc(nCoeff, nCoeff, PS_TYPE_F64); // Matrix for solution - psVector *xVector = psVectorAlloc(nCoeff, PS_TYPE_F64); // Vector for solution in x - psVector *yVector = psVectorAlloc(nCoeff, PS_TYPE_F64); // Vector for solution in y - for (psS32 i = 0; i < nCoeff; i++) { - for (psS32 j = 0; j < nCoeff; j++) { - matrix->data.F64[i][j] = 0.0; - } - xVector->data.F64[i] = 0.0; - yVector->data.F64[i] = 0.0; - } - - // - // Iterate over the grid points - // - for (psS32 g = 0; g < numCoords; g++) { - // Iterate over the polynomial coefficients, accumulating the matrix and vectors - - for (psS32 i = 0, ijIndex = 0; i < order; i++) { - for (psS32 j = 0; j < order - i; j++, ijIndex++) { - fakePoly->mask[i][j] = 0; - psF64 xIn = ((psPlane *) source->data[g])->x; - psF64 yIn = ((psPlane *) source->data[g])->y; - psF64 xOut = ((psPlane *) dest->data[g])->x; - psF64 yOut = ((psPlane *) dest->data[g])->y; - psF64 ijPoly = psDPolynomial2DEval(fakePoly, xIn, yIn); - fakePoly->mask[i][j] = 1; - - for (psS32 m = 0, mnIndex = 0; m < order; m++) { - for (psS32 n = 0; n < order - m; n++, mnIndex++) { - fakePoly->mask[m][n] = 0; - psF64 mnPoly = psDPolynomial2DEval(fakePoly, xIn, yIn); - fakePoly->mask[m][n] = 1; - - matrix->data.F64[ijIndex][mnIndex] += ijPoly * mnPoly; - } - } - - xVector->data.F64[ijIndex] += ijPoly * xOut; - yVector->data.F64[ijIndex] += ijPoly * yOut; - } - } - } - - // - // Solution via LU Decomposition - // - psVector *permutation = psVectorAlloc(nCoeff, PS_TYPE_F64); // Permutation vector for LU Decomposition - psImage *luMatrix = psMatrixLUD(NULL, &permutation, matrix); // LU decomposed matrix - psVector *xSolution = psMatrixLUSolve(NULL, luMatrix, xVector, permutation); // Solution in x - psVector *ySolution = psMatrixLUSolve(NULL, luMatrix, yVector, permutation); // Solution in y - - // - // XXX: Should check the output of the matrix routines and return false if bad. - // - - // - // Stuff coefficients into transformation - // - for (psS32 i = 0, ijIndex = 0; i < order; i++) { - for (psS32 j = 0; j < order - i; j++, ijIndex++) { - trans->x->coeff[i][j] = xSolution->data.F64[ijIndex]; - trans->y->coeff[i][j] = ySolution->data.F64[ijIndex]; - } - } - - psFree(fakePoly); - psFree(permutation); - psFree(luMatrix); - psFree(xSolution); - psFree(ySolution); - psFree(matrix); - psFree(xVector); - psFree(yVector); - - return(true); -} - - -/***************************************************************************** -psPlaneTransformInvert(out, in, region, nSamples) - -// XXX: Use static data structures. - *****************************************************************************/ -psPlaneTransform *psPlaneTransformInvert(psPlaneTransform *out, - const psPlaneTransform *in, - psRegion region, - int nSamples) -{ - PS_ASSERT_PTR_NON_NULL(in, NULL); - // - // If the transform is linear, then invert it exactly and return. - // - if (p_psIsProjectionLinear((psPlaneTransform *) in)) { - return(p_psPlaneTransformLinearInvert((psPlaneTransform *) in)); - } - PS_INT_COMPARE(1, nSamples, NULL); - - // Ensure that the input transformation is symmetrical. - if ((in->x->nX != in->x->nY) || - (in->y->nX != in->y->nY) || - (in->x->nX != in->y->nX)) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, "Input transformation must have same nX==nY."); - } - psS32 order = in->x->nX; - - psPlaneTransform *myPT = NULL; - psPlane *inCoord = psPlaneAlloc(); - psPlane *outCoord = psPlaneAlloc(); - - // - // Allocate a new psPlaneTransform if "out" is NULL, or has the wrong size. - // - if (out == NULL) { - myPT = psPlaneTransformAlloc(order, order); - } else { - if ((out->x->nX == order) && (out->x->nY == order) && - (out->y->nX == order) && (out->y->nY == order)) { - myPT = out; - } else { - psFree(out); - myPT = psPlaneTransformAlloc(order, order); - } - } - - // - // Copy the input transform to myPT. - // - for (psS32 i = 0 ; i < in->x->nX ; i++) { - for (psS32 j = 0 ; j < in->x->nY ; j++) { - myPT->x->coeff[i][j] = in->x->coeff[i][j]; - } - } - for (psS32 i = 0 ; i < in->y->nX ; i++) { - for (psS32 j = 0 ; j < in->y->nY ; j++) { - myPT->y->coeff[i][j] = in->y->coeff[i][j]; - } - } - - // - // Create a grid of xin,yin --> xout,yout - // - psArray *inData = psArrayAlloc(nSamples * nSamples); - psArray *outData = psArrayAlloc(nSamples * nSamples); - for (psS32 i = 0 ; i < inData->n; i++) { - inData->data[i] = (psPtr *) psPlaneAlloc(); - outData->data[i] = (psPtr *) psPlaneAlloc(); - } - - // - // Initialize the grid. Since we want the inverse of the transformation, the - // inCoords are written to the outData vector, and the outCoords are written - // to the inData vector. - // - psS32 cnt = 0; - for (int yint = 0; yint < nSamples; yint++) { - inCoord->y = region.y0 + ((psF32) yint) * ((region.y1 - region.y0) / ((psF32) nSamples)); - for (int xint = 0; xint < nSamples; xint++) { - inCoord->x = region.x0 + ((psF32) xint) * ((region.x1 - region.x0) / ((psF32) nSamples)); - (void)psPlaneTransformApply(outCoord, in, inCoord); - ((psPlane *) outData->data[cnt])->x = inCoord->x; - ((psPlane *) outData->data[cnt])->y = inCoord->y; - ((psPlane *) inData->data[cnt])->x = outCoord->x; - ((psPlane *) inData->data[cnt])->y = outCoord->y; - - cnt++; - } - } - // XXX: what values should be used here? - bool rc = psPlaneTransformFit(myPT, inData, outData, 10, 100.0); - - psFree(inCoord); - psFree(outCoord); - psFree(inData); - psFree(outData); - - if (rc == true) { - return(myPT); - } - - // XXX: Generate an error message, or warning message. - return(NULL); -} Index: unk/psLib/src/astronomy/psCoord.h =================================================================== --- /trunk/psLib/src/astronomy/psCoord.h (revision 4545) +++ (revision ) @@ -1,488 +1,0 @@ -/** @file psCoord.h -* -* @brief Contains basic coordinate transformation definitions and operations -* -* This file defines the basic types for astronomical coordinate -* transformation -* -* @ingroup CoordinateTransform -* -* @author GLG, MHPCC -* -* @version $Revision: 1.38 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-12 19:12:00 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#ifndef PS_COORD_H -#define PS_COORD_H - -#include "psType.h" -#include "psImage.h" -#include "psArray.h" -#include "psList.h" -#include "psFunctions.h" -// N.B. inclusion of psTime.h was done to after the typedefs to handle cross-dependency of typedefs - -/// @addtogroup CoordinateTransform -/// @{ - -/** Euclidiean Coordinate System. - * - * Both detector and sky positions will be used extensively in the IPP. One - * coordinate system to be used is linear coordinates which conform to - * Euclidean geometry. - * - */ -typedef struct -{ - double x; ///< x position - double y; ///< y position - double xErr; ///< Error in x position - double yErr; ///< Error in y position -} -psPlane; - -/** Angular Coordinate System - * - * Both detector and sky positions will be used extensively in the IPP. One - * coordinate system to be used is angular coordinates for which additional - * care must often be taken in comparison to a euclidiean coordinate system. - * - */ -typedef struct -{ - double r; ///< RA - double d; ///< Dec - double rErr; ///< Error in RA - double dErr; ///< Error in Dec -} -psSphere; - -/** Cubic Coordinate System - * - */ -typedef struct -{ - double x; ///< cos (DEC) cos (RA) - double y; ///< cos (DEC) sic (RA) - double z; ///< sin (DEC) - double xErr; ///< Error in x - double yErr; ///< Error in y - double zErr; ///< Error in z -} -psCube; - -/** Spherical rotations represent coordinate transformation in 3-D, as well as - * the effects of precession and nutation. The structure contains the - * elements of a quaternion to represent the spherical rotational. - * - */ -typedef struct -{ - double q0; ///< first element of the quaternion - double q1; ///< second element of the quaternion - double q2; ///< third element of the quaternion - double q3; ///< fourth element of the quaternion -} -psSphereRot; - -/** 2D Polynomial Transform - * - * A transform between coordinate systems that consists simply of two 2D - * polynomials to transform both components - the output coordinates depend - * only on the input coordinates and no other quantities of objects at those - * coordinates. - * - */ -typedef struct -{ - psDPolynomial2D* x; ///< 2D polynomial transform of X coordinates - psDPolynomial2D* y; ///< 2D polynomial transform of Y coordinates -} -psPlaneTransform; - -/** 4D Polynomial Transform - * - * A transform between coordinate systems that consists of two 4D polynomials - * in which the output coordinates are also specified to be a function of the - * magnitude and color of the object with the given coordinates. This type of - * coordinate transformation is necessary to represent the (color-dependent) - * optical distortions caused by the atmosphere and camera optics, and the - * possibly effects of charge transfer inefficiency. - * - * The lowest two terms are the x and y axis of the target system. The higher - * two terms may represent magnitude and color terms. - */ -typedef struct -{ - psDPolynomial4D* x; ///< 4D polynomial transform of X coordinates - psDPolynomial4D* y; ///< 4D polynomial transform of Y coordinates -} -psPlaneDistort; - -/** Projection type for projection/deprojection - * - * @see psProject, psDeproject - * - */ -typedef enum { - PS_PROJ_TAN, ///< Tangent projection - PS_PROJ_SIN, ///< Sine projection - PS_PROJ_AIT, ///< Aitoff projection - PS_PROJ_PAR, ///< Par projection - // PS_PROJ_GLS, ///< GLS projection - // PS_PROJ_CAR, ///< CAR projection - // PS_PROJ_MER, ///< MER projection - PS_PROJ_NTYPE ///< Number of types; must be last. -} psProjectionType; - -/** Parameter set for projection/deprojection - * - * @see psProject, psDeproject - * - */ -typedef struct -{ - double R; ///< Coordinates of projection center - double D; ///< Coordinates of projection center - double Xs; ///< plate-scale in X direction - double Ys; ///< plate-scale in Y direction - psProjectionType type; ///< Projection type -} -psProjection; - -/** Mode for Offset calculation between two sky positions - * - * @see psSphereGetOffset, psSphereSetOffset - * - */ -typedef enum { - PS_SPHERICAL, ///< offset corresponds to an angular offset - PS_LINEAR ///< offset corresponds to a linear offset -} psSphereOffsetMode; - -/** The units of the offset - * - * @see psSphereGetOffset, psSphereSetOffset - * - */ -typedef enum { - PS_ARCSEC, ///< Arcseconds - PS_ARCMIN, ///< Arcminutes - PS_DEGREE, ///< Degrees - PS_RADIAN ///< Radians -} psSphereOffsetUnit; - -#include "psTime.h" - -/** Allocates a psPlane - * - * @return psPlane* resulting plane structure. - */ - -psPlane* psPlaneAlloc(void); - -/** Allocates a psSphere - * - * @return psSphere* resulting sphere structure. - */ -psSphere* psSphereAlloc(void); - -/** psSphereRot allocator which defines the rotation in terms of the coordinate - * of the pole and the rotation about that pole. - * - * @return psSphereRot* Newly allocated psSphereRot object - */ -psSphereRot* psSphereRotAlloc( - double alphaP, - double deltaP, - double phiP -); - -/** psSphereRot allocator which defines the rotation from the elements of the - * quaternion. - * - * @return psSphereRot* Newly allocated psSphereRot object - */ -psSphereRot* psSphereRotQuat( - double q0, - double q1, - double q2, - double q3 -); - -/** Allocates a psPlaneTransform transform. - * - * @return psPlaneTransform* resulting plane transform - */ -psPlaneTransform* psPlaneTransformAlloc( - int n1, ///< The order of the x term in the transform. - int n2 ///< The order of the y term in the transform. -); - -/** Applies the psPlaneTransform transform to a specified coordinate - * - * @return psPlane* resulting coordinate based on transform - */ -psPlane* psPlaneTransformApply( - psPlane* out, ///< a psPlane to recycle. If NULL, a new one is generated. - const psPlaneTransform* transform, ///< the transform to apply - const psPlane* coords ///< the coordinate to apply the transform above. -); - -/** Allocates a psPlaneDistort transform. - * - * @return psPlaneDistort* resulting plane distort transform - */ - -psPlaneDistort* psPlaneDistortAlloc( - int n1, ///< The order of the w term in the transform. - int n2, ///< The order of the x term in the transform. - int n3, ///< The order of the y term in the transform. - int n4 ///< The order of the z term in the transform. -); - - -/** Applies the psPlaneDistort transform to a specified coordinate - * - * @return psPlane* resulting coordinate based on transform - */ -psPlane* psPlaneDistortApply( - psPlane* out, ///< a psPlane to recycle. If NULL, a new one is generated. - const psPlaneDistort* distort, ///< the transform to apply - const psPlane* coords, ///< the coordinate to apply the transform above. - float mag, ///< third term -- maybe magnitude - float color ///< forth term -- maybe color -); - - -/** Applies the psSphereRot transform for a specified coordinate - * - * @return psSphere* resulting coordinate based on transform - */ -psSphere* psSphereRotApply( - psSphere* out, ///< a psSphere to recycle. If NULL, a new one is generated. - const psSphereRot* transform, ///< the transform to apply - const psSphere* coord ///< the coordinate to apply the transform above.x -); - -/** Combines two rotations to produce a single rotation which is equivalent of - * applying the first rotation and then the second. - * - * @return psSphereRot* new psSphereRot transform - */ -psSphereRot* psSphereRotCombine( - psSphereRot* out, - const psSphereRot* rot1, - const psSphereRot* rot2 -); - -/** Inverts a psSphereRot's rotation. - * - * @return psSphereRot* The inverted psSphereRot - */ -psSphereRot* psSphereRotInvert( - psSphereRot* rot ///< the psSphereRot to invert -); - -/** Creates the appropriate transform for converting from ICRS to Ecliptic - * coordinate systems. - * - * @return psSphereRot* transform for ICRS->Ecliptic coordinate systems - */ -psSphereRot* psSphereRotICRSToEcliptic( - const psTime* time ///< the time for which the resulting transform will be valid -); - -/** Creates the appropriate transform for converting from Ecliptic to ICRS - * coordinate systems. - * - * @return psSphereRot* transform for Ecliptic->ICRS coordinate systems - */ -psSphereRot* psSphereRotEclipticToICRS( - const psTime* time ///< the time for which the resulting transform will be valid -); - -/** Creates the appropriate transform for converting from ICRS to Galactic - * coordinate systems. - * - */ -psSphereRot* psSphereRotICRSToGalactic(void); - -/** Creates the appropriate transform for converting from Galactic to ICRS - * coordinate systems. - * - */ -psSphereRot* psSphereRotGalacticToICRS(void); - -/** Allocates memory for a psProjection structure - * - * @return psProjection* psProjection structure - */ -psProjection* psProjectionAlloc( - double R, ///< Right-ascension of projection center. - double D, ///< Declination of projection center. - double Xs, ///< Scale in x-dimension - double Ys, ///< Scale in y-dimension - psProjectionType type -); - -/** Projects a spherical coordinate to a linear coordinate system - * - * @return psPlane* projected coordinate - */ -psPlane* psProject( - const psSphere* coord, ///< coordinate to project - const psProjection* projection ///< parameters of the projection -); - -/** Reverse projection of a linear coordinate to a spherical coordinate system - * - * @return psPlane* projected coordinate - */ -psSphere* psDeproject( - const psPlane* coord, ///< coordinate to project - const psProjection* projection ///< parameters of the projection -); - -/** Determines the offset (RA,Dec) on the sky between two positions. - * - * Both an offset mode and an offset unit may be defined. The mode may be - * either PS_SPHERICAL, in which case the specified offset corresponds to an - * offset in angles, or it may be PS_LINEAR, in which case the offset - * corresponds to a linear offset in a local projection. The offset unit may - * be in one of PS_ARCSEC, PS_ARCMIN, PS_DEGREE, and PS_RADIAN, which - * specifies the units of the offset only. - * - * @return psSphere* the offset between position1 and position2 - */ -psSphere* psSphereGetOffset( - const psSphere* position1, ///< first position for calculating offset - const psSphere* position2, ///< second position for calculating offset - psSphereOffsetMode mode, ///< type of offset can be PS_SPHERICAL or PS_LINEAR - psSphereOffsetUnit unit ///< specifies the units of offset only -); - -/** Applies the given offset to a coordinate. - * - * Both an offset mode and an offset unit may be defined. The mode may be - * either PS_SPHERICAL, in which case the specified offset corresponds to an - * offset in angles, or it may be PS_LINEAR, in which case the offset - * corresponds to a linear offset in a local projection. The offset unit may - * be in one of PS_ARCSEC, PS_ARCMIN, PS_DEGREE, and PS_RADIAN, which - * specifies the units of the offset only. - * - * @return psSphere* the original position with the given offset applied. - */ -psSphere* psSphereSetOffset( - const psSphere* position, ///< coordinate of origin - const psSphere* offset, ///< coordinate of offset to apply - psSphereOffsetMode mode, ///< corresponds to an offset in angles or local projection - psSphereOffsetUnit unit ///< specifies the units of offset only -); - -/** Generates the complete spherical rotation to account for precession - * between two times. The equinoxes shall be Julian equinoxes. - * - * @return psSphere* the resulting spherical rotation - */ -psSphere* psSpherePrecess( - psSphere *coords, ///< coordinates (modified in-place) - const psTime *fromTime, ///< equinox of coords input - const psTime *toTime ///< equinox of coords output -); - -/** Takes a given transform and inverts it linearly if possible. - * - * @return psPlaneTransform - * the linearly inverted transform -*/ -psPlaneTransform *p_psPlaneTransformLinearInvert( - psPlaneTransform *transform ///< transform to invert -); - - -/** Takes a transform and tests whether or not it is a linear projection. - * - * @return psS32 - * the order of the projection -*/ -psS32 p_psIsProjectionLinear( - psPlaneTransform *transform ///< transform to test for linearity -); - -/** inverts a given transformation. - * - * It may assume that the input transformation is one-to-one, and that the - * inverse transformation may be specified through using polynomials of the - * same type and order as the forward transformation. In the event that the - * input transformation is linear, an exact solution may be calculated; - * otherwise nSamples samples in each axis, covering the region specified by - * region shall be used as a grid to fit the best inverse transformation. The - * function shall return NULL if it was unable to generate the inverse - * transformation; otherwise it shall return the inverse transformation. In - * the event that out is NULL, a new psPlaneTransform shall be allocated and - * returned. - * - * @return psPlaneTransform* the resulting inverted transform - */ -psPlaneTransform* psPlaneTransformInvert( - psPlaneTransform *out, ///< a transform to recycle, or NULL if one is to be created. - const psPlaneTransform *in, ///< transform to invert - psRegion region, ///< region to fit for non-linear transform inversion - int nSamples ///< number of samples in each axis for fit -); - -/** Creates a single transformation that has the effect of performing trans1 - * followed by trans2. - * - * psPlaneTransformCombine takes two transformations (trans1 and trans2) and - * returns a single transformation that has the effect of performing trans1 - * followed by trans2. In the event that the input transformation is linear, - * an exact solution may be calculated; otherwise nSamples samples in each - * axis, covering the region specified by region shall be used as a grid to - * fit the best inverse transformation. The function shall return NULL if it - * was unable to generate the transformation; otherwise it shall return the - * transformation. - * - * @return psPlaneTransform* resulting transformation - */ -psPlaneTransform* psPlaneTransformCombine( - psPlaneTransform *out, ///< a transform to recycle, or NULL if one is to be created. - const psPlaneTransform *trans1, ///< first transform to combine - const psPlaneTransform *trans2, ///< first transform to combine - psRegion region, ///< region to cover (for non-linear transforms) - int nSamples ///< number of samples on each axis (for non-linear transforms) -); - - -/** takes two arrays containing matched coordinates and returns the - * best-fitting transformation. - * - * psPlaneTransformFit takes two arrays containing matched coordinates (i.e., - * coordinates in the source array correspond to the coordinates in the dest - * array) and returns the best-fitting transformation. The source and dest - * will contain psCoords. In the event that the number of coordinates in each - * is not identical, the function shall generate a warning, and extra - * coordinates in the longer of the two shall be ignored. The trans transform - * may not be NULL, since it specifies the desired order, polynomial type and - * any polynomial terms to mask. nRejIter rejection iterations shall be - * performed, wherein coordinates lying more than sigmaClip standard - * deviations from the fit shall be rejected. - * - * @return bool TRUE if successful, otherwise FALSE. - */ -bool psPlaneTransformFit( - psPlaneTransform *trans, - const psArray *source, - const psArray *dest, - int nRejIter, - float sigmaClip -); -//XXX: need to add doxygen comments on the parameters above. -rdd - -/// @} - -#endif // #ifndef PS_COORD_H Index: unk/psLib/src/astronomy/psPhotometry.h =================================================================== --- /trunk/psLib/src/astronomy/psPhotometry.h (revision 4545) +++ (revision ) @@ -1,74 +1,0 @@ -/** @file psPhotometry.h -* -* @brief Contains basic photometric structures. -* -* This file defines the basic photometric structures. -* -* @ingroup Photometry -* -* @author GLG, MHPCC -* -* XXX: There is no code associated with this header file. Perhaps we should -* incorporate it into psAstrometry.h -* -* @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#ifndef PS_PHOTOMETRIC_H -#define PS_PHOTOMETRIC_H - -#include "psType.h" -#include "psFunctions.h" - -/// @addtogroup Photometry -/// @{ - -/** The photometric system description - * - * The photometric system is defined by the psPhotSystem structure. A - * photometric system is identified by a human-readable name (ie, SDSS.g, - * Landolt92.B, GPC1.OTA32.r). Each photometric system is given a unique - * identifier ID. Observations taken with a specific camera, detector, and - * filter represent their own photometric system, and it may be necessary to - * perform transformations between these systems. Photometric systems - * associated with observations from a specific camera/ detector/filter - * combination can be associated with those components. - * - */ - -typedef struct -{ - const psS32 ID; ///< ID number for this photometric system - const char *name; ///< Name of photometric system - const char *camera; ///< Camera for photometric system - const char *filter; ///< Filter used for photometric system - const char *detector; ///< Detector used for photometric system -} -psPhotSystem; - -/** Photometric system transformation - * - * This structure defines the transformation between two photometric systems. - * - */ - -typedef struct -{ - const psPhotSystem src; ///< Source photometric system - const psPhotSystem dst; ///< Destination photometric system - const psPhotSystem pP; ///< Primary color reference - const psPhotSystem pM; ///< Primary color reference - const psPhotSystem sP; ///< Secondary color reference - const psPhotSystem sM; ///< Secondary color reference - psF32 pA; ///< Color offset for references - psF32 sA; ///< Color offset for references - psPolynomial3D transform; ///< Transformation from source to destination -} -psPhotTransform; - -/// @} - -#endif // #ifndef PS_PHOTOMETRIC_H Index: unk/psLib/src/astronomy/psTime.c =================================================================== --- /trunk/psLib/src/astronomy/psTime.c (revision 4545) +++ (revision ) @@ -1,1598 +1,0 @@ -/** @file psTime.c - * - * @brief Definitions for time, time utilities, and conversion functions for use with psLib astronomy - * functions. - * - * A collection of functions are required by psLib to manipulate time data. These functions primarily consist - * of conversions between specific time formats. They use the UNIX timeval time system as the - * base upon which International Atomic Time (TAI) and Universal Time Coordinated (UTC) are calculated. - * - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.66 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-12 19:12:00 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include -#include -#include -#include - -#include "psTime.h" -#include "psError.h" -#include "psLogMsg.h" -#include "psMemory.h" -#include "psAbort.h" -#include "psImage.h" -#include "psCoord.h" -#include "psString.h" -#include "psMetadata.h" -#include "psMetadataIO.h" -#include "psLookupTable.h" -#include "psConstants.h" -#include "psAstronomyErrors.h" - -#include "config.h" - -#define MAX_STRING_LENGTH 256 - -/** Sidereal angular conversion from seconds to radians for GMST in seconds (i.e. pi/(180*240)) */ -#define S2R (7.272205216643039903848711535369e-5) - -/** Two times pi with double precision accuracy */ -#define TWOPI (2.0*M_PI) - -/** Conversion from radians to degrees */ -#define R2DEG = (180.0/M_PI) - - /** Maximum length of time string */ - #define MAX_TIME_STRING_LENGTH 256 - - /** Seconds per minute */ - #define SEC_PER_MINUTE 60.0 - - /** Seconds per hour */ - #define SEC_PER_HOUR (60.0*SEC_PER_MINUTE) - - /** Seconds per day */ - #define SEC_PER_DAY (24.0*SEC_PER_HOUR) - - /** Seconds per year */ - #define SEC_PER_YEAR (365.0*SEC_PER_DAY) - - /** Microseconds per day */ - #define NSEC_PER_DAY 86400000000000.0 - - /** Time metadata read from config file */ - static psMetadata *timeMetadata = NULL; - -// Offset to convert terrestrial time(TT) to international atomic time(TAI) -#define TAI_TT_OFFSET_SECONDS 32 -#define TAI_TT_OFFSET_NANOSECONDS 184000000 - -// Offset from converting to MJD -#define MJD_EPOCH_OFFSET 40587.0 - -// Offset for converting to JD -#define JD_EPOCH_OFFSET 2440587.5 - -// Offset of year 0000 from epoch -#define YEAR_0000_SEC -62125920000.0 - -// Offset of year 9999 from epoch -#define YEAR_9999_SEC 253202544000.0 - -/** Static function prototypes */ -static char *cleanString(char *inString, int sLen); -static char* getToken(char **inString, char *delimiter, psParseErrorType *status); -static psF64 searchTables(psF64 index, psU64 column, char *metadataTableNames[], - psU32 nTables, psLookupStatusType* status); -static psTime* convertTimeTAIUTC(psTime* time); -static psTime* convertTimeUTCTAI(psTime* time); -static psTime* convertTimeTAITT(psTime* time); -static psTime* convertTimeTTTAI(psTime* time); -static psTime* convertTimeUTCUT1(psTime* time); - -/** Removes leading and trailing whitespace and # characters from a string. The cleaned string is a new null - * terminated copy of the original input string. */ -static char *cleanString(char *inString, int sLen) -{ - char *ptrB = NULL; - char *ptrE = NULL; - char *cleaned = NULL; - - ptrB = inString; - - // Skip over leading # or whitespace - while (isspace(*ptrB) || *ptrB=='#') { - ptrB++; - } - - // Skip over trailing whitespace, null terminators, and # characters - ptrE = inString + sLen - 1; - while(isspace(*ptrE) || *ptrE=='\0' || *ptrE=='#') { - ptrE--; - } - - // Length, sLen, does not include '\0' - sLen = ptrE - ptrB + 1; - - // Adds '\0' to end of string and +1 to sLen - cleaned = psStringNCopy(ptrB, sLen); - - return cleaned; -} - -/** Returns cleaned token based on delimiter, but not including delimiter. Also changes the pointer location - * the beginning of the string. Tokens are newly allocated null terminated strings. */ -static char* getToken(char **inString, char *delimiter, psParseErrorType *status) -{ - char *cleanToken = NULL; - int sLen = 0; - - // Skip over leading whitespace - while(isspace(**inString)) { - (*inString)++; - } - - // Length of token, not including delimiter - sLen = strcspn(*inString, delimiter); - - if(sLen) { - - // Create new, cleaned, and null terminated token - cleanToken = cleanString(*inString, sLen); - - // Move to end of token - (*inString) += (sLen+1); - - } else if(**inString!='\0' && sLen==0) { - *status = PS_PARSE_ERROR_GENERAL; - } - - return cleanToken; -} - -// get the psTime.config filename by checking environment variable first, then original installation area. -char* p_psGetConfigFileName() -{ - char* filename = getenv("PS_CONFIG_FILE"); - - if (filename == NULL) { // environment variable not found - filename = PS_CONFIG_FILE_DEFAULT; // this should come from configure.ac - } - - return filename; -} - - -// Searches time tables in priority order and performs interpolation if input index value is within a table. -// If the index value is out of range, the status is set accordingly. -static psF64 searchTables(psF64 index, psU64 column, char *metadataTableNames[], - psU32 nTables, psLookupStatusType* status) -{ - char* tableName = NULL; - psF64 result = NAN; - psLookupTable* table = NULL; - psMetadataItem* tableMetadataItem = NULL; - - // Check time metadata. Function call reports errors. - if(timeMetadata == NULL) { - if(!p_psTimeInit(p_psGetConfigFileName())) - *status = PS_LOOKUP_ERROR; - return NAN; - } - - // Search each table in priority order: daily, eopc,finals - for(psS32 i = 0; i < nTables; i++) { - - // Get table name from list of tables to search - tableName = metadataTableNames[i]; - - // Lookup table name in time metadata - tableMetadataItem = psMetadataLookup(timeMetadata, tableName); - - // Check if table not a metadata item - if(tableMetadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - tableName); - *status = PS_LOOKUP_ERROR; - return NAN; - } - - // Get table from metadata - table = (psLookupTable*)tableMetadataItem->data.V; - - // Check that table is not NULL - PS_ASSERT_PTR_NON_NULL(table,NAN); - - // Check if index within to/from range - if(index >= table->validFrom ) { - if(index <= table->validTo) { - // Attempt to interpolate table - result = psLookupTableInterpolate(table, index, column); - *status = PS_LOOKUP_SUCCESS; - if(!isnan(result)) { - break; - } - } else { - *status = PS_LOOKUP_PAST_BOTTOM; - } - } else { - *status = PS_LOOKUP_PAST_TOP; - } - } - - return result; -} - -bool p_psTimeInit(const char *fileName) -{ - psS32 numLines = 0; - bool foundTable = false; - char *tableDir = NULL; - char *tableNames = NULL; - char *tableFormats = NULL; - char *namesPtr = NULL; - char *formatPtr = NULL; - char *metadataNamesPtr = NULL; - char *tableName = NULL; - char *tableFormat = NULL; - char *fullTableName = NULL; - psS32 i = 0; - psS32 j = 0; - psS32 numTables = 0; - psU32 nFail = 0; - psVector *tablesFrom = NULL; - psVector *tablesTo = NULL; - psVector *tablesIndex = NULL; - psMetadataItem *metadataItem = NULL; - psLookupTable *table = NULL; - psParseErrorType status = PS_PARSE_SUCCESS; - char metadataTableNames[4][MAX_STRING_LENGTH] = {"daily", "eopc", "finals", "tai"}; - - // Read time config file - timeMetadata = psMetadataConfigParse(timeMetadata, &nFail, fileName, true); - if(timeMetadata == NULL) { - return false; - } else if(nFail != 0) { - return false; - } - - // Get number of tables - metadataItem = psMetadataLookup(timeMetadata, "psLib.time.tables.n"); - if(metadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.tables.n"); - return false; - } - numTables = (psS32)metadataItem->data.S32; - - // Get lower range of tables - metadataItem = psMetadataLookup(timeMetadata, "psLib.time.tables.from"); - if(metadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.tables.from"); - return false; - } - tablesFrom = psVectorCopy(tablesFrom, metadataItem->data.V, PS_TYPE_F64); - if(tablesFrom->n != numTables) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_BAD_VECTOR, tablesFrom->n, numTables); - psFree(tablesFrom); - return false; - } - - // Get upper range of tables - metadataItem = psMetadataLookup(timeMetadata, "psLib.time.tables.to"); - if(metadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.tables.to"); - psFree(tablesFrom); - return false; - } - tablesTo = psVectorCopy(tablesTo, metadataItem->data.V, PS_TYPE_F64); - if(tablesTo->n != numTables) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_BAD_VECTOR, tablesTo->n, numTables); - psFree(tablesFrom); - psFree(tablesTo); - return false; - } - - // Get index columns for the tables - metadataItem = psMetadataLookup(timeMetadata, "psLib.time.tables.index"); - if(metadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.tables.index"); - psFree(tablesFrom); - psFree(tablesTo); - return false; - } - tablesIndex = psVectorCopy(tablesIndex, metadataItem->data.V, PS_TYPE_S32); - if(tablesIndex->n != numTables) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,PS_ERRORTEXT_psTime_BAD_VECTOR,tablesIndex->n,numTables); - psFree(tablesFrom); - psFree(tablesTo); - psFree(tablesIndex); - return false; - } - - // Get path to time data files - metadataItem = psMetadataLookup(timeMetadata, "psLib.time.tables.dir"); - if(metadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.tables.dir"); - psFree(tablesFrom); - psFree(tablesTo); - psFree(tablesIndex); - return false; - } - tableDir = psStringCopy(metadataItem->data.V); - - // Table file names - metadataItem = psMetadataLookup(timeMetadata, "psLib.time.tables.files"); - if(metadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.tables.files"); - - psFree(tablesFrom); - psFree(tablesTo); - psFree(tablesIndex); - psFree(tableDir); - return false; - } - tableNames = psStringCopy(metadataItem->data.V); - - // Get table format strings - metadataItem = psMetadataLookup(timeMetadata, "psLib.time.tables.format"); - if(metadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.tables.format"); - psFree(tablesFrom); - psFree(tablesTo); - psFree(tablesIndex); - psFree(tableDir); - psFree(tableNames); - return false; - } - tableFormats = psStringCopy(metadataItem->data.V); - formatPtr = tableFormats; - - // Read time tables - namesPtr = tableNames; - while((tableName=getToken(&namesPtr, " ", &status)) != NULL) { - - // Form path with table name, adding one to length for last '/' that may not occur - // in string in cong file - fullTableName = (char*)psAlloc(strlen(tableDir)+strlen(tableName)+1+1); - - // Old strings may come back from psAlloc(), so set initial position to EOL - fullTableName[0]='\0'; - strcat(fullTableName, tableDir); - strcat(fullTableName, "/"); - strcat(fullTableName, tableName); - - // Get table format - tableFormat = getToken(&formatPtr,",",&status); - if(tableFormat == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.tables.format"); - } - - // Create and read table - if(i < numTables) { - table = psLookupTableAlloc(fullTableName, (const char*)tableFormat, tablesIndex->data.S32[i]); - numLines = psLookupTableRead(table); - } else { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_BAD_TABLE_COUNT, i+1, numTables); - } - - // Place tables into metadata slightly altered names as keys to create consistent naming conventions - foundTable = false; - for(j=0; jsec = 0; - outTime->nsec = 0; - outTime->type = type; - outTime->leapsecond = false; - - return outTime; -} - -psTime* psTimeGetNow(psTimeType type) -{ - struct timeval now; - psTime *time = NULL; - - // Allocate psTime struct - time = psTimeAlloc(type); - - // Verify time structure allocated - if(time == NULL) { - return NULL; - } - - // Get the system time - if (gettimeofday(&now, (struct timezone *)0) == -1) { - psError(PS_ERR_OS_CALL_FAILED, true, - PS_ERRORTEXT_psTime_GET_TOD_FAILED); - return NULL; - } - - // Convert timeval time to psTime - time->sec = now.tv_sec; - time->nsec = now.tv_usec*1000; - - // Add most leapseconds to UTC time to get TAI time if necessary - if(type == PS_TIME_TAI) { - time->sec += p_psTimeGetTAIDelta(time); - } - - return time; -} - -static psTime* convertTimeTAIUTC(psTime* time) -{ - psF64 deltaTAI = 0.0; - psS64 deltaSec = 0; - psU32 deltaNsec = 0; - psF64 deltaUTC = 0.0; - - // Determine delta to convert between UTC and TAI - deltaTAI = p_psTimeGetTAIDelta(time); - deltaSec = (psS64)(deltaTAI); - deltaNsec = (psU32)((deltaTAI - (psF64)deltaSec) * 1e9); - - // Determine seconds - time->sec -= deltaSec; - - // Check for underflow in nsec - if(deltaNsec > time->nsec) { - // Borrow second - time->nsec += 1e9; - time->sec--; - } - - // Determine nsec - time->nsec -= deltaNsec; - - // Check for overflow in nsec - if(time->nsec >= 1e9) { - time->nsec -= 1e9; - time->sec++; - } - - // Set new type - time->type = PS_TIME_UTC; - - // Check if leapsecond present in delta - deltaUTC = p_psTimeGetTAIDelta(time); - if(fabs(deltaTAI-deltaUTC) >= 1.0) { - time->sec++; - } - - return time; -} - -static psTime* convertTimeUTCTAI(psTime* time) -{ - psF64 delta = 0.0; - psS64 deltaSec = 0; - psU32 deltaNsec = 0; - - // Determine delta to convert between UTC and TAI - delta = p_psTimeGetTAIDelta(time); - - deltaSec = (psS64)(delta); - deltaNsec = (psU32)((delta - (psF64)deltaSec) * 1e9); - - // Determine seconds - time->sec += deltaSec; - - // Determine nsec - time->nsec += deltaNsec; - - // Check for overflow in nsec - if(time->nsec >= 1e9) { - time->nsec -= 1e9; - time->sec++; - } - - // Set new type - time->type = PS_TIME_TAI; - - return time; -} - -static psTime* convertTimeTAITT(psTime* time) -{ - // Add TT offset - time->sec += TAI_TT_OFFSET_SECONDS; - time->nsec += TAI_TT_OFFSET_NANOSECONDS; - - // Check for overflow in nsec - if(time->nsec >= 1e9) { - time->nsec -= 1e9; - time->sec++; - } - - // Set new type - time->type = PS_TIME_TT; - - return time; -} - -static psTime* convertTimeTTTAI(psTime* time) -{ - // Subtract TT offset - time->sec -= TAI_TT_OFFSET_SECONDS; - - // Check for nsec underflow - if(TAI_TT_OFFSET_NANOSECONDS > time->nsec) { - // Borrow second - time->sec--; - time->nsec += 1e9; - } - time->nsec -= TAI_TT_OFFSET_NANOSECONDS; - - // Check for overflow in nsec - if(time->nsec >= 1e9) { - time->nsec -= 1e9; - time->sec++; - } - - // Set new type - time->type = PS_TIME_TAI; - - return time; -} - -static psTime* convertTimeUTCUT1(psTime* time) -{ - psS64 ut1utc = 0; - - // Get UT1-UTC value - ut1utc = (psS64)(psTimeGetUT1Delta(time,PS_IERS_A) * 1e9); - - // Since UTC is within 0.9 sec of UT1 then nsec member is the member affected - if((ut1utc < 0) && (abs(ut1utc) > time->nsec)) { - // Borrow from sec - time->sec--; - if(time->leapsecond) { - time->leapsecond = false; - } else { - time->leapsecond = psTimeIsLeapSecond(time); - } - // Add to nsec - time->nsec += 1e9; - } - time->nsec += ut1utc; - - // Check for overflow in nsec - if(time->nsec >= 1e9) { - time->nsec -= 1e9; - time->sec++; - if(time->leapsecond) { - time->leapsecond = false; - time->sec--; - } else { - time->leapsecond = psTimeIsLeapSecond(time); - } - } - - // Set new type - time->type = PS_TIME_UT1; - - return time; -} - -psTime* psTimeConvert(psTime *time, psTimeType type) -{ - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NULL); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),time); - - // If the input type is UT1 then return time and generate error message - if(time->type == PS_TIME_UT1) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,"Cannot convert from UT1 time type"); - return time; - } - - // If the time to convert to is the same as psTime the return time - if (time->type == type) { - return time; - } - - // Convert from TAI to UTC, TT, UT1 - if(time->type == PS_TIME_TAI) { - // Convert from TAI to UTC - if(type == PS_TIME_UTC) { - time = convertTimeTAIUTC(time); - // Convert from TAI to TT - } else if(type == PS_TIME_TT) { - time = convertTimeTAITT(time); - // Convert from TAI to UT1 - } else if(type == PS_TIME_UT1) { - // Convert to UTC first - time = convertTimeTAIUTC(time); - // Convert UTC to UT1 - time = convertTimeUTCUT1(time); - // Convert from TAI to unknown time type - } else { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_TYPE_UNKNOWN, type); - } - // Convert from TT to TAI, UTC, UT1 - } else if(time->type == PS_TIME_TT) { - // Convert from TT to UTC - if(type == PS_TIME_UTC) { - // Convert to TAI time first - time = convertTimeTTTAI(time); - // Convert from TAI to UTC - time = convertTimeTAIUTC(time); - // Convert from TT to TAI - } else if(type == PS_TIME_TAI) { - time = convertTimeTTTAI(time); - // Convert from TT to UT1 - } else if(type == PS_TIME_UT1) { - // Convert to UTC first - // Convert to TAI time first - time = convertTimeTTTAI(time); - // Convert from TAI to UTC - time = convertTimeTAIUTC(time); - // Convert from UTC to UT1 - time = convertTimeUTCUT1(time); - // Convert from TT to unknown time type - } else { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_TYPE_UNKNOWN, type); - } - // Convert from UTC to TAI, TT, UT1 - } else if(time->type == PS_TIME_UTC) { - // Convert UTC to TAI - if(type == PS_TIME_TAI) { - time = convertTimeUTCTAI(time); - // Convert UTC to TT - } else if(type == PS_TIME_TT) { - // Convert to TAI time first - time = convertTimeUTCTAI(time); - // Convert TAI to TT - time = convertTimeTAITT(time); - // Convert UTC to UT1 - } else if(type == PS_TIME_UT1) { - time = convertTimeUTCUT1(time); - // Convert UTC to unknown time type - } else { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_TYPE_UNKNOWN, type); - } - // Convert unknown time type - } else { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_TYPE_UNKNOWN, time->type); - } - - return time; -} - -double psTimeToLMST(psTime *time, double longitude) -{ - psF64 jdTdtDays = 0.0; - psF64 jdUt1Days = 0.0; - psF64 mjdUt1Days = 0.0; - psF64 lmstRad = 0.0; - psF64 fracDays = 0.0; - psF64 gmstRad = 0.0; - psF64 t = 0.0; - psF64 tu = 0.0; - psF64 const1 = 24110.5493771; - psF64 const2 = 8639877.3173760; - psF64 const3 = 307.4771600; - psF64 const4 = 0.0931118; - psF64 const5 = -0.0000062; - psF64 const6 = 0.0000013; - psTime *tdtTime = NULL; - psTime *ut1Time = NULL; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NAN); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),NAN); - - // Verify input time is not in UT1 seconds - if(time->type == PS_TIME_UT1) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,PS_ERRORTEXT_psTime_TYPE_INCORRECT,time->type); - return NAN; - } - - // Determine time reference to TT - tdtTime = psTimeAlloc(time->type); - tdtTime->sec = time->sec; - tdtTime->nsec = time->nsec; - tdtTime->leapsecond = time->leapsecond; - tdtTime = psTimeConvert(tdtTime,PS_TIME_TT); - - // Determine time reference to UT1 - ut1Time = psTimeAlloc(time->type); - ut1Time->sec = time->sec; - ut1Time->nsec = time->nsec; - ut1Time->leapsecond = time->leapsecond; - ut1Time = psTimeConvert(ut1Time,PS_TIME_UT1); - - // Calculate UT1 as Julian Centuries since J2000.0 - jdUt1Days = psTimeToJD(ut1Time); - mjdUt1Days = psTimeToMJD(ut1Time); - t = (jdUt1Days - 2451545.0)/36525.0; - - // Calculate TDT as Julian centuries since J2000.0 - jdTdtDays = psTimeToJD(tdtTime); - tu = (jdTdtDays - 2451545.0)/36525.0; - - // Calculate fractional part of MJD - fracDays = fmod(mjdUt1Days, 1.0); - - // Calculate Greenwich Mean Sidereal Time (GMST) in radians. - // Equation set up to minimize multiplications. - gmstRad = fracDays*TWOPI - + (const1+const2*tu+t*(const3+t*(const4+t*(const5+const6*t))))*S2R; - - // Place GMST between 0 and 2*pi - gmstRad = fmod(gmstRad, TWOPI); - - // Calculate Local Mean Sidereal Time (LMST) in radians - lmstRad = gmstRad + longitude; - - // Free temporary structs - psFree(ut1Time); - psFree(tdtTime); - - return lmstRad; -} - -double psTimeGetUT1Delta(const psTime *time, psTimeBulletin bulletin) -{ - psU32 nTables = 2; - psF64 mjd = 0.0; - psF64 result = 0.0; - psU64 tableColumn = 0; - psF64 dut2ut1 = 0.0; - psF64 t = 0.0; - psVector* dut = NULL; - psMetadataItem* tableMetadataItem = NULL; - psLookupStatusType status = PS_LOOKUP_SUCCESS; - char* metadataTableNames[2] = {"dailyTable", "finalsTable"}; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NAN); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),NAN); - - // Check for invalid bulletin specified - if((bulletin != PS_IERS_A) && (bulletin != PS_IERS_B)) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,"Invalid bulletin specified %d",bulletin); - return NAN; - } - - // Set lookup table column based on Bullentin - if(bulletin == PS_IERS_A) { - tableColumn = 3; - } else { - tableColumn = 6; - } - - // Attempt to find value through table lookup and interpolation - mjd = psTimeToMJD(time); - result = searchTables(mjd,tableColumn,metadataTableNames,nTables,&status); - - // Value could not be found through table lookup and interpolation - if(status == PS_LOOKUP_PAST_TOP) { - - // Date too early for tables. Get default time delta value from metadata, and issue warning. - psLogMsg(__func__,PS_LOG_WARN,PS_ERRORTEXT_psTime_TIME_PREDATES_TABLES,mjd,"UT1-UTC"); - - // Lookup value from time metadata loaded from psTime.config - tableMetadataItem = psMetadataLookup(timeMetadata, "psLib.time.before.dut"); - if(tableMetadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.before.dut"); - return NAN; - } - result = tableMetadataItem->data.F64; - - } else if(status == PS_LOOKUP_PAST_BOTTOM) { - /* Date too late for tables. Issue warning and use following formulae for predicting - ahead of the most recent available table entry. - ut1-utc = [0] + [1]*(MJD - [2]) - (ut2-ut1) - [0, 1, 2] = @psLib.time.predict.dut - ut2-ut1 = 0.022 sin(2*pi*t) - 0.012 cos(2*pi*t) - 0.006 sin(4*pi*t) + 0.007 cos(4*pi*t) - t = 2000.0 + (MJD - 51544.03)/365.2422 - */ - // Generate warning of postdate information - psLogMsg(__func__,PS_LOG_WARN,PS_ERRORTEXT_psTime_TIME_POSTDATES_TABLES, mjd, "UT1-UTC"); - - // Lookup values to calculate prediction - tableMetadataItem = psMetadataLookup(timeMetadata, "psLib.time.predict.dut"); - if(tableMetadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.predict.dut"); - return NAN; - } - dut = (psVector*)tableMetadataItem->data.V; - PS_ASSERT_PTR_NON_NULL(dut,NAN); - - // Calculate predication of future UT1-UTC - t = 2000.0 + (mjd - 51544.03)/365.2422; - dut2ut1 = 0.022*sin(TWOPI*t) - 0.012*cos(TWOPI*t) - 0.006*sin(4.0*M_PI*t) + 0.007*cos(4.0*M_PI*t); - result = dut->data.F64[0] + dut->data.F64[1]*(mjd - dut->data.F64[2]) - dut2ut1; - - } else if(status != PS_LOOKUP_SUCCESS) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_INTERPOLATION_FAILED); - return NAN; - } - - return result; -} - -psSphere* p_psTimeGetPoleCoords(const psTime* time) -{ - psU32 nTables = 3; - psF64 x = 0.0; - psF64 y = 0.0; - psF64 mjd = 0.0; - psF64 a = 0.0; - psF64 c = 0.0; - psF64 mjdPred = 0.0; - psSphere* output = NULL; - psLookupStatusType xStatus = PS_LOOKUP_SUCCESS; - psLookupStatusType yStatus = PS_LOOKUP_SUCCESS; - psMetadataItem *tableMetadataItem = NULL; - char *metadataTableNames[3] = {"dailyTable", "eopcTable", "finalsTable"}; - psVector *xp = NULL; - psVector *yp = NULL; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NULL); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),NULL); - - if(time->type != PS_TIME_TAI) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_TYPE_INCORRECT, time->type); - return NULL; - } - - // Attempt to find value through table lookup and interpolation - mjd = psTimeToMJD(time); - // x = searchTables(mjd, 0, &xStatus, metadataTableNames, nTables); - x = searchTables(mjd, 0, metadataTableNames, nTables,&xStatus); - // y = searchTables(mjd, 0, &yStatus, metadataTableNames, nTables); - y = searchTables(mjd, 0, metadataTableNames, nTables,&yStatus); - - // Value could not be found through table lookup and interpolation - if(xStatus==PS_LOOKUP_PAST_TOP && yStatus==PS_LOOKUP_PAST_TOP) { - - // Date too earlier for tables. Get default polar coodinate values from metadata, and issue warning. - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_TIME_PREDATES_TABLES, mjd, "polar motion"); - - tableMetadataItem = psMetadataLookup(timeMetadata, "psLib.time.before.xp"); - if(tableMetadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, "psLib.time.before.xp"); - return NULL; - } - x = tableMetadataItem->data.F64; - - tableMetadataItem = psMetadataLookup(timeMetadata, "psLib.time.before.yp"); - if(tableMetadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, "psLib.time.before.yp"); - return NULL; - } - y = tableMetadataItem->data.F64; - - } else if(xStatus==PS_LOOKUP_PAST_BOTTOM && yStatus==PS_LOOKUP_PAST_BOTTOM) { - - /* Date too late for tables. Issue warning and use following formulae for predicting - ahead of the most recent available table entry. - x = [0] + [1]*cos a + [2]*sin a + [3]*cos c + [4]*sin c - [0], [1], [2], [3] = @psLib.time.predict.xp - y = [0] + [1]*cos a + [2]*sin a + [3]*cos c + [4]*sin c - [0], [1], [2], [3] = @psLib.time.predict.yp - a = 2*pi*(mjd - pslib.time.predict.mjd)/365.25 - c = 2*pi*(mjd - pslib.time.predict.mjd)/435.0 - */ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_TIME_POSTDATES_TABLES, mjd, "polar motion"); - - // Get predicted MJD - tableMetadataItem = psMetadataLookup(timeMetadata, "psLib.time.predict.mjd"); - if(tableMetadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, - "psLib.time.predict.mjd"); - return NULL; - } - mjdPred = tableMetadataItem->data.F64; - - // Get xp - tableMetadataItem = psMetadataLookup(timeMetadata, "psLib.time.predict.xp"); - if(tableMetadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, "psLib.time.predict.xp"); - return NULL; - } - xp = (psVector*)tableMetadataItem->data.V; - PS_ASSERT_PTR_NON_NULL(xp,NULL); - - // Get yp - tableMetadataItem = psMetadataLookup(timeMetadata, "psLib.time.predict.yp"); - if(tableMetadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, "psLib.time.predict.yp"); - return NULL; - } - yp = (psVector*)tableMetadataItem->data.V; - PS_ASSERT_PTR_NON_NULL(yp,NULL); - - // Calculate "a" and "c" constants - a = TWOPI*(mjd - mjdPred)/365.25; - c = TWOPI*(mjd - mjdPred)/435.0; - - // Calculate x and y polar coordinates - x = xp->data.F64[0] + - xp->data.F64[1]*cos(a) + - xp->data.F64[2]*sin(a) + - xp->data.F64[3]*cos(c) + - xp->data.F64[4]*sin(c); - - y = yp->data.F64[0] + - yp->data.F64[1]*cos(a) + - yp->data.F64[2]*sin(a) + - yp->data.F64[3]*cos(c) + - yp->data.F64[4]*sin(c); - - } else if(xStatus!=PS_LOOKUP_SUCCESS || yStatus!=PS_LOOKUP_SUCCESS) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_INTERPOLATION_FAILED); - return NULL; - } - - // Create output sphere and convert arcsec to radians (i.e. x/60/60*PS_PI/180) - output = psAlloc(sizeof(psSphere)); - output->r = x * M_PI / 648000.0; - output->d = y * M_PI / 648000.0; - - return output; -} - -psF64 p_psTimeGetTAIDelta(const psTime *time) -{ - psF64 jd = 0.0; - psF64 mjd = 0.0; - psF64 out = 0.0; - psF64 const1 = 0.0; - psF64 const2 = 0.0; - psF64 const3 = 0.0; - psLookupTable* table = NULL; - psMetadataItem *tableMetadataItem = NULL; - psVector *results = NULL; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NAN); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),NAN); - - // Check time metadata - if(timeMetadata == NULL) { - if(!p_psTimeInit(p_psGetConfigFileName())) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_FILE_NOT_FOUND, "psTime.config"); - return 0.0; - } - } - - // Get table from metadata - tableMetadataItem = psMetadataLookup(timeMetadata, "taiTable"); - if(tableMetadataItem == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_LOOKUP_METADATA_FAILED, "taiTable"); - return 0.0; - } - table = (psLookupTable*)tableMetadataItem->data.V; - PS_ASSERT_PTR_NON_NULL(table,0); - - // Determine Julian and modified Julian dates used in table lookup and time delta calculation - jd = psTimeToJD(time); - mjd = psTimeToMJD(time); - - // Set ceiling of the julian date to the last entry in the lookup table - if(table->validTo < jd) { - jd = table->validTo; - } - - // Interpolation of look up table - results = psLookupTableInterpolateAll(table, jd); - - // Check for successful interpolation - if(results == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_INTERPOLATION_FAILED); - } - - // Set constants from table - const1 = results->data.F64[1]; - const2 = results->data.F64[2]; - const3 = results->data.F64[3]; - - // If const3 not equal to zero solve for difference else floor of const1 - if(fabs(const3-0.0) > FLT_EPSILON) { - out = const1 + (mjd - const2) * const3; - } else { - out = floor(const1); - } - - psFree(results); - - return out; -} - -long psTimeLeapSecondDelta(const psTime *time1, const psTime *time2) -{ - psS64 diff = 0; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time1,0); - PS_ASSERT_PTR_NON_NULL(time2,0); - PS_ASSERT_INT_WITHIN_RANGE(time1->nsec,0,(psU32)((1e9)-1),0); - PS_ASSERT_INT_WITHIN_RANGE(time2->nsec,0,(psU32)((1e9)-1),0); - diff = abs((psS64)p_psTimeGetTAIDelta((psTime*)time1)-(psS64)p_psTimeGetTAIDelta((psTime*)time2)); - - return diff; -} - -bool psTimeIsLeapSecond(const psTime* utc) -{ - psTime* prevUtc = NULL; - psBool returnValue = false; - - // Check for valid time - PS_ASSERT_PTR_NON_NULL(utc,false); - - // Verify time is UTC type - if(utc->type != PS_TIME_UTC) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,PS_ERRORTEXT_psTime_TYPE_INCORRECT,utc->type); - return false; - } - - // Allocate time to hold utc - 1 second - prevUtc = psTimeAlloc(PS_TIME_UTC); - prevUtc->sec = utc->sec - 1; - - // Check the absolute difference between the two times for leapsecond - if(psTimeLeapSecondDelta(utc,prevUtc) >= 1.0) { - returnValue = true; - } else { - returnValue = false; - } - - // Free prevUtc - psFree(prevUtc); - - return returnValue; -} - -double psTimeToJD(const psTime *time) -{ - psF64 jd = NAN; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NAN); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),NAN); - - // Julian date conversion - if(time->sec < 0) { - // psTime earlier than epoch - jd = time->sec / SEC_PER_DAY - time->nsec / NSEC_PER_DAY + JD_EPOCH_OFFSET; - } else { - // psTime greater than epoch - jd = time->sec / SEC_PER_DAY + time->nsec / NSEC_PER_DAY + JD_EPOCH_OFFSET; - } - - return jd; -} - -double psTimeToMJD(const psTime *time) -{ - psF64 mjd = NAN; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NAN); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),NAN); - - // Modified Julian date conversion - if(time->sec < 0) { - // psTime earlier than epoch - mjd = time->sec / SEC_PER_DAY - time->nsec / NSEC_PER_DAY + MJD_EPOCH_OFFSET; - } else { - // psTime greater than epoch - mjd = time->sec / SEC_PER_DAY + time->nsec / NSEC_PER_DAY + MJD_EPOCH_OFFSET; - } - - return mjd; -} - -psString psTimeToISO(const psTime *time) -{ - psS32 ds = 0; - char *timeString = NULL; - char *tempString = NULL; - struct tm *tmTime = NULL; - time_t sec; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NULL); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),NULL); - - // Check valid year range - PS_ASSERT_LONG_WITHIN_RANGE(time->sec,YEAR_0000_SEC,YEAR_9999_SEC,NULL) - - // Allocate temp strings - tempString = psAlloc(MAX_TIME_STRING_LENGTH); - timeString = psAlloc(MAX_TIME_STRING_LENGTH); - - // Convert nanoseconds to decaseconds - ds = time->nsec / 100000000; - sec = time->sec; - - // If leapsecond use previous day - if(time->leapsecond) { - sec--; - } - - // tmTime variable is statically allocated, no need to free - tmTime = gmtime(&sec); - - // Converts psTime to YYYY-MM-DDThh:mm:ss.sss in string form - if (!strftime(tempString, MAX_TIME_STRING_LENGTH, "%Y-%m-%dT%H:%M:%S", tmTime)) { - psError(PS_ERR_OS_CALL_FAILED, true, PS_ERRORTEXT_psTime_CONVERT_TIME_TO_STRING_FAILED); - } - - // Check if time is UTC and leapsecond - if(((time->type==PS_TIME_UTC)||(time->type==PS_TIME_UT1)) && (time->leapsecond)) { - // Modify second to be 60 - tempString[17] = '6'; - tempString[18] = '0'; - } - - // Create string with milliseconds - if (snprintf(timeString, MAX_TIME_STRING_LENGTH, "%s,%1dZ", tempString, ds) < 0) { - psError(PS_ERR_OS_CALL_FAILED, true, PS_ERRORTEXT_psTime_APPEND_MSEC_FAILED); - } - psFree(tempString); - - return timeString; -} - -struct timeval* psTimeToTimeval(const psTime *time) -{ - struct timeval *timevalTime = NULL; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NULL); - PS_ASSERT_INT_WITHIN_RANGE(time->sec,0,INT32_MAX,NULL); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),NULL); - - // Allocate structure timeval - timevalTime = (struct timeval*)psAlloc(sizeof(struct timeval)); - - // Set structure members - timevalTime->tv_sec = time->sec; - timevalTime->tv_usec = time->nsec / 1000; - - return timevalTime; -} - -/* -struct tm* p_psTimeToTM(const psTime *time) -{ - psS64 cent = 0; - psS64 year = 0; - psS64 month = 0; - psS64 day = 0; - psS64 hour = 0; - psS64 minute = 0; - psS64 seconds = 0; - psS64 temp = 0; - struct tm* tmTime = NULL; - - - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NULL); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),NULL); - - seconds = time->sec%60; - minute = time->sec/60%60; - hour = time->sec/3600%24; - day = (time->sec+62135596800)/86400; - - // Add 306 days to make relative to Mar 1, 0; also adjust day to be within a range (1..2**28-1) where our - // calculations will work with 32bit ints - if(day > (pow(2, 28)-307)) - { - temp = (day - 146097+306)/146097+1; // Avoid overflow if day close to maxint - day -= temp * 146097-306; - } else if((day += 306) <= 0) - { - temp = -( -day / 146097 + 1); // Avoid ambiguity in C division of negatives - day -= temp * 146097; - } - - cent = (day*4-1)/146097; // Calc number of centuries day is after 29 Feb of yr 0 - day -= cent*146097/4; // 4 centuries = 146097 days - year = (day*4-1)/1461; // Calc number of years into the century - day -= year*1461/4; // Again March-based (4 yrs =\u02dc 146[01] days) - month = (day*12+1093)/367; // Get the month (3..14 represent March through - day -= (month*367-1094)/12; // February of following year) - year += cent*100+temp*400; // Get the real year, which is off by - - // One if month is January or February - if(month > 12) - { - year++; - month -= 12; - } - - // Allocate output - tmTime = (struct tm*)psAlloc(sizeof(struct tm)); - - tmTime->tm_year = year - 1900; - tmTime->tm_mon = month - 1; - tmTime->tm_mday = day + 1; - tmTime->tm_hour = hour; - tmTime->tm_min = minute; - tmTime->tm_sec = seconds; - tmTime->tm_isdst = -1; - - return tmTime; -} -*/ - -psTime* psTimeFromJD(double jd) -{ - psF64 days = 0.0; - psF64 seconds = 0.0; - psTime *outTime = NULL; - - // Allocate psTime struct - outTime = psTimeAlloc(PS_TIME_TAI); - - // Julian date conversion courtesy of Eugene Magnier - days = jd - 2440587.5; - seconds = days * SEC_PER_DAY; - if(seconds < 0.0) { - outTime->nsec = (seconds - (psS64)seconds) * -1000000000.0; // psTime earlier than epoch - } else { - outTime->nsec = (seconds - (psS64)seconds) * 1000000000.0; // psTime greater than epoch - } - outTime->sec = seconds; - - // Error check - PS_ASSERT_INT_WITHIN_RANGE(outTime->nsec,0,(psU32)((1e9)-1),outTime); - - return outTime; -} - -psTime* psTimeFromMJD(double mjd) -{ - psF64 days = 0.0; - psF64 seconds = 0.0; - psTime *outTime = NULL; - - // Allocate psTime struct - outTime = psTimeAlloc(PS_TIME_TAI); - - // Modified Julian date conversion courtesy of Eugene Magnier - days = mjd - 40587.0; - seconds = days * SEC_PER_DAY; - - if(seconds < 0.0) { - outTime->nsec = (seconds - (psS64)seconds) * -1000000000.0; // psTime earlier than epoch - } else { - outTime->nsec = (seconds - (psS64)seconds) * 1000000000.0; // psTime greater than epoch - } - outTime->sec = seconds; - - // Error check - PS_ASSERT_INT_WITHIN_RANGE(outTime->nsec,0,(psU32)((1e9)-1),NULL); - - return outTime; -} - -psTime* psTimeFromISO(const char *input) -{ - psS32 millisecond; - struct tm tmTime; - psTime *outTime = NULL; - - // Check for NULL string - PS_ASSERT_PTR_NON_NULL(input,NULL); - - // Convert YYYY-MM-DDThh:mm:ss.sss in string form to tm time - if (sscanf(input, "%d-%d-%dT%d:%d:%d,%d", &tmTime.tm_year, &tmTime.tm_mon, &tmTime.tm_mday, - &tmTime.tm_hour, &tmTime.tm_min, &tmTime.tm_sec,&millisecond) < 7) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psTime_ISOTIME_MALFORMED, input); - return NULL; - } - - PS_ASSERT_INT_NONNEGATIVE(tmTime.tm_year, outTime); - PS_ASSERT_INT_WITHIN_RANGE(tmTime.tm_mon,1,12,outTime); - PS_ASSERT_INT_WITHIN_RANGE(tmTime.tm_mday,1,31,outTime); - PS_ASSERT_INT_WITHIN_RANGE(tmTime.tm_hour,0,23,outTime); - PS_ASSERT_INT_WITHIN_RANGE(tmTime.tm_min,0,59,outTime); - PS_ASSERT_INT_WITHIN_RANGE(tmTime.tm_sec,0,59,outTime); - PS_ASSERT_INT_WITHIN_RANGE(millisecond,0,999,outTime); - - tmTime.tm_year -= 1900; - tmTime.tm_mon--; - tmTime.tm_isdst = -1; - - // Convert tm time to psTime - outTime = p_psTimeFromTM(&tmTime); - outTime->nsec = millisecond * 1000000; - - return outTime; -} - -psTime* psTimeFromTT(psS64 sec, psU32 nsec) -{ - psTime* outTime = NULL; - - // Verify nsec within range - PS_ASSERT_INT_WITHIN_RANGE(nsec,0,(psU32)((1e9)-1),NULL); - - // Allocate psTime data - outTime = psTimeAlloc(PS_TIME_TT); - - // Set data members - outTime->sec = sec; - outTime->nsec = nsec; - - // Return data structure - return outTime; -} - -psTime* psTimeFromUTC(psS64 sec, psU32 nsec, bool leapsecond) -{ - psTime* outTime = NULL; - - // Verify nsec within range - PS_ASSERT_INT_WITHIN_RANGE(nsec,0,(psU32)((1e9)-1),NULL); - - // Allocate psTime data - outTime = psTimeAlloc(PS_TIME_UTC); - - // Set data members - outTime->sec = sec; - outTime->nsec = nsec; - - // Set leapsecond flag if necessary - outTime->leapsecond = psTimeIsLeapSecond(outTime); - - return outTime; -} - -psTime* psTimeFromTimeval(const struct timeval *input) -{ - psTime *outTime = NULL; - - - // Error check - PS_ASSERT_PTR_NON_NULL(input,NULL); - - // Allocate psTime struct - outTime = psTimeAlloc(PS_TIME_TAI); - - // Convert to psTime - outTime->sec = input->tv_sec; - outTime->nsec = input->tv_usec * 1000; - - // Error check - PS_ASSERT_INT_WITHIN_RANGE(outTime->nsec,0,(psU32)((1e9)-1),outTime); - - return outTime; -} - -psTime* p_psTimeFromTM(const struct tm* time) -{ - psS64 year; - psS64 month; - psS64 day; - psS64 hour; - psS64 minute; - psS64 seconds; - psS64 temp; - psTime *outTime = NULL; - - // Error check - PS_ASSERT_PTR_NON_NULL(time,NULL); - - // Allocate psTime struct - outTime = psTimeAlloc(PS_TIME_TAI); - - // Extract data from TM struct - year = time->tm_year + 1900; - month = time->tm_mon + 1; - day = time->tm_mday; - hour = time->tm_hour; - minute = time->tm_min; - seconds = time->tm_sec; - - // Make month in range 3..14 (treat Jan & Feb as months 13..14 of prev year) - if( month <= 2 ) - { - temp = (14 - month) / 12; - // year -= (temp = (14 - month) / 12); - year -= temp; - month += 12 * temp; - } else if(month > 14) - { - temp = (month - 3) / 12; - // year += (temp = (month - 3) / 12); - year += temp; - month -= 12 * temp; - } - - // Make year positive - if (year < 0 ) - { - day -= 146097 * (temp = (399 - year) / 400); - year += 400 * temp; - } - - // Add day of month, days of previous 0-11 month period that began w/March, days of previous 0-399 year - // period that began w/March of a 400-multiple year), days of any 400-year periods before that, and 306 - // days to adjust from Mar 1, year 0-relative to Jan 1, year 1-relative. Add hours, minutes, and seconds. - day += (month * 367 - 1094) / 12 + year % 100 * 1461 / 4 + (year/100 * 36524 + year/400) - 306; - outTime->sec = (((day - 1) * SEC_PER_DAY) - 62135596800) + hour*SEC_PER_HOUR - + minute*SEC_PER_MINUTE + seconds; - - // C's TM does not define a microsecond field. Microseconds must be manipulated by calling function. - outTime->nsec = 0; - - // Error check - PS_ASSERT_INT_WITHIN_RANGE(outTime->nsec,0,(psU32)((1e9)-1),outTime); - - return outTime; -} - -psTime* psTimeMath(const psTime *time, double delta) -{ - psF64 sec = 0.0; - psTime *outTime = NULL; - psTime *tempTime = NULL; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time,NULL); - PS_ASSERT_INT_WITHIN_RANGE(time->nsec,0,(psU32)((1e9)-1),NULL); - - // Convert time to TAI if necessary, but without changing input arguments - if(time->type == PS_TIME_UTC) { - tempTime = psTimeAlloc(PS_TIME_UTC); - tempTime->sec = time->sec; - tempTime->nsec = time->nsec; - tempTime = psTimeConvert(tempTime, PS_TIME_TAI); - outTime = psTimeAlloc(PS_TIME_TAI); - } else { - tempTime = psMemIncrRefCounter((psTime*)time); - outTime = psTimeAlloc(time->type); - } - - // Create output time - sec = delta + (psF64)tempTime->sec + (psF64)tempTime->nsec/1e9; - PS_ASSERT_LONG_WITHIN_RANGE((psS64)sec,0,PS_MAX_S64,outTime); - outTime->sec = (psS64)sec; - outTime->nsec = (psU32)((sec - (psF64)outTime->sec)*1e9); - - // Error check - PS_ASSERT_INT_WITHIN_RANGE(outTime->nsec,0,(psU32)((1e9)-1),outTime); - - // Convert result to same time type as input - if(time->type == PS_TIME_UTC) { - outTime = psTimeConvert(outTime, PS_TIME_UTC); - } - - psFree(tempTime); - - return outTime; -} - -double psTimeDelta(const psTime *time1, const psTime *time2) -{ - psF64 out = 0.0; - psF64 uSec1 = 0.0; - psF64 uSec2 = 0.0; - psTime *tempTime1 = NULL; - psTime *tempTime2 = NULL; - - // Error checks - PS_ASSERT_PTR_NON_NULL(time1,0.0); - PS_ASSERT_INT_WITHIN_RANGE(time1->nsec,0,(psU32)((1e9)-1),0.0); - PS_ASSERT_PTR_NON_NULL(time2,0.0); - PS_ASSERT_INT_WITHIN_RANGE(time2->nsec,0,(psU32)((1e9)-1),0.0); - - // Verify both times of the same type - if(time1->type != time2->type) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,PS_ERRORTEXT_psTime_TYPE_INCORRECT,time1->type); - return out; - } - - // Convert time to TAI if necessary, but without changing input arguments - if(time1->type == PS_TIME_UTC) { - tempTime1 = psTimeAlloc(PS_TIME_UTC); - tempTime1->sec = time1->sec; - tempTime1->nsec = time1->nsec; - tempTime1 = psTimeConvert(tempTime1, PS_TIME_TAI); - } else { - tempTime1 = psMemIncrRefCounter((psTime*)time1); - } - if(time2->type == PS_TIME_UTC) { - tempTime2 = psTimeAlloc(PS_TIME_UTC); - tempTime2->sec = time2->sec; - tempTime2->nsec = time2->nsec; - tempTime2 = psTimeConvert(tempTime2, PS_TIME_TAI); - } else { - tempTime2 = psMemIncrRefCounter((psTime*)time2); - } - - uSec1 = tempTime1->sec >= 0 ? 1.0 : -1.0; - uSec1 = uSec1*tempTime1->nsec/1e9; - uSec2 = tempTime2->sec >= 0 ? 1.0 : -1.0; - uSec2 = uSec2*tempTime2->nsec/1e9; - out = (tempTime1->sec-tempTime2->sec) + (uSec1-uSec2); - - psFree(tempTime1); - psFree(tempTime2); - - return out; -} - Index: unk/psLib/src/astronomy/psTime.h =================================================================== --- /trunk/psLib/src/astronomy/psTime.h (revision 4545) +++ (revision ) @@ -1,349 +1,0 @@ -/** @file psTime.h - * - * @brief Definitions for time, time utilities, and conversion functions for use - * with psLib astronomy functions. - * - * A collection of functions are required by psLib to manipulate time data. These - * functions primarily consist of conversions between specific time formats. They - * use the UNIX timeval time system as the base upon which International Atomic - * Time (TAI) and Universal Time Coordinated (UTC) are calculated. - * - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.34 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-12 19:12:00 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PSTIME_H -#define PSTIME_H - -#include -#include -#include - -#include "psType.h" -// N.B. inclusion of psCoord.h was done to after the typedefs to handle cross-dependency of typedefs - -/// @addtogroup Time -/// @{ - -/** Time type. - * - * Enumeration for psTime types, TAI or UTC time. - */ -typedef enum { - PS_TIME_TAI, ///< Temps Atomique International (TAI) time (time with leapseconds) - PS_TIME_UTC, ///< Universal Time Coordinated (UTC) time (time without leapseconds) - PS_TIME_UT1, ///< Universal Time corrected for polar motion - PS_TIME_TT, ///< Terrestrial Time -} psTimeType; - -/** Time Bulletin type - * - * Enumeration for psTimeBulletin type, A or B. - */ -typedef enum { - PS_IERS_A, ///< IERS Bulletin A - PS_IERS_B, ///< IERS Bulletin B -} psTimeBulletin; - -/** Definition of psTime. - * - * The psTime struct is used by psLib to represent time values critical to - * astronomical calculations. This structure represents a time which is - * equivalent to TAI (International Atomic Time) and is measured in both - * seconds and microseconds. - */ -typedef struct psTime -{ - psS64 sec; ///< Seconds since epoch, Jan 1, 1970. - psU32 nsec; ///< Nanoseconds since last second. - psBool leapsecond; ///< if time falls on UTC leapsecond - psTimeType type; ///< Type of time. -} -psTime; - -#include "psCoord.h" -#include "psImage.h" - -/** Initialize time data. - * - * Reads config and data files associated with various time conversions. - * - * @return bool: True for success, false for failure. - */ -psBool p_psTimeInit( - const char *fileName ///< File name containing config/data info -); - -/** Free memory persistant time data. - * - * Frees time data to be held in memory until the end of successful program execution. - * - * @return void: void. - */ -psBool p_psTimeFinalize(void); - -/** Allocate time struct. - * - * Allocates an empty time struct. User must specify the psTimeType - * (PS_TIME_TAI or PS_TIME_UTC) in the argument. The seconds and microseconds members - * of the struct are set to zero. - * - * @return psTime*: Struct with empty time. - */ -psTime* psTimeAlloc( - psTimeType type ///< Type of time to create (UTC or TAI). -); - -/** Get current time. - * - * Gets current time from the system clock. User must specify the psTimeType - * (PS_TIME_TAI or PS_TIME_UTC) in the argument. - * - * @return psTime*: Struct with current time. - */ -psTime* psTimeGetNow( - psTimeType type ///< Type of time to get (UTC or TAI). -); - -/** Convert psTime to UTC or TAI time. - * - * Converts psTime to UTC or TAI time based on the psTimeType argument. - * - * @return psTime*: Pointer to psTime. - */ -psTime* psTimeConvert( - psTime *time, ///< Time to be converted. - psTimeType type ///< Type to be converted to. -); - -/** Convert psTime to Local Mean Sidereal Time (LMST). - * - * Converts psTime at the given longitude to LMST time. If the input time is not - * in UTC format, then it is converted. - * - * @return double: LST Time. - */ -double psTimeToLMST( - psTime *time, ///< psTime to be converted. - double longitude ///< Longitude. -); - -/** Determine UT1 - UTC from table lookup. - * - * This function is necessary to for various SLALIB functions. - * - * @return double: Time difference. - */ -double psTimeGetUT1Delta( - const psTime *time, ///< psTime to be looked up. - psTimeBulletin bulletin ///< IERS bulletin to use -); - -/** Determine TAI - UTC from table lookup. - * - * This function is necessary to for various psTime functions. - * - * @return psF64: Time difference. - */ -psF64 p_psTimeGetTAIDelta( - const psTime *time ///< psTime to be looked up. -); - -/** Determine polar coordinates at a given time. - * - * Determines the orientation of the polar axis at the given time. - * - * @return psSphere*: Spherical coordinates of Earth's polar axias. - */ -psSphere* p_psTimeGetPoleCoords( - const psTime *time ///< psTime determine polar orientation. -); - -/** Calculate the number of leapseconds between two times. - * - * Calculates the number of leapseconds between two times. - * - * @return long: leapseconds added between given times - */ -long psTimeLeapSecondDelta( - const psTime* time1, ///< First input time. - const psTime* time2 ///< Second input time. -); - -/** Determine if UTC time is a leapsecond. - * - * Determines if the specified UTC time is a valid leapsecond. - * - * @return bool: valid leap second - */ -bool psTimeIsLeapSecond( - const psTime* utc ///< UTC to verify if leap second -); - -/** Convert psTime to Julian date time. - * - * Converts psTime to Julian date (JD) time. This function does not add or - * subtract leapseconds. - * - * @return double: Julian Date (JD) time. - */ -double psTimeToJD( - const psTime* time ///< Input time to be converted. -); -/** Convert psTime to modified Julian date time. - * - * Converts psTime to modified Julian date (MJD) time. This function does not - * add or subtract leapseconds. - * - * @return double: Modified Julian Days (MJD) time. - */ -double psTimeToMJD( - const psTime* time ///< Input time to be converted. -); - -/** Convert psTime to ISO8601 formatted string. - * - * Converts psTime to a null terminated string in the form of YYYY-MM-DDThh:mm:ss.sss. - * This function does not add or subtract leapseconds. - * - * @return psString: Pointer null terminated array of chars in ISO time. - */ -psString psTimeToISO( - const psTime* time ///< Input time to be converted. -); - -/** Convert psTime to timeval time. - * - * Converts psTime to timeval time. This function does not add or subtract leapseconds. - * - * @return timeval*: timeval struct time. - */ -struct timeval* psTimeToTimeval( - const psTime* time ///< Input time to be converted. - ); - -/* - * Convert psTime to tm time. - * - * Converts psTime to tm time. This function is based on a Perl algorithm availble - * in the Pan-STARRS Image processing Algorithm Design Description (ADD). This function - * does not add or subtract leapseconds. - * - * @return tm: tm struct time. - * -struct tm* p_psTimeToTM( - const psTime *time ///< Input time to be converted. - ); -*/ -/** Convert JD to psTime. - * - * Converts JD time to psTime. This function does not add or subtract leapseconds. - * - * @return psTime: time. - */ -psTime* psTimeFromJD( - double jd ///< Input time to be converted. -); - -/** Convert MJD to psTime. - * - * Converts MJD time to psTime. This function does not add or subtract leapseconds. - * - * @return psTime: time. - */ -psTime* psTimeFromMJD( - double mjd ///< Input time to be converted. -); - -/** Convert ISO to psTime. - * - * Converts ISO time to psTime. This function does not add or subtract leapseconds. - * - * @return psTime*: time - */ -psTime* psTimeFromISO( - const char* input ///< Input time to be converted. -); - -/** Convert timeval to psTime. - * - * Converts timeval time to psTime. This function does not add or subtract leapseconds. - * - * @return psTime*: time. - */ -psTime* psTimeFromTimeval( - const struct timeval *input ///< Input time to be converted. -); - -/** Convert Terrestrial Time to psTime - * - * Converts Terrestial Time to psTime. This function assumes resultant time is of type TT. - * - * @return psTime*: time (TT) - */ -psTime* psTimeFromTT( - psS64 sec, ///< Input terrestrial time in seconds - psU32 nsec ///< Input terrestrial time fraction of seconds (nanoseconds) -); - -/** Convert UTC time to psTime - * - * Converts UTC time to psTime. It will verify if time specified is a leapsecond. - * - * @return psTime*: time (UTC)time - */ -psTime* psTimeFromUTC( - psS64 sec, ///< Input time in seconds - psU32 nsec, ///< Input time fraction of seconds (nanoseconds) - bool leapsecond ///< Input time is a leapsecond -); - -/** Convert tm time to psTime. - * - * Converts tm time to psTime. This function is based on a Perl algorithm availble - * in the Pan-STARRS Image processing Algorithm Design Description (ADD). This function - * does not add or subtract leapseconds. - * - * @return psTime*: time. - */ -psTime* p_psTimeFromTM( - const struct tm *time ///< Input time to be converted. -); - -/** Adds delta to time. Result is in TAI time. - * - * Adds delta to time. Input time is converted to TAI format if necessary. - * - * @return psTime*: time. - */ -psTime* psTimeMath( - const psTime *time, ///< Time. - double delta ///< Time delta. -); - -/** Determine difference between two times. Result is in TAI time. - * - * Determine difference between two times. Input times are converted to TAI format if necessary. - * - * @return double: Time difference. - */ -double psTimeDelta( - const psTime *time1, ///< First time. - const psTime *time2 ///< Second time. -); - -/** Get the filename of the psLib configuration file. - * - * @return char* If a PS_CONFIG_FILE environment variable exists, - * that is returned, otherwise the default location - * dependent on the installation location. - */ -char* p_psGetConfigFileName(); - -/// @} - -#endif // #ifndef PSTIME_H Index: unk/psLib/src/collections/.cvsignore =================================================================== --- /trunk/psLib/src/collections/.cvsignore (revision 4545) +++ (revision ) @@ -1,7 +1,0 @@ -Makefile.in -.deps -.libs -Makefile -*.lo -*.la - Index: unk/psLib/src/collections/Makefile.am =================================================================== --- /trunk/psLib/src/collections/Makefile.am (revision 4545) +++ (revision ) @@ -1,44 +1,0 @@ -#Makefile for collections functions of psLib -# - -INCLUDES = \ - -I$(top_srcdir)/src/astronomy \ - -I$(top_srcdir)/src/dataManip \ - -I$(top_srcdir)/src/dataIO \ - -I$(top_srcdir)/src/image \ - -I$(top_srcdir)/src/sysUtils \ - $(all_includes) - -noinst_LTLIBRARIES = libpslibcollections.la - -libpslibcollections_la_SOURCES = \ - psBitSet.c \ - psVector.c \ - psPixels.c \ - psList.c \ - psScalar.c \ - psCompare.c \ - psArray.c \ - psHash.c \ - psMetadata.c \ - psMetadataIO.c - -BUILT_SOURCES = psCollectionsErrors.h -EXTRA_DIST = psCollectionsErrors.dat psCollectionsErrors.h collections.i - -psCollectionsErrors.h:psCollectionsErrors.dat - $(top_srcdir)/src/psParseErrorCodes --data=$? $@ - -pslibincludedir = $(includedir) -pslibinclude_HEADERS = \ - psBitSet.h \ - psVector.h \ - psPixels.h \ - psList.h \ - psScalar.h \ - psCompare.h \ - psArray.h \ - psHash.h \ - psMetadata.h \ - psMetadataIO.h - Index: unk/psLib/src/collections/collections.i =================================================================== --- /trunk/psLib/src/collections/collections.i (revision 4545) +++ (revision ) @@ -1,9 +1,0 @@ -/* collections headers */ -%include "psArray.h" -%include "psBitSet.h" -%include "psCollectionsErrors.h" -%include "psCompare.h" -%include "psHash.h" -%include "psList.h" -%include "psScalar.h" -%include "psVector.h" Index: unk/psLib/src/collections/psArray.c =================================================================== --- /trunk/psLib/src/collections/psArray.c (revision 4545) +++ (revision ) @@ -1,207 +1,0 @@ - -/** @file psArray.c - * - * @brief Contains support for basic vector types - * - * This file defines the basic type for a vector struct and functions useful - * in manupulating vectors. - * - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.33 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -/******************************************************************************/ - -/* INCLUDE FILES */ - -/******************************************************************************/ -#include // for qsort, etc. -#include - -#include "psMemory.h" -#include "psError.h" -#include "psArray.h" -#include "psLogMsg.h" - -#include "psCollectionsErrors.h" - -/***************************************************************************** - FUNCTION IMPLEMENTATION - LOCAL - *****************************************************************************/ -static void arrayFree(psArray* psArr); - -static void arrayFree(psArray* psArr) -{ - if (psArr == NULL) { - return; - } - - psArrayElementFree(psArr); - - psFree(psArr->data); -} - -/***************************************************************************** - FUNCTION IMPLEMENTATION - PUBLIC - *****************************************************************************/ -psArray* psArrayAlloc(long nalloc) -{ - psArray* psArr = NULL; - - // Create vector struct - psArr = (psArray* ) psAlloc(sizeof(psArray)); - psMemSetDeallocator(psArr, (psFreeFunc) arrayFree); - - psArr->nalloc = nalloc; - psArr->n = nalloc; - - // Create vector data array - psArr->data = psAlloc(nalloc * sizeof(psPtr)); - - return psArr; -} - -psArray* psArrayRealloc(psArray* in, long nalloc) -{ - if (in == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL,true,PS_ERRORTEXT_psArray_REALLOC_NULL); - return NULL; - } else if (in->nalloc != nalloc) { // No need to realloc to same size - if (nalloc < in->n) { - for (psS32 i = nalloc; i < in->n; i++) { // For reduction in vector size - psFree(in->data[i]); - } - in->n = nalloc; - } - // Realloc after decrementation to avoid accessing freed array elements - in->data = psRealloc(in->data, nalloc * sizeof(psPtr)); - in->nalloc = nalloc; - } - - return in; -} - -psArray* psArrayAdd(psArray* array, - long delta, - psPtr data) -{ - if (array == NULL) { - return array; - } - - int n = array->n; - - if (n >= array->nalloc) { - // array needs to be expanded to make room for more elements - int d = (delta > 0) ? delta : 10; // as spec'ed in SDRS. - array = psArrayRealloc(array, n+d); - } - - // add the element to the end of the array. - array->data[n] = psMemIncrRefCounter(data); - array->n = n+1; - - return array; -} - -bool psArrayRemove(psArray* array, - const psPtr data) -{ - bool success = false; - - if (array == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psArray_ARRAY_NULL); - return false; - } - - psS32 n = array->n; - psPtr* psArrData = array->data; - for (psS32 i = n-1; i >= 0; i--) { - if (psArrData[i] == data) { - memmove(&array->data[i],&array->data[i+1],(n-i-1)*sizeof(psPtr)); - n--; - success = true; - } - } - array->n = n; // reset the array size to indicate the removed item(s) - - return success; -} - -void psArrayElementFree(psArray* psArr) -{ - - if (psArr == NULL) { - return; - } - - for (psS32 i = 0; i < psArr->n; i++) { - psFree(psArr->data[i]); - psArr->data[i] = NULL; - } -} - -psArray* psArraySort(psArray* array, psComparePtrFunc func) -{ - if (array == NULL) { - return NULL; - } - - qsort(array->data, array->n, sizeof(psPtr), (int (*)(const void* , const void*))func); - - return array; -} - -/// Set an element in the array. -bool psArraySet(psArray* array, ///< input array to set element in - long position, ///< the element position to set - psPtr data) ///< the value to set it to -{ - if (array == NULL) - { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psArray_ARRAY_NULL); - return false; - } - - if (position >= array->nalloc) - { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psArray_POSITION_BEYOND_NALLOC, - position, array->nalloc); - return false; - } - - psFree(array->data[position]); - array->data[position] = data; - - return true; -} - -/// Get an element in the array. -psPtr psArrayGet(const psArray* array, long position ) -{ - if (array == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psArray_ARRAY_NULL); - return NULL; - } - - if (position >= array->nalloc) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psArray_POSITION_BEYOND_NALLOC, - position, array->nalloc); - return NULL; - } - - return array->data[position]; -} - - - - Index: unk/psLib/src/collections/psArray.h =================================================================== --- /trunk/psLib/src/collections/psArray.h (revision 4545) +++ (revision ) @@ -1,152 +1,0 @@ - -/** @file psArray.h - * - * @brief Contains basic array definitions and operations - * - * This file defines the basic type for a array struct and functions useful - * in manupulating arrays. - * - * @ingroup Array - * - * @author Robert DeSonia, MHPCC - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.28 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_ARRAY_H -#define PS_ARRAY_H - -#include "psType.h" -#include "psCompare.h" - -/// @addtogroup Array -/// @{ - -/** An array to support primitive types. - * - * Struct for maintaining an array of frequently used primitive types. - * - */ -typedef struct -{ - long nalloc; ///< Total number of elements available. - long n; ///< Number of elements in use. - psPtr* data; ///< An Array of pointer elements - void *lock; ///< Optional lock for thread safety -} -psArray; - -/*****************************************************************************/ - -/* FUNCTION PROTOTYPES */ - -/*****************************************************************************/ - -/** Allocate an array. - * - * Uses psLib memory allocation functions to create an array collection of - * data - * - * @return psArray* : Pointer to psArray. - * - */ -psArray* psArrayAlloc( - long nalloc ///< Total number of elements to make available. -) -; - -/** Reallocate an array. - * - * Uses psLib memory allocation functions to reallocate an array collection - * of data. - * - * @return psArray* : Pointer to psArray. - * - */ -psArray* psArrayRealloc( - psArray* array, ///< array to reallocate. - long nalloc ///< Total number of elements to make available. -); - -/** Add an element to the end the array, expanding the array storage if - * necessary. - * - * @return psArray* The array with the element added - */ -psArray* psArrayAdd( - psArray* array, ///< array to operate on - long delta, - ///< the amount to expand array, if necessary. If less than one, 10 will be used. - psPtr data ///< the data pointer to add to psArray -); - -/** Remove an element from the array - * - * Finds and removes the specified data pointer from the list. - * - * @return bool: TRUE if the specified data pointer was found and removed, - * otherwise FALSE. - * - */ -bool psArrayRemove( - psArray* array, ///< array to operate on - const psPtr data ///< the data pointer to remove from psArray -); - -/** Deallocate/Dereference elements of an array. - * - * Uses psLib memory allocation functions to deallocate/dereference elements - * of a array of void pointers. The array psArr is not freed, and its elements - * will all be set to NULL. - * - */ -void psArrayElementFree( - psArray* psArr ///< Void pointer array to destroy. -); - -/** Sort the array according to an external compare function. - * - * Sorts an array via the specification of a comparison function - * to specify how the objects on the array should be sorted. - * - * The comparison function must return an integer less than, equal to, or - * greater than zero if the first argument is considered to be respectively - * less than, equal to, or greater than the second. - * - * If two members compare as equal, their order in the sorted array is - * undefined. - * - * @return psArray* The sorted array. - */ -psArray* psArraySort( - psArray* array, ///< input array to sort. - psComparePtrFunc func ///< the compare function -); - -/** Set an element in the array. If the current element is non-NULL, the old - * element is freed. - * - * @return psBool TRUE if the element was set successfully, otherwise FALSE - */ -bool psArraySet( - psArray* array, ///< input array to set element in - long position, ///< the element position to set - psPtr data ///< the value to set it to -); - -/** Get an element from the array. - * - * @return void* the element at given position. - */ -psPtr psArrayGet( - const psArray* array, ///< input array to get element from - long position ///< the element position to get -); - -/// @} - -#endif // #ifndef PS_ARRAY_H Index: unk/psLib/src/collections/psBitSet.c =================================================================== --- /trunk/psLib/src/collections/psBitSet.c (revision 4545) +++ (revision ) @@ -1,295 +1,0 @@ -/** @file psBitSet.c - * - * @brief Creates an array of bytes of arbitrary length for storing individual bits. - * - * Bit masks are useful tools for toggling various flags and options. This set of functions module provides - * a mechanism to create an array of bits of arbitrary length and manipulate them with basic binary - * operations. A print function is also provided to display the entire set of bits in binary format as a - * string. - * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.27 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-25 02:02:05 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include -#include -#include - -#include "psBitSet.h" -#include "psMemory.h" -#include "psError.h" -#include "psAbort.h" -#include "psString.h" - -#include "psCollectionsErrors.h" - -enum { - UNKNOWN_OP, - AND_OP, - OR_OP, - XOR_OP, - NOT_OP -}; - -static void bitSetFree(psBitSet* inBitSet); - -/** Private function to create a mask. - * - * Creates an eight bit mask with the given bit set. All other bits in the byte are zero. The input bit uses - * zero-based indexing, and is the cumulitive index within the array, not the localized byte's bit position. - * - * @return char*: Pointer to byte in which bit is contained. - */ -static char mask(psS32 bit) -{ - char mask = (char)0x01; - - // Ignore splint warning about negative bit shifts - /* @i@ */ - mask = mask << (bit % 8); - - return mask; -} - -static void bitSetFree(psBitSet* inBitSet) -{ - if (inBitSet == NULL) { - return; - } - psFree(inBitSet->bits); -} - -psBitSet* psBitSetAlloc(long nalloc) -{ - psS32 numBytes = 0; - psBitSet* newObj = NULL; - - if (nalloc < 0) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psBitSet_ALLOC_NEG_SIZE, - nalloc); - return NULL; - } - - numBytes = ceil(nalloc / 8.0); - newObj = psAlloc(sizeof(psBitSet)); - psMemSetDeallocator(newObj, (psFreeFunc) bitSetFree); - newObj->n = numBytes; - - // Ignore splint warning about releasing pointer members, since they've not been allocated yet - /* @i@ */ - newObj->bits = psAlloc(sizeof(char) * numBytes); - - memset(newObj->bits, 0, numBytes); - - return newObj; -} - -psBitSet* psBitSetSet(psBitSet* bitSet, - long bit) -{ - char *byte = NULL; - - if (bitSet == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psBitSet_SET_NULL); - return bitSet; - } else if ( (bit < 0) || - (bit > bitSet->n * 8 - 1) ) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psBitSet_BIT_OUTOFRANGE, - bit,bitSet->n * 8 - 1); - return bitSet; - } - // Variable byte is the byte in the array that contains the bit to be set - byte = bitSet->bits + bit / 8; - *byte |= mask(bit); - - return bitSet; -} - -psBitSet* psBitSetClear(psBitSet* bitSet, - long bit) -{ - char *byte = NULL; - - if (bitSet == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psBitSet_SET_NULL); - return bitSet; - } else if ( (bit < 0) || - (bit > bitSet->n * 8 - 1) ) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psBitSet_BIT_OUTOFRANGE, - bit,bitSet->n * 8 - 1); - return bitSet; - } - // Variable byte is the byte in the array that contains the bit to be set - byte = bitSet->bits + bit / 8; - *byte &= ! mask(bit); - - return bitSet; -} - -bool psBitSetTest(const psBitSet* bitSet, - long bit) -{ - char *byte = NULL; - - if (bitSet == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psBitSet_SET_NULL); - return false; - } else if ( (bit < 0) || - (bit > bitSet->n * 8 - 1) ) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psBitSet_BIT_OUTOFRANGE, - bit,bitSet->n * 8 - 1); - return false; - } - - // Variable byte is the byte in the array that contains the bit to be tested - byte = bitSet->bits + bit / 8; - return ((*byte & mask(bit)) != 0); -} - -psBitSet* psBitSetOp(psBitSet* outBitSet, - const psBitSet* inBitSet1, - const char *operator, - const psBitSet* inBitSet2) -{ - psS32 i = 0; - psS32 n = 0; - char* outBits = NULL; - char* inBits1 = NULL; - char* inBits2 = NULL; - psS32 op = UNKNOWN_OP; - - if (inBitSet1 == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psBitSet_FIRST_OPERAND_NULL); - psFree(outBitSet); - return NULL; - } - inBits1 = inBitSet1->bits; - - if (operator == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psBitSet_OPERATOR_NULL); - psFree(outBitSet); - return NULL; - } - - // parse the operator - if (strcmp(operator,"AND")==0) { - op = AND_OP; - } else if (strcmp(operator,"OR")==0) { - op = OR_OP; - } else if (strcmp(operator,"XOR")==0) { - op = XOR_OP; - } else if (strcmp(operator,"NOT")==0) { - op = NOT_OP; - } else { - psFree(outBitSet); - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psBitSet_OPERATOR_INVALID, - operator); - return NULL; - } - - if (op != NOT_OP) { - if (inBitSet2 == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psBitSet_SECOND_OPERAND_NULL); - psFree(outBitSet); - return NULL; - } - - if (inBitSet1->n != inBitSet2->n) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psBitSet_OPERANDS_SIZE_DIFFER); - psFree(outBitSet); - return NULL; - } - inBits2 = inBitSet2->bits; - } - - if (outBitSet == NULL) { - outBitSet = psBitSetAlloc(inBitSet1->n*8); - } else if (outBitSet->n != inBitSet1->n) { - outBitSet->n = inBitSet1->n; - outBitSet->bits = psRealloc(outBitSet->bits, inBitSet1->n); - } - - n = outBitSet->n; - outBits = outBitSet->bits; - - switch (op) { - case AND_OP: - for (i = 0; i < n; i++) { - outBits[i] = inBits1[i] & inBits2[i]; - } - break; - case OR_OP: - for (i = 0; i < n; i++) { - outBits[i] = inBits1[i] | inBits2[i]; - } - break; - case XOR_OP: - for (i = 0; i < n; i++) { - outBits[i] = inBits1[i] ^ inBits2[i]; - } - break; - case NOT_OP: - for (i = 0; i < n; i++) { - outBits[i] = ~inBits1[i]; - } - break; - default: - psAbort("psBitSetOp", - "Unexpected error - operator parsed successfully but not valid?"); - } - - return outBitSet; -} - -psBitSet* psBitSetNot(psBitSet* outBitSet, - const psBitSet* inBitSet) -{ - if (inBitSet == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psBitSet_OPERAND_NULL); - psFree(outBitSet); - return NULL; - } - - outBitSet = psBitSetOp(outBitSet,inBitSet,"NOT",NULL); - - if (outBitSet == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psBitSet_NOT_OP_FAILED); - } - - return outBitSet; -} - -psString psBitSetToString(const psBitSet* bitSet) -{ - psS32 i = 0; - psS32 numBits = bitSet->n * 8; - char *outString = psAlloc((size_t) numBits + 1); - - for (i = 0; i < numBits; i++) { - outString[numBits - i - 1] = psBitSetTest(bitSet, i) ? '1' : '0'; - } - - outString[numBits] = 0; - - return outString; -} Index: unk/psLib/src/collections/psBitSet.h =================================================================== --- /trunk/psLib/src/collections/psBitSet.h (revision 4545) +++ (revision ) @@ -1,147 +1,0 @@ -/** @file psBitSet.h - * - * @brief Creates an array of bytes of arbitrary length for storing individual bits. - * - * Bit masks are useful tools for toggling various flags and options. This set of functions module provides - * a mechanism to create an array of bits of arbitrary length and manipulate them with basic binary - * operations. A print function is also provided to display the entire set of bits in binary format as a - * string. - * - * @ingroup BitSet - * - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.21 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PSBITSET_H -#define PSBITSET_H - -#include "psType.h" - -/// @addtogroup BitSet -/// @{ - -/******************************************************************************/ -/* TYPE DEFINITIONS */ -/******************************************************************************/ - -/** Struct containing array of bytes to hold bit data and corresponding array length. - * - * The bits in the struct are assembled in as an array of bytes with eight bits per byte. The bits are - * arranged with the LSB in first (right most) position of the first array element. - */ -typedef struct -{ - long n; ///< Number of bytes in the array - psU8 *bits; ///< Aray of bytes holding bits - void *lock; ///< Optional lock for thread safety -} -psBitSet; - -/*****************************************************************************/ -/* FUNCTION PROTOTYPES */ -/*****************************************************************************/ - -/** Allocate a psBitSet. - * - * Create a psBitSet with the number of bits specified by the user. All bits are set to zero upon - * allocation. - * - * @return psBitSet* : Pointer to struct containing array of bits and size of array. - */ - -/*@null@*/ -psBitSet* psBitSetAlloc( - long nalloc ///< Number of bits in psBitSet array -) -; - -/** Set a bit. - * - * Sets a bit at a given bit location. The bit is set based on a zero index with the - * first bit set in the zero bit slot of the zero element of the byte array. As an example, setting bit 3 in - * an array with two elements would result in an psBitSet that looks like 00000000 00001000. - * - * @return psBitSet* : Pointer to struct containing psBitSet. - */ -psBitSet* psBitSetSet( - /* @returned@ */ - psBitSet* bitSet, ///< Pointer to psBitSet to be set. - long bit ///< Bit to be set. -); - -/** Clear a bit. - * - * Clear a bit at a given bit location. The bit is cleared based on a zero - * index with the first bit set in the zero bit slot of the zero element of - * the byte array. - * - * @return psBitSet* : Pointer to struct containing psBitSet. - */ -psBitSet* psBitSetClear( - /* @returned@ */ - psBitSet* bitSet, ///< Pointer to psBitSet to be cleared. - long bit ///< Bit to be cleared. -); - -/** Test the value of a bit. - * - * Prints the value of a bit at a given bit location, either one or zero. The resulting bit is based on a - * zero index format with the first bit set in the zero bit slot of the zero element of the byte array - * As an example, testing bit 3 in a psBitSet with two bytes that looks like 00000000 00001000 would return a - * value of one, since that is the value that was set. - * - * @return int: Value of bit, either one or zero. - */ - -bool psBitSetTest( - const psBitSet* bitSet, ///< Pointer psBitSet to be tested. - long bit ///< Bit to be tested. -); - -/** Perform a binary operation on two psBitSets - * - * Perform an AND, OR, or XOR on two psBitSets. If the BitMasks are not the same size, the operation will not - * be performed and an error message will be logged. - * - * @return psBitSet* : Pointer to struct containing result of binary operation. - */ -psBitSet* psBitSetOp( - /* @returned@ */ - psBitSet* outBitSet, ///< Resulting psBitSet from binary operation - const psBitSet* inBitSet1, ///< First psBitSet on which to operate - const char *operator, ///< Bit operation - const psBitSet* inBitSet2 ///< First psBitSet on which to operate -); - -/** Perform a not operation on a psBitSet - * - * Toggles bits in a psBitset. All zero bits are set to one and all one bits are set to zero. - * - * @return psBitSet* : Pointer to struct containing result of operation. - */ - -psBitSet* psBitSetNot( - psBitSet* outBitSet, ///< Resulting psBitSet from operation - const psBitSet* inBitSet ///< Input psBitSet -); - -/** Convert the psBitSet to a string of ones and zeros. - * - * Converts the contents of a psBitSet to a string representation of its binary form of ones and zeros. The - * LSB is the right-most chracter. Each set of eight characters represents one byte. - * - * @return char*: Pointer to character array containing string data. - */ - -psString psBitSetToString( - const psBitSet* bitSet ///< psBitSet to convert */ -); - -/// @} - -#endif // #ifndef PSBITSET_H Index: unk/psLib/src/collections/psCollectionsErrors.dat =================================================================== --- /trunk/psLib/src/collections/psCollectionsErrors.dat (revision 4545) +++ (revision ) @@ -1,53 +1,0 @@ -# -# This file is used to generate psCollectionsErrors.h content -# -# Format is: -# ERRORNAME(one word) ERRORTEXT -# -# N.B. in code, the ERRORNAME appears as PS_ERRORTEXT_ERRORNAME -#################################################################### -# -psArray_REALLOC_NULL psArrayRealloc must be given a non-NULL psArray to resize. -psArray_ARRAY_NULL Specified psArray can not be NULL. -psArray_POSITION_BEYOND_NALLOC Specified position, %d, is greater than the allocated size of the array, %d. -# -psVector_REALLOC_NULL psVectorRealloc must a given a non-NULL psVector to resize. Desired datatype unknown. -psVector_NOT_A_VECTOR The input psVector must have a vector dimension type. -psVector_SORT_NULL psVectorSort can not sort a NULL psVector. -psVector_UNSUPPORTED_TYPE Input psVector is an unsupported type (0x%x). -psVector_NULL The input psVector can not be NULL. -psVector_EXTENDSIZE_NEG The input number of elements to extend must be non-negative. -# -psBitSet_ALLOC_NEG_SIZE The number of bit in a psBitSet (%d) must be greater than zero. -psBitSet_SET_NULL Can not operate on a NULL psBitSet. -psBitSet_BIT_OUTOFRANGE The specified bit position (%d) is invalid. Position must be between 0 and %d. -psBitSet_OPERATOR_NULL Specified operator is NULL. Must specify desired operator. -psBitSet_OPERATOR_INVALID Specified operator, %s, is invalid. Valid operators are AND, OR, and XOR. -psBitSet_FIRST_OPERAND_NULL First psBitSet operand can not be NULL. -psBitSet_SECOND_OPERAND_NULL Second psBitSet operand can not be NULL. -psBitSet_OPERANDS_SIZE_DIFFER The psBitSet operand must be the same size. -psBitSet_NOT_OP_FAILED Could not perform NOT operation. -psBitSet_OPERAND_NULL Operand can not be NULL. -# -psScalar_UNSUPPORTED_TYPE Specified datatype (%d) is unsupported by psScalar. -psScalar_COPY_NULL Can not copy a NULL psScalar. -# -psHash_KEY_NULL Input key can not be NULL. -psHash_TABLE_NULL Input psHash can not be NULL. -psHash_DATA_NULL Input data can not be NULL. -# -psList_LOCATION_INVALID Specified location, %d, is invalid. -psList_ITERATOR_INVALID Specified iterator is not valid. -psList_ITERATOR_NULL Specified iterator is NULL. -psList_ITERATOR_NONMUTABLE Specified iterator indicates list is non-mutable. -psList_LIST_NULL Specified psList reference is NULL. -psList_DATA_NULL Specified data item is NULL. -psList_DATA_NOT_FOUND Specified data item is not found in the psList. -# -psPixels_NULL Input psPixels can not be NULL. -psPixels_MASK_NULL Specified mask can not be NULL. -psPixels_MASK_TYPE Specified mask's type, %s, is invalid. Should be PS_TYPE_MASK. -psPixels_DATA_NULL Input psPixels contains no data. -psPixels_REGION_INVALID Specified psRegion, [%d:%d,%d:%d], does not specify a valid region. -psPixels_FAILED_IMAGE_CREATE Failed to create image of size %dx%d. - Index: unk/psLib/src/collections/psCollectionsErrors.h =================================================================== --- /trunk/psLib/src/collections/psCollectionsErrors.h (revision 4545) +++ (revision ) @@ -1,71 +1,0 @@ -/** @file psCollectionsErrors.h - * - * @brief Contains the error text for the collections functions - * - * @ingroup ErrorHandling - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-10 21:46:46 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_COLLECTIONS_ERRORS_H -#define PS_COLLECTIONS_ERRORS_H - -/* N.B., lines between '//~Start' and '//~End' are automatic generated from - * the template following the '//~Start'. The template is used to generate - * the other lines by, for each error text in psCollectionsErrors.dat, the following - * substitutions are made: - * $1 The error text macro name (first word in the psCollectionsErrors.dat lines) - * $2 The error text (rest of the line in psCollectionsErrors.dat) - * $n The order of the source line in psCollecitonsErrors.dat (comments excluded) - * - * DO NOT EDIT THE LINES BETWEEN //~Start and //~End! ANY CHANGES WILL BE OVERWRITTEN. - */ - -#define PS_ERRORNAME_DOMAIN "psLib.collections." - -//~Start #define PS_ERRORTEXT_$1 "$2" -#define PS_ERRORTEXT_psArray_REALLOC_NULL "psArrayRealloc must be given a non-NULL psArray to resize." -#define PS_ERRORTEXT_psArray_ARRAY_NULL "Specified psArray can not be NULL." -#define PS_ERRORTEXT_psArray_POSITION_BEYOND_NALLOC "Specified position, %d, is greater than the allocated size of the array, %d." -#define PS_ERRORTEXT_psVector_REALLOC_NULL "psVectorRealloc must a given a non-NULL psVector to resize. Desired datatype unknown." -#define PS_ERRORTEXT_psVector_NOT_A_VECTOR "The input psVector must have a vector dimension type." -#define PS_ERRORTEXT_psVector_SORT_NULL "psVectorSort can not sort a NULL psVector." -#define PS_ERRORTEXT_psVector_UNSUPPORTED_TYPE "Input psVector is an unsupported type (0x%x)." -#define PS_ERRORTEXT_psVector_NULL "The input psVector can not be NULL." -#define PS_ERRORTEXT_psVector_EXTENDSIZE_NEG "The input number of elements to extend must be non-negative." -#define PS_ERRORTEXT_psBitSet_ALLOC_NEG_SIZE "The number of bit in a psBitSet (%d) must be greater than zero." -#define PS_ERRORTEXT_psBitSet_SET_NULL "Can not operate on a NULL psBitSet." -#define PS_ERRORTEXT_psBitSet_BIT_OUTOFRANGE "The specified bit position (%d) is invalid. Position must be between 0 and %d." -#define PS_ERRORTEXT_psBitSet_OPERATOR_NULL "Specified operator is NULL. Must specify desired operator." -#define PS_ERRORTEXT_psBitSet_OPERATOR_INVALID "Specified operator, %s, is invalid. Valid operators are AND, OR, and XOR." -#define PS_ERRORTEXT_psBitSet_FIRST_OPERAND_NULL "First psBitSet operand can not be NULL." -#define PS_ERRORTEXT_psBitSet_SECOND_OPERAND_NULL "Second psBitSet operand can not be NULL." -#define PS_ERRORTEXT_psBitSet_OPERANDS_SIZE_DIFFER "The psBitSet operand must be the same size." -#define PS_ERRORTEXT_psBitSet_NOT_OP_FAILED "Could not perform NOT operation." -#define PS_ERRORTEXT_psBitSet_OPERAND_NULL "Operand can not be NULL." -#define PS_ERRORTEXT_psScalar_UNSUPPORTED_TYPE "Specified datatype (%d) is unsupported by psScalar." -#define PS_ERRORTEXT_psScalar_COPY_NULL "Can not copy a NULL psScalar." -#define PS_ERRORTEXT_psHash_KEY_NULL "Input key can not be NULL." -#define PS_ERRORTEXT_psHash_TABLE_NULL "Input psHash can not be NULL." -#define PS_ERRORTEXT_psHash_DATA_NULL "Input data can not be NULL." -#define PS_ERRORTEXT_psList_LOCATION_INVALID "Specified location, %d, is invalid." -#define PS_ERRORTEXT_psList_ITERATOR_INVALID "Specified iterator is not valid." -#define PS_ERRORTEXT_psList_ITERATOR_NULL "Specified iterator is NULL." -#define PS_ERRORTEXT_psList_ITERATOR_NONMUTABLE "Specified iterator indicates list is non-mutable." -#define PS_ERRORTEXT_psList_LIST_NULL "Specified psList reference is NULL." -#define PS_ERRORTEXT_psList_DATA_NULL "Specified data item is NULL." -#define PS_ERRORTEXT_psList_DATA_NOT_FOUND "Specified data item is not found in the psList." -#define PS_ERRORTEXT_psPixels_NULL "Input psPixels can not be NULL." -#define PS_ERRORTEXT_psPixels_MASK_NULL "Specified mask can not be NULL." -#define PS_ERRORTEXT_psPixels_MASK_TYPE "Specified mask's type, %s, is invalid. Should be PS_TYPE_MASK." -#define PS_ERRORTEXT_psPixels_DATA_NULL "Input psPixels contains no data." -#define PS_ERRORTEXT_psPixels_REGION_INVALID "Specified psRegion, [%d:%d,%d:%d], does not specify a valid region." -#define PS_ERRORTEXT_psPixels_FAILED_IMAGE_CREATE "Failed to create image of size %dx%d." -//~End - -#endif // #ifndef PS_COLLECTIONS_ERRORS_H Index: unk/psLib/src/collections/psCompare.c =================================================================== --- /trunk/psLib/src/collections/psCompare.c (revision 4545) +++ (revision ) @@ -1,119 +1,0 @@ - -/** @file psCompare.c - * @brief Comparison functions for sorting routines - * @ingroup Compare - * - * @author Robert Lupton, Princeton University - * @author Robert Daniel DeSonia, MHPCC - * - * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-03-17 19:26:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include "psCompare.h" - -#define COMPARE_NUMERIC_PTR(TYPE) \ -int psCompare##TYPE##Ptr(const void** a, const void** b) { \ - return **((ps##TYPE**)a) - **((ps##TYPE**)b); \ -} - -#define COMPARE_NUMERIC_PTR_DESCENDING(TYPE) \ -int psCompareDescending##TYPE##Ptr(const void** a, const void** b) { \ - return **((ps##TYPE**)b) - **((ps##TYPE**)a); \ -} - -#define COMPARE_NUMERIC(TYPE) \ -int psCompare##TYPE(const void* a, const void* b) { \ - return *((ps##TYPE*)a) - *((ps##TYPE*)b); \ -} - -#define COMPARE_NUMERIC_DESCENDING(TYPE) \ -int psCompareDescending##TYPE(const void* a, const void* b) { \ - return *((ps##TYPE*)b) - *((ps##TYPE*)a); \ -} - -COMPARE_NUMERIC_PTR(S8) -COMPARE_NUMERIC_PTR(S16) -COMPARE_NUMERIC_PTR(S32) -COMPARE_NUMERIC_PTR(S64) -COMPARE_NUMERIC_PTR(U8) -COMPARE_NUMERIC_PTR(U16) -COMPARE_NUMERIC_PTR(U32) -COMPARE_NUMERIC_PTR(U64) - -int psCompareF32Ptr(const void** a, const void** b) -{ - psF32 diff = **((psF32**)a) - **((psF32**)b); - return (diff>FLT_EPSILON) ? 1 : ((diffDBL_EPSILON) ? 1 : ((diffFLT_EPSILON) ? 1 : ((diffDBL_EPSILON) ? 1 : ((diffFLT_EPSILON) ? 1 : ((diffDBL_EPSILON) ? 1 : ((diffFLT_EPSILON) ? 1 : ((diffDBL_EPSILON) ? 1 : ((diff -#include -#include -#include "psHash.h" -#include "psMemory.h" -#include "psString.h" -#include "psTrace.h" -#include "psError.h" -#include "psConstants.h" - -#include "psCollectionsErrors.h" - -static psHashBucket* hashBucketAlloc(const char *key, psPtr data, psHashBucket* next); -static void hashBucketFree(psHashBucket* bucket); -static psPtr doHashWork(psHash* table, const char *key, psPtr data, psBool remove - ); -static void hashFree(psHash* table); - -/****************************************************************************** -psHashKeyList(table): this function creates a linked list with an entry in -that list for every key in the hash table. -Inputs: - table: a hash table -Return; - The linked list - *****************************************************************************/ -psList* psHashKeyList(const psHash* hash) -{ - psS32 i = 0; // Loop index variable - psList* myLinkList = NULL; // The output data structure - psHashBucket* ptr = NULL; // Used to step thru linked list. - - if (hash == NULL) { - return NULL; - } - // Create the linked list - myLinkList = psListAlloc(NULL); - - // Loop through every bucket in the hash table. If that bucket is not - // NULL, then add the bucket's key to the linked list. - for (i = 0; i < hash->n; i++) { - if (hash->buckets[i] != NULL) { - // Since a bucket contains a linked list of keys/data, we must - // step trough each key in that linked list: - - ptr = hash->buckets[i]; - while (ptr != NULL) { - psListAdd(myLinkList, PS_LIST_HEAD, ptr->key); - ptr = ptr->next; - } - } - } - - // Return the linked list - return (myLinkList); -} - -/****************************************************************************** -hashBucketAlloc(key, data, next): This procedure creates a new hash bucket -with the specified key, data, and next. -Inputs: - key: the new bucket's key pointer - data: the new bucket's data pointer - next: the new bucket's key pointer -Return: - the new hash bucket. - *****************************************************************************/ -static psHashBucket* hashBucketAlloc(const char *key, - psPtr data, - psHashBucket* next) -{ - // Allocate memory for the new hash bucket. - psHashBucket* bucket = psAlloc(sizeof(psHashBucket)); - - psMemSetDeallocator(bucket, (psFreeFunc) hashBucketFree); - - // Initialize the bucket. - bucket->key = psStringCopy(key); - - if (data == NULL) { - // NOTE: Should we flag a warning message? - bucket->data = NULL; - } else { - bucket->data = psMemIncrRefCounter(data); - } - - bucket->next = next; - - return bucket; -} - -/****************************************************************************** -hashBucketFree(bucket): This procedure deallocates the specified -hash bucket. -Inputs: - bucket: the hash bucket to be freed. -Return: - NONE - *****************************************************************************/ -static void hashBucketFree(psHashBucket* bucket) -{ - if (bucket == NULL) { - return; - } - - psFree(bucket->key); - - psFree(bucket->data); -} - -/****************************************************************************** -psHashAlloc(n): this procedure creates a new hash table with the -specified number of buckets. -Inputs: - n: initial number of buckets -Return: - The new hash table. - *****************************************************************************/ -psHash* psHashAlloc(long nalloc) // initial number of buckets -{ - psS32 i = 0; // loop index variable - - // Create the new hash table. - psHash* table = psAlloc(sizeof(psHash)); - - psMemSetDeallocator(table, (psFreeFunc) hashFree); - - // Allocate memory for the buckets. - table->buckets = psAlloc(nalloc * sizeof(psHashBucket* )); - table->n = nalloc; - - psTrace("utils.hash", 1, "Creating %d-element hash table\n", nalloc); - - // Initialize all buckets to NULL. - for (i = 0; i < nalloc; i++) - { - table->buckets[i] = NULL; - } - - // Return the new hash table. - return table; -} - -/****************************************************************************** -hashFree(table): This procedure deallocates the specified hash -table. It loops through each bucket, and calls hashBucketFree() on that -bucket. - -Inputs: - table: a hash table -Return: - NONE - *****************************************************************************/ -static void hashFree(psHash* table) -{ - psS32 i = 0; // Loop index variable. - - if (table == NULL) { - return; - } - // Loop through each bucket in the hash table. If that bucket is not - // NULL, then free the bucket via a function call to hashBucketFree(); - for (i = 0; i < table->n; i++) { - - // A bucket is composed of a linked list of buckets. - while (table->buckets[i] != NULL) { - psHashBucket* bucket = table->buckets[i]; - table->buckets[i] = bucket->next; - psFree(bucket); - } - } - - // Free the bucket structure, then the hash table. - psFree(table->buckets); -} - -/****************************************************************************** -doHashWork(table, key, data, remove): This is an internal -procedure which does the bulk of the work in using the hash table. Depending -upon the input parameters, it will either insert a new key/data into the hash -table, retrieve the data for a specified key, or remove a key/data item. If -we try to insert a key that already exists in the hash table, then we deallocate -the existing data/key item. -Inputs: - table: a hash table - key: the key to insert, retrieve, or remove. Must not be NULL. - data: the data to insert, if not NULL - remove: set to non-zero if the key/data should be removed from the table. -Return: - NONE - -NOTE: consider removing this private function and simply putting the code -into the psHashInsert(), psHashLookup(), and psHashRemove(). Why? Because -there is little common code between those functions. - *****************************************************************************/ -static psPtr doHashWork(psHash* table, - const char *key, - psPtr data, psBool remove - ) -{ - psS64 hash = 1; // This will contain an integer value - - // "hashed" from the key. - char *tmpchar = NULL; // Used in computing the hash function. - psHashBucket* ptr = NULL; // Used to retrieve the hash bucket. - psHashBucket* optr = NULL; // "original pointer": used to step - - // thru the linked list for a bucket. - - // The following condition should never be true, since this is a private - // function, but I'm checking it anyway since future coders might change - // the way this procedure is called. - if ((table == NULL) || (key == NULL)) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psHash_KEY_NULL); - return NULL; - } - // NOTE: This is the originally supplied hash function. - // for (psS32 i = 0, len = strlen(key); i < len; i++) { - // hash = (hash << 1) ^ key[i]; - // } - // hash &= (table->n - 1); - - // This hash algorithm is from Sedgewick. NOTE: must reread to ensure that - // the size of the hash table is not required to be a prime number. - tmpchar = (char *)key; - for (hash = 0; *tmpchar != '\0'; tmpchar++) { - hash = (64 * hash + *tmpchar) % (table->n); - } - - // NOTE: This should not be necessary, but for now, I'm checking bounds - // anyway. - if ((hash < 0) || (hash >= table->n)) { - psError(PS_ERR_UNKNOWN, true, - "Internal hash function out of range (%d)", hash); - } - // ptr will have the correct hash bucket. - ptr = table->buckets[hash]; - - // We know the correct hash bucket, now we need to know what to do. - // If the data parameter is NULL, then, by definition, this is a retrieve - // or a remove operation on the hash table. - - if (data == NULL) { - if (remove - ) { - // We search through the linked list for this bucket in - // the hash table and look for an entry for this key. - - optr = ptr; - while (ptr != NULL) { - // Determine if this entry holds the correct key. - if (strcmp(key, ptr->key) == 0) { - // The following lines of code are fairly standard ways - // of removing an item from a single-linked list. - - psPtr data = ptr->data; - - optr->next = ptr->next; - if (ptr == table->buckets[hash]) { - table->buckets[hash] = ptr->next; - } - psFree(ptr); - - // By definition, the data associated with that key - // must be returned, not freed. - return data; - } - optr = ptr; - ptr = ptr->next; - } - return NULL; // not in hash - } - else { - // If we get here, then a retrieve operation is requested. So, - // we step trough the linked list at this bucket, and return the - // data once we find it, or return NULL if we don't. - while (ptr != NULL) { - if (strcmp(key, ptr->key) == 0) { - return ptr->data; - } - ptr = ptr->next; - } - return NULL; // not in hash - } - } else { - // We get here if this procedure was called with non-NULL data. - // Therefore, we should insert that data into the hash table. - // First, we search through the linked list for this bucket in - // the hash table and look for a duplicate entry for this key. - - while (ptr != NULL) { - if (strcmp(key, ptr->key) == 0) { - // We have found this key in the hash table. - - psTrace("utils.hash.insert", 3, "Replacing data for %s\n", key); - - // NOTE: I have changed this behavior from the originally - // supplied code. Formerly, if itemFree was NULL, then - // the new data was not inserted into the hash table. - - psFree(ptr->data); - - ptr->data = psMemIncrRefCounter(data); - return data; - } - ptr = ptr->next; - } - // We did not found key in the linked list for this bucket of the hash - // table. So, we insert this data at the head of that linked list. - - table->buckets[hash] = hashBucketAlloc(key, data, table->buckets[hash]); - return data; - } -} - -/****************************************************************************** -psHashAdd(table, key, data): this procedure, which is part of -the public API, inserts a new key/data pair into the hash table. -Inputs: - table: a hash table - key: the key to use - data: the data to insert. -Return: - boolean value defining success or failure - *****************************************************************************/ -bool psHashAdd(psHash* hash, - const char *key, - psPtr data) -{ - PS_ASSERT_PTR_NON_NULL(hash, false); - PS_ASSERT_PTR_NON_NULL(key, false); - PS_ASSERT_PTR_NON_NULL(data, false); - - return (doHashWork(hash, key, data, false) != NULL); -} - -/****************************************************************************** -psHashLookup(table, key): this procedure, which is part of the public API, -looks up the specified key in the hash table and returns the data associated -with that key. - -Inputs: - table: a hash table - key: the key to use -Return: - The data associated with that key. - *****************************************************************************/ -psPtr psHashLookup(const psHash* hash, // hash to lookup key in - const char *key) // key to lookup -{ - PS_ASSERT_PTR_NON_NULL(hash, NULL); - PS_ASSERT_PTR_NON_NULL(key, NULL); - - return doHashWork((psPtr)hash, key, NULL, false); -} - -/****************************************************************************** -psHashRemove(table, key): this procedure, which is part of the -public API, removes the specified key from the hash table. -Inputs: - table: a hash table - key: the key to remove -Return: - boolean value defining success or failure - *****************************************************************************/ -bool psHashRemove(psHash* hash, - const char *key) -{ - psPtr data = NULL; - psBool retVal = false; - - PS_ASSERT_PTR_NON_NULL(hash, false); - PS_ASSERT_PTR_NON_NULL(key, false); - - data = doHashWork(hash, key, NULL, true); - if (data != NULL) { - retVal = true; - } else { - retVal = false; - } - - return retVal; -} - -psArray* psHashToArray(const psHash* hash) -{ - PS_ASSERT_PTR_NON_NULL(hash, NULL); - - // first, let's just count the number of data elements to know what size - // psArray we need to allocate. - int nElements = 0; - int nbucket = hash->n; - for (int i = 0; i < nbucket; i++) { - psHashBucket* tmpBucket = hash->buckets[i]; - while (tmpBucket != NULL) { - nElements++; - tmpBucket = tmpBucket->next; - } - } - - psArray* result = psArrayAlloc(nElements); - result->n = nElements; - - // now fill in the array with the hash hash's data - psPtr* data = result->data; - for (int i = 0; i < nbucket; i++) { - psHashBucket* tmpBucket = hash->buckets[i]; - while (tmpBucket != NULL) { - *(data++) = psMemIncrRefCounter(tmpBucket->data); - tmpBucket = tmpBucket->next; - } - } - - return result; -} Index: unk/psLib/src/collections/psHash.h =================================================================== --- /trunk/psLib/src/collections/psHash.h (revision 4545) +++ (revision ) @@ -1,88 +1,0 @@ -/** @file psHash.h - * @brief Contains support for basic hashing functions. - * @ingroup HashTable - * - * This file will hold the prototypes for defining a hash table with arbitrary - * data types, allocating/deallocating that has table, adding and removing - * data from that hash table, and listing all keys defined in the hash table. - * - * @author Robert Lupton, Princeton University - * @author Robert DeSonia, MHPCC - * @author GLG, MHPCC - * - * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_HASH_H -#define PS_HASH_H - -/** \addtogroup HashTable - * \{ - */ - -#include "psList.h" - -/** A bucket that holds an item of data. */ -typedef struct psHashBucket -{ - char *key; ///< The key for this item of data. - psPtr data; ///< The data itself. - struct psHashBucket* next; ///< The list of other possible keys. -} -psHashBucket; - -//typedef struct HashTable psHash; ///< Opaque type for a hash table - -/** The hash-table itself. */ -typedef struct psHash -{ - long n; ///< Number of buckets in hash table. - psHashBucket* *buckets; ///< The bucket data. - void *lock; ///< Optional lock for thread safety. -} -psHash; - -/// Allocate hash buckets in table. -psHash* psHashAlloc( - long nalloc ///< The number of buckets to allocate. -) -; - -/// Insert entry into table. -bool psHashAdd( - psHash* hash, ///< The table to insert in. - const char *key, ///< The key to use. - psPtr data ///< The data to insert. -); - -/// Lookup key in table. -psPtr psHashLookup( - const psHash* hash, ///< The table to lookup key in. - const char *key ///< The key to lookup. -); - -/// Remove key from table. -bool psHashRemove( - psHash* hash, ///< The table to lookup key in. - const char *key ///< The key to lookup. -); - -/// List all keys in table. -psList* psHashKeyList( - const psHash* hash ///< The table to list keys from.. -); - -/** Create a psArray from a psHash contents. - * - * @return psArray* A new psArray with duplicate contents of the input psHash - */ -psArray* psHashToArray( - const psHash* hash ///< The table to convert to psArray. -); - -/* \} */// End of DataGroup Functions - -#endif // #ifndef PS_HASH_H Index: unk/psLib/src/collections/psList.c =================================================================== --- /trunk/psLib/src/collections/psList.c (revision 4545) +++ (revision ) @@ -1,639 +1,0 @@ -/** @file psList.c - * @brief Support for doubly linked lists - * @ingroup LinkedList - * - * @author Robert Lupton, Princeton University - * @author Robert Daniel DeSonia, MHPCC - * - * @version $Revision: 1.40 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include -#include // we need a mutex to make this stuff thread safe. - -#include "psError.h" -#include "psAbort.h" -#include "psMemory.h" -#include "psList.h" -#include "psTrace.h" -#include "psLogMsg.h" - -#include "psCollectionsErrors.h" - -#define ITER_INIT_HEAD ((psPtr )1) // next iteration should return head -#define ITER_INIT_TAIL ((psPtr )2) // next iteration should return tail - -// private functions. -static void listFree(psList* list); -static void listIteratorFree(psListIterator* iter); -static psBool listIteratorRemove(psListIterator* iterator); - -static void listFree(psList* list) -{ - if (list == NULL) { - return; - } - - pthread_mutex_lock(&list->lock) - ; - - // remove the free function of iterators to avoid double removal from list - psArray* iterators = list->iterators; - for (int i = 0; i < iterators->n; i++) { - psMemSetDeallocator(iterators->data[i], NULL); - } - - psFree(list->iterators); - - for (psListElem* ptr = list->head; ptr != NULL;) { - psListElem* next = ptr->next; - - psFree(ptr->data); - psFree(ptr); - - ptr = next; - } - - pthread_mutex_unlock(&list->lock) - ; - - pthread_mutex_destroy(&list->lock) - ; - -} - -static void listIteratorFree(psListIterator* iter) -{ - if (iter == NULL) { - return; - } - - // remove this iterator from the parent list - psArrayRemove(iter->list->iterators,iter); - -} - -static psBool listIteratorRemove(psListIterator* iterator) -{ - if (iterator == NULL || iterator->cursor == NULL) { - return false; - } - - psListElem* elem = iterator->cursor; - psList* list = iterator->list; - int index = iterator->index; - - pthread_mutex_lock(&list->lock) - ; - - if (elem == list->head) { // head of list? - list->head = elem->next; - } else { - elem->prev->next = elem->next; - } - - if (elem == list->tail) { // tail of list? - list->tail = elem->prev; - } else { - elem->next->prev = elem->prev; - } - - psArray* iterators = list->iterators; - for (int i = 0; i < iterators->n; i++) { - psListIterator* iter = (psListIterator*) iterators->data[i]; - if (iter->cursor == elem) { - iter->cursor = NULL; - } else if (iter->index > index && iter->index > 0) { - iter->index--; - } - } - - list->n--; - - pthread_mutex_unlock(&list->lock) - ; - - // OK, delete orphaned list element and its data - psFree(elem->data); - psFree(elem); - - return true; -} - -psList* psListAlloc(psPtr data) -{ - psList* list = psAlloc(sizeof(psList)); - - psMemSetDeallocator(list, (psFreeFunc) listFree); - - list->n = 0; - list->head = list->tail = NULL; - list->iterators = psArrayAlloc(16); - list->iterators->n = 0; - - // create a default iterator - psListIteratorAlloc(list,PS_LIST_HEAD,true); - - pthread_mutex_init(&(list->lock), NULL) - ; - - if (data != NULL) { - psListAdd(list, PS_LIST_TAIL, data); - } - - return list; -} - -psListIterator* psListIteratorAlloc(psList* list, long location, bool mutable) -{ - psListIterator* iter = psAlloc(sizeof(psListIterator)); - - psMemSetDeallocator(iter, (psFreeFunc) listIteratorFree); - - // initialize the attributes - iter->list = list; - iter->cursor = NULL; - iter->index = 0; - iter->offEnd = false; - iter->mutable = mutable; - - // add to the list's array of iterators - psArray* listIterators = list->iterators; - int num = listIterators->n; - if ( num >= listIterators->nalloc) { - // need to resize the array to make more room for another iterator. - list->iterators = psArrayRealloc(listIterators,listIterators->nalloc*2); - listIterators = list->iterators; - } - listIterators->data[num] = iter; - listIterators->n = num+1; - - if (! psListIteratorSet(iter,location)) { - psFree(iter); - iter = NULL; - } - - return iter; -} - -bool psListIteratorSet(psListIterator* iterator, - long location) -{ - if (iterator == NULL) { - return false; - } - - psList* list = iterator->list; - - if (location == PS_LIST_TAIL) { - iterator->cursor = list->tail; - iterator->index = list->n - 1; - iterator->offEnd = false; - return true; - } - - if (location == PS_LIST_HEAD) { - iterator->cursor = list->head; - iterator->index = 0; - iterator->offEnd = false; - return true; - } - - if (location < 0) { - location = list->n + location; - } - - if (location < 0 || location >= (int)list->n) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psList_LOCATION_INVALID, - location); - return false; - } - - psListElem* cursor = iterator->cursor; - int index = iterator->index; - if (cursor == NULL) { // set the cursor to the head if it is NULL - if (location > list->n/2) { // closer to tail or head? - cursor = list->tail; - index = list->n - 1; - } else { - cursor = list->head; - index = 0; - } - } - - if (location < index) { - psS32 diff = index - location; - - for (psS32 count = 0; count < diff; count++) { - cursor = cursor->prev; // shouldn't need to check for NULL - } - } else { - psS32 diff = location - index; - - for (psS32 count = 0; count < diff; count++) { - cursor = cursor->next; // shouldn't need to check for NULL - } - } - iterator->cursor = cursor; - iterator->index = location; - iterator->offEnd = false; - - return true; -} - -bool psListAdd(psList* list, long location, psPtr data) -{ - - if (list == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_LIST_NULL); - return false; - } - - if (data == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_DATA_NULL); - return false; - } - - if (location > 0 && location >= (int)list->n) { - psLogMsg(__func__,PS_LOG_WARN, - "Specified location, %d, is beyond the end of the list. " - "Adding data item to tail.", - location); - location = PS_LIST_TAIL; - } - - // move ourselves to the given position - if (! psListIteratorSet(list->iterators->data[0],location)) { - return false; - } - - if (location == PS_LIST_TAIL) { - // insert the element at the end of the list - return psListAddAfter(list->iterators->data[0],data); - } else { - return psListAddBefore(list->iterators->data[0],data); - } -} - -bool psListAddAfter(psListIterator* iterator, void* data) -{ - if (data == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_DATA_NULL); - return false; - } - - if (iterator == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_ITERATOR_NULL); - return false; - } - - // Check if the list pointed by the iterator can be changed - if (!iterator->mutable) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_ITERATOR_NONMUTABLE); - return false; - } - - psListElem* cursor = iterator->cursor; - psList* list = iterator->list; - - if (cursor == NULL && list->head != NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psList_ITERATOR_INVALID); - return false; - } - - psListElem* elem = psAlloc(sizeof(psListElem)); - - pthread_mutex_lock(&list->lock) - ; - - // set the new list element's attributes - if (cursor == NULL) { // must be an empty list - elem->prev = NULL; - elem->next = NULL; - list->head = elem; - list->tail = elem; - } else { - elem->prev = cursor; - elem->next = cursor->next; - cursor->next = elem; - if (elem->next == NULL) { - list->tail = elem; - } else { - elem->next->prev = elem; - } - } - - elem->data = psMemIncrRefCounter(data); - - list->n++; - - if (cursor == list->tail) { - list->tail = elem; - } - - psArray* iterators = list->iterators; - int index = iterator->index; - for (int i = 0; i < iterators->n; i++) { - psListIterator* iter = (psListIterator*) iterators->data[i]; - if (iter->index > index) { - iter->index++; - } - } - - pthread_mutex_unlock(&list->lock) - ; - - return true; -} - -bool psListAddBefore(psListIterator* iterator, void* data) -{ - if (data == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_DATA_NULL); - return false; - } - - if (iterator == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_ITERATOR_NULL); - return false; - } - - // Check if the list pointed by the iterator can be changed - if (!iterator->mutable) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_ITERATOR_NONMUTABLE); - return false; - } - - psListElem* cursor = iterator->cursor; - psList* list = iterator->list; - - if (cursor == NULL && list->head != NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psList_ITERATOR_INVALID); - return false; - } - - psListElem* elem = psAlloc(sizeof(psListElem)); - - pthread_mutex_lock(&list->lock) - ; - - // set the new list element's attributes - if (cursor == NULL) { // empty list. - elem->prev = NULL; - elem->next = NULL; - list->head = elem; - list->tail = elem; - } else { - elem->prev = cursor->prev; - elem->next = cursor; - cursor->prev = elem; - if (elem->prev == NULL) { - list->head = elem; - } else { - elem->prev->next = elem; - } - } - - elem->data = psMemIncrRefCounter(data); - - list->n++; - - if (cursor == list->head) { - list->head = elem; - } - - psArray* iterators = list->iterators; - int index = iterator->index; - for (int i = 0; i < iterators->n; i++) { - psListIterator* iter = (psListIterator*) iterators->data[i]; - if (iter->index >= index) { - iter->index++; - } - } - - pthread_mutex_unlock(&list->lock) - ; - - return true; -} - -bool psListRemove(psList* list, - long location) -{ - if (list == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_LIST_NULL); - return false; - } - - // move ourselves to the given position - psListIterator* defaultIterator = list->iterators->data[0]; - if (! psListIteratorSet(defaultIterator,location)) { - return false; - } - - return listIteratorRemove(defaultIterator); -} - -bool psListRemoveData(psList* list, - psPtr data) -{ - if (list == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_LIST_NULL); - return false; - } - - if (data == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_DATA_NULL); - return false; - } - - psListElem* elem = list->head; - int index = 0; - while (elem != NULL && elem->data != data) { - elem = elem->next; - index++; - } - if (elem == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_DATA_NOT_FOUND); - return false; - } - - psListIterator* iterator = (psListIterator*)list->iterators->data[0]; - iterator->index = index; - iterator->cursor = elem; - - return listIteratorRemove(iterator); -} - -psPtr psListGet(psList* list, long location) -{ - if (list == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psList_LIST_NULL); - return NULL; - } - - if (list->head == NULL) { // list empty? - return NULL; - } - - psListIterator* iterator = list->iterators->data[0]; - - if (! psListIteratorSet(iterator,location)) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psList_LOCATION_INVALID, - location); - return NULL; - } - - return iterator->cursor->data; -} - -/* - * and now return the previous/next element of the list - */ -psPtr psListGetAndIncrement(psListIterator* iterator) -{ - if (iterator == NULL ) { - return NULL; - } - if (( iterator->cursor == NULL) && (iterator->offEnd)) { - return NULL; - } - if ( (iterator->cursor == NULL) && (!iterator->offEnd)) { - iterator->cursor = iterator->list->head; - iterator->index = 0; - return NULL; - } - - psPtr data = iterator->cursor->data; - - iterator->cursor = iterator->cursor->next; - iterator->index++; - if (iterator->cursor == NULL) { - iterator->offEnd = true; - } - - return data; -} - -psPtr psListGetAndDecrement(psListIterator* iterator) -{ - if (iterator == NULL ) { - return NULL; - } - if ((iterator->cursor == NULL) && (!iterator->offEnd)) { - psLogMsg(__func__,PS_LOG_WARN,"Attempt to get previous with itertator cursor NULL and offEnd false"); - return NULL; - } - if ( (iterator->cursor == NULL) && (iterator->offEnd) ) { - iterator->cursor = iterator->list->tail; - iterator->index = iterator->list->n-1; - iterator->offEnd = false; - return NULL; - } - - psPtr data = iterator->cursor->data; - - iterator->cursor = iterator->cursor->prev; - iterator->index--; - - return data; -} - -/* - * Convert a psList to/from a psVoidPtrArray - */ -psArray* psListToArray(const psList* restrict list) -{ - psListElem* ptr; - psU32 n; - psArray* restrict arr; - - if (list == NULL) { - return NULL; - } - - if (list->n > 0) { - arr = psArrayAlloc(list->n); - } else { - arr = psArrayAlloc(1); - } - - arr->n = list->n; - - ptr = list->head; - n = list->n; - for (psS32 i = 0; i < n; i++) { - arr->data[i] = psMemIncrRefCounter(ptr->data); - ptr = ptr->next; - } - - return arr; -} - -psList* psArrayToList(const psArray* array) -{ - psU32 n; - psList* list; // list of elements - - if (array == NULL) { - return NULL; - } - - list = psListAlloc(NULL); - n = array->n; - for (psS32 i = 0; i < n; i++) { - psListAdd(list, PS_LIST_TAIL, array->data[i]); - } - - return list; -} - -psList* psListSort(psList* list, psComparePtrFunc func) -{ - psArray* arr; - - if (list == NULL) { - return NULL; - } - // convert to indexable vector for use by qsort. - arr = psListToArray(list); - psArray* iterators = psMemIncrRefCounter(list->iterators); - psFree(list); - - arr = psArraySort(arr, func); - - // convert back to linked list - list = psArrayToList(arr); - psFree(list->iterators); - list->iterators = iterators; - psFree(arr); - - // sorting should invalidate all iterator positions. - for (int i = 0; i < iterators->n; i++) { - ((psListIterator*)iterators->data[i])->cursor = NULL; - } - - return list; -} - Index: unk/psLib/src/collections/psList.h =================================================================== --- /trunk/psLib/src/collections/psList.h (revision 4545) +++ (revision ) @@ -1,230 +1,0 @@ -/** @file psList.h - * @brief Support for doubly linked lists - * - * @author Robert Lupton, Princeton University - * @author Robert Daniel DeSonia, MHPCC - * - * @ingroup LinkedList - * - * @version $Revision: 1.29 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_LIST_H -#define PS_LIST_H - -#include // we need a mutex to make this stuff thread safe. - -#include "psCompare.h" -#include "psArray.h" - -/** @addtogroup LinkedList - * @{ - */ - -/** Special values of index into list - * - * This list of possible list position values should be contiguous non-positive values ending with - * PS_LIST_UNKNOWN. Any value less-than-or-equal-to PS_LIST_UNKNOWN is considered a undefined position. - * - */ -enum { - PS_LIST_HEAD = 0, ///< at head - PS_LIST_TAIL = -1, ///< at tail -}; - -/** Doubly-linked list element */ -typedef struct psListElem -{ - struct psListElem* prev; ///< previous link in list - struct psListElem* next; ///< next link in list - psPtr data; ///< real data item -} -psListElem; - -/** The psList Linked list structure. User should not allocate this struct - * directly; rather the psListAlloc should be used. - * - * @see psListAlloc - */ -typedef struct -{ - long n; ///< number of elements on list - psListElem* head; ///< first element on list (may be NULL) - psListElem* tail; ///< last element on list (may be NULL) - psArray* iterators; - ///< array of all iterators associated with this list. First iterator is - ///< used internally to improve performance when using indexed access, all - ///< others are user-level iterators created by psListIteratorAlloc. - - pthread_mutex_t lock; ///< mutex to lock a node during changes -// void *lock; ///< Optional lock for thread safety -} -psList; - -/** The psList iterator structure. This should be allocated via - * psListIteratorAlloc and not directly. - * - * The life span of a psListIterator object is ended by either a psFree - * of this structure OR psFree of the psList in which it operates on. - * - * @see psListIteratorAlloc, psListIteratorSet, psListGetAndIncrement, psListGetAndDecrement - */ -typedef struct -{ -psList* list; ///< List iterator to works on -psListElem* cursor; ///< current cursor position -int index; ///< the index number in the list -bool offEnd; ///< Iterator off the end? -bool mutable; ///< Is it permissible to modify the list? -} -psListIterator; - - -/** Creates a psList linked list object. - * - * @return psList* A new psList object. - */ -psList* psListAlloc( - psPtr data - ///< initial data item; may be NULL if no an empty psList is desired -) -; - -/** Creates a psListIterator object and associates it with a psList. - * - * @return psListIterator* A new psListIterator object. - */ -psListIterator* psListIteratorAlloc( - psList* list, ///< the psList to iterate with - long location, ///< the initial starting point. - ///< This can be a numeric index, PS_LIST_HEAD, or PS_LIST_TAIL. - bool mutable ///< Is it permissible to modify list? -); - -/** Set the iterator of the list to a given position. If location is invalid the - * iterator position is not changed. - * - * @return bool TRUE if iterator successfully set, otherwise FALSE. - */ -bool psListIteratorSet( - psListIterator* iterator, ///< list iterator - long location ///< index number, PS_LIST_HEAD, or PS_LIST_TAIL -); - -/** Adds an element to a psList at position given. - * - * @return bool TRUE if item was successfully added, otherwise FALSE. - */ -bool psListAdd( - psList* list, ///< list to add item to - long location, ///< index, PS_LIST_HEAD, PS_LIST_TAIL, or numbered location. - psPtr data ///< data item to add. If NULL, list is not modified. -); - -/** Adds an data item to a psList at position just after the list position given - * - * @return bool TRUE if item was successfully added, otherwise FALSE. - */ -bool psListAddAfter( - psListIterator* iterator, ///< list position to add item to - psPtr data ///< data item to add. If NULL, list is not modified. -); - -/** Adds an data item to a psList at position just before the list position given - * - * @return bool TRUE if item was successfully added, otherwise FALSE. - */ -bool psListAddBefore( - psListIterator* iterator, ///< list position to add item to - psPtr data ///< data item to add. If NULL, list is not modified. -); - -/** Remove an item at the specified location from a list. - * - * @return bool TRUE if element is successfully removed, otherwise FALSE. - */ -bool psListRemove( - psList* list, ///< list to remove element from - long location ///< index of item -); - -/** Remove an item from a list. - * - * @return bool TRUE if element is successfully removed, otherwise FALSE. - */ -bool psListRemoveData( - psList* list, ///< list to remove element from - psPtr data ///< data item to find and remove -); - -/** Retrieve an item from a list. - * - * @return psPtr the item corresponding to the location parameter. If - * location is invalid (e.g., a numbered index greater - * than the list size or if the list is empty), a - * NULL is returned. - */ -psPtr psListGet( - psList* list, ///< list to retrieve element from - long location ///< index number, PS_LIST_HEAD, or PS_LIST_TAIL -); - -/** Position the specified iterator to the next item in list. - * - * @return psPtr the data item at the original iterator position or NULL if the - * iterator went past the end of the list. - */ -psPtr psListGetAndIncrement( - psListIterator* iterator ///< iterator to move -); - -/** Position the specified iterator to the previous item in list. - * - * @return psPtr the data item at the original iterator position or NULL if the - * iterator went past the beginning of the list. - */ -psPtr psListGetAndDecrement( - psListIterator* iterator ///< iterator to move -); - -/** Convert a linked list to an array - * - * @return psArray* A new psArray populated with elements from the list, - * or NULL if the given dlist parameter is NULL. - */ -psArray* psListToArray( - const psList* list ///< List to convert -); - -/** Convert array to a doubly-linked list - * - * @return psList* A new psList populated with elements formt the psArray, - * or NULL is the given arr parameter is NULL. - */ -psList* psArrayToList( - const psArray* array ///< vector to convert -); - -/** Sort a list via a comparison function. - * - * The comparison function must return an integer less than, equal to, or - * greater than zero if the first argument is considered to be respectively - * less than, equal to, or greater than the second. - * - * If two members compare as equal, their order in the sorted array is - * undefined. - * - * @return psList* Sorted list. - */ -psList* psListSort( - psList* list, ///< the list to sort - psComparePtrFunc func ///< the comparison function -); - -/// @} End of DataGroup Functions - -#endif // #ifndef PS_LIST_H - Index: unk/psLib/src/collections/psMetadata.c =================================================================== --- /trunk/psLib/src/collections/psMetadata.c (revision 4545) +++ (revision ) @@ -1,739 +1,0 @@ -/** @file psMetadata.c -* -* -* @brief Contains metadata structures, enumerations and functions prototypes. -* -* This file defines metadata item, metadata type, metadata flags, metadata containers, and function -* prototypes necessary creating psLib metadata APIs -* -* @ingroup Metadata -* -* @author Robert DeSonia, MHPCC -* @author Ross Harman, MHPCC -* -* @version $Revision: 1.70 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-06 03:04:35 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -/******************************************************************************/ -/* INCLUDE FILES */ -/******************************************************************************/ -#include -#include -#include - -#include "fitsio.h" -#include "psType.h" -#include "psMemory.h" -#include "psError.h" -#include "psAbort.h" -#include "psList.h" -#include "psHash.h" -#include "psVector.h" -#include "psMetadata.h" -#include "psLookupTable.h" -#include "psString.h" -#include "psAstronomyErrors.h" -#include "psConstants.h" -#include "psLogMsg.h" - -/******************************************************************************/ -/* DEFINE STATEMENTS */ -/******************************************************************************/ - -/** Maximum size of a string */ -#define MAX_STRING_LENGTH 1024 - -/******************************************************************************/ -/* TYPE DEFINITIONS */ -/******************************************************************************/ - -// None - -/*****************************************************************************/ -/* GLOBAL VARIABLES */ -/*****************************************************************************/ - -// None - -/*****************************************************************************/ -/* FILE STATIC VARIABLES */ -/*****************************************************************************/ - -static psS32 metadataId = 0; - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - LOCAL */ -/*****************************************************************************/ - -static psMetadataItem* makeMetaMulti(psHash* table, const char* key, psMetadataItem* existing) -{ - - if (existing != NULL && existing->type == PS_META_MULTI) { - return existing; - } - - // move any existing entry into a psList - psList* newList = psListAlloc(existing); - - psMetadataItem* item = psMetadataItemAlloc(key, - PS_META_MULTI, - "", - newList); - - if (existing != NULL) { - psHashRemove(table,key); // take out the old entry - } - - psHashAdd(table, key, item); // put in the new entry - psMemDecrRefCounter(item); // get rid of extra reference - - // free local references of newly allocated items. - psFree(newList); - - return item; -} - -static void metadataItemFree(psMetadataItem* metadataItem) -{ - psMetadataType type; - - type = metadataItem->type; - - if (metadataItem == NULL) { - return; - } - - psMemDecrRefCounter(metadataItem->name); - psMemDecrRefCounter(metadataItem->comment); - - if(!PS_META_IS_PRIMITIVE(type)) { - psFree(metadataItem->data.V); - } -} - -static void metadataIteratorFree(psMetadataIterator* iter) -{ - if (iter == NULL) { - return; - } - psFree(iter->iter); - - if (iter->regex != NULL) { - regfree(iter->regex); - } -} - -static void metadataFree(psMetadata* metadata) -{ - if (metadata == NULL) { - return; - } - psFree(metadata->list); - psFree(metadata->table); - -} - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - PUBLIC */ -/*****************************************************************************/ - -psMetadataItem* psMetadataItemAlloc(const char *name, psMetadataType type, - const char *comment, ...) -{ - va_list argPtr; - psMetadataItem* metadataItem = NULL; - - // Get the variable list parameters to pass to allocation function - va_start(argPtr, comment); - - // Call metadata item allocation - metadataItem = psMetadataItemAllocV(name, type, comment, argPtr); - - // Clean up stack after variable arguement has been used - va_end(argPtr); - - return metadataItem; -} - -#define METADATAITEM_ALLOC_TYPE(NAME,TYPE,METATYPE) \ -psMetadataItem* psMetadataItemAlloc##NAME(const char* name, \ - const char* comment, \ - TYPE value) \ -{ \ - return psMetadataItemAlloc(name, METATYPE, comment, value); \ -} - -METADATAITEM_ALLOC_TYPE(Str,const char*,PS_META_STR) -METADATAITEM_ALLOC_TYPE(F32,psF32,PS_META_F32) -METADATAITEM_ALLOC_TYPE(F64,psF64,PS_META_F64) -METADATAITEM_ALLOC_TYPE(S32,psS32,PS_META_S32) -METADATAITEM_ALLOC_TYPE(Bool,psBool,PS_META_BOOL) - -psMetadataItem* psMetadataItemAllocV(const char *name, psMetadataType type, - const char *comment, va_list argPtr) -{ - psMetadataItem* metadataItem = NULL; - - - PS_ASSERT_PTR_NON_NULL(name,NULL); - - // Allocate metadata item - metadataItem = (psMetadataItem*) psAlloc(sizeof(psMetadataItem)); - metadataItem->data.V = NULL; - - // Set deallocator - psMemSetDeallocator(metadataItem, (psFreeFunc) metadataItemFree); - - // Allocate and set metadata item comment - if (comment == NULL) { - // Per SDRS, null isn't allowed, must use "" instead - metadataItem->comment = psStringCopy(""); - } else { - metadataItem->comment = psStringCopy(comment); - } - - // Set metadata item unique id - *(psS32 *)(&metadataItem->id) = ++metadataId; - - // Set metadata item type - metadataItem->type = type & PS_METADATA_TYPE_MASK; - - // Allocate and set metadata item name - metadataItem->name = (char *)psAlloc(sizeof(char) * MAX_STRING_LENGTH); - vsprintf(metadataItem->name, name, argPtr); - - // Set metadata item value - switch(metadataItem->type) { - case PS_META_BOOL: - metadataItem->data.B = (psBool)va_arg(argPtr, psS32); - break; - case PS_META_S32: - metadataItem->data.S32 = (psS32)va_arg(argPtr, psS32); - break; - case PS_META_F32: - metadataItem->data.F32 = (psF32)va_arg(argPtr, psF64); - break; - case PS_META_F64: - metadataItem->data.F64 = (psF64)va_arg(argPtr, psF64); - break; - case PS_META_STR: - // Perform copy of input strings - metadataItem->data.V = psStringNCopy(va_arg(argPtr, char *), MAX_STRING_LENGTH); - break; - case PS_META_LIST: - case PS_META_VEC: - case PS_META_HASH: - case PS_META_LOOKUPTABLE: - case PS_META_JPEG: - case PS_META_PNG: - case PS_META_ASTROM: - case PS_META_UNKNOWN: - case PS_META_META: - case PS_META_MULTI: - case PS_META_ARRAY: - // Copy of input data not performed due to variability of data types - metadataItem->data.V = psMemIncrRefCounter(va_arg(argPtr, psPtr)); - break; - default: - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psMetadata_METATYPE_INVALID, type); - psFree(metadataItem); - metadataItem = NULL; - } - - return metadataItem; -} - -psMetadata* psMetadataAlloc(void) -{ - psList* list = NULL; - psHash* table = NULL; - psMetadata* metadata = NULL; - - // Allocate metadata - metadata = (psMetadata*) psAlloc(sizeof(psMetadata)); - // Set deallocator - psMemSetDeallocator(metadata, (psFreeFunc) metadataFree); - - // Allocate metadata's internal containers - list = (psList*) psListAlloc(NULL); - table = (psHash*) psHashAlloc(10); - - metadata->list = list; - metadata->table = table; - - return metadata; -} - -bool psMetadataAddItem(psMetadata *md, const psMetadataItem *item, long location, psS32 flags) -{ - char * key = NULL; - psHash *mdTable = NULL; - psList *mdList = NULL; - psMetadataItem *existingEntry = NULL; - - PS_ASSERT_PTR_NON_NULL(md,NULL); - PS_ASSERT_PTR_NON_NULL(md->table,NULL); - PS_ASSERT_PTR_NON_NULL(md->list,NULL); - PS_ASSERT_PTR_NON_NULL(item,NULL); - PS_ASSERT_PTR_NON_NULL(item->name,NULL); - - mdTable = md->table; - mdList = md->list; - key = item->name; - - // See if key is already in table - existingEntry = (psMetadataItem*)psHashLookup(mdTable, key); - - if (item->type == PS_META_MULTI) { - // the incoming entry is PS_META_MULTI - - // force the hash entry to be PS_META_MULTI - existingEntry = makeMetaMulti(mdTable,key,existingEntry); - - // add all the items in the incoming entry to metadata - psList* list = item->data.list; - if (list != NULL) { - psListIterator* iter = psListIteratorAlloc(list,PS_LIST_HEAD,true); - psMetadataItem* listItem; - while ((listItem=(psMetadataItem*)psListGetAndIncrement(iter)) != NULL) { - psMetadataAddItem(md,listItem,location,flags); - } - psFree(iter); - } - - return true; // all done. - } - - // how the item is added to the hash depends on prior existence, flags, etc. - if(existingEntry != NULL) { // prior existence - if (existingEntry->type == PS_META_MULTI || (flags & PS_META_DUPLICATE_OK) != 0) { - // duplicate entries allowed - add another entry. - - // make sure the existing entry is PS_META_MULTI - existingEntry = makeMetaMulti(mdTable,key,existingEntry); - - // add to the hash's list of duplicate entries - if (! psListAdd(existingEntry->data.list, PS_LIST_TAIL, (psPtr)item) ) { - psError(PS_ERR_UNKNOWN,false,PS_ERRORTEXT_psMetadata_ADD_COLLECTION_FAILED,key); - return false; - } - } else if ((flags & PS_META_REPLACE) != 0) { - // replace entry instead of creating a duplicate entry. - - // remove the existing entry from metadata - psMetadataRemove(md,0,key); - - // treat as if new (added to list below) - if(!psHashAdd(mdTable, key, (psPtr)item)) { - psError(PS_ERR_UNKNOWN,false,PS_ERRORTEXT_psMetadata_ADD_TABLE_FAILED,key); - return false; - } - - // Generate warning that item has been replaced - psLogMsg(__func__,PS_LOG_WARN,"Metadata item %s has been replaced", - existingEntry->name); - } else { - // default is to error on duplicate entry. - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psMetadata_DUPLICATE_NOT_ALLOWED); - return false; - } - } else { - // OK, this is a new item. - - // Node doesn't exist - Add new metadata item to metadata collection's hash - if(!psHashAdd(mdTable, key, (psPtr)item)) { - psError(PS_ERR_UNKNOWN,false,PS_ERRORTEXT_psMetadata_ADD_TABLE_FAILED,key); - return false; - } - } - - if(!psListAdd(mdList, location, (psPtr)item)) { - psError(PS_ERR_UNKNOWN,false,PS_ERRORTEXT_psMetadata_ADD_COLLECTION_FAILED,key); - return false; - } - - return true; -} - -bool psMetadataAdd(psMetadata *md, long location, const char *name, - int format, const char *comment, ...) -{ - va_list argPtr; - - va_start(argPtr, comment); - psBool result = psMetadataAddV(md,location,name,format,comment,argPtr); - va_end(argPtr); - - return result; -} - -bool psMetadataAddV(psMetadata *md, long location, const char *name, - int format, const char *comment, va_list list) -{ - psMetadataItem* metadataItem = NULL; - - metadataItem = psMetadataItemAllocV(name, format & PS_METADATA_TYPE_MASK, comment, list); - - if (!psMetadataAddItem(md, metadataItem, location, format & PS_METADATA_FLAGS_MASK)) { - psError(PS_ERR_UNKNOWN,false,PS_ERRORTEXT_psMetadata_ADD_FAILED); - psFree(metadataItem); - return false; - } - // Decrement reference count, since the metadata item is now in metadata collection and no longer needed - psFree(metadataItem); - - return true; -} - -#define METADATA_ADD_TYPE(NAME,TYPE,METATYPE) \ -psBool psMetadataAdd##NAME(psMetadata* md, long where, const char* name, \ - const char* comment, TYPE value) { \ - return psMetadataAdd(md,where,name, METATYPE,comment,value); \ -} - -METADATA_ADD_TYPE(S32,psS32,PS_META_S32) -METADATA_ADD_TYPE(F32,psF32,PS_META_F32) -METADATA_ADD_TYPE(F64,psF64,PS_META_F64) -METADATA_ADD_TYPE(List,psList*,PS_META_LIST) -METADATA_ADD_TYPE(Str,const char*,PS_META_STR) -METADATA_ADD_TYPE(Vector,psVector*,PS_META_VEC) -METADATA_ADD_TYPE(Image,psImage*,PS_META_IMG) -METADATA_ADD_TYPE(Hash,psHash*,PS_META_HASH) -METADATA_ADD_TYPE(LookupTable,psLookupTable*,PS_META_LOOKUPTABLE) -METADATA_ADD_TYPE(Unknown,void*,PS_META_UNKNOWN) -METADATA_ADD_TYPE(Metadata,psMetadata*,PS_META_META) -METADATA_ADD_TYPE(Array,psArray*,PS_META_ARRAY) - -psBool psMetadataRemove(psMetadata *md, long where, const char *key) -{ - PS_ASSERT_PTR_NON_NULL(md,NULL); - - PS_ASSERT_PTR_NON_NULL(md->list,NULL); - psList* mdList = md->list; - - PS_ASSERT_PTR_NON_NULL(md->table,NULL); - psHash* mdTable = md->table; - - // Select removal by key or index - if (key != NULL) { - // Remove by key name - psMetadataItem* entry = psHashLookup(mdTable,key); - if (entry == NULL) { - psError(PS_ERR_UNKNOWN, false, PS_ERRORTEXT_psMetadata_REMOVE_TABLE_FAILED, key); - return false; - } - if (entry->type == PS_META_MULTI) { - psMetadataItem* listItem; - psListIterator* iter = psListIteratorAlloc( - entry->data.list, - PS_LIST_HEAD,true); - while ((listItem=psListGetAndIncrement(iter)) != NULL) { - psListRemoveData(mdList, listItem); - } - psFree(iter); - psHashRemove(mdTable,key); - - } else { - psListRemoveData(mdList, entry); - psHashRemove(mdTable, key); - } - } else { - // Remove by index - psMetadataItem* entry = psListGet(mdList, where); - if (entry == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psMetadata_FIND_INDEX_FAILED, where); - return false; - } - key = entry->name; - - if (key == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psMetadata_REMOVE_LIST_INDEX_FAILED, where); - return false; - } - - psMetadataItem* tableItem = psHashLookup(mdTable, key); - if (tableItem == NULL) { - psError(PS_ERR_UNKNOWN, false, PS_ERRORTEXT_psMetadata_REMOVE_TABLE_FAILED, key); - return false; - } - - if (tableItem->type == PS_META_MULTI) { - // multiple entries with same key, remove just the specified one - psListRemoveData(tableItem->data.list, entry); - } else { - if (!psHashRemove(mdTable, key)) { - psError(PS_ERR_UNKNOWN, false, PS_ERRORTEXT_psMetadata_REMOVE_TABLE_FAILED, key); - return false; - } - } - psListRemove(mdList, where); - } - - return true; -} - -psMetadataItem* psMetadataLookup(const psMetadata *md, const char *key) -{ - psHash* mdTable = NULL; - psMetadataItem* entry = NULL; - - - PS_ASSERT_PTR_NON_NULL(md,NULL); - PS_ASSERT_PTR_NON_NULL(md->table,NULL); - PS_ASSERT_PTR_NON_NULL(key,NULL); - - mdTable = md->table; - entry = (psMetadataItem*)psHashLookup(mdTable, key); - - return entry; -} - -void* psMetadataLookupPtr(bool *status, const psMetadata *md, const char *key) -{ - psMetadataItem *metadataItem = NULL; - - if (status) { - *status = true; - } - - metadataItem = psMetadataLookup(md, key); - if(metadataItem == NULL) { - if (status) { - *status = false; - } - return NULL; - } - if (metadataItem->type == PS_META_MULTI) { - // if multiple keys found, use the first. - metadataItem = (psMetadataItem*)((metadataItem->data.list)->head); - } - - if(PS_META_IS_PRIMITIVE(metadataItem->type)) { - if (status) { - *status = false; - } - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psMetadata_METATYPE_INVALID, - metadataItem->type); - return NULL; - } else { - return metadataItem->data.V; - } -} - -#define psMetadataLookupNumTYPE(TYPE) \ -ps##TYPE psMetadataLookup##TYPE(bool *status, const psMetadata *md, const char *key) \ -{ \ - psMetadataItem *metadataItem = NULL; \ - ps##TYPE value = 0; \ - \ - if (status) { \ - *status = true; \ - } \ - \ - metadataItem = psMetadataLookup(md, key); \ - if(metadataItem == NULL) { \ - if (status) { \ - *status = false; \ - } \ - return 0; \ - } \ - if (metadataItem->type == PS_META_MULTI) { \ - /* if multiple keys found, use the first. */ \ - metadataItem = (psMetadataItem*)((metadataItem->data.list)->head); \ - } \ - \ - switch (metadataItem->type) { \ - case PS_META_S32: \ - value = (ps##TYPE)metadataItem->data.S32; \ - break; \ - case PS_META_F32: \ - value = (ps##TYPE)metadataItem->data.F32; \ - break; \ - case PS_META_F64: \ - value = (ps##TYPE)metadataItem->data.F64; \ - break; \ - case PS_META_BOOL: \ - if (metadataItem->data.B) { \ - value = 1; \ - } \ - break; \ - default: \ - /* if you get to this point, the value is not a number. */ \ - if (status) { \ - *status = false; \ - } \ - break; \ - } \ - \ - /* psFree(metadataItem); currently, the lookup doesn't increment the ref count */ \ - return value; \ -} - -psMetadataLookupNumTYPE(F32) -psMetadataLookupNumTYPE(F64) -psMetadataLookupNumTYPE(S32) -psMetadataLookupNumTYPE(Bool) - -psMetadataItem* psMetadataGet(const psMetadata *md, long location) -{ - psMetadataItem* entry = NULL; - - PS_ASSERT_PTR_NON_NULL(md,NULL); - PS_ASSERT_PTR_NON_NULL(md->list,NULL); - - entry = (psMetadataItem*) psListGet(md->list, location); - if (entry == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psMetadata_FIND_INDEX_FAILED, location); - return NULL; - } - - return entry; -} - -psMetadataIterator* psMetadataIteratorAlloc(psMetadata* md, - long location, - const char* regex) -{ - PS_ASSERT_PTR_NON_NULL(md,NULL); - PS_ASSERT_PTR_NON_NULL(md->list,NULL); - - psMetadataIterator* newIter = psAlloc(sizeof(psMetadataIterator)); - newIter->regex = NULL; - newIter->iter = NULL; - - // Set deallocator - psMemSetDeallocator(newIter, (psFreeFunc) metadataIteratorFree); - - if (regex == NULL) { - newIter->iter = psListIteratorAlloc(md->list, location, false); - return newIter; - } else { - int regRtn = regcomp(newIter->regex,regex,0); - if (regRtn != 0) { - char errMsg[256]; - regerror(regRtn, newIter->regex, errMsg, 256); - regfree(newIter->regex); - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psMetadata_REGEX_INVALID, - errMsg); - psFree(newIter); - return NULL; - } - } - - psMetadataIteratorSet(newIter, location); // XXX: do we error if no match is found? - - return newIter; -} - -bool psMetadataIteratorSet(psMetadataIterator* iterator, - long location) -{ - int match; - psMetadataItem* cursor; - - PS_ASSERT_PTR_NON_NULL(iterator,NULL); - - psListIterator* iter = iterator->iter; - PS_ASSERT_PTR_NON_NULL(iterator->iter,NULL); - - regex_t* regex = iterator->regex; - - // handle trivial case where no regex subsetting is required. - if (regex == NULL) { - return psListIteratorSet(iter,location); - } - - if (location < 0) { - // match from the tail - match = 0; - psListIteratorSet(iter,PS_LIST_TAIL); - while ( (cursor=(psMetadataItem*)iter->cursor) != NULL) { - if (regexec(regex, cursor->name, 0, NULL, 0) == 0) { - // this key is a match - match--; - if (match == location) { - break; - } - } - (void)psListGetAndDecrement(iter); - } - return (match == location); - } - - // find the n-th match from the head - match = -1; - psListIteratorSet(iter,PS_LIST_HEAD); - while ( (cursor=(psMetadataItem*)iter->cursor) != NULL) { - if (regexec(regex, cursor->name, 0, NULL, 0) == 0) { - // this key is a match - match++; - if (match == location) { - break; - } - } - (void)psListGetAndIncrement(iter); - } - return (match == location); -} - -psMetadataItem* psMetadataGetAndIncrement(psMetadataIterator* iterator) -{ - psMetadataItem* oldValue; - - PS_ASSERT_PTR_NON_NULL(iterator,NULL); - - psListIterator* iter = iterator->iter; - PS_ASSERT_PTR_NON_NULL(iterator->iter,NULL); - - regex_t* regex = iterator->regex; - - // handle trivial case where no regex subsetting is required. - if (regex == NULL) { - return (psMetadataItem*)psListGetAndIncrement(iter); - } - - oldValue = (psMetadataItem*)iter->cursor; - - while (psListGetAndIncrement(iter) != NULL) { - if (iter->cursor != NULL && - regexec(regex, ((psMetadataItem*)iter->cursor)->name, 0, NULL, 0) == 0) { - // this key is a match - break; - } - } - return oldValue; -} - -psMetadataItem* psMetadataGetAndDecrement(psMetadataIterator* iterator) -{ - psMetadataItem* oldValue; - - PS_ASSERT_PTR_NON_NULL(iterator,NULL); - - psListIterator* iter = iterator->iter; - PS_ASSERT_PTR_NON_NULL(iterator->iter,NULL); - - regex_t* regex = iterator->regex; - - // handle trivial case where no regex subsetting is required. - if (regex == NULL) { - return (psMetadataItem*)psListGetAndDecrement(iter); - } - - oldValue = (psMetadataItem*)iter->cursor; - - while (psListGetAndDecrement(iter) != NULL) { - if (iter->cursor != NULL && - regexec(regex, ((psMetadataItem*)iter->cursor)->name, 0, NULL, 0) == 0) { - // this key is a match - break; - } - } - return oldValue; -} Index: unk/psLib/src/collections/psMetadata.h =================================================================== --- /trunk/psLib/src/collections/psMetadata.h (revision 4545) +++ (revision ) @@ -1,605 +1,0 @@ -/** @file psMetadata.h -* -* @brief Contains metadata struuctures, enumerations and functions prototypes -* -* This file defines metadata item, metadata type, metadata flags, metadata containers, and function -* prototypes necessary creating psLib metadata APIs -* -* @ingroup Metadata -* -* @author Robert DeSonia, MHPCC -* @author Ross Harman, MHPCC -* -* @version $Revision: 1.53 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-06 03:04:35 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ -#ifndef PS_METADATA_H -#define PS_METADATA_H - -#include -#include -#include -#include - -#include "psHash.h" -#include "psList.h" -#include "psImage.h" -#include "psLookupTable.h" - -/// @addtogroup Metadata -/// @{ - -/** Metadata item type. - * - * Enumeration for maintaining metadata item types. - */ -typedef enum { - PS_META_S32 = PS_TYPE_S32, ///< psS32 primitive data. - PS_META_F32 = PS_TYPE_F32, ///< psF32 primitive data. - PS_META_F64 = PS_TYPE_F64, ///< psF64 primitive data. - PS_META_BOOL = PS_TYPE_BOOL, ///< psBool primitive data. - PS_META_LIST = 0x10000, ///< List data (Stored as item.data.list). - PS_META_STR, ///< String data (Stored as item.data.V). - PS_META_VEC, ///< Vector data (Stored as item.data.V). - PS_META_IMG, ///< Image data (Stored as item.data.V). - PS_META_HASH, ///< Hash data (Stored as item.data.V). - PS_META_LOOKUPTABLE, ///< Lookup table data (Stored as item.data.V). - PS_META_JPEG, ///< JPEG data (Stored as item.data.V). - PS_META_PNG, ///< PNG data (Stored as item.data.V). - PS_META_ASTROM, ///< Astrometric coefficients (Stored as item.data.V). - PS_META_UNKNOWN, ///< Other data (Stored as item.data.V). - PS_META_MULTI, ///< Used internally, do not create an metadata item of this type. - PS_META_META, ///< Metadata data (Stored as item.data.md). - PS_META_ARRAY ///< Array data (Stored as item.data.V). -} psMetadataType; -#define PS_META_IS_PRIMITIVE(TYPE) \ -(TYPE == PS_META_S32 || \ - TYPE == PS_META_F32 || \ - TYPE == PS_META_F64 || \ - TYPE == PS_META_BOOL) - -#define PS_META_PRIMITIVE_TYPE(METATYPE) ( \ - (METATYPE==PS_META_S32) ? PS_TYPE_S32 : \ - (METATYPE==PS_META_F32) ? PS_TYPE_F32 : \ - (METATYPE==PS_META_F64) ? PS_TYPE_F64 : \ - (METATYPE==PS_META_BOOL) ? PS_TYPE_BOOL : 0 ) - -/** Option flags for psMetadata functions - * - * Enumeration for the modification of the behaviour in psMetadataAddItem. - * - * @see psMetadataAddItem - */ -typedef enum { - PS_META_DEFAULT = 0, ///< default behaviour (duplicate entry is an error) - PS_META_REPLACE = 0x1000000, ///< allow entry to be replaced - PS_META_DUPLICATE_OK = 0x2000000, ///< allow duplicate entries - PS_META_NULL = 0x4000000 ///< psMetadataItem.data is a NULL value -} psMetadataFlags; - -#define PS_METADATA_FLAGS_MASK 0xFF000000 -#define PS_METADATA_TYPE_MASK 0x00FFFFFF - -/** Metadata data structure. - * - * Struct for holding metadata items. Metadata items are held in two - * containers. The first employs a doubly-linked list to preserve the order - * of the metadata. The second container employs a hash table which - * allows fast lookup when given a metadata keyword. - */ -typedef struct psMetadata -{ - psList* list; ///< Metadata in linked-list - psHash* table; ///< Metadata in a hash table - void *lock; ///< Optional lock for thread safety -} -psMetadata; - -/** Metadata iterator - * - * Iterator for metadata. - */ -typedef struct -{ - psListIterator* iter; ///< iterator for the psMetadata's psList - regex_t* regex; ///< the subsetting regular expression -} -psMetadataIterator; - -/** Metadata item data structure. - * - * Struct for maintaining metadata items of varying types. It also contains - * information about the item name, flags, comments, and other items with the same name. - */ -typedef struct psMetadataItem -{ - const psS32 id; ///< Unique ID for metadata item. - psString name; ///< Name of metadata item. - psMetadataType type; ///< Type of metadata item. - union { - psBool B; ///< boolean data - psS32 S32; ///< Signed 32-bit integer data. - psF32 F32; ///< Single-precision float data. - psF64 F64; ///< Double-precision float data. - psList *list; ///< List data. - psMetadata *md; ///< Metadata data. - psPtr V; ///< Pointer to other type of data. - } data; ///< Union for data types. - psString comment; ///< Optional comment ("", not NULL). -} -psMetadataItem; - -/** Create a metadata item. - * - * Returns a fill psMetadataItem ready for insertion into the psMetadata - * struct. The name argument specifies the name to use for this item, and - * may include sprintf formatting codes. The format entry specifies both - * the metadata type and optional flags and is created by bit-wise or of the - * appropriate type and flag. The comment argument is a fixed string used to - * comment the metadata item. The arguments to the name formatting codes and - * the metadata itself are passed as arguments following the comment string. - * The data must be a pointer for any of the elements stored in data.void. - * The argument list must be interpreted appropriately by the va_list - * operators in the function specified size and type. - * - * @return psMetadataItem* : Pointer metadata item. - */ -psMetadataItem* psMetadataItemAlloc( - const char *name, ///< Name of metadata item. - psMetadataType type, ///< Type of metadata item. - const char *comment, ///< Comment for metadata item. - ... ///< Arguments for name formatting and metadata item data. -) -; - -/** Create a metadata item with specified string data. - * - * Returns a fill psMetadataItem ready for insertion into the psMetadata - * struct. - * - * @return psMetadataItem* : Pointer metadata item. - */ -psMetadataItem* psMetadataItemAllocStr( - const char* name, ///< Name of metadata item. - const char* comment, ///< Comment for metadata item. - const char* value ///< the value of the metadata item. -); - -/** Create a metadata item with specified psF32 data. - * - * Returns a fill psMetadataItem ready for insertion into the psMetadata - * struct. - * - * @return psMetadataItem* : Pointer metadata item. - */ -psMetadataItem* psMetadataItemAllocF32( - const char* name, ///< Name of metadata item. - const char* comment, ///< Comment for metadata item. - psF32 value ///< the value of the metadata item. -); - -/** Create a metadata item with specified psF64 data. - * - * Returns a fill psMetadataItem ready for insertion into the psMetadata - * struct. - * - * @return psMetadataItem* : Pointer metadata item. - */ -psMetadataItem* psMetadataItemAllocF64( - const char* name, ///< Name of metadata item. - const char* comment, ///< Comment for metadata item. - psF64 value ///< the value of the metadata item. -); - -/** Create a metadata item with specified psS32 data. - * - * Returns a fill psMetadataItem ready for insertion into the psMetadata - * struct. - * - * @return psMetadataItem* : Pointer metadata item. - */ -psMetadataItem* psMetadataItemAllocS32( - const char* name, ///< Name of metadata item. - const char* comment, ///< Comment for metadata item. - psS32 value ///< the value of the metadata item. -); - -/** Create a metadata item with specified psBool data. - * - * Returns a fill psMetadataItem ready for insertion into the psMetadata - * struct. - * - * @return psMetadataItem* : Pointer metadata item. - */ -psMetadataItem* psMetadataItemAllocBool( - const char* name, ///< Name of metadata item. - const char* comment, ///< Comment for metadata item. - bool value ///< the value of the metadata item. -); - -#ifndef SWIG -/** Create a metadata item with va_list. - * - * Returns a fill psMetadataItem ready for insertion into the psMetadata - * struct. The name argument specifies the name to use for this item, and - * may include sprintf formatting codes. The format entry specifies both - * the metadata type and optional flags and is created by bit-wise or of the - * appropriate type and flag. The comment argument is a fixed string used to - * comment the metadata item. The arguments to the name formatting codes and - * the metadata itself are passed as arguments following the comment string. - * The data must be a pointer for any of the elements stored in data.void. - * The argument list must be interpreted appropriately by the va_list - * operators in the function specified size and type. - * - * @return psMetadataItem* : Pointer metadata item. - */ -psMetadataItem* psMetadataItemAllocV( - const char *name, ///< Name of metadata item. - psMetadataType type, ///< Type of metadata item. - const char *comment, ///< Comment for metadata item. - va_list list ///< Arguments for name formatting and metadata item data. -); -#endif // #ifndef SWIG - -/** Create a metadata collection. - * - * Returns an empty metadata container with fully allocated internal metadata - * containers. - * - * @return psMetadata* : Pointer metadata. - */ -psMetadata* psMetadataAlloc(void); - -/** Add existing metadata item to metadata collection. - * - * Add a metadata item that has already been created to the metadata - * collection. - * - * @return bool: True for success, false for failure. - */ -bool psMetadataAddItem( - psMetadata* md, ///< Metadata collection to insert metadat item. - const psMetadataItem* item, ///< Metadata item to be added. - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - psS32 flags ///< Options flag mask, see psMetadataFlags enum -); - -/** Create and add a metadata item to metadata collection. - * - * Creates a new metadata item add to the metadata collection. - * - * @return bool: True for success, false for failure. - */ -bool psMetadataAdd( - psMetadata* md, ///< Metadata collection to insert metadata item. - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char *name, ///< Name of metadata item. - int format, ///< Type of metadata item (psMetadataType) and options (psMetadataFlags) - const char *comment, ///< Comment for metadata item. - ... ///< Arguments for name formatting and metadata item data. -); - -#ifndef SWIG -/** Create and add a metadata item to metadata collection. - * - * Creates a new metadata item add to the metadata collection. - * - * @return bool: True for success, false for failure. - */ -bool psMetadataAddV( - psMetadata* md, ///< Metadata collection to insert metadata item. - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char *name, ///< Name of metadata item. - int format, ///< Type of metadata item (psMetadataType) and options (psMetadataFlags) - const char *comment, ///< Comment for metadata item. - va_list list ///< Arguments for name formatting and metadata item data. -); -#endif // #ifndef SWIG - -/** Add a psS32 value to metadata collection. - * - * @return bool: True for success, False for failure. - */ -bool psMetadataAddS32( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psS32 value ///< Value for metadata item data -); - -/** Add a psF32 value to metadata collection. - * - * @return bool: True for success, False for failure. -*/ -bool psMetadataAddF32( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psF32 value ///< Value for metadata item data -); - -/** Add a psF64 value to metadata collection. - * - * @return bool: True for success, False for failure. -*/ -bool psMetadataAddF64( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psF64 value ///< Value for metadata item data -); - -/** Add a psList to metadata collection. - * - * @return psBool: True for success, False for failure. - */ -psBool psMetadataAddList( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psList* value ///< psList for metadata item data -); - -/** Add a string to metadata collection. - * - * @return bool: True for success, False for failure. - */ -bool psMetadataAddStr( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - const char* value ///< String for metadata item data -); - -/** Add a vector to metadata collection. - * - * @return psBool: True for success, False for failure. - */ -psBool psMetadataAddVector( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psVector* value ///< Vector for metadata item data -); - -/** Add a array to metadata collection. - * - * @return psBool: True for success, False for failure. - */ -psBool psMetadataAddArray( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psArray* value ///< Vector for metadata item data -); - -/** Add an Image to metadata collection. - * - * @return psBool: True for success, False for failure. - */ -psBool psMetadataAddImage( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psImage* value ///< Image for metadata item data -); - -/** Add a Hash to metadata collection. - * - * @return psBool: True for success, False for failure. - */ -psBool psMetadataAddHash( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psHash* value ///< Hash for metadata item data -); - -/** Add a LookupTable to metadata collection. - * - * @return psBool: True for success, False for failure. - */ -psBool psMetadataAddLookupTable( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psLookupTable* value ///< LookupTable for metadata item data -); - -/** Add an Unknown (psPtr) to metadata collection. - * - * @return psBool: True for success, False for failure. - */ -psBool psMetadataAddUnknown( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psPtr value ///< Unknown for metadata item data -); - -/** Add Metadata to metadata collection. - * - * @return psBool: True for success, False for failure. - */ -psBool psMetadataAddMetadata( - psMetadata* md, ///< Metadata collection to insert metadata item - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* name, ///< Name of metadata item - const char* comment, ///< Comment for metadata item - psMetadata* value ///< Metadata for metadata item data -); - -/** Remove an item from metadata collection. - * - * Items may be removed from metadata by specifing a key or location. If the - * name is null, the where argument is used instead. If name is not null, - * where is set to PS_LIST_UNKNOWN. If the item is found, it is removed from - * the metadata and true is returned. If the key is not unique, then all - * items corresponding to it are removed. - * - * @return bool: True for success, false for failure. - */ -bool psMetadataRemove( - psMetadata* md, ///< Metadata collection to remove metadata item. - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char * key ///< Name of metadata key. -); - -/** Find an item in the metadata collection based on key name. - * - * Items may be found in the metadata by providing a key. If the key is - * non-unique, the first item is returned. If the item is not found, null is - * returned. - * - * @return psMetadataItem* : Pointer metadata item. - */ -psMetadataItem* psMetadataLookup( - const psMetadata * md, ///< Metadata collection to lookup metadata item. - const char * key ///< Name of metadata key. -); - -/** Find an item in the metadata collection based on key name and return its double precision value. - * - * Items may be found in the metadata by providing a key. If the key is - * non-unique, the value of the first item is returned. If the item is not found, zero is - * returned. - * - * @return psF64 : Value of metadata item. - */ -psF64 psMetadataLookupF64( - bool *status, ///< Status of lookup. - const psMetadata *md, ///< Metadata collection to lookup metadata item. - const char *key ///< Name of metadata key. -); - -/** Find an item in the metadata collection based on key name and return its single precision value. - * - * Items may be found in the metadata by providing a key. If the key is - * non-unique, the value of the first item is returned. If the item is not found, zero is - * returned. - * - * @return psF32 : Value of metadata item. - */ -psF32 psMetadataLookupF32( - bool *status, ///< Status of lookup. - const psMetadata *md, ///< Metadata collection to lookup metadata item. - const char *key ///< Name of metadata key. -); - -/** Find an item in the metadata collection based on key name and return its integer value. - * - * Items may be found in the metadata by providing a key. If the key is - * non-unique, the value of the first item is returned. If the item is not found, zero is - * returned. - * - * @return psS32 : Value of metadata item. - */ -psS32 psMetadataLookupS32( - bool *status, ///< Status of lookup. - const psMetadata *md, ///< Metadata collection to lookup metadata item. - const char *key ///< Name of metadata key. -); - -/** Find an item in the metadata collection based on key name and return its boolean value. - * - * Items may be found in the metadata by providing a key. If the key is - * non-unique, the value of the first item is returned. If the item is not found, zero is - * returned. - * - * @return bool : Value of metadata item. - */ -bool psMetadataLookupBool( - bool *status, ///< Status of lookup. - const psMetadata *md, ///< Metadata collection to lookup metadata item. - const char *key ///< Name of metadata key. -); - -/** Find an item in the metadata collection based on key name and return its integer value. - * - * Items may be found in the metadata by providing a key. If the key is - * non-unique, the value of the first item is returned. If the item is not found, zero is - * returned. - * - * @return void* : Value of metadata item. - */ -psPtr psMetadataLookupPtr( - bool *status, ///< Status of lookup. - const psMetadata* md, ///< Metadata collection to lookup metadata item. - const char *key ///< Name of metadata key. -); - -/** Find an item in the metadata collection based on list index. - * - * Items may be found in the metadata by their entry position in the list - * container. - * - * @return psMetadataItem* : Pointer metadata item. - */ -psMetadataItem* psMetadataGet( - const psMetadata* md, ///< Metadata collection to retrieve metadata item. - long location ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL -); - -/** Creates a psMetadataIterator to iterate over the specified psMetadata. - * - * Supports the subsetting of the metadata via keyword using regular - * expression. If no regular expression is specified, iteration - * over the entire psMetadata is performed. - * - * @return psMetadataIterator* a new psMetadataIterator, of NULL if error occurred - */ -psMetadataIterator* psMetadataIteratorAlloc( - psMetadata* md, ///< the psMetadata to iterate with - long location, ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL - const char* regex - ///< A regular expression for subsetting the psMetadata. If NULL, no - ///< subsetting is performed. -); - -/** Set the iterator of the psMetadat to a given position. If location is - * invalid the iterator position is not changed. - * - * @return bool TRUE if iterator successfully set, otherwise FALSE. -*/ -bool psMetadataIteratorSet( - psMetadataIterator* iterator, ///< psMetadata iterator - long location ///< index number, PS_LIST_HEAD, or PS_LIST_TAIL -); - -/** Position the specified iterator to the next matching item in psMetadata, - * given the regular expression of the iterator - * - * @return psPtr the psMetadataItem at the original iterator position - * or NULL if the iterator went past the end of the list. - */ -psMetadataItem* psMetadataGetAndIncrement( - psMetadataIterator* iterator ///< iterator to move -); - -/** Position the specified iterator to the previous matching item in psMetadata, - * given the regular expression of the iterator - * - * @return psPtr the psMetadataItem at the original iterator position - * or NULL if the iterator went past the beginning of the - * list. - */ -psMetadataItem* psMetadataGetAndDecrement( - psMetadataIterator* iterator ///< iterator to move -); - -/// @} - -#endif // #ifndef PS_METADATA_H Index: unk/psLib/src/collections/psMetadataIO.c =================================================================== --- /trunk/psLib/src/collections/psMetadataIO.c (revision 4545) +++ (revision ) @@ -1,1580 +1,0 @@ -/** @file psMetadataIO.c -* -* @brief Contains metadata input/output functions. -* -* This file defines functions to read and write metadata to/from an external file. -* -* @ingroup Metadata -* -* @author Ross Harman, MHPCC -* @author Eric Van Alst, MHPCC -* -* @version $Revision: 1.35 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-06 03:04:35 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#include -#include -#include -#include -#include - -#include "psAbort.h" -#include "psType.h" -#include "psMemory.h" -#include "psError.h" -#include "psString.h" -#include "psList.h" -#include "psHash.h" -#include "psVector.h" -#include "psMetadata.h" -#include "psMetadataIO.h" -#include "psConstants.h" -#include "psAstronomyErrors.h" - -/******************************************************************************/ -/* DEFINE STATEMENTS */ -/******************************************************************************/ - -/** Check for FITS errors */ -#define FITS_ERROR(STRING,PS_ERROR) \ -fits_get_errstatus(status, fitsErr); \ -psError(PS_ERR_IO,true, STRING, PS_ERROR, fitsErr); \ -status = 0; \ -fits_close_file(fd, &status); \ -if(status){ \ - fits_get_errstatus(status, fitsErr); \ - psError(PS_ERR_IO,true, "Couldn't close FITS file. FITS error: %s", fitsErr); \ -} \ -status = 0; \ -psFree(output); \ -return NULL; - -/** Maximum size of a FITS line */ -#define FITS_LINE_SIZE 80 - -/** Maximum size of a string */ -#define MAX_STRING_LENGTH 256 - - -/******************************************************************************/ -/* TYPE DEFINITIONS */ -/******************************************************************************/ - -// None - -/*****************************************************************************/ -/* GLOBAL VARIABLES */ -/*****************************************************************************/ - -// None - -/*****************************************************************************/ -/* FILE STATIC VARIABLES */ -/*****************************************************************************/ - -// None - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - LOCAL */ -/*****************************************************************************/ - -static void saxEndElement(void *ctx, const xmlChar *tagName); -static void initVectorXml(void *ctx, char *tagName); -static void initMetadataItemXml(void *ctx, char *tagName); -static void saxStartElement(void *ctx, const xmlChar *tagName, const xmlChar **atts); -static psMetadata* getMetadataType(char *linePtr); -static psMetadata* setMetadataItem(psMetadata* template, char* linePtr) -; -static void parseLevelInfoFree(p_psParseLevelInfo* info); -static psBool parseLine(psS32* level, psArray* levelArray, - char* linePtr, psS32 lineCount, char* fileName, psBool overwrite); -static psBool parseMetadataItem(char* keyName, psS32* level, psArray* levelArray, - char* linePtr, psS32 lineCount, char* fileName, psMetadataFlags flags); - -static void parseLevelInfoFree(p_psParseLevelInfo* info) -{ - psFree(info->nonUniqueKeyArray); - psFree(info->typeArray); - psFree(info->templateArray); - psFree(info->name); - psFree(info->metadata); -} - -// Determines if a line is blank (whitespace only) or a commentline. It returns true if so. The input string -// must be null terminated. -psBool ignoreLine(char *inString) -{ - while(*inString!='\0' && *inString!='#') { - if(!isspace(*inString)) { - return false; - } - inString++; - } - - return true; -} - - -// Removes leading and trailing whitespace and # characters from a string. The cleaned string is a new null -// terminated copy of the original input string. -char *cleanString(char *inString, psS32 sLen, psBool ignoreComment) -{ - char *ptrB = NULL; - char *ptrE = NULL; - char *cleaned = NULL; - - // Initialize begining of string pointer - ptrB = inString; - - // Skip over leading # or whitespace - if(ignoreComment) { - while (isspace(*ptrB) || *ptrB=='#') { - ptrB++; - } - } else { - while (isspace(*ptrB)) { - ptrB++; - } - } - - // Skip over trailing whitespace, null terminators, and # characters - ptrE = inString + sLen; - if(ignoreComment) { - while(isspace(*ptrE) || *ptrE=='\0' || *ptrE=='#') { - ptrE--; - } - } else { - while(isspace(*ptrE) || *ptrE=='\0') { - ptrE--; - } - } - - // Length, sLen, does not include '\0' - sLen = ptrE - ptrB + 1; - - // Adds '\0' to end of string and +1 to sLen - if(sLen < 0 ) { - cleaned = NULL; - } else { - cleaned = psStringNCopy(ptrB, sLen); - } - - return cleaned; -} - -// Count repeat occurances of a single character within a line. The input string must be null terminated. -psS32 repeatedChars(char *inString, char ch) -{ - psS32 count = 0; - - while(*inString!='\0') { - if(*inString == ch) { - count++; - } - inString++; - } - - return count; -} - -// Returns cleaned token based on delimiter, but not including delimiter. Also changes the pointer location -// the beginning of the string. Tokens are newly allocated null terminated strings. -char* getToken(char **inString, char *delimiter, psS32 *status, psBool ignoreComment) -{ - char *cleanToken = NULL; - char *convertChar = NULL; - psS32 sLen = 0; - - // Convert tab characters to white space - while((convertChar=strchr(*inString,'\t')) != NULL ) { - *convertChar = ' '; - } - - // Skip over leading whitespace - while(isspace(**inString)) { - (*inString)++; - } - - // Length of token, not including delimiter - sLen = strcspn(*inString, delimiter); - if(sLen) { - - // Create new, cleaned, and null terminated token - cleanToken = cleanString(*inString, sLen,ignoreComment); - - // Move to end of token - (*inString) += sLen; - } else if(**inString!='\0' && sLen==0) { - *status = 1; - } - - return cleanToken; -} - -// Returns single parsed value as a double precision number. The input string must be cleaned and null -// terminated. -double parseValue(char *inString, psS32 *status) -{ - char *end = NULL; - double value = 0.0; - - value = strtod(inString, &end); - if(*end != '\0') { - *status = 1; - } else if(inString==end) { - *status = 1; - } - - return value; -} - -/** Returns true or false. 'T', 't', '1', 'F', 'f', and '0' are acceptable, parsable variations. */ -psBool parseBool(char *inString, psS32 *status) -{ - psBool value = false; - - - if(*inString=='T' || *inString=='t' || *inString=='1') { - value = true; - } else if(*inString=='F' || *inString=='f' || *inString=='0') { - value = false; - } else { - *status = 1; - } - - return value; -} - -/** Returns parsed vector filled with with data. The input string must be null terminated. */ -psVector* parseVector(char *inString, psElemType elemType, psS32 *status) -{ - char* end = NULL; - char* saveValue = NULL; - psS32 i = 0; - psS32 numValues = 0; - double value = 0.0; - psVector* vec = NULL; - - // Cycle through string and count entries - saveValue = inString; - while(*inString!='\0') { - strtod(inString, &end); - if(inString==end) { - *status = 1; - return NULL; - } - while(*end==' ' || *end==',') { // Commas or spaces may be used as delimiters for vector values - end++; - } - inString=end; - numValues++; - } - - // Cycle through string and convert string values to values - if(numValues) { - inString = saveValue; - end = NULL; - vec = psVectorAlloc(numValues, elemType); - - while(*inString!='\0') { - value = strtod(inString, &end); - if(inString==end) { - *status = 1; - return vec; - } - switch(elemType) { - case PS_TYPE_U8: - vec->data.U8[i++] = (psU8)value; - break; - case PS_TYPE_U16: - vec->data.U16[i++] = (psU16)value; - break; - case PS_TYPE_U32: - vec->data.U32[i++] = (psU32)value; - break; - case PS_TYPE_U64: - vec->data.U64[i++] = (psU64)value; - break; - case PS_TYPE_S8: - vec->data.S8[i++] = (psS8)value; - break; - case PS_TYPE_S16: - vec->data.S16[i++] = (psS16)value; - break; - case PS_TYPE_S32: - vec->data.S32[i++] = (psS32)value; - break; - case PS_TYPE_S64: - vec->data.S64[i++] = (psS64)value; - break; - case PS_TYPE_F32: - vec->data.F32[i++] = (psF32)value; - break; - case PS_TYPE_F64: - vec->data.F64[i++] = (psF64)value; - break; - default: - *status = 1; - psError(PS_ERR_BAD_PARAMETER_VALUE,true, - PS_ERRORTEXT_psMetadataIO_TYPE_INVALID, - elemType); - } - - while(*end==' ' || *end==',') { - end++; - } - inString=end; - } - } - - return vec; -} - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - PUBLIC */ -/*****************************************************************************/ - -p_psParseLevelInfo* p_psParseLevelInfoAlloc(void) -{ - - p_psParseLevelInfo* info = NULL; - - // Allocate memory for parse level info - info = (p_psParseLevelInfo*)psAlloc(sizeof(p_psParseLevelInfo)); - - // If allocation successful then initialize members - if(info != NULL) { - - info->nonUniqueKeyArray = psArrayAlloc(10); - info->nonUniqueKeyArray->n = 0; - - info->typeArray = psArrayAlloc(10); - info->typeArray->n = 0; - - info->templateArray = psArrayAlloc(10); - info->templateArray->n = 0; - - info->metadata = NULL; - info->name = NULL; - - // Set memory deallocator - psMemSetDeallocator(info,(psFreeFunc)parseLevelInfoFree); - } - return info; -} - -bool psMetadataItemPrint(FILE * fd, const char *format, const psMetadataItem* item) -{ - psMetadataType type; - psBool success = true; - - PS_ASSERT_PTR_NON_NULL(fd, success); - PS_ASSERT_PTR_NON_NULL(format, success); - PS_ASSERT_PTR_NON_NULL(item, success); - - type = item->type; - - // determining the format type - char* fType = strchr(format,'%'); - if (fType == NULL) { - // well, the format contains no reference to the metadataItem's data: - // that is truly trival to do! - fprintf(fd,format); - return success; - } - - // skip over any format modifiers - const char* formatEnd = format+strlen(format); - while ( (fType < formatEnd) && - (strchr(" +-01234567890.$#, hlL",*(++fType)) != NULL) ) {} - - #define METADATAITEM_NUMERIC_CAST(FORMAT_TYPE) { \ - switch(type) { \ - case PS_META_BOOL: \ - fprintf(fd, format, (FORMAT_TYPE) item->data.B); \ - break; \ - case PS_META_S32: \ - fprintf(fd,format,(FORMAT_TYPE) item->data.S32); \ - break; \ - case PS_META_F32: \ - fprintf(fd, format,(FORMAT_TYPE) item->data.F32); \ - break; \ - case PS_META_F64: \ - fprintf(fd, format,(FORMAT_TYPE) item->data.F64); \ - break; \ - default: \ - psError(PS_ERR_BAD_PARAMETER_TYPE,true, \ - PS_ERRORTEXT_psMetadata_METATYPE_INVALID, (int)type); \ - success = false; \ - } \ - } - - switch(*fType) { - case 'd': - case 'i': - case 'c': - METADATAITEM_NUMERIC_CAST(int) - break; - case 'o': - case 'u': - case 'x': - case 'X': - METADATAITEM_NUMERIC_CAST(unsigned int) - break; - case 'e': - case 'E': - case 'f': - case 'F': - case 'g': - case 'G': - case 'a': - case 'A': - METADATAITEM_NUMERIC_CAST(double) - break; - case 's': - if (type == PS_META_STR) { - fprintf(fd,format,(char*)item->data.V); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE,true, - PS_ERRORTEXT_psMetadata_METATYPE_INVALID, (int)type); - success = false; - } - break; - case 'p': - fprintf(fd,format,item->data.V); - break; - default: - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psMetadata_FORMAT_INVALID, *fType); - break; - } - - return success; -} - - -psMetadata* psMetadataReadHeader(psMetadata* output, char *extName, psS32 extNum, char *fileName) -{ - psBool tempBool; - psBool success; - char keyType; - char keyName[FITS_LINE_SIZE]; - char keyValue[FITS_LINE_SIZE]; - char keyComment[FITS_LINE_SIZE]; - char fitsErr[MAX_STRING_LENGTH]; - psS32 i; - psS32 hduType = 0; - psS32 status = 0; - psS32 numKeys = 0; - psS32 keyNum = 0; - fitsfile *fd = NULL; - - PS_ASSERT_PTR_NON_NULL(fileName,NULL); - - fits_open_file(&fd, fileName, READONLY, &status); - if(fd == NULL || status != 0) { - FITS_ERROR("FITS error while opening file: %s %s", fileName); - return NULL; - } - - if (extName == NULL && extNum < 1) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psMetadataIO_EXTNUM_NOTPOSITIVE, - extNum); - return NULL; - } - - // Allocate metadata if user didn't - if (output == NULL) { - output = psMetadataAlloc(); - } - - // Move to user designated HDU number or HDU name in FITS file. HDU numbers starts at one. - if (extName != NULL) { - if (fits_movnam_hdu(fd, ANY_HDU, extName, 0, &status) != 0) { - FITS_ERROR("FITS error while locating header %s: %s", extName); - } - } else { - if (fits_movabs_hdu(fd, extNum, &hduType, &status) != 0) { - FITS_ERROR("FITS error while locating header %d: %s", extNum); - } - } - - // Get number of key names - if (fits_get_hdrpos(fd, &numKeys, &keyNum, &status) != 0) { - FITS_ERROR("FITS error while reading key %d: %s", keyNum); - } - - // Get each key name. Keywords start at one. - for (i = 1; i <= numKeys; i++) { - if (fits_read_keyn(fd, i, keyName, keyValue, keyComment, &status) != 0) { - FITS_ERROR("FITS error while reading key %d: %s", keyNum); - } - if (fits_get_keytype(keyValue, &keyType, &status) != 0) { - fits_get_errstatus(status, fitsErr); - if (status != VALUE_UNDEFINED) { - FITS_ERROR("FITS error while determining key %d type: %s", keyNum); - } else { - // Some keywords are still valid if they don't have a type (like COMMENTS and HISTORY) - keyType = 'C'; - status = 0; - } - } - - switch (keyType) { - case 'I': - success = psMetadataAdd(output, PS_LIST_TAIL, keyName, - PS_META_S32 | PS_META_DUPLICATE_OK, - keyComment, atoi(keyValue)); - break; - case 'F': - success = psMetadataAdd(output, PS_LIST_TAIL, keyName, - PS_META_F64 | PS_META_DUPLICATE_OK, - keyComment, atof(keyValue)); - break; - case 'C': - success = psMetadataAdd(output, PS_LIST_TAIL, keyName, - PS_META_STR | PS_META_DUPLICATE_OK, - keyComment, keyValue); - break; - case 'L': - tempBool = (keyValue[0] == 'T') ? 1 : 0; - success = psMetadataAdd(output, PS_LIST_TAIL, keyName, - PS_META_BOOL | PS_META_DUPLICATE_OK, - keyComment, tempBool); - break; - case 'U': - case 'X': - default: - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_FITS_METATYPE_INVALID, keyType); - return output; - } - - if (!success) { - psError(PS_ERR_UNKNOWN, false, PS_ERRORTEXT_psMetadataIO_ADD_FAILED, keyName); - return output; - } - } - - return output; -} - -static psMetadata* getMetadataType(char* linePtr) -{ - psMetadata* metadataTemplate = NULL; - psS32 status = 0; - char* token = NULL; - psMetadataItem* tempItem = NULL; - - // Loop through line and generate metadata items for each token found - while((token = getToken(&linePtr," ",&status,false)) != NULL ) { - - // If not allocated then allocate new metadata - if(metadataTemplate == NULL) { - metadataTemplate = psMetadataAlloc(); - } - - // Look for comment indicator # - if(strstr(token,"#") != 0) { - psFree(token); - break; - } - - // Create metadata item to represent token read - tempItem = psMetadataItemAllocStr(token,"",""); - if(tempItem == NULL) { - psFree(metadataTemplate); - psFree(token); - metadataTemplate = NULL; - break; - } - - // Add item to template - if(!psMetadataAddItem(metadataTemplate, tempItem, PS_LIST_TAIL, PS_META_DEFAULT)) { - psFree(metadataTemplate); - psFree(tempItem); - psFree(token); - metadataTemplate = NULL; - break; - } - psFree(tempItem); - psFree(token); - } - - return metadataTemplate; -} - -static psMetadata* setMetadataItem(psMetadata* template, char* linePtr) -{ - psMetadata* md = NULL; - psS32 items = 0; - char* token = NULL; - psS32 status = 0; - psMetadataItem* mdItem = NULL; - psMetadataItem* templateItem = NULL; - psListIterator* iter = NULL; - - // Determine the number of items in template - items = template->list->n; - if(items > 0 ) { - - // Allocate metadata - md = psMetadataAlloc() - ; - - // Point to first item in template - iter = psListIteratorAlloc(template-> - list,PS_LIST_HEAD,true); - - // For each item in template parse line string for values - for(psS32 i = 0; - i < items; - i++) { - - // Get template item - templateItem = psListGetAndIncrement(iter) - ; - if(templateItem == NULL) { - psFree(md); - md = NULL; - break; - } - - // Get the next token on the line - token = getToken(&linePtr," ",&status,false); - if(token != NULL) { - // Allocate metadata item - mdItem = psMetadataItemAllocStr(templateItem->name,templateItem->comment,token); - if(mdItem == NULL) { - psFree(md); - md = NULL; - psFree(token); - break; - } - // Add item to metadata - if(!psMetadataAddItem(md, mdItem, PS_LIST_TAIL, PS_META_DEFAULT)) { - psFree(md); - md = NULL; - psFree(mdItem); - psFree(token); - break; - } - psFree(mdItem); - } else { - // Missing items - psFree(md); - md = NULL; - break; - } - - psFree(token); - } - psFree(iter); - } - return md; -} - -psBool parseMetadataItem(char* keyName, psS32* level, psArray* levelArray, - char* linePtr, psS32 lineCount, char* fileName, psMetadataFlags flags) -{ - psBool returnValue = true; - psBool addStatus = false; - psMetadataType mdType = PS_META_UNKNOWN; - psElemType vectorType = PS_TYPE_S8; - char* strType = NULL; - char* strValue = NULL; - char* strComment = NULL; - psS32 status = 0; - psMetadata* md = NULL; - psF64 tempDbl = 0.0; - psBool tempBool = false; - psS32 tempInt = 0; - psVector* tempVec = NULL; - char* tempStr = NULL; - psArray* nonUniqueKeys = NULL; - psBool typeFound = false; - psArray* typeArray = NULL; - psArray* templateArray = NULL; - psMetadata* tempMeta = NULL; - p_psParseLevelInfo* nextLevelInfo = NULL; - - // Get the metadata item type - strType = getToken(&linePtr, " ", &status,true); - - // Check for no type - if(strType==NULL) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_FILE_ELEMENT_NULL, "type",lineCount, - fileName); - returnValue = false; - } else { - - // Set metadata type based on type token - - // Check if the keyName specifies a vector and if so use strType token to find vector type - if(*keyName == '@') { - mdType = PS_META_VEC; - // Get the type of vector - if(!strncmp(strType, "U8", 2)) { - vectorType = PS_TYPE_U8; - } else if (!strncmp(strType,"U16",3)) { - vectorType = PS_TYPE_U16; - } else if (!strncmp(strType,"U32",3)) { - vectorType = PS_TYPE_U32; - } else if (!strncmp(strType,"U64",3)) { - vectorType = PS_TYPE_U64; - } else if (!strncmp(strType,"S8",2)) { - vectorType = PS_TYPE_S8; - } else if (!strncmp(strType,"S16",3)) { - vectorType = PS_TYPE_S16; - } else if (!strncmp(strType,"S32",3)) { - vectorType = PS_TYPE_S32; - } else if (!strncmp(strType,"S64",3)) { - vectorType = PS_TYPE_S64; - } else if (!strncmp(strType,"F32",3)) { - vectorType = PS_TYPE_F32; - } else if (!strncmp(strType,"F64",3)) { - vectorType = PS_TYPE_F64; - } else { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, "", keyName, - strType, lineCount, fileName); - psFree(strType); - return false; - } - } else if(!strncmp(strType, "STR", 3)) { - mdType = PS_META_STR; - } else if(!strncmp(strType, "BOOL", 4)) { - mdType = PS_META_BOOL; - } else if(!strncmp(strType, "S32", 3)) { - mdType = PS_META_S32; - } else if(!strncmp(strType, "F32", 3)) { - mdType = PS_META_F32; - } else if(!strncmp(strType, "F64", 3)) { - mdType = PS_META_F64; - } else if(!strncmp(strType, "MULTI", 5)) { - mdType = PS_META_MULTI; - } else if(!strncmp(strType, "METADATA", 8)) { - mdType = PS_META_META; - } else { - // Search through user types - typeArray = ((p_psParseLevelInfo*)(levelArray->data[*level]))->typeArray; - templateArray = ((p_psParseLevelInfo*)(levelArray->data[*level]))->templateArray; - for(psS32 k = 0; k < typeArray->n; k++) { - if(strcmp(strType,(char*)typeArray->data[k]) == 0) { - tempMeta = setMetadataItem((psMetadata*)templateArray->data[k],linePtr); - if(tempMeta != NULL) { - // Add metadata item - md = ((p_psParseLevelInfo*)(levelArray->data[*level]))->metadata; - addStatus = psMetadataAdd(md,PS_LIST_TAIL,keyName,PS_META_META | flags,"",tempMeta); - // Check for add failure - if (! addStatus) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_OVERWRITE_ITEM, - keyName, lineCount, fileName); - psFree(strType); - psFree(tempMeta); - return false; - } - psFree(tempMeta); - } else { - // Metadata type read error - psError(PS_ERR_IO,true,PS_ERRORTEXT_psMetadataIO_FILE_ELEMENT_NULL, - keyName,lineCount,fileName); - psFree(strType); - return false; - } - typeFound = true; - break; - } - } - if(!typeFound) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_FILE_TYPE_INVALID, - strType, lineCount,fileName); - psFree(strType); - return false; - } else { - psFree(strType); - return true; - } - } - } - - // If type is not MULTI or META then get the value and comment - if((mdType != PS_META_MULTI) && (mdType != PS_META_META)) { - // Get the metadata item value if there is one. - status = 0; - strValue = getToken(&linePtr, "#", &status,true); - if(status) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_FILE_ELEMENT_NULL, "value", lineCount, - fileName); - psFree(strType); - psFree(strValue); - return false; - } - if(strValue==NULL) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_FILE_ELEMENT_NULL, "value", lineCount, - fileName); - psFree(strType); - psFree(strValue); - return false; - } - // Not all lines will have comments, so NULL is ok. - status = 0; - strComment = getToken(&linePtr,"~", &status,true); - if(status) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_FILE_ELEMENT_NULL, "comment", lineCount, - fileName); - psFree(strType); - psFree(strValue); - psFree(strComment); - } - } - - // Need to add item to metadata so get pointer to metadata - status = 0; - md = ((p_psParseLevelInfo*)(levelArray->data[*level]))->metadata; - nonUniqueKeys = ((p_psParseLevelInfo*)(levelArray->data[*level]))->nonUniqueKeyArray; - switch(mdType) { - case PS_META_STR: - addStatus = psMetadataAdd(md, PS_LIST_TAIL, keyName, - mdType | flags, - strComment, strValue); - break; - case PS_META_BOOL: - tempBool = parseBool(strValue, &status); - if(!status) { - addStatus = psMetadataAdd(md, PS_LIST_TAIL, keyName, - mdType | flags, - strComment, tempBool); - } else { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, strValue, keyName, - strType, lineCount, fileName); - returnValue = false; - } - break; - case PS_META_F32: - case PS_META_F64: - tempDbl = parseValue(strValue, &status); - if(!status) { - addStatus = psMetadataAdd(md, PS_LIST_TAIL, keyName, - mdType | flags, - strComment, tempDbl); - } else { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, strValue, keyName, strType, lineCount, - fileName); - returnValue = false; - } - break; - case PS_META_S32: - tempInt = (psS32)parseValue(strValue, &status); - if(!status) { - addStatus = psMetadataAdd(md, PS_LIST_TAIL, keyName, - mdType | flags, - strComment, tempInt); - } else { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, strValue, keyName, - strType, lineCount, fileName); - returnValue = false; - } - break; - case PS_META_VEC: - tempVec = parseVector(strValue, vectorType, &status); - if(!status) { - addStatus = psMetadataAdd(md, PS_LIST_TAIL, keyName+1, - mdType | flags, - strComment, tempVec); - } else { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, strValue, keyName, - strType, lineCount, fileName); - returnValue = false; - } - psFree(tempVec); - break; - case PS_META_MULTI: - // Add key to non-unique array of keys - // Check for duplicate MULTI lines - addStatus = true; - for(psS32 k=0; k < nonUniqueKeys->n; k++) { - if(strcmp(keyName,(char*)nonUniqueKeys->data[k]) == 0) { - psError(PS_ERR_IO,true,PS_ERRORTEXT_psMetadataIO_DUPLICATE_MULTI, - lineCount,fileName); - psFree(strType); - return false; - } - } - tempStr = psStringCopy(keyName); - nonUniqueKeys = psArrayAdd(nonUniqueKeys,0,tempStr); - addStatus = true; - psFree(tempStr); - break; - case PS_META_META: - // Create next level info - nextLevelInfo = p_psParseLevelInfoAlloc(); - // Create new metadata - nextLevelInfo->metadata = psMetadataAlloc(); - // Save name of metadata - nextLevelInfo->name = psStringCopy(keyName); - // Add next level to levelArray - levelArray = psArrayAdd(levelArray,1,nextLevelInfo); - psFree(nextLevelInfo); - // Increment level counter - (*level)++; - addStatus = true; - break; - default: - psError(PS_ERR_IO,true,PS_ERRORTEXT_psMetadataIO_FILE_TYPE_INVALID, - lineCount,fileName); - break; - } - - // Check if the add status was successful - if (! addStatus) { - // psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_OVERWRITE_ITEM, keyName, lineCount, - // fileName); - returnValue = false; - } - - psFree(strComment); - psFree(strValue); - psFree(strType); - - return returnValue; -} - -psBool parseLine(psS32* level, psArray* levelArray, char* linePtr, - psS32 lineCount, char* fileName, psBool overwrite) -{ - psBool returnValue = true; - psMetadataFlags flags = PS_META_DEFAULT; - char* keyName = NULL; - psS32 status = 0; - psS32 limit = 0; - psMetadata* tempTemplate = NULL; - char* strType = NULL; - psArray* typeArray = NULL; - psArray* templateArray = NULL; - p_psParseLevelInfo* upperLevelInfo = NULL; - p_psParseLevelInfo* lowerLevelInfo = NULL; - psBool addStatus = 0; - - // Set flags if overwrite specified - if(overwrite) { - flags = PS_META_REPLACE; - } - - // If line is not a comment or blank, then extract data - if(!ignoreLine(linePtr)) { - - // Check for more than one '@' in a line - if(repeatedChars(linePtr, '@') > 1) { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psMetadataIO_FILE_MULTIPLE_CHAR, '@', lineCount, fileName); - return false; - } - - // Get metadata item name - keyName = getToken(&linePtr, " ", &status,true); - if(status) { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psMetadataIO_FILE_ELEMENT_NULL, "keyName", lineCount, fileName); - psFree(keyName); - return false; - } - - // Check for special keyName values "TYPE", "END" - if(strcmp(keyName,"TYPE") == 0 ) { - // Get the type name - strType = getToken(&linePtr," ",&status,true); - if(strType == NULL) { - psError(PS_ERR_IO,true,PS_ERRORTEXT_psMetadataIO_FILE_ELEMENT_NULL,"type",lineCount, - fileName); - psFree(keyName); - return false; - } - tempTemplate = getMetadataType(linePtr); - // Check if type was parsed succesfully - if(tempTemplate != NULL) { - // Access type array - typeArray = ((p_psParseLevelInfo*)(levelArray->data[*level]))->typeArray; - // Check if type already exists in array - for(psS32 k=0; k < typeArray->n; k++) { - // Compare type name with the list of current types - if(strcmp(strType,(char*)typeArray->data[k]) == 0) { - psError(PS_ERR_IO,true,PS_ERRORTEXT_psMetadataIO_TYPE_DUPLICATE, - strType,lineCount,fileName); - psFree(tempTemplate); - psFree(keyName); - psFree(strType); - return false; - } - } - // Add key name to array of type - typeArray = psArrayAdd(typeArray,1,strType); - // Add template to array of templates - templateArray = ((p_psParseLevelInfo*)(levelArray->data[*level]))->templateArray; - templateArray = psArrayAdd(templateArray,1,tempTemplate); - psFree(tempTemplate); - } else { - psError(PS_ERR_IO,true,PS_ERRORTEXT_psMetadataIO_FILE_TYPE_INVALID, - strType,lineCount,fileName); - psFree(keyName); - psFree(strType); - return false; - } - psFree(strType); - } else if (strcmp(keyName,"END") == 0 ) { - if(*level > 0) { - upperLevelInfo = ((p_psParseLevelInfo*)(levelArray->data[*level-1])); - lowerLevelInfo = ((p_psParseLevelInfo*)(levelArray->data[*level])); - // Check name in nonunique list - for(psS32 k=0; k < upperLevelInfo->nonUniqueKeyArray->n; k++) { - if(strcmp(upperLevelInfo->nonUniqueKeyArray->data[k],lowerLevelInfo->name) == 0) { - flags = PS_META_DUPLICATE_OK; - break; - } - } - // Add metadata to upper level metadata - addStatus = psMetadataAdd(upperLevelInfo->metadata, - PS_LIST_TAIL,lowerLevelInfo->name, - PS_META_META | flags, - "", - lowerLevelInfo->metadata); - if(!addStatus) { - psFree(keyName); - return false; - } else { - // Remove lower info level - if(!psArrayRemove(levelArray,levelArray->data[*level])) { - psFree(keyName); - return false; - } - psFree(lowerLevelInfo); - (*level)--; - } - } else { - psFree(keyName); - return false; - } - } else { - // Check if key name present in array of non-unique key names - limit = ((p_psParseLevelInfo*)(levelArray->data[*level]))->nonUniqueKeyArray->n; - for(psS32 k=0; k < limit; k++) { - char* name = (char*)((p_psParseLevelInfo*) - (levelArray->data[*level]))->nonUniqueKeyArray->data[k]; - if(strcmp(name,keyName) == 0) { - flags = PS_META_DUPLICATE_OK; - } - } - // Parse metadataItem - if(!parseMetadataItem(keyName,level, levelArray, linePtr, lineCount, fileName, flags)) { - psFree(keyName); - return false; - } - } - psFree(keyName); - } - return returnValue; -} - -psMetadata* psMetadataConfigParse(psMetadata* md, unsigned int *nFail, const char *fileName, bool overwrite) -{ - FILE* fp = NULL; - char* line = NULL; - char* linePtr = NULL; - psArray* parseLevelInfoArray = NULL; - psS32 lineCount = 0; - psS32 nestingLevel = 0; - p_psParseLevelInfo* topLevelInfo = NULL; - - // Check for NULL file name - PS_ASSERT_PTR_NON_NULL(fileName,NULL); - - // Check for NULL nFail - PS_ASSERT_PTR_NON_NULL(nFail,NULL); - - // Attempt to open specified file - if((fp=fopen(fileName, "r")) == NULL) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_FILE_OPEN_FAILED, fileName); - return NULL; - } - - // Allocate metadata if necessary - if (md == NULL) { - md = psMetadataAlloc(); - } - - // Allocate array to store parse level information - parseLevelInfoArray = psArrayAlloc(10); - parseLevelInfoArray->n = 0; - - // Set parse level info for the top level - topLevelInfo = p_psParseLevelInfoAlloc(); - topLevelInfo->metadata = psMemIncrRefCounter(md); - parseLevelInfoArray = psArrayAdd(parseLevelInfoArray,1,topLevelInfo); - psFree(topLevelInfo); - - // Create reusable line for continuous read - line = (char*)psAlloc(MAX_STRING_LENGTH*sizeof(char)); - - // While loop to parse the file - while(fgets(line, MAX_STRING_LENGTH, fp) != NULL) { - - // Initialize variables for new line - linePtr = line; - lineCount++; - - if(!parseLine(&nestingLevel,parseLevelInfoArray,linePtr,lineCount,(char*)fileName,overwrite)) { - (*nFail)++; - } - } - - // Free parse array and line buffer - psFree(parseLevelInfoArray); - psFree(line); - - return md; -} - - -static void saxStartElement(void *ctx, const xmlChar *tagName, const xmlChar **atts) -{ - psU64 i = 0; - char* psTagName = NULL; - char *psAttName = NULL; - char *psAttValue = NULL; - const xmlChar *attName = NULL; - const xmlChar *attValue = NULL; - psMetadata* md = NULL; - psHash* htAtts = NULL; - xmlParserCtxtPtr ctxt = NULL; - xmlParserInputPtr input = NULL; - - - // Get and check initial data pointers - ctxt = (xmlParserCtxtPtr)ctx; - PS_ASSERT_GENERAL_PTR_NON_NULL(ctxt, return); - md = (psMetadata*)ctxt->sax->_private; - PS_ASSERT_GENERAL_PTR_NON_NULL(md, return); - input = (xmlParserInputPtr)ctxt->input; - PS_ASSERT_GENERAL_PTR_NON_NULL(input, return); - - // Copy XML strings to psStrings to avoid libxml2/psLib memory corruption problems - psTagName = psStringCopy((const char*)tagName); - - // Metadata containter for housing element attributes used by other SAX events - htAtts = psHashAlloc(10); - - - // Get tag name - if(psTagName != NULL) { - psHashAdd(htAtts, "tagName", psTagName); - } else { - PS_ASSERT_GENERAL_PTR_NON_NULL(psTagName, return); - psFree(htAtts); - psFree(psTagName); - return; - } - - // Get all attribute names and attribute values - if(atts != NULL) { - attName = atts[i++]; - attValue = atts[i++]; - while(attName != NULL) { - if(attValue != NULL) { - - // Copy XML strings to psStrings to avoid libxml2/psLib memory corruption problems - psAttName = psStringCopy((const char*)attName); - psAttValue = psStringCopy((const char*)attValue); - psHashAdd(htAtts, psAttName, psAttValue); - psFree(psAttName); - psFree(psAttValue); - } else { - PS_ASSERT_GENERAL_PTR_NON_NULL(psAttValue, return); - psFree(htAtts); - psFree(psTagName); - return; - } - attName = atts[i++]; - attValue = atts[i++]; - } - } - - // Add attributes to metadata - - psMetadataAdd(md, PS_LIST_TAIL, "htAtts", - PS_META_HASH | PS_META_DUPLICATE_OK, - NULL, htAtts); - - psFree(psTagName); - psFree(htAtts); - - return; -} - -static void initMetadataItemXml(void *ctx, char *tagName) -{ - psBool overwrite = false; - psBool tempBool = false; - psS32 status = 0; - psU32 lineNumber = 0; - psF64 tempDbl = 0.0; - psS32 tempInt = 0.0; - psMetadataType mdType = PS_META_UNKNOWN; - char *fileName = NULL; - char *strName = NULL; - char *strType = NULL; - char *strValue = NULL; - psMetadata* md = NULL; - psHash* htAtts = NULL; - psMetadataItem *metadataItem = NULL; - xmlParserCtxtPtr ctxt = NULL; - xmlParserInputPtr input = NULL; - - - // Get and check initial data pointers - ctxt = (xmlParserCtxtPtr)ctx; - PS_ASSERT_GENERAL_PTR_NON_NULL(ctxt, return); - md = (psMetadata*)ctxt->sax->_private; - PS_ASSERT_GENERAL_PTR_NON_NULL(md, return); - input = (xmlParserInputPtr)ctxt->input; - PS_ASSERT_GENERAL_PTR_NON_NULL(input, return); - metadataItem = psMetadataLookup(md, "htAtts"); - PS_ASSERT_GENERAL_PTR_NON_NULL(metadataItem, return); - PS_ASSERT_GENERAL_PTR_NON_NULL(metadataItem->data.list, return); - metadataItem = (psMetadataItem*)psListGet(metadataItem->data.list,PS_LIST_TAIL); - htAtts = (psHash*)metadataItem->data.list; - PS_ASSERT_GENERAL_PTR_NON_NULL(htAtts, return); - fileName = (char*)input->filename; - PS_ASSERT_GENERAL_PTR_NON_NULL(fileName, return); - lineNumber = input->line; - - // Get attribute name - strName = psHashLookup(htAtts, "name"); - if(strName == NULL) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_NO_NAME, lineNumber, fileName); - return; - } - - // Get attribute type, if there is one - strType = psHashLookup(htAtts, "psType"); - if(strType!= NULL) { - if(xmlStrEqual(BAD_CAST strType, BAD_CAST "psString")) { - mdType = PS_META_STR; - } else if(xmlStrEqual(BAD_CAST strType, BAD_CAST "psBool")) { - mdType = PS_META_BOOL; - } else if(xmlStrEqual(BAD_CAST strType, BAD_CAST "psS32")) { - mdType = PS_META_S32; - } else if(xmlStrEqual(BAD_CAST strType, BAD_CAST "psF32")) { - mdType = PS_META_F32; - } else if(xmlStrEqual(BAD_CAST strType, BAD_CAST "psF64")) { - mdType = PS_META_F64; - } else { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_TYPE_INVALID_LINE_FILE, strType, lineNumber, - fileName); - return; - } - } - - // Get attribute value, if there is one - strValue = psHashLookup(htAtts, "value"); - - /* If metadata item is found, and is not a folder node, and overwrite is allowed, then remove - existing and allow switch/case below to add new item. If overwrite is false, then report error. If - found item is folder node, then psMetadataAdd will automatically add a new child. */ - metadataItem = psMetadataLookup(md, "overwrite"); - if(metadataItem != NULL) { - overwrite = parseBool((char*)strValue, &status); - if(status) { - status = 0; - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, strValue, strName, strType, - lineNumber, fileName); - } - metadataItem = psMetadataLookup(md, strName); - if(metadataItem != NULL) { - if(metadataItem->type != PS_META_LIST) { - if(overwrite) { - psMetadataRemove(md, INT_MIN, strName); - } else { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_OVERWRITE_ITEM, strName, lineNumber, - fileName); - return; - } - } - } - } - - // Create metadata item and add to metadata - switch(mdType) { - case PS_META_LIST: - psMetadataAdd(md, PS_LIST_TAIL, strName, - mdType | PS_META_DUPLICATE_OK, - NULL, NULL); - break; - case PS_META_STR: - psMetadataAdd(md, PS_LIST_TAIL, strName, - mdType | PS_META_DUPLICATE_OK, - NULL, strValue); - break; - case PS_META_BOOL: - tempBool = parseBool((char*)strValue, &status); - if(!status) { - psMetadataAdd(md, PS_LIST_TAIL, strName, - mdType | PS_META_DUPLICATE_OK, - NULL, tempBool); - } else { - status = 0; - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, strValue, strName, strType, - lineNumber, fileName); - } - break; - case PS_META_S32: - tempInt = (psS32)parseValue((char*)strValue, &status); - if(!status) { - psMetadataAdd(md, PS_LIST_TAIL, strName, - mdType | PS_META_DUPLICATE_OK, - NULL, tempInt); - } else { - status = 0; - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, strValue, strName, strType, - lineNumber, fileName); - } - break; - case PS_META_F32: - case PS_META_F64: - tempDbl = parseValue((char*)strValue, &status); - if(!status) { - psMetadataAdd(md, PS_LIST_TAIL, strName, - mdType | PS_META_DUPLICATE_OK, - NULL, tempDbl); - } else { - status = 0; - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, strValue, strName, strType, - lineNumber, fileName); - } - break; - default: - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_FILE_TYPE_INVALID, strType, lineNumber, fileName); - } // End switch - - return; -} - - -static void initVectorXml(void *ctx, char *tagName) -{ - bool overwrite = false; - psS32 status = 0; - psU32 lineNumber = 0; - psElemType pType = 0; - char *strName = NULL; - char *strType = NULL; - char *strValue = NULL; - char *fileName = NULL; - psMetadataItem *table = NULL; - psMetadataItem *tables = NULL; - psMetadataItem *metadataItem = NULL; - psVector *vec = NULL; - psMetadata* md = NULL; - psHash* htAtts = NULL; - xmlParserCtxtPtr ctxt = NULL; - xmlParserInputPtr input = NULL; - - - // Get and check initial data pointers - ctxt = (xmlParserCtxtPtr)ctx; - PS_ASSERT_GENERAL_PTR_NON_NULL(ctxt, return); - md = (psMetadata*)ctxt->sax->_private; - PS_ASSERT_GENERAL_PTR_NON_NULL(md, return); - input = (xmlParserInputPtr)ctxt->input; - PS_ASSERT_GENERAL_PTR_NON_NULL(input, return); - tables = psMetadataLookup(md, "htAtts"); - PS_ASSERT_GENERAL_PTR_NON_NULL(tables, return); - PS_ASSERT_GENERAL_PTR_NON_NULL(tables->data.list, return); - table = (psMetadataItem*)psListGet(tables->data.list,PS_LIST_TAIL); - htAtts = (psHash*)table->data.list; - PS_ASSERT_GENERAL_PTR_NON_NULL(htAtts, return); - fileName = (char*)input->filename; - PS_ASSERT_GENERAL_PTR_NON_NULL(fileName, return); - lineNumber = input->line; - - // Get attribute name - strName = psHashLookup(htAtts, "name"); - if(strName == NULL) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_NO_NAME, lineNumber, fileName); - return; - } - - // Get attribute type, if there is one - strType = psHashLookup(htAtts, "psType"); - if(strType!= NULL) { - if(xmlStrEqual(BAD_CAST strType, BAD_CAST "psBool")) { - pType = PS_TYPE_U8; - } else if(xmlStrEqual(BAD_CAST strType, BAD_CAST "psS32")) { - pType = PS_TYPE_S32; - } else if(xmlStrEqual(BAD_CAST strType, BAD_CAST "psF32")) { - pType = PS_TYPE_F32; - } else if(xmlStrEqual(BAD_CAST strType, BAD_CAST "psF64")) { - pType = PS_TYPE_F64; - } else { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_TYPE_INVALID_LINE_FILE, strName, lineNumber, - fileName); - return; - } - } - - strValue = psHashLookup(htAtts, "value"); - PS_ASSERT_GENERAL_PTR_NON_NULL(strValue, return); - - - /* If metadata item is found, and is not a folder node, and overwrite is allowed, then remove - existing and allow switch/case below to add new item. If overwrite is false, then report error. If - found item is folder node, then psMetadataAdd will automatically add a new child. */ - metadataItem = psMetadataLookup(md, "overwrite"); - if(metadataItem != NULL) { - overwrite = parseBool((char*)strValue, &status); - if(status) { - status = 0; - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, strValue, strName, strType, - input->line, input->filename); - } - metadataItem = psMetadataLookup(md, strName); - if(metadataItem != NULL) { - if(metadataItem->type != PS_META_LIST) { - if(overwrite) { - psMetadataRemove(md, INT_MIN, strName); - } else { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_OVERWRITE_ITEM, strName, lineNumber, - fileName); - return; - } - } - } - } - - // Get value - vec = parseVector((char*)strValue, pType, &status); - if(!status) { - psMetadataAdd(md, PS_LIST_TAIL, strName+1, - PS_META_VEC | PS_META_DUPLICATE_OK, - NULL, vec); - } else { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_PARSE_FAILED, strValue, strName, strType, - lineNumber, fileName); - } - psFree(vec); -} - -static void saxEndElement(void *ctx, const xmlChar *tagName) -{ - char *psStartTagName = NULL; - char *psEndTagName = NULL; - psMetadata* md = NULL; - psHash* htAtts = NULL; - psMetadataItem *table = NULL; - psMetadataItem *tables = NULL; - xmlParserCtxtPtr ctxt = NULL; - xmlParserInputPtr input = NULL; - - - // Get and check initial data pointers - ctxt = (xmlParserCtxtPtr)ctx; - PS_ASSERT_GENERAL_PTR_NON_NULL(ctxt, return); - md = (psMetadata*)ctxt->sax->_private; - PS_ASSERT_GENERAL_PTR_NON_NULL(md, return); - input = (xmlParserInputPtr)ctxt->input; - PS_ASSERT_GENERAL_PTR_NON_NULL(input, return); - tables = psMetadataLookup(md, "htAtts"); - PS_ASSERT_GENERAL_PTR_NON_NULL(tables, return); - PS_ASSERT_GENERAL_PTR_NON_NULL(tables->data.list, return); - table = (psMetadataItem*)psListGet(tables->data.list,PS_LIST_TAIL); - htAtts = (psHash*)table->data.list; - PS_ASSERT_GENERAL_PTR_NON_NULL(htAtts, return); - - // Copy XML strings to psStrings to avoid libxml2/psLib memory corruption problems - psEndTagName = psStringCopy((const char*)tagName); - - // Compare start and end tag names - psStartTagName = psHashLookup(htAtts, "tagName"); - PS_ASSERT_GENERAL_PTR_NON_NULL(psStartTagName, return); - if(strcmp(psEndTagName, psStartTagName)) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_TAG_MISMATCH, psStartTagName, psEndTagName); - } - - // Initialize psLib structs - if(!strcmp(psEndTagName, "psMetadataItem")) { - initMetadataItemXml(ctx, psEndTagName); - } else if(!strcmp(psEndTagName, "psVector")) { - initVectorXml(ctx, psEndTagName); - } else if(strcmp(psEndTagName, "psRoot")) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_TAG_UNKNOWN, psEndTagName); - } - - // Free temporary metadata item and its hash table - psListRemove(tables->data.list, PS_LIST_TAIL); - - psFree(psEndTagName); - - return; -} - -psMetadata* psMetadataConfigParseXml(psMetadata* md, psU32 *nFail, const char *fileName, psBool overwrite) -{ - xmlSAXHandler saxHandler; - - - // Error checks - PS_ASSERT_PTR_NON_NULL(fileName, NULL); - - // Allocate metadata if necessary - if (md == NULL) { - md = psMetadataAlloc(); - } - - // Sax handler initializations - saxHandler.internalSubset = NULL; - saxHandler.isStandalone = NULL; - saxHandler.hasInternalSubset = NULL; - saxHandler.hasExternalSubset = NULL; - saxHandler.resolveEntity = NULL; - saxHandler.getEntity = NULL; - saxHandler.entityDecl = NULL; - saxHandler.notationDecl = NULL; - saxHandler.attributeDecl = NULL; - saxHandler.elementDecl = NULL; - saxHandler.unparsedEntityDecl = NULL; - saxHandler.setDocumentLocator = NULL; - saxHandler.startDocument = NULL; - saxHandler.endDocument = NULL; - saxHandler.startElement = saxStartElement; - saxHandler.endElement = saxEndElement; - saxHandler.reference = NULL; - saxHandler.characters = NULL; - saxHandler.ignorableWhitespace = NULL; - saxHandler.processingInstruction = NULL; - saxHandler.comment = NULL; - saxHandler.warning = xmlParserError; - saxHandler.error = xmlParserError; - saxHandler.fatalError = xmlParserError; - saxHandler.getParameterEntity = NULL; - saxHandler.cdataBlock = NULL; - saxHandler.externalSubset = NULL; - saxHandler.initialized = 1; - saxHandler._private = md; - saxHandler.startElementNs = NULL; - saxHandler.endElementNs = NULL; - saxHandler.serror = NULL; - - // Parse XML file - if (xmlSAXUserParseFile(&saxHandler, NULL, fileName)) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psMetadataIO_FILE_OPEN_FAILED, fileName); - return NULL; - } - - // Parser and memory cleanups for libxml2 - xmlCleanupParser(); - xmlMemoryDump(); - - return md; -} Index: unk/psLib/src/collections/psMetadataIO.h =================================================================== --- /trunk/psLib/src/collections/psMetadataIO.h (revision 4545) +++ (revision ) @@ -1,104 +1,0 @@ -/** @file psMetadataIO.h - * - * @brief Contains metadata input/output functions. - * - * This file defines functions to read and write metadata to/from an external file. - * - * @ingroup Metadata - * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-28 20:17:52 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ -#ifndef PS_METADATAIO_H -#define PS_METADATAIO_H - -/// @addtogroup Metadata -/// @{ - -/** A metadata data structure used in parsing arrays. - * - * Contains array information and the metadata storage location. -*/ -typedef struct -{ - psArray* nonUniqueKeyArray; ///< non-unique key names - psArray* typeArray; ///< array of user defined types - psArray* templateArray; ///< array of user type templates - psMetadata* metadata; ///< metadata container - char* name; ///< name of key -} -p_psParseLevelInfo; - -/** Allocates a p_psParseLevelInfo structure - * - * @return p_psParseLevelInfo* : new p_psParseLevelInfo struct - */ -p_psParseLevelInfo* p_psParseLevelInfoAlloc(void); - -/** Print metadata item to file. - * - * Metadata items may be printed to an open file descriptor based on a - * provided format. The format is a sprintf format statement with exactly - * one % formatting command. If the metadata item type is a numeric type, - * this formatting command must also be numeric, and the type conversion - * performed to the value to match the format type. If the metadata type is - * a string, the fromatting command must also be for a string. If the - * metadata type is any other data type, printing is not allowed. - * - * @return psMetadataItem* : Pointer metadata item. - */ -bool psMetadataItemPrint( - FILE * fd, ///< Pointer to file to write metadata item. - const char *format, ///< Format to print metadata item. - const psMetadataItem* item ///< Metadata item to print. -); - -/** Read metadata header. - * - * Read a metadata header from file. If the file is not found, an error is - * reported. - * - * @return psMetadata* : Pointer to resulting metadata. - */ -psMetadata* psMetadataReadHeader( - psMetadata* output, ///< Resulting metadata from read. - char *extName, ///< File name extension string. - psS32 extNum, ///< File name extension number. Starts at 1. - char *fileName ///< Name of file to read. -); - -/** Read metadata configuration file. - * - * Loads pre-defined settings by parsing a configuration file into a psMetadata structure. - * - * @return psMetadata* : Resulting metadata from read. - */ -psMetadata* psMetadataConfigParse( - psMetadata* md, ///< Resulting metadata from read. - unsigned int *nFail, ///< Number of failed lines. - const char *fileName, ///< Name of file to read. - bool overwrite ///< Allow overwrite of duplicate specifications. -); - -/** Read XML metadata configuration file. - * - * Loads pre-defined XML settings by parsing a configuration file into a psMetadata structure. - * - * @return psMetadata* : Resulting metadata from read. - */ - -psMetadata* psMetadataConfigParseXml( - psMetadata* md, ///< Resulting metadata from read. - psU32 *nFail, ///< Number of failed lines. - const char *fileName, ///< Name of file to read. - psBool overwrite ///< Allow overwrite of duplicate specifications. -); - -/// @} - -#endif // #ifndef PS_METADATAIO_H Index: unk/psLib/src/collections/psPixels.c =================================================================== --- /trunk/psLib/src/collections/psPixels.c (revision 4545) +++ (revision ) @@ -1,326 +1,0 @@ -/** @file psPixels.c - * - * @brief Contains psPixel related functions - * - * @ingroup Image - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include - -#include "psPixels.h" -#include "psMemory.h" - -#include "psError.h" -#include "psCollectionsErrors.h" - -typedef int(*qsortCompareFcn)(const void *, const void *); - -static void pixelsFree(psPixels* pixels) -{ - if (pixels != NULL) { - psFree(pixels->data); - } -} - -// for use by qsort, etc. -static int comparePixelCoord(psPixelCoord* coord1, psPixelCoord* coord2) -{ - // check row first - if (coord1->y < coord2->y) { - return -1; - } - - if (coord1->y > coord2->y) { - return 1; - } - - // rows are the same, so check column - if (coord1->x < coord2->x) { - return -1; - } - - if (coord1->x > coord2->x) { - return 1; - } - - return 0; -} - -psPixels* psPixelsAlloc(long nalloc) -{ - psPixels* out = psAlloc(sizeof(psPixels)); - - if (nalloc > 0) { - out->data = psAlloc(sizeof(psPixelCoord)*nalloc); - } else { - out->data = NULL; - } - out->n = nalloc; - out->nalloc = nalloc; - - psMemSetDeallocator(out, (psFreeFunc)pixelsFree); - - return out; -} - -psPixels* psPixelsRealloc(psPixels* pixels, long nalloc) -{ - if (pixels == NULL) { - return psPixelsAlloc(nalloc); - } - - if (nalloc > 0) { - pixels->data = psRealloc(pixels->data, sizeof(psPixelCoord)*nalloc); - } else { - psFree(pixels->data); - pixels->data = NULL; - } - - pixels->nalloc = nalloc; - - if (pixels->n > pixels->nalloc) { - pixels->n = pixels->nalloc; - } - - return pixels; -} - -psPixels* p_psPixelsAppend(psPixels* pixels, long growth, int x, int y) -{ - if (growth < 1) { - growth = 10; - } - - if ( (pixels == NULL) || (pixels->n >= pixels->nalloc) ) { - pixels=psPixelsRealloc(pixels, pixels->nalloc+growth); - } - - int n = pixels->n; - - pixels->data[n].x = x; - pixels->data[n].y = y; - - pixels->n++; - - return pixels; -} - -psPixels* psPixelsCopy(psPixels* out, const psPixels* pixels) -{ - if (pixels == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL,true,PS_ERRORTEXT_psPixels_NULL); - psFree(out); - return NULL; - } - - out = psPixelsRealloc(out, pixels->n); - - memcpy(out->data,pixels->data, pixels->n*sizeof(psPixelCoord)); - out->n = pixels->n; - - return out; -} - -psImage *psPixelsToMask(psImage *out, const psPixels *pixels, psRegion region, psMaskType maskVal) -{ - // check that the input pixel vector is valid - if (pixels == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psPixels_NULL); - psFree(out); - return NULL; - } - psPixelCoord* data = pixels->data; - if (data == NULL) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psPixels_DATA_NULL); - psFree(out); - return NULL; - } - - int x0 = region.x0; - int x1 = region.x1; - int y0 = region.y0; - int y1 = region.y1; - - // determine the output image size - int numRows = y1-y0; - int numCols = x1-x0; - if (numRows < 1 || numCols < 1) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psPixels_REGION_INVALID, - y0,y1,x0,x1); - psFree(out); - return NULL; - } - - // allocate the output image - out = psImageRecycle(out, numCols, numRows, PS_TYPE_MASK); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psPixels_FAILED_IMAGE_CREATE, - numCols, numRows); - return NULL; - } - *(psS32*)&out->row0 = y0; - *(psS32*)&out->col0 = x0; - - // initialize image to all zeros - int columnByteSize = sizeof(psMaskType)*numCols; - for (int row = 0; row < numRows; row++) { - memset(out->data.U8[row],0,columnByteSize); - } - - // determine the length of the pixel vector - int length = pixels->n; - - // cycle through the vector of pixels and insert pixels into image - psMaskType** outData = out->data.PS_TYPE_MASK_DATA; - for (int p = 0; p < length; p++) { - psS32 x = data[p].x; - psS32 y = data[p].y; - // pixel in region? - if (x >= x0 && x < x1 && y >= y0 && y < y1) { - outData[y-y0][x-x0] |= maskVal; - } - } - - return out; -} - -psPixels* psPixelsFromMask(psPixels* out, const psImage* mask, psMaskType maskVal) -{ - if (mask == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psPixels_MASK_NULL); - psFree(out); - return NULL; - } - if (mask->type.type != PS_TYPE_MASK) { - char* typeStr; - PS_TYPE_NAME(typeStr,mask->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psPixels_MASK_TYPE, - typeStr); - psFree(out); - return NULL; - } - int numRows = mask->numRows; - int numCols = mask->numCols; - - // assumption: number of masked pixels is relatively small compared to - // total pixels, so it is best to just start with a guess and resize if - // necessary - int minPixels = numRows*numCols/100; // initial guess, 1% of pixels masked - if (minPixels < 32) { // enforce a minimum size - minPixels = 32; - } - - // check out's validity (allocated/minimum size) - if (out == NULL || out->data == NULL || out->nalloc < minPixels) { - out = psPixelsRealloc(out,minPixels); - } - - // start with a blank list of pixels - out->n = 0; - - // find the mask pixels in the image - int numPixels = 0; - psPixelCoord* data = out->data; - int nalloc = out->nalloc; - for (int row=0; rowdata.PS_TYPE_MASK_DATA[row]; - for (int col=0; colnalloc; - data = out->data; - } - - data[numPixels].x = col; - data[numPixels].y = row; - numPixels++; - } - } - } - out->n = numPixels; - - return out; -} - -psPixels* psPixelsConcatenate(psPixels *out,const psPixels *pixels) -{ - if (pixels == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psPixels_NULL); - return NULL; - } - - int pixelsN = pixels->n; - psPixelCoord* pixelsData = pixels->data; - - if (out == NULL) { - // simple copy pixels - out = psPixelsCopy(out,pixels); - return out; - } - - // make sure the out is large enough to fit the result - int outN = out->n; - out = psPixelsRealloc(out,outN + pixelsN); - psPixelCoord* outData = out->data; - - // sort the OUT array to help in searching for duplicates later - qsort(outData, outN, sizeof(psPixelCoord), - (qsortCompareFcn)comparePixelCoord); - - // add non-duplicate values in pixels to out - psPixelCoord pCoord; - int end = outN; - for (int n = 0; n < pixelsN; n++) { - pCoord = pixelsData[n]; - if (bsearch(&pCoord, outData, outN, sizeof(psPixelCoord), - (qsortCompareFcn)comparePixelCoord) == NULL) { - // no match in OUT array of this value - outData[end++] = pCoord; - } - } - out->n = end; // set number of elements to reflect added data - - return out; -} - -bool p_psPixelsPrint (FILE *fd, psPixels* pixels, const char *name) -{ - - fprintf (fd, "psPixels: %s\n", name); - - if (pixels == NULL) { - fprintf(fd,"NULL\n\n"); - return true; - } - - int n = pixels->n; - psPixelCoord* data = pixels->data; - - if (data == NULL || n == 0) { - fprintf(fd,"EMPTY\n\n"); - return true; - } - - for (int i = 0; i < n; i++) { - fprintf (fd, "(%d,%d)\n", data[i].x, data[i].y); - } - fprintf (fd, "\n"); - return (true); -} Index: unk/psLib/src/collections/psPixels.h =================================================================== --- /trunk/psLib/src/collections/psPixels.h (revision 4545) +++ (revision ) @@ -1,151 +1,0 @@ -/** @file psPixels.h - * - * @brief Contains psPixel related functions - * - * @ingroup Image - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ -#ifndef PS_PIXELS_H -#define PS_PIXELS_H - -#include "psImage.h" -#include "psVector.h" - -/// @addtogroup Image -/// @{ - -/** Data structure for storing psPixel coordinates */ -typedef struct -{ - int x; ///< x coordinate - int y; ///< y coordinate -} -psPixelCoord; - -/** list of pixel coordinates - * - * Usually an image mask is the best way to carry information about what - * pixels mean what. However, in the case where the number of pixels in which - * we are interested is limited, it is more efficient to simply carry a list - * of pixels. An example of this is in the image combination code, where we - * want to perform an operation on a relatively small fraction of pixels, and - * it is inefficient to go through an entire mask image checking each pixel. - * - */ -typedef struct -{ - long n; ///< Number in usa - long nalloc; ///< Number allocated - psPixelCoord* data; ///< The pixel coordinates - void *lock; ///< Option lock for thread safety -} -psPixels; - - -/** Allocates a new psPixels structure - * - * @return psPixels* new psPixels - */ -psPixels* psPixelsAlloc( - long nalloc ///< the size of the coordinate vectors -) -; - -/** resizes a psPixels structure - * - * @return psPixels* resized psPixels - */ -psPixels* psPixelsRealloc( - psPixels* pixels, ///< psPixels to resize, or NULL to create new psPixels - long nalloc ///< the size of the coordinate vectors -); - -/** Add a pixel location to a psPixels - * - * @return psPixels* psPixels with the value appended. - */ -psPixels* p_psPixelsAppend( - psPixels* pixels, ///< psPixels to append new coordinate to. NULL creates a new one. - long growth, ///< number of elements to grow the psPixels list, if necessary. if growth < 1, 10 is used. - int x, ///< x coordinate to append - int y ///< y coordinate to append -); - -/** Copies a psPixels object - * - * Makes a deep copy of the data in a psPixels object. Any data in the OUT - * parameter will be destroyed and OUT will be resized, if necessary. - * - * @return psPixels* a new psPixels that is a duplicate to IN - */ -psPixels* psPixelsCopy( - psPixels* out, ///< psPixels struct to recycle, or NULL - const psPixels* pixels ///< psPixels struct to copy -); - -/** Generate a psImage from a psPixels - * - * psPixelsToMask shall return an image of type U8 with the pixels lying - * within the specified region set to the maskVal. The out image shall be - * modified if supplied, or allocated and returned if NULL. The size of the - * output image shall be region->x1 - region->x0 by region->y1 - region->y0, - * with out->x0 = region->x0 and out->y0 = region->y0. In the event that - * either of pixels or region are NULL, the function shall generate an - * error and return NULL. - * - * @return psImage* generated mask image - */ -psImage* psPixelsToMask( - psImage* out, ///< psImage to recycle, or NULL - const psPixels* pixels, ///< list of pixels to use - psRegion region, ///< region to define the output mask image - psMaskType maskVal ///< the mask bit-values to act upon -); - -/** Generate a psPixels from a mask psImage - * - * psMaskToPixels shall return a psPixels consisting of the coordinates in - * the mask that match the maskVal. The out pixel list shall be modified if - * supplied, or allocated and returned if NULL. In hte event that mask is - * NULL, the function shall generate an error and return NULL. - * - * @return psPixels* generated psPixels pixel list - */ -psPixels* psPixelsFromMask( - psPixels *out, ///< psPixels to recycle, or NULL - const psImage *mask, ///< the input mask psImage - psMaskType maskVal ///< the mask bit-values to act upon -); - -/** Concatenates two psPixels - * - * psPixelsConcatenate shall concatenate pixels onto out. In the event that - * out is NULL, a new psPixels shall be allocated, and the contents of - * pixels simply copied in. If pixels is NULL, the function shall generate - * an error and return NULL. The function shall take care to ensure that - * there are no duplicate pixels in out. - * - * @return psPixels Concatenated psPixel list - */ -psPixels* psPixelsConcatenate( - psPixels *out, ///< psPixels to recycle, or NULL - const psPixels *pixels ///< psPixels to append to OUT -); - -/** Prints a psPixels to specified destination. - * - * @return bool: True if successful. -*/ -bool p_psPixelsPrint( - FILE *fd, ///< destination file descriptor - psPixels* pixels, ///< psPixels to print - const char *name ///< printf-style format of header line -); - -#endif // #ifndef PS_PIXELS_H Index: unk/psLib/src/collections/psScalar.c =================================================================== --- /trunk/psLib/src/collections/psScalar.c (revision 4545) +++ (revision ) @@ -1,139 +1,0 @@ -/** @file psScalar.c - * - * @brief Contains basic scalar definitions and operations - * - * This file defines the basic type for a scalar struct and functions useful - * in manupulating scalars. - * * - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-28 20:17:52 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include "psMemory.h" -#include "psError.h" -#include "psScalar.h" -#include "psLogMsg.h" -#include "psAbort.h" - -#include "psCollectionsErrors.h" - -psScalar* psScalarAlloc(complex value, psElemType type) -{ - psScalar* scalar = NULL; - - // Create scalar - scalar = (psScalar* ) psAlloc(sizeof(psScalar)); - - scalar->type.dimen = PS_DIMEN_SCALAR; - scalar->type.type = type; - - switch (type) { - case PS_TYPE_S8: - scalar->data.S8 = (psS8) value; - break; - case PS_TYPE_U8: - scalar->data.U8 = (psU8) value; - break; - case PS_TYPE_S16: - scalar->data.S16 = (psS16) value; - break; - case PS_TYPE_U16: - scalar->data.U16 = (psU16) value; - break; - case PS_TYPE_S32: - scalar->data.S32 = (psS32) value; - break; - case PS_TYPE_U32: - scalar->data.U32 = (psU32) value; - break; - case PS_TYPE_S64: - scalar->data.S64 = (psS64) value; - break; - case PS_TYPE_U64: - scalar->data.U64 = (psU64) value; - break; - case PS_TYPE_F32: - scalar->data.F32 = (psF32) value; - break; - case PS_TYPE_F64: - scalar->data.F64 = (psF64) value; - break; - case PS_TYPE_C32: - scalar->data.C32 = (psC32) value; - break; - case PS_TYPE_C64: - scalar->data.C64 = (psC64) value; - break; - default: - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psScalar_UNSUPPORTED_TYPE, - type); - psFree(scalar); - return NULL; - } - - return scalar; -} - -psScalar* psScalarCopy(const psScalar *value) -{ - psElemType dataType; - psScalar *newScalar = NULL; - - if (value == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psScalar_COPY_NULL); - return NULL; - } - - dataType = value->type.type; - switch (dataType) { - case PS_TYPE_S8: - newScalar = psScalarAlloc(value->data.S8, dataType); - break; - case PS_TYPE_U8: - newScalar = psScalarAlloc(value->data.U8, dataType); - break; - case PS_TYPE_S16: - newScalar = psScalarAlloc(value->data.S16, dataType); - break; - case PS_TYPE_U16: - newScalar = psScalarAlloc(value->data.U16, dataType); - break; - case PS_TYPE_S32: - newScalar = psScalarAlloc(value->data.S32, dataType); - break; - case PS_TYPE_U32: - newScalar = psScalarAlloc(value->data.U32, dataType); - break; - case PS_TYPE_S64: - newScalar = psScalarAlloc(value->data.S64, dataType); - break; - case PS_TYPE_U64: - newScalar = psScalarAlloc(value->data.U64, dataType); - break; - case PS_TYPE_F32: - newScalar = psScalarAlloc(value->data.F32, dataType); - break; - case PS_TYPE_F64: - newScalar = psScalarAlloc(value->data.F64, dataType); - break; - case PS_TYPE_C32: - newScalar = psScalarAlloc(value->data.C32, dataType); - break; - case PS_TYPE_C64: - newScalar = psScalarAlloc(value->data.C64, dataType); - break; - default: - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psScalar_UNSUPPORTED_TYPE, - dataType); - return NULL; - } - - return newScalar; -} Index: unk/psLib/src/collections/psScalar.h =================================================================== --- /trunk/psLib/src/collections/psScalar.h (revision 4545) +++ (revision ) @@ -1,84 +1,0 @@ - -/** @file psScalar.h - * - * @brief Contains basic scalar definitions and operations - * - * This file defines the basic type for a scalar struct and functions useful - * in manupulating scalars. - * - * @ingroup Scalar - * - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-07 02:17:53 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_SCALAR_H -#define PS_SCALAR_H - -#include "psType.h" - -/// @addtogroup Scalar -/// @{ - -/** Basic scalar data structure. - * - * Struct for maintaining a scalar of frequently used primitive types. - * - */ -typedef struct -{ - psMathType type; ///< Type of data. - - union { - psU8 U8; ///< Unsigned 8-bit integer data. - psU16 U16; ///< Unsigned 16-bit integer data. - psU32 U32; ///< Unsigned 32-bit integer data. - psU64 U64; ///< Unsigned 64-bit integer data. - psS8 S8; ///< Signed 8-bit integer data. - psS16 S16; ///< Signed 16-bit integer data. - psS32 S32; ///< Signed 32-bit integer data. - psS64 S64; ///< Signed 64-bit integer data. - psF32 F32; ///< Single-precision float data. - psF64 F64; ///< Double-precision float data. - psC32 C32; ///< Single-precision complex data. - psC64 C64; ///< Double-precision complex data. - } data; ///< Union for data types. -} -psScalar; - -/*****************************************************************************/ - -/* FUNCTION PROTOTYPES */ - -/*****************************************************************************/ - -/** Allocate a scalar. - * - * Uses psLib memory allocation functions to create scalar data as defined by the psType type. - * Accepts a complex 64 bit float for input value, as max size, but resizes according to - * correct type. - * - * @return psScalar* Pointer to a new psScalar. - */ -psScalar* psScalarAlloc( - complex value, ///< Data to be put into psScalar. - psElemType type ///< Type of data to be held by psScalar. -); - -/** Copy a scalar. - * - * Uses psLib memory allocation functions to copy a scalar. - * - * @return psScalar* A copy of the input scalar - */ -psScalar* psScalarCopy( - const psScalar *value ///< Scalar to copy. -); - -/// @} - -#endif // #ifndef PS_SCALAR_H Index: unk/psLib/src/collections/psVector.c =================================================================== --- /trunk/psLib/src/collections/psVector.c (revision 4545) +++ (revision ) @@ -1,582 +1,0 @@ -/** @file psVector.c -* -* @brief Contains support for basic vector types -* -* This file defines the basic type for a vector struct and functions useful -* in manupulating vectors. -* -* @author Ross Harman, MHPCC -* @author Robert DeSonia, MHPCC -* -* @version $Revision: 1.46 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-07 02:17:53 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#include // for memcpy -#include -#include -#include - -#include "psMemory.h" -#include "psError.h" -#include "psVector.h" -#include "psLogMsg.h" -#include "psCompare.h" - -#include "psCollectionsErrors.h" - -typedef struct -{ - p_psVectorData data; // need this first for psVectorSortIndex to work. - psU32 index; -} -indexedVector; - -static void vectorFree(psVector* psVec); - -static void vectorFree(psVector* psVec) -{ - if (psVec == NULL) { - return; - } - - psFree(psVec->data.U8); -} - -// FUNCTION IMPLEMENTATION - PUBLIC - -psVector* psVectorAlloc( long nalloc, psElemType type) -{ - psVector* psVec = NULL; - psS32 elementSize = 0; - - elementSize = PSELEMTYPE_SIZEOF(type); - if (elementSize < 1) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVector_UNSUPPORTED_TYPE, type); - return NULL; - } - - - // Create vector struct - psVec = (psVector* ) psAlloc(sizeof(psVector)); - psMemSetDeallocator(psVec, (psFreeFunc) vectorFree); - - psVec->type.dimen = PS_DIMEN_VECTOR; - psVec->type.type = type; - *(long*)&psVec->nalloc = nalloc; - psVec->n = nalloc; - - // Create vector data array - psVec->data.U8 = psAlloc(nalloc * elementSize); - - return psVec; -} - -psVector* psVectorRealloc(psVector* vector, long nalloc) -{ - psS32 elementSize = 0; - psElemType elemType; - - if (vector == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psVector_REALLOC_NULL); - return NULL; - } else if (vector->nalloc != nalloc) { // No need to realloc to same size - elemType = vector->type.type; - elementSize = PSELEMTYPE_SIZEOF(elemType); - if (nalloc < vector->n) { - vector->n = nalloc; - } - // Realloc after decrementation to avoid accessing freed array elements - vector->data.U8 = psRealloc(vector->data.U8, nalloc * elementSize); - *(long*)&vector->nalloc = nalloc; - } - - return vector; -} - -psVector* psVectorRecycle(psVector* vector, long nalloc, psElemType type) -{ - psS32 byteSize; - - if (vector == NULL) { - return psVectorAlloc(nalloc, type); - } - - if (vector->type.dimen != PS_DIMEN_VECTOR && - vector->type.dimen != PS_DIMEN_TRANSV) { - psFree(vector); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVector_NOT_A_VECTOR); - return NULL; - } - - byteSize = nalloc * PSELEMTYPE_SIZEOF(type); - - // need to increase data buffer? - if (byteSize > vector->nalloc*PSELEMTYPE_SIZEOF(vector->type.type)) { - vector->data.U8 = psRealloc(vector->data.U8, byteSize); - *(long*)&vector->nalloc = nalloc; - } - - vector->type.dimen = PS_DIMEN_VECTOR; - vector->type.type = type; - vector->n = nalloc; - return vector; -} - -psVector *psVectorExtend(psVector *vector, long delta, long nExtend) -{ - // can't handle a NULL vector (don't know the data type to allocate) - if (vector == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psVector_NULL); - return NULL; - } - - // requirement on delta; if < 1, set to 10. - if (delta < 1) { - delta = 10; - } - - // adjust the allocated size, if needed. (if nExtend < 1, this is will never happen) - if (nExtend > 0) { - unsigned int minAlloc = vector->n + nExtend + nExtend; - if (vector->nalloc < minAlloc) { - unsigned int nAlloc = delta + vector->nalloc; - // make sure the delta is large enough hold twice the extended length. - if (nAlloc < minAlloc) { - nAlloc = minAlloc; - } - vector = psVectorRealloc(vector, nAlloc); - } - } else if (nExtend < -vector->n) { - // For the case of a negative nExtend, need to check that we are not decreasing - // vector beyond its own length (i.e., creating a negative length). - nExtend = -vector->n; - } - - // increment the length by the value specified - vector->n += nExtend; - - return vector; -} - -psVector* psVectorCopy(psVector* output, const psVector* input, psElemType type) -{ - if (input == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psVector_SORT_NULL); - psFree(output); - return NULL; - } - - psS32 nElements = input->n; - - output = psVectorRecycle(output, nElements, type); - - #define PSVECTOR_COPY(INTYPE,OUTTYPE) { \ - ps##INTYPE *inVec = input->data.INTYPE; \ - ps##OUTTYPE *outVec = output->data.OUTTYPE; \ - for (psS32 col=0;coltype.type) { \ - case PS_TYPE_S8: \ - PSVECTOR_COPY(S8,OUTTYPE); \ - break; \ - case PS_TYPE_S16: \ - PSVECTOR_COPY(S16,OUTTYPE); \ - break; \ - case PS_TYPE_S32: \ - PSVECTOR_COPY(S32,OUTTYPE); \ - break; \ - case PS_TYPE_S64: \ - PSVECTOR_COPY(S64,OUTTYPE); \ - break; \ - case PS_TYPE_U8: \ - PSVECTOR_COPY(U8,OUTTYPE); \ - break; \ - case PS_TYPE_U16: \ - PSVECTOR_COPY(U16,OUTTYPE); \ - break; \ - case PS_TYPE_U32: \ - PSVECTOR_COPY(U32,OUTTYPE); \ - break; \ - case PS_TYPE_U64: \ - PSVECTOR_COPY(U64,OUTTYPE); \ - break; \ - case PS_TYPE_F32: \ - PSVECTOR_COPY(F32,OUTTYPE); \ - break; \ - case PS_TYPE_F64: \ - PSVECTOR_COPY(F64,OUTTYPE); \ - break; \ - case PS_TYPE_C32: \ - PSVECTOR_COPY(C32,OUTTYPE); \ - break; \ - case PS_TYPE_C64: \ - PSVECTOR_COPY(C64,OUTTYPE); \ - break; \ - default: { \ - char* typeStr; \ - PS_TYPE_NAME(typeStr,type); \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - PS_ERRORTEXT_psVector_UNSUPPORTED_TYPE, \ - typeStr); \ - psFree(output); \ - } \ - } \ - break; \ - } - - switch (type) { - PSVECTOR_COPY_CASE(S8); - PSVECTOR_COPY_CASE(S16); - PSVECTOR_COPY_CASE(S32); - PSVECTOR_COPY_CASE(S64); - PSVECTOR_COPY_CASE(U8); - PSVECTOR_COPY_CASE(U16); - PSVECTOR_COPY_CASE(U32); - PSVECTOR_COPY_CASE(U64); - PSVECTOR_COPY_CASE(F32); - PSVECTOR_COPY_CASE(F64); - PSVECTOR_COPY_CASE(C32); - PSVECTOR_COPY_CASE(C64); - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVector_UNSUPPORTED_TYPE, - typeStr); - psFree(output); - - break; - } - } - return output; - - -} - -psVector* psVectorSort(psVector* outVector, const psVector* inVector) -{ - psS32 N = 0; - psS32 elSize = 0; - psPtr inVec = NULL; - psPtr outVec = NULL; - psElemType inType = 0; - - if (inVector == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psVector_SORT_NULL); - psFree(outVector); - return NULL; - } - - inType = inVector->type.type; - N = inVector->n; - inVec = (psPtr)inVector->data.U8; - elSize = PSELEMTYPE_SIZEOF(inType); - - if (outVector == NULL) { - outVector = psVectorAlloc(N, inType); - } - - // check to see if output vector needs to be resized/retyped - if ( (N > outVector->nalloc) || - (inType != outVector->type.type) ) { - // reshape the output vector to match the input vector's size/type. - outVector = psVectorRecycle(outVector,N,inType); - } - outVector->n = N; - outVec = outVector->data.U8; - - if (N == 0) { - // no need to sort anything, as there are no elements in input vector. - return outVector; - } - - // Copy input vector values into output vector if not in-place sorting - if (inVector != outVector) { - memcpy(outVec, inVec, elSize * N); - } - - // Sort output vector - switch (inType) { - case PS_TYPE_U8: - qsort(outVec, N, elSize, psCompareU8); - break; - case PS_TYPE_U16: - qsort(outVec, N, elSize, psCompareU16); - break; - case PS_TYPE_U32: - qsort(outVec, N, elSize, psCompareU32); - break; - case PS_TYPE_U64: - qsort(outVec, N, elSize, psCompareU64); - break; - case PS_TYPE_S8: - qsort(outVec, N, elSize, psCompareS8); - break; - case PS_TYPE_S16: - qsort(outVec, N, elSize, psCompareS16); - break; - case PS_TYPE_S32: - qsort(outVec, N, elSize, psCompareS32); - break; - case PS_TYPE_S64: - qsort(outVec, N, elSize, psCompareS64); - break; - case PS_TYPE_F32: - qsort(outVec, N, elSize, psCompareF32); - break; - case PS_TYPE_F64: - qsort(outVec, N, elSize, psCompareF64); - break; - default: - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVector_UNSUPPORTED_TYPE, - inType); - psFree(outVector); - return NULL; - } - - return outVector; -} - -psVector* psVectorSortIndex(psVector* outVector, const psVector* inVector) -{ - psS32 N = 0; - psElemType inType = 0; - - if (inVector == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psVector_SORT_NULL); - psFree(outVector); - return NULL; - } - - inType = inVector->type.type; - N = inVector->n; - - if (N == 0) { - // no need to sort anything, as there are no elements in input vector. - return outVector; - } - - // ok, let's create a temporary indexed vector - indexedVector* idxVector = psAlloc(sizeof(indexedVector)*N); - int elSize = PSELEMTYPE_SIZEOF(inType); - for (int i = 0; i < N; i++) { - idxVector[i].data.U8 = inVector->data.U8+i*elSize; - idxVector[i].index = i; - } - - // Sort indexed vector - // n.b., since first element in indexedVector is a pointer to the data, - // we can use the 'Ptr' version of the standard compare functions - switch (inType) { - case PS_TYPE_U8: - qsort(idxVector, N, sizeof(indexedVector), (psCompareFcn)psCompareU8Ptr); - break; - case PS_TYPE_U16: - qsort(idxVector, N, sizeof(indexedVector), (psCompareFcn)psCompareU16Ptr); - break; - case PS_TYPE_U32: - qsort(idxVector, N, sizeof(indexedVector), (psCompareFcn)psCompareU32Ptr); - break; - case PS_TYPE_U64: - qsort(idxVector, N, sizeof(indexedVector), (psCompareFcn)psCompareU64Ptr); - break; - case PS_TYPE_S8: - qsort(idxVector, N, sizeof(indexedVector), (psCompareFcn)psCompareS8Ptr); - break; - case PS_TYPE_S16: - qsort(idxVector, N, sizeof(indexedVector), (psCompareFcn)psCompareS16Ptr); - break; - case PS_TYPE_S32: - qsort(idxVector, N, sizeof(indexedVector), (psCompareFcn)psCompareS32Ptr); - break; - case PS_TYPE_S64: - qsort(idxVector, N, sizeof(indexedVector), (psCompareFcn)psCompareS64Ptr); - break; - case PS_TYPE_F32: - qsort(idxVector, N, sizeof(indexedVector), (psCompareFcn)psCompareF32Ptr); - break; - case PS_TYPE_F64: - qsort(idxVector, N, sizeof(indexedVector), (psCompareFcn)psCompareF64Ptr); - break; - default: - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVector_UNSUPPORTED_TYPE, - inType); - psFree(idxVector); - psFree(outVector); - return NULL; - } - - // extract the indices to the output vector - outVector = psVectorRecycle(outVector, N, PS_TYPE_U32); - psU32* outData = outVector->data.U32; - for (int i = 0; i < N; i++) { - outData[i] = idxVector[i].index; - } - - // Free temp memory - psFree(idxVector); - - return outVector; -} - -char* psVectorToString(psVector* vector, int maxLength) -{ - - if (maxLength < 5) { - return NULL; - } - - char* str = psAlloc(sizeof(char)*maxLength+1); - - if (vector == NULL) { - snprintf(str,maxLength, "NULL"); - return str; - } - - int size = vector->n; - - if (size == 0) { - snprintf(str,maxLength, "[]"); - return str; - } - - char* tempStr = psAlloc(sizeof(char)*maxLength+1); - *str = '\0'; - bool full = false; - - #define APPEND_ELEMENTS_CASE(TYPE, NATIVE_TYPE, FORMAT) \ -case PS_TYPE_##TYPE: \ - for (lcv=0; lcv < size && ! full; lcv++) { \ - snprintf(tempStr, maxLength, "%s" FORMAT, prefix, (NATIVE_TYPE) (vector->data.TYPE[lcv])); \ - strncat(str,tempStr,maxLength); \ - full = (strlen(str) > maxLength-2); \ - prefix = ","; \ - } \ - break; - - #define APPEND_ELEMENTS_CASE_COMPLEX(TYPE,CREAL,CIMAG) \ -case PS_TYPE_##TYPE: \ - for (lcv=0; lcv < size && ! full; lcv++) { \ - snprintf(tempStr, maxLength, "%s%g%+gi", prefix, \ - CREAL(vector->data.TYPE[lcv]), \ - CIMAG(vector->data.TYPE[lcv])); \ - full = (strlen(str) > maxLength-2); \ - prefix = ","; \ - } \ - break; - - int lcv; - char* prefix = "["; - switch(vector->type.type) { - APPEND_ELEMENTS_CASE(S8,char,"%hd") - APPEND_ELEMENTS_CASE(S16,short int,"%hd") - APPEND_ELEMENTS_CASE(S32,int,"%d") - APPEND_ELEMENTS_CASE(S64,long,"%ld") - APPEND_ELEMENTS_CASE(U8,unsigned char,"%hu") - APPEND_ELEMENTS_CASE(U16,unsigned short,"%hu") - APPEND_ELEMENTS_CASE(U32,unsigned int, "%u") - APPEND_ELEMENTS_CASE(U64,unsigned long,"%lu") - APPEND_ELEMENTS_CASE(F32,double,"%g") - APPEND_ELEMENTS_CASE(F64,double,"%g") - APPEND_ELEMENTS_CASE_COMPLEX(C32,crealf,cimagf) - APPEND_ELEMENTS_CASE_COMPLEX(C64,creal,cimag) - default: - snprintf(str,maxLength,"[...]"); - break; - } - - if (full) { - // couldn't all fit in given string length - - // remove elements until there is room for ",...]" - while (strlen(str) > maxLength - 5) { - char* lastComma = strrchr(str,','); - if (lastComma == NULL) { // no comma, must be first number - str[1] = '\0'; - } else { - *lastComma = '\0'; - } - } - strncat(str,",...]",maxLength); - } else { - strncat(str,"]",maxLength); - } - - psFree(tempStr); - - return str; -} - -psF64 p_psVectorGetElementF64(psVector* vector, - int position) -{ - if (vector == NULL) { - return NAN; - } - if (position < 0 || position >= vector->n) { - return NAN; - } - - switch (vector->type.type) { - case PS_TYPE_U8: - return vector->data.U8[position]; - break; - case PS_TYPE_U16: - return vector->data.U16[position]; - break; - case PS_TYPE_U32: - return vector->data.U32[position]; - break; - case PS_TYPE_U64: - return vector->data.U64[position]; - break; - case PS_TYPE_S8: - return vector->data.S8[position]; - break; - case PS_TYPE_S16: - return vector->data.S16[position]; - break; - case PS_TYPE_S32: - return vector->data.S32[position]; - break; - case PS_TYPE_S64: - return vector->data.S64[position]; - break; - case PS_TYPE_F32: - return vector->data.F32[position]; - break; - case PS_TYPE_F64: - return vector->data.F64[position]; - default: - return NAN; - } -} - -bool p_psVectorPrint (FILE *f, psVector *a, char *name) -{ - - fprintf (f, "vector: %s\n", name); - - for (int i = 0; i < a[0].n; i++) { - fprintf (f, "%f\n", p_psVectorGetElementF64(a, i)); - } - fprintf (f, "\n"); - return (true); -} Index: unk/psLib/src/collections/psVector.h =================================================================== --- /trunk/psLib/src/collections/psVector.h (revision 4545) +++ (revision ) @@ -1,196 +1,0 @@ -/** @file psVector.h - * - * @brief Contains basic vector definitions and operations - * - * This file defines the basic type for a vector struct and functions useful - * in manupulating vectors. - * - * @ingroup Vector - * - * @author Robert DeSonia, MHPCC - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.38 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-07 02:17:53 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_VECTOR_H -#define PS_VECTOR_H - -#include - -#include "psType.h" - -/// @addtogroup Vector -/// @{ - -///< Union of psVector data types. -typedef union { - psU8* U8; ///< Unsigned 8-bit integer data. - psU16* U16; ///< Unsigned 16-bit integer data. - psU32* U32; ///< Unsigned 32-bit integer data. - psU64* U64; ///< Unsigned 64-bit integer data. - psS8* S8; ///< Signed 8-bit integer data. - psS16* S16; ///< Signed 16-bit integer data. - psS32* S32; ///< Signed 32-bit integer data. - psS64* S64; ///< Signed 64-bit integer data. - psF32* F32; ///< Single-precision float data. - psF64* F64; ///< Double-precision float data. - psC32* C32; ///< Single-precision complex data. - psC64* C64; ///< Double-precision complex data. -} -p_psVectorData; - -/** An vector to support primitive types. - * - * Struct for maintaining an vector of frequently used primitive types. - * - */ -typedef struct -{ - psMathType type; ///< Type of data. - long n; ///< Number of elements in use. - const long nalloc; ///< Total number of elements available. - p_psVectorData data; ///< Union for data types. - void *lock; ///< Optional lock for thread safety. -} -psVector; - -/*****************************************************************************/ - -/* FUNCTION PROTOTYPES */ - -/*****************************************************************************/ - - -/** Allocate a vector. - * - * Uses psLib memory allocation functions to create a vector collection of - * data as defined by the psType type. - * - * @return psVector* Pointer to psVector. - */ -psVector* psVectorAlloc( - long nalloc, ///< Total number of elements to make available. - psElemType type ///< Type of data to be held by vector. -) -; - -/** Reallocate a vector. - * - * Uses psLib memory allocation functions to reallocate a vector collection - * of data. The vector is reallocated according to the psType type member - * contained within the vector. - * - * @return psVector* Pointer to psVector. - * - */ -psVector* psVectorRealloc( - psVector* vector, ///< Vector to reallocate. - long nalloc ///< Total number of elements to make available. -); - -/** Extend a vector's length. - * - * Increments a vector's length, n, by the specified number of elements. - * If the allocated storage is less than the current vector's length plus - * twice the number of elements to be added, it is reallocated larger by - * a given amount. - * - * @return psVector* Pointer to the adjusted psVector - */ -psVector *psVectorExtend( - psVector *vector, ///< Vector to extend - long delta, ///< Amount to expand allocation, if necessary - long nExtend ///< Number of elements to add to vector length -); - -/** Recycle a vector. - * - * Uses psLib memory allocation functions to reallocate a vector collection - * of data. The vector is reallocated according to the psElemType type - * parameter. - * - * @return psVector* Pointer to psVector. - * - */ -psVector* psVectorRecycle( - psVector* vector, - ///< Vector to recycle. If NULL, a new vector is created. No effort - ///< taken to preserve the values. - - long nalloc, ///< Total number of elements to make available. - psElemType type ///< the datatype of the returned vector -); - -/** Copy a vector, converting types. - * - * Performs a deep copy of the elements of one psVector to a new psVector, - * converting numeric types to a specified type. - * - * @return psVector* Pointer to resulting psVector. - * - */ -psVector* psVectorCopy( - psVector* output, ///< if non-NULL, a psVector to recycle - const psVector* input, ///< the vector to copy. - psElemType type ///< the data type of the resulting psVector -); - -/** Sort an array of floats. - * - * Sorts an array of floats in ascending order. This function is valid for - * all non-complex data types. - * - * @return psVector* Pointer to sorted psVector. - */ -psVector* psVectorSort( - psVector* outVector, ///< the output vector to recycle, or NULL if new vector desired. - const psVector* inVector ///< the vector to sort. -); - -/** Creates an array of indices based on sort ordered of array. - * - * Sorts a vector and creates an integer array holding indices of - * sorted float values based on pre-sort index positions. - * - * @return psVector* vector of the indices of sort. - */ -psVector* psVectorSortIndex( - psVector* outVector, ///< vector to recycle - const psVector* inVector ///< vector to sort -); - -/** Creates a string from a psVector's values in the form "[x0,x1,x2]". - * - * @return psPtr a newly allocated string - */ -char* psVectorToString( - psVector* vector, ///< vector to create a string from - int maxLength ///< the maximum length of the resulting string -); - -/** Returns an element in the vector as a psF64 value - * - * @return psF64 the value at specified position, or NAN if position is invalid. - */ -psF64 p_psVectorGetElementF64( - psVector* vector, ///< vector to retrieve element - int position ///< the vector position to get -); - -/** Print a vector to a stream - * - * @return psBool TRUE is successful, otherwise FALSE. - */ -bool p_psVectorPrint ( - FILE *f, ///< output stream - psVector *a, ///< vector to print - char *name ///< name of vector (for title) -); - -/// @} - -#endif // #ifndef PS_VECTOR_H Index: unk/psLib/src/dataIO/.cvsignore =================================================================== --- /trunk/psLib/src/dataIO/.cvsignore (revision 4545) +++ (revision ) @@ -1,7 +1,0 @@ -Makefile.in -.deps -.libs -Makefile -*.lo -*.la - Index: unk/psLib/src/dataIO/Makefile.am =================================================================== --- /trunk/psLib/src/dataIO/Makefile.am (revision 4545) +++ (revision ) @@ -1,30 +1,0 @@ -#Makefile for dataIO functions of psLib -# -INCLUDES = \ - -I$(top_srcdir)/src/astronomy \ - -I$(top_srcdir)/src/collections \ - -I$(top_srcdir)/src/dataManip \ - -I$(top_srcdir)/src/image \ - -I$(top_srcdir)/src/sysUtils \ - $(all_includes) - -noinst_LTLIBRARIES = libpslibdataIO.la - -libpslibdataIO_la_SOURCES = \ - psLookupTable.c \ - psFits.c \ - psDB.c - - -BUILT_SOURCES = psFileUtilsErrors.h -EXTRA_DIST = psFileUtilsErrors.dat psFileUtilsErrors.h dataIO.i - -psFileUtilsErrors.h: psFileUtilsErrors.dat - $(top_srcdir)/src/psParseErrorCodes --data=$? $@ - -pslibincludedir = $(includedir) -pslibinclude_HEADERS = \ - psLookupTable.h \ - psFits.h \ - psDB.h - Index: unk/psLib/src/dataIO/dataIO.i =================================================================== --- /trunk/psLib/src/dataIO/dataIO.i (revision 4545) +++ (revision ) @@ -1,4 +1,0 @@ -/* dataIO headers */ -%include "psFileUtilsErrors.h" -%include "psFits.h" -%include "psLookupTable.h" Index: unk/psLib/src/dataIO/psDB.c =================================================================== --- /trunk/psLib/src/dataIO/psDB.c (revision 4545) +++ (revision ) @@ -1,1723 +1,0 @@ -/** @file psDB.c - * - * -*- mode: C; c-basic-indent: 4; tab-width: 8; indent-tabs-mode: nil -*- - * vim: set cindent ts=8 sw=4 expandtab: - * - * @brief database functions - * - * This file contains functions that perform basic database operations. MySQL - * 4.1.2 or newer is required. - * - * @author Aaron Culliney - * @author Joshua Hoblitt - * - * @version $Revision: 1.38 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2005 Joshua Hoblitt, University of Hawaii - */ - -#ifndef OMIT_PSDB - -#include -#include -#include -#undef __STRICT_ANSI__ -#include -#define __STRICT_ANSI__ -#include -#include -#include // enum_field_types - -#include "psDB.h" -#include "psMemory.h" -#include "psAbort.h" -#include "psError.h" -#include "psString.h" -#include "psFileUtilsErrors.h" - -typedef struct -{ - enum enum_field_types type; - bool isUnsigned; -} -mysqlType; - -// database utility functions -static inline bool psDBPackRow(MYSQL_BIND *bind, const psMetadata *values, psU32 paramCount); - -// SQL generation functions -static char *psDBGenerateCreateTableSQL(const char *tableName, const psMetadata *where); -static char *psDBGenerateSelectRowSQL(const char *tableName, const char *col, const psMetadata *where, psU64 limit); -static char *psDBGenerateInsertRowSQL(const char *tableName, const psMetadata *row); -static char *psDBGenerateUpdateRowSQL(const char *tableName, const psMetadata *where, const psMetadata *values); -static char *psDBGenerateDeleteRowSQL(const char *tableName, const psMetadata *where, unsigned long long limit); -static char *psDBGenerateWhereSQL(const psMetadata *where); -static char *psDBGenerateSetSQL(const psMetadata *set - ); - -// lookup table functions -static psElemType psDBMySQLToPType(enum enum_field_types type, unsigned int flags); -static char *psDBPTypeToSQL(psElemType pType); -static mysqlType *psDBPTypeToMySQL(psElemType pType); - -static psHash *psDBGetPTypeToSQLTable(void); -static void psDBPTypeToSQLTableCleanup(void); - -static psHash *psDBGetSQLToPTypeTable(void); -static void psDBSQLToPTypeTableCleanup(void); - -static psHash *psDBGetMySQLToSQLTable(void); -static void psDBMySQLToSQLTableCleanup(void); - -static psHash *psDBGetPTypeToMySQLTable(void); -static void psDBPTypeToMySQLTableCleanup(void); - -static psPtr psDBMySQLTypeAlloc(enum enum_field_types type, bool isUnsigned); -static void psDBAddToLookupTable(psHash *lookupTable, psU32 type, const char *string); -static void psDBAddVoidToLookupTable(psHash *lookupTable, psU32 type, psPtr value); - -// pType utility functions -static psPtr psDBGetPTypeNaN(psElemType pType); -static bool psDBIsPTypeNaN(psElemType pType, psPtr data); - -// string utility functions -static char *psDBIntToString(psU64 n); - - -// public functions -/*****************************************************************************/ - -psDB *psDBInit(const char *host, const char *user, const char *passwd, const char *dbname) -{ - MYSQL *mysql; - psDB *dbh; - - mysql = mysql_init(NULL); - if (!mysql) { - psAbort(__func__, "mysql_init(), out of memory."); - } - - // Connect to host and mySql server with specified database - if (!mysql_real_connect(mysql, host, user, passwd, dbname, 0, NULL, 0)) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psDB_FAILED_TO_CONNECT,mysql_error(mysql)); - - mysql_close(mysql); - - return NULL; - } - - dbh = psAlloc(sizeof(psDB)); - - dbh->mysql = mysql; - - return dbh; -} - -void psDBCleanup(psDB *dbh) -{ - // Check if argument dbh is NULL - if(dbh == NULL) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psDB_INVALID_PSDB); - } else { - - // Attempt to close specified database connection - mysql_close(dbh->mysql); - dbh->mysql = NULL; - psFree(dbh); - - // ASC WARNING NOTE: the psDBSQLToPTypeTableCleanup cleanup routine - // needs to be called first because it refers to - // psDBGetPTypeToSQLTable ... - psDBSQLToPTypeTableCleanup(); - psDBMySQLToSQLTableCleanup(); - psDBPTypeToSQLTableCleanup(); - psDBPTypeToMySQLTableCleanup(); - } -} - -bool psDBCreate(psDB *dbh, const char *dbname) -{ - char *query = NULL; - bool status; - - psStringAppend(&query, "CREATE DATABASE %s", dbname); - - // the MySQL C API notes that mysql_create_db() is deprecated - status = p_psDBRunQuery(dbh, query); - if (!status) { - psError(PS_ERR_UNKNOWN, false, "Failed to create new database."); - } - - psFree(query); - - return status; -} - -bool psDBChange(psDB *dbh, const char *dbname) -{ - // Verify database object is valid - if(dbh == NULL) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psDB_INVALID_PSDB); - return false; - } - - // Attempt to select new database - if (mysql_select_db(dbh->mysql, dbname) != 0) { - psError(PS_ERR_UNKNOWN, true, PS_ERRORTEXT_psDB_FAILED_TO_CHANGE, - mysql_error(dbh->mysql)); - - return false; - } - - return true; -} - -bool psDBDrop(psDB *dbh, const char *dbname) -{ - char *query = NULL; - bool status; - - psStringAppend(&query, "DROP DATABASE %s", dbname); - - // the MySQL C API notes that mysql_drop_db() is deprecated - status = p_psDBRunQuery(dbh, query); - if (!status) { - psError(PS_ERR_UNKNOWN, false, "Failed to drop database."); - } - - psFree(query); - - return status; -} - -bool psDBCreateTable(psDB *dbh, const char *tableName, const psMetadata *md) -{ - char *query; - bool status; - - // Verify the database object is not NULL - if(dbh == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL,true,PS_ERRORTEXT_psDB_INVALID_PSDB); - return false; - } - - // Generate SQL query string - query = psDBGenerateCreateTableSQL(tableName, md); - if (!query) { - psError(PS_ERR_UNEXPECTED_NULL, false, PS_ERRORTEXT_psDB_QUERY_GEN_FAIL); - return false; - } - - // Run SQL query to create table - status = p_psDBRunQuery(dbh, query); - if (!status) { - psError(PS_ERR_UNKNOWN, false, PS_ERRORTEXT_psDB_TABLE_CREATE_FAIL); - } - - // Free query string - psFree(query); - - return status; -} - -bool psDBDropTable(psDB *dbh, const char *tableName) -{ - char *query = NULL; - bool status; - - // Create SQL command string to drop table - psStringAppend(&query, "DROP TABLE %s", tableName); - - // Execute query - status = p_psDBRunQuery(dbh, query); - if (!status) { - psError(PS_ERR_UNKNOWN, false, PS_ERRORTEXT_psDB_TABLE_DROP_FAIL); - } - - psFree(query); - - return status; -} - -psArray *psDBSelectColumn(psDB *dbh, const char *tableName, const char *col, unsigned long long limit) -{ - MYSQL_RES *result; // complete db result set - MYSQL_ROW row; // single row of db result set - char *query; // SQL query - my_ulonglong rowCount; // number of rows in db result set - unsigned long dataSize; // size of field - unsigned int fieldCount; // number of fields in db result set - psArray *column = NULL; // return array - psPtr data; // copy of result field - - // Generate SQL query string - query = psDBGenerateSelectRowSQL(tableName, col, NULL, limit); - if (!query) { - psError(PS_ERR_UNEXPECTED_NULL, false, PS_ERRORTEXT_psDB_QUERY_GEN_FAIL); - return NULL; - } - - // Execut SQL query string - if (!p_psDBRunQuery(dbh, query)) { - psError(PS_ERR_UNKNOWN, false, PS_ERRORTEXT_psDB_SEL_COL_FAIL); - psFree(query); - return NULL; - } - psFree(query); - - // Obtain query result and check for no data condition - result = mysql_store_result(dbh->mysql); - - if (!result) { - // no result set - fieldCount = mysql_field_count(dbh->mysql); - - // if field count is zero the query returned no data. If it's non-zero - // then something bad has happened. - if (fieldCount != 0) { - psError(PS_ERR_UNEXPECTED_NULL, true, PS_ERRORTEXT_psDB_QUERY_NO_DATA, - mysql_error(dbh->mysql)); - return NULL; - } - } - - // Get number of rows returned in result - rowCount = mysql_num_rows(result); - - // pre-allocate enough elements to hold the complete result set - // then reset n to 0 so elements are added from the beginning of - // the array - column = psArrayAlloc(rowCount); - column->n = 0; - - // Fetch each result - while ((row = mysql_fetch_row(result))) { - // get the first element of lengths array that is part of the - // result set - dataSize = *(mysql_fetch_lengths(result)); - - // represent NULL as an empty string - if (row[0] == NULL) { - data = psStringCopy(""); - } else { - data = psAlloc(dataSize+1); - memcpy(data, row[0], dataSize); - ((char*)data)[dataSize] = '\0'; - } - - // add field to return array - psArrayAdd(column, 0, data); - psFree(data); - } - - // Clean up mysql memory - mysql_free_result(result); - - return column; -} - -// dest = assign to, source = source string psArray, conv = conversion function, -// type = type to cast to, pType = psElemType -#define PS_STR_ARRAY_TO_PTYPE(dest, source, conv, type, pType) \ -{ \ - psPtr myNaN; \ - int i; \ - \ - for (i = 0; i < source->n; i++) { \ - if (strlen(source->data[i])) { \ - dest[i] = (type)conv(source->data[i]); \ - } else { \ - myNaN = psDBGetPTypeNaN(pType); \ - dest[i] = *(type *)myNaN; \ - psFree(myNaN); \ - } \ - } \ -} - -psVector *psDBSelectColumnNum(psDB *dbh, const char *tableName, const char *col, psElemType type, unsigned long long limit) -{ - psArray *stringColumn; // source psArray - psVector *column; // dest psVector - - stringColumn = psDBSelectColumn(dbh, tableName, col, limit); - if (!stringColumn) { - // could be an error or the result set was just empty - return NULL; - } - - column = psVectorAlloc(stringColumn->n, type); - - // conversion functions are a portability issue - switch (type) { - case PS_TYPE_S8: - PS_STR_ARRAY_TO_PTYPE(column->data.S8, stringColumn, atoi, psS8, PS_TYPE_S8); - break; - case PS_TYPE_S16: - PS_STR_ARRAY_TO_PTYPE(column->data.S16, stringColumn, atoi, psS16, PS_TYPE_S16); - break; - case PS_TYPE_S32: - PS_STR_ARRAY_TO_PTYPE(column->data.S32, stringColumn, atoi, psS32, PS_TYPE_S32); - break; - case PS_TYPE_S64: - PS_STR_ARRAY_TO_PTYPE(column->data.S64, stringColumn, atoll, psS64, PS_TYPE_S64); - break; - case PS_TYPE_U8: - PS_STR_ARRAY_TO_PTYPE(column->data.U8, stringColumn, atoi, psU8, PS_TYPE_U8); - break; - case PS_TYPE_U16: - PS_STR_ARRAY_TO_PTYPE(column->data.U16, stringColumn, atoi, psU16, PS_TYPE_U16); - break; - case PS_TYPE_U32: - PS_STR_ARRAY_TO_PTYPE(column->data.U32, stringColumn, atoi, psU32, PS_TYPE_U32); - break; - case PS_TYPE_U64: - PS_STR_ARRAY_TO_PTYPE(column->data.U64, stringColumn, atoll, psU64, PS_TYPE_U64); - break; - case PS_TYPE_F32: - PS_STR_ARRAY_TO_PTYPE(column->data.F32, stringColumn, atof, psF32, PS_TYPE_F32); - break; - case PS_TYPE_F64: - PS_STR_ARRAY_TO_PTYPE(column->data.F64, stringColumn, atof, psF64, PS_TYPE_F64); - break; - case PS_TYPE_C32: - // this is a bogus SQL type - PS_STR_ARRAY_TO_PTYPE(column->data.C32, stringColumn, atof, psC32, PS_TYPE_C32); - break; - case PS_TYPE_C64: - // this is a bogus SQL type - PS_STR_ARRAY_TO_PTYPE(column->data.C64, stringColumn, atof, psC64, PS_TYPE_C64); - break; - case PS_TYPE_BOOL: - // valid for psVector? - PS_STR_ARRAY_TO_PTYPE(column->data.U8, stringColumn, atoi, psU8, PS_TYPE_U8); - break; - } - - psFree(stringColumn); - - return column; -} - -psArray *psDBSelectRows(psDB *dbh, const char *tableName, const psMetadata *where, unsigned long long limit) -{ - MYSQL_RES *result; // complete db result set - MYSQL_ROW row; // single row of db result set - MYSQL_FIELD *field; // field type info - char *query; // SQL query - my_ulonglong rowCount; // number of rows in db result set - unsigned int fieldCount; // number of fields in db result set - unsigned long *fieldLength; // field sizes - long len; // field length - psArray *resultSet; // return array - int i; // field index - psMetadata *md; // a row - psU32 pType; // psElemType of a field - psPtr data; // copy of result field - - // Create select row query - query = psDBGenerateSelectRowSQL(tableName, NULL, where, limit); - if (!query) { - psError(PS_ERR_UNEXPECTED_NULL, false, "Query generation failed."); - return NULL; - } - - // Run SQL query - if (!p_psDBRunQuery(dbh, query)) { - psError(PS_ERR_UNKNOWN, false, "Query execution failed."); - psFree(query); - return NULL; - } - psFree(query); - - result = mysql_store_result(dbh->mysql); - if (!result) { - // no result set - fieldCount = mysql_field_count(dbh->mysql); - - // if field count is zero the query should have returned no data. If - // it's non-zero then something bad has happened. - if (fieldCount != 0) { - psError(PS_ERR_UNEXPECTED_NULL, true, "Query returned no data. Error: %s", mysql_error(dbh->mysql)); - - return NULL; - } - } - - rowCount = mysql_num_rows(result); - - // pre-allocate enough elements to hold the complete result set - // then reset n to 0 so elements are added from the beginning of - // the array - resultSet = psArrayAlloc(rowCount); - resultSet->n = 0; - - field = mysql_fetch_fields(result); - fieldCount = mysql_num_fields(result); - - while ((row = mysql_fetch_row(result))) { - // allocate new psMetadata to represent a row - md = psMetadataAlloc(); - - fieldLength = mysql_fetch_lengths(result); - - for (i = 0; i < fieldCount; i++) { - // lookup MySQL column type - pType = psDBMySQLToPType(field[i].type, field[i].flags); - - len = fieldLength[i]; - if (len) { - data = psAlloc(len+1); - memcpy(data, row[i], len); - ((char*)data)[len] = '\0'; - } else { - data = psDBGetPTypeNaN(pType); - } - - // copy field data and convert NULLs to the appropriate NaN value - if (pType == PS_META_STR) { - psMetadataAddStr(md, PS_LIST_TAIL, field[i].name, "", data); - } else if (pType == PS_META_S32) { - psMetadataAddS32(md, PS_LIST_TAIL, field[i].name, "", atoll(data)); - } else if (pType == PS_META_F32) { - psMetadataAddF32(md, PS_LIST_TAIL, field[i].name, "", atof(data)); - } else if (pType == PS_META_F64) { - psMetadataAddF64(md, PS_LIST_TAIL, field[i].name, "", atof(data)); - } else if (pType == PS_META_BOOL) { - psMetadataAdd(md, PS_LIST_TAIL, field[i].name, pType, "", atoi(data)); - } else { - // XXX: assume binary string ... - psMetadataAddStr(md, PS_LIST_TAIL, field[i].name, "", data); - } - - psFree(data); - } - - // add row to result set - psArrayAdd(resultSet, 0, md); - psFree(md); - } - - mysql_free_result(result); - - return resultSet; -} - -bool psDBInsertOneRow(psDB *dbh, const char *tableName, const psMetadata *row) -{ - psArray *rowSet; // psArray of row to insert - - // Check for null row - if(row == NULL) { - psError(PS_ERR_UNKNOWN,true,PS_ERRORTEXT_psDB_INSERT_ROW_FAIL); - return false; - } - - // Create array to store single row - rowSet = psArrayAlloc(1); - rowSet->n = 0; - psArrayAdd(rowSet, 0, (psPtr)row); - - // Execute function to insert rows - if (!psDBInsertRows(dbh, tableName, rowSet)) { - psError(PS_ERR_UNKNOWN, false, PS_ERRORTEXT_psDB_INSERT_ROW_FAIL); - psFree(rowSet); - return false; - } - - psFree(rowSet); - - return true; -} - -bool psDBInsertRows(psDB *dbh, const char *tableName, const psArray *rowSet) -{ - psMetadata *row; // row of data - char *query; // SQL query - MYSQL_STMT *stmt; // prepared db statement - MYSQL_BIND *bind; // field values to insert - unsigned long paramCount; // number of placeholders in query - psU64 j; // row index - - // Verify database connections is set up - if(dbh == NULL) { - psError(PS_ERR_UNEXPECTED_NULL,true,PS_ERRORTEXT_psDB_INVALID_PSDB); - return false; - } - - // Verify row array is non-NULL - if(rowSet == NULL) { - psError(PS_ERR_UNEXPECTED_NULL,true,PS_ERRORTEXT_psDB_INSERT_ROW_FAIL); - return false; - } - - // we are assuming that all rows in the set have an identical with reguard - // to field count and type - row = rowSet->data[0]; - - // Generate SQL query string - query = psDBGenerateInsertRowSQL(tableName, row); - if (!query) { - psError(PS_ERR_UNEXPECTED_NULL, false, PS_ERRORTEXT_psDB_QUERY_GEN_FAIL); - return false; - } - - // Prepare SQL statement - stmt = mysql_stmt_init(dbh->mysql); - if (!stmt) { - psAbort(__func__, "mysql_stmt_init(), out of memory."); - } - if (mysql_stmt_prepare(stmt, query, (unsigned long)strlen(query))) { - psError(PS_ERR_UNKNOWN, true, "Failed to prepare query. Error: %s", mysql_stmt_error(stmt)); - mysql_stmt_close(stmt); - psFree(query); - return false; - } - - psFree(query); - - // how many place holders are in our query - paramCount = mysql_stmt_param_count(stmt); - - // structure larger enough to hold one field of data per place holder - bind = psAlloc(sizeof(MYSQL_BIND) * paramCount); - - // loop over rows - for (j = 0; j < rowSet->n; j++) { - row = rowSet->data[j]; - - // reset bind for each row - memset(bind, 0, sizeof(MYSQL_BIND) * paramCount); - - if (!psDBPackRow(bind, row, paramCount)) { - psError(PS_ERR_UNKNOWN, false, "Failed to pack params into bind structure."); - - mysql_rollback(dbh->mysql); - - psFree(bind); - mysql_stmt_close(stmt); - } - - if (mysql_stmt_bind_param(stmt, bind)) { - psError(PS_ERR_UNKNOWN, true, "Failed to bind params. Error: %s", mysql_stmt_error(stmt)); - - mysql_rollback(dbh->mysql); - - psFree(bind); - mysql_stmt_close(stmt); - - return false; - } - - if (mysql_stmt_execute(stmt)) { - psError(PS_ERR_UNKNOWN, true, "Failed to execute prepared statement. Error: %s", - mysql_stmt_error(stmt)); - - mysql_rollback(dbh->mysql); - - psFree(bind); - mysql_stmt_close(stmt); - - return false; - } - } // end loop over rows - - // point of no return - mysql_commit(dbh->mysql); - - psFree(bind); - mysql_stmt_close(stmt); - - return true; -} - -psArray *psDBDumpRows(psDB *dbh, const char *tableName) -{ - return psDBSelectRows(dbh, tableName, NULL, 0); -} - -psMetadata *psDBDumpCols(psDB *dbh, const char *tableName) -{ - MYSQL_RES *result; - MYSQL_FIELD *field; - unsigned int fieldCount; - psMetadata *table; - psU32 pType; - unsigned int i; - psPtr column; - - // Verify database object is not null - if(dbh == NULL) { - psError(PS_ERR_UNEXPECTED_NULL,true,PS_ERRORTEXT_psDB_INVALID_PSDB); - return NULL; - } - - // Verify table name is not null - if(tableName == NULL) { - psError(PS_ERR_UNEXPECTED_NULL,true,PS_ERRORTEXT_psDB_NULL_TABLE); - return NULL; - } - - // find column types - result = mysql_list_fields(dbh->mysql, tableName, NULL); - if (!result) { - psError(PS_ERR_UNEXPECTED_NULL, true, "Failed to retrieve column types."); - } - - field = mysql_fetch_fields(result); - fieldCount = mysql_num_fields(result); - - table = psMetadataAlloc(); - - // fetch each column and load into psMetadata - for (i =0; i < fieldCount; i++) { - // find ptype of column - pType = psDBMySQLToPType(field[i].type, field[i].flags); - //psLogMsg( __func__, PS_LOG_INFO, "pType=[%ld]\n", pType ); - - // if the ptype is PS_TYPE_PTR assume that it's a string and fetch the - // column as an psArray of strings; otherwise fetch the column as a - // psVector. - if (pType == PS_META_STR) { - // PS_META_UNKNOWN -> PS_META_ARRAY ? - column = psDBSelectColumn(dbh, tableName, field[i].name, 0); - psMetadataAddArray(table, PS_LIST_TAIL, field[i].name, "", column); - // psMetadataAddStr(table, PS_LIST_TAIL, field[i].name, "", column); - psFree(column); - } else { - column = psDBSelectColumnNum(dbh, tableName, field[i].name, pType, 0); - psMetadataAddVector(table, PS_LIST_TAIL, field[i].name, "", column); - psFree(column); - } - } - - return table; -} - -psS64 psDBUpdateRows(psDB *dbh, const char *tableName, const psMetadata *where, const psMetadata *values) -{ - char *query; - MYSQL_STMT *stmt; // prepared db statement - unsigned long paramCount; // number of placeholders in query - MYSQL_BIND *bind; // field values to insert - my_ulonglong rowsAffected; // number of rows affected by query - - // Verify database object is not NULL - if(dbh == NULL) { - psError(PS_ERR_UNEXPECTED_NULL,true,PS_ERRORTEXT_psDB_INVALID_PSDB); - return -1; - } - - // Generate SQL query to update row - query = psDBGenerateUpdateRowSQL(tableName, where, values); - if (!query) { - psError(PS_ERR_UNEXPECTED_NULL, false, PS_ERRORTEXT_psDB_QUERY_GEN_FAIL); - return -1; - } - - // Initialize SQL statement - stmt = mysql_stmt_init(dbh->mysql); - if (!stmt) { - psAbort(__func__, "mysql_stmt_init(), out of memory."); - } - - // Prepare SQL statement - if (mysql_stmt_prepare(stmt, query, (unsigned long)strlen(query))) { - psError(PS_ERR_UNKNOWN, true, PS_ERRORTEXT_psDB_SQL_PREPARE_FAIL, mysql_stmt_error(stmt)); - mysql_stmt_close(stmt); - psFree(query); - return -1; - } - psFree(query); - - // how many place holders are in our query - paramCount = mysql_stmt_param_count(stmt); - - // structure large enough to hold one field of data per place holder - bind = psAlloc(sizeof(MYSQL_BIND) * paramCount); - - // init bind - memset(bind, 0, sizeof(MYSQL_BIND) * paramCount); - - if (!psDBPackRow(bind, values, paramCount)) { - psFree(bind); - mysql_stmt_close(stmt); - return -1; - } - - if (mysql_stmt_bind_param(stmt, bind)) { - psError(PS_ERR_UNKNOWN, true, "Failed to bind params. Error: %s", mysql_stmt_error(stmt)); - mysql_rollback(dbh->mysql); - psFree(bind); - mysql_stmt_close(stmt); - return -1; - } - - if (mysql_stmt_execute(stmt)) { - psError(PS_ERR_UNKNOWN, true, "Failed to execute prepared statement. Error: %s", - mysql_stmt_error(stmt)); - mysql_rollback(dbh->mysql); - psFree(bind); - mysql_stmt_close(stmt); - return -1; - } - - psFree(bind); - - // mysql_stmt_affected_rows() must be called before a commit - rowsAffected = mysql_stmt_affected_rows(stmt); - - // point of no return - mysql_commit(dbh->mysql); - - mysql_stmt_close(stmt); - - return rowsAffected; -} - -psS64 psDBDeleteRows(psDB *dbh, const char *tableName, const psMetadata *where, unsigned long long limit) -{ - char *query; - psS64 rows = 0; - - // Verify database is not NULL - if(dbh == NULL) { - psError(PS_ERR_UNEXPECTED_NULL, true, PS_ERRORTEXT_psDB_INVALID_PSDB); - return -1; - } - - // Create SQL statement string - query = psDBGenerateDeleteRowSQL(tableName, where,limit); - if (!query) { - psError(PS_ERR_UNEXPECTED_NULL, false, "Query generation failed."); - return -1; - } - - // Run SQL query - if (!p_psDBRunQuery(dbh, query)) { - psError(PS_ERR_UNKNOWN, false, "Delete failed."); - mysql_rollback(dbh->mysql); - psFree(query); - return -1; - } - psFree(query); - - // Get the number of affected row for the delete command - rows = (psS64)mysql_affected_rows(dbh->mysql); - - // point of no return - mysql_commit(dbh->mysql); - - return rows; -} - -// database utility functions -/*****************************************************************************/ - -bool p_psDBRunQuery(psDB *dbh, const char *format) -{ - // Verify database object is not NULL - if(dbh == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL,true,PS_ERRORTEXT_psDB_INVALID_PSDB); - return false; - } - - // Run query - if (mysql_real_query(dbh->mysql, format, (unsigned long)strlen(format)) !=0) { - psError(PS_ERR_UNKNOWN, true, PS_ERRORTEXT_psDB_SQL_QUERY_FAIL, mysql_error(dbh->mysql)); - return false; - } - - return true; -} - -static inline bool psDBPackRow(MYSQL_BIND *bind, const psMetadata *values, psU32 paramCount) -{ - psListIterator *cursor; // row iterator - psMetadataItem *item; // field in row - mysqlType *mType; // type tmp variable - static bool isNull = true; // used in a MYSQL_BIND to indicate NULL, - // this will be used outside of this func - psU32 i; // field index - - // Verify values or bind are not null - if((values == NULL) || (bind == NULL)) { - return false; - } - - // check size of values == paramCount ? - cursor = psListIteratorAlloc(values->list, 0, false); - - // loop over fields - i = 0; - while ((item = psListGetAndIncrement(cursor))) { - // lookup pType -> mysql type - mType = psDBPTypeToMySQL(item->type); - - bind[i].buffer_type = mType->type; - bind[i].is_unsigned = mType->isUnsigned; - - psFree(mType); - - // input data length is determined by the MYSQL_TYPE_* unless it's a string - if (item->type == PS_TYPE_S32) { - bind[i].length = 0; - bind[i].buffer = &item->data.S32; - bind[i].is_null = psDBIsPTypeNaN(item->type, &item->data.S32) - ? (my_bool *)&isNull - : NULL; - } else if (item->type == PS_TYPE_F32) { - bind[i].length = 0; - bind[i].buffer = &item->data.F32; - bind[i].is_null = psDBIsPTypeNaN(item->type, &item->data.F32) - ? (my_bool *)&isNull - : NULL; - } else if (item->type == PS_TYPE_F64) { - bind[i].length = 0; - bind[i].buffer = &item->data.F64; - bind[i].is_null = psDBIsPTypeNaN(item->type, &item->data.F64) - ? (my_bool *)&isNull - : NULL; - } else if (item->type == PS_TYPE_BOOL) { - // XXX: ASC HACK NOTE (2005/06/03): set extreme bytes to the - // boolean character value. sizeof(psBool)==4 which triggers an - // endianess issue in the MySQL conversion (reading only 1 byte), - // on Macintosh hardware (and maybe others?) - unsigned int c = (unsigned int)item->data.B; - item->data.S32 = (unsigned int)((c<<24) | c); - bind[i].length = 0; - bind[i].buffer = &item->data.B; - bind[i].is_null = psDBIsPTypeNaN(item->type, &item->data.B) - ? (my_bool *)&isNull - : NULL; - } else if (item->type == PS_META_STR) { - // convert NaNs to NULL and set the buffer_length for strings - - bind[i].buffer_length = (unsigned long)strlen((char *)item->data.V); - bind[i].length = &bind[i].buffer_length; - bind[i].buffer = item->data.V; - bind[i].is_null = *(char *)item->data.V == '\0' - ? (my_bool *)&isNull - : NULL; - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE , true, - "FIXME: Only type of PS_TYPE_S32 (PS_META_S32), " - "PS_TYPE_F32 (PS_META_F32), PS_TYPE_F64 (PS_META_F64), " - "PS_TYPE_BOOL (PS_META_BOOL), " - "and PS_META_STR are supported."); - - psFree(cursor); - - return false; - } - - // increment field index - i++; - } - - psFree(cursor); - - return true; -} - - -// SQL generation functions -/*****************************************************************************/ - -static char *psDBGenerateCreateTableSQL(const char *tableName, const psMetadata *table) -{ - char *query = NULL; // complete query - psMetadataItem *item; // column description - psListIterator *cursor; // column iterator - char *colType; // type lookup table - - // Verify input parameters are not null - if ( (tableName==NULL) || (table==NULL) ) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, PS_ERRORTEXT_psDB_TABLE_PARAM_NULL); - return NULL; - } - - // Begin to create SQL string to create table - psStringAppend(&query, "CREATE TABLE %s (", tableName); - - // Set list iterator at head of list - cursor = psListIteratorAlloc(table->list, 0, false); - - // find column name and type - while ((item = psListGetAndIncrement(cursor))) { - if ((item->type == PS_META_S32) || (item->type == PS_META_F32) || (item->type == PS_META_F64) || - (item->type == PS_TYPE_S32) || (item->type == PS_TYPE_F32) || (item->type == PS_TYPE_F64) || - (item->type == PS_TYPE_BOOL) || (item->type == PS_META_BOOL)) { - // + column name + _ + column type - colType = psDBPTypeToSQL(item->type); - psStringAppend(&query, "%s %s", item->name, colType); - psFree(colType); - } else if (item->type == PS_META_STR) { - // + column name + _ + varchar( + length + ) - psStringAppend(&query, "%s VARCHAR(%s)", item->name, item->data.V); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - "FIXME: Only type of PS_META_S32, PS_META_F32, PS_META_F64, PS_META_BOOL, " - "and PS_META_STR are supported, (not %d).", item->type); - - psFree(query); - psFree(cursor); - - return NULL; - } - if (strstr(item->comment, "AUTO_INCREMENT")) { - psStringAppend(&query, "%s", " AUTO_INCREMENT"); - } - - // add a , after every column declaration except the last one - if (!cursor->offEnd) { - psStringAppend(&query, ", "); - } - } - - // Reset iterator to head of list - psListIteratorSet(cursor, 0); - - // find database indexes - while ((item = psListGetAndIncrement(cursor))) { - // XXX NOTE: check for "Primary Key" first before "Key". Yes we're - // playing fast and loose here, but I think it's fine... - if (strstr(item->comment, "Primary Key")) { - psStringAppend(&query, ", PRIMARY KEY(%s)", item->name); - } else if (strstr(item->comment, "Key")) { - psStringAppend(&query, ", KEY(%s)", item->name); - } else if (strstr(item->comment, "AUTO_INCREMENT")) { - // this needs to be recognized as a key if it wasn't already - psStringAppend(&query, ", KEY(%s)", item->name); - } - } - - psFree(cursor); - - // end column types + table type - psStringAppend(&query, ") ENGINE=innodb"); - - return query; -} - -static char *psDBGenerateSelectRowSQL(const char *tableName, const char *col, const psMetadata *where, psU64 limit) -{ - char *query = NULL; - char *whereSQL; - char *limitString; - - // select all columns if col is NULL - if (col) { - psStringAppend(&query, "SELECT %s FROM %s", col, tableName); - } else { - psStringAppend(&query, "SELECT * FROM %s", tableName); - } - - // select all rows if where is NULL - if (where) { - whereSQL = psDBGenerateWhereSQL(where); - if (!whereSQL) { - psError(PS_ERR_UNEXPECTED_NULL, false, "SQL substring generation failed."); - - psFree(query); - - return NULL; - } - psStringAppend(&query, " %s", whereSQL); - psFree(whereSQL); - } - - // treat limit == 0 as "no limit" - if (limit) { - limitString = psDBIntToString(limit); - psStringAppend(&query, " LIMIT %s", limitString); - psFree(limitString); - } - - return query; -} - -static char *psDBGenerateInsertRowSQL(const char *tableName, const psMetadata *row) -{ - char *query = NULL; - psListIterator *cursor; - psMetadataItem *item; - - // Check if table is NULL - if(tableName == NULL) { - psError(PS_ERR_UNEXPECTED_NULL,true,PS_ERRORTEXT_psDB_QUERY_GEN_FAIL); - return NULL; - } - - // Check if row is NULL - if(row == NULL) { - psError(PS_ERR_UNEXPECTED_NULL,true,PS_ERRORTEXT_psDB_QUERY_GEN_FAIL); - return NULL; - } - - // Start building query string - psStringAppend(&query, "INSERT INTO %s (", tableName); - - cursor = psListIteratorAlloc(row->list, 0, false); - - // get field names - while ((item = psListGetAndIncrement(cursor))) { - psStringAppend(&query, item->name); - - // + , + _ between every field name - if (!cursor->offEnd) { - psStringAppend(&query, ", "); - } - } - - // end of field names - psStringAppend(&query, ") VALUES ("); - - psListIteratorSet(cursor, 0); - - // create value place holders - while ((item = psListGetAndIncrement(cursor))) { - psStringAppend(&query, "?"); - - // + ", " between every place holder - if (!cursor->offEnd) { - psStringAppend(&query, ", "); - } - } - - psFree(cursor); - - // end of values - psStringAppend(&query, ")"); - - return query; -} - -static char *psDBGenerateUpdateRowSQL(const char *tableName, const psMetadata *where, const psMetadata *values) -{ - char *query = NULL; - char *setSQL; - char *whereSQL; - - // Verify where and values pointer are not NULL - if ((!values) || (!where)) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, PS_ERRORTEXT_psDB_UPDATE_ROW_FAIL); - return NULL; - } - - // Create set SQL substring - setSQL = psDBGenerateSetSQL(values); - if (!setSQL) { - psError(PS_ERR_UNEXPECTED_NULL, false, PS_ERRORTEXT_psDB_SQL_SUBSTR_FAIL); - return NULL; - } - - // Create where SQL substring - whereSQL = psDBGenerateWhereSQL(where); - if (!whereSQL) { - psError(PS_ERR_UNEXPECTED_NULL, false, PS_ERRORTEXT_psDB_SQL_SUBSTR_FAIL); - return NULL; - } - - // Append substring to SQL update string - psStringAppend(&query, "UPDATE %s %s %s", tableName, setSQL, whereSQL); - psFree(setSQL); - psFree(whereSQL); - - return query; -} - -static char *psDBGenerateDeleteRowSQL(const char *tableName, const psMetadata *where, unsigned long long limit) -{ - char *query = NULL; - char *whereSQL; - char *limitString; - - // delete all rows if where is NULL - if (!where) { - psStringAppend(&query, "TRUNCATE TABLE %s", tableName); - return query; - } - - // Generate where SQL substring - whereSQL = psDBGenerateWhereSQL(where); - if (!whereSQL) { - psError(PS_ERR_UNEXPECTED_NULL, false, PS_ERRORTEXT_psDB_SQL_SUBSTR_FAIL); - return NULL; - } - - psStringAppend(&query, "DELETE FROM %s %s", tableName, whereSQL); - - // Complete delete SQL command string - // treat limit == 0 as "no limit" - if (limit) { - limitString = psDBIntToString(limit); - psStringAppend(&query, " LIMIT %s", limitString); - psFree(limitString); - } - psFree(whereSQL); - - return query; -} - -static char *psDBGenerateWhereSQL(const psMetadata *where) -{ - char *query = NULL; - psListIterator *cursor; - psMetadataItem *item; - - if (!where) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, "where param may not be NULL."); - return NULL; - } - - query = psStringCopy("WHERE "); - - cursor = psListIteratorAlloc(where->list, 0, false); - - // find column name and match pattern - while ((item = psListGetAndIncrement(cursor))) { - // item->data must be a string - if ((item->type == PS_META_S32) || (item->type == PS_TYPE_S32)) { - psStringAppend(&query, "%s=%d", item->name, (int)(item->data.S32)); - } else if ((item->type == PS_META_F32) || (item->type == PS_TYPE_F32)) { - psStringAppend(&query, "%s=%g", item->name, (double)(item->data.F32)); - } else if ((item->type == PS_META_F64) || (item->type == PS_TYPE_F64)) { - psStringAppend(&query, "%s=%g", item->name, (double)(item->data.F64)); - } else if ((item->type == PS_META_BOOL) || (item->type == PS_TYPE_BOOL)) { - psStringAppend(&query, "%s=%d", item->name, (int)(item->data.B)); - } else if (item->type == PS_META_STR) { - // + column name + _ + like + _ + ' + value + ' - if (*(char *)item->data.V == '\0') { - psStringAppend(&query, "%s IS NULL", item->name); - } else { - // XXX ASC NOTE: we should have a better match for - // char & varchar columns than this. LIKE is OK for - // very large TEXT columns that really shouldn't be - // used in a where clause... - psStringAppend(&query, "%s LIKE '%s'", item->name, item->data.V); - } - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - "Only types PS_META_S32, PS_META_F32, PS_META_F64, PS_META_BOOL, PS_META_STR are supported"); - - psFree(cursor); - psFree(query); - - return NULL; - } - - // + " and " after every column declaration except the last one - if (!cursor->offEnd) { - psStringAppend(&query, " AND "); - } - } - - psFree(cursor); - - return query; -} - -static char *psDBGenerateSetSQL(const psMetadata *set - ) -{ - char *query = NULL; - psListIterator *cursor; - psMetadataItem *item; - - if (!set - ) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, "set param may not be NULL."); - - return NULL; - } - - query = psStringCopy("SET "); - - cursor = psListIteratorAlloc(set - ->list, 0, false); - - // find column name - while ((item = psListGetAndIncrement(cursor))) { - // + column name + _ + = + _ + ? - psStringAppend(&query, "%s = ?", item->name); - - // + ", " after every column declaration except the last one - if (!cursor->offEnd) { - psStringAppend(&query, ", "); - } - } - - psFree(cursor); - - return query; -} - - -// lookup table functions -/*****************************************************************************/ - -static psElemType psDBMySQLToPType(enum enum_field_types type, unsigned int flags) -{ - psHash *mysqlToSQLTable; // type lookup table - psHash *sqlToPSTable; // type lookup table - char *key; // hash tmp value - char *value; // hash tmp value - char *sqlType; // copy of lookup table result - psU32 pType; // psElemType of a field - - mysqlToSQLTable = psDBGetMySQLToSQLTable(); - - // lookup MySQL column type - key = psDBIntToString((psU64)type); - sqlType = psHashLookup(mysqlToSQLTable, key); - psFree(key); - psFree(mysqlToSQLTable); - - if (!sqlType) { - psError(PS_ERR_UNEXPECTED_NULL, true, "type lookup failed."); - return -1; - } - - // MySQL column types can not be directly translated to PS - // types as the the mysql types do not tell you if the value is - // signed or unsigned. The result is this ugly conversion from - // mysql -> ascii -> ptype - if (flags & UNSIGNED_FLAG) { - psStringPrepend(&sqlType, "UNSIGNED "); - } - - //psLogMsg( __func__, PS_LOG_INFO, "sqlType=[%s]\n", sqlType ); - - // convert MySQL type to PS type - sqlToPSTable = psDBGetSQLToPTypeTable(); - value = psHashLookup(sqlToPSTable, sqlType); - psFree(sqlToPSTable); - - if (!value) { - psError(PS_ERR_UNEXPECTED_NULL, true, "type lookup failed."); - - return -1; - } - - pType = (psU32)atol(value); - - return pType; -} - -static char *psDBPTypeToSQL(psElemType pType) -{ - psHash *pTypeToSQLTable; // type lookup table - char *key; // hash tmp value - char *sqlType; // hash tmp value - - pTypeToSQLTable = psDBGetPTypeToSQLTable(); - - key = psDBIntToString((psU64)pType); - sqlType = psHashLookup(pTypeToSQLTable, key); - psFree(key); - psFree(pTypeToSQLTable); - - if (!sqlType) { - psError(PS_ERR_UNEXPECTED_NULL, true, "type lookup failed."); - - return NULL; - } - - psMemIncrRefCounter(sqlType); - - return sqlType; -} - -static mysqlType *psDBPTypeToMySQL(psElemType pType) -{ - psHash *pTypeToMySQLTable; // type lookup table - char *key; // hash tmp value - mysqlType *mType; // mysqlType struct to return - - pTypeToMySQLTable = psDBGetPTypeToMySQLTable(); - - key = psDBIntToString((psU64)pType); - mType = psHashLookup(pTypeToMySQLTable, key); - psFree(key); - psFree(pTypeToMySQLTable); - - if (!mType) { - psError(PS_ERR_UNEXPECTED_NULL, true, "type lookup failed."); - - return NULL; - } - - psMemIncrRefCounter(mType); - - return mType; -} - -static psHash *psDBGetPTypeToSQLTable(void) -{ - static psHash *lookupTable = NULL; - - if (!lookupTable) { - lookupTable = psHashAlloc(14); - - // no support for CHAR, TEXT or GLOB - psDBAddToLookupTable(lookupTable, PS_TYPE_S8, "TINYINT"); - psDBAddToLookupTable(lookupTable, PS_TYPE_S16, "SMALLINT"); - psDBAddToLookupTable(lookupTable, PS_TYPE_S32, "INT"); - psDBAddToLookupTable(lookupTable, PS_TYPE_S64, "BIGINT"); - psDBAddToLookupTable(lookupTable, PS_TYPE_U8, "UNSIGNED TINYINT"); - psDBAddToLookupTable(lookupTable, PS_TYPE_U16, "UNSIGNED SMALLINT"); - psDBAddToLookupTable(lookupTable, PS_TYPE_U32, "UNSIGNED INT"); - psDBAddToLookupTable(lookupTable, PS_TYPE_U64, "UNSIGNED BIGINT"); - psDBAddToLookupTable(lookupTable, PS_TYPE_F32, "FLOAT"); - psDBAddToLookupTable(lookupTable, PS_TYPE_F64, "DOUBLE"); - psDBAddToLookupTable(lookupTable, PS_TYPE_C32, "PS_TYPE_C32 is not supported"); - psDBAddToLookupTable(lookupTable, PS_TYPE_C64, "PS_TYPE_C64 is not supported"); - psDBAddToLookupTable(lookupTable, PS_TYPE_BOOL,"TINYINT"); - psDBAddToLookupTable(lookupTable, PS_META_STR, "VARCHAR"); - } - - // simulate true ref counting - psMemIncrRefCounter(lookupTable); - - return lookupTable; -} - -static void psDBPTypeToSQLTableCleanup(void) -{ - psHash *lookupTable; - - lookupTable = psDBGetPTypeToSQLTable(); - - psMemDecrRefCounter(lookupTable); - psFree(lookupTable); -} - -static psHash *psDBGetSQLToPTypeTable(void) -{ - static psHash *lookupTable = NULL; - psHash *psToSQLTable; - psList *list; - psListIterator *cursor; - char *key; - char *value; - - if (!lookupTable) { - // invert the PSToSQL table - psToSQLTable = psDBGetPTypeToSQLTable(); - lookupTable = psHashAlloc(psToSQLTable->n); - - list = psHashKeyList(psToSQLTable); - cursor = psListIteratorAlloc(list, 0, false); - - while ((key = psListGetAndIncrement(cursor))) { - value = psHashLookup(psToSQLTable, key); - // switch key and value - psHashAdd(lookupTable, value, key); - } - - // Add BLOB & TEXT reverse mappings - value = psDBIntToString((psU64)PS_META_STR); - psHashAdd(lookupTable, "BLOB", value); - psHashAdd(lookupTable, "TEXT", value); - psFree(value); - - // DECIMAL does not exist in the pType to SQL table - value = psDBIntToString(0); - psHashAdd(lookupTable, "DECIMAL", value); - psFree(value); - - psFree(cursor); - psFree(list); - psFree(psToSQLTable); - } - - // simulate true ref counting - psMemIncrRefCounter(lookupTable); - - return lookupTable; -} - -static void psDBSQLToPTypeTableCleanup(void) -{ - psHash *lookupTable; - - lookupTable = psDBGetSQLToPTypeTable(); - - psMemDecrRefCounter(lookupTable); - psFree(lookupTable); -} - -static psHash *psDBGetMySQLToSQLTable(void) -{ - static psHash *lookupTable = NULL; - - if (!lookupTable) { - lookupTable = psHashAlloc(20); - - psDBAddToLookupTable(lookupTable, FIELD_TYPE_TINY, "TINYINT"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_SHORT, "SMALLINT"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_LONG, "INT"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_INT24, "MEDIUMINT"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_LONGLONG, "BIGINT"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_DECIMAL, "DECIMAL"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_FLOAT, "FLOAT"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_DOUBLE, "DOUBLE"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_TIMESTAMP, "TIMESTAMP"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_DATE, "DATE"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_TIME, "TIME"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_DATETIME, "DATETIME"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_YEAR, "YEAR"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_STRING, "CHAR"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_VAR_STRING,"VARCHAR"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_BLOB, "BLOB"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_SET, "SET"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_ENUM, "ENUM"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_NULL, "NULL-type"); - psDBAddToLookupTable(lookupTable, FIELD_TYPE_CHAR, "TINYINT"); - } - - // simulate true ref counting - psMemIncrRefCounter(lookupTable); - - return lookupTable; -} - -static void psDBMySQLToSQLTableCleanup(void) -{ - psHash *lookupTable; - - lookupTable = psDBGetMySQLToSQLTable(); - - psMemDecrRefCounter(lookupTable); - psFree(lookupTable); -} - -static psHash *psDBGetPTypeToMySQLTable(void) -{ - static psHash *lookupTable = NULL; - - if (!lookupTable) { - lookupTable = psHashAlloc(14); - - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_S8, psDBMySQLTypeAlloc(MYSQL_TYPE_TINY, false)); - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_S16, psDBMySQLTypeAlloc(MYSQL_TYPE_SHORT, false)); - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_S32, psDBMySQLTypeAlloc(MYSQL_TYPE_LONG, false)); - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_S64, psDBMySQLTypeAlloc(MYSQL_TYPE_LONGLONG, false)); - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_U8, psDBMySQLTypeAlloc(MYSQL_TYPE_TINY, true)); - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_U16, psDBMySQLTypeAlloc(MYSQL_TYPE_SHORT, true)); - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_U32, psDBMySQLTypeAlloc(MYSQL_TYPE_LONG, true)); - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_U64, psDBMySQLTypeAlloc(MYSQL_TYPE_LONGLONG, true)); - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_F32, psDBMySQLTypeAlloc(MYSQL_TYPE_FLOAT, false)); - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_F64, psDBMySQLTypeAlloc(MYSQL_TYPE_DOUBLE, false)); - // bogus type - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_C32, psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - // bogus type - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_C64, psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - psDBAddVoidToLookupTable(lookupTable, PS_TYPE_BOOL, psDBMySQLTypeAlloc(MYSQL_TYPE_TINY, true)); - // XXX: removed PS_TYPE_PTR, can this be removed too? - // psDBAddVoidToLookupTable(lookupTable, PS_TYPE_PTR, psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - - psDBAddVoidToLookupTable(lookupTable, PS_META_STR, psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - psDBAddVoidToLookupTable(lookupTable, PS_META_VEC, psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - psDBAddVoidToLookupTable(lookupTable, PS_META_IMG, psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - psDBAddVoidToLookupTable(lookupTable, PS_META_HASH, psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - psDBAddVoidToLookupTable(lookupTable, PS_META_LOOKUPTABLE, - psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - psDBAddVoidToLookupTable(lookupTable, PS_META_JPEG, psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - psDBAddVoidToLookupTable(lookupTable, PS_META_PNG, psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - psDBAddVoidToLookupTable(lookupTable, PS_META_ASTROM, psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - psDBAddVoidToLookupTable(lookupTable, PS_META_UNKNOWN,psDBMySQLTypeAlloc(MYSQL_TYPE_VAR_STRING, false)); - } - - // simulate true ref counting - psMemIncrRefCounter(lookupTable); - - return lookupTable; -} - -static void psDBPTypeToMySQLTableCleanup(void) -{ - psHash *lookupTable; - - lookupTable = psDBGetPTypeToMySQLTable(); - - psMemDecrRefCounter(lookupTable); - psFree(lookupTable); -} - -static psPtr psDBMySQLTypeAlloc(enum enum_field_types type, bool isUnsigned) -{ - mysqlType *mType; - - mType = psAlloc(sizeof(mysqlType)); - mType->type = type; - mType->isUnsigned = isUnsigned; - - return mType; -} - -static void psDBAddToLookupTable(psHash *lookupTable, psU32 type, const char *string) -{ - char *key; - char *value; - - key = psDBIntToString((psU64)type); - value = psStringCopy(string); - - psHashAdd(lookupTable, key, value); - - psFree(key); - psFree(value); -} - -static void psDBAddVoidToLookupTable(psHash *lookupTable, psU32 type, psPtr value) -{ - char *key; - - key = psDBIntToString((psU64)type); - - psHashAdd(lookupTable, key, value); - - // destructive of value parameter - psFree(value); - psFree(key); -} - - -// pType utility functions -/*****************************************************************************/ - -#define PS_NAN_ALLOC(dest, type, nan) \ -dest = psAlloc(sizeof(type)); \ -*(type *)dest = nan; - -static psPtr psDBGetPTypeNaN(psElemType pType) -{ - psPtr myNaN; - - switch (pType) { - case PS_TYPE_S8: - PS_NAN_ALLOC(myNaN, psS8, PS_MAX_S8); - break; - case PS_TYPE_S16: - PS_NAN_ALLOC(myNaN, psS16, PS_MAX_S16); - break; - case PS_TYPE_S32: - PS_NAN_ALLOC(myNaN, psS32, PS_MAX_S32); - break; - case PS_TYPE_S64: - PS_NAN_ALLOC(myNaN, psS64, PS_MAX_S64); - break; - case PS_TYPE_U8: - PS_NAN_ALLOC(myNaN, psU8, PS_MAX_U8); - break; - case PS_TYPE_U16: - PS_NAN_ALLOC(myNaN, psU16, PS_MAX_U16); - break; - case PS_TYPE_U32: - PS_NAN_ALLOC(myNaN, psU32, PS_MAX_U32); - break; - case PS_TYPE_U64: - PS_NAN_ALLOC(myNaN, psU64, PS_MAX_U64); - break; - case PS_TYPE_F32: - PS_NAN_ALLOC(myNaN, psF32, NAN); - break; - case PS_TYPE_F64: - PS_NAN_ALLOC(myNaN, psF64, NAN); - break; - case PS_TYPE_C32: - // this is a bogus SQL type - PS_NAN_ALLOC(myNaN, psC32, NAN); - break; - case PS_TYPE_C64: - // this is a bogus SQL type - PS_NAN_ALLOC(myNaN, psC64, NAN); - break; - case PS_TYPE_BOOL: - // XXX: what is NaN for a bool? - PS_NAN_ALLOC(myNaN, psU8, PS_MAX_U8); - break; - } - - return myNaN; -} - -#define PS_IS_NAN(type, data, nan) *(type *)data == nan - -static bool psDBIsPTypeNaN(psElemType pType, psPtr data) -{ - bool isNaN; - - switch (pType) { - case PS_TYPE_S8: - isNaN = PS_IS_NAN(psS8, data, PS_MAX_S8); - break; - case PS_TYPE_S16: - isNaN = PS_IS_NAN(psS16, data, PS_MAX_S16); - break; - case PS_TYPE_S32: - isNaN = PS_IS_NAN(psS32, data, PS_MAX_S32); - break; - case PS_TYPE_S64: - isNaN = PS_IS_NAN(psS64, data, PS_MAX_S64); - break; - case PS_TYPE_U8: - isNaN = PS_IS_NAN(psU8, data, PS_MAX_U8); - break; - case PS_TYPE_U16: - isNaN = PS_IS_NAN(psU16, data, PS_MAX_U16); - break; - case PS_TYPE_U32: - isNaN = PS_IS_NAN(psU32, data, PS_MAX_U32); - break; - case PS_TYPE_U64: - isNaN = PS_IS_NAN(psU64, data, PS_MAX_U64); - break; - case PS_TYPE_F32: - isNaN = PS_IS_NAN(psF32, data, NAN); - break; - case PS_TYPE_F64: - isNaN = PS_IS_NAN(psF64, data, NAN); - break; - case PS_TYPE_C32: - // this is a bogus SQL type - isNaN = PS_IS_NAN(psC32, data, NAN); - break; - case PS_TYPE_C64: - // this is a bogus SQL type - isNaN = PS_IS_NAN(psC64, data, NAN); - break; - case PS_TYPE_BOOL: - // XXX: what is NaN for a bool? - isNaN = PS_IS_NAN(psU8, data, PS_MAX_U8); - break; - } - - return isNaN; -} - - -// string utility functions -/*****************************************************************************/ - -static char *psDBIntToString(psU64 n) -{ - char *string; - size_t length; - - // length of string + \0 - // if n is 0, length is 1 char + \0 - length = n ? (size_t)log10((double)n) + 1 - : 2; - string = psAlloc(length); - sprintf(string, "%li", (long int)n); - - return string; -} - -#endif // OMIT_PSDB Index: unk/psLib/src/dataIO/psDB.h =================================================================== --- /trunk/psLib/src/dataIO/psDB.h (revision 4545) +++ (revision ) @@ -1,281 +1,0 @@ -/** @file psDB.h - * - * @brief database types and functions - * - * This file defines the abstract database type and functions that - * perform basic database operations. - * - * @ingroup DataBase - * - * @author Joshua Hoblitt - * - * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-09 01:24:30 $ - * - * Copyright 2005 Joshua Hoblitt, University of Hawaii - */ - -#ifndef PS_DB_H -#define PS_DB_H 1 - -#ifndef OMIT_PSDB - -#include "psType.h" -#include "psMetadata.h" - -/// @addtogroup DataBase -/// @{ - -/** Database handle - * - * An opaque object representing a database connection. - * - */ -typedef struct -{ - void* mysql; ///< MySQL database handle -} -psDB; - -/** Opens a new database connection - * - * @return A new psDB object if the database connection is successful or NULL on - * failure. - */ -psDB *psDBInit( - const char *host, ///< Database server hostname - const char *user, ///< Database username - const char *passwd, ///< Database password - const char *dbname ///< Database namespace -); - -/** Closes a database connection - */ -void psDBCleanup( - psDB *dbh ///< Database handle -); - -/** Creates a new database namespace - * - * @return true on success - */ -bool psDBCreate( - psDB *dbh, ///< Database handle - const char *dbname ///< New database namespace -); - -/** Changes the current database namespace - * - * @return true on success - */ -bool psDBChange( - psDB *dbh, ///< Database handle - const char *dbname ///< Database namespace -); - -/** Drops a database namespace - * - * @return true on success - */ -bool psDBDrop( - psDB *dbh, ///< Database handle - const char *dbname ///< Database namespace -); - -/** Executes a SQL query - * - * This function will execute a string as a raw SQL query. No additional - * processing of the string or abstraction of the underlying database's SQL - * dialect is provided. Caveat emptor. - * - * @return true on success - */ -bool p_psDBRunQuery( - psDB *dbh, ///< Database handle - const char *format ///< SQL string to execute -); - -/** Creates a new database table - * - * This function generates and executes the SQL needed to create a table named - * "tableName", with the column names and data types as described in "md". Each - * data item in the psMetadata collection represents a single table field. The - * name of the field is given by the name of the psMetadataItem and the data - * type is give by the psMetadataItem.type and psMetadataItem.ptype entries. A - * lookup table should be used to convert from PSLib types into MySQL - * compatible SQL data types. For example, a PS_META_STR would map to an SQL99 - * varchar. If the value of type is PS_META_STR then the psMetadataItem.data - * element is set to a string with the length for the field written as a text - * string. The value of the psMetadataItem.data element is unused for the - * PS_META_PRIMITIVE types. Other psMetadata types beyond PS_META_STR and - * PS_META_PRIMITIVE are not allowed in a table definition. - * - * Database indexes can be specified setting the "comment" field to "Primary - * Key" or "Key". Comments are otherwise ignored. - * - * @return true on success - */ -bool psDBCreateTable( - psDB *dbh, ///< Database handle - const char *tableName, ///< Table name - const psMetadata *md ///< Column names, types, and indexes -); - -/** Deletes a database table - * - * @return true on success -*/ -bool psDBDropTable( - psDB *dbh, ///< Database handle - const char *tableName ///< Table name -); - -/** Selects a column from a table - * - * This function generates and executes the SQL needed to select an entire - * column from a table or up to "limit" rows from it. If "limit" is 0, the - * entire range is returned. - * - * @return A psArray of strings or NULL on failure - */ -psArray *psDBSelectColumn( - psDB *dbh, ///< Database handle - const char *tableName, ///< Table name - const char *col, ///< Column name - unsigned long long limit ///< Maximum number of elements to return -); - -/** Selects a column from a table and casts it to a given type - * - * This function generates and executes the SQL needed to select an entire - * column from a table or up to "limit" rows from it. If "limit" is 0, the - * entire range is returned. The data in the column is cast to to "pType". - * - * @return A psVector or NULL on failure - */ -psVector *psDBSelectColumnNum( - psDB *dbh, ///< Database handle - const char *tableName, ///< Table name - const char *col, ///< Column name - psElemType type, ///< Resulting psVector type - unsigned long long limit ///< Maximum number of elements to return -); - -/** Selects a set of rows from a table - * - * This function returns rows from the specified table which match the - * restrictions given by "where". The restrictions are specified as field / - * value pairs. The psMetadata collection "where" must consist of valid - * database fields. The selected rows are returned as a psArray of psMetadata - * values, one per row. - * - * Currently, the "where" specification only supports the PS_META_STR type. - * The string value can be a SQL match pattern, e.g. "%foo%", or an empty - * string, e.g. "", to match NULL field values. - * - * @return A psArray of psMetadata or NULL on failure - */ -psArray *psDBSelectRows( - psDB *dbh, ///< Database handle - const char *tableName, ///< Table name - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of elements to return -); - -/** Insert a single row into a table - * - * This function inserts the data from "row" into "tableName". - * - * The "row" specification uses the psMetadataItem name as the column name. - * The field values may be specified in any order. psMetadata types beyond - * PS_META_STR and PS_META_PRIMITIVE are not supported. If fields are - * specified in "row" that do not exist in "tableName", the insert will fail. - * - * @return true on success - */ -bool psDBInsertOneRow( - psDB *dbh, ///< Database handle - const char *tableName, ///< Table name - const psMetadata *row ///< Row description -); - -/** Insert a set of rows into a table - * - * This function inserts the data from "rowSet" into "tableName". - * - * "rowSet" is a psArray of psMetadata containing row specifications identical to - * those used in psDBInsertOneRow(). - * - * @return true on success - */ -bool psDBInsertRows( - psDB *dbh, ///< Database handle - const char *tableName, ///< Table name - const psArray *rowSet ///< Set of rows to insert -); - -/** Retrieves all rows from a table - * - * This function fetches all rows as an psArray of psMetadata. The rows are in - * the same psMetadata format as used in psDBInsertOneRow() & psDBInsertRows(). - * - * @return A psArray of psMetadata or NULL on failure - */ -psArray *psDBDumpRows( - psDB *dbh, ///< Database handle - const char *tableName ///< Table name -); - -/** Retrieves all columns from a table - * - * This function fetches all columns, as either a psVector or a psArray - * depending on whether or not the column is numeric, and return them in a - * psMetadata structure where psMetadataItem.name contains the column's name. - * - * @return A psMetadata containing either a psArrays or psVector per column - */ -psMetadata *psDBDumpCols( - psDB *dbh, ///< Database handle - const char *tableName ///< Table name -); - -/** Updates the field values, as specified, in a table - * - * This function updates the fields contained in "values" in the row(s) that - * have a field with the value indicated by "where". Where "where" is in the - * same format as used in psDBSelectRows(). - * - * The "values" specification uses the same format as the row specification - * used in psDBInsertOneRow(), etc. - * - * @return The number of rows modified or a negative value on error - */ -psS64 psDBUpdateRows( - psDB *dbh, ///< Database handle - const char *tableName, ///< Table name - const psMetadata *where, ///< Row match criteria - const psMetadata *values ///< new field values -); - -/** Deletes rows, as specified, in a table - * - * Delete the rows that are matched by "where" using the same semantics for - * "where" as in psDBUpdateRow(). - * - * If "where" is NULL, all rows in the table will be removed and regardless of - * the number of rows that were dropped, only 1 will be returned on success. - * - * @return The number of rows removed or a negative value on error - */ -psS64 psDBDeleteRows( - psDB *dbh, ///< Database handle - const char *tableName, ///< Table name - const psMetadata *where, ///< Row match criteria - unsigned long long limit ///< Maximum number of rows to delete -); - -/// @} - -#endif // OMIT_PSDB - -#endif // PS_DB_H Index: unk/psLib/src/dataIO/psFileUtilsErrors.dat =================================================================== --- /trunk/psLib/src/dataIO/psFileUtilsErrors.dat (revision 4545) +++ (revision ) @@ -1,76 +1,0 @@ -# -# This file is used to generate psFileUtilsErrors.h content -# -# Format is: -# ERRORNAME(one word) ERROR_TEXT -# -# N.B. in code, the ERRORNAME appears as PS_ERRORTEXT_ERRORNAME -#################################################################### -psLookupTable_FILE_NOT_FOUND Failed to open file %s. -psLookupTable_PARSE_VALUE Unable to parse string, %s on line %lld. -psLookupTable_PARSE_TYPE Unable to parse type, %s on line %lld. -psLookupTable_PARSE_GENERAL Unable to read lookup table item, %s on line %lld -psLookupTable_INTERPOLATE_HIGH High index too big, %d. -psLookupTable_INTERPOLATE_LOW Low index too small, %d. -psLookupTable_DIVIDE_BY_ZERO Divide by zero error during interpolation. -psLookupTable_INVALID_TYPE Invalid psLookupType, %d; -psLookupTable_TABLE_INVALID Lookup table is invalid. -# -psFits_NULL The input psFits object can not NULL. -psFits_FILENAME_INVALID Could not open file,'%s'.\nCFITSIO Error: %s -psFits_FILENAME_NULL Specified filename can not be NULL. -psFits_EXTNAME_NULL Specified extension name can not be NULL. -psFits_EXTNAME_INVALID Could not find HDU '%s' in file %s.\nCFITSIO Error: %s -psFits_EXTNUM_ABS_MOVE_FAILED Could not move to specified HDU #%d in file %s.\nCFITSIO Error: %s -psFits_EXTNUM_REL_MOVE_FAILED Could not move %d HDUs from current position in file %s.\nCFITSIO Error: %s -psFits_GET_EXTNUM_FAILED Failed to determine the current HDU number in file %s.\nCFITSIO Error: %s -psFits_GETNUMHDUS_FAILED Failed to determine the number of HDUs in file %s.\nCFITSIO Error: %s -psFits_GETHDUTYPE_FAILED Failed to determine an HDU type in file %s.\nCFITSIO Error: %s -psFits_GETNUMKEYS_FAILED Failed to determine the number of header keys in file %s.\nCFITSIO Error: %s -psFits_GET_TABLE_SIZE_FAILED Failed to determine the size of the current HDU table.\nCFITSIO Error: %s -psFits_FILENAME_CREATE_FAILED Could not create file,'%s'.\nCFITSIO Error: %s -psFits_TYPE_UNSUPPORTED Specified type, %s, is not supported. -psFits_CREATE_HDU_FAILED Could not create new image HDU in file,'%s'.\nCFITSIO Error: %s -psFits_GET_HDU_TYPE_FAILED Could not determine the HDU type.\nCFITSIO Error: %s -psFits_NOT_IMAGE_TYPE Current FITS HDU type must be an image. -psFits_NOT_TABLE_TYPE Current FITS HDU type must be a table. -psFits_TABLE_EMPTY Can't create a table without any rows. -psFits_CFITSIO_ERROR CFITSIO error: %s -psFits_METATYPE_INVALID Specified FITS metadata type, %c, is not supported. -psFits_METADATA_ADD_FAILED Failed to add metadata item, %s. -psFits_WRITE_FAILED Could not write data to file,'%s'.\nCFITSIO Error: %s -psFits_IMAGE_NULL The input psImage was NULL. Need a non-NULL psImage for operation to be performed. -psFits_METADATA_NULL The input psMetadata was NULL. Need a non-NULL psMetadata for operation to be performed. -psFits_METADATA_PTYPE_UNSUPPORTED A metadata item's primative type, %d, is not supported. -psFits_ROW_INVALID Specified row, %d, is not valid for current table of %d rows. -psFits_GET_TABLE_ELEMENT Failed to retrieve table element (%d,%d).\nCFITSIO Error: %s -psFits_FIND_COLUMN Specified column, %s, was not found.\nCFITSIO Error: %s -psFits_GET_COLTYPE Could not determine the datatype of the table column.\nCFITSIO Error: %s -psFits_TABLE_READ_COL Failed to read table column.\nCFITSIO Error: %s -psFits_DATATYPE_UNKNOWN Could not determine image data type.\nCFITSIO Error: %s -psFits_IMAGE_DIM_UNKNOWN Could not determine image dimensions.\nCFITSIO Error: %s -psFits_IMAGE_DIMENSION_UNSUPPORTED Image number of dimensions, %d, is not valid. Only two or three dimensions supported for FITS I/O. -psFits_IMAGE_SIZE_UNKNOWN Could not determine image size.\nCFITSIO Error: %s -psFits_FITS_TYPE_UNSUPPORTED FITS image type, BITPIX=%d, is not supported. -psFits_READ_FAILED Reading FITS file failed.\nCFITSIO Error: %s -psFits_IMAGE_UPDATE_TYPE_MISMATCH Can not update a %s image given a %s image. -psFits_FITS_Z_SMALL Current FITS HDU has %d z-planes, but z-plane %d was specified. -# -psDB_INVALID_PSDB Invalid psDB has been specified. -psDB_NULL_TABLE NULL table specified. -psDB_FAILED_TO_CONNECT Failed to connect to database. Error: %s -psDB_FAILED_TO_CHANGE Failed to change database. Error: %s -psDB_TABLE_PARAM_NULL Create table parameters may not be NULL. -psDB_QUERY_GEN_FAIL Query generation failed. -psDB_TABLE_CREATE_FAIL Failed to create table. -psDB_SQL_PREPARE_FAIL Failed to prepare query. Error: %s -psDB_SQL_QUERY_FAIL Failed to execute SQL query. Error: %s -psDB_TABLE_DROP_FAIL Failed to drop table. -psDB_SEL_COL_FAIL Failed to select column. -psDB_QUERY_NO_DATA Query returned no data. Error: %s -psDB_INSERT_ROW_FAIL Failed to insert row. -psDB_UPDATE_ROW_FAIL Update row SQL generate fail: values and where params may not be NULL. -psDB_SQL_SUBSTR_FAIL SQL substring generation failed. -psDB_WHERE_SUBSTR_FAIL WHERE parameter my not be NULL. -# - Index: unk/psLib/src/dataIO/psFileUtilsErrors.h =================================================================== --- /trunk/psLib/src/dataIO/psFileUtilsErrors.h (revision 4545) +++ (revision ) @@ -1,96 +1,0 @@ -/** @file psFileUtilsErrors.h - * - * @brief Contains the error text for the dataIO functions - * - * @ingroup ErrorHandling - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.23 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-25 01:16:50 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_FILEUTIL_ERRORS_H -#define PS_FILEUTIL_ERRORS_H - -/* N.B., lines between '//~Start' and '//~End' are automatic generated from - * the template following the '//~Start'. The template is used to generate - * the other lines by, for each error text in psAstronomyErrors.dat, the following - * substitutions are made: - * $1 The error text macro name (first word in the psAstronomyErrors.dat lines) - * $2 The error text (rest of the line in psAstronomyErrors.dat) - * $n The order of the source line in psAstronomyErrors.dat (comments excluded) - * - * DO NOT EDIT THE LINES BETWEEN //~Start and //~End! ANY CHANGES WILL BE OVERWRITTEN. - */ - -//~Start #define PS_ERRORTEXT_$1 "$2" -#define PS_ERRORTEXT_psLookupTable_FILE_NOT_FOUND "Failed to open file %s." -#define PS_ERRORTEXT_psLookupTable_PARSE_VALUE "Unable to parse string, %s on line %lld." -#define PS_ERRORTEXT_psLookupTable_PARSE_TYPE "Unable to parse type, %s on line %lld." -#define PS_ERRORTEXT_psLookupTable_PARSE_GENERAL "Unable to read lookup table item, %s on line %lld" -#define PS_ERRORTEXT_psLookupTable_INTERPOLATE_HIGH "High index too big, %d." -#define PS_ERRORTEXT_psLookupTable_INTERPOLATE_LOW "Low index too small, %d." -#define PS_ERRORTEXT_psLookupTable_DIVIDE_BY_ZERO "Divide by zero error during interpolation." -#define PS_ERRORTEXT_psLookupTable_INVALID_TYPE "Invalid psLookupType, %d;" -#define PS_ERRORTEXT_psLookupTable_TABLE_INVALID "Lookup table is invalid." -#define PS_ERRORTEXT_psFits_NULL "The input psFits object can not NULL." -#define PS_ERRORTEXT_psFits_FILENAME_INVALID "Could not open file,'%s'.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_FILENAME_NULL "Specified filename can not be NULL." -#define PS_ERRORTEXT_psFits_EXTNAME_NULL "Specified extension name can not be NULL." -#define PS_ERRORTEXT_psFits_EXTNAME_INVALID "Could not find HDU '%s' in file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_EXTNUM_ABS_MOVE_FAILED "Could not move to specified HDU #%d in file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_EXTNUM_REL_MOVE_FAILED "Could not move %d HDUs from current position in file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_GET_EXTNUM_FAILED "Failed to determine the current HDU number in file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_GETNUMHDUS_FAILED "Failed to determine the number of HDUs in file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_GETHDUTYPE_FAILED "Failed to determine an HDU type in file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_GETNUMKEYS_FAILED "Failed to determine the number of header keys in file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_GET_TABLE_SIZE_FAILED "Failed to determine the size of the current HDU table.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_FILENAME_CREATE_FAILED "Could not create file,'%s'.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_TYPE_UNSUPPORTED "Specified type, %s, is not supported." -#define PS_ERRORTEXT_psFits_CREATE_HDU_FAILED "Could not create new image HDU in file,'%s'.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_GET_HDU_TYPE_FAILED "Could not determine the HDU type.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_NOT_IMAGE_TYPE "Current FITS HDU type must be an image." -#define PS_ERRORTEXT_psFits_NOT_TABLE_TYPE "Current FITS HDU type must be a table." -#define PS_ERRORTEXT_psFits_TABLE_EMPTY "Can't create a table without any rows." -#define PS_ERRORTEXT_psFits_CFITSIO_ERROR "CFITSIO error: %s" -#define PS_ERRORTEXT_psFits_METATYPE_INVALID "Specified FITS metadata type, %c, is not supported." -#define PS_ERRORTEXT_psFits_METADATA_ADD_FAILED "Failed to add metadata item, %s." -#define PS_ERRORTEXT_psFits_WRITE_FAILED "Could not write data to file,'%s'.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_IMAGE_NULL "The input psImage was NULL. Need a non-NULL psImage for operation to be performed." -#define PS_ERRORTEXT_psFits_METADATA_NULL "The input psMetadata was NULL. Need a non-NULL psMetadata for operation to be performed." -#define PS_ERRORTEXT_psFits_METADATA_PTYPE_UNSUPPORTED "A metadata item's primative type, %d, is not supported." -#define PS_ERRORTEXT_psFits_ROW_INVALID "Specified row, %d, is not valid for current table of %d rows." -#define PS_ERRORTEXT_psFits_GET_TABLE_ELEMENT "Failed to retrieve table element (%d,%d).\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_FIND_COLUMN "Specified column, %s, was not found.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_GET_COLTYPE "Could not determine the datatype of the table column.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_TABLE_READ_COL "Failed to read table column.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_DATATYPE_UNKNOWN "Could not determine image data type.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_IMAGE_DIM_UNKNOWN "Could not determine image dimensions.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_IMAGE_DIMENSION_UNSUPPORTED "Image number of dimensions, %d, is not valid. Only two or three dimensions supported for FITS I/O." -#define PS_ERRORTEXT_psFits_IMAGE_SIZE_UNKNOWN "Could not determine image size.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_FITS_TYPE_UNSUPPORTED "FITS image type, BITPIX=%d, is not supported." -#define PS_ERRORTEXT_psFits_READ_FAILED "Reading FITS file failed.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psFits_IMAGE_UPDATE_TYPE_MISMATCH "Can not update a %s image given a %s image." -#define PS_ERRORTEXT_psFits_FITS_Z_SMALL "Current FITS HDU has %d z-planes, but z-plane %d was specified." -#define PS_ERRORTEXT_psDB_INVALID_PSDB "Invalid psDB has been specified." -#define PS_ERRORTEXT_psDB_NULL_TABLE "NULL table specified." -#define PS_ERRORTEXT_psDB_FAILED_TO_CONNECT "Failed to connect to database. Error: %s" -#define PS_ERRORTEXT_psDB_FAILED_TO_CHANGE "Failed to change database. Error: %s" -#define PS_ERRORTEXT_psDB_TABLE_PARAM_NULL "Create table parameters may not be NULL." -#define PS_ERRORTEXT_psDB_QUERY_GEN_FAIL "Query generation failed." -#define PS_ERRORTEXT_psDB_TABLE_CREATE_FAIL "Failed to create table." -#define PS_ERRORTEXT_psDB_SQL_PREPARE_FAIL "Failed to prepare query. Error: %s" -#define PS_ERRORTEXT_psDB_SQL_QUERY_FAIL "Failed to execute SQL query. Error: %s" -#define PS_ERRORTEXT_psDB_TABLE_DROP_FAIL "Failed to drop table." -#define PS_ERRORTEXT_psDB_SEL_COL_FAIL "Failed to select column." -#define PS_ERRORTEXT_psDB_QUERY_NO_DATA "Query returned no data. Error: %s" -#define PS_ERRORTEXT_psDB_INSERT_ROW_FAIL "Failed to insert row." -#define PS_ERRORTEXT_psDB_UPDATE_ROW_FAIL "Update row SQL generate fail: values and where params may not be NULL." -#define PS_ERRORTEXT_psDB_SQL_SUBSTR_FAIL "SQL substring generation failed." -#define PS_ERRORTEXT_psDB_WHERE_SUBSTR_FAIL "WHERE parameter my not be NULL." -//~End - -#endif // #ifndef PS_FILEUTIL_ERRORS_H Index: unk/psLib/src/dataIO/psFits.c =================================================================== --- /trunk/psLib/src/dataIO/psFits.c (revision 4545) +++ (revision ) @@ -1,1704 +1,0 @@ -/** @file psFits.c - * - * @brief Contains Fits I/O routines - * - * @ingroup FileIO - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.40 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include - -#include "psFits.h" -#include "string.h" -#include "psError.h" -#include "psFileUtilsErrors.h" -#include "psImageStructManip.h" -#include "psMemory.h" -#include "psString.h" -#include "psLogMsg.h" -#include "psTrace.h" - -#define MAX_STRING_LENGTH 256 // maximum length string for FITS routines - -// list of FITS header keys to ignore. -static char* standardFitsKeys[] = { - NULL - }; - -static psElemType convertFitsToPsType(int datatype) -{ - switch (datatype) { - case TBYTE: - return PS_TYPE_U8; - case TSBYTE: - return PS_TYPE_S8; - case TSHORT: - return PS_TYPE_S16; - case TUSHORT: - return PS_TYPE_U16; - case TLONG: - if (sizeof(long) == 8) { - return PS_TYPE_S64; - } - // no break - case TINT: - return PS_TYPE_S32; - case TULONG: - if (sizeof(unsigned long) == 8) { - return PS_TYPE_U64; - } - // no break - case TUINT: - return PS_TYPE_U32; - case TLONGLONG: - return PS_TYPE_S64; - case TFLOAT: - return PS_TYPE_F32; - case TDOUBLE: - return PS_TYPE_F64; - case TCOMPLEX: - return PS_TYPE_C32; - case TDBLCOMPLEX: - return PS_TYPE_C64; - case TLOGICAL: - return PS_TYPE_BOOL; - default: - psError(PS_ERR_IO, true, - "Unknown FITS datatype, %d.", - datatype); - return 0; - } -} - -static bool convertPsTypeToFits(psElemType type, int* bitPix, double* bZero, int* dataType) -{ - - int bitpix; - int datatype; - double bzero = 0.0; - - switch (type) { - - case PS_TYPE_U8: - bitpix = BYTE_IMG; - datatype = TBYTE; - break; - - case PS_TYPE_BOOL: - case PS_TYPE_S8: - bitpix = BYTE_IMG; - bzero = INT8_MIN; - datatype = TSBYTE; - break; - - case PS_TYPE_U16: - bitpix = SHORT_IMG; - bzero = -1.0 * INT16_MIN; - datatype = TUSHORT; - break; - - case PS_TYPE_S16: - bitpix = SHORT_IMG; - datatype = TSHORT; - break; - - case PS_TYPE_U32: - bitpix = LONG_IMG; - bzero = -1.0 * INT32_MIN; - datatype = TUINT; - break; - - case PS_TYPE_S32: - bitpix = LONG_IMG; - datatype = TINT; - break; - - case PS_TYPE_F32: - bitpix = FLOAT_IMG; - datatype = TFLOAT; - break; - - case PS_TYPE_F64: - bitpix = DOUBLE_IMG; - datatype = TDOUBLE; - break; - - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psFits_TYPE_UNSUPPORTED, - typeStr); - return false; - } - } - - // pass the requested parameters (NULL parameters are not set, of course). - if (bitPix != NULL) { - *bitPix = bitpix; - } - - if (dataType != NULL) { - *dataType = datatype; - } - - if (bZero != NULL) { - *bZero = bzero; - } - - return true; -} - -static bool convertMetadataTypeToBinaryTForm(psMetadataType type, char** fitsType) -{ - switch (type) { - case PS_META_BOOL: - *fitsType = psStringCopy("1L"); - break; - case PS_META_S32: - *fitsType = psStringCopy("1J"); - break; - case PS_META_F32: - *fitsType = psStringCopy("1E"); - break; - case PS_META_F64: - *fitsType = psStringCopy("1D"); - break; - // XXX: Handle other types, e.g., Vectors, etc. - default: - return false; - } - - return true; -} - -static bool isHDUEmpty(const psFits* fits) -{ - /* check for keys - no keys means this is really an empty HDU */ - int keysexist = -1; - int morekeys; - int status = 0; - - fits_get_hdrspace(fits->p_fd, &keysexist, &morekeys, &status); - - // if no keys exist and not primary HDU, this really is an empty HDU - if (keysexist == 0) { - return true; - } - - return false; - -} - -static void fitsFree(psFits* fits) -{ - int status = 0; - - if (fits != NULL) { - (void)fits_close_file(fits->p_fd, &status); - psFree(fits->filename); - } -} - -psFits* psFitsAlloc(const char* name) -{ - int status = 0; - fitsfile *fptr = NULL; /* Pointer to the FITS file */ - - if (name == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_FILENAME_NULL); - return NULL; - } - - /* Open/Create the FITS file */ - if (access(name, F_OK) == 0) { // file exists - (void)fits_open_file(&fptr, name, READWRITE, &status); - if (fptr == NULL) { // if failed, try openning as just read-only - status = 0; - (void)fits_open_file(&fptr, name, READONLY, &status); - } - if (fptr == NULL || status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - fits_get_errstatus(status, fitsErr); - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psFits_FILENAME_INVALID, - name, fitsErr); - return NULL; - } - } else { // file does not exist, so create. - (void)fits_create_file(&fptr, name, &status); - if (fptr == NULL || status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_FILENAME_CREATE_FAILED, - name, fitsErr); - return NULL; - } - } - - psFits* fits = psAlloc(sizeof(psFits)); - fits->filename = psAlloc(strlen(name)+1); - fits->p_fd = fptr; - strcpy((char*)fits->filename,name); - psMemSetDeallocator(fits,(psFreeFunc)fitsFree); - - return fits; -} - -bool psFitsMoveExtName(const psFits* fits, - const char* extname) -{ - int status = 0; - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return false; - } - - if (extname == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_EXTNAME_NULL); - return false; - } - - - if (fits_movnam_hdu(fits->p_fd, ANY_HDU, (char*)extname, 0, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - fits_get_errstatus(status, fitsErr); - psError(PS_ERR_LOCATION_INVALID, true, - PS_ERRORTEXT_psFits_EXTNAME_INVALID, - extname, fits->filename, fitsErr); - return false; - } - - return true; -} - -bool psFitsMoveExtNum(const psFits* fits, - int extnum, - bool relative) -{ - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return false; - } - - int status = 0; - int hdutype = 0; - - if (relative) { - fits_movrel_hdu(fits->p_fd, extnum, &hdutype, &status); - if (status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - fits_get_errstatus(status, fitsErr); - psError(PS_ERR_LOCATION_INVALID, true, - PS_ERRORTEXT_psFits_EXTNUM_REL_MOVE_FAILED, - extnum, fits->filename, fitsErr); - return false; - } - } else { - fits_movabs_hdu(fits->p_fd, extnum+1, &hdutype, &status); - if (status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - fits_get_errstatus(status, fitsErr); - psError(PS_ERR_LOCATION_INVALID, true, - PS_ERRORTEXT_psFits_EXTNUM_ABS_MOVE_FAILED, - extnum, fits->filename, fitsErr); - return false; - } - } - - return true; -} - -int psFitsGetExtNum(const psFits* fits) -{ - int hdunum; - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return PS_FITS_TYPE_NONE; - } - - - return fits_get_hdu_num(fits->p_fd,&hdunum) - 1; -} - -psString psFitsGetExtName(const psFits* fits) -{ - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return NULL; - } - - int status = 0; - char name[MAX_STRING_LENGTH]; - - if (fits_read_key_str(fits->p_fd, "EXTNAME", name, NULL, &status) != 0) { - status = 0; - if (fits_read_key_str(fits->p_fd, "HDUNAME", name, NULL, &status) != 0) { - int num = psFitsGetExtNum(fits); - snprintf(name, MAX_STRING_LENGTH, "EXT-%3d",num); - } - } - return psStringCopy(name); -} - -bool psFitsSetExtName(psFits* fits, const char* name) -{ - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return false; - } - - if (name == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_EXTNAME_NULL); - return false; - } - - int status = 0; - - if (fits_update_key_str(fits->p_fd, "EXTNAME", (char*)name, NULL, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_WRITE_FAILED, - fits->filename, fitsErr); - return false; - } - - return true; -} - -int psFitsGetSize(const psFits* fits) -{ - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return 0; - } - - int num = 0; - int status = 0; - - if (fits_get_num_hdus(fits->p_fd, &num, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - fits_get_errstatus(status, fitsErr); - psError(PS_ERR_LOCATION_INVALID, true, - PS_ERRORTEXT_psFits_GETNUMHDUS_FAILED, - fits->filename, fitsErr); - return 0; - } - - return num; -} - -psFitsType psFitsGetExtType(const psFits* fits) -{ - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return PS_FITS_TYPE_NONE; - } - - int status = 0; - int hdutype = PS_FITS_TYPE_NONE; - - if (fits_get_hdu_type(fits->p_fd, &hdutype, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - fits_get_errstatus(status, fitsErr); - psError(PS_ERR_LOCATION_INVALID, true, - PS_ERRORTEXT_psFits_GETHDUTYPE_FAILED, - fits->filename, fitsErr); - return PS_FITS_TYPE_NONE; - } - - if (hdutype == PS_FITS_TYPE_IMAGE && - psFitsGetExtNum(fits) > 0 && - isHDUEmpty(fits)) { - return PS_FITS_TYPE_ANY; - } - - return hdutype; -} - -psMetadata* psFitsReadHeader(psMetadata* out, - const psFits* fits) -{ - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return NULL; - } - - if (out == NULL) { - out = psMetadataAlloc(); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - "Failed to allocate a new psMetadata container."); - return NULL; - } - } - - // Get number of key names - int numKeys = 0; - int keyNum = 0; - int status = 0; - fits_get_hdrpos(fits->p_fd, &numKeys, &keyNum, &status); - - // Get each key name. Keywords start at one. - char keyType; - char keyName[MAX_STRING_LENGTH]; - char keyValue[MAX_STRING_LENGTH]; - char keyComment[MAX_STRING_LENGTH]; - psBool tempBool; - psBool success; - psBool stdKey; - for (int i = 1; i <= numKeys; i++) { - - fits_read_keyn(fits->p_fd, i, keyName, keyValue, keyComment, &status); - - stdKey = false; - - int stdKeyIdx = 0; - while (standardFitsKeys[stdKeyIdx] != NULL && ! stdKey) { - if (strcmp(keyName,standardFitsKeys[stdKeyIdx++]) == 0) { - stdKey = true; - } - } - - if (keyValue[0] != 0) { // blank values are not handled by fits_get_keytype - fits_get_keytype(keyValue, &keyType, &status); - } else { - keyType = 'C'; - } - if (status != 0) { - break; - } - - if (! stdKey) { - switch (keyType) { - case 'X': // bit - case 'I': // short int. - case 'J': // int. - case 'B': // byte - success = psMetadataAdd(out, - PS_LIST_TAIL, - keyName, - PS_META_S32 | PS_META_DUPLICATE_OK, - keyComment, - atoi(keyValue)); - break; - case 'U': // unsigned int. may not fit in a psS32 - case 'K': // long int. can't all fit in a psS32 - case 'F': - success = psMetadataAdd(out, - PS_LIST_TAIL, - keyName, - PS_META_F64 | PS_META_DUPLICATE_OK, - keyComment, - atof(keyValue)); - break; - case 'C': - // remove the single-quotes at front/end - if (keyValue[0] == '\'' && keyValue[strlen(keyValue)-1] == '\'') { - keyValue[strlen(keyValue)-1] = '\0'; - success = psMetadataAdd(out, - PS_LIST_TAIL, - keyName, - PS_META_STR | PS_META_DUPLICATE_OK, - keyComment, - keyValue+1); - } else { - success = psMetadataAdd(out, - PS_LIST_TAIL, - keyName, - PS_META_STR | PS_META_DUPLICATE_OK, - keyComment, - keyValue); - } - break; - case 'L': - tempBool = (keyValue[0] == 'T') ? 1 : 0; - success = psMetadataAdd(out, - PS_LIST_TAIL, - keyName, - PS_META_BOOL | PS_META_DUPLICATE_OK, - keyComment, - tempBool); - break; - default: - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_METATYPE_INVALID, - keyType); - return out; - } - - if (!success) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psFits_METADATA_ADD_FAILED, - keyName); - return out; - } - } - - } - - if ( status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_METADATA_ADD_FAILED, - fitsErr); - return false; - } - - return out; -} - -psMetadata* psFitsReadHeaderSet(psMetadata* out, - const psFits* fits) -{ - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - psFree(out); - return NULL; - } - - if (out == NULL) { - out = psMetadataAlloc(); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - "Failed to allocate a new psMetadata container."); - return NULL; - } - } - - int size = psFitsGetSize(fits); - - int origPosition = psFitsGetExtNum(fits); - - for (int lcv=0; lcv < size; lcv++) { - psFitsMoveExtNum(fits, lcv, false); - - char* name = NULL; - if (lcv == 0) { - name = psStringCopy("PHU"); - } else { - name = psFitsGetExtName(fits); - } - - psMetadata* header = psFitsReadHeader(NULL, fits); - if (name != NULL && header != NULL) { - psMetadataAddMetadata(out, PS_LIST_HEAD, name, "FITS Header", - header); - } else { // XXX: is this a warning or error? - psLogMsg(__func__, PS_LOG_WARN, - "Failed to read HDU#%d header data.", - lcv); - } - - psFree(name); - psFree(header); - } - - // reposition to the original position - psFitsMoveExtNum(fits, origPosition, false); - - return out; -} - -psImage* psFitsReadImage(psImage* output, // a psImage to recycle. - const psFits* fits, // the psFits object - psRegion region, // the region in the FITS image to read - int z) // the z-plane in the FITS image cube to read -{ - psS32 status = 0; /* CFITSIO file vars */ - psS32 nAxis = 0; - psS32 anynull = 0; - psS32 bitPix = 0; /* Pixel type */ - long nAxes[3]; - long firstPixel[3]; /* lower-left corner of image subset */ - long lastPixel[3]; /* upper-right corner of image subset */ - long increment[3]; /* increment for image subset */ - char fitsErr[80] = ""; /* CFITSIO error message string */ - psS32 fitsDatatype = 0; - psS32 datatype = 0; - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - psFree(output); - return NULL; - } - - // check to see if we even are positioned on an image HDU - int hdutype; - if ( fits_get_hdu_type(fits->p_fd,&hdutype, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_HDU_TYPE_FAILED, - fitsErr); - return NULL; - } - if (hdutype != IMAGE_HDU) { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_NOT_IMAGE_TYPE); - return NULL; - } - - /* Get the data type 'bitPix' from the FITS image */ - if (fits_get_img_equivtype(fits->p_fd, &bitPix, &status) != 0) { - fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_DATATYPE_UNKNOWN, - fitsErr); - psFree(output); - return NULL; - } - - /* Get the dimensions 'nAxis' from the FITS image */ - if (fits_get_img_dim(fits->p_fd, &nAxis, &status) != 0) { - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_IMAGE_DIM_UNKNOWN, - fitsErr); - psFree(output); - return NULL; - } - - /* Validate the number of axis */ - if ((nAxis < 2) || (nAxis > 3)) { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_IMAGE_DIMENSION_UNSUPPORTED, - nAxis); - psFree(output); - return NULL; - } - - /* Get the Image size from the FITS file */ - if (fits_get_img_size(fits->p_fd, nAxis, nAxes, &status) != 0) { - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_IMAGE_SIZE_UNKNOWN, - fitsErr); - psFree(output); - return NULL; - } - - firstPixel[0] = region.x0 + 1; - firstPixel[1] = region.y0 + 1; - firstPixel[2] = z + 1; - - if (region.x1 > 0) { - lastPixel[0] = region.x1; - } else { - lastPixel[0] = nAxes[0] + region.x1; // n.b., region.x1 < 0 - } - if (region.y1 > 0) { - lastPixel[1] = region.y1; - } else { - lastPixel[1] = nAxes[1] + region.y1; // n.b., region.y1 < 0 - } - lastPixel[2] = z + 1; - - increment[0] = 1; - increment[1] = 1; - increment[2] = 1; - - switch (bitPix) { - case BYTE_IMG: - datatype = PS_TYPE_U8; - fitsDatatype = TBYTE; - break; - case SBYTE_IMG: - datatype = PS_TYPE_S8; - fitsDatatype = TSBYTE; - break; - case USHORT_IMG: - datatype = PS_TYPE_U16; - fitsDatatype = TUSHORT; - break; - case SHORT_IMG: - datatype = PS_TYPE_S16; - fitsDatatype = TSHORT; - break; - case ULONG_IMG: - datatype = PS_TYPE_U32; - fitsDatatype = TUINT; - break; - case LONG_IMG: - datatype = PS_TYPE_S32; - fitsDatatype = TINT; - break; - case LONGLONG_IMG: - datatype = PS_TYPE_S64; - fitsDatatype = TLONGLONG; - break; - case FLOAT_IMG: - datatype = PS_TYPE_F32; - fitsDatatype = TFLOAT; - break; - case DOUBLE_IMG: - datatype = PS_TYPE_F64; - fitsDatatype = TDOUBLE; - break; - default: - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_FITS_TYPE_UNSUPPORTED, - bitPix); - psFree(output); - return NULL; - } - - output = psImageRecycle(output, - lastPixel[0]-firstPixel[0]+1, - lastPixel[1]-firstPixel[1]+1, - datatype); - - if (output == NULL) { - psError(PS_ERR_UNKNOWN, false, - "Failed to allocate a properly sized image."); - return false; - } - - // n.b., this assumes contiguous image buffer - if (fits_read_subset(fits->p_fd, fitsDatatype, firstPixel, lastPixel, increment, - NULL, output->data.V[0], &anynull, &status) != 0) { - psFree(output); - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_READ_FAILED, - fitsErr); - return NULL; - } - - return output; - -} - -bool psFitsWriteImage(psFits* fits, - psMetadata* header, - const psImage* input, - int numZPlanes) -{ - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return false; - } - - if (input == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_IMAGE_NULL); - return false; - } - int numCols = input->numCols; - int numRows = input->numRows; - - int status = 0; - - // determine the FITS-equivalent parameters - int bitPix; - double bZero; - int dataType; - if (! convertPsTypeToFits(input->type.type, &bitPix, &bZero, &dataType) ) { - return false; - } - - int naxis = 3; - long naxes[3]; - - naxes[0] = numCols; - naxes[1] = numRows; - naxes[2] = numZPlanes; - - if (numZPlanes < 2) { - naxis = 2; - } - - fits_create_img(fits->p_fd, bitPix, naxis, naxes, &status); - - if (bZero != 0) { // set the bscale/bzero - fits_write_key_dbl(fits->p_fd, "BZERO", bZero, 12, "Pixel Value Offset", &status); - fits_write_key_dbl(fits->p_fd, "BSCALE", 1.0, 12, "Pixel Value Scale", &status); - fits_set_bscale(fits->p_fd, 1.0, bZero, &status); - } - - // write the header, if any. - if (header != NULL) { - psFitsWriteHeader(header, (psPtr)fits); - } - - if (input->parent == NULL) { // if no parent, assume that the image data is contiguous - fits_write_img(fits->p_fd, - dataType, // datatype - 1, // writing to the first z-plane - numCols*numRows, // number of elements to write, i.e., the whole image - input->data.V[0], // the data - &status); - } else { // image data may not be contiguous; write one row at a time - int firstPixel = 1; - for (int row = 0; row < numRows; row++) { - fits_write_img(fits->p_fd, - dataType, // datatype - firstPixel, - numCols, // number of elements to write, i.e., one row's worth - input->data.V[row],// the raw row data - &status); - firstPixel += numCols; // move to next row - } - } - - if ( status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_WRITE_FAILED, - fits->filename, fitsErr); - return false; - } - - return true; - -} - -bool psFitsUpdateImage(psFits* fits, - const psImage* input, - psRegion region, - int z) -{ - int status = 0; - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return false; - } - - if (input == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_IMAGE_NULL); - return false; - } - - // check to see if we are positioned on an image HDU - int hdutype; - if ( fits_get_hdu_type(fits->p_fd,&hdutype, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_HDU_TYPE_FAILED, - fitsErr); - return NULL; - } - if (hdutype != IMAGE_HDU) { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_NOT_IMAGE_TYPE); - return NULL; - } - - int numCols = input->numCols; - int numRows = input->numRows; - - // determine the FITS-equivalent parameters - int bitPix; - double bZero; - int dataType; - if (! convertPsTypeToFits(input->type.type, &bitPix, &bZero, &dataType) ) { - return false; - } - - //check to see if the HDU has the same datatype - int fileBitpix; - int naxis; - long nAxes[3]; - nAxes[2] = 1; - fits_get_img_param(fits->p_fd, 3, &fileBitpix, &naxis, nAxes, &status); - - //check to see if the HDU has the same datatype - if (bitPix != fileBitpix) { - char* fitsTypeStr; - char* imageTypeStr; - PS_TYPE_NAME(fitsTypeStr,fileBitpix); - PS_TYPE_NAME(imageTypeStr,input->type.type); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_IMAGE_UPDATE_TYPE_MISMATCH, - fitsTypeStr, imageTypeStr); - return false; - } - - //check if the HDU has the z-plane requested - if (z >= nAxes[2]) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psFits_FITS_Z_SMALL, - nAxes[2],z); - return false; - } - - // determine the region in the FITS file domain - long firstPixel[3]; - long lastPixel[3]; - - firstPixel[0] = region.x0 + 1; - firstPixel[1] = region.y0 + 1; - firstPixel[2] = z + 1; - - if (region.x1 > 0) { - lastPixel[0] = region.x1; - } else { - lastPixel[0] = nAxes[0] + region.x1; // n.b., region.x1 < 0 - } - if (region.y1 > 0) { - lastPixel[1] = region.y1; - } else { - lastPixel[1] = nAxes[1] + region.y1; // n.b., region.y1 < 0 - } - lastPixel[2] = z + 1; - - if (firstPixel[0] < 1 || firstPixel[0] > nAxes[0] || - firstPixel[1] < 1 || firstPixel[1] > nAxes[1] || - lastPixel[0] < 1 || lastPixel[0] > nAxes[0] || - lastPixel[1] < 1 || lastPixel[1] > nAxes[1]) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - "Specified region [%d:%d,%d:%d], is not valid given the %dx%d FITS image.", - region.y0,region.y1-1,region.x0,region.x1-1); - return false; - - } - - int dx = lastPixel[0] - firstPixel[0]; - int dy = lastPixel[1] - firstPixel[1]; - if (dx > numCols || - dy > numRows) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - "The region [%d:%d,%d:%d], is not valid given the input %dx%d image.", - firstPixel[1]-1,lastPixel[1]-1, - firstPixel[0]-1,lastPixel[0]-1, - numCols, numRows); - return false; - } - - psImage* subset; - if (dx != numCols || dy != numRows) { - // the input image needs to be subsetted - subset = psImageSubset((psImage*)input, psRegionSet(0,dx+1,0,dy+1)); - } else { - subset = psMemIncrRefCounter((psImage*)input); - } - - fits_write_subset(fits->p_fd, dataType, firstPixel, lastPixel, subset->data.V[0], &status); - - if ( status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_WRITE_FAILED, - fits->filename, fitsErr); - return false; - } - - return true; -} - -bool psFitsWriteHeader(const psMetadata* output, - psFits* fits) -{ - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return false; - } - - if (output == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_METADATA_NULL); - return false; - } - - int status = 0; - - //transverse the metadata list and add each key. - - psListIterator* iter = psListIteratorAlloc(output->list,PS_LIST_HEAD,true); - psMetadataItem* item; - while ( (item=psListGetAndIncrement(iter)) != NULL ) { - switch (item->type) { - case PS_META_BOOL: { - int value = item->data.B; - fits_update_key(fits->p_fd, - TLOGICAL, - item->name, - &value, - item->comment, - &status); - break; - } - case PS_META_S32: - fits_update_key(fits->p_fd, - TINT, - item->name, - &item->data.S32, - item->comment, - &status); - break; - case PS_META_F32: - fits_update_key(fits->p_fd, - TFLOAT, - item->name, - &item->data.F32, - item->comment, - &status); - break; - case PS_META_F64: - fits_update_key(fits->p_fd, - TDOUBLE, - item->name, - &item->data.F64, - item->comment, - &status); - break; - case PS_META_STR: - fits_update_key(fits->p_fd, - TSTRING, - item->name, - item->data.V, - item->comment, - &status); - break; - default: // all other META types are ignored - break; - } - - if ( status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_WRITE_FAILED, - fits->filename, fitsErr); - return false; - } - } - - return true; -} - -psMetadata* psFitsReadTableRow(const psFits* fits, - int row) -{ - long numRows; - int numCols; - int status = 0; - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return NULL; - } - - // check to see if we even are positioned on a table HDU - int hdutype; - fits_get_hdu_type(fits->p_fd,&hdutype, &status); - if ( status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_HDU_TYPE_FAILED, - fitsErr); - return NULL; - } - if (hdutype != ASCII_TBL && hdutype != BINARY_TBL) { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_NOT_TABLE_TYPE); - return NULL; - } - - // get the size of the FITS table - fits_get_num_rows(fits->p_fd, &numRows, &status); - fits_get_num_cols(fits->p_fd, &numCols, &status); - if ( status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_TABLE_SIZE_FAILED, - fitsErr); - return NULL; - } - - psTrace(".psFits.psFitsReadTableRow",5,"Table size is %ix%i\n",numCols, numRows); - // the row parameter in the proper range? - if (row < 0 || row >= numRows) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psFits_ROW_INVALID, - row,numRows); - return NULL; - } - - psMetadata* data = psMetadataAlloc(); - - int typecode; - long repeat; - long width; - char name[60]; - for (int col = 1; col <= numCols; col++) { - // get the column name - if (hdutype == BINARY_TBL) { - fits_get_bcolparms(fits->p_fd, col, name, - NULL, NULL, NULL, NULL, NULL, NULL, NULL, &status); - } else { - fits_get_acolparms(fits->p_fd, col, name, - NULL, NULL, NULL, NULL, NULL, NULL, NULL, &status); - } - // get the column type - fits_get_coltype(fits->p_fd, col, &typecode, &repeat, &width, &status); - - if (status == 0) { - - #define READ_TABLE_ROW_CASE(FITSTYPE, NATIVETYPE, TYPE) \ - case FITSTYPE: { \ - NATIVETYPE value = 0; \ - int anynul = 0; \ - fits_read_col(fits->p_fd, FITSTYPE, col,row+1, \ - 1, 1, NULL, &value, &anynul, &status); \ - psTrace(".psFits.psFitsReadTableRow",5,"Column #%i, '%s', is type %i, repeat %i, Value = %g\n", \ - col, name, typecode, repeat, (double)value); \ - psMetadataAdd(data,PS_LIST_TAIL, name, \ - PS_META_##TYPE, \ - "", (ps##TYPE)value); \ - break; \ - } - - switch (typecode) { - case TBYTE: - case TSHORT: - case TLONGLONG: - READ_TABLE_ROW_CASE(TLONG, long, S32) - READ_TABLE_ROW_CASE(TFLOAT, float, F32) - READ_TABLE_ROW_CASE(TDOUBLE, double, F64) - READ_TABLE_ROW_CASE(TLOGICAL, bool, BOOL); - case TSTRING: { - char* value = psAlloc(repeat+1); - int anynul = 0; - fits_read_col(fits->p_fd, TSTRING, col,row+1, - 1, 1, NULL, &value, &anynul, &status); - psTrace(".psFits.psFitsReadTableRow",5,"Column #%i, '%s', is type %i, repeat %i, value = %s\n", - col, name, typecode, repeat, value); - if (anynul == 0) { - psMetadataAdd(data,PS_LIST_TAIL, name, - PS_META_STR, - "", value); - } - psFree(value); - break; - } - default: - psTrace("psFits.psFitsReadTableRow", 2, - "Column %d or row %d was of a non primitive type, %d", - col, row, typecode); - } - } - - if ( status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_TABLE_ELEMENT, - col,row,fitsErr); - psFree(data); - return NULL; - } - - } - - return data; -} - -psArray* psFitsReadTableColumn(const psFits* fits, - const char* colname) -{ - int colnum = 0; - int status = 0; - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return NULL; - } - - // check to see if we even are positioned on a table HDU - int hdutype; - if ( fits_get_hdu_type(fits->p_fd,&hdutype, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_HDU_TYPE_FAILED, - fitsErr); - return NULL; - } - if (hdutype != ASCII_TBL && hdutype != BINARY_TBL) { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_NOT_TABLE_TYPE); - return NULL; - } - - // find the column by name - if ( fits_get_colnum(fits->p_fd, CASESEN, (char*)colname, &colnum, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_FIND_COLUMN, - colname, fitsErr); - return NULL; - } - - // get the number of rows - long numRows = 0; - fits_get_num_rows(fits->p_fd, &numRows, &status); - - // get the column length. - int width; - if ( fits_get_col_display_width(fits->p_fd, colnum, &width, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_COLTYPE, - fitsErr); - return NULL; - } - - // allocate the buffers - psArray* result = psArrayAlloc(numRows); - for (int row = 0; row < numRows; row++) { - result->data[row] = psAlloc((width+1)*sizeof(char)); - } - result->n = numRows; - - fits_read_col_str(fits->p_fd, - colnum, - 1, // firstrow - 1, // firestelem - numRows, - "", // nulstr - (char**)result->data, - NULL, - &status); - - if ( status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_TABLE_READ_COL, - fitsErr); - return NULL; - } - - return result; -} - -psVector* psFitsReadTableColumnNum(const psFits* fits, - const char* colname) -{ - int status = 0; - int colnum = 0; - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return NULL; - } - - // check to see if we even are positioned on a table HDU - int hdutype; - if ( fits_get_hdu_type(fits->p_fd,&hdutype, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_HDU_TYPE_FAILED, - fitsErr); - return NULL; - } - if (hdutype != ASCII_TBL && hdutype != BINARY_TBL) { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_NOT_TABLE_TYPE); - return NULL; - } - - // find the column by name - if ( fits_get_colnum(fits->p_fd, CASESEN, (char*)colname, &colnum, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_FIND_COLUMN, - colname, fitsErr); - return NULL; - } - - // get the number of rows - long numRows = 0; - fits_get_num_rows(fits->p_fd, - &numRows, - &status); - - // get the column datatype. - int typecode; - long repeat; - long width; - if ( fits_get_eqcoltype(fits->p_fd, colnum, &typecode, &repeat, &width, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_COLTYPE, - fitsErr); - return NULL; - } - - psVector* result = psVectorAlloc(numRows, convertFitsToPsType(typecode)); - - fits_read_col(fits->p_fd, - typecode, - colnum, - 1 /* firstrow */, - 1 /* firstelem */, - numRows, - NULL, - (psPtr)(result->data.U8), - NULL, - &status); - - if ( status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_TABLE_READ_COL, - fitsErr); - return NULL; - } - - return result; -} - - -psArray* psFitsReadTable(psFits* fits) -{ - int status = 0; - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return NULL; - } - - // check to see if we even are positioned on a table HDU - int hdutype; - if ( fits_get_hdu_type(fits->p_fd,&hdutype, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_HDU_TYPE_FAILED, - fitsErr); - return NULL; - } - if (hdutype != ASCII_TBL && hdutype != BINARY_TBL) { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_NOT_TABLE_TYPE); - return NULL; - } - - // get the size of the FITS table - long numRows = 0; - fits_get_num_rows(fits->p_fd, &numRows, &status); - if ( status != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_TABLE_SIZE_FAILED, - fitsErr); - return NULL; - } - - - psArray* table = psArrayAlloc(numRows); - - for (int row = 0; row < numRows; row++) { - psTrace(".psFits.psFitsReadTable",5,"Reading row %i of %i\n",row, numRows); - table->data[row] = psFitsReadTableRow(fits,row); - } - - return table; -} - -bool psFitsWriteTable(psFits* fits, - const psMetadata* header, - const psArray* table) -{ - int status = 0; - psMetadataItem* item; - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return false; - } - - if (table == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_IMAGE_NULL); - return false; - } - - int rows = table->n; - if (rows < 1) { - // no table data, what can I do? - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psFits_TABLE_EMPTY); - return false; - } - - // find all the columns needed - psArray* columns = psArrayAlloc(((psMetadata*)table->data[0])->list->n); - columns->n=0; - - // find the unique items in the array of metadata 'rows' - for (int row=0; row < rows; row++) { - psMetadata* rowMeta = table->data[row]; - if (rowMeta != NULL) { - psListIterator* iter = psListIteratorAlloc(rowMeta->list, - PS_LIST_HEAD,true); - while ( (item=psListGetAndIncrement(iter)) != NULL) { - if (PS_META_IS_PRIMITIVE(item->type)) { - bool found = false; - for (int n=0; n < columns->n && ! found; n++) { - if (strcmp(item->name, - ((psMetadataItem*)(columns->data[n]))->name) == 0) { - found = true; - } - } - if (! found) { - psArrayAdd(columns, columns->nalloc, item); - } - } - } - psFree(iter); - } - } - - if (columns->n == 0) { // no table columns found - // XXX: Error? - return false; - } - - //create list of column names and types. - psArray* columnNames = psArrayAlloc(columns->n); - psArray* columnTypes = psArrayAlloc(columns->n); - for (int n=0; n < columns->n; n++) { - char* fitsType; - columnNames->data[n] = psMemIncrRefCounter(((psMetadataItem*)columns->data[n])->name); - if ( ! convertMetadataTypeToBinaryTForm(((psMetadataItem*)columns->data[n])->type, - &fitsType)) { - // XXX: error message - return false; - } - columnTypes->data[n] = fitsType; - } - - char* extname = NULL; - if (header != NULL) { - extname = psMetadataLookupPtr(NULL, header, "EXTNAME"); - if ( extname == NULL) { - extname = psMetadataLookupPtr(NULL, header, "HDUNAME"); - } - } - - fits_create_tbl(fits->p_fd, - BINARY_TBL, - table->n, // number of rows in table - columns->n, // number of columns in table - (char**)columnNames->data, // names of the columns - (char**)columnTypes->data, // format of the columns - NULL, // physical unit of columns - extname, // extension name - &status); - - psFree(columnNames); - psFree(columnTypes); - - // fill in the table elements with data - for (int n = 0; n < columns->n; n++) { - int row; - item = columns->data[n]; - if (PS_META_IS_PRIMITIVE(item->type)) { - psVector* col = NULL; - switch (item->type) { - case PS_META_S32: - col = psVectorAlloc(table->n, PS_TYPE_S32); - for (row = 0; row < table->n; row++) { - col->data.S32[row] = psMetadataLookupS32(NULL, - table->data[row], - item->name); - } - fits_write_col_int(fits->p_fd, - n+1, // column number - 1, // firstrow - 1, // firstelem - table->n, // nelements - col->data.S32, - &status); - break; - case PS_META_F32: - col = psVectorAlloc(table->n, PS_TYPE_F32); - for (row = 0; row < table->n; row++) { - col->data.F32[row] = psMetadataLookupF32(NULL, - table->data[row], - item->name); - } - fits_write_col_flt(fits->p_fd, - n+1, // column number - 1, // firstrow - 1, // firstelem - table->n, // nelements - col->data.F32, - &status); - break; - case PS_META_F64: - col = psVectorAlloc(table->n, PS_TYPE_F64); - for (row = 0; row < table->n; row++) { - col->data.F64[row] = psMetadataLookupF64(NULL, - table->data[row], - item->name); - } - fits_write_col_dbl(fits->p_fd, - n+1, // column number - 1, // firstrow - 1, // firstelem - table->n, // nelements - col->data.F64, - &status); - break; - case PS_META_BOOL: - col = psVectorAlloc(table->n, PS_TYPE_BOOL); - for (row = 0; row < table->n; row++) { - col->data.S8[row] = psMetadataLookupBool(NULL, - table->data[row], - item->name); - } - fits_write_col_log(fits->p_fd, - n+1, // column number - 1, // firstrow - 1, // firstelem - table->n, // nelements - (char*)col->data.S8, - &status); - break; - default: - // XXX: error message? - break; - } - psFree(col); - } else if (item->type == PS_META_STR) { - psArray* col = psArrayAlloc(table->n); - for (row = 0; row < table->n; row++) { - col->data[row] = item->data.V; - } - fits_write_col_str(fits->p_fd, - n, // column number - 1, // firstrow - 1, // firstelem - table->n, // nelements - (char**)col->data, - &status); - psFree(col); - } - } - - psFree(columns); - - return true; -} - -bool psFitsUpdateTable(psFits* fits, - const psMetadata* data, - int row) -{ - int status = 0; - - if (fits == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_NULL); - return false; - } - - if (data == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psFits_IMAGE_NULL); - return false; - } - - // check to see if we even are positioned on a table HDU - int hdutype; - if ( fits_get_hdu_type(fits->p_fd,&hdutype, &status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_GET_HDU_TYPE_FAILED, - fitsErr); - return false; - } - if (hdutype != ASCII_TBL && hdutype != BINARY_TBL) { - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_NOT_TABLE_TYPE); - return false; - } - - psMetadataIterator* iter = psMetadataIteratorAlloc((psPtr)data,PS_LIST_HEAD,NULL); - - psMetadataItem* item; - - while ( (item=psMetadataGetAndIncrement(iter)) != NULL) { - if (PS_META_IS_PRIMITIVE(item->type)) { - // operating on primitive data type, i.e., not a complex object - int colnum = 0; - - if ( fits_get_colnum(fits->p_fd, CASESEN, item->name, &colnum, &status) == 0) { - // cooresponding column found in table - int dataType = 0; - convertPsTypeToFits(item->type, NULL, NULL, &dataType); - - if (fits_write_col(fits->p_fd, dataType, colnum, row+1, 1, 1, &item->data,&status) != 0) { - char fitsErr[MAX_STRING_LENGTH]; - (void)fits_get_errstatus(status, fitsErr); - psError(PS_ERR_IO, true, - PS_ERRORTEXT_psFits_WRITE_FAILED, - fits->filename, fitsErr); - psFree(iter); - return false; - } - } else { - // the column was not found. - psWarning("No column with the name '%s' exists in the table.", - item->name); - } - } - } - - psFree(iter); - - return true; -} Index: unk/psLib/src/dataIO/psFits.h =================================================================== --- /trunk/psLib/src/dataIO/psFits.h (revision 4545) +++ (revision ) @@ -1,269 +1,0 @@ -/** @file psFits.h - * - * @brief Contains Fits I/O routines - * - * @ingroup FileIO - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.19 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-22 03:00:27 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_FITS_H -#define PS_FITS_H - -#include - -#include "psType.h" -#include "psArray.h" -#include "psVector.h" -#include "psMetadata.h" -#include "psImage.h" - -/// @addtogroup FileIO -/// @{ - -/** FITS HDU type. - * - * Enumeration for FITS HDU type. - * - */ -typedef enum { - PS_FITS_TYPE_NONE = -1, ///< Unknown HDU type - PS_FITS_TYPE_IMAGE = IMAGE_HDU, ///< Image HDU type - PS_FITS_TYPE_BINARY_TABLE = BINARY_TBL, ///< Binary table HDU type - PS_FITS_TYPE_ASCII_TABLE = ASCII_TBL, ///< ASCII table HDU type - PS_FITS_TYPE_ANY = ANY_HDU ///< Any HDU type -} psFitsType; - -/** FITS file object. - * - * This object should be considered opaque to the user; no item in this - * struct should be accessed directly. - * - */ -typedef struct -{ - fitsfile* p_fd; ///< the CFITSIO fits files handle. - const char* filename; ///< the filename of the fits file -} -psFits; - -/** Opens a FITS file and allocates the associated psFits object. - * - * @return psFits* new psFits object for the FITS files specified or - * NULL if the open of the FITS file failed - */ -psFits* psFitsAlloc( - const char* name ///< the FITS file name -); - -/** Moves the FITS HDU to the specified extension name. - * - * @return psFitsType The HDU type, or PS_FITS_TYPE_NONE if move failed. - */ -bool psFitsMoveExtName( - const psFits* fits, ///< the psFits object to move - const char* extname ///< the extension name -); - -/** Moves the FITS HDU to the specified extension number - * - * @return psFitsType The HDU type, or PS_FITS_TYPE_NONE if move failed. - */ -bool psFitsMoveExtNum( - const psFits* fits, ///< the psFits object to move - int extnum, ///< the extension number to move to (zero is primary HDU) - bool relative ///< if true, extnum is a relative number to the current position -); - -/** Get the current extension number, where 0 is the primary HDU. - * - * @return int Current HDU number of the psFits file or < 0 if an error - * occurred. - */ -int psFitsGetExtNum( - const psFits* fits ///< the psFits object -); - -/** Get the current extension name. - * - * @return int Current HDU name of the psFits file or NULL if an - * error occurred. - */ -psString psFitsGetExtName( - const psFits* fits ///< the psFits object -); - -/** Set the current extension's name - * - * @return bool TRUE if the extension was successfully set, otherwise FALSE. - */ -bool psFitsSetExtName( - psFits* fits, ///< the psFits object - const char* name ///< the extension name -); - -/** Get the total number of HDUs in the FITS file. - * - * @return int The total number of HDUs in the FITS file or < 0 if an - * error occurred. - */ -int psFitsGetSize( - const psFits* fits ///< the psFits object -); - -/** Get the extension type of the current HDU. - * - * @return psFitsType The type of the current HDU. If PS_FITS_TYPE_UNKNOWN, - * the type could not be determined. - */ -psFitsType psFitsGetExtType( - const psFits* fits ///< the psFits object -); - -/** Reads the header of the current HDU. - * - * @return psMetadata* the header data - */ -psMetadata* psFitsReadHeader( - psMetadata* out, - ///< The psMetadata to add the header data. If null, a new psMetadata is created. - - const psFits* fits ///< the psFits object -); - -/** Reads the header of all HDUs. The current HDU is not changed. - * - * @return psMetadata* the header data set as a number of metadata entries - */ -psMetadata* psFitsReadHeaderSet( - psMetadata* out, - ///< The psMetadata to add the header data via psMetadata items. If null, a - ///< new psMetadata is created. The keys of the psMetadata are the extension names - ///< of the cooresponding HDUs. - - const psFits* fits ///< the psFits object -); - -/** Writes the values of the metadata to the current HDU header. - * - * @return bool if TRUE, the write was successful, otherwise FALSE. - */ -bool psFitsWriteHeader( - const psMetadata* output, ///< the psMetadata data in which to write - psFits* fits ///< the psFits object -); - -/** Reads an image, given the desired region and z-plane. - * - * @return psImage* the read image or NULL if there was an error. - */ -psImage* psFitsReadImage( - psImage* out, ///< a psImage to recycle. - const psFits* fits, ///< the psFits object - psRegion region, ///< the region in the FITS image to read - int z ///< the z-plane in the FITS image cube to read -); - -/** Writes an image, given the desired region and z-plane. - * - * @return bool TRUE is the write was successful, otherwise FALSE. - */ -bool psFitsWriteImage( - psFits* fits, ///< the psFits object - psMetadata* header, ///< header items for the new HDU. Can be NULL. - const psImage* input, ///< the image to output - int depth ///< the number of z-planes of the FITS image data cube -); - -/** Updates the FITS file image, given the desired region and z-plane. - * - * @return bool TRUE is the write was successful, otherwise FALSE. - */ -bool psFitsUpdateImage( - psFits* fits, ///< the psFits object - const psImage* input, ///< the image to output - psRegion region, ///< the region in the FITS image to write - int z ///< the z-planes of the FITS image data cube to write -); - -/** Reads a table row. The current HDU type must be either - * PS_FITS_TYPE_BINARY_TABLE or PS_FITS_TYPE_ASCII_TABLE. - * - * @return psMetadata* The table row's data. The keys are the column names. - */ -psMetadata* psFitsReadTableRow( - const psFits* fits, ///< the psFits object - int row ///< row number to read -); - -/** Reads a table column. The current HDU type must be either - * PS_FITS_TYPE_BINARY_TABLE or PS_FITS_TYPE_ASCII_TABLE. - * - * @return psArray* Array of data items for the specified column or NULL - * if an error occurred. - */ -psArray* psFitsReadTableColumn( - const psFits* fits, ///< the psFits object - const char* colname ///< the column name -); - -/** Reads a table column of numbers. The current HDU type must be either - * PS_FITS_TYPE_BINARY_TABLE or PS_FITS_TYPE_ASCII_TABLE. - * - * @return psVector* Vector of data for the specified column or NULL - * if an error occurred. - */ -psVector* psFitsReadTableColumnNum( - const psFits* fits, ///< the psFits object - const char* colname ///< the column name -); - - -/** Reads a whole FITS table. The current HDU type must be either - * PS_FITS_TYPE_BINARY_TABLE or PS_FITS_TYPE_ASCII_TABLE. - * - * @return psArray* Array of psMetadata items, which contains the output - * data items of each row. - * - * @see psFitsReadTableRow - */ -psArray* psFitsReadTable( - psFits* fits ///< the psFits object -); - -/** Writes a whole FITS table. The current HDU type must be either - * PS_FITS_TYPE_BINARY_TABLE or PS_FITS_TYPE_ASCII_TABLE. - * - * @return bool TRUE if the write was successful, otherwise FALSE - * - * @see psFitsReadTableRow - */ -bool psFitsWriteTable( - psFits* fits, ///< the psFits object - const psMetadata* header, ///< header items for the new HDU. Can be NULL. - const psArray* table - ///< Array of psMetadata items, which contains the output data items of each row. -); - -/** Updates a FITS table. The current HDU type must be either - * PS_FITS_TYPE_BINARY_TABLE or PS_FITS_TYPE_ASCII_TABLE. - * - * @return bool TRUE if the write was successful, otherwise FALSE - * - * @see psFitsWriteTable - */ -bool psFitsUpdateTable( - psFits* fits, ///< the psFits object - const psMetadata* data, - ///< Array of psMetadata items, which contains the output data items of each row. - int row ///< the row number to update. -); - -/// @} - -#endif // #ifndef PS_FITS_H Index: unk/psLib/src/dataIO/psLookupTable.c =================================================================== --- /trunk/psLib/src/dataIO/psLookupTable.c (revision 4545) +++ (revision ) @@ -1,847 +1,0 @@ -/** @file psLookupTable.c -* -* @brief This file defines the structure and functions for table lookups. -* -* @ingroup dataIO -* -* @author Ross Harman, MHPCC -* -* @version $Revision: 1.22 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-06 03:04:35 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, Univ. of Hawaii -*/ -#include -#include -#include -#undef __STRICT_ANSI__ -#include -#define __STRICT_ANSI__ -#include -#include - -#include "psMemory.h" -#include "psString.h" -#include "psError.h" -#include "psLookupTable.h" -#include "psFileUtilsErrors.h" -#include "psConstants.h" - -/******************************************************************************/ -/* DEFINE STATEMENTS */ -/******************************************************************************/ - -/** Maximum size of a string */ -#define MAX_STRING_LENGTH 256 - -/******************************************************************************/ -/* TYPE DEFINITIONS */ -/******************************************************************************/ - -// None - -/*****************************************************************************/ -/* GLOBAL VARIABLES */ -/*****************************************************************************/ - -// None - -/*****************************************************************************/ -/* FILE STATIC VARIABLES */ -/*****************************************************************************/ - -// None - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - LOCAL */ -/*****************************************************************************/ - -static bool ignoreLine(char *inString); -static char *cleanString(char *inString, int sLen); -static char* getToken(char **inString, char *delimiter, psParseErrorType *status); -static psS32 parseS32(char *inString, psParseErrorType *status); -static psS64 parseS64(char *inString, psParseErrorType *status); -static psF32 parseF32(char *inString, psParseErrorType *status); -static psF64 parseF64(char *inString, psParseErrorType *status); -static void parseValue(psVector *vec, psU64 index, char* strValue, psParseErrorType *status); -static void lookupTableFree(psLookupTable* table); - -/** Determines if a line is blank (whitespace only) or a commentline. It returns true if so. The input string - * must be null terminated. */ -static bool ignoreLine(char *inString) -{ - while(*inString!='\0' && *inString!='#') { - if(!isspace(*inString)) { - return false; - } - inString++; - } - return true; -} - - -/** Removes leading and trailing whitespace and # characters from a string. The cleaned string is a new null - * terminated copy of the original input string. */ -static char *cleanString(char *inString, int sLen) -{ - char *ptrB = NULL; - char *ptrE = NULL; - char *cleaned = NULL; - - ptrB = inString; - - // Skip over leading # or whitespace - while (isspace(*ptrB) || *ptrB=='#') { - ptrB++; - } - - // Skip over trailing whitespace, null terminators, and # characters - ptrE = inString + sLen; - while(isspace(*ptrE) || *ptrE=='\0' || *ptrE=='#') { - ptrE--; - } - - // Length, sLen, does not include '\0' - sLen = ptrE - ptrB + 1; - - // Adds '\0' to end of string and +1 to sLen - cleaned = psStringNCopy(ptrB, sLen); - - return cleaned; -} - - -/** Returns cleaned token based on delimiter, but not including delimiter. Also changes the pointer location - * the beginning of the string. Tokens are newly allocated null terminated strings. */ -static char* getToken(char **inString, char *delimiter, psParseErrorType *status) -{ - char *cleanToken = NULL; - int sLen = 0; - - // Skip over leading whitespace - while(isspace(**inString)) { - (*inString)++; - } - - // Length of token, not including delimiter - sLen = strcspn(*inString, delimiter); - if(sLen) { - - // Create new, cleaned, and null terminated token - cleanToken = cleanString(*inString, sLen); - - // Move to end of token - (*inString) += sLen; - } else if(**inString!='\0' && sLen==0) { - *status = PS_PARSE_ERROR_GENERAL; - } - - return cleanToken; -} - -/** Returns single parsed value as a psS32. The input string must be cleaned and null terminated. */ -static psS32 parseS32(char *inString, psParseErrorType *status) -{ - char *end = NULL; - psS32 value = 0.0; - - - value = (psS32)strtol(inString, &end, 0); - if(*end != '\0') { - *status = PS_PARSE_ERROR_VALUE; - } else if(inString==end) { - *status = PS_PARSE_ERROR_VALUE; - } - - return value; -} - -/** Returns single parsed value as a psS64. The input string must be cleaned and null terminated. */ -static psS64 parseS64(char *inString, psParseErrorType *status) -{ - char *end = NULL; - psS64 value = 0.0; - - value = (psS64)strtoll(inString, &end, 0); - if(*end != '\0') { - *status = PS_PARSE_ERROR_VALUE; - } else if(inString==end) { - *status = PS_PARSE_ERROR_VALUE; - } - - return value; -} - -/** Returns single parsed value as a psF32. The input string must be cleaned and null terminated. */ -static psF32 parseF32(char *inString, psParseErrorType *status) -{ - char *end = NULL; - psF32 value = 0.0; - - value = (psF32)strtof(inString, &end); - if(*end != '\0') { - *status = PS_PARSE_ERROR_VALUE; - } else if(inString==end) { - *status = PS_PARSE_ERROR_VALUE; - } - - return value; -} - -/** Returns single parsed value as a psF64. The input string must be cleaned and null terminated. */ -static psF64 parseF64(char *inString, psParseErrorType *status) -{ - char *end = NULL; - psF64 value = 0.0; - - value = (psF64)strtod(inString, &end); - if(*end != '\0') { - *status = PS_PARSE_ERROR_VALUE; - } else if(inString==end) { - *status = PS_PARSE_ERROR_VALUE; - } - - return value; -} - -/** Returns single parsed value as a double precision number. The input string must be cleaned and null - * terminated. */ -static void parseValue(psVector *vec, psU64 index, char* strValue, psParseErrorType *status) -{ - psElemType type; - - - if(vec == NULL) { - *status = 1; - return; - } - - type = vec->type.type; - - switch(type) { - case PS_TYPE_S32: - vec->data.S32[index] = parseS32(strValue, status); - break; - case PS_TYPE_S64: - vec->data.S64[index] = parseS64(strValue, status); - break; - case PS_TYPE_F32: - vec->data.F32[index] = parseF32(strValue, status); - break; - case PS_TYPE_F64: - vec->data.F64[index] = parseF64(strValue, status); - break; - default: - *status = PS_PARSE_ERROR_TYPE; - } - - return; -} - -static void lookupTableFree(psLookupTable* table) -{ - if (table == NULL) { - return; - } - - psFree(table->values); - psFree(table->filename); - psFree(table->format); -} - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - PUBLIC */ -/*****************************************************************************/ - -psLookupTable* psLookupTableAlloc(const char *fileName, const char *format, long indexCol) -{ - psLookupTable *outTable = NULL; - - // Can't read table if you don't know its name - PS_ASSERT_PTR_NON_NULL(fileName,NULL); - - // Can't read table if you don't know its format - PS_ASSERT_PTR_NON_NULL(format,NULL); - - // Allocate lookup table - outTable = (psLookupTable*)psAlloc(sizeof(psLookupTable)); - - // Set deallocator - psMemSetDeallocator(outTable, (psFreeFunc)lookupTableFree); - - // Allocate and set file name and format strings - outTable->filename = psStringCopy(fileName); - outTable->format = psStringCopy(format); - - // Valid ranges. Automatically set by table read if both zero. - *(double *)&outTable->validFrom = 0; - *(double *)&outTable->validTo = 0; - outTable->indexCol = indexCol; - - // Vector of independent index values. Filled by table read. - outTable->index = NULL; - - // Array of dependent table values corresponding to index values. Filled by table read. - outTable->values = NULL; - - return outTable; -} - -#define UPDATE_VALID_TO_FROM(TABLE) \ -switch (TABLE->index->type.type) { \ -case PS_TYPE_U8: \ - *(double *)&TABLE->validFrom = (psF64)TABLE->index->data.U8[0]; \ - *(double *)&TABLE->validTo = (psF64)TABLE->index->data.U8[TABLE->index->n-1]; \ - break; \ -case PS_TYPE_S8: \ - *(double *)&TABLE->validFrom = (psF64)TABLE->index->data.S8[0]; \ - *(double *)&TABLE->validTo = (psF64)TABLE->index->data.S8[TABLE->index->n-1]; \ - break; \ -case PS_TYPE_U16: \ - *(double *)&TABLE->validFrom = (psF64)TABLE->index->data.U16[0]; \ - *(double *)&TABLE->validTo = (psF64)TABLE->index->data.U16[TABLE->index->n-1]; \ - break; \ -case PS_TYPE_S16: \ - *(double *)&TABLE->validFrom = (psF64)TABLE->index->data.S16[0]; \ - *(double *)&TABLE->validTo = (psF64)TABLE->index->data.S16[TABLE->index->n-1]; \ - break; \ -case PS_TYPE_U32: \ - *(double *)&TABLE->validFrom = (psF64)TABLE->index->data.U32[0]; \ - *(double *)&TABLE->validTo = (psF64)TABLE->index->data.U32[TABLE->index->n-1]; \ - break; \ -case PS_TYPE_S32: \ - *(double *)&TABLE->validFrom = (psF64)TABLE->index->data.S32[0]; \ - *(double *)&TABLE->validTo = (psF64)TABLE->index->data.S32[TABLE->index->n-1]; \ - break; \ -case PS_TYPE_U64: \ - *(double *)&TABLE->validFrom = (psF64)TABLE->index->data.U64[0]; \ - *(double *)&TABLE->validTo = (psF64)TABLE->index->data.U64[TABLE->index->n-1]; \ - break; \ -case PS_TYPE_S64: \ - *(double *)&TABLE->validFrom = (psF64)TABLE->index->data.S64[0]; \ - *(double *)&TABLE->validTo = (psF64)TABLE->index->data.S64[TABLE->index->n-1]; \ - break; \ -case PS_TYPE_F32: \ - *(double *)&TABLE->validFrom = (psF64)TABLE->index->data.F32[0]; \ - *(double *)&TABLE->validTo = (psF64)TABLE->index->data.F32[TABLE->index->n-1]; \ - break; \ -case PS_TYPE_F64: \ - *(double *)&TABLE->validFrom = (psF64)TABLE->index->data.F64[0]; \ - *(double *)&TABLE->validTo = (psF64)TABLE->index->data.F64[TABLE->index->n-1]; \ - break; \ -default: \ - *(double *)&TABLE->validFrom = (psF64)0; \ - *(double *)&TABLE->validTo = (psF64)0; \ - break; \ -} - -#define COPY_VECTOR_VALUES(VEC_OUT,INDEX_OUT,VEC_IN,INDEX_IN) \ -switch(((psVector*)(VEC_IN))->type.type) { \ -case PS_TYPE_U8: \ - ((psVector*)VEC_OUT)->data.U8[INDEX_OUT] = ((psVector*)VEC_IN)->data.U8[INDEX_IN]; \ - break; \ -case PS_TYPE_U16: \ - ((psVector*)VEC_OUT)->data.U16[INDEX_OUT] = ((psVector*)VEC_IN)->data.U16[INDEX_IN]; \ - break; \ -case PS_TYPE_U32: \ - ((psVector*)VEC_OUT)->data.U32[INDEX_OUT] = ((psVector*)VEC_IN)->data.U32[INDEX_IN]; \ - break; \ -case PS_TYPE_U64: \ - ((psVector*)VEC_OUT)->data.U64[INDEX_OUT] = ((psVector*)VEC_IN)->data.U64[INDEX_IN]; \ - break; \ -case PS_TYPE_S8: \ - ((psVector*)VEC_OUT)->data.S8[INDEX_OUT] = ((psVector*)VEC_IN)->data.S8[INDEX_IN]; \ - break; \ -case PS_TYPE_S16: \ - ((psVector*)VEC_OUT)->data.S16[INDEX_OUT] = ((psVector*)VEC_IN)->data.S16[INDEX_IN]; \ - break; \ -case PS_TYPE_S32: \ - ((psVector*)VEC_OUT)->data.S32[INDEX_OUT] = ((psVector*)VEC_IN)->data.S32[INDEX_IN]; \ - if(INDEX_OUT == 0) { \ - validFrom = ((psVector*)VEC_OUT)->data.S32[INDEX_OUT]; \ - } \ - if(INDEX_OUT == ((psVector*)VEC_OUT)->n-1 ) { \ - validTo = ((psVector*)VEC_OUT)->data.S32[INDEX_OUT]; \ - } \ - break; \ -case PS_TYPE_S64: \ - ((psVector*)VEC_OUT)->data.S64[INDEX_OUT] = ((psVector*)VEC_IN)->data.S64[INDEX_IN]; \ - if(INDEX_OUT == 0) { \ - validFrom = ((psVector*)VEC_OUT)->data.S64[INDEX_OUT]; \ - } \ - if(INDEX_OUT == ((psVector*)VEC_OUT)->n-1 ) { \ - validTo = ((psVector*)VEC_OUT)->data.S64[INDEX_OUT]; \ - } \ - break; \ -case PS_TYPE_F32: \ - ((psVector*)VEC_OUT)->data.F32[INDEX_OUT] = ((psVector*)VEC_IN)->data.F32[INDEX_IN]; \ - if(INDEX_OUT == 0) { \ - validFrom = ((psVector*)VEC_OUT)->data.F32[INDEX_OUT]; \ - } \ - if(INDEX_OUT == ((psVector*)VEC_OUT)->n-1 ) { \ - validTo = ((psVector*)VEC_OUT)->data.F32[INDEX_OUT]; \ - } \ - break; \ -case PS_TYPE_F64: \ - ((psVector*)VEC_OUT)->data.F64[INDEX_OUT] = ((psVector*)VEC_IN)->data.F64[INDEX_IN]; \ - if(INDEX_OUT == 0) { \ - validFrom = ((psVector*)VEC_OUT)->data.F64[INDEX_OUT]; \ - } \ - if(INDEX_OUT == ((psVector*)VEC_OUT)->n-1 ) { \ - validTo = ((psVector*)VEC_OUT)->data.F64[INDEX_OUT]; \ - } \ - break; \ -default: \ - break; \ -} - -psArray *psVectorsReadFromFile(const char *filename, const char *format) -{ - psArray* outputArray = NULL; - psVector* colVector = NULL; - char* strValue = NULL; - char* strNum = NULL; - char* line = NULL; - char* linePtr = NULL; - int numCols = 0; - int numRows = 0; - FILE* fp = NULL; - const char* tempFormat = NULL; - psParseErrorType parseStatus = PS_PARSE_SUCCESS; - - // Check for nul file name - PS_ASSERT_PTR_NON_NULL(filename,NULL); - - // Parse format string for valid string - PS_ASSERT_PTR_NON_NULL(format,NULL); - - // Create temp pointer which can then be used several times - tempFormat = format; - - // Create output array and set array elements to zero - outputArray = psArrayAlloc(10); - outputArray->n = 0; - - // Parse the format string to determine how many vectors - // and whether the format string is valid - while((strValue=getToken((char**)&tempFormat," ",&parseStatus))) { - - // Check for %d format sub string - if(strcmp(strValue,"\%d") == 0 ) { - numCols++; - colVector = psVectorAlloc(1,PS_TYPE_S32); - outputArray = psArrayAdd(outputArray,1,colVector); - psFree(colVector); - } else if (strcmp(strValue,"\%ld") == 0) { - numCols++; - colVector = psVectorAlloc(1,PS_TYPE_S64); - outputArray = psArrayAdd(outputArray,1,colVector); - psFree(colVector); - } else if (strcmp(strValue,"\%f") == 0) { - numCols++; - colVector = psVectorAlloc(1,PS_TYPE_F32); - outputArray = psArrayAdd(outputArray,1,colVector); - psFree(colVector); - } else if (strcmp(strValue,"\%lf") == 0) { - numCols++; - colVector = psVectorAlloc(1,PS_TYPE_F64); - outputArray = psArrayAdd(outputArray,1,colVector); - psFree(colVector); - } else if (strstr(strValue,"\%*") != 0) { - // Don't increase number of columns - } else { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,"Invalid format specifier"); - psFree(strValue); - numCols = 0; - break; - } - psFree(strValue); - } - - // If the format string was parsed successfully and return numCols the - // prepare to open file and read values - if(numCols > 0) { - - // Open specified file - if((fp=fopen(filename, "r")) == NULL) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psLookupTable_FILE_NOT_FOUND, - filename); - psFree(outputArray); - return NULL; - } else { - // Initialize array index - int arrayIndex = 0; - - // Create reusable line for continuous read - line = (char*)psAlloc(MAX_STRING_LENGTH*sizeof(char)); - - // Loop through file to get numRows, numCols, and column data types - while((fgets(line, MAX_STRING_LENGTH, fp) != NULL) && (parseStatus == PS_PARSE_SUCCESS)) { - - // Copy pointer to line for parsing - linePtr = line; - - // If line is not a comment or blank, then extract data - if(!ignoreLine(linePtr)) { - numRows++; - - // Copy format pointer for parsing - tempFormat = format; - arrayIndex = 0; - parseStatus = PS_PARSE_SUCCESS; - - // Loop through format and line strings to get values in text table file - while((strValue=getToken((char**)&tempFormat," ",&parseStatus)) && - (strNum=getToken((char**)&linePtr," ",&parseStatus)) ) { - - // Set column vector - colVector = outputArray->data[arrayIndex]; - - // Set column entries based on format string defining the type - if(strcmp(strValue,"\%d") == 0 ) { - colVector = psVectorRecycle(colVector, numRows, colVector->type.type); - parseValue(colVector,numRows-1,strNum,&parseStatus); - arrayIndex++; - } else if (strcmp(strValue,"\%ld") == 0) { - colVector = psVectorRecycle(colVector, numRows, colVector->type.type); - parseValue(colVector,numRows-1,strNum,&parseStatus); - arrayIndex++; - } else if (strcmp(strValue,"\%f") == 0) { - colVector = psVectorRecycle(colVector, numRows, colVector->type.type); - parseValue(colVector,numRows-1,strNum,&parseStatus); - arrayIndex++; - } else if (strcmp(strValue,"\%lf") == 0) { - colVector = psVectorRecycle(colVector, numRows, colVector->type.type); - parseValue(colVector,numRows-1,strNum,&parseStatus); - arrayIndex++; - } else if (strstr(strValue,"\%*") != 0) { - // Don't increase number of columns - } - psFree(strValue); - psFree(strNum); - - // If the file line was not parsed successful report error and return NULL - if(parseStatus != PS_PARSE_SUCCESS) { - psError(PS_ERR_UNKNOWN,true,"Parsing text file failed."); - fclose(fp); - psFree(outputArray); - psFree(line); - return NULL; - } - } - } // ignore line - } - - // Read on the lines in the file - close file pointer - fclose(fp); - psFree(line); - } - } else { - // Format string parse error detected - psError(PS_ERR_UNKNOWN,true,"Format string was not parsed sucessfully"); - psFree(outputArray); - return NULL; - } - - // Return populated array - return outputArray; -} - -psLookupTable *psLookupTableImport(psLookupTable *table, const psArray *vectors, long indexCol) -{ - psLookupTable* outputTable = NULL; - psBool sortNeeded = false; - psF64 validTo = 0; - psF64 validFrom = 0; - - // Check for NULL input table - PS_ASSERT_PTR_NON_NULL(table,NULL); - - // Check for NULL vectors - PS_ASSERT_PTR_NON_NULL(vectors,NULL); - - // Check for invalid index column - if(indexCol < 0 ) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,"Index column cannot be less than zero"); - return NULL; - } - - if (indexCol >= vectors->n) { - psError(PS_ERR_BAD_PARAMETER_VALUE,true,"Index column, %d, is larger than number of columns, %d.", - indexCol, vectors->n); - return NULL; - } - - psVector* indexColumnVector = vectors->data[indexCol]; - psS32 numRows = indexColumnVector->n; - psS32 numCols = vectors->n; - - // Check if array is sorted on the index column - psVector* sortedIndex = psVectorAlloc(numRows,PS_TYPE_U32); - sortedIndex = psVectorSortIndex(sortedIndex,indexColumnVector); - for(psS32 i = 0; i < numRows; i++ ) { - if(sortedIndex->data.U32[i] != i) { - sortNeeded = true; - break; - } - } - - // Check if it is necessary to sort value vectors - if(sortNeeded) { - // Allocate new array to contain sorted vectors - psArray* newValueArray = psArrayAlloc(numCols); - for(psS32 j = 0; j < numCols; j++) { - psS32 type = ((psVector*)(vectors->data[j]))->type.type; - newValueArray->data[j] = psVectorAlloc(numRows,type); - } - - // Populate new array/vectors with sorted values - for(psS32 i = 0; i < numRows; i++) { - // Populate new index vector - psU32 sortIndex = sortedIndex->data.U32[i]; - // For every column populate new value vectors - for(psS32 j=0; j < numCols; j++) { - COPY_VECTOR_VALUES(newValueArray->data[j],i,vectors->data[j], sortIndex) - } - } - // Assign new vector value to table - table->index = newValueArray->data[indexCol]; - // Assign new value vectors to table array - table->values = newValueArray; - // Assign indexCol - table->indexCol = indexCol; - // Assign validTo and validFrom values - UPDATE_VALID_TO_FROM(table) - - // Set return value - outputTable = table; - - } else { - // Index vector is already sorted - // Assign array vector specified by indexCol to table index vector and increment memory ref - table->index = vectors->data[indexCol]; - table->values = (psArray*)vectors; - psMemIncrRefCounter((psArray*)vectors); - - // Assign indexCol - table->indexCol = indexCol; - // Assign validTo and validFrom values - UPDATE_VALID_TO_FROM(table); - - // Set return value - outputTable = table; - } - - // Free sort vector - psFree(sortedIndex); - - return outputTable; -} - -long psLookupTableRead(psLookupTable* table) -{ - long numRows = 0; - psArray* vectors = NULL; - psLookupTable* outTable = NULL; - - // Check if the input table is NULL then return 0 - PS_ASSERT_PTR_NON_NULL(table,0); - - // Read vectors from file specified in table - vectors = psVectorsReadFromFile(table->filename, table->format); - - // Check for valid array after reading from file - if(vectors != NULL) { - - // Import vector into table - outTable = psLookupTableImport(table, vectors, table->indexCol); - - psFree(vectors); - - // Update the number of rows read if outTable is not NULL - if(outTable != NULL) { - numRows = table->index->n; - } - } - - // Return the number of lines read - return numRows; -} - -#define CONVERT_VALUE_TO_F64(VECTOR,INDEX,RESULT) \ -switch(VECTOR->type.type) { \ -case PS_TYPE_U8: \ - RESULT = (psF64)VECTOR->data.U8[INDEX]; \ - break; \ -case PS_TYPE_U16: \ - RESULT = (psF64)VECTOR->data.U16[INDEX]; \ - break; \ -case PS_TYPE_U32: \ - RESULT = (psF64)VECTOR->data.U32[INDEX]; \ - break; \ -case PS_TYPE_U64: \ - RESULT = (psF64)VECTOR->data.U64[INDEX]; \ - break; \ -case PS_TYPE_S8: \ - RESULT = (psF64)VECTOR->data.S8[INDEX]; \ - break; \ -case PS_TYPE_S16: \ - RESULT = (psF64)VECTOR->data.S16[INDEX]; \ - break; \ -case PS_TYPE_S32: \ - RESULT = (psF64)VECTOR->data.S32[INDEX]; \ - break; \ -case PS_TYPE_S64: \ - RESULT = (psF64)VECTOR->data.S64[INDEX]; \ - break; \ -case PS_TYPE_F32: \ - RESULT = (psF64)VECTOR->data.F32[INDEX]; \ - break; \ -case PS_TYPE_F64: \ - RESULT = VECTOR->data.F64[INDEX]; \ - break; \ -default: \ - RESULT = NAN; \ - break; \ -} - -#define CHECK_LOWER_UPPER_BOUND(TABLE,INDEX,COLUMN) \ -switch (TABLE->index->type.type) { \ -case PS_TYPE_S32: \ - if( (psS32)index < TABLE->index->data.S32[0] ) { \ - return NAN; \ - } \ - if( (psS32)index > TABLE->index->data.S32[numRows-1] ) { \ - return NAN; \ - } \ - break; \ -case PS_TYPE_S64: \ - if( (psS64)index < TABLE->index->data.S64[0] ) { \ - return NAN; \ - } \ - if( (psS64)index > TABLE->index->data.S64[numRows-1] ) { \ - return NAN; \ - } \ - break; \ -case PS_TYPE_F32: \ - if( (psF32)index < TABLE->index->data.F32[0] ) { \ - return NAN; \ - } \ - if( (psF32)index > TABLE->index->data.F32[numRows-1] ) { \ - return NAN; \ - } \ - break; \ -case PS_TYPE_F64: \ - if( index < TABLE->index->data.F64[0] ) { \ - return NAN; \ - } \ - if( index > TABLE->index->data.F64[numRows-1] ) { \ - return NAN; \ - } \ - break; \ -default: \ - return NAN; \ - break; \ -} - -double psLookupTableInterpolate(const psLookupTable *table, double index, long column) -{ - psU64 hiIdx = 0; - psU64 loIdx = 0; - long numRows = 0; - long numCols = 0; - psF64 out = 0.0; - psF64 denom = 0.0; - psF64 convertVal = 0.0; - psF64 tempVal = 0.0; - psVector *indexVec = NULL; - psVector *valuesVec = NULL; - psArray *values = NULL; - - // Check for NULL table - PS_ASSERT_PTR_NON_NULL(table,NAN); - - indexVec = table->index; - values = table->values; - numRows = table->index->n; - numCols = table->values->n; - PS_ASSERT_PTR_NON_NULL(indexVec,NAN); - PS_ASSERT_PTR_NON_NULL(values,NAN); - PS_ASSERT_INT_UNEQUAL(numRows, 0,NAN); - PS_ASSERT_INT_UNEQUAL(numCols, 0,NAN); - PS_ASSERT_INT_WITHIN_RANGE(column, 0, (int)(numCols-1), NAN); - - valuesVec = (psVector*)values->data[column]; - PS_ASSERT_PTR_NON_NULL(indexVec,NAN); - - // Verify the index is within the bounds of the table - CHECK_LOWER_UPPER_BOUND(table,index,column) - - // Find location in table where specified index is between to entries - CONVERT_VALUE_TO_F64(indexVec, 0, convertVal) - while(index > convertVal ) { - hiIdx++; - if(hiIdx >= numRows) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psLookupTable_INTERPOLATE_HIGH, hiIdx); - return NAN; - } - CONVERT_VALUE_TO_F64(indexVec, hiIdx, convertVal) - } - - // Check for negative low index and generate error - loIdx = hiIdx--; - if(loIdx < 0) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psLookupTable_INTERPOLATE_LOW, loIdx); - return NAN; - } - - // Perform linear interpolation to calculate return value - CONVERT_VALUE_TO_F64(indexVec, hiIdx, denom) - CONVERT_VALUE_TO_F64(indexVec, loIdx, convertVal); - denom -= convertVal; - if(fabs(denom) < FLT_EPSILON) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psLookupTable_DIVIDE_BY_ZERO); - return NAN; - } else { - CONVERT_VALUE_TO_F64(valuesVec,hiIdx,tempVal) - CONVERT_VALUE_TO_F64(valuesVec,loIdx,convertVal) - tempVal -= convertVal; - CONVERT_VALUE_TO_F64(indexVec,loIdx,convertVal) - out = tempVal*(index-convertVal)/denom; - CONVERT_VALUE_TO_F64(valuesVec,loIdx,convertVal) - out += convertVal; - } - - return out; -} - -psVector* psLookupTableInterpolateAll(const psLookupTable *table, double index) -{ - long numCols = 0; - psVector *outVector = NULL; - - // Error checks - PS_ASSERT_PTR_NON_NULL(table,NULL); - numCols = table->values->n; - PS_ASSERT_INT_UNEQUAL(numCols, 0,NULL); - - // Create output vector - outVector = psVectorAlloc(numCols, PS_TYPE_F64); - - // Fill vectors with results and status of results - for(psU64 i=0; idata.F64[i] = psLookupTableInterpolate(table, index, i); - if(isnan(outVector->data.F64[i])) { - // Free allocated vector - psFree(outVector); - outVector = NULL; - // Break out of loop since error detected - break; - } - } - - return outVector; -} - Index: unk/psLib/src/dataIO/psLookupTable.h =================================================================== --- /trunk/psLib/src/dataIO/psLookupTable.h (revision 4545) +++ (revision ) @@ -1,133 +1,0 @@ -/** @file psLookupTable.h -* -* @brief This file defines the structure and functions for table lookups. -* -* @ingroup dataIO -* -* @author Ross Harman, MHPCC -* -* @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-06 03:04:35 $ -* -* Copyright 2004 Maui High Performance Computing Center, University of Hawaii -*/ - -#ifndef PS_LOOKUPTABLE_H -#define PS_LOOKUPTABLE_H - -#include "psType.h" -#include "psVector.h" -#include "psArray.h" - - -/** Lookup table structure - * - * Holds table data read from external data files. - * - */ -typedef struct -{ - const char *filename; ///< Name of file with table - const char *format; ///< scanf-like format string for file - long indexCol; ///< Column of the index vector (starting at zero) - psVector *index; ///< Vector of independent index values - psArray *values; ///< Array of dependent table values corresponding to index values - const double validFrom; ///< Lower bound for rable read - const double validTo; ///< Upper bound for table read -} -psLookupTable; - - -/** Lookup table lookup status and error conditions - * - * Success, failure, and status conditions for table lookups. - */ -typedef enum { - PS_LOOKUP_SUCCESS = 0x0000, ///< Table lookup succeeded - PS_LOOKUP_PAST_TOP = 0x0101, ///< Lookup off top of table - PS_LOOKUP_PAST_BOTTOM = 0x0102, ///< Lookup off bottom of table - PS_LOOKUP_ERROR = 0x0104 ///< Any other type of lookup error -} psLookupStatusType; - -/** Lookup table parse status and error conditions - * - * Success, failure, and status conditions for table parsing. - */ -typedef enum { - PS_PARSE_SUCCESS = 0x0000, ///< Table lookup succeeded - PS_PARSE_ERROR_TYPE = 0x0101, ///< Error parsing type - PS_PARSE_ERROR_VALUE = 0x0102, ///< Error parsing numerical value - PS_PARSE_ERROR_GENERAL = 0x0104 ///< Any other type of lookup error -}psParseErrorType; - -/** Allocator for psLookupTable struct - * - * Allocates a new psLookupTable struct. - * - * @return psLookupTable* New psLookupTable struct. - */ -psLookupTable* psLookupTableAlloc( - const char *fileName, ///< Name of file to read - const char *format, ///< scanf-like format string - long indexCol ///< Column of the index vector (starting at zero) -); - -/** Read vectors from file - * - * Read numeric vectors from ASCII text file - * - * @return psArray* New array of psVectors corresponding to the columns of the table - */ -psArray *psVectorsReadFromFile( - const char* filename, ///< File to be read - const char* format ///< scanf-like format string -); - -/** Import arrays of vectors into a table - * - * Import array of vectors read from text file into a table structure - * - * @return psLookupTable* Lookup table structure with array vector data - */ -psLookupTable *psLookupTableImport( - psLookupTable *table, ///< Lookup table into which to import - const psArray *vectors, ///< Array of vectors - long indexCol ///< Index of the index vector in the array of vectors -); - -/** Read lookup table - * - * Reads a lookup table and fills corresponding psLookupTable struct. - * - * @return long: Number of valid lines read - */ -long psLookupTableRead( - psLookupTable *table ///< Table to read -); - -/** Lookup and interpolate value from table. - * - * Interpolates value from table. Sets status bit for success or one of several possible failure - * conditions. - * - * @return double Interpolation value at index - */ -double psLookupTableInterpolate( - const psLookupTable *table, ///< Table with data - double index, ///< Value to be interpolated - long column ///< Column in table to be interpolated -); - -/** Lookup and interpolate all values from table. - * - * Interpolates all values from table. Sets status bit for success or one of several possible failure - * conditions. - * - * @return psVector* Interpolation values calculated at index - */ -psVector* psLookupTableInterpolateAll( - const psLookupTable *table, ///< Table with data - double index ///< Value to be interpolated -); - -#endif // #ifndef PS_LOOKUPTABLE_H Index: unk/psLib/src/dataManip/.cvsignore =================================================================== --- /trunk/psLib/src/dataManip/.cvsignore (revision 4545) +++ (revision ) @@ -1,7 +1,0 @@ -Makefile.in -.deps -.libs -Makefile -*.lo -*.la - Index: unk/psLib/src/dataManip/Makefile.am =================================================================== --- /trunk/psLib/src/dataManip/Makefile.am (revision 4545) +++ (revision ) @@ -1,33 +1,0 @@ -#Makefile for dataManip functions of psLib -# -INCLUDES = \ - -I$(top_srcdir)/src/astronomy \ - -I$(top_srcdir)/src/collections \ - -I$(top_srcdir)/src/dataIO \ - -I$(top_srcdir)/src/image \ - -I$(top_srcdir)/src/sysUtils \ - $(all_includes) - -noinst_LTLIBRARIES = libpslibdataManip.la - -libpslibdataManip_la_SOURCES = psUnaryOp.c psBinaryOp.c psStats.c \ - psFunctions.c psMatrix.c psVectorFFT.c psMinimize.c psRandom.c - -BUILT_SOURCES = psDataManipErrors.h -EXTRA_DIST = psDataManipErrors.dat psDataManipErrors.h dataManip.i - -psDataManipErrors.h: psDataManipErrors.dat - $(top_srcdir)/src/psParseErrorCodes --data=$? $@ - -pslibincludedir = $(includedir) -pslibinclude_HEADERS = \ - psConstants.h \ - psStats.h \ - psFunctions.h \ - psMatrix.h \ - psBinaryOp.h \ - psUnaryOp.h \ - psVectorFFT.h \ - psMinimize.h \ - psRandom.h - Index: unk/psLib/src/dataManip/dataManip.i =================================================================== --- /trunk/psLib/src/dataManip/dataManip.i (revision 4545) +++ (revision ) @@ -1,11 +1,0 @@ -/* dataManip headers */ -%include "psConstants.h" -%include "psDataManipErrors.h" -%include "psFunctions.h" -%include "psMatrix.h" -%include "psBinaryOp.h" -%include "psUnaryOp.h" -%include "psMinimize.h" -%include "psRandom.h" -%include "psStats.h" -%include "psVectorFFT.h" Index: unk/psLib/src/dataManip/psBinaryOp.c =================================================================== --- /trunk/psLib/src/dataManip/psBinaryOp.c (revision 4545) +++ (revision ) @@ -1,582 +1,0 @@ -/** @file psBinaryOp.c - * - * @brief Provides binary functions for simple matrix and vector element operations. Functions - * include: - * - * Addition (+) - * Subtraction (-) - * Multiplication (*) - * Division (/) - * Power (^) - * Minimum (min) - * Maximum (max) - * Absolute value (abs) - * Exponent (exp) - * Natural Log (ln) - * Power of 10 (ten) - * Log (log) - * Sine (sin or dsin) - * Cosine (cos or dcos) - * Tangent (tan or dtan) - * Arcsine (asin or dasin) - * Arccosine (acos or dacos) - * Arctan (atan or datan) - * - * Currently only vector-vector and image-image binary operations are supported. - * - * @ingroup MatrixArithmetic - * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -/****************************************************************************** - * INCLUDE FILES * - ******************************************************************************/ -#include -#include -#include - -#include "psMemory.h" -#include "psError.h" -#include "psImage.h" -#include "psVector.h" -#include "psScalar.h" -#include "psLogMsg.h" -#include "psConstants.h" -#include "psDataManipErrors.h" - -/***************************************************************************** - * FUNCTION IMPLEMENTATION - LOCAL * - *****************************************************************************/ - -// Conversion for degrees to radians -#define D2R 0.01745329252111111 /* PI/180 */ - -// Conversion for radians to degrees -#define R2D 57.29577950924861 /* 180.0/PI */ - -// Binary SCALAR_XXXX operations -#define SCALAR_SCALAR(OUT,IN1,OP,IN2,TYPE) \ -{ \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - ps##TYPE *i2 = NULL; \ - o = &((psScalar* )OUT)->data.TYPE; \ - i1 = &((psScalar* )IN1)->data.TYPE; \ - i2 = &((psScalar* )IN2)->data.TYPE; \ - *o = OP; \ -} - -#define SCALAR_VECTOR(OUT,IN1,OP,IN2,TYPE) \ -{ \ - psS32 i = 0; \ - psS32 npt = 0; \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - ps##TYPE *i2 = NULL; \ - npt = ((psVector* )IN2)->n; \ - o = ((psVector* )OUT)->data.TYPE; \ - i1 = &((psScalar* )IN1)->data.TYPE; \ - i2 = ((psVector* )IN2)->data.TYPE; \ - for (i=0; i < npt; i++, o++, i2++) { \ - *o = OP; \ - } \ -} - -#define SCALAR_IMAGE(OUT,IN1,OP,IN2,TYPE) \ -{ \ - psS32 i = 0; \ - psS32 j = 0; \ - psS32 numRows = 0; \ - psS32 numCols = 0; \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - ps##TYPE *i2 = NULL; \ - numRows = ((psImage* )IN2)->numRows; \ - numCols = ((psImage* )IN2)->numCols; \ - for(j = 0; j < numCols; j++) { \ - o = ((psImage* )OUT)->data.TYPE[j]; \ - i1 = &((psScalar* )IN1)->data.TYPE; \ - i2 = ((psImage* )IN2)->data.TYPE[j]; \ - for(i = 0; i < numRows; i++, o++, i2++) { \ - *o = OP; \ - } \ - } \ -} - -// Binary VECTOR_XXXX operations -#define VECTOR_SCALAR(OUT,IN1,OP,IN2,TYPE) \ -{ \ - psS32 i = 0; \ - psS32 n1 = 0; \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - ps##TYPE *i2 = NULL; \ - n1 = ((psVector* )IN1)->n; \ - o = ((psVector* )OUT)->data.TYPE; \ - i1 = ((psVector* )IN1)->data.TYPE; \ - i2 = &((psScalar* )IN2)->data.TYPE; \ - for (i=0; i < n1; i++, o++, i1++) { \ - *o = OP; \ - } \ -} - -#define VECTOR_VECTOR(OUT,IN1,OP,IN2,TYPE) \ -{ \ - psS32 i = 0; \ - psS32 n1 = 0; \ - psS32 n2 = 0; \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - ps##TYPE *i2 = NULL; \ - n1 = ((psVector* )IN1)->n; \ - n2 = ((psVector* )IN2)->n; \ - if(n1 != n2) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - PS_ERRORTEXT_psMatrix_COUNT_DIFFERS, \ - n1, n2); \ - if (OUT != IN1 && OUT != IN2) { \ - psFree(OUT); \ - } \ - return NULL; \ - } \ - o = ((psVector* )OUT)->data.TYPE; \ - i1 = ((psVector* )IN1)->data.TYPE; \ - i2 = ((psVector* )IN2)->data.TYPE; \ - for (i=0; i < n1; i++, o++, i1++, i2++) { \ - *o = OP; \ - } \ -} - -#define VECTOR_IMAGE(OUT,IN1,OP,IN2,TYPE) \ -{ \ - psS32 i = 0; \ - psS32 j = 0; \ - psS32 n1 = 0; \ - psS32 numRows2 = 0; \ - psS32 numCols2 = 0; \ - psDimen dim1 = 0; \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - ps##TYPE *i2 = NULL; \ - n1 = ((psVector* )IN1)->n; \ - dim1 = ((psVector* )IN1)->type.dimen; \ - numRows2 = ((psImage* )IN2)->numRows; \ - numCols2 = ((psImage* )IN2)->numCols; \ - \ - if(dim1 == PS_DIMEN_VECTOR) { /* Regular vectors */ \ - if(n1!=numRows2) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - PS_ERRORTEXT_psMatrix_COUNT_DIFFERS, \ - n1, numRows2); \ - if (OUT != IN1 && OUT != IN2) { \ - psFree(OUT); \ - } \ - return NULL; \ - } \ - \ - i1 = ((psVector* )IN1)->data.TYPE; \ - for(j = 0; j < numRows2; j++, i1++) { \ - o = ((psImage* )OUT)->data.TYPE[j]; \ - i2 = ((psImage* )IN2)->data.TYPE[j]; \ - for(i = 0; i < numCols2; i++, o++, i2++) { \ - *o = OP; \ - } \ - } \ - } else { /* Transposed vectors */ \ - if(n1!=numCols2) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - PS_ERRORTEXT_psMatrix_COUNT_DIFFERS, \ - n1, numCols2); \ - if (OUT != IN1 && OUT != IN2) { \ - psFree(OUT); \ - } \ - return NULL; \ - } \ - \ - for(j = 0; j < numRows2; j++) { \ - o = ((psImage* )OUT)->data.TYPE[j]; \ - i1 = ((psVector* )IN1)->data.TYPE; \ - i2 = ((psImage* )IN2)->data.TYPE[j]; \ - for(i = 0; i < numCols2; i++, o++, i1++, i2++) { \ - *o = OP; \ - } \ - } \ - } \ -} - -// Binary IMAGE_XXXX operations -#define IMAGE_SCALAR(OUT,IN1,OP,IN2,TYPE) \ -{ \ - psS32 i = 0; \ - psS32 j = 0; \ - psS32 numRows = 0; \ - psS32 numCols = 0; \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - ps##TYPE *i2 = NULL; \ - numRows = ((psImage* )IN1)->numRows; \ - numCols = ((psImage* )IN1)->numCols; \ - for(j = 0; j < numRows; j++) { \ - o = ((psImage* )OUT)->data.TYPE[j]; \ - i1 = ((psImage* )IN1)->data.TYPE[j]; \ - i2 = &((psScalar* )IN2)->data.TYPE; \ - for(i = 0; i < numCols; i++, o++, i1++) { \ - *o = OP; \ - } \ - } \ -} - -#define IMAGE_VECTOR(OUT,IN1,OP,IN2,TYPE) \ -{ \ - psS32 i = 0; \ - psS32 j = 0; \ - psS32 n2 = 0; \ - psS32 numRows1 = 0; \ - psS32 numCols1 = 0; \ - psDimen dim2 = 0; \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - ps##TYPE *i2 = NULL; \ - n2 = ((psVector* )IN2)->n; \ - dim2 = ((psVector* )IN2)->type.dimen; \ - numRows1 = ((psImage* )IN1)->numRows; \ - numCols1 = ((psImage* )IN1)->numCols; \ - \ - if(dim2 == PS_DIMEN_VECTOR) { /* Regular vectors */ \ - if(n2!=numRows1) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - PS_ERRORTEXT_psMatrix_COUNT_DIFFERS, \ - n2, numRows1); \ - if (OUT != IN1 && OUT != IN2) { \ - psFree(OUT); \ - } \ - return NULL; \ - } \ - \ - i2 = ((psVector* )IN2)->data.TYPE; \ - for(j = 0; j < numRows1; j++, i1++) { \ - o = ((psImage* )OUT)->data.TYPE[j]; \ - i1 = ((psImage* )IN1)->data.TYPE[j]; \ - for(i = 0; i < numCols1; i++, o++, i1++) { \ - *o = OP; \ - } \ - } \ - } else { /* Transposed vectors */ \ - if(n2!=numCols1) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - PS_ERRORTEXT_psMatrix_COUNT_DIFFERS, \ - n2, numCols1); \ - if (OUT != IN1) { \ - psFree(OUT); \ - } \ - return NULL; \ - } \ - \ - for(j = 0; j < numRows1; j++) { \ - o = ((psImage* )OUT)->data.TYPE[j]; \ - i1 = ((psVector* )IN2)->data.TYPE; \ - i2 = ((psImage* )IN1)->data.TYPE[j]; \ - for(i = 0; i < numCols1; i++, o++, i2++, i1++) { \ - *o = OP; \ - } \ - } \ - } \ -} - -#define IMAGE_IMAGE(OUT,IN1,OP,IN2,TYPE) \ -{ \ - psS32 i = 0; \ - psS32 j = 0; \ - psS32 numRows1 = 0; \ - psS32 numCols1 = 0; \ - psS32 numRows2 = 0; \ - psS32 numCols2 = 0; \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - ps##TYPE *i2 = NULL; \ - numRows1 = ((psImage* )IN1)->numRows; \ - numCols1 = ((psImage* )IN1)->numCols; \ - numRows2 = ((psImage* )IN2)->numRows; \ - numCols2 = ((psImage* )IN2)->numCols; \ - if(numRows1!=numRows2 || numCols1!=numCols2) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - PS_ERRORTEXT_psMatrix_IMAGE_SIZE_DIFFERS, \ - numCols1, numRows1, numCols2, numRows2); \ - if (OUT != IN1 && OUT != IN2) { \ - psFree(OUT); \ - } \ - return NULL; \ - } \ - for(j = 0; j < numRows1; j++) { \ - o = ((psImage* )OUT)->data.TYPE[j]; \ - i1 = ((psImage* )IN1)->data.TYPE[j]; \ - i2 = ((psImage* )IN2)->data.TYPE[j]; \ - for(i = 0; i < numCols1; i++, o++, i1++, i2++) { \ - *o = OP; \ - } \ - } \ -} - -// Preprocessor macro function to create arithmetic function based on input type -#define BINARY_TYPE(DIM1,DIM2,OUT,IN1,OP,IN2) \ -switch (IN1->type) { \ -case PS_TYPE_U8: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,U8); \ - break; \ -case PS_TYPE_U16: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,U16); \ - break; \ -case PS_TYPE_U32: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,U32); \ - break; \ -case PS_TYPE_U64: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,U64); \ - break; \ -case PS_TYPE_S8: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,S8); \ - break; \ -case PS_TYPE_S16: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,S16); \ - break; \ -case PS_TYPE_S32: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,S32); \ - break; \ -case PS_TYPE_S64: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,S64); \ - break; \ -case PS_TYPE_F32: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,F32); \ - break; \ -case PS_TYPE_F64: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,F64); \ - break; \ -case PS_TYPE_C32: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,C32); \ - break; \ -case PS_TYPE_C64: \ - DIM1##_##DIM2(OUT,IN1,OP,IN2,C64); \ - break; \ -default: \ - /* char* strType; \ - PS_TYPE_NAME(strType,IN1->type); \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - PS_ERRORTEXT_psMatrix_TYPE_MISMATCH, \ - strType); */ \ - if (OUT != IN1 && OUT != IN2) { \ - psFree(OUT); \ - } \ - return NULL; \ -} - -// Preprocessor macro function to create arithmetic function operation name -#define BINARY_OP(DIM1,DIM2,OUT,IN1,OP,IN2) \ -if(!strncmp(OP, "=", 1)) { \ - BINARY_TYPE(DIM1,DIM2,OUT,IN1,*i2,IN2); \ -} else if(!strncmp(OP, "+", 1)) { \ - BINARY_TYPE(DIM1,DIM2,OUT,IN1,*i1 + *i2,IN2); \ -} else if(!strncmp(OP, "-", 1)) { \ - BINARY_TYPE(DIM1,DIM2,OUT,IN1,*i1 - *i2,IN2); \ -} else if(!strncmp(OP, "*", 1)) { \ - BINARY_TYPE(DIM1,DIM2,OUT,IN1,*i1 * *i2,IN2); \ -} else if(!strncmp(OP, "/", 1)) { \ - BINARY_TYPE(DIM1,DIM2,OUT,IN1,*i1 / *i2,IN2); \ -} else if(!strncmp(OP, "^", 1)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN1->type)) { \ - BINARY_TYPE(DIM1,DIM2,OUT,IN1,cpow(*i1,*i2),IN2); \ - } else { \ - BINARY_TYPE(DIM1,DIM2,OUT,IN1,pow(*i1,*i2),IN2); \ - } \ -} else if(!strncmp(OP, "min", 3)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN1->type)) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - PS_ERRORTEXT_psMatrix_MIN_COMPLEX_SUPPORT); \ - if (OUT != IN1 && OUT != IN2) { \ - psFree(OUT); \ - } \ - return NULL; \ - } else { \ - BINARY_TYPE(DIM1,DIM2,OUT,IN1,fmin(*i1,*i2),IN2); \ - } \ -} else if(!strncmp(OP, "max", 3)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN1->type)) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - PS_ERRORTEXT_psMatrix_MAX_COMPLEX_SUPPORT); \ - if (OUT != IN1 && OUT != IN2) { \ - psFree(OUT); \ - } \ - return NULL; \ - } else { \ - BINARY_TYPE(DIM1,DIM2,OUT,IN1,fmax(*i1,*i2),IN2); \ - } \ -} else { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - PS_ERRORTEXT_psMatrix_OPERATION_UNSUPPORTED, \ - OP); \ - if (OUT != IN1 && OUT != IN2) { \ - psFree(OUT); \ - } \ - return NULL; \ -} - -psMathType* psBinaryOp(psPtr out, const psPtr in1, const char *op, const psPtr in2) -{ - - psVector* input1 = (psVector* ) in1; - psVector* input2 = (psVector* ) in2; - - #define psBinaryOp_EXIT { \ - if (out != in1 && out != in2) { \ - psFree(out); \ - } \ - return NULL; \ - } - - PS_ASSERT_GENERAL_PTR_NON_NULL(input1, psBinaryOp_EXIT); - PS_ASSERT_GENERAL_PTR_NON_NULL(input2, psBinaryOp_EXIT); - PS_ASSERT_GENERAL_PTR_NON_NULL(op, psBinaryOp_EXIT); - - PS_ASSERT_PTRS_TYPE_EQUAL_GENERAL(input1,input2, psBinaryOp_EXIT); - - PS_ASSERT_PTR_DIMEN_GENERAL_NOT(input1, PS_DIMEN_OTHER, psBinaryOp_EXIT); - PS_ASSERT_PTR_DIMEN_GENERAL_NOT(input2, PS_DIMEN_OTHER, psBinaryOp_EXIT); - - psType* psType1 = (psType*)in1; - psType* psType2 = (psType*)in2; - psDimen dim1 = psType1->dimen; - psDimen dim2 = psType2->dimen; - psElemType elType1 = psType1->type; - psElemType elType2 = psType2->type; - - if (dim1 == PS_DIMEN_VECTOR || dim1 == PS_DIMEN_TRANSV) { - if (((psVector* ) in1)->n == 0) { - psLogMsg(__func__, PS_LOG_WARN, "Vector contains zero elements"); - } - } else if (dim1 == PS_DIMEN_IMAGE) { - if (((psImage* ) in1)->numCols == 0 || ((psImage* ) in1)->numRows == 0) { - psLogMsg(__func__, PS_LOG_WARN, "Image contains zero length row or cols"); - } - } - - if (dim2 == PS_DIMEN_VECTOR || dim2 == PS_DIMEN_TRANSV) { - if (((psVector* ) in2)->n == 0) { - psLogMsg(__func__, PS_LOG_WARN, "Vector contains zero elements"); - } - } else if (dim2 == PS_DIMEN_IMAGE) { - if (((psImage* ) in2)->numCols == 0 || ((psImage* ) in2)->numRows == 0) { - psLogMsg(__func__, PS_LOG_WARN, "Image contains zero length row or cols"); - } - } - - if (dim1 == PS_DIMEN_SCALAR) { - if ( out != NULL && ((psType*)out)->dimen != dim2) { - if (out != in1 && out != in2) { - psFree(out); - } - out = NULL; - } - if (dim2 == PS_DIMEN_SCALAR) { - if (out == NULL || ((psScalar*)out)->type.type != elType1) { - if (out != in1 && out != in2) { - psFree(out); - } - out = psScalarAlloc(0.0,elType1); - } - BINARY_OP(SCALAR, SCALAR, out, psType1, op, psType2); // scalar op scalar - } else if (dim2 == PS_DIMEN_VECTOR || dim2 == PS_DIMEN_TRANSV) { - out = psVectorRecycle(out,((psVector*)in2)->n,elType1); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psMatrix_OUTPUT_VECTOR_NOT_CREATED); - return NULL; - } - BINARY_OP(SCALAR, VECTOR, out, psType1, op, psType2); // scalar op vector - } else if (dim2 == PS_DIMEN_IMAGE) { - out = psImageRecycle(out, ((psImage* ) in2)->numCols, ((psImage* ) in2)->numRows,elType1); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psMatrix_OUTPUT_IMAGE_NOT_CREATED); - return NULL; - } - BINARY_OP(SCALAR, IMAGE, out, psType1, op, psType2); // scalar op image - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psMatrix_DIMEN_INVALID, - "in2",dim2); - psBinaryOp_EXIT; - } - } else if (dim1 == PS_DIMEN_VECTOR || dim1 == PS_DIMEN_TRANSV) { - if (dim2 == PS_DIMEN_SCALAR) { - out = psVectorRecycle(out,((psVector*)in1)->n,elType1); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psMatrix_OUTPUT_VECTOR_NOT_CREATED); - return NULL; - } - BINARY_OP(VECTOR, SCALAR, out, psType1, op, psType2); // vector op scalar - } else if (dim2 == PS_DIMEN_VECTOR || dim2 == PS_DIMEN_TRANSV) { - out = psVectorRecycle(out,((psVector*)in2)->n,elType2); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psMatrix_OUTPUT_VECTOR_NOT_CREATED); - return NULL; - } - BINARY_OP(VECTOR, VECTOR, out, psType1, op, psType2); // vector op vector - } else if (dim2 == PS_DIMEN_IMAGE) { - out = psImageRecycle(out, ((psImage* ) in2)->numCols, ((psImage* ) in2)->numRows, elType2); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psMatrix_OUTPUT_IMAGE_NOT_CREATED); - return NULL; - } - BINARY_OP(VECTOR, IMAGE, out, psType1, op, psType2); // vector op image - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psMatrix_DIMEN_INVALID, - "in2",dim2); - psBinaryOp_EXIT; - } - } else if (dim1 == PS_DIMEN_IMAGE) { - out = psImageRecycle(out, ((psImage*)in1)->numCols, ((psImage*)in1)->numRows, elType1); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psMatrix_OUTPUT_IMAGE_NOT_CREATED); - return NULL; - } - if (dim2 == PS_DIMEN_SCALAR) { - BINARY_OP(IMAGE, SCALAR, out, psType1, op, psType2); // image op scalar - } else if (dim2 == PS_DIMEN_VECTOR || dim2 == PS_DIMEN_TRANSV) { - BINARY_OP(IMAGE, VECTOR, out, psType1, op, psType2); // image op vector - } else if (dim2 == PS_DIMEN_IMAGE) { - BINARY_OP(IMAGE, IMAGE, out, psType1, op, psType2); // image op image - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psMatrix_DIMEN_INVALID, - "in2",dim2); - psBinaryOp_EXIT; - } - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psMatrix_DIMEN_INVALID, - "in1",dim1); - psBinaryOp_EXIT; - } - - // Automtically free psScalar types, since they are usually allocated in the argument list when this - // function is called, provided that the input is not the output. - if(psType1->dimen==PS_DIMEN_SCALAR && in1!=out) { - psFree(in1); - } - - if(psType2->dimen==PS_DIMEN_SCALAR && in2!=out) { - psFree(in2); - } - - return out; -} Index: unk/psLib/src/dataManip/psBinaryOp.h =================================================================== --- /trunk/psLib/src/dataManip/psBinaryOp.h (revision 4545) +++ (revision ) @@ -1,66 +1,0 @@ -/** @file psBinaryOp.h - * - * @brief Provides binary functions for simple matrix and vector element operations. Functions - * include: - * - * Addition (+) - * Subtraction (-) - * Multiplication (*) - * Division (/) - * Power (^) - * Minimum (min) - * Maximum (max) - * Absolute value (abs) - * Exponent (exp) - * Natural Log (ln) - * Power of 10 (ten) - * Log (log) - * Sine (sin or dsin) - * Cosine (cos or dcos) - * Tangent (tan or dtan) - * Arcsine (asin or dasin) - * Arccosine (acos or dacos) - * Arctan (atan or datan) - * - * Currently only vector-vector and image-image binary operations are supported. - * - * @ingroup MatrixArithmetic - * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PSBINARY_OP_H -#define PSBINARY_OP_H - -/// @addtogroup MatrixArithmetic -/// @{ - -/** Perform simple binary arithmetic with images or vectors - * - * Performs addition, subtraction, multiplication, division, power, minumum, and maximum arithmetic - * operations with images and vectors. Uses the form: - * - * out = in1 op in2, - * - * Where op is: "=", "+", "-", "*", "/", "^", "min", or "max" - * - * This function only supports vector-vector or image-image operations. - * - * @return psType* : Pointer to either psImage or psVector. - */ -psMathType* psBinaryOp( - psPtr out, ///< Output type, either psImage or psVector. - const psPtr in1, ///< First input, either psImage or psVector. - const char *op, ///< Operator. - const psPtr in2 ///< Second input, either psImage or psVector. -); - -/// @} - -#endif // #ifndef PSBINARY_OP_H Index: unk/psLib/src/dataManip/psConstants.h =================================================================== --- /trunk/psLib/src/dataManip/psConstants.h (revision 4545) +++ (revision ) @@ -1,735 +1,0 @@ -/** @file psConstants.h - * - * This file will hold definitions of various constants as well as common - * macros used throughout psLib. - * - * @author GLG, MHPCC - * - * @version $Revision: 1.74 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-28 23:28:31 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - * - * XXX: Add parenthesis around all arguments so that these macros can be - * called with complex expressions. - * - * XXX: All functions which use the PS_CHECK macros must be scrutinized so - * that we ensure that an argument which is expected to be output is - * psFree'ed before reurning NULL. - * - * XXX: The macros have a name similar to PS_CHECK_CONDITION() and generally - * throw a psError if the CONDITION is true. However, some throw the error - * if the CONDITION is false. This should be consistant. - * - * XXX: rename all these with form PS_ASSERT_CONDITION(). - * - */ - -#include // for M_PI - -/***************************************************************************** -These constants are used by various functions in the psLib. - *****************************************************************************/ -#define PS_DETERMINE_BRACKET_STEP_SIZE 0.10 -#define PS_MAX_LMM_ITERATIONS 100 -#define PS_MAX_MINIMIZE_ITERATIONS 100 -#define PS_LEFT_SPLINE_DERIV 0.0 -#define PS_RIGHT_SPLINE_DERIV 0.0 -/***************************************************************************** -These are common mathimatical constants used by various functions in the psLib. - *****************************************************************************/ -#ifndef M_PI -#define M_PI 3.1415926535897932384626433832795029 /* pi */ -#define M_PI_2 1.5707963267948966192313216916397514 /* pi/2 */ -#define M_PI_4 0.7853981633974483096156608458198757 /* pi/4 */ -#define M_1_PI 0.3183098861837906715377675267450287 /* 1/pi */ -#define M_2_PI 0.6366197723675813430755350534900574 /* 2/pi */ -#endif // #ifndef M_PI - -#define DEG_TO_RAD(DEGREES) ((DEGREES) * M_PI / 180.0) -#define MIN_TO_RAD(MINUTES) ((MINUTES) * M_PI / (180.0 * 60.0)) -#define SEC_TO_RAD(SECONDS) ((SECONDS) * M_PI / (180.0 * 60.0 * 60.0)) -#define RAD_TO_DEG(RADIANS) ((RADIANS) * 180.0 / M_PI) -#define RAD_TO_MIN(RADIANS) ((RADIANS) * 180.0 * 60.0 / M_PI) -#define RAD_TO_SEC(RADIANS) ((RADIANS) * 180.0 * 60.0 * 60.0 / M_PI) - -/***************************************************************************** - -*****************************************************************************/ - -#define PS_ASSERT_INT_UNEQUAL(NAME1, NAME2, RVAL) \ -if ((NAME1) == (NAME2)) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s and %s are equal.", \ - #NAME1, #NAME2); \ - return(RVAL); \ -} - -#define PS_ASSERT_INT_EQUAL(NAME1, NAME2, RVAL) \ -if ((NAME1) != (NAME2)) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s and %s are not equal.", \ - #NAME1, #NAME2); \ - return(RVAL); \ -} - -#define PS_ASSERT_INT_NONNEGATIVE(NAME, RVAL) \ -if ((NAME) < 0) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s is less than 0.", #NAME); \ - return(RVAL); \ -} - -#define PS_ASSERT_INT_POSITIVE(NAME, RVAL) \ -if ((NAME) < 1) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s is 0 or less.", #NAME); \ - return(RVAL); \ -} - -#define PS_ASSERT_INT_ZERO(NAME, RVAL) \ -if ((NAME) != 0) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s is 0.", #NAME); \ - return(RVAL); \ -} - -#define PS_ASSERT_INT_NONZERO(NAME, RVAL) \ -if ((NAME) == 0) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s is 0.", #NAME); \ - return(RVAL); \ -} - -// XXX: Where did these int casts come from? -#define PS_ASSERT_INT_WITHIN_RANGE(NAME, LOWER, UPPER, RVAL) \ -if ((int)(NAME) < LOWER || (int)(NAME) > UPPER) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s, %d, is out of range. Must be between %d and %d.", \ - #NAME,(int)NAME,LOWER,UPPER); \ - return RVAL; \ -} - -#define PS_ASSERT_INT_LESS_THAN(VAR1, VAR2, RVAL) \ -if (!(VAR1 < VAR2)) { \ - psError(PS_ERR_UNKNOWN, true, \ - "Error: %s is not less than %s (%d, %d)", #VAR1, #VAR2, VAR1, VAR2); \ - return(RVAL); \ -} - -#define PS_ASSERT_INT_LESS_THAN_OR_EQUAL(VAR1, VAR2, RVAL) \ -if (!(VAR1 <= VAR2)) { \ - psError(PS_ERR_UNKNOWN, true, \ - "Error: %s is not less than %s (%d, %d)", #VAR1, #VAR2, VAR1, VAR2); \ - return(RVAL); \ -} - -#define PS_ASSERT_INT_LARGER_THAN(NAME1, NAME2, RVAL) \ -if (!((NAME1) > (NAME2))) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: !(%s > %s) (%d %d).", \ - #NAME1, #NAME2, NAME1, NAME2); \ - return(RVAL); \ -} - -#define PS_ASSERT_INT_LARGER_THAN_OR_EQUAL(NAME1, NAME2, RVAL) \ -if (!((NAME1) >= (NAME2))) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: !(%s >= %s) (%d %d).", \ - #NAME1, #NAME2, NAME1, NAME2); \ - return(RVAL); \ -} -#define PS_ASSERT_FLOAT_LARGER_THAN(NAME1, NAME2, RVAL) \ -if (!((NAME1) > (NAME2))) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: !(%s > %s) (%f %f).", \ - #NAME1, #NAME2, NAME1, NAME2); \ - return(RVAL); \ -} - -#define PS_ASSERT_FLOAT_LARGER_THAN_OR_EQUAL(NAME1, NAME2, RVAL) \ -if (!((NAME1) >= (NAME2))) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: !(%s >= %s) (%f %f).", \ - #NAME1, #NAME2, NAME1, NAME2); \ - return(RVAL); \ -} - -// Produce an error if (NAME1 > NAME2) -// XXX: Get rid of this, use above macros. -#define PS_INT_COMPARE(NAME1, NAME2, RVAL) \ -if ((NAME1) > (NAME2)) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: (%s > %s) (%d %d).", \ - #NAME1, #NAME2, NAME1, NAME2); \ - return(RVAL); \ -} - -// Produce an error if ((NAME1 > NAME2) -// XXX: Get rid of this, use above macros. -#define PS_FLOAT_COMPARE(NAME1, NAME2, RVAL) \ -if ((NAME1) > (NAME2)) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: (%s > %s) (%f %f)", \ - #NAME1, #NAME2, NAME1, NAME2); \ - return(RVAL); \ -} - -#define PS_ASSERT_FLOAT_NON_EQUAL(NAME1, NAME2, RVAL) \ -if (fabs((NAME2) - (NAME1)) < FLT_EPSILON) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s and %s are equal.", \ - #NAME1, #NAME2); \ - return(RVAL); \ -} - -#define PS_ASSERT_FLOAT_EQUAL(NAME1, NAME2, RVAL) \ -if (fabs((NAME2) - (NAME1)) > FLT_EPSILON) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s and %s are not equal.", \ - #NAME1, #NAME2); \ - return(RVAL); \ -} - -// Return an error if the arg is lies outside the supplied range. -#define PS_ASSERT_FLOAT_WITHIN_RANGE(NAME, LOWER, UPPER, RVAL) \ -if ((NAME) < (LOWER) || (NAME) > (UPPER)) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s, %f, is out of range. Must be between %f and %f.", \ - #NAME, NAME, LOWER, UPPER); \ - return RVAL; \ -} - -// Return an error if the arg lies outside the supplied range -#define PS_ASSERT_LONG_WITHIN_RANGE(NAME, LOWER, UPPER, RVAL) \ -if ((NAME) < (LOWER) || (NAME) > (UPPER)) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Error: %s, %lld, is out of range.", \ - #NAME, NAME, LOWER, UPPER); \ - return RVAL; \ -} - -/***************************************************************************** -Macros which take a generic psLib type and determine if it is NULL, or has -the wrong type. -*****************************************************************************/ -#define PS_ASSERT_PTR_NON_NULL(NAME, RVAL) PS_ASSERT_GENERAL_PTR_NON_NULL(NAME, return RVAL) -#define PS_ASSERT_GENERAL_PTR_NON_NULL(NAME, CLEANUP) \ -if ((NAME) == NULL) { \ - psError(PS_ERR_BAD_PARAMETER_NULL, true, \ - "Unallowable operation: %s is NULL.", \ - #NAME); \ - CLEANUP; \ -} - -#define PS_ASSERT_PTR_TYPE(NAME, TYPE, RVAL) \ -if ((NAME)->type.type != TYPE) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "Unallowable operation: %s has incorrect type.", \ - #NAME); \ - return(RVAL); \ -} - -#define PS_ASSERT_PTR_DIMEN(NAME, DIMEN, RVAL) PS_ASSERT_GENERAL_PTR_DIMEN(NAME, DIMEN, return RVAL) -#define PS_ASSERT_GENERAL_PTR_DIMEN(NAME, DIMEN, CLEANUP) \ -if ((NAME)->type.dimen != DIMEN) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "Unallowable operation: %s has incorrect dimensionality.", \ - #NAME); \ - CLEANUP; \ -} - -#define PS_ASSERT_PTR_DIMEN_GENERAL_NOT(NAME, DIMEN, CLEANUP) \ -if ((NAME)->type.dimen == DIMEN) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "Unallowable operation: %s has incorrect dimensionality.", \ - #NAME); \ - CLEANUP; \ -} - - -#define PS_ASSERT_PTRS_SIZE_EQUAL(PTR1, PTR2, RVAL) \ -if (PTR1->n != PTR2->n) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - "ptr %s has size %d, ptr %s has size %d.", \ - #PTR1, PTR1->n, #PTR2, PTR2->n); \ - return(RVAL); \ -} - -#define PS_ASSERT_PTR_TYPE_EQUAL(PTR1, PTR2, RVAL) PS_ASSERT_PTRS_TYPE_EQUAL_GENERAL(PTR1, PTR2, return RVAL) -#define PS_ASSERT_PTRS_TYPE_EQUAL_GENERAL(PTR1, PTR2, CLEANUP) \ -if (PTR1->type.type != PTR2->type.type) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "ptr %s has type %d, ptr %s has type %d.", \ - #PTR1, PTR1->type.type, #PTR2, PTR2->type.type); \ - CLEANUP; \ -} - - -/***************************************************************************** - PS_VECTOR macros: - *****************************************************************************/ -#define PS_ASSERT_VECTOR_NON_NULL(NAME, RVAL) PS_ASSERT_GENERAL_VECTOR_NON_NULL(NAME, return RVAL) -#define PS_ASSERT_GENERAL_VECTOR_NON_NULL(NAME, CLEANUP) \ -if ((NAME) == NULL || (NAME)->data.U8 == NULL) { \ - psError(PS_ERR_BAD_PARAMETER_NULL, true, \ - "Unallowable operation: psVector %s or its data is NULL.", \ - #NAME); \ - CLEANUP; \ -} \ - -#define PS_ASSERT_VECTOR_NON_EMPTY(NAME, RVAL) PS_ASSERT_GENERAL_VECTOR_NON_EMPTY(NAME, return RVAL) -#define PS_ASSERT_GENERAL_VECTOR_NON_EMPTY(NAME, CLEANUP) \ -if ((NAME)->n < 1) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - "Unallowable operation: psVector %s has no elements.", \ - #NAME); \ - CLEANUP; \ -} \ - -#define PS_ASSERT_VECTOR_TYPE_F32_OR_F64(NAME, RVAL) \ -if (((NAME)->type.type != PS_TYPE_F32) && ((NAME)->type.type != PS_TYPE_F64)) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "psVector %s: bad type(%d)", \ - #NAME, NAME->type.type); \ - return(RVAL); \ -} \ - -#define PS_ASSERT_VECTOR_TYPE_S16_S32_F32(NAME, RVAL) \ -if (((NAME)->type.type != PS_TYPE_S16) && ((NAME)->type.type != PS_TYPE_S32) && ((NAME)->type.type != PS_TYPE_F32)) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "psVector %s: bad type(%d)", \ - #NAME, NAME->type.type); \ - return(RVAL); \ -} \ - -#define PS_ASSERT_VECTOR_TYPE(NAME, TYPE, RVAL) \ -if ((NAME)->type.type != TYPE) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "Unallowable operation: psVector %s has incorrect type.", \ - #NAME); \ - return(RVAL); \ -} - -#define PS_ASSERT_VECTORS_SIZE_EQUAL(VEC1, VEC2, RVAL) \ -if (VEC1->n != VEC2->n) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - "psVector %s has size %d, psVector %s has size %d.", \ - #VEC1, VEC1->n, #VEC2, VEC2->n); \ - return(RVAL); \ -} - -#define PS_ASSERT_VECTOR_SIZE(VEC, SIZE, RVAL) \ -if (VEC->n != SIZE) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - "psVector %s has size %d, should be %d." \ - #VEC, VEC->n, SIZE); \ - return(RVAL); \ -} - -#define PS_ASSERT_VECTOR_TYPE_EQUAL(VEC1, VEC2, RVAL) \ -if (VEC1->type.type != VEC2->type.type) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - "psVector %s has size %d, psVector %s has size %d.", \ - #VEC1, VEC1->type.type, #VEC2, VEC2->type.type); \ - return(RVAL); \ -} - -#define PS_VECTOR_F64_TO_F32(X64, X32) \ -psVector *X32 = psVectorAlloc(X64->n, PS_TYPE_F32); \ -for (int i=0;in;i++) { \ - X32->data.F32[i] = (float) X64->data.F64[i]; \ -} \ - -#define PS_VECTOR_F32_TO_F64(X32, X64) \ -psVector *X64 = psVectorAlloc(X32->n, PS_TYPE_F64); \ -for (int i=0;in;i++) { \ - X64->data.F64[i] = (float) X32->data.F32[i]; \ -} \ - -#define PS_VECTOR_PRINT_F32(NAME) \ -for (int my_i=0;my_i<(NAME)->n;my_i++) { \ - printf("%s->data.F32[%d] is %f\n", #NAME, my_i, (NAME)->data.F32[my_i]); \ -} \ -printf("\n"); \ - -#define PS_VECTOR_PRINT_F64(NAME) \ -for (int my_i=0;my_i<(NAME)->n;my_i++) { \ - printf("%s->data.F64[%d] is %f\n", #NAME, my_i, (NAME)->data.F64[my_i]); \ -} \ -printf("\n"); \ - - -#define PS_VECTOR_CONVERT_F64_TO_F32_STATIC(OLD, NEW_PTR32, NEW_STATIC32) \ -if (OLD->type.type == PS_TYPE_F32) { \ - NEW_PTR32 = (psVector *) OLD; \ -} else if (OLD->type.type == PS_TYPE_F64) { \ - NEW_STATIC32 = psVectorRecycle(NEW_STATIC32, OLD->n, PS_TYPE_F32); \ - p_psMemSetPersistent(NEW_STATIC32, true); \ - p_psMemSetPersistent(NEW_STATIC32->data.U8, true); \ - for (i=0; i < OLD->n ; i++) { \ - NEW_STATIC32->data.F32[i] = (float) OLD->data.F64[i]; \ - } \ - NEW_PTR32 = NEW_STATIC32; \ -} \ - -#define PS_VECTOR_CONVERT_F32_TO_F64_STATIC(OLD, NEW_PTR64, NEW_STATIC64) \ -if (OLD->type.type == PS_TYPE_F64) { \ - NEW_PTR64 = (psVector *) OLD; \ -} else if (OLD->type.type == PS_TYPE_F32) { \ - NEW_STATIC64 = psVectorRecycle(NEW_STATIC64, OLD->n, PS_TYPE_F64); \ - p_psMemSetPersistent(NEW_STATIC64, true); \ - p_psMemSetPersistent(NEW_STATIC64->data.U8, true); \ - for (i=0; i < OLD->n ; i++) { \ - NEW_STATIC64->data.F64[i] = (double) OLD->data.F32[i]; \ - } \ - NEW_PTR64 = NEW_STATIC64; \ -} \ - -#define PS_VECTOR_GEN_YERR_STATIC_F32(VEC, N) \ -VEC = psVectorRecycle(VEC, N, PS_TYPE_F32); \ -p_psMemSetPersistent(VEC, true); \ -p_psMemSetPersistent(VEC->data.U8, true); \ -for (int i=0;idata.F32[i] = 1.0; \ -} \ - -#define PS_VECTOR_GEN_YERR_STATIC_F64(VEC, N) \ -VEC = psVectorRecycle(VEC, N, PS_TYPE_F64); \ -p_psMemSetPersistent(VEC, true); \ -p_psMemSetPersistent(VEC->data.U8, true); \ -for (int i=0;idata.F64[i] = 1.0; \ -} \ - -#define PS_VECTOR_GEN_X_INDEX_STATIC_F32(VEC, N) \ -VEC = psVectorRecycle(VEC, N, PS_TYPE_F32); \ -p_psMemSetPersistent(VEC, true); \ -p_psMemSetPersistent(VEC->data.U8, true); \ -for (int i=0;idata.F32[i] = (float) i; \ -} \ - -#define PS_VECTOR_GEN_X_INDEX_STATIC_F64(VEC, N) \ -VEC = psVectorRecycle(VEC, N, PS_TYPE_F64); \ -p_psMemSetPersistent(VEC, true); \ -p_psMemSetPersistent(VEC->data.U8, true); \ -for (int i=0;idata.F64[i] = (float) i; \ -} \ - -#define PS_VECTOR_GEN_STATIC_RECYCLED(NAME, SIZE, TYPE) \ -static psVector *NAME = NULL; \ -(NAME) = psVectorRecycle((NAME), SIZE, TYPE); \ -p_psMemSetPersistent((NAME), true); \ -p_psMemSetPersistent((NAME)->data.U8, true); \ - -#define PS_VECTOR_DECLARE_ALLOC_STATIC(NAME, SIZE, TYPE) \ -static psVector *(NAME) = NULL; \ -if ((NAME) == NULL) { \ - (NAME) = psVectorAlloc(SIZE, TYPE); \ - p_psMemSetPersistent((NAME), true); \ -} \ - -#define PS_VECTOR_SET_U8(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->n ; i++) { \ - (NAME)->data.U8[i] = VALUE; \ -}\ - -#define PS_VECTOR_SET_U16(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->n ; i++) { \ - (NAME)->data.U16[i] = VALUE; \ -}\ - -#define PS_VECTOR_SET_U32(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->n ; i++) { \ - (NAME)->data.U32[i] = VALUE; \ -}\ - -#define PS_VECTOR_SET_U64(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->n ; i++) { \ - (NAME)->data.U64[i] = VALUE; \ -}\ - -#define PS_VECTOR_SET_S8(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->n ; i++) { \ - (NAME)->data.S8[i] = VALUE; \ -}\ - -#define PS_VECTOR_SET_S16(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->n ; i++) { \ - (NAME)->data.S16[i] = VALUE; \ -}\ - -#define PS_VECTOR_SET_S32(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->n ; i++) { \ - (NAME)->data.S32[i] = VALUE; \ -}\ - -#define PS_VECTOR_SET_S64(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->n ; i++) { \ - (NAME)->data.S64[i] = VALUE; \ -}\ - -#define PS_VECTOR_SET_F64(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->n ; i++) { \ - (NAME)->data.F64[i] = VALUE; \ -}\ - -#define PS_VECTOR_SET_F32(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->n ; i++) { \ - (NAME)->data.F32[i] = VALUE; \ -}\ - - -/***************************************************************************** - PS_POLY macros: -*****************************************************************************/ -#define PS_ASSERT_POLY_NON_NULL(NAME, RVAL) \ -if ((NAME) == NULL || (NAME)->coeff == NULL) { \ - psError(PS_ERR_BAD_PARAMETER_NULL, true, \ - "Unallowable operation: polynomial %s or its coeffs is NULL.", \ - #NAME); \ - return(RVAL); \ -} \ - -#define PS_ASSERT_POLY_TYPE(NAME, TYPE, RVAL) \ -if ((NAME)->type != TYPE) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "Unallowable operation: polynomial %s has wrong type.", #NAME); \ - return(RVAL); \ -} \ - -// The following macros declare and allocate a static polynomial of the -// specified order and type. - -#define PS_POLY_1D_DECLARE_ALLOC_STATIC(NAME, ORDER, TYPE) \ -static psPolynomial1D *(NAME) = NULL; \ -if ((NAME) == NULL) { \ - (NAME) = psPolynomial1DAlloc(ORDER, TYPE); \ - p_psMemSetPersistent((NAME), true); \ - p_psMemSetPersistent((NAME)->coeff, true); \ - p_psMemSetPersistent((NAME)->coeffErr, true); \ - p_psMemSetPersistent((NAME)->mask, true); \ -} \ - -#define PS_POLY_2D_DECLARE_ALLOC_STATIC(NAME, ORDER, TYPE) \ -static psPolynomial2D *(NAME) = NULL; \ -if ((NAME) == NULL) { \ - (NAME) = psPolynomial2DAlloc(ORDER, TYPE); \ - p_psMemSetPersistent((NAME), true); \ -} \ - -#define PS_POLY_3D_DECLARE_ALLOC_STATIC(NAME, ORDER, TYPE) \ -static psPolynomial3D *(NAME) = NULL; \ -if ((NAME) == NULL) { \ - (NAME) = psPolynomial3DAlloc(ORDER, TYPE); \ - p_psMemSetPersistent((NAME), true); \ -} \ - -#define PS_POLY_4D_DECLARE_ALLOC_STATIC(NAME, ORDER, TYPE) \ -static psPolynomial4D *(NAME) = NULL; \ -if ((NAME) == NULL) { \ - (NAME) = psPolynomial4DAlloc(ORDER, TYPE); \ - p_psMemSetPersistent((NAME), true); \ -} \ - -#define PS_POLY_1D_D_DECLARE_ALLOC_STATIC(NAME, ORDER, TYPE) \ -static psPolynomial1D *(NAME) = NULL; \ -if ((NAME) == NULL) { \ - (NAME) = psPolynomial1DAlloc(ORDER, TYPE); \ - p_psMemSetPersistent((NAME), true); \ -} \ - -#define PS_POLY_2D_D_DECLARE_ALLOC_STATIC(NAME, ORDER, TYPE) \ -static psPolynomial2D *(NAME) = NULL; \ -if ((NAME) == NULL) { \ - (NAME) = psPolynomial2DAlloc(ORDER, TYPE); \ - p_psMemSetPersistent((NAME), true); \ -} \ - -#define PS_POLY_3D_D_DECLARE_ALLOC_STATIC(NAME, ORDER, TYPE) \ -static psPolynomial3D *(NAME) = NULL; \ -if ((NAME) == NULL) { \ - (NAME) = psPolynomial3DAlloc(ORDER, TYPE); \ - p_psMemSetPersistent((NAME), true); \ -} \ - -#define PS_POLY_4D_D_DECLARE_ALLOC_STATIC(NAME, ORDER, TYPE) \ -static psPolynomial4D *(NAME) = NULL; \ -if ((NAME) == NULL) { \ - (NAME) = psPolynomial4DAlloc(ORDER, TYPE); \ - p_psMemSetPersistent((NAME), true); \ -} \ - -/***************************************************************************** - PS_IMAGE macros: -*****************************************************************************/ -#define PS_ASSERT_IMAGE_NON_NULL(NAME, RVAL) PS_ASSERT_GENERAL_IMAGE_NON_NULL(NAME, return RVAL) -#define PS_ASSERT_GENERAL_IMAGE_NON_NULL(NAME, CLEANUP) \ -if ((NAME) == NULL || (NAME)->data.V == NULL) { \ - psError(PS_ERR_BAD_PARAMETER_NULL, true, \ - "Unallowable operation: psImage %s or its data is NULL.", \ - #NAME); \ - CLEANUP; \ -} - -#define PS_ASSERT_IMAGE_NON_EMPTY(NAME, RVAL) PS_ASSERT_GENERAL_IMAGE_NON_EMPTY(NAME, return RVAL) -#define PS_ASSERT_GENERAL_IMAGE_NON_EMPTY(NAME, CLEANUP) \ -if ((NAME)->numCols < 1 || (NAME)->numRows < 1) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - "Unallowable operation: psImage %s has zero rows or columns (%dx%d).", \ - #NAME, (NAME)->numCols, (NAME)->numRows); \ - CLEANUP; \ -} - -#define PS_ASSERT_IMAGE_TYPE(NAME, TYPE, RVAL) \ -if ((NAME)->type.type != TYPE) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "Unallowable operation: psImage %s has incorrect type.", \ - #NAME); \ - return(RVAL); \ -} - -#define PS_ASSERT_IMAGES_SIZE_EQUAL(NAME1, NAME2, RVAL) \ -if (((NAME1)->numCols != (NAME2)->numCols) || \ - ((NAME1)->numRows != (NAME2)->numRows)) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - "Unallowable operation: psImages %s and %s are not the same size.", \ - #NAME1, #NAME2); \ - return(RVAL); \ -} - -#define PS_ASSERT_IMAGE_SIZE(NAME1, NUM_COLS, NUM_ROWS, RVAL) \ -if (((NAME1)->numCols != NUM_COLS) || \ - ((NAME1)->numRows != NUM_ROWS)) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - "Unallowable operation: psImages %s is not the correct size.", \ - #NAME1); \ - return(RVAL); \ -} - -#define PS_IMAGE_PRINT_F32(NAME) \ -printf("======== printing %s ========\n", #NAME); \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - printf("%.2f ", (NAME)->data.F32[i][j]); \ - } \ - printf("\n"); \ -}\ - -#define PS_IMAGE_PRINT_F64(NAME) \ -printf("======== printing %s ========\n", #NAME); \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - printf("%.2f ", (NAME)->data.F64[i][j]); \ - } \ - printf("\n"); \ -}\ - -#define PS_IMAGE_SET_U8(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - (NAME)->data.U8[i][j] = (VALUE); \ - } \ -}\ - -#define PS_IMAGE_SET_U16(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - (NAME)->data.U16[i][j] = (VALUE); \ - } \ -}\ - -#define PS_IMAGE_SET_U32(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - (NAME)->data.U32[i][j] = (VALUE); \ - } \ -}\ - -#define PS_IMAGE_SET_U64(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - (NAME)->data.U64[i][j] = (VALUE); \ - } \ -}\ - -#define PS_IMAGE_SET_S8(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - (NAME)->data.S8[i][j] = (VALUE); \ - } \ -}\ - -#define PS_IMAGE_SET_S16(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - (NAME)->data.S16[i][j] = (VALUE); \ - } \ -}\ - -#define PS_IMAGE_SET_S32(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - (NAME)->data.S32[i][j] = (VALUE); \ - } \ -}\ - -#define PS_IMAGE_SET_S64(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - (NAME)->data.S64[i][j] = (VALUE); \ - } \ -}\ - -#define PS_IMAGE_SET_F32(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - (NAME)->data.F32[i][j] = (VALUE); \ - } \ -}\ - -#define PS_IMAGE_SET_F64(NAME, VALUE) \ -for (int i = 0 ; i < (NAME)->numRows ; i++) { \ - for (int j = 0 ; j < (NAME)->numCols ; j++) { \ - (NAME)->data.F64[i][j] = (VALUE); \ - } \ -}\ - -/***************************************************************************** - PS_READOUT macros: -*****************************************************************************/ -#define PS_ASSERT_READOUT_NON_NULL(NAME, RVAL) \ -if ((NAME) == NULL || (NAME)->image == NULL) { \ - psError(PS_ERR_BAD_PARAMETER_NULL, true, \ - "Unallowable operation: psReadout %s or its data is NULL.", \ - #NAME); \ - return(RVAL); \ -} - -#define PS_ASSERT_READOUT_NON_EMPTY(NAME, RVAL) \ -if ((NAME)->image->numCols < 1 || (NAME)->image->numRows < 1) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - "Unallowable operation: psReadout %s or its data is NULL.", #NAME); \ - return(RVAL); \ -} - -#define PS_ASSERT_READOUT_TYPE(NAME, TYPE, RVAL) \ -if ((NAME)->image->type.type != TYPE) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "Unallowable operation: psImage %s has incorrect type.", #NAME); \ - return(RVAL); \ -} - -/***************************************************************************** - Misc. macros: - *****************************************************************************/ -#define PS_MAX(A, B) \ -(((A) > (B)) ? (A) : (B)) - -#define PS_MIN(A, B) \ -(((A) < (B)) ? (A) : (B)) - -#define PS_SQR(A) \ -((A) * (A)) Index: unk/psLib/src/dataManip/psDataManipErrors.dat =================================================================== --- /trunk/psLib/src/dataManip/psDataManipErrors.dat (revision 4545) +++ (revision ) @@ -1,55 +1,0 @@ -# -# This file is used to generate psDataManipErrors.h content -# -# -# Format is: -# ERRORNAME(one word) ERROR_TEXT -# -# N.B. in code, the ERRORNAME appears as PS_ERRORTEXT_ERRORNAME -#################################################################### -# -psVectorFFT_TYPE_NOT_F32_C32 Input psVector type, %s, is not supported. Valid data types are psF32 and psC32. -psVectorFFT_REVERSE_NOT_COMPLEX Input psVector (%s) is not complex. Reverse FFT operation requires a complex input. -psVectorFFT_FORWARD_NOT_REAL Input psVector (%s) is not real. Forward FFT operation requires a real input. -psVectorFFT_FFTW_PLAN_NULL Could not create a valid FFT plan to perform the transform. -psVectorFFT_TYPE_UNSUPPORTED Specified psVector type, %s, is not supported. -psVectorFFT_REAL_IMAG_TYPE_MISMATCH Real psVector type, %s, and imaginary psVector type, %s, must be the same. -psVectorFFT_REAL_IMAG_SIZE_MISMATCH Real psVector size, %d, and imaginary psVector size, %d, must be the same. -psVectorFFT_NONREAL_NOTSUPPORTED Input psVector type, %s, is required to be either psF32 or psF64. -psVectorFFT_NONCOMPLEX_NOTSUPPORTED Input psVector type, %s, is required to be either psC32 or psC64. -psVectorFFT_DIRECTION_NOTSET Must specify the direction as either PS_FFT_FORWARD or PS_FFT_REVERSE. -# -psStats_NOT_F32_F64 Invalid data type, %s. Only psF32 and psF64 data types are supported. -psStats_VECTOR_TYPE_UNSUPPORTED Input psVector type, %s, is not supported. -psStats_YVAL_OUT_OF_RANGE Specified yVal, %g, is not within y-range, %g to %g. -psStats_ROBUST_QUARTILE_BINS_FAILED Could not determine the robust lower/upper quartile bin numbers. -psStats_STATS_FAILED Failed to calculate the specified statistic. -psStats_STATS_SAMPLE_MEDIAN_SORT_PROBLEM Failed to sort input data. -psStats_STATS_VECTOR_BIN_DISECT_PROBLEM Failed to determine the bin number of a data element. -psStats_STATS_FIT_QUADRATIC_POLYNOMIAL_1D_FIT Failed to fit a 1-dimensional polynomial to the three specified data points. Returning NAN. -psStats_STATS_FIT_QUADRATIC_POLY_MEDIAN Failed to determine the median of the fitted polynomial. Returning NAN. -psStats_ROBUST_STATS_CLIPPED_STATS Failed to determine clipped statistics. - - -psStats_STATS_POLY_MEDIAN_OUT_OF_RANGE The requested y-value does not fall with the specified range of x-values. Returning NAN. -# -psFunctions_INVALID_POLYNOMIAL_TYPE Unknown polynomial type 0x%x found. Evaluation failed. -psFunctions_TYPE_NOT_SUPPORTED Input psVector type, %s, is not supported. -psFunctions_NOT_ENOUGH_DATAPOINTS Given vector does not have enough data points for %d-order interpolation. -# -psRandom_UNKNOWN_RANDFOM_NUMBER_GENERATOR_TYPE Unknown Random Number Generator Type -psRandom_NULL_RANDOM_VAR Random variable is NULL. -# -psMatrix_COUNT_DIFFERS Number of elements inconsistent, %d vs %d. Number of elements must match. -psMatrix_IMAGE_SIZE_DIFFERS Specified psImage dimensions differed, %dx%d vs %dx%d. -psMatrix_TYPE_MISMATCH Specified data type, %s, is not supported. -psMatrix_MIN_COMPLEX_SUPPORT The minimum operation is not supported with complex data. -psMatrix_MAX_COMPLEX_SUPPORT The maximum operation is not supported with complex data. -psMatrix_OPERATION_UNSUPPORTED Specified operation, %s, is not supported. -psMatrix_DIMEN_OTHER_FOUND %s's dimensionality is PS_DIMEN_OTHER, which is not allowed. -psMatrix_OUTPUT_VECTOR_NOT_CREATED Couldn't create a proper output psVector. -psMatrix_OUTPUT_IMAGE_NOT_CREATED Couldn't create a proper output psImage. -psMatrix_DIMEN_INVALID Specified parameter, %s, has invalid dimensionality, %d. -psMatrix_VECTOR_EMPTY Input psVector contains no elements. No data to perform operation with. -psMatrix_IMAGE_EMPTY Input psImage contains no pixels. No data to perform operation with. -psMatrix_TRANSPOSE_MISMATCH Number of rows do not match number of columns. Index: unk/psLib/src/dataManip/psDataManipErrors.h =================================================================== --- /trunk/psLib/src/dataManip/psDataManipErrors.h (revision 4545) +++ (revision ) @@ -1,71 +1,0 @@ -/** @file psDataManipErrors.h - * - * @brief Contains the error text for the data manipulation functions - * - * @ingroup ErrorHandling - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.14 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_DATAMANIP_ERRORS_H -#define PS_DATAMANIP_ERRORS_H - -/* N.B., lines between '//~Start' and '//~End' are automatic generated from - * the template following the '//~Start'. The template is used to generate - * the other lines by, for each error text in psDataManipErrors.dat, the following - * substitutions are made: - * $1 The error text macro name (first word in the psDataManipErrors.dat lines) - * $2 The error text (rest of the line in psDataManipErrors.dat) - * $n The order of the source line in psDataManipErrors.dat (comments excluded) - * - * DO NOT EDIT THE LINES BETWEEN //~Start and //~End! ANY CHANGES WILL BE OVERWRITTEN. - */ - -//~Start #define PS_ERRORTEXT_$1 "$2" -#define PS_ERRORTEXT_psVectorFFT_TYPE_NOT_F32_C32 "Input psVector type, %s, is not supported. Valid data types are psF32 and psC32." -#define PS_ERRORTEXT_psVectorFFT_REVERSE_NOT_COMPLEX "Input psVector (%s) is not complex. Reverse FFT operation requires a complex input." -#define PS_ERRORTEXT_psVectorFFT_FORWARD_NOT_REAL "Input psVector (%s) is not real. Forward FFT operation requires a real input." -#define PS_ERRORTEXT_psVectorFFT_FFTW_PLAN_NULL "Could not create a valid FFT plan to perform the transform." -#define PS_ERRORTEXT_psVectorFFT_TYPE_UNSUPPORTED "Specified psVector type, %s, is not supported." -#define PS_ERRORTEXT_psVectorFFT_REAL_IMAG_TYPE_MISMATCH "Real psVector type, %s, and imaginary psVector type, %s, must be the same." -#define PS_ERRORTEXT_psVectorFFT_REAL_IMAG_SIZE_MISMATCH "Real psVector size, %d, and imaginary psVector size, %d, must be the same." -#define PS_ERRORTEXT_psVectorFFT_NONREAL_NOTSUPPORTED "Input psVector type, %s, is required to be either psF32 or psF64." -#define PS_ERRORTEXT_psVectorFFT_NONCOMPLEX_NOTSUPPORTED "Input psVector type, %s, is required to be either psC32 or psC64." -#define PS_ERRORTEXT_psVectorFFT_DIRECTION_NOTSET "Must specify the direction as either PS_FFT_FORWARD or PS_FFT_REVERSE." -#define PS_ERRORTEXT_psStats_NOT_F32_F64 "Invalid data type, %s. Only psF32 and psF64 data types are supported." -#define PS_ERRORTEXT_psStats_VECTOR_TYPE_UNSUPPORTED "Input psVector type, %s, is not supported." -#define PS_ERRORTEXT_psStats_YVAL_OUT_OF_RANGE "Specified yVal, %g, is not within y-range, %g to %g." -#define PS_ERRORTEXT_psStats_ROBUST_QUARTILE_BINS_FAILED "Could not determine the robust lower/upper quartile bin numbers." -#define PS_ERRORTEXT_psStats_STATS_FAILED "Failed to calculate the specified statistic." -#define PS_ERRORTEXT_psStats_STATS_SAMPLE_MEDIAN_SORT_PROBLEM "Failed to sort input data." -#define PS_ERRORTEXT_psStats_STATS_VECTOR_BIN_DISECT_PROBLEM "Failed to determine the bin number of a data element." -#define PS_ERRORTEXT_psStats_STATS_FIT_QUADRATIC_POLYNOMIAL_1D_FIT "Failed to fit a 1-dimensional polynomial to the three specified data points. Returning NAN." -#define PS_ERRORTEXT_psStats_STATS_FIT_QUADRATIC_POLY_MEDIAN "Failed to determine the median of the fitted polynomial. Returning NAN." -#define PS_ERRORTEXT_psStats_ROBUST_STATS_CLIPPED_STATS "Failed to determine clipped statistics." -#define PS_ERRORTEXT_psStats_STATS_POLY_MEDIAN_OUT_OF_RANGE "The requested y-value does not fall with the specified range of x-values. Returning NAN." -#define PS_ERRORTEXT_psFunctions_INVALID_POLYNOMIAL_TYPE "Unknown polynomial type 0x%x found. Evaluation failed." -#define PS_ERRORTEXT_psFunctions_TYPE_NOT_SUPPORTED "Input psVector type, %s, is not supported." -#define PS_ERRORTEXT_psFunctions_NOT_ENOUGH_DATAPOINTS "Given vector does not have enough data points for %d-order interpolation." -#define PS_ERRORTEXT_psRandom_UNKNOWN_RANDFOM_NUMBER_GENERATOR_TYPE "Unknown Random Number Generator Type" -#define PS_ERRORTEXT_psRandom_NULL_RANDOM_VAR "Random variable is NULL." -#define PS_ERRORTEXT_psMatrix_COUNT_DIFFERS "Number of elements inconsistent, %d vs %d. Number of elements must match." -#define PS_ERRORTEXT_psMatrix_IMAGE_SIZE_DIFFERS "Specified psImage dimensions differed, %dx%d vs %dx%d." -#define PS_ERRORTEXT_psMatrix_TYPE_MISMATCH "Specified data type, %s, is not supported." -#define PS_ERRORTEXT_psMatrix_MIN_COMPLEX_SUPPORT "The minimum operation is not supported with complex data." -#define PS_ERRORTEXT_psMatrix_MAX_COMPLEX_SUPPORT "The maximum operation is not supported with complex data." -#define PS_ERRORTEXT_psMatrix_OPERATION_UNSUPPORTED "Specified operation, %s, is not supported." -#define PS_ERRORTEXT_psMatrix_DIMEN_OTHER_FOUND "%s's dimensionality is PS_DIMEN_OTHER, which is not allowed." -#define PS_ERRORTEXT_psMatrix_OUTPUT_VECTOR_NOT_CREATED "Couldn't create a proper output psVector." -#define PS_ERRORTEXT_psMatrix_OUTPUT_IMAGE_NOT_CREATED "Couldn't create a proper output psImage." -#define PS_ERRORTEXT_psMatrix_DIMEN_INVALID "Specified parameter, %s, has invalid dimensionality, %d." -#define PS_ERRORTEXT_psMatrix_VECTOR_EMPTY "Input psVector contains no elements. No data to perform operation with." -#define PS_ERRORTEXT_psMatrix_IMAGE_EMPTY "Input psImage contains no pixels. No data to perform operation with." -#define PS_ERRORTEXT_psMatrix_TRANSPOSE_MISMATCH "Number of rows do not match number of columns." -//~End - -#endif // #ifndef PS_DATAMANIP_ERRORS_H Index: unk/psLib/src/dataManip/psFunctions.c =================================================================== --- /trunk/psLib/src/dataManip/psFunctions.c (revision 4545) +++ (revision ) @@ -1,2201 +1,0 @@ -/** @file psFunctions.c - * - * @brief Contains basic function allocation, deallocation, and evaluation - * routines. - * - * This file will hold the functions for allocated, freeing, and evaluating - * polynomials. It also contains a Gaussian functions. - * - * @version $Revision: 1.116 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-09 02:11:01 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - * - * XXX: Should the "coeffErr[]" be used as well? Bug ???. Ignore coeffErr - * - * XXX: In the various polyAlloc(n) functions, n is really the order of the - * polynomial plus 1. To create a 2nd-order polynomial, n == 3. - */ -/*****************************************************************************/ -/* INCLUDE FILES */ -/*****************************************************************************/ -#include -#include - -#include -#include -#include -#include - -#include "psMemory.h" -#include "psVector.h" -#include "psScalar.h" -#include "psTrace.h" -#include "psError.h" -#include "psLogMsg.h" -#include "psFunctions.h" -#include "psConstants.h" - -#include "psDataManipErrors.h" - -/*****************************************************************************/ -/* DEFINE STATEMENTS */ -/*****************************************************************************/ - -/*****************************************************************************/ -/* TYPE DEFINITIONS */ -/*****************************************************************************/ -static void polynomial1DFree(psPolynomial1D* poly); -static void polynomial2DFree(psPolynomial2D* poly); -static void polynomial3DFree(psPolynomial3D* poly); -static void polynomial4DFree(psPolynomial4D* poly); -static void dPolynomial1DFree(psDPolynomial1D* poly); -static void dPolynomial2DFree(psDPolynomial2D* poly); -static void dPolynomial3DFree(psDPolynomial3D* poly); -static void dPolynomial4DFree(psDPolynomial4D* poly); -static void spline1DFree(psSpline1D *tmpSpline); -static psS32 vectorBinDisectF32(psF32 *bins,psS32 numBins,psF32 x); -static psS32 vectorBinDisectS32(psS32 *bins,psS32 numBins,psS32 x); - -/*****************************************************************************/ -/* GLOBAL VARIABLES */ -/*****************************************************************************/ - -// None - -/*****************************************************************************/ -/* FILE STATIC VARIABLES */ -/*****************************************************************************/ - -// None - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - LOCAL */ -/*****************************************************************************/ - -static void spline1DFree(psSpline1D *tmpSpline) -{ - psS32 i; - - if (tmpSpline == NULL) { - return; - } - - if (tmpSpline->spline != NULL) { - for (i=0;in;i++) { - psFree((tmpSpline->spline)[i]); - } - psFree(tmpSpline->spline); - } - - if (tmpSpline->p_psDeriv2 != NULL) { - psFree(tmpSpline->p_psDeriv2); - } - psFree(tmpSpline->knots); - - return; -} - -static void polynomial1DFree(psPolynomial1D* poly) -{ - psFree(poly->coeff); - psFree(poly->coeffErr); - psFree(poly->mask); -} - -static void polynomial2DFree(psPolynomial2D* poly) -{ - unsigned int x = 0; - - for (x = 0; x < poly->nX; x++) { - psFree(poly->coeff[x]); - psFree(poly->coeffErr[x]); - psFree(poly->mask[x]); - } - psFree(poly->coeff); - psFree(poly->coeffErr); - psFree(poly->mask); -} - -static void polynomial3DFree(psPolynomial3D* poly) -{ - unsigned int x = 0; - unsigned int y = 0; - - for (x = 0; x < poly->nX; x++) { - for (y = 0; y < poly->nY; y++) { - psFree(poly->coeff[x][y]); - psFree(poly->coeffErr[x][y]); - psFree(poly->mask[x][y]); - } - psFree(poly->coeff[x]); - psFree(poly->coeffErr[x]); - psFree(poly->mask[x]); - } - - psFree(poly->coeff); - psFree(poly->coeffErr); - psFree(poly->mask); -} - -static void polynomial4DFree(psPolynomial4D* poly) -{ - unsigned int x = 0; - unsigned int y = 0; - unsigned int z = 0; - - for (x = 0; x < poly->nX; x++) { - for (y = 0; y < poly->nY; y++) { - for (z = 0; z < poly->nZ; z++) { - psFree(poly->coeff[x][y][z]); - psFree(poly->coeffErr[x][y][z]); - psFree(poly->mask[x][y][z]); - } - psFree(poly->coeff[x][y]); - psFree(poly->coeffErr[x][y]); - psFree(poly->mask[x][y]); - } - psFree(poly->coeff[x]); - psFree(poly->coeffErr[x]); - psFree(poly->mask[x]); - } - - psFree(poly->coeff); - psFree(poly->coeffErr); - psFree(poly->mask); -} - -static void dPolynomial1DFree(psDPolynomial1D* poly) -{ - psFree(poly->coeff); - psFree(poly->coeffErr); - psFree(poly->mask); -} - -static void dPolynomial2DFree(psDPolynomial2D* poly) -{ - for (unsigned int x = 0; x < poly->nX; x++) { - psFree(poly->coeff[x]); - psFree(poly->coeffErr[x]); - psFree(poly->mask[x]); - } - psFree(poly->coeff); - psFree(poly->coeffErr); - psFree(poly->mask); -} - -static void dPolynomial3DFree(psDPolynomial3D* poly) -{ - unsigned int x = 0; - unsigned int y = 0; - - for (x = 0; x < poly->nX; x++) { - for (y = 0; y < poly->nY; y++) { - psFree(poly->coeff[x][y]); - psFree(poly->coeffErr[x][y]); - psFree(poly->mask[x][y]); - } - psFree(poly->coeff[x]); - psFree(poly->coeffErr[x]); - psFree(poly->mask[x]); - } - - psFree(poly->coeff); - psFree(poly->coeffErr); - psFree(poly->mask); -} - -static void dPolynomial4DFree(psDPolynomial4D* poly) -{ - unsigned int x = 0; - unsigned int y = 0; - unsigned int z = 0; - - for (x = 0; x < poly->nX; x++) { - for (y = 0; y < poly->nY; y++) { - for (z = 0; z < poly->nZ; z++) { - psFree(poly->coeff[x][y][z]); - psFree(poly->coeffErr[x][y][z]); - psFree(poly->mask[x][y][z]); - } - psFree(poly->coeff[x][y]); - psFree(poly->coeffErr[x][y]); - psFree(poly->mask[x][y]); - } - psFree(poly->coeff[x]); - psFree(poly->coeffErr[x]); - psFree(poly->mask[x]); - } - - psFree(poly->coeff); - psFree(poly->coeffErr); - psFree(poly->mask); -} - -/***************************************************************************** -createChebyshevPolys(n): this routine takes as input the required order n, -and returns as output as a pointer to an array of n psPolynomial1D -structures, corresponding to the first n Chebyshev polynomials. - -XXX: The output should be static since the Chebyshev polynomials might be -used frequently and the data structure created here does not contain the -outer coefficients of the Chebyshev polynomials. - *****************************************************************************/ -static psPolynomial1D **createChebyshevPolys(psS32 maxChebyPoly) -{ - PS_ASSERT_INT_NONNEGATIVE(maxChebyPoly, NULL); - - psPolynomial1D **chebPolys = NULL; - - chebPolys = (psPolynomial1D **) psAlloc(maxChebyPoly * sizeof(psPolynomial1D *)); - for (psS32 i = 0; i < maxChebyPoly; i++) { - chebPolys[i] = psPolynomial1DAlloc(i + 1, PS_POLYNOMIAL_ORD); - } - - // Create the Chebyshev polynomials. - // Polynomial i has i-th order. - chebPolys[0]->coeff[0] = 1; - - // XXX: Bug 296 - if (maxChebyPoly > 1) { - chebPolys[1]->coeff[1] = 1; - - for (psS32 i = 2; i < maxChebyPoly; i++) { - for (psS32 j = 0; j < chebPolys[i - 1]->n; j++) { - chebPolys[i]->coeff[j + 1] = 2 * chebPolys[i - 1]->coeff[j]; - } - for (psS32 j = 0; j < chebPolys[i - 2]->n; j++) { - chebPolys[i]->coeff[j] -= chebPolys[i - 2]->coeff[j]; - } - } - } else { - // XXX: Code this. - printf("WARNING: %d-order chebyshev polynomials not correctly implemented.\n", maxChebyPoly); - } - - return (chebPolys); -} - -/***************************************************************************** - Polynomial coefficients will be accessed in [w][x][y][z] fashion. - *****************************************************************************/ -static psF64 ordPolynomial1DEval(psF64 x, const psPolynomial1D* poly) -{ - psS32 loop_x = 0; - psF32 polySum = 0.0; - psF32 xSum = 1.0; - - psTrace(".psLib.dataManip.psFunctions.ordPolynomial1DEval", 4, - "---- Calling ordPolynomial1DEval(%f)\n", x); - psTrace(".psLib.dataManip.psFunctions.ordPolynomial1DEval", 4, - "Polynomial order is %d\n", poly->n); - for (loop_x = 0; loop_x < poly->n; loop_x++) { - psTrace(".psLib.dataManip.psFunctions.ordPolynomial1DEval", 4, - "Polynomial coeff[%d] is %f\n", loop_x, poly->coeff[loop_x]); - } - - for (loop_x = 0; loop_x < poly->n; loop_x++) { - if (poly->mask[loop_x] == 0) { - psTrace(".psLib.dataManip.psFunctions.ordPolynomial1DEval", 10, - "polysum+= sum*coeff [%f+= (%f * %f)\n", polySum, xSum, poly->coeff[loop_x]); - polySum += xSum * poly->coeff[loop_x]; - } - xSum *= x; - } - - return(polySum); -} - -// XXX: You can do this without having to psAlloc() vector d. -// XXX: How does the mask vector effect Crenshaw's formula? -// XXX: We assume that x is scaled between -1.0 and 1.0; -static psF64 chebPolynomial1DEval(psF64 x, const psPolynomial1D* poly) -{ - PS_ASSERT_FLOAT_WITHIN_RANGE(x, -1.0, 1.0, 0.0); - // XXX: Create a macro for this in psConstants.h - if (poly->n < 1) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, "Error: Chebyshev polynomial as order %d.", poly->n); - return(NAN); - } - psVector *d; - psS32 n = poly->n; - psS32 i; - psF32 tmp = 0.0; - - // Special case where the Chebyshev poly is constant. - if (n == 1) { - if (poly->mask[0] == 0) { - tmp += poly->coeff[0]; - } - return(tmp); - } - - // Special case where the Chebyshev poly is linear. - if (n == 2) { - if (poly->mask[0] == 0) { - tmp+= poly->coeff[0]; - } - if (poly->mask[1] == 0) { - tmp+= poly->coeff[1] * x; - } - return(tmp); - } - - // General case where the Chebyshev poly has 2 or more terms. - d = psVectorAlloc(n, PS_TYPE_F32); - if(poly->mask[n-1] == 0) { - d->data.F32[n-1] = poly->coeff[n-1]; - } else { - d->data.F32[n-1] = 0.0; - } - - d->data.F32[n-2] = (2.0 * x * d->data.F32[n-1]); - if(poly->mask[n-2] == 0) { - d->data.F32[n-2] += poly->coeff[n-2]; - } - - for (i=n-3;i>=1;i--) { - d->data.F32[i] = (2.0 * x * d->data.F32[i+1]) - - (d->data.F32[i+2]); - if(poly->mask[i] == 0) { - d->data.F32[i] += poly->coeff[i]; - } - } - - tmp = (x * d->data.F32[1]) - - (d->data.F32[2]); - if(poly->mask[0] == 0) { - tmp += (0.5 * poly->coeff[0]); - } - psFree(d); - return(tmp); - - /* This is old code that does not use Clenshaw's formula. Get rid of it. - - psS32 n; - psS32 i; - psF32 tmp; - psPolynomial1D **chebPolys = NULL; - - n = poly->n; - chebPolys = createChebyshevPolys(n); - - tmp = 0.0; - for (i=0;in;i++) { - tmp+= (poly->coeff[i] * psPolynomial1DEval(x, chebPolys[i])); - } - tmp-= (poly->coeff[0]/2.0); - - - return(tmp); - */ -} - -static psF64 ordPolynomial2DEval(psF64 x, - psF64 y, - const psPolynomial2D* poly) -{ - PS_ASSERT_POLY_NON_NULL(poly, NAN); - - psS32 loop_x = 0; - psS32 loop_y = 0; - psF32 polySum = 0.0; - psF32 xSum = 1.0; - psF32 ySum = 1.0; - - for (loop_x = 0; loop_x < poly->nX; loop_x++) { - ySum = xSum; - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - if (poly->mask[loop_x][loop_y] == 0) { - polySum += ySum * poly->coeff[loop_x][loop_y]; - } - ySum *= y; - } - xSum *= x; - } - - return(polySum); -} - -static psF64 chebPolynomial2DEval(psF64 x, psF64 y, const psPolynomial2D* poly) -{ - PS_ASSERT_FLOAT_WITHIN_RANGE(x, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(y, -1.0, 1.0, 0.0); - PS_ASSERT_POLY_NON_NULL(poly, NAN); - - psS32 loop_x = 0; - psS32 loop_y = 0; - psS32 i = 0; - psF32 polySum = 0.0; - psPolynomial1D* *chebPolys = NULL; - psS32 maxChebyPoly = 0; - - // Determine how many Chebyshev polynomials - // are needed, then create them. - maxChebyPoly = poly->nX; - if (poly->nY > maxChebyPoly) { - maxChebyPoly = poly->nY; - } - chebPolys = createChebyshevPolys(maxChebyPoly); - - for (loop_x = 0; loop_x < poly->nX; loop_x++) { - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - if (poly->mask[loop_x][loop_y] == 0) { - polySum += poly->coeff[loop_x][loop_y] * - psPolynomial1DEval(chebPolys[loop_x], x) * - psPolynomial1DEval(chebPolys[loop_y], y); - } - } - } - for (i=0;inX; loop_x++) { - ySum = xSum; - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - zSum = ySum; - for (loop_z = 0; loop_z < poly->nZ; loop_z++) { - if (poly->mask[loop_x][loop_y][loop_z] == 0) { - polySum += zSum * poly->coeff[loop_x][loop_y][loop_z]; - } - zSum *= z; - } - ySum *= y; - } - xSum *= x; - } - - return(polySum); -} - -static psF64 chebPolynomial3DEval(psF64 x, psF64 y, psF64 z, const psPolynomial3D* poly) -{ - PS_ASSERT_FLOAT_WITHIN_RANGE(x, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(y, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(z, -1.0, 1.0, 0.0); - psS32 loop_x = 0; - psS32 loop_y = 0; - psS32 loop_z = 0; - psS32 i = 0; - psF32 polySum = 0.0; - psPolynomial1D* *chebPolys = NULL; - psS32 maxChebyPoly = 0; - - // Determine how many Chebyshev polynomials - // are needed, then create them. - maxChebyPoly = poly->nX; - if (poly->nY > maxChebyPoly) { - maxChebyPoly = poly->nY; - } - if (poly->nZ > maxChebyPoly) { - maxChebyPoly = poly->nZ; - } - chebPolys = createChebyshevPolys(maxChebyPoly); - - for (loop_x = 0; loop_x < poly->nX; loop_x++) { - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - for (loop_z = 0; loop_z < poly->nZ; loop_z++) { - if (poly->mask[loop_x][loop_y][loop_z] == 0) { - polySum += poly->coeff[loop_x][loop_y][loop_z] * - psPolynomial1DEval(chebPolys[loop_x], x) * - psPolynomial1DEval(chebPolys[loop_y], y) * - psPolynomial1DEval(chebPolys[loop_z], z); - } - } - } - } - - for (i=0;inX; loop_x++) { - ySum = xSum; - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - zSum = ySum; - for (loop_z = 0; loop_z < poly->nZ; loop_z++) { - tSum = zSum; - for (loop_t = 0; loop_t < poly->nT; loop_t++) { - if (poly->mask[loop_x][loop_y][loop_z][loop_t] == 0) { - polySum += tSum * poly->coeff[loop_x][loop_y][loop_z][loop_t]; - } - tSum *= t; - } - zSum *= z; - } - ySum *= y; - } - xSum *= x; - } - - return(polySum); -} - -static psF64 chebPolynomial4DEval(psF64 x, psF64 y, psF64 z, psF64 t, const psPolynomial4D* poly) -{ - PS_ASSERT_FLOAT_WITHIN_RANGE(x, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(y, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(z, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(t, -1.0, 1.0, 0.0); - psS32 loop_x = 0; - psS32 loop_y = 0; - psS32 loop_z = 0; - psS32 loop_t = 0; - psS32 i = 0; - psF32 polySum = 0.0; - psPolynomial1D* *chebPolys = NULL; - psS32 maxChebyPoly = 0; - - // Determine how many Chebyshev polynomials - // are needed, then create them. - maxChebyPoly = poly->nX; - if (poly->nY > maxChebyPoly) { - maxChebyPoly = poly->nY; - } - if (poly->nZ > maxChebyPoly) { - maxChebyPoly = poly->nZ; - } - if (poly->nT > maxChebyPoly) { - maxChebyPoly = poly->nT; - } - chebPolys = createChebyshevPolys(maxChebyPoly); - - for (loop_x = 0; loop_x < poly->nX; loop_x++) { - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - for (loop_z = 0; loop_z < poly->nZ; loop_z++) { - for (loop_t = 0; loop_t < poly->nT; loop_t++) { - if (poly->mask[loop_x][loop_y][loop_z][loop_t] == 0) { - polySum += poly->coeff[loop_x][loop_y][loop_z][loop_t] * - psPolynomial1DEval(chebPolys[loop_x], x) * - psPolynomial1DEval(chebPolys[loop_y], y) * - psPolynomial1DEval(chebPolys[loop_z], z) * - psPolynomial1DEval(chebPolys[loop_t], t); - } - } - } - } - } - - for (i=0;in; loop_x++) { - if (poly->mask[loop_x] == 0) { - polySum += xSum * poly->coeff[loop_x]; - } - xSum *= x; - } - - return(polySum); -} - -// XXX: You can do this without having to psAlloc() vector d. -// XXX: How does the mask vector effect Crenshaw's formula? -static psF64 dChebPolynomial1DEval(psF64 x, const psDPolynomial1D* poly) -{ - PS_ASSERT_FLOAT_WITHIN_RANGE(x, -1.0, 1.0, 0.0); - psVector *d; - psS32 n; - psS32 i; - psF64 tmp; - - n = poly->n; - d = psVectorAlloc(n, PS_TYPE_F64); - if(poly->mask[n-1] == 0) { - d->data.F64[n-1] = poly->coeff[n-1]; - } else { - d->data.F64[n-1] = 0.0; - } - d->data.F64[n-2] = (2.0 * x * d->data.F64[n-1]); - if(poly->mask[n-2] == 0) { - d->data.F64[n-2] += poly->coeff[n-2]; - } - for (i=n-3;i>=1;i--) { - d->data.F64[i] = (2.0 * x * d->data.F64[i+1]) - - (d->data.F64[i+2]); - if(poly->mask[i] == 0) { - d->data.F64[i] += poly->coeff[i]; - } - } - - tmp = (x * d->data.F64[1]) - - (d->data.F64[2]); - if(poly->mask[0] == 0) { - tmp += (0.5 * poly->coeff[0]); - } - - psFree(d); - return(tmp); -} - -static psF64 dOrdPolynomial2DEval(psF64 x, - psF64 y, - const psDPolynomial2D* poly) -{ - psS32 loop_x = 0; - psS32 loop_y = 0; - psF64 polySum = 0.0; - psF64 xSum = 1.0; - psF64 ySum = 1.0; - - for (loop_x = 0; loop_x < poly->nX; loop_x++) { - ySum = xSum; - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - if (poly->mask[loop_x][loop_y] == 0) { - polySum += ySum * poly->coeff[loop_x][loop_y]; - } - ySum *= y; - } - xSum *= x; - } - - return(polySum); -} - -static psF64 dChebPolynomial2DEval(psF64 x, psF64 y, const psDPolynomial2D* poly) -{ - PS_ASSERT_FLOAT_WITHIN_RANGE(x, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(y, -1.0, 1.0, 0.0); - psS32 loop_x = 0; - psS32 loop_y = 0; - psS32 i = 0; - psF64 polySum = 0.0; - psPolynomial1D* *chebPolys = NULL; - psS32 maxChebyPoly = 0; - - // Determine how many Chebyshev polynomials - // are needed, then create them. - maxChebyPoly = poly->nX; - if (poly->nY > maxChebyPoly) { - maxChebyPoly = poly->nY; - } - chebPolys = createChebyshevPolys(maxChebyPoly); - - for (loop_x = 0; loop_x < poly->nX; loop_x++) { - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - if (poly->mask[loop_x][loop_y] == 0) { - polySum += poly->coeff[loop_x][loop_y] * - psPolynomial1DEval(chebPolys[loop_x], x) * - psPolynomial1DEval(chebPolys[loop_y], y); - } - } - } - - for (i=0;inX; loop_x++) { - ySum = xSum; - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - zSum = ySum; - for (loop_z = 0; loop_z < poly->nZ; loop_z++) { - if (poly->mask[loop_x][loop_y][loop_z] == 0) { - polySum += zSum * poly->coeff[loop_x][loop_y][loop_z]; - } - zSum *= z; - } - ySum *= y; - } - xSum *= x; - } - - return(polySum); -} - -static psF64 dChebPolynomial3DEval(psF64 x, psF64 y, psF64 z, const psDPolynomial3D* poly) -{ - PS_ASSERT_FLOAT_WITHIN_RANGE(x, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(y, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(z, -1.0, 1.0, 0.0); - psS32 loop_x = 0; - psS32 loop_y = 0; - psS32 loop_z = 0; - psS32 i = 0; - psF64 polySum = 0.0; - psPolynomial1D* *chebPolys = NULL; - psS32 maxChebyPoly = 0; - - // Determine how many Chebyshev polynomials - // are needed, then create them. - maxChebyPoly = poly->nX; - if (poly->nY > maxChebyPoly) { - maxChebyPoly = poly->nY; - } - if (poly->nZ > maxChebyPoly) { - maxChebyPoly = poly->nZ; - } - chebPolys = createChebyshevPolys(maxChebyPoly); - - for (loop_x = 0; loop_x < poly->nX; loop_x++) { - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - for (loop_z = 0; loop_z < poly->nZ; loop_z++) { - if (poly->mask[loop_x][loop_y][loop_z] == 0) { - polySum += poly->coeff[loop_x][loop_y][loop_z] * - psPolynomial1DEval(chebPolys[loop_x], x) * - psPolynomial1DEval(chebPolys[loop_y], y) * - psPolynomial1DEval(chebPolys[loop_z], z); - } - } - } - } - - for (i=0;inX; loop_x++) { - ySum = xSum; - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - zSum = ySum; - for (loop_z = 0; loop_z < poly->nZ; loop_z++) { - tSum = zSum; - for (loop_t = 0; loop_t < poly->nT; loop_t++) { - if (poly->mask[loop_x][loop_y][loop_z][loop_t] == 0) { - polySum += tSum * poly->coeff[loop_x][loop_y][loop_z][loop_t]; - } - tSum *= t; - } - zSum *= z; - } - ySum *= y; - } - xSum *= x; - } - - return(polySum); -} - -static psF64 dChebPolynomial4DEval(psF64 x, psF64 y, psF64 z, psF64 t, const psDPolynomial4D* poly) -{ - PS_ASSERT_FLOAT_WITHIN_RANGE(x, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(y, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(z, -1.0, 1.0, 0.0); - PS_ASSERT_FLOAT_WITHIN_RANGE(t, -1.0, 1.0, 0.0); - psS32 loop_x = 0; - psS32 loop_y = 0; - psS32 loop_z = 0; - psS32 loop_t = 0; - psS32 i = 0; - psF64 polySum = 0.0; - psPolynomial1D* *chebPolys = NULL; - psS32 maxChebyPoly = 0; - - // Determine how many Chebyshev polynomials - // are needed, then create them. - maxChebyPoly = poly->nX; - if (poly->nY > maxChebyPoly) { - maxChebyPoly = poly->nY; - } - if (poly->nZ > maxChebyPoly) { - maxChebyPoly = poly->nZ; - } - if (poly->nT > maxChebyPoly) { - maxChebyPoly = poly->nT; - } - chebPolys = createChebyshevPolys(maxChebyPoly); - - for (loop_x = 0; loop_x < poly->nX; loop_x++) { - for (loop_y = 0; loop_y < poly->nY; loop_y++) { - for (loop_z = 0; loop_z < poly->nZ; loop_z++) { - for (loop_t = 0; loop_t < poly->nT; loop_t++) { - if (poly->mask[loop_x][loop_y][loop_z][loop_t] == 0) { - polySum += poly->coeff[loop_x][loop_y][loop_z][loop_t] * - psPolynomial1DEval(chebPolys[loop_x], x) * - psPolynomial1DEval(chebPolys[loop_y], y) * - psPolynomial1DEval(chebPolys[loop_z], z) * - psPolynomial1DEval(chebPolys[loop_t], t); - } - } - } - } - } - - for (i=0;idata.TYPE, true); \ - \ - psTrace(".psLib.dataManip.psFunctions.fullInterpolate1D##TYPE", 4, \ - "---- fullInterpolate1D##TYPE() begin (%d-order at x=%f) (%d data points)----\n", n-1, x, n); \ - \ - for (i=0;idata.TYPE[i] = range[i]; \ - psTrace(".psLib.dataManip.psFunctions.fullInterpolate1D##TYPE", 6, \ - "p->data.TYPE[%d] is %f\n", i, p->data.TYPE[i]); \ - \ - } \ - \ - /* From NR, during each iteration of the m loop, we are computing the \ - p_{i ... i+m} terms. \ - */ \ - for (m=1;mdata.TYPE[i] = (((x-domain[i+m]) * p->data.TYPE[i]) + \ - ((domain[i]-x) * p->data.TYPE[i+1])) / \ - (domain[i] - domain[i+m]); \ - /*printf("((%f-%f * %f) + (%f-%f * %f)) / (%f - %f)\n", x, domain[i+m], p->data.TYPE[i], domain[i], x, p->data.TYPE[i+1], domain[i], domain[i+m]); \ - */ \ - psTrace(".psLib.dataManip.psFunctions.fullInterpolate1D##TYPE", 6, \ - "p->data.TYPE[%d] is %f\n", i, p->data.TYPE[i]); \ - } \ - } \ - psTrace(".psLib.dataManip.psFunctions.fullInterpolate1D##TYPE", 4, \ - "---- fullInterpolate1D##TYPE() end ----\n"); \ - \ - return(p->data.TYPE[0]); \ -} \ - -/* -FUNC_MACRO_FULL_INTERPOLATE_1D(U8) -FUNC_MACRO_FULL_INTERPOLATE_1D(U16) -FUNC_MACRO_FULL_INTERPOLATE_1D(U32) -FUNC_MACRO_FULL_INTERPOLATE_1D(U64) -FUNC_MACRO_FULL_INTERPOLATE_1D(S8) -FUNC_MACRO_FULL_INTERPOLATE_1D(S16) -FUNC_MACRO_FULL_INTERPOLATE_1D(S32) -FUNC_MACRO_FULL_INTERPOLATE_1D(S64) -FUNC_MACRO_FULL_INTERPOLATE_1D(F64) -*/ -FUNC_MACRO_FULL_INTERPOLATE_1D(F32) - - -/***************************************************************************** -interpolate1DF32(): this is the base 1-D flat memory routine to perform -LaGrange interpolation. - *****************************************************************************/ -static psF32 interpolate1DF32(psF32 *domain, - psF32 *range, - psS32 n, - psS32 order, - psF32 x) -{ - PS_ASSERT_PTR_NON_NULL(domain, NAN) - PS_ASSERT_PTR_NON_NULL(range, NAN) - // XXX: Check valid values for n, order, and x? - - psS32 binNum; - psS32 numIntPoints = order+1; - psS32 origin; - - psTrace(".psLib.dataManip.psFunctions.interpolate1DF32", 4, - "---- interpolate1DF32() begin ----\n"); - - binNum = vectorBinDisectF32(domain, n, x); - - if (0 == numIntPoints%2) { - origin = binNum - ((numIntPoints/2) - 1); - } else { - origin = binNum - (numIntPoints/2); - if ((x-domain[binNum]) > (domain[binNum+1]-x)) { - // x is closer to binNum+1. - origin = 1 + (binNum - (numIntPoints/2)); - } - } - if (origin < 0) { - origin = 0; - } - if ((origin + numIntPoints) > n) { - origin = n - numIntPoints; - } - - psTrace(".psLib.dataManip.psFunctions.interpolate1DF32", 4, - "---- interpolate1DF32() end ----\n"); - return(fullInterpolate1DF32(&domain[origin], &range[origin], order+1, x)); -} - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - PUBLIC */ -/*****************************************************************************/ - -/***************************************************************************** - Evaluate a non-normalized Gaussian with the given mean and sigma at the - given coordianate. Note that this is not a Gaussian deviate. The - evaluated Gaussian is: \f[ exp(-\frac{(x-mean)^2}{2\sigma^2}) \f] - *****************************************************************************/ -float psGaussian(float x, float mean, float sigma, bool normal) -{ - psF32 tmp = 1.0; - - psTrace(".psLib.dataManip.psFunctions.psGaussian", 4, - "---- psGaussian() begin ----\n"); - - if (normal == true) { - tmp = 1.0 / sqrtf(2.0 * M_PI * (sigma * sigma)); - } - - psTrace(".psLib.dataManip.psFunctions.psGaussian", 4, - "---- psGaussian() end ----\n"); - return(tmp * exp(-((x - mean) * (x - mean)) / (2.0 * sigma * sigma))); -} - -/***************************************************************************** - p_psGaussianDev() - This private routine (formerly a psLib API routine) creates a psVector of the - specified size and type F32 and fills it with a random Gaussian distribution - of numbers with the specified mean and sigma. This routine makes use of the - GSL routines for generating both uniformly distributed numbers and the - Gaussian distribution as well. - -XXX: There is no way to seed the random generator. - *****************************************************************************/ -psVector* p_psGaussianDev(psF32 mean, psF32 sigma, psS32 Npts) -{ - PS_ASSERT_INT_NONNEGATIVE(Npts, NULL); - - psVector* gauss = NULL; - const gsl_rng_type *T = NULL; - gsl_rng *r = NULL; - psS32 i = 0; - - - gauss = psVectorAlloc(Npts, PS_TYPE_F32); - gauss->n = Npts; - gsl_rng_env_setup(); - T = gsl_rng_default; - r = gsl_rng_alloc(T); - - for (i = 0; i < Npts; i++) { - gauss->data.F32[i] = mean + gsl_ran_gaussian(r, sigma); - } - - // XXX: Should I free r, T as well? This is a memory leak. - return(gauss); -} - -/***************************************************************************** - This routine must allocate memory for the polynomial structures. - *****************************************************************************/ -psPolynomial1D* psPolynomial1DAlloc(int n, - psPolynomialType type) -{ - PS_ASSERT_INT_POSITIVE(n, NULL); - - int i = 0; - psPolynomial1D* newPoly = NULL; - - newPoly = (psPolynomial1D* ) psAlloc(sizeof(psPolynomial1D)); - psMemSetDeallocator(newPoly, (psFreeFunc) polynomial1DFree); - - newPoly->type = type; - newPoly->n = n; - newPoly->coeff = (psF32 *)psAlloc(n * sizeof(psF32)); - newPoly->coeffErr = (psF32 *)psAlloc(n * sizeof(psF32)); - newPoly->mask = (char *)psAlloc(n * sizeof(char)); - for (i = 0; i < n; i++) { - newPoly->coeff[i] = 0.0; - newPoly->coeffErr[i] = 0.0; - newPoly->mask[i] = 0; - } - - return(newPoly); -} - -psPolynomial2D* psPolynomial2DAlloc( int nX, int nY, - psPolynomialType type) -{ - PS_ASSERT_INT_POSITIVE(nX, NULL); - PS_ASSERT_INT_POSITIVE(nY, NULL); - - int x = 0; - int y = 0; - psPolynomial2D* newPoly = NULL; - - newPoly = (psPolynomial2D* ) psAlloc(sizeof(psPolynomial2D)); - psMemSetDeallocator(newPoly, (psFreeFunc) polynomial2DFree); - - newPoly->type = type; - newPoly->nX = nX; - newPoly->nY = nY; - - newPoly->coeff = (psF32 **)psAlloc(nX * sizeof(psF32 *)); - newPoly->coeffErr = (psF32 **)psAlloc(nX * sizeof(psF32 *)); - newPoly->mask = (char **)psAlloc(nX * sizeof(char *)); - for (x = 0; x < nX; x++) { - newPoly->coeff[x] = (psF32 *)psAlloc(nY * sizeof(psF32)); - newPoly->coeffErr[x] = (psF32 *)psAlloc(nY * sizeof(psF32)); - newPoly->mask[x] = (char *)psAlloc(nY * sizeof(char)); - } - for (x = 0; x < nX; x++) { - for (y = 0; y < nY; y++) { - newPoly->coeff[x][y] = 0.0; - newPoly->coeffErr[x][y] = 0.0; - newPoly->mask[x][y] = 0; - } - } - - return(newPoly); -} - -psPolynomial3D* psPolynomial3DAlloc( int nX, int nY, int nZ, - psPolynomialType type) -{ - PS_ASSERT_INT_POSITIVE(nX, NULL); - PS_ASSERT_INT_POSITIVE(nY, NULL); - PS_ASSERT_INT_POSITIVE(nZ, NULL); - - psS32 x = 0; - psS32 y = 0; - psS32 z = 0; - psPolynomial3D* newPoly = NULL; - - newPoly = (psPolynomial3D* ) psAlloc(sizeof(psPolynomial3D)); - psMemSetDeallocator(newPoly, (psFreeFunc) polynomial3DFree); - - newPoly->type = type; - newPoly->nX = nX; - newPoly->nY = nY; - newPoly->nZ = nZ; - - newPoly->coeff = (psF32 ***)psAlloc(nX * sizeof(psF32 **)); - newPoly->coeffErr = (psF32 ***)psAlloc(nX * sizeof(psF32 **)); - newPoly->mask = (char ***)psAlloc(nX * sizeof(char **)); - for (x = 0; x < nX; x++) { - newPoly->coeff[x] = (psF32 **)psAlloc(nY * sizeof(psF32 *)); - newPoly->coeffErr[x] = (psF32 **)psAlloc(nY * sizeof(psF32 *)); - newPoly->mask[x] = (char **)psAlloc(nY * sizeof(char *)); - for (y = 0; y < nY; y++) { - newPoly->coeff[x][y] = (psF32 *)psAlloc(nZ * sizeof(psF32)); - newPoly->coeffErr[x][y] = (psF32 *)psAlloc(nZ * sizeof(psF32)); - newPoly->mask[x][y] = (char *)psAlloc(nZ * sizeof(char)); - } - } - for (x = 0; x < nX; x++) { - for (y = 0; y < nY; y++) { - for (z = 0; z < nZ; z++) { - newPoly->coeff[x][y][z] = 0.0; - newPoly->coeffErr[x][y][z] = 0.0; - newPoly->mask[x][y][z] = 0; - } - } - } - - return(newPoly); -} - -psPolynomial4D* psPolynomial4DAlloc( int nX, int nY, int nZ, int nT, - psPolynomialType type) -{ - PS_ASSERT_INT_POSITIVE(nX, NULL); - PS_ASSERT_INT_POSITIVE(nY, NULL); - PS_ASSERT_INT_POSITIVE(nZ, NULL); - PS_ASSERT_INT_POSITIVE(nT, NULL); - - psS32 x = 0; - psS32 y = 0; - psS32 z = 0; - psS32 t = 0; - psPolynomial4D* newPoly = NULL; - - newPoly = (psPolynomial4D* ) psAlloc(sizeof(psPolynomial4D)); - psMemSetDeallocator(newPoly, (psFreeFunc) polynomial4DFree); - - newPoly->type = type; - newPoly->nX = nX; - newPoly->nY = nY; - newPoly->nZ = nZ; - newPoly->nT = nT; - - newPoly->coeff = (psF32 ****)psAlloc(nX * sizeof(psF32 ***)); - newPoly->coeffErr = (psF32 ****)psAlloc(nX * sizeof(psF32 ***)); - newPoly->mask = (char ****)psAlloc(nX * sizeof(char ***)); - for (x = 0; x < nX; x++) { - newPoly->coeff[x] = (psF32 ***)psAlloc(nY * sizeof(psF32 **)); - newPoly->coeffErr[x] = (psF32 ***)psAlloc(nY * sizeof(psF32 **)); - newPoly->mask[x] = (char ***)psAlloc(nY * sizeof(char **)); - for (y = 0; y < nY; y++) { - newPoly->coeff[x][y] = (psF32 **)psAlloc(nZ * sizeof(psF32 *)); - newPoly->coeffErr[x][y] = (psF32 **)psAlloc(nZ * sizeof(psF32 *)); - newPoly->mask[x][y] = (char **)psAlloc(nZ * sizeof(char *)); - for (z = 0; z < nZ; z++) { - newPoly->coeff[x][y][z] = (psF32 *)psAlloc(nT * sizeof(psF32)); - newPoly->coeffErr[x][y][z] = (psF32 *)psAlloc(nT * sizeof(psF32)); - newPoly->mask[x][y][z] = (char *)psAlloc(nT * sizeof(char)); - } - } - } - for (x = 0; x < nX; x++) { - for (y = 0; y < nY; y++) { - for (z = 0; z < nZ; z++) { - for (t = 0; t < nT; t++) { - newPoly->coeff[x][y][z][t] = 0.0; - newPoly->coeffErr[x][y][z][t] = 0.0; - newPoly->mask[x][y][z][t] = 0; - } - } - } - } - - return(newPoly); -} - -psF64 psPolynomial1DEval(const psPolynomial1D* poly, psF64 x) -{ - PS_ASSERT_POLY_NON_NULL(poly, NAN); - - if (poly->type == PS_POLYNOMIAL_ORD) { - return(ordPolynomial1DEval(x, poly)); - } else if (poly->type == PS_POLYNOMIAL_CHEB) { - return(chebPolynomial1DEval(x, poly)); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psFunctions_INVALID_POLYNOMIAL_TYPE, - poly->type); - } - return(NAN); -} - -psVector *psPolynomial1DEvalVector(const psPolynomial1D *poly, - const psVector *x) -{ - PS_ASSERT_POLY_NON_NULL(poly, NULL); - PS_ASSERT_VECTOR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_TYPE(x, PS_TYPE_F32, NULL); - - psVector *tmp; - - tmp = psVectorAlloc(x->n, PS_TYPE_F32); - for (psS32 i=0;in;i++) { - tmp->data.F32[i] = psPolynomial1DEval(poly, x->data.F32[i]); - } - - return(tmp); -} - -psF64 psPolynomial2DEval(const psPolynomial2D* poly, psF64 x, psF64 y) -{ - PS_ASSERT_POLY_NON_NULL(poly, NAN); - - if (poly->type == PS_POLYNOMIAL_ORD) { - return(ordPolynomial2DEval(x, y, poly)); - } else if (poly->type == PS_POLYNOMIAL_CHEB) { - return(chebPolynomial2DEval(x, y, poly)); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psFunctions_INVALID_POLYNOMIAL_TYPE, - poly->type); - } - return(NAN); -} - -psVector *psPolynomial2DEvalVector(const psPolynomial2D *poly, - const psVector *x, - const psVector *y) - -{ - PS_ASSERT_POLY_NON_NULL(poly, NULL); - PS_ASSERT_VECTOR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_TYPE(x, PS_TYPE_F32, NULL); - PS_ASSERT_VECTOR_NON_NULL(y, NULL); - PS_ASSERT_VECTOR_TYPE(y, PS_TYPE_F32, NULL); - - psVector *tmp; - psS32 vecLen=x->n; - - // Determine the length of the output vector to by the minimum of the x,y vectors - if (y->n < vecLen) { - vecLen = y->n; - } - - // Create output vector to return - tmp = psVectorAlloc(vecLen, PS_TYPE_F32); - - // Evaluate the polynomial at the specified points - for (psS32 i=0; idata.F32[i] = psPolynomial2DEval(poly,x->data.F32[i],y->data.F32[i]); - } - - // Return output vector - return(tmp); -} - -psF64 psPolynomial3DEval(const psPolynomial3D* poly, psF64 x, psF64 y, psF64 z) -{ - PS_ASSERT_POLY_NON_NULL(poly, NAN); - - if (poly->type == PS_POLYNOMIAL_ORD) { - return(ordPolynomial3DEval(x, y, z, poly)); - } else if (poly->type == PS_POLYNOMIAL_CHEB) { - return(chebPolynomial3DEval(x, y, z, poly)); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psFunctions_INVALID_POLYNOMIAL_TYPE, - poly->type); - } - return(NAN); -} - -psVector *psPolynomial3DEvalVector(const psPolynomial3D *poly, - const psVector *x, - const psVector *y, - const psVector *z) - -{ - PS_ASSERT_POLY_NON_NULL(poly, NULL); - PS_ASSERT_VECTOR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_TYPE(x, PS_TYPE_F32, NULL); - PS_ASSERT_VECTOR_NON_NULL(y, NULL); - PS_ASSERT_VECTOR_TYPE(y, PS_TYPE_F32, NULL); - PS_ASSERT_VECTOR_NON_NULL(z, NULL); - PS_ASSERT_VECTOR_TYPE(z, PS_TYPE_F32, NULL); - - psVector *tmp; - psS32 vecLen=x->n; - - // Determine the length of output vector from min of the input vectors - if (y->n < vecLen) { - vecLen = y->n; - } - if (z->n < vecLen) { - vecLen = z->n; - } - - // Allocate output vector - tmp = psVectorAlloc(vecLen, PS_TYPE_F32); - - // Evaluate polynomial - for (psS32 i = 0; i < vecLen; i++) { - tmp->data.F32[i] = psPolynomial3DEval(poly, - x->data.F32[i], - y->data.F32[i], - z->data.F32[i]); - } - - // Return output vector - return(tmp); -} - -psF64 psPolynomial4DEval(const psPolynomial4D* poly, psF64 x, psF64 y, psF64 z, psF64 t) -{ - PS_ASSERT_POLY_NON_NULL(poly, NAN); - - if (poly->type == PS_POLYNOMIAL_ORD) { - return(ordPolynomial4DEval(x,y,z,t, poly)); - } else if (poly->type == PS_POLYNOMIAL_CHEB) { - return(chebPolynomial4DEval(x,y,z,t, poly)); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psFunctions_INVALID_POLYNOMIAL_TYPE, - poly->type); - } - return(NAN); -} - -psVector *psPolynomial4DEvalVector(const psPolynomial4D *poly, - const psVector *x, - const psVector *y, - const psVector *z, - const psVector *t) -{ - PS_ASSERT_POLY_NON_NULL(poly, NULL); - PS_ASSERT_VECTOR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_TYPE(x, PS_TYPE_F32, NULL); - PS_ASSERT_VECTOR_NON_NULL(y, NULL); - PS_ASSERT_VECTOR_TYPE(y, PS_TYPE_F32, NULL); - PS_ASSERT_VECTOR_NON_NULL(z, NULL); - PS_ASSERT_VECTOR_TYPE(z, PS_TYPE_F32, NULL); - PS_ASSERT_VECTOR_NON_NULL(t, NULL); - PS_ASSERT_VECTOR_TYPE(t, PS_TYPE_F32, NULL); - - psVector *tmp; - psS32 vecLen=x->n; - - // Determine output vector size from min of input vectors - if (z->n < vecLen) { - vecLen = z->n; - } - if (y->n < vecLen) { - vecLen = y->n; - } - if (t->n < vecLen) { - vecLen = t->n; - } - - // Allocate output vector - tmp = psVectorAlloc(vecLen, PS_TYPE_F32); - - // Evaluate polynomial - for (psS32 i = 0; i < vecLen; i++) { - tmp->data.F32[i] = psPolynomial4DEval(poly, - x->data.F32[i], - y->data.F32[i], - z->data.F32[i], - t->data.F32[i]); - } - - // Return output vector - return(tmp); -} - - -psDPolynomial1D* psDPolynomial1DAlloc( int n, - psPolynomialType type) -{ - PS_ASSERT_INT_POSITIVE(n, NULL); - - unsigned int i = 0; - psDPolynomial1D* newPoly = NULL; - - newPoly = (psDPolynomial1D* ) psAlloc(sizeof(psDPolynomial1D)); - psMemSetDeallocator(newPoly, (psFreeFunc) dPolynomial1DFree); - - newPoly->type = type; - newPoly->n = n; - newPoly->coeff = (psF64 *)psAlloc(n * sizeof(psF64)); - newPoly->coeffErr = (psF64 *)psAlloc(n * sizeof(psF64)); - newPoly->mask = (char *)psAlloc(n * sizeof(char)); - for (i = 0; i < n; i++) { - newPoly->coeff[i] = 0.0; - newPoly->coeffErr[i] = 0.0; - newPoly->mask[i] = 0; - } - - return(newPoly); -} - -psDPolynomial2D* psDPolynomial2DAlloc( int nX, int nY, - psPolynomialType type) -{ - PS_ASSERT_INT_POSITIVE(nX, NULL); - PS_ASSERT_INT_POSITIVE(nY, NULL); - - unsigned int x = 0; - unsigned int y = 0; - psDPolynomial2D* newPoly = NULL; - - newPoly = (psDPolynomial2D* ) psAlloc(sizeof(psDPolynomial2D)); - psMemSetDeallocator(newPoly, (psFreeFunc) dPolynomial2DFree); - - newPoly->type = type; - newPoly->nX = nX; - newPoly->nY = nY; - - newPoly->coeff = (psF64 **)psAlloc(nX * sizeof(psF64 *)); - newPoly->coeffErr = (psF64 **)psAlloc(nX * sizeof(psF64 *)); - newPoly->mask = (char **)psAlloc(nX * sizeof(char *)); - for (x = 0; x < nX; x++) { - newPoly->coeff[x] = (psF64 *)psAlloc(nY * sizeof(psF64)); - newPoly->coeffErr[x] = (psF64 *)psAlloc(nY * sizeof(psF64)); - newPoly->mask[x] = (char *)psAlloc(nY * sizeof(char)); - } - for (x = 0; x < nX; x++) { - for (y = 0; y < nY; y++) { - newPoly->coeff[x][y] = 0.0; - newPoly->coeffErr[x][y] = 0.0; - newPoly->mask[x][y] = 0; - } - } - - return(newPoly); -} - -psDPolynomial3D* psDPolynomial3DAlloc( int nX, int nY, int nZ, - psPolynomialType type) -{ - PS_ASSERT_INT_POSITIVE(nX, NULL); - PS_ASSERT_INT_POSITIVE(nY, NULL); - PS_ASSERT_INT_POSITIVE(nZ, NULL); - - unsigned int x = 0; - unsigned int y = 0; - unsigned int z = 0; - psDPolynomial3D* newPoly = NULL; - - newPoly = (psDPolynomial3D* ) psAlloc(sizeof(psDPolynomial3D)); - psMemSetDeallocator(newPoly, (psFreeFunc) dPolynomial3DFree); - - newPoly->type = type; - newPoly->nX = nX; - newPoly->nY = nY; - newPoly->nZ = nZ; - - newPoly->coeff = (psF64 ***)psAlloc(nX * sizeof(psF64 **)); - newPoly->coeffErr = (psF64 ***)psAlloc(nX * sizeof(psF64 **)); - newPoly->mask = (char ***)psAlloc(nX * sizeof(char **)); - for (x = 0; x < nX; x++) { - newPoly->coeff[x] = (psF64 **)psAlloc(nY * sizeof(psF64 *)); - newPoly->coeffErr[x] = (psF64 **)psAlloc(nY * sizeof(psF64 *)); - newPoly->mask[x] = (char **)psAlloc(nY * sizeof(char *)); - for (y = 0; y < nY; y++) { - newPoly->coeff[x][y] = (psF64 *)psAlloc(nZ * sizeof(psF64)); - newPoly->coeffErr[x][y] = (psF64 *)psAlloc(nZ * sizeof(psF64)); - newPoly->mask[x][y] = (char *)psAlloc(nZ * sizeof(char)); - } - } - for (x = 0; x < nX; x++) { - for (y = 0; y < nY; y++) { - for (z = 0; z < nZ; z++) { - newPoly->coeff[x][y][z] = 0.0; - newPoly->coeffErr[x][y][z] = 0.0; - newPoly->mask[x][y][z] = 0; - } - } - } - - return(newPoly); -} - -psDPolynomial4D* psDPolynomial4DAlloc( int nX, int nY, int nZ, int nT, - psPolynomialType type) -{ - PS_ASSERT_INT_POSITIVE(nX, NULL); - PS_ASSERT_INT_POSITIVE(nY, NULL); - PS_ASSERT_INT_POSITIVE(nZ, NULL); - PS_ASSERT_INT_POSITIVE(nT, NULL); - - unsigned int x = 0; - unsigned int y = 0; - unsigned int z = 0; - unsigned int t = 0; - psDPolynomial4D* newPoly = NULL; - - newPoly = (psDPolynomial4D* ) psAlloc(sizeof(psDPolynomial4D)); - psMemSetDeallocator(newPoly, (psFreeFunc) dPolynomial4DFree); - - newPoly->type = type; - newPoly->nX = nX; - newPoly->nY = nY; - newPoly->nZ = nZ; - newPoly->nT = nT; - - newPoly->coeff = (psF64 ****)psAlloc(nX * sizeof(psF64 ***)); - newPoly->coeffErr = (psF64 ****)psAlloc(nX * sizeof(psF64 ***)); - newPoly->mask = (char ****)psAlloc(nX * sizeof(char ***)); - for (x = 0; x < nX; x++) { - newPoly->coeff[x] = (psF64 ***)psAlloc(nY * sizeof(psF64 **)); - newPoly->coeffErr[x] = (psF64 ***)psAlloc(nY * sizeof(psF64 **)); - newPoly->mask[x] = (char ***)psAlloc(nY * sizeof(char **)); - for (y = 0; y < nY; y++) { - newPoly->coeff[x][y] = (psF64 **)psAlloc(nZ * sizeof(psF64 *)); - newPoly->coeffErr[x][y] = (psF64 **)psAlloc(nZ * sizeof(psF64 *)); - newPoly->mask[x][y] = (char **)psAlloc(nZ * sizeof(char *)); - for (z = 0; z < nZ; z++) { - newPoly->coeff[x][y][z] = (psF64 *)psAlloc(nT * sizeof(psF64)); - newPoly->coeffErr[x][y][z] = (psF64 *)psAlloc(nT * sizeof(psF64)); - newPoly->mask[x][y][z] = (char *)psAlloc(nT * sizeof(char)); - } - } - } - for (x = 0; x < nX; x++) { - for (y = 0; y < nY; y++) { - for (z = 0; z < nZ; z++) { - for (t = 0; t < nT; t++) { - newPoly->coeff[x][y][z][t] = 0.0; - newPoly->coeffErr[x][y][z][t] = 0.0; - newPoly->mask[x][y][z][t] = 0; - } - } - } - } - - return(newPoly); -} - - -psF64 psDPolynomial1DEval(const psDPolynomial1D* poly, psF64 x) -{ - PS_ASSERT_POLY_NON_NULL(poly, NAN); - - if (poly->type == PS_POLYNOMIAL_ORD) { - return(dOrdPolynomial1DEval(x, poly)); - } else if (poly->type == PS_POLYNOMIAL_CHEB) { - return(dChebPolynomial1DEval(x, poly)); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psFunctions_INVALID_POLYNOMIAL_TYPE, - poly->type); - } - return(NAN); -} - -psVector *psDPolynomial1DEvalVector(const psDPolynomial1D *poly, - const psVector *x) - -{ - PS_ASSERT_POLY_NON_NULL(poly, NULL); - PS_ASSERT_VECTOR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_TYPE(x, PS_TYPE_F64, NULL); - - psVector *tmp; - - tmp = psVectorAlloc(x->n, PS_TYPE_F64); - for (psS32 i=0;in;i++) { - tmp->data.F64[i] = psDPolynomial1DEval(poly, - x->data.F64[i]); - } - - return(tmp); -} - - -psF64 psDPolynomial2DEval(const psDPolynomial2D* poly, - psF64 x, - psF64 y) -{ - PS_ASSERT_POLY_NON_NULL(poly, NAN); - if (poly->type == PS_POLYNOMIAL_ORD) { - return(dOrdPolynomial2DEval(x, y, poly)); - } else if (poly->type == PS_POLYNOMIAL_CHEB) { - return(dChebPolynomial2DEval(x, y, poly)); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psFunctions_INVALID_POLYNOMIAL_TYPE, - poly->type); - } - return(NAN); -} - -psVector *psDPolynomial2DEvalVector(const psDPolynomial2D *poly, - const psVector *x, - const psVector *y) -{ - PS_ASSERT_POLY_NON_NULL(poly, NULL); - PS_ASSERT_VECTOR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_TYPE(x, PS_TYPE_F64, NULL); - PS_ASSERT_VECTOR_NON_NULL(y, NULL); - PS_ASSERT_VECTOR_TYPE(y, PS_TYPE_F64, NULL); - - psVector *tmp; - psS32 vecLen=x->n; - - // Determine the output vector length from minimum length of input vectors - if (y->n < vecLen) { - vecLen = y->n; - } - - // Allocate output vector - tmp = psVectorAlloc(vecLen, PS_TYPE_F64); - - // Evaluate the polynomial - for (psS32 i = 0; i < vecLen; i++) { - tmp->data.F64[i] = psDPolynomial2DEval(poly,x->data.F64[i],y->data.F64[i]); - } - - // Return output vector - return(tmp); -} - - -psF64 psDPolynomial3DEval(const psDPolynomial3D* poly, - psF64 x, - psF64 y, - psF64 z) -{ - PS_ASSERT_POLY_NON_NULL(poly, NAN); - - if (poly->type == PS_POLYNOMIAL_ORD) { - return(dOrdPolynomial3DEval(x, y, z, poly)); - } else if (poly->type == PS_POLYNOMIAL_CHEB) { - return(dChebPolynomial3DEval(x, y, z, poly)); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psFunctions_INVALID_POLYNOMIAL_TYPE, - poly->type); - } - return(NAN); -} - -psVector *psDPolynomial3DEvalVector(const psDPolynomial3D *poly, - const psVector *x, - const psVector *y, - const psVector *z) - -{ - PS_ASSERT_POLY_NON_NULL(poly, NULL); - PS_ASSERT_VECTOR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_TYPE(x, PS_TYPE_F64, NULL); - PS_ASSERT_VECTOR_NON_NULL(y, NULL); - PS_ASSERT_VECTOR_TYPE(y, PS_TYPE_F64, NULL); - PS_ASSERT_VECTOR_NON_NULL(z, NULL); - PS_ASSERT_VECTOR_TYPE(z, PS_TYPE_F64, NULL); - - psVector *tmp; - psS32 vecLen=x->n; - - // Determine the size of output vector from min of input vectors - if (y->n < vecLen) { - vecLen = y->n; - } - if (z->n < vecLen) { - vecLen = z->n; - } - - // Allocate output vector - tmp = psVectorAlloc(vecLen, PS_TYPE_F64); - - // Evaluate polynomial - for (psS32 i = 0; i < vecLen; i++) { - tmp->data.F64[i] = psDPolynomial3DEval(poly, - x->data.F64[i], - y->data.F64[i], - z->data.F64[i]); - } - - // Return output vector - return(tmp); -} - -psF64 psDPolynomial4DEval(const psDPolynomial4D* poly, - psF64 x, - psF64 y, - psF64 z, - psF64 t) -{ - PS_ASSERT_POLY_NON_NULL(poly, NAN); - - if (poly->type == PS_POLYNOMIAL_ORD) { - return(dOrdPolynomial4DEval(x,y,z,t, poly)); - } else if (poly->type == PS_POLYNOMIAL_CHEB) { - return(dChebPolynomial4DEval(x,y,z,t, poly)); - } else { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psFunctions_INVALID_POLYNOMIAL_TYPE, - poly->type); - } - return(NAN); -} - -psVector *psDPolynomial4DEvalVector(const psDPolynomial4D *poly, - const psVector *x, - const psVector *y, - const psVector *z, - const psVector *t) -{ - PS_ASSERT_POLY_NON_NULL(poly, NULL); - PS_ASSERT_VECTOR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_TYPE(x, PS_TYPE_F64, NULL); - PS_ASSERT_VECTOR_NON_NULL(y, NULL); - PS_ASSERT_VECTOR_TYPE(y, PS_TYPE_F64, NULL); - PS_ASSERT_VECTOR_NON_NULL(z, NULL); - PS_ASSERT_VECTOR_TYPE(z, PS_TYPE_F64, NULL); - PS_ASSERT_VECTOR_NON_NULL(t, NULL); - PS_ASSERT_VECTOR_TYPE(t, PS_TYPE_F64, NULL); - - psVector *tmp; - psS32 vecLen=x->n; - - // Determine the output vector size from min of input vectors - if (z->n < vecLen) { - vecLen = z->n; - } - if (y->n < vecLen) { - vecLen = y->n; - } - if (t->n < vecLen) { - vecLen = t->n; - } - - // Allocate output vector - tmp = psVectorAlloc(vecLen, PS_TYPE_F64); - - // Evaluate the polynomial - for (psS32 i = 0; i < vecLen; i++) { - tmp->data.F64[i] = psDPolynomial4DEval(poly, - x->data.F64[i], - y->data.F64[i], - z->data.F64[i], - t->data.F64[i]); - } - - // Return output vector - return(tmp); -} - - - - -//typedef struct { -// psS32 n; -// psPolynomial1D **spline; -// psF32 *p_psDeriv2; -// psVector *knots; -//} psSpline1D; - -/***************************************************************************** - NOTE: "n" specifies the number of spline polynomials. Therefore, there - must exist n+1 points in "knots". - -XXX: Ensure that domain[i+1] != domain[i] - -XXX: What should be the defualty type for knots be? psF32 is assumed. - *****************************************************************************/ -psSpline1D *psSpline1DAlloc( int numSplines, - int order, - float min, - float max) -{ - PS_ASSERT_INT_NONNEGATIVE(numSplines, NULL); - PS_ASSERT_INT_NONNEGATIVE(order, NULL); - PS_ASSERT_FLOAT_NON_EQUAL(max, min, NULL); - - psSpline1D *tmp = NULL; - psS32 i; - psF32 tmpDomain; - psF32 width; - - tmp = (psSpline1D *) psAlloc(sizeof(psSpline1D)); - tmp->n = numSplines; - - tmp->spline = (psPolynomial1D **) psAlloc(numSplines * sizeof(psPolynomial1D *)); - for (i=0;ispline)[i] = psPolynomial1DAlloc(order+1, PS_POLYNOMIAL_ORD); - } - - // This should be set by the psVectorFitSpline1D() - tmp->p_psDeriv2 = NULL; - - tmp->knots = psVectorAlloc(numSplines+1, PS_TYPE_F32); - width = (max - min) / ((psF32) numSplines); - - tmp->knots->data.F32[0] = min; - tmpDomain = min+width; - for (i=1;iknots->data.F32[i] = tmpDomain; - tmpDomain+= width; - } - tmp->knots->data.F32[numSplines] = max; - - psMemSetDeallocator(tmp,(psFreeFunc)spline1DFree); - return(tmp); -} - - -/***************************************************************************** -XXX: What should be the defualty type for knots be? psF32 is assumed. - *****************************************************************************/ -psSpline1D *psSpline1DAllocGeneric(const psVector *bounds, - int order) -{ - PS_ASSERT_VECTOR_NON_NULL(bounds, NULL); - PS_ASSERT_VECTOR_NON_EMPTY(bounds, NULL); - PS_ASSERT_INT_NONNEGATIVE(order, NULL); - - psSpline1D *tmp = NULL; - unsigned int i; - unsigned int numSplines; - - tmp = (psSpline1D *) psAlloc(sizeof(psSpline1D)); - - numSplines = bounds->n - 1; - tmp->n = numSplines; - - tmp->spline = (psPolynomial1D **) psAlloc(numSplines * sizeof(psPolynomial1D *)); - for (i=0;ispline)[i] = psPolynomial1DAlloc(order+1, PS_POLYNOMIAL_ORD); - } - - // This should be set by the psVectorFitSpline1D() - tmp->p_psDeriv2 = NULL; - - tmp->knots = psVectorAlloc(bounds->n, PS_TYPE_F32); - - for (i=0;in;i++) { - tmp->knots->data.F32[i] = bounds->data.F32[i]; - if (i<(bounds->n-1)) { - if (FLT_EPSILON >= fabs(bounds->data.F32[i+1]-bounds->data.F32[i])) { - psError(PS_ERR_UNKNOWN, true, "data points must be distinct\n"); - } - } - } - - psMemSetDeallocator(tmp,(psFreeFunc)spline1DFree); - return(tmp); -} - -/***************************************************************************** -vectorBinDisectF32(): This is a macro for a private function which takes as -input a vector an array of data as well as a single value for that data. The -input vector values are assumed to be non-decreasing (v[i-1] <= v[i] for all -i). This routine does a binary disection of the vector and returns "i" such -that (v[i] <= x <= v[i+1). If x lies outside the range of v[], then this -routine prints a warning message and returns (-2 or -1). - *****************************************************************************/ -#define FUNC_MACRO_VECTOR_BIN_DISECT(TYPE) \ -static psS32 vectorBinDisect##TYPE(ps##TYPE *bins, \ - psS32 numBins, \ - ps##TYPE x) \ -{ \ - psS32 min; \ - psS32 max; \ - psS32 mid; \ - \ - psTrace(".psLib.dataManip.psFunctions.vectorBinDisect##TYPE", 4, \ - "---- Calling vectorBinDisect##TYPE(%f)\n", x); \ - \ - if (x < bins[0]) { \ - psLogMsg(__func__, PS_LOG_WARN, \ - "vectorBinDisect%s(): ordinate %f is outside vector range (%f - %f).", \ - #TYPE, x, bins[0], bins[numBins-1]); \ - return(-2); \ - } \ - \ - if (x > bins[numBins-1]) { \ - psLogMsg(__func__, PS_LOG_WARN, \ - "vectorBinDisect%s(): ordinate %f is outside vector range (%f - %f).", \ - #TYPE, x, bins[0], bins[numBins-1]); \ - return(-1); \ - } \ - \ - min = 0; \ - max = numBins-2; \ - mid = ((max+1)-min)/2; \ - \ - while (min != max) { \ - psTrace(".psLib.dataManip.psFunctions.vectorBinDisect##TYPE", 4, \ - "(min, mid, max) is (%d, %d, %d): (x, bins) is (%f, %f)\n", \ - min, mid, max, x, bins[mid]); \ - \ - if (x == bins[mid]) { \ - psTrace(".psLib.dataManip.psFunctions.vectorBinDisect##TYPE", 4, \ - "---- Exiting vectorBinDisect##TYPE(): bin %d\n", mid); \ - return(mid); \ - } else if (x < bins[mid]) { \ - max = mid-1; \ - } else { \ - min = mid; \ - } \ - mid = ((max+1)+min)/2; \ - } \ - \ - psTrace(".psLib.dataManip.psFunctions.vectorBinDisect##TYPE", 4, \ - "---- Exiting vectorBinDisect##TYPE(): bin %d\n", min); \ - return(min); \ -} \ - -FUNC_MACRO_VECTOR_BIN_DISECT(S8) -FUNC_MACRO_VECTOR_BIN_DISECT(S16) -FUNC_MACRO_VECTOR_BIN_DISECT(S32) -FUNC_MACRO_VECTOR_BIN_DISECT(S64) -FUNC_MACRO_VECTOR_BIN_DISECT(U8) -FUNC_MACRO_VECTOR_BIN_DISECT(U16) -FUNC_MACRO_VECTOR_BIN_DISECT(U32) -FUNC_MACRO_VECTOR_BIN_DISECT(U64) -FUNC_MACRO_VECTOR_BIN_DISECT(F32) -FUNC_MACRO_VECTOR_BIN_DISECT(F64) - -/***************************************************************************** -p_psVectorBinDisect(): A wrapper to the above p_psVectorBinDisect(). - *****************************************************************************/ -psS32 p_psVectorBinDisect(psVector *bins, - psScalar *x) -{ - PS_ASSERT_VECTOR_NON_NULL(bins, -4); - PS_ASSERT_VECTOR_NON_EMPTY(bins, -4); - PS_ASSERT_PTR_NON_NULL(x, -6); - PS_ASSERT_PTR_TYPE_EQUAL(x, bins, -3); - char* strType; - - switch (x->type.type) { - case PS_TYPE_U8: - return(vectorBinDisectU8(bins->data.U8, bins->n, x->data.U8)); - case PS_TYPE_U16: - return(vectorBinDisectU16(bins->data.U16, bins->n, x->data.U16)); - case PS_TYPE_U32: - return(vectorBinDisectU32(bins->data.U32, bins->n, x->data.U32)); - case PS_TYPE_U64: - return(vectorBinDisectU64(bins->data.U64, bins->n, x->data.U64)); - case PS_TYPE_S8: - return(vectorBinDisectS8(bins->data.S8, bins->n, x->data.S8)); - case PS_TYPE_S16: - return(vectorBinDisectS16(bins->data.S16, bins->n, x->data.S16)); - case PS_TYPE_S32: - return(vectorBinDisectS32(bins->data.S32, bins->n, x->data.S32)); - case PS_TYPE_S64: - return(vectorBinDisectS64(bins->data.S64, bins->n, x->data.S64)); - case PS_TYPE_F32: - return(vectorBinDisectF32(bins->data.F32, bins->n, x->data.F32)); - case PS_TYPE_F64: - return(vectorBinDisectF64(bins->data.F64, bins->n, x->data.F64)); - case PS_TYPE_C32: - PS_TYPE_NAME(strType,x->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, - PS_ERRORTEXT_psFunctions_TYPE_NOT_SUPPORTED, - strType); - return 0; - case PS_TYPE_C64: - PS_TYPE_NAME(strType,x->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, - PS_ERRORTEXT_psFunctions_TYPE_NOT_SUPPORTED, - strType); - return 0; - case PS_TYPE_BOOL: - PS_TYPE_NAME(strType,x->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, - PS_ERRORTEXT_psFunctions_TYPE_NOT_SUPPORTED, - strType); - return 0; - } - return(-3); -} - -/***************************************************************************** -p_psVectorInterpolate(): This routine will take as input psVectors domain and -range, and the x value, assumed to lie with the domain vector. It produces -as output the LaGrange interpolated value of a polynomial of the specified -order around the point x. - -XXX: This stuff does not currently work with a mask. - -XXX: add another psScalar argument for the result. - -XXX: The VectorCopy routines seg fault when I declare range32 as static. - *****************************************************************************/ -psScalar *p_psVectorInterpolate(psVector *domain, - psVector *range, - int order, - psScalar *x) -{ - PS_ASSERT_VECTOR_NON_NULL(domain, NULL); - PS_ASSERT_VECTOR_NON_NULL(range, NULL); - PS_ASSERT_PTR_NON_NULL(x, NULL); - PS_ASSERT_INT_NONNEGATIVE(order, NULL); - PS_ASSERT_VECTORS_SIZE_EQUAL(domain, range, NULL); - PS_ASSERT_PTR_TYPE_EQUAL(domain, range, NULL); - PS_ASSERT_PTR_TYPE_EQUAL(domain, x, NULL); - - psVector *range32 = NULL; - psVector *domain32 = NULL; - psTrace(".psLib.dataManip.psFunctions.p_psVectorInterpolate", 4, - "---- p_psVectorInterpolate() begin ----\n"); - - if (order > (domain->n - 1)) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psFunctions_NOT_ENOUGH_DATAPOINTS, - order); - return(NULL); - } - - if (x->type.type == PS_TYPE_F32) { - psTrace(".psLib.dataManip.psFunctions.p_psVectorInterpolate", 4, - "---- p_psVectorInterpolate() end ----\n"); - return(psScalarAlloc(interpolate1DF32(domain->data.F32, - range->data.F32, - domain->n, - order, - x->data.F32), PS_TYPE_F32)); - } else if (x->type.type == PS_TYPE_F64) { - // XXX: use recycled vectors here. - range32 = psVectorCopy(range32, range, PS_TYPE_F32); - domain32 = psVectorCopy(domain32, domain, PS_TYPE_F32); - - psScalar *tmpScalar = psScalarAlloc((psF64) - interpolate1DF32(domain32->data.F32, - range32->data.F32, - domain32->n, - order, - (psF32) x->data.F64), PS_TYPE_F64); - psFree(range32); - psFree(domain32); - - psTrace(".psLib.dataManip.psFunctions.p_psVectorInterpolate", 4, - "---- p_psVectorInterpolate() end ----\n"); - // XXX: Convert data type to F64? - return(tmpScalar); - - } else { - char* strType; - PS_TYPE_NAME(strType,x->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, - PS_ERRORTEXT_psFunctions_TYPE_NOT_SUPPORTED, - strType); - } - - psTrace(".psLib.dataManip.psFunctions.p_psVectorInterpolate", 4, - "return(NULL)\n"); - psTrace(".psLib.dataManip.psFunctions.p_psVectorInterpolate", 4, - "---- p_psVectorInterpolate() end ----\n"); - - return(NULL); -} - - -/***************************************************************************** -psSpline1DEval(): this routine takes an existing spline of arbitrary order -and an independent x value. Each determines which spline that x corresponds -to by doing a bracket disection on the knots of the spline data structure -(vectorBinDisectF32()). Then it evaluates the spline at that x location -by a call to the 1D polynomial functions. - -XXX: The spline eval functions require input and output to be F32. however - the spline fit functions require F32 and F64. - -XXX: This only works if spline0>knots if psF32. Must add support for psU32 and -psF64. - *****************************************************************************/ -float psSpline1DEval( - const psSpline1D *spline, - float x -) -{ - PS_ASSERT_PTR_NON_NULL(spline, NAN); - PS_ASSERT_INT_NONNEGATIVE(spline->n, NAN); - PS_ASSERT_VECTOR_TYPE(spline->knots, PS_TYPE_F32, NAN); - - unsigned int binNum; - unsigned int n; - - n = spline->n; - //XXX binNum = vectorBinDisectF32(spline->domains, (spline->n)+1, x); - binNum = vectorBinDisectF32(spline->knots->data.F32, (spline->n)+1, x); - if (binNum < 0) { - psLogMsg(__func__, PS_LOG_WARN, - "psSpline1DEval(): x ordinate (%f) is outside the spline range (%f - %f).", - x, spline->knots->data.F32[0], - spline->knots->data.F32[n-1]); - - if (x < spline->knots->data.F32[0]) { - return(psPolynomial1DEval(spline->spline[0], - x)); - } else if (x > spline->knots->data.F32[n-1]) { - return(psPolynomial1DEval(spline->spline[n-1], - x)); - } - } - - return(psPolynomial1DEval(spline->spline[binNum], - x)); -} - -// XXX: The spline eval functions require input and output to be F32. -// however the spline fit functions require F32 and F64. -psVector *psSpline1DEvalVector( - const psSpline1D *spline, - const psVector *x -) -{ - PS_ASSERT_PTR_NON_NULL(spline, NULL); - PS_ASSERT_VECTOR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_TYPE_F32_OR_F64(x, NULL); - PS_ASSERT_VECTOR_TYPE(spline->knots, PS_TYPE_F32, NULL); - - unsigned int i; - psVector *tmpVector; - - tmpVector = psVectorAlloc(x->n, PS_TYPE_F32); - if (x->type.type == PS_TYPE_F32) { - for (i=0;in;i++) { - tmpVector->data.F32[i] = psSpline1DEval( - spline, - x->data.F32[i] - ); - } - } else if (x->type.type == PS_TYPE_F64) { - for (i=0;in;i++) { - tmpVector->data.F32[i] = psSpline1DEval( - spline, - (psF32) x->data.F64[i] - ); - } - } else { - char* strType; - PS_TYPE_NAME(strType,x->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, - PS_ERRORTEXT_psFunctions_TYPE_NOT_SUPPORTED, - strType); - return(NULL); - } - - return(tmpVector); -} Index: unk/psLib/src/dataManip/psFunctions.h =================================================================== --- /trunk/psLib/src/dataManip/psFunctions.h (revision 4545) +++ (revision ) @@ -1,519 +1,0 @@ -/** @file psFunctions.h - * @brief Standard Mathematical Functions. - * @ingroup Stats - * - * This file will hold the prototypes for procedures which allocate, free, - * and evaluate various polynomials. Those polynomial structures are also - * defined here. - * - * @ingroup Stats - * - * @author Someone at IfA - * @author GLG, MHPCC - * - * @version $Revision: 1.53 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-09 02:11:01 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_FUNCTIONS_H -#define PS_FUNCTIONS_H - -#include -#include -#include -#include - -#include "psVector.h" -#include "psScalar.h" - -/** \addtogroup Stats - * \{ - */ - -/** Evaluate a non-normalized Gaussian with the given mean and sigma at the - * given coordianate. - * - * Note that this is not a Gaussian deviate. The evaluated Gaussian is: - * \f[ exp(-\frac{(x-mean)^2}{2\sigma^2}) \f] - * - * @return float value on the gaussian curve given the input parameters - */ -float psGaussian( - float x, ///< Value at which to evaluate - float mean, ///< Mean for the Gaussian - float sigma, ///< Standard deviation for the Gaussian - bool normal ///< Indicates whether result should be normalized -); - -/** Produce a vector of random numbers from a Gaussian distribution with - * the specified mean and sigma - * - * @return psVector* vector of random numbers - * - */ -psVector* p_psGaussianDev( - psF32 mean, ///< The mean of the Gaussian - psF32 sigma, ///< The sigma of the Gaussian - psS32 Npts ///< The size of the vector -); - -/** Polynomial Type. - * - * Enumeration for Polynomial types. - */ -typedef enum { - PS_POLYNOMIAL_ORD, ///< Ordinary Polynomial - PS_POLYNOMIAL_CHEB ///< Chebyshev Polynomial -} -psPolynomialType; - -/** One-dimensional polynomial */ -typedef struct -{ - psPolynomialType type; ///< Polynomial type - psElemType ctype; ///< Polynomial precision - int n; ///< Number of terms - psF32 *coeff; ///< Coefficients - psF32 *coeffErr; ///< Error in coefficients - char *mask; ///< Coefficient mask -} -psPolynomial1D; - -/** Two-dimensional polynomial */ -typedef struct -{ - psPolynomialType type; ///< Polynomial type - psElemType ctype; ///< Polynomial precision - int nX; ///< Number of terms in x - int nY; ///< Number of terms in y - psF32 **coeff; ///< Coefficients - psF32 **coeffErr; ///< Error in coefficients - char **mask; ///< Coefficients mask -} -psPolynomial2D; - -/** Three-dimensional polynomial */ -typedef struct -{ - psPolynomialType type; ///< Polynomial type - psElemType ctype; ///< Polynomial precision - int nX; ///< Number of terms in x - int nY; ///< Number of terms in y - int nZ; ///< Number of terms in z - psF32 ***coeff; ///< Coefficients - psF32 ***coeffErr; ///< Error in coefficients - char ***mask; ///< Coefficients mask -} -psPolynomial3D; - -/** Four-dimensional polynomial */ -typedef struct -{ - psPolynomialType type; ///< Polynomial type - psElemType ctype; ///< Polynomial precision - int nX; ///< Number of terms in x - int nY; ///< Number of terms in y - int nZ; ///< Number of terms in z - int nT; ///< Number of terms in t - psF32 ****coeff; ///< Coefficients - psF32 ****coeffErr; ///< Error in coefficients - char ****mask; ///< Coefficients mask -} -psPolynomial4D; - - -/** Allocates a psPolynomial1D structure with n terms - * - * @return psPolynomial1D* new 1-D polynomial struct - */ -psPolynomial1D* psPolynomial1DAlloc( - int n, ///< Number of terms - psPolynomialType type ///< Polynomial Type -); - -/** Allocates a 2-D polynomial structure - * - * @return psPolynomial2D* new 2-D polynomial struct - */ -psPolynomial2D* psPolynomial2DAlloc( - int nX, ///< Number of terms in x - int nY, ///< Number of terms in y - psPolynomialType type ///< Polynomial Type -); - -/** Allocates a 3-D polynomial structure - * - * @return psPolynomial3D* new 3-D polynomial struct - */ -psPolynomial3D* psPolynomial3DAlloc( - int nX, ///< Number of terms in x - int nY, ///< Number of terms in y - int nZ, ///< Number of terms in z - psPolynomialType type ///< Polynomial Type -); - -/** Allocates a 4-D polynomial structure - * - * @return psPolynomial4D* new 4-D polynomial struct - */ -psPolynomial4D* psPolynomial4DAlloc( - int nX, ///< Number of terms in x - int nY, ///< Number of terms in y - int nZ, ///< Number of terms in z - int nT, ///< Number of terms in t - psPolynomialType type ///< Polynomial Type -); - -/** Evaluates a 1-D polynomial at specific coordinates. - * - * @return psF64 result of polynomial at given location - */ -psF64 psPolynomial1DEval( - const psPolynomial1D* poly, ///< Coefficients for the polynomial - psF64 x ///< location at which to evaluate -); - -/** Evaluates a 2-D polynomial at specific coordinates. - * - * @return psF64 result of polynomial at given location - */ -psF64 psPolynomial2DEval( - const psPolynomial2D* poly, ///< Coefficients for the polynomial - psF64 x, ///< x location at which to evaluate - psF64 y ///< y location at which to evaluate -); - -/** Evaluates a 3-D polynomial at specific coordinates. - * - * @return psF64 result of polynomial at given location - */ -psF64 psPolynomial3DEval( - const psPolynomial3D* poly, ///< Coefficients for the polynomial - psF64 x, ///< x location at which to evaluate - psF64 y, ///< y location at which to evaluate - psF64 z ///< z location at which to evaluate -); - -/** Evaluates a 4-D polynomial at specific coordinates. - * - * @return psF64 result of polynomial at given location - */ -psF64 psPolynomial4DEval( - const psPolynomial4D* poly, ///< Coefficients for the polynomial - psF64 x, ///< x location at which to evaluate - psF64 y, ///< y location at which to evaluate - psF64 z, ///< z location at which to evaluate - psF64 t ///< t location at which to evaluate -); - -/** Evaluates a 1-D polynomial at specific sets of coordinates - * - * @return psVector* results of polynomials at given locations - */ -psVector *psPolynomial1DEvalVector( - const psPolynomial1D *poly, ///< Coefficients for the polynomial - const psVector *x ///< x locations at which to evaluate -); - -/** Evaluates a 2-D polynomial at specific sets of coordinates - * - * @return psVector* results of polynomial at given locations - */ -psVector *psPolynomial2DEvalVector( - const psPolynomial2D *poly, ///< Coefficients for the polynomial - const psVector *x, ///< x locations at which to evaluate - const psVector *y ///< y locations at which to evaluate -); - -/** Evaluates a 3-D polynomial at specific sets of coordinates - * - * @return psVector* results of polynomial at given locations - */ -psVector *psPolynomial3DEvalVector( - const psPolynomial3D *poly, ///< Coefficients for the polynomial - const psVector *x, ///< x locations at which to evaluate - const psVector *y, ///< y locations at which to evaluate - const psVector *z ///< z locations at which to evaluate -); - -/** Evaluates a 4-D polynomial at specific sets of coordinates - * - * @return psVector* results of polynomial at given locations - */ -psVector *psPolynomial4DEvalVector( - const psPolynomial4D *poly, ///< Coefficients for the polynomial - const psVector *x, ///< x locations at which to evaluate - const psVector *y, ///< y locations at which to evaluate - const psVector *z, ///< z locations at which to evaluate - const psVector *t ///< t locations at which to evaluate -); - -/*****************************************************************************/ - -/* Double-precision polynomials, mainly for use in astrometry */ - -/** Double-precision one-dimensional polynomial */ -typedef struct -{ - psPolynomialType type; ///< Polynomial type - int n; ///< Number of terms - psF64 *coeff; ///< Coefficients - psF64 *coeffErr; ///< Error in coefficients - char *mask; ///< Coefficient mask -} -psDPolynomial1D; - -/** Double-precision two-dimensional polynomial */ -typedef struct -{ - psPolynomialType type; ///< Polynomial type - int nX; ///< Number of terms in x - int nY; ///< Number of terms in y - psF64 **coeff; ///< Coefficients - psF64 **coeffErr; ///< Error in coefficients - char **mask; ///< Coefficients mask -} -psDPolynomial2D; - -/** Double-precision three-dimensional polynomial */ -typedef struct -{ - psPolynomialType type; ///< Polynomial type - int nX; ///< Number of terms in x - int nY; ///< Number of terms in y - int nZ; ///< Number of terms in z - psF64 ***coeff; ///< Coefficients - psF64 ***coeffErr; ///< Error in coefficients - char ***mask; ///< Coefficient mask -} -psDPolynomial3D; - -/** Double-precision four-dimensional polynomial */ -typedef struct -{ - psPolynomialType type; ///< Polynomial type - int nX; ///< Number of terms in w - int nY; ///< Number of terms in x - int nZ; ///< Number of terms in y - int nT; ///< Number of terms in z - psF64 ****coeff; ///< Coefficients - psF64 ****coeffErr; ///< Error in coefficients - char ****mask; ///< Coefficients mask -} -psDPolynomial4D; - -/** Allocates a double-precision 1-D polynomial structure with n terms - * - * @return psPolynomial1D* new double-precision 1-D polynomial struct - */ -psDPolynomial1D* psDPolynomial1DAlloc( - int n, ///< Number of terms - psPolynomialType type ///< Polynomial Type -); - -/** Allocates a double-precision 2-D polynomial structure - * - * @return psPolynomial2D* new double-precision 2-D polynomial struct - */ -psDPolynomial2D* psDPolynomial2DAlloc( - int nX, ///< Number of terms in x - int nY, ///< Number of terms in y - psPolynomialType type ///< Polynomial Type -); - -/** Allocates a double-precision 3-D polynomial structure - * - * @return psPolynomial3D* new double-precision 3-D polynomial struct - */ -psDPolynomial3D* psDPolynomial3DAlloc( - int nX, ///< Number of terms in x - int nY, ///< Number of terms in y - int nZ, ///< Number of terms in z - psPolynomialType type ///< Polynomial Type -); - -/** Allocates a double-precision 4-D polynomial structure - * - * @return psPolynomial4D* new double-precision 4-D polynomial struct - */ -psDPolynomial4D* psDPolynomial4DAlloc( - int nX, ///< Number of terms in w - int nY, ///< Number of terms in x - int nZ, ///< Number of terms in y - int nT, ///< Number of terms in z - psPolynomialType type ///< Polynomial Type -); - -/** Evaluates a double-precision 1-D polynomial at specific coordinates. - * - * @return psF32 result of polynomial at given location - */ -psF64 psDPolynomial1DEval( - const psDPolynomial1D* poly, ///< Coefficients for the polynomial - psF64 x ///< Value at which to evaluate -); - -/** Evaluates a double-precision 2-D polynomial at specific coordinates. - * - * @return psF32 result of polynomial at given location - */ -psF64 psDPolynomial2DEval( - const psDPolynomial2D* poly, ///< Coefficients for the polynomial - psF64 x, ///< Value x at which to evaluate - psF64 y ///< Value y at which to evaluate -); - -/** Evaluates a double-precision 3-D polynomial at specific coordinates. - * - * @return psF64 result of polynomial at given location - */ -psF64 psDPolynomial3DEval( - const psDPolynomial3D* poly, ///< Coefficients for the polynomial - psF64 x, ///< Value x at which to evaluate - psF64 y, ///< Value y at which to evaluate - psF64 z ///< Value z at which to evaluate -); - -/** Evaluates a double-precision 4-D polynomial at specific coordinates. - * - * @return psF64 result of polynomial at given location - */ -psF64 psDPolynomial4DEval( - const psDPolynomial4D* poly, ///< Coefficients for the polynomial - psF64 x, ///< Value w at which to evaluate - psF64 y, ///< Value x at which to evaluate - psF64 z, ///< Value y at which to evaluate - psF64 t ///< Value z at which to evaluate -); - -/** Evaluates a double-precision 1-D polynomial at specific sets of coordinates. - * - * @return psVector* results of polynomial at given locations - */ -psVector *psDPolynomial1DEvalVector( - const psDPolynomial1D *poly, ///< Coefficients for the polynomial - const psVector *x ///< x locations at which to evaluate -); - -/** Evaluates a double-precision 2-D polynomial at specific sets of coordinates. - * - * @return psVector* results of polynomial at given locations - */ -psVector *psDPolynomial2DEvalVector( - const psDPolynomial2D *poly, ///< Coefficients for the polynomial - const psVector *x, ///< x locations at which to evaluate - const psVector *y ///< y locations at which to evaluate -); - -/** Evaluates a double-precision 3-D polynomial at specific sets of coordinates. - * - * @return psVector* results of polynomial at given locations - */ -psVector *psDPolynomial3DEvalVector( - const psDPolynomial3D *poly, ///< Coefficients for the polynomial - const psVector *x, ///< x locations at which to evaluate - const psVector *y, ///< y locations at which to evaluate - const psVector *z ///< z locations at which to evaluate -); - -/** Evaluates a double-precision 4-D polynomial at specific sets of coordinates. - * - * @return psVector* results of polynomial at given locations - */ -psVector *psDPolynomial4DEvalVector( - const psDPolynomial4D *poly, ///< Coefficients for the polynomial - const psVector *x, ///< w locations at which to evaluate - const psVector *y, ///< x locations at which to evaluate - const psVector *z, ///< y locations at which to evaluate - const psVector *t ///< z locations at which to evaluate -); - -/** One-Dimensional Spline */ -typedef struct -{ - unsigned int n; ///< The number of spline polynomials - psPolynomial1D **spline; ///< An array of n pointers to the spline polynomials - psF32 *p_psDeriv2; ///< For cubic splines, the second derivative at each domain point. Size is n+1. - psF32 *domains; ///< The boundaries between each spline piece. Size is n+1. - psVector *knots; ///< The boundaries between each spline piece. Size is n+1. -} -psSpline1D; - -/** Allocates a psSpline1D structure - * - * Allocator for psSpline1D where the bounds are implicitly specified through specifying - * min and max values along with the number of splines. - * - * @return psSpline1D* new 1-D spline struct - */ -psSpline1D *psSpline1DAlloc( - int n, ///< Number of spline polynomials - int order, ///< Order of spline polynomials - float min, ///< Lower boundary value of spline polynomials - float max ///< Upper boundary value of spline polynomials -); - -/** Allocates a psSpline1D structure - * - * Allocator for psSpline1D where the bounds are explicitly specified. - * - * @return psSpline1D* new 1-D spline struct - */ -psSpline1D *psSpline1DAllocGeneric( - const psVector *bounds, ///< Bounds for spline polynomials - int order ///< Order of spline polynomials -); - -/** Evaluates 1-D spline polynomials at a specific coordinate. - * - * @return float result of spline polynomials evaluated at given location - */ -float psSpline1DEval( - const psSpline1D *spline, ///< Coefficients for spline polynomials - float x ///< location at which to evaluate -); - -/** Evaluates 1-D spline polynomials at a set of specific coordinates. - * - * @return psVector* results of spline polynomials evaluated at given locations - */ -psVector *psSpline1DEvalVector( - const psSpline1D *spline, ///< Coefficients of spline polynomials - const psVector *x ///< locations at which to evaluate -); - -/** Performs a binary disection on a given vector. - * Searches through an array of data for a specified value. - * - * @return psS32 corresponding index number of specified value - */ -psS32 p_psVectorBinDisect( - psVector *bins, ///< Array of non-decreasing values - psScalar *x ///< Target value to find -); - -/** Interpolates a series of data points for evaluation at a specific coordinate. Uses a - * Lagrange interpolation method. - * - * @return psScalar* Lagrange interpolation value at given location - */ -psScalar *p_psVectorInterpolate( - psVector *domain, ///< Domain (x coords) for interpolation - psVector *range, ///< Range (y coords) for interpolation - int order, ///< Order of interpolation function - psScalar *x ///< Location at which to evaluate -); - -#if 0 -psF32 p_psNRSpline1DEval(psSpline1D *spline, - const psVector* x, - const psVector* y, - psF32 X); -#endif // #if 0 - -/** \} */ // End of MathGroup Functions - -#endif // #ifndef PS_FUNCTIONS_H - Index: unk/psLib/src/dataManip/psMatrix.c =================================================================== --- /trunk/psLib/src/dataManip/psMatrix.c (revision 4545) +++ (revision ) @@ -1,650 +1,0 @@ -/** @file psMatrix.c - * - * @brief Provides functions for linear algebra operations on psImages and psVectors. - * - * Functions are provided to: - * Transpose a psImage - * Compute LUD - * Solve LUD - * Matrix inversion - * Calculate determinant - * Matrix addition - * Matrix subtraction - * Matrix multiplication - * Calculate Eigenvectors - * Convert matrix to vector - * Convert vector to matrix - * - * These functions treat psImages as if they were matrices, therefore there is no psMatrix. - * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.34 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-25 01:15:01 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -/******************************************************************************/ -/* INCLUDE FILES */ -/******************************************************************************/ -#include -#include -#include -#include -#include -#include - -#include "psMemory.h" -#include "psError.h" -#include "psImage.h" -#include "psVector.h" -#include "psMatrix.h" -#include "psConstants.h" -#include "psDataManipErrors.h" - - -/*****************************************************************************/ -/* DEFINE STATEMENTS */ -/*****************************************************************************/ - -/** Preprocessor macro to generate error for image dimensionality not set to PS_DIMEN_IMAGE */ -#define PS_CHECK_DIMEN_AND_TYPE(NAME, PS_DIMEN, CLEANUP) \ -if (NAME->type.dimen != PS_DIMEN) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "Invalid operation. %s has incorrect dimensionality %d.", #NAME, PS_DIMEN); \ - CLEANUP; \ -} else if(NAME->type.type!=PS_TYPE_F64 && NAME->type.type!=PS_TYPE_F32) { \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - "Invalid operation. %s not PS_TYPE_F64.", #NAME); \ - CLEANUP; \ -} - -/** Preprocessor macro to check that input is not equal to output */ -#define PS_CHECK_POINTERS(NAME1, NAME2, CLEANUP) \ -if (NAME1 == NAME2) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - "Invalid operation: Pointer to %s is same as %s.", #NAME1, #NAME2); \ - CLEANUP; \ -} - -/** Preprocessor macro to check that an image is square */ -#define PS_CHECK_SQUARE(NAME, CLEANUP) \ -if (NAME->numCols != NAME->numRows) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, "Invalid operation: %s not square array.", #NAME); \ - CLEANUP; \ -} - -/** Preprocessor macro to initalize a GSL matrix. */ -#define PS_GSL_MATRIX_INITIALIZE(LHS_NAME, RHS_NAME) \ -LHS_NAME.size1 = numRows; \ -LHS_NAME.size2 = numCols; \ -LHS_NAME.tda = numCols; \ -LHS_NAME.data = RHS_NAME; - - -/*****************************************************************************/ -/* FILE STATIC FUNCTIONS */ -/*****************************************************************************/ - -static void psVectorToGslVector(gsl_vector *outGslVector, const psVector *inVector); -static void gslVectorToPsVector(psVector *outVector, gsl_vector *inGslVector); -static void psImageToGslMatrix(gsl_matrix *outGslMatrix, const psImage *inImage); -static void gslMatrixToPsImage(psImage *outImage, gsl_matrix *inGslMatrix); - -/** Static function to copy psF32 or psF64 vector data to a GSL vector */ -static void psVectorToGslVector(gsl_vector *outGslVector, const psVector *inVector) -{ - psU32 i = 0; - psU32 n = 0; - - - n = inVector->n; - for(i=0; itype.type == PS_TYPE_F32) { - outGslVector->data[i] = (psF64)inVector->data.F32[i]; - } else { - outGslVector->data[i] = inVector->data.F64[i]; - } - } -} - -/** Static function to copy GSL vector data to a psF32 or psF64 vector */ -static void gslVectorToPsVector(psVector *outVector, gsl_vector *inGslVector) -{ - psU32 i = 0; - psU32 n = 0; - - - n = outVector->n; - for(i=0; itype.type == PS_TYPE_F32) { - outVector->data.F32[i] = (psF32)inGslVector->data[i]; - } else { - outVector->data.F64[i] = inGslVector->data[i]; - } - } -} - -/** Static function to copy psF32 or psF64 image data to a GSL matrix */ -static void psImageToGslMatrix(gsl_matrix *outGslMatrix, const psImage *inImage) -{ - psU32 i = 0; - psU32 j = 0; - psU32 numRows = 0; - psU32 numCols = 0; - - - numRows = inImage->numRows; - numCols = inImage->numCols; - if(inImage->type.type == PS_TYPE_F32) { - for(i=0; idata[i*numCols+j] = inImage->data.F32[i][j]; - } - } - } else { - for(i=0; idata[i*numCols+j] = inImage->data.F64[i][j]; - } - } - } -} - -/** Static function to copy GSL matrix data to a psF32 or psF64 image */ -static void gslMatrixToPsImage(psImage *outImage, gsl_matrix *inGslMatrix) -{ - psU32 i = 0; - psU32 j = 0; - psU32 numRows = 0; - psU32 numCols = 0; - - - numRows = outImage->numRows; - numCols = outImage->numCols; - if(outImage->type.type == PS_TYPE_F32) { - for(i=0; idata.F32[i][j] = inGslMatrix->data[i*numCols+j]; - } - } - } else { - for(i=0; idata.F64[i][j] = inGslMatrix->data[i*numCols+j]; - } - } - } -} - - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - PUBLIC */ -/*****************************************************************************/ - -psImage* psMatrixLUD(psImage* out, psVector** perm, psImage* in) -{ - psS32 signum = 0; - psS32 numRows = 0; - psS32 numCols = 0; - gsl_matrix *lu = NULL; - gsl_permutation permGSL; - - - #define psMatrixLUD_EXIT {psFree(out); return NULL;} - - // Error checks - PS_ASSERT_GENERAL_IMAGE_NON_NULL(in, psMatrixLUD_EXIT); - PS_CHECK_POINTERS(in, out, psMatrixLUD_EXIT); - PS_CHECK_DIMEN_AND_TYPE(in, PS_DIMEN_IMAGE, psMatrixLUD_EXIT); - PS_ASSERT_GENERAL_PTR_NON_NULL(perm, psMatrixLUD_EXIT); - - out = psImageRecycle(out, in->numCols, in->numRows, in->type.type); - - PS_CHECK_SQUARE(in, psMatrixLUD_EXIT); // gsl_linalg_LU_decomp would fail on non-square input. - PS_CHECK_SQUARE(out, psMatrixLUD_EXIT); - - // Initialize data - numRows = in->numRows; - numCols = in->numCols; - - // Initialize GSL data - permGSL.size = numCols; - if (sizeof(size_t) == 4) { - *perm = psVectorRecycle(*perm, numCols, PS_TYPE_S32); - } else if (sizeof(size_t) == 8) { - *perm = psVectorRecycle(*perm, numCols, PS_TYPE_S64); - } else { - psError(PS_ERR_UNKNOWN, true, - "Failed to allocate the permutation vector; " - "could not determine the cooresponding data type."); - psMatrixLUD_EXIT; - } - - (*perm)->n = numCols; - permGSL.data = (psPtr)((*perm)->data.U8); - lu = gsl_matrix_alloc(numRows, numCols); - - // Copy psImage data into GSL matrix data - psImageToGslMatrix(lu, in); - - // Calculate LU decomposition - gsl_linalg_LU_decomp(lu, &permGSL, &signum); // N.B., uses Gaussian Elimination with partial pivoting. - - // Copy GSL matrix data to psImage data - gslMatrixToPsImage(out, lu); - - // Free GSL data - gsl_matrix_free(lu); - - return out; -} - -psVector* psMatrixLUSolve(psVector* out, const psImage* LU, const psVector* RHS, - const psVector* perm) -{ - psS32 numRows = 0; - psS32 numCols = 0; - gsl_matrix *lu; - gsl_permutation permGSL; - gsl_vector *b = NULL; - gsl_vector *x = NULL; - - #define LUSOLVE_CLEANUP {psFree(out); return NULL;} - - // Error checks - PS_ASSERT_GENERAL_IMAGE_NON_NULL(LU, LUSOLVE_CLEANUP); - PS_CHECK_DIMEN_AND_TYPE(LU, PS_DIMEN_IMAGE, LUSOLVE_CLEANUP); - PS_ASSERT_GENERAL_IMAGE_NON_EMPTY(LU, LUSOLVE_CLEANUP); - PS_ASSERT_GENERAL_VECTOR_NON_NULL(RHS, LUSOLVE_CLEANUP); - PS_CHECK_DIMEN_AND_TYPE(RHS, PS_DIMEN_VECTOR, LUSOLVE_CLEANUP); - PS_ASSERT_GENERAL_VECTOR_NON_NULL(perm, LUSOLVE_CLEANUP); - - out = psVectorRecycle(out, LU->numRows, LU->type.type); - - PS_CHECK_POINTERS(out, RHS, LUSOLVE_CLEANUP); - PS_CHECK_POINTERS(RHS, perm, LUSOLVE_CLEANUP); - PS_CHECK_POINTERS(out, perm, LUSOLVE_CLEANUP); - - // Initialize data - numRows = LU->numRows; - numCols = LU->numCols; - - // Initialize GSL data - lu = gsl_matrix_alloc(numRows, numCols); - psImageToGslMatrix(lu, LU); - b = gsl_vector_alloc(RHS->n); - psVectorToGslVector(b, RHS); - x = gsl_vector_alloc(RHS->n); - - out->n = numCols; - permGSL.size = perm->n; - permGSL.data = (psPtr)(perm->data.U8); - - // Solve for {x} in equation: {b} = [A]{x} - gsl_linalg_LU_solve(lu, &permGSL, b, x); - - // Copy GSL vector data to psVector data - gslVectorToPsVector(out, x); - - // Free GSL data - gsl_vector_free(b); - gsl_vector_free(x); - gsl_matrix_free(lu); - - return out; -} - -psImage* psMatrixInvert(psImage* out, const psImage* in, float *determinant) -{ - psS32 signum = 0; - psS32 numRows = 0; - psS32 numCols = 0; - gsl_matrix *inv = NULL; - gsl_matrix *lu = NULL; - gsl_permutation *perm = NULL; - - #define INVERT_CLEANUP { psFree(out); return NULL; } - // Error checks - PS_ASSERT_GENERAL_PTR_NON_NULL(determinant, INVERT_CLEANUP); - PS_ASSERT_GENERAL_IMAGE_NON_NULL(in, INVERT_CLEANUP); - PS_CHECK_POINTERS(in, out, INVERT_CLEANUP); - PS_CHECK_DIMEN_AND_TYPE(in, PS_DIMEN_IMAGE, INVERT_CLEANUP); - PS_ASSERT_GENERAL_IMAGE_NON_EMPTY(in, INVERT_CLEANUP); - - out = psImageRecycle(out, in->numCols, in->numRows, in->type.type); - - PS_CHECK_SQUARE(in, INVERT_CLEANUP); - PS_CHECK_SQUARE(out, INVERT_CLEANUP); - - // Initialize data - numRows = in->numRows; - numCols = in->numCols; - - // Initialize GSL data - perm = gsl_permutation_alloc(numRows); - lu = gsl_matrix_alloc(numRows, numCols); - inv = gsl_matrix_alloc(numRows, numCols); - psImageToGslMatrix(lu, in); - - // Invert data and calculate determinant - gsl_linalg_LU_decomp(lu, perm, &signum); - gsl_linalg_LU_invert(lu, perm, inv); - *determinant = (float)gsl_linalg_LU_det(lu, signum); - - // Copy GSL matrix data to psImage data - gslMatrixToPsImage(out, inv); - - // Free GSL structs - gsl_permutation_free(perm); - gsl_matrix_free(lu); - gsl_matrix_free(inv); - - return out; -} - -float *psMatrixDeterminant(const psImage* in) -{ - psS32 signum = 0; - psS32 numRows = 0; - psS32 numCols = 0; - psF32 *det = NULL; - gsl_matrix *lu = NULL; - gsl_permutation *perm = NULL; - - #define DETERMINANT_EXIT { return NULL; } - // Error checks - PS_ASSERT_GENERAL_IMAGE_NON_NULL(in, DETERMINANT_EXIT); - PS_CHECK_DIMEN_AND_TYPE(in, PS_DIMEN_IMAGE, DETERMINANT_EXIT); - PS_ASSERT_GENERAL_IMAGE_NON_EMPTY(in, DETERMINANT_EXIT); - PS_CHECK_SQUARE(in, DETERMINANT_EXIT); - - // Initialize data - numRows = in->numRows; - numCols = in->numCols; - - // Allocate GSL structs - perm = gsl_permutation_alloc(numRows); - lu = gsl_matrix_alloc(numRows, numCols); - psImageToGslMatrix(lu, in); - - // Calculate determinant - det = (psF32*)psAlloc(sizeof(psF32)); - gsl_linalg_LU_decomp(lu, perm, &signum); - *det = (psF32)gsl_linalg_LU_det(lu, signum); - - // Free GSL structs - gsl_permutation_free(perm); - gsl_matrix_free(lu); - - return det; -} - -psImage* psMatrixMultiply(psImage* out, psImage* in1, psImage* in2) -{ - gsl_matrix *m1 = NULL; - gsl_matrix *m2 = NULL; - gsl_matrix *m3 = NULL; - - #define MULTIPLY_CLEANUP { psFree(out); return NULL; } - - // Error checks - PS_ASSERT_GENERAL_IMAGE_NON_NULL(in1, MULTIPLY_CLEANUP); - PS_ASSERT_GENERAL_IMAGE_NON_NULL(in2, MULTIPLY_CLEANUP); - PS_ASSERT_GENERAL_IMAGE_NON_EMPTY(in1, MULTIPLY_CLEANUP); - PS_ASSERT_GENERAL_IMAGE_NON_EMPTY(in2, MULTIPLY_CLEANUP); - PS_CHECK_DIMEN_AND_TYPE(in1, PS_DIMEN_IMAGE, MULTIPLY_CLEANUP); - PS_CHECK_DIMEN_AND_TYPE(in2, PS_DIMEN_IMAGE, MULTIPLY_CLEANUP); - PS_CHECK_POINTERS(in1, out, MULTIPLY_CLEANUP); - PS_CHECK_POINTERS(in1, in2, MULTIPLY_CLEANUP); - - if (in1->numRows != in2->numCols) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, "Invalid operation: number of rows of in1 != number of cols of in2."); - MULTIPLY_CLEANUP; - } - if (in1->type.type != in2->type.type) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, "Invalid operation: data types of in1 and in2 must match."); - MULTIPLY_CLEANUP; - } - - out = psImageRecycle(out, in2->numCols, in1->numRows, in2->type.type); - - // Initialize GSL data - m1 = gsl_matrix_alloc(in1->numRows, in1->numCols); - psImageToGslMatrix(m1, in1); - m2 = gsl_matrix_alloc(in2->numRows, in2->numCols); - psImageToGslMatrix(m2, in2); - m3 = gsl_matrix_alloc(out->numRows, out->numCols); - - // Perform multiplication - // gsl_blas_dgemm(CblasNoTrans, CblasNoTrans, 1.0, m1, m2, 0.0, m3); - gsl_linalg_matmult(m1, m2, m3); - - // Copy GSL matrix data to psImage data - gslMatrixToPsImage(out, m3); - - // Free GSL structs - gsl_matrix_free(m1); - gsl_matrix_free(m2); - gsl_matrix_free(m3); - - return out; -} - -psImage* psMatrixTranspose(psImage* out, const psImage* in) -{ - psU32 i = 0; - psU32 j = 0; - psS32 numRowsIn = 0; - psS32 numColsIn = 0; - psS32 numRowsOut = 0; - psS32 numColsOut = 0; - - #define TRANSPOSE_CLEANUP { psFree(out); return NULL; } - // Error checks - PS_ASSERT_GENERAL_IMAGE_NON_NULL(in, TRANSPOSE_CLEANUP); - PS_CHECK_DIMEN_AND_TYPE(in, PS_DIMEN_IMAGE, TRANSPOSE_CLEANUP); - PS_ASSERT_GENERAL_IMAGE_NON_EMPTY(in, TRANSPOSE_CLEANUP); - PS_CHECK_POINTERS(in, out, TRANSPOSE_CLEANUP); - - out = psImageRecycle(out, in->numCols, in->numRows, in->type.type); - - // Initialize data - numRowsIn = in->numRows; - numColsIn = in->numCols; - numRowsOut = out->numRows; - numColsOut = out->numCols; - - if(numRowsIn!=numColsOut && numRowsOut!=numColsIn) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, PS_ERRORTEXT_psMatrix_TRANSPOSE_MISMATCH); - TRANSPOSE_CLEANUP; - } - - if(out->type.type == PS_TYPE_F32) { - for(i=0; idata.F32[i][j] = in->data.F32[j][i]; - } - } - } else { - for(i=0; idata.F64[i][j] = in->data.F64[j][i]; - } - } - } - - return out; -} - -psImage* psMatrixEigenvectors(psImage* out, psImage* in) -{ - psS32 numRows = 0; - psS32 numCols = 0; - gsl_vector *eVals = NULL; - gsl_eigen_symmv_workspace *w = NULL; - gsl_matrix *outGSL = NULL; - gsl_matrix *inGSL = NULL; - - #define EIGENVECTORS_CLEANUP { psFree(out); return NULL; } - // Error checks - PS_ASSERT_GENERAL_IMAGE_NON_NULL(in, EIGENVECTORS_CLEANUP); - PS_CHECK_DIMEN_AND_TYPE(in, PS_DIMEN_IMAGE, EIGENVECTORS_CLEANUP); - PS_ASSERT_GENERAL_IMAGE_NON_EMPTY(in, EIGENVECTORS_CLEANUP); - PS_CHECK_POINTERS(in, out, EIGENVECTORS_CLEANUP); - - out = psImageRecycle(out, in->numCols, in->numRows, in->type.type); - - // Initialize data - numRows = in->numRows; - numCols = in->numCols; - - inGSL = gsl_matrix_alloc(numRows, numCols); - psImageToGslMatrix(inGSL, in); - outGSL = gsl_matrix_alloc(numRows, numCols); - - // Allocate GSL structs - eVals = gsl_vector_alloc(numRows); - w = gsl_eigen_symmv_alloc(numRows); - - // Non-square matrices not allowed - PS_CHECK_SQUARE(in, EIGENVECTORS_CLEANUP); - PS_CHECK_SQUARE(out, EIGENVECTORS_CLEANUP); - - // Calculate Eigenvalues and Eigenvectors...Eigenvalues not currently used - gsl_eigen_symmv(inGSL, eVals, outGSL, w); - - // Copy GSL matrix data to psImage data - gslMatrixToPsImage(out, outGSL); - - // Free GSL structs - gsl_matrix_free(inGSL); - gsl_matrix_free(outGSL); - gsl_eigen_symmv_free(w); - gsl_vector_free(eVals); - - return out; -} - -psVector* psMatrixToVector(psVector* outVector, const psImage* inImage) -{ - psS32 size = 0; - - #define psMatrixToVector_EXIT {psFree(outVector); return NULL;} - - // Error checks - PS_ASSERT_GENERAL_IMAGE_NON_NULL(inImage, psMatrixToVector_EXIT); - PS_CHECK_DIMEN_AND_TYPE(inImage, PS_DIMEN_IMAGE, psMatrixToVector_EXIT); - PS_ASSERT_GENERAL_IMAGE_NON_EMPTY(inImage, psMatrixToVector_EXIT); - - if (inImage->numRows == 1) { - // Create transposed row vector - outVector = psVectorRecycle(outVector, inImage->numCols, inImage->type.type); - outVector->type.dimen = PS_DIMEN_TRANSV; - } else if (inImage->numCols == 1) { - // Create non-transposed column vector - outVector = psVectorRecycle(outVector, inImage->numRows, inImage->type.type); - } else { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "Image does not have dim with 1 col or 1 row: (%d x %d).", - inImage->numRows, inImage->numCols); - psMatrixToVector_EXIT; - } - - // More checks - if (outVector->type.dimen == PS_DIMEN_VECTOR) { - PS_CHECK_DIMEN_AND_TYPE(outVector, PS_DIMEN_VECTOR, psMatrixToVector_EXIT); - - if (outVector->n == 0) { - outVector->n = inImage->numRows; - } - - if (outVector->n != inImage->numRows) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "Image and vector sizes differ: (%d vs %d).", - inImage->numRows, outVector->n); - psMatrixToVector_EXIT; - } - - size = PSELEMTYPE_SIZEOF(inImage->type.type) * inImage->numRows; - - } else if (outVector->type.dimen == PS_DIMEN_TRANSV) { - PS_CHECK_DIMEN_AND_TYPE(outVector, PS_DIMEN_TRANSV, psMatrixToVector_EXIT); - - if (outVector->n == 0) { - outVector->n = inImage->numCols; - } - - if (outVector->n != inImage->numCols) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "Image and vector sizes differ: (%d vs %d).", - inImage->numCols, outVector->n); - psMatrixToVector_EXIT; - } - - size = PSELEMTYPE_SIZEOF(inImage->type.type) * inImage->numCols; - } - - memcpy(outVector->data.U8, inImage->data.U8[0], size); - - return outVector; -} - -psImage* psVectorToMatrix(psImage* outImage, const psVector* inVector) -{ - psS32 size = 0; - - #define VECTORTOMATRIX_CLEANUP {psFree(outImage); return NULL; } - // Error checks - PS_ASSERT_GENERAL_VECTOR_NON_NULL(inVector, VECTORTOMATRIX_CLEANUP); - - if (inVector->type.dimen == PS_DIMEN_VECTOR) { - PS_CHECK_DIMEN_AND_TYPE(inVector, PS_DIMEN_VECTOR, VECTORTOMATRIX_CLEANUP); - PS_ASSERT_GENERAL_VECTOR_NON_EMPTY(inVector, VECTORTOMATRIX_CLEANUP); - - outImage = psImageRecycle(outImage, 1, inVector->n, inVector->type.type); - - // More checks for PS_DIMEN_VECTOR - if (outImage->numCols > 1) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "Image has more than 1 column: numCols = %d.", - outImage->numCols); - VECTORTOMATRIX_CLEANUP; - } else if (outImage->numRows != inVector->n) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "Image and vector sizes differ: (%d vs %d).", - outImage->numRows, inVector->n); - VECTORTOMATRIX_CLEANUP; - } - - size = PSELEMTYPE_SIZEOF(outImage->type.type) * outImage->numRows; - - } else if (inVector->type.dimen == PS_DIMEN_TRANSV) { - PS_CHECK_DIMEN_AND_TYPE(inVector, PS_DIMEN_TRANSV, VECTORTOMATRIX_CLEANUP); - PS_ASSERT_GENERAL_VECTOR_NON_EMPTY(inVector, VECTORTOMATRIX_CLEANUP); - outImage = psImageRecycle(outImage, inVector->n, 1, inVector->type.type); - // More checks for PS_DIMEN_TRANSV - if (outImage->numRows > 1) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "Image has more than 1 row: numRows = %d.", - outImage->numRows); - VECTORTOMATRIX_CLEANUP; - } else if (outImage->numCols != inVector->n) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "Image and vector sizes differ: (%d vs %d).", - outImage->numCols, inVector->n); - VECTORTOMATRIX_CLEANUP; - } - - size = PSELEMTYPE_SIZEOF(outImage->type.type) * outImage->numCols; - } - - PS_ASSERT_GENERAL_IMAGE_NON_NULL(outImage, VECTORTOMATRIX_CLEANUP); - PS_CHECK_DIMEN_AND_TYPE(outImage, PS_DIMEN_IMAGE, VECTORTOMATRIX_CLEANUP); - - memcpy(outImage->data.U8[0], inVector->data.U8, size); - - return outImage; -} Index: unk/psLib/src/dataManip/psMatrix.h =================================================================== --- /trunk/psLib/src/dataManip/psMatrix.h (revision 4545) +++ (revision ) @@ -1,165 +1,0 @@ -/** @file psMatrix.h - * - * @brief Provides functions for linear algebra operations on psImages and psVectors. - * - * Functions are provided to: - * Transpose a psImage - * Compute LUD - * Solve LUD - * Matrix inversion - * Calculate determinant - * Matrix multiplication - * Calculate Eigenvectors - * Convert matrix to vector - * Convert vector to matrix - * - * These functions treat psImages as if they were matrices, therefore there is no psMatrix. These functions - * operate only with the psF64 data type. - * - * @ingroup Matrix - * - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.19 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-25 01:15:01 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PSMATRIX_H -#define PSMATRIX_H - -/// @addtogroup Matrix -/// @{ - -/** LU Decomposition of psImage matrix. - * - * Performs a LU decomposition on a psImage matrix and returns the LU matrix. If the user specifies NULL for - * the outImage or outPerm arguments, then they will be automatically created. The input image must - * be square. This function operates only with the psF64 data type. Input and output arguments should not be - * the same. GSL indexes the top row as the zero row, not the bottom. - * - * @return psImage* : Pointer to LU decomposed psImage. - */ -psImage* psMatrixLUD( - psImage* out, ///< Image to return, or NULL. - psVector** perm, ///< Output permutation vector used by psMatrixLUSolve. - psImage* in ///< Image to decompose. -); - -/** LU Solution of psImage matrix. - * - * Solves for and returns the psVector, {x} in the equation [A]{x} = {b}. If the user specifies NULL as the - * outVector argument, then it will automatically be created. The input image must be square. This function - * operates only with the psF64 data type. Input and output arguments should not be the same. GSL indexes - * the top row as the zero row, not the bottom. - * - * @return psVector* : Pointer to psVector solution of matrix equation. - */ -psVector* psMatrixLUSolve( - psVector* out, ///< Vector to return, or NULL. - const psImage* LU, ///< LU-decomposed matrix. - const psVector* RHS, ///< Vector right-hand-side of equation. - const psVector* perm ///< Permutation vector resulting from psMatrixLUD function. -); - -/** Invert psImage matrix. - * - * Inverts a psImage matrix and returns the determinant as an option through the argument list. If the user - * specifies NULL as the outImage argument, then it will automatically be created. The input image must be - * square. This function operates only with the psF64 data type. Input and output arguments should not be - * the same. GSL indexes the top row as the zero row, not the bottom. - * - * @return psImage* : Pointer to inverted psImage. - */ -psImage* psMatrixInvert( - psImage* out, ///< Image to return, or NULL for in-place substitution. - const psImage* in, ///< Image to be inverted - float *determinant ///< Determinant to return, or NULL -); - -/** Calculate psImage matrix determinant. - * - * Calculates the determinant of a psImage matrix and returns the single precision floating point result. The - * input image must be square. This function operates only with the psF64 data type. GSL indexes the top row - * as the zero row, not the bottom. - * - * @return float: Determinant from psImage. - */ -float *psMatrixDeterminant( - const psImage* in ///< Image used to calculate determinant. -); - -/** Performs psImage matrix multiplication. - * - * Performs a classical matrix multiplication involving row and column operations. Input images must be square - * and the same size. If the user specifies NULL as the outImage argument, then it will automatically be - * created. This function operates only with the psF64 data type. GSL indexes the top row as the - * zero row, not the bottom. - * - * @return psImage* : Pointer to resulting psImage. - */ -psImage* psMatrixMultiply( - psImage* out, ///< Matrix to return, or NULL. - psImage* in1, ///< First input image. - psImage* in2 ///< Second input image. -); - -/** Transpose matrix. - * - * Performs psImage matrix transpose by substituting existing rows for columns. The input image must be - * square. If the user specifies NULL as the outImage argument, then it will automaticallty be created. - * This function operates only with the psF64 data type. GSL indexes the top row as the zero - * row, not the bottom. - * - * @return psImage* : Pointer to transposed psImage. - */ -psImage* psMatrixTranspose( - psImage* out, ///< Image to return, or NULL - const psImage* inImage ///< Image to transpose -); - -/** Calculate matrix eigenvectors. - * - * Calculates the eigenvectors for a matrix. The input image must be symmetric and square. If the user - * specifies NULL as the outImage argument, then it will automatically be created. This function operates - * only with the psF64 data type. GSL indexes the top row as the zero row, not the bottom. - * - * @return psImage* : Pointer to matrix of Eigenvectors. - */ -psImage* psMatrixEigenvectors( - psImage* out, ///< Eigenvectors to return, or NULL. - psImage* in ///< Input image. -); - -/** Convert matrix to vector. - * - * Converts a 1-d psImage matrix into a vector. If the user specifies NULL as the outVector argument, then it - * will automatically be created based on the input image (PS_DIMEN_VECTOR for an input image with 1 col or - * PS_DIMENT_TRANSV for an input image with 1 row). Either the number of rows or the number of colums of the - * input matrix must be 1. This function operates only with the psF64 data type. - * - * @return psVector* : Pointer to psVector. - */ -psVector* psMatrixToVector( - psVector* outVector, ///< Vector to return, or NULL. - const psImage* inImage ///< Image to convert. -); - -/** Convert vector to matrix. - * - * Converts a vector into a psImage matrix. If the dimensionality of the vector is PS_DIMEN_VECTOR, then the - * resulting psImage is a 1d column. If the dimensionality of the vector is PS_DIMEN_TRANSV, then the - * resulting psImage is a 1d row. If the user specifies NULL as the outImage argument, then it will - * automatically be created. This function operates only with the psF64 data type. - * - * @return psVector* : Pointer to psIamge. - */ -psImage* psVectorToMatrix( - psImage* outImage, ///< Matrix to return, or NULL. - const psVector* inVector ///< Vector to convert. -); - -/// @} - -#endif // #ifndef PSMATRIX_H Index: unk/psLib/src/dataManip/psMinimize.c =================================================================== --- /trunk/psLib/src/dataManip/psMinimize.c (revision 4545) +++ (revision ) @@ -1,2207 +1,0 @@ -/** @file psMinimize.c - * \brief basic minimization functions - * @ingroup Math - * - * This file will contain functions to minimize an arbitrary function at - * a data point, fit an arbitrary function to a set of data points, and - * fit a 1-D polynomial to a set of data points. - * - * @author GLG, MHPCC - * - * @version $Revision: 1.124 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-09 02:11:01 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - * - * XXX: must follow coding name standards on local functions. - * - */ -/*****************************************************************************/ -/* INCLUDE FILES */ -/*****************************************************************************/ -#include -#include -#include - -#include "psMinimize.h" -#include "psStats.h" -#include "psImage.h" -#include "psImageStructManip.h" -/*****************************************************************************/ -/* DEFINE STATEMENTS */ -/*****************************************************************************/ -#define PS_SEG psLib -#define PS_PWD dataManip -#define PS_FILE psMinimize -/*****************************************************************************/ -/* TYPE DEFINITIONS */ -/*****************************************************************************/ - -/*****************************************************************************/ -/* GLOBAL VARIABLES */ -/*****************************************************************************/ -static psMinimizeChi2PowellFunc Chi2PowellFunc = NULL; -static psVector *myValue; -static psVector *myError; - -/*****************************************************************************/ -/* FILE STATIC VARIABLES */ -/*****************************************************************************/ - -// None - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - LOCAL */ -/*****************************************************************************/ - -/****************************************************************************** -p_psBuildSums1D(x, polyOrder, sums): this routine calculates the powers of -input parameter "x" between 0 and input parameter polyOrder. The result is -returned as a psVector sums. - -XXX: Use a static vector. - *****************************************************************************/ -static void buildSums1D(psF64 x, - psS32 polyOrder, - psVector* sums) -{ - psS32 i = 0; - psF64 xSum = 0.0; - - if (sums == NULL) { - sums = psVectorAlloc(polyOrder, PS_TYPE_F64); - } - if (polyOrder > sums->n) { - sums = psVectorRealloc(sums, polyOrder); - } - - xSum = 1.0; - for (i = 0; i <= polyOrder; i++) { - sums->data.F64[i] = xSum; - xSum *= x; - } -} - -/***************************************************************************** -CalculateSecondDerivs(): Given a set of x/y vectors corresponding to a -tabulated function at n points, this routine calculates the second -derivatives of the interpolating cubic splines at those n points. - -The first and second derivatives at the endpoints, undefined in the SDR, are -here defined to be 0.0. They can be modified via ypo and yp1. - -This routine assumes that vectors x and y are of the appropriate types/sizes -(F32). - -XXX: This algorithm is derived from the Numerical Recipes. -XXX: use recycled vectors for internal data. -XXX: do an F64 version? - *****************************************************************************/ -static psF32 *calculateSecondDerivs(const psVector* x, ///< Ordinates (or NULL to just use the indices) - const psVector* y) ///< Coordinates -{ - psTrace(".psLib.dataManip.calculateSecondDerivs", 4, - "---- calculateSecondDerivs() begin ----\n"); - - psS32 i; - psS32 k; - psF32 sig; - psF32 p; - psS32 n = y->n; - psF32 *u = (psF32 *) psAlloc(n * sizeof(psF32)); - psF32 *derivs2 = (psF32 *) psAlloc(n * sizeof(psF32)); - psF32 *X = (psF32 *) & (x->data.F32[0]); - psF32 *Y = (psF32 *) & (y->data.F32[0]); - psF32 qn; - - // XXX: The second derivatives at the endpoints, undefined in the SDR, - // are set in psConstants.h: PS_LEFT_SPLINE_DERIV, PS_RIGHT_SPLINE_DERIV. - derivs2[0] = -0.5; - u[0]= (3.0/(X[1]-X[0])) * ((Y[1]-Y[0])/(X[1]-X[0]) - PS_LEFT_SPLINE_DERIV); - - for (i=1;i<=(n-2);i++) { - sig = (X[i] - X[i-1]) / (X[i+1] - X[i-1]); - p = sig * derivs2[i-1] + 2.0; - derivs2[i] = (sig - 1.0) / p; - u[i] = ((Y[i+1] - Y[i])/(X[i+1]-X[i])) - ((Y[i]-Y[i-1])/(X[i]-X[i-1])); - u[i] = ((6.0 * u[i] / (X[i+1] - X[i-1])) - (sig * u[i-1])) / p; - - psTrace(".psLib.dataManip.calculateSecondDerivs", 6, - "X[%d] is %f\n", i, X[i]); - psTrace(".psLib.dataManip.calculateSecondDerivs", 6, - "Y[%d] is %f\n", i, Y[i]); - psTrace(".psLib.dataManip.calculateSecondDerivs", 6, - "u[%d] is %f\n", i, u[i]); - } - - qn = 0.5; - u[n-1] = (3.0/(X[n-1]-X[n-2])) * (PS_RIGHT_SPLINE_DERIV - (Y[n-1]-Y[n-2])/(X[n-1]-X[n-2])); - derivs2[n-1] = (u[n-1] - (qn * u[n-2])) / ((qn * derivs2[n-2]) + 1.0); - - for (k=(n-2);k>=0;k--) { - derivs2[k] = derivs2[k] * derivs2[k+1] + u[k]; - - psTrace(".psLib.dataManip.calculateSecondDerivs", 6, - "derivs2[%d] is %f\n", k, derivs2[k]); - } - - psFree(u); - psTrace(".psLib.dataManip.calculateSecondDerivs", 4, - "---- calculateSecondDerivs() end ----\n"); - return(derivs2); -} - -/****************************************************************************** -p_psNRSpline1DEval(): This routine does NR-style evaluation of cubic splines. -It takes advantage of the 2nd derivatives of the cubic splines, which are -stored in the psSPline1D data structure, and computes the interpolated value -directly, without computing (or using) the interpolating cubic spline -polynomial. - -This routine is here mostly for a sanity check on the psLib function -evalSpline() which computes the interpolated value based on the cubic spline -polynomials which are stored in psSpline1D. - -XXX: This is F32 only - -XXX: spline->knots must be psF32 - *****************************************************************************/ -/* -psF32 p_psNRSpline1DEval(psSpline1D *spline, - const psVector* x, - const psVector* y, - psF32 X) -{ - PS_ASSERT_PTR_NON_NULL(spline, NAN); - PS_ASSERT_INT_NONNEGATIVE(spline->n, NAN); - PS_ASSERT_VECTOR_NON_NULL(spline->domains, NAN); - PS_ASSERT_PTR_NON_NULL(spline->p_psDeriv2, NAN); - PS_ASSERT_VECTOR_NON_NULL(x, NAN); - PS_ASSERT_VECTOR_TYPE(x, PS_TYPE_F32, NAN); - PS_ASSERT_VECTOR_NON_NULL(y, NAN); - PS_ASSERT_VECTOR_TYPE(y, PS_TYPE_F32, NAN); - PS_ASSERT_VECTOR_TYPE(spline->knots, PS_TYPE_F32, NULL); - - psS32 n; - psS32 klo; - psS32 khi; - psF32 H; - psF32 A; - psF32 B; - psF32 C; - psF32 D; - psF32 Y; - - n = spline->n; - klo = p_psVectorBinDisect32(spline->knots->data.F32, (spline->n)+1, X); - if (klo < 0) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: psMinimize.c: p_psNRSpline1DEval(): p_psVectorBinDisect32 returned an error (%d).\n", klo); - return(NAN); - } - khi = klo + 1; - H = spline->knots->data.F32[khi] - spline->knots->data.F32[klo]; - A = (spline->knots->data.F32[khi] - X) / H; - B = (X - spline->knots->data.F32[klo]) / H; - C = ((A*A*A)-A) * (H*H/6.0); - D = ((B*B*B)-B) * (H*H/6.0); - - Y = (A * y->data.F32[klo]) + - (B * y->data.F32[khi]) + - (C * (spline->p_psDeriv2)[klo]) + - (D * (spline->p_psDeriv2)[khi]); - - return(Y); -} -*/ -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - PUBLIC */ -/*****************************************************************************/ - -/***************************************************************************** -psVectorFitSpline1D(): given a psSpline1D data structure and a set of x/y -vectors, this routine generates the linear or cublic splines which satisfy -those data points. - -The formula for calculating the spline polynomials is derived from Numerical -Recipes in C. The basic idea is that the polynomial is - (1) y = (A * y[0]) + - (2) (B * y[1]) + - (3) ((((A*A*A)-A) * mySpline->p_psDeriv2[0]) * H^2)/6.0 + - (4) ((((B*B*B)-B) * mySpline->p_psDeriv2[1]) * H^2)/6.0 -Where: - H = x[1]-x[0] - A = (x[1]-x)/H - B = (x-x[0])/H -The bulk of the code in this routine is the expansion of the above equation -into a polynomial in terms of x, and then saving the coefficients of the -powers of x in the spline polynomials. This gets pretty complicated. - -XXX: usage of yErr is not specified in IfA documentation. - -XXX: Is the x argument redundant? What do we do if the x argument is -supplied, but does not equal the knots specified in mySpline? - -XXX: can psSpline be NULL? - -XXX: reimplement this assuming that mySpline is NULL? - -XXX: What happens if X is NULL, then an index vector is generated for X, but -that index vector lies outside the range vectors in mySpline? - -XXX: Assumes mySpline->knots is psF32. Must add psU32 and psF64. - *****************************************************************************/ -psSpline1D *psVectorFitSpline1D(psSpline1D *mySpline, ///< The spline which will be generated. - const psVector* x, ///< Ordinates (or NULL to just use the indices) - const psVector* y, ///< Coordinates - const psVector* yErr) ///< Errors in coordinates, or NULL -{ - PS_ASSERT_VECTOR_NON_NULL(y, NULL); - PS_ASSERT_VECTOR_TYPE_F32_OR_F64(y, NULL); - if (mySpline != NULL) { - PS_ASSERT_VECTOR_TYPE(mySpline->knots, PS_TYPE_F32, NULL); - } - - psTrace(".psLib.dataManip.psVectorFitSpline1D", 4, - "---- psVectorFitSpline1D() begin ----\n"); - psS32 numSplines = (y->n)-1; - psF32 tmp; - psF32 H; - psS32 i; - psF32 slope; - psVector *x32 = NULL; - psVector *y32 = NULL; - psVector *yErr32 = NULL; - static psVector *x32Static = NULL; - static psVector *y32Static = NULL; - static psVector *yErr32Static = NULL; - - PS_VECTOR_CONVERT_F64_TO_F32_STATIC(y, y32, y32Static); - - // If yErr==NULL, set all errors equal. - if (yErr == NULL) { - PS_VECTOR_GEN_YERR_STATIC_F32(yErr32Static, y->n); - yErr32 = yErr32Static; - } else { - PS_ASSERT_VECTOR_TYPE_F32_OR_F64(yErr, NULL); - PS_VECTOR_CONVERT_F64_TO_F32_STATIC(yErr, yErr32, yErr32Static); - } - - // If x==NULL, create an x32 vector with x values set to (0:n). - if (x == NULL) { - PS_VECTOR_GEN_X_INDEX_STATIC_F32(x32Static, y->n); - x32 = x32Static; - } else { - PS_ASSERT_VECTOR_TYPE_F32_OR_F64(x, NULL); - PS_VECTOR_CONVERT_F64_TO_F32_STATIC(x, x32, x32Static); - } - PS_ASSERT_VECTORS_SIZE_EQUAL(x32, y32, NULL); - PS_ASSERT_VECTORS_SIZE_EQUAL(yErr32, y32, NULL); - - /* - XXX: - This can not be implemented until SDR states what order spline should be - created. - Should we error if mySpline is not NULL? - Should we error if mySPline is not NULL? - */ - if (mySpline == NULL) { - mySpline = psSpline1DAllocGeneric(x32, 3); - } - PS_ASSERT_PTR_NON_NULL(mySpline, NULL); - PS_ASSERT_INT_NONNEGATIVE(mySpline->n, NULL); - - if (y32->n != (1 + mySpline->n)) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "data size / spline size mismatch (%d %d)\n", - y32->n, mySpline->n); - return(NULL); - } - - // If these are linear splines, which means their polynomials will have - // two coefficients, then we do the simple calculation. - if (2 == (mySpline->spline[0])->n) { - for (i=0;in;i++) { - slope = (y32->data.F32[i+1] - y32->data.F32[i]) / - (mySpline->knots->data.F32[i+1] - mySpline->knots->data.F32[i]); - (mySpline->spline[i])->coeff[0] = y32->data.F32[i] - - (slope * mySpline->knots->data.F32[i]); - - (mySpline->spline[i])->coeff[1] = slope; - psTrace(".psLib.dataManip.psMinimize.psVectorFitSpline1D", 4, - "---- mySpline %d coeffs are (%f, %f)\n", i, - (mySpline->spline[i])->coeff[0], - (mySpline->spline[i])->coeff[1]); - } - psTrace(".psLib.dataManip.psMinimize.psVectorFitSpline1D", 4, - "---- Exiting psVectorFitSpline1D()()\n"); - return((psSpline1D *) mySpline); - } - - // Check if these are cubic splines (n==4). If not, psError. - if (4 != (mySpline->spline[0])->n) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "Don't know how to generate %d-order splines.", - (mySpline->spline[0])->n-1); - return(NULL); - } - - // If we get here, then we know these are cubic splines. We first - // generate the second derivatives at each data point. - mySpline->p_psDeriv2 = calculateSecondDerivs(x32, y32); - for (i=0;in;i++) - psTrace(".psLib.dataManip.psVectorFitSpline1D", 6, - "Second deriv[%d] is %f\n", i, mySpline->p_psDeriv2[i]); - - // We generate the coefficients of the spline polynomials. I can't - // concisely explain how this code works. See above function comments - // and Numerical Recipes in C. - for (i=0;idata.F32[i+1] - x32->data.F32[i]; - psTrace(".psLib.dataManip.psVectorFitSpline1D", 4, - "x data (%f - %f) (%f)\n", - x32->data.F32[i], - x32->data.F32[i+1], H); - // - // ******** Calculate 0-order term ******** - // - // From (1) - (mySpline->spline[i])->coeff[0] = (y32->data.F32[i] * x32->data.F32[i+1]/H); - // From (2) - ((mySpline->spline[i])->coeff[0])-= ((y32->data.F32[i+1] * x32->data.F32[i])/H); - // From (3) - tmp = (x32->data.F32[i+1] * x32->data.F32[i+1] * x32->data.F32[i+1]) / (H * H * H); - tmp-= (x32->data.F32[i+1] / H); - tmp*= (mySpline->p_psDeriv2)[i] * H * H / 6.0; - ((mySpline->spline[i])->coeff[0])+= tmp; - // From (4) - tmp = -(x32->data.F32[i] * x32->data.F32[i] * x32->data.F32[i]) / (H * H * H); - tmp+= (x32->data.F32[i] / H); - tmp*= (mySpline->p_psDeriv2)[i+1] * H * H / 6.0; - ((mySpline->spline[i])->coeff[0])+= tmp; - - // - // ******** Calculate 1-order term ******** - // - // From (1) - (mySpline->spline[i])->coeff[1] = -(y32->data.F32[i]) / H; - // From (2) - ((mySpline->spline[i])->coeff[1])+= (y32->data.F32[i+1] / H); - // From (3) - tmp = -3.0 * (x32->data.F32[i+1] * x32->data.F32[i+1]) / (H * H * H); - tmp+= (1.0 / H); - tmp*= ((mySpline->p_psDeriv2)[i]) * H * H / 6.0; - ((mySpline->spline[i])->coeff[1])+= tmp; - // From (4) - tmp = 3.0 * (x32->data.F32[i] * x32->data.F32[i]) / (H * H * H); - tmp-= (1.0 / H); - tmp*= ((mySpline->p_psDeriv2)[i+1]) * H * H / 6.0; - ((mySpline->spline[i])->coeff[1])+= tmp; - - // - // ******** Calculate 2-order term ******** - // - // From (3) - (mySpline->spline[i])->coeff[2] = ((mySpline->p_psDeriv2)[i]) * 3.0 * x32->data.F32[i+1] / (6.0 * H); - // From (4) - ((mySpline->spline[i])->coeff[2])-= (((mySpline->p_psDeriv2)[i+1]) * 3.0 * x32->data.F32[i] / (6.0 * H)); - - // - // ******** Calculate 3-order term ******** - // - // From (3) - (mySpline->spline[i])->coeff[3] = -((mySpline->p_psDeriv2)[i]) / (6.0 * H); - // From (4) - ((mySpline->spline[i])->coeff[3])+= ((mySpline->p_psDeriv2)[i+1]) / (6.0 * H); - - psTrace(".psLib.dataManip.psVectorFitSpline1D", 6, - "(mySpline->spline[%d])->coeff[0] is %f\n", i, (mySpline->spline[i])->coeff[0]); - psTrace(".psLib.dataManip.psVectorFitSpline1D", 6, - "(mySpline->spline[%d])->coeff[1] is %f\n", i, (mySpline->spline[i])->coeff[1]); - psTrace(".psLib.dataManip.psVectorFitSpline1D", 6, - "(mySpline->spline[%d])->coeff[2] is %f\n", i, (mySpline->spline[i])->coeff[2]); - psTrace(".psLib.dataManip.psVectorFitSpline1D", 6, - "(mySpline->spline[%d])->coeff[3] is %f\n", i, (mySpline->spline[i])->coeff[3]); - - } - - psTrace(".psLib.dataManip.psVectorFitSpline1D", 4, - "---- psVectorFitSpline1D() end ----\n"); - return(mySpline); -} - - -/****************************************************************************** -XXX: We assume unnormalized gaussians. - *****************************************************************************/ -psVector *psMinimizeLMChi2Gauss1D(psImage *deriv, - const psVector *params, - const psArray *coords) -{ - PS_ASSERT_PTR_NON_NULL(coords, NULL); - PS_ASSERT_PTR_NON_NULL(params, NULL); - - psTrace(".psLib.dataManip.psMinimize", 4, - "---- psMinimizeLMChi2Gauss1D() begin ----\n"); - psF32 x; - psS32 i; - psF32 mean = params->data.F32[0]; - psF32 stdev = params->data.F32[1]; - psVector *out = psVectorAlloc(coords->n, PS_TYPE_F32); - - psTrace(".psLib.dataManip.psMinimize", 6, - "(mean, stdev) is (%f, %f)\n", mean, stdev); - - if (deriv == NULL) { - deriv = psImageAlloc(params->n, coords->n, PS_TYPE_F32); - } else { - PS_ASSERT_IMAGE_SIZE(deriv, params->n, coords->n, NULL); - PS_ASSERT_IMAGE_TYPE(deriv, PS_TYPE_F32, NULL); - } - - for (i=0;in;i++) { - x = ((psVector *) (coords->data[i]))->data.F32[0]; - out->data.F32[i] = psGaussian(x, mean, stdev, false); - } - - for (i=0;in;i++) { - x = ((psVector *) (coords->data[i]))->data.F32[0]; - psF32 tmp = (x - mean) * psGaussian(x, mean, stdev, false); - deriv->data.F32[i][0] = tmp / (stdev * stdev); - tmp = (x - mean) * (x - mean) * - psGaussian(x, mean, stdev, 0); - deriv->data.F32[i][1] = tmp / (stdev * stdev * stdev); - } - - psTrace(".psLib.dataManip.psMinimize", 4, - "---- psMinimizeLMChi2Gauss1D() end ----\n"); - return(out); -} - -/* -XXX: from bug 230: - -We first perform a rotation: -u = - (x-x0)*cos(theta) + (y-y0)*sin(theta) -v = (x-x0)*cos(theta) + (y-y0)*sin(theta) - -Here u is the major axis, and v is the minor axis, x0,y0 is the centre, and -theta is the position angle. - -Then the flux is - -flux = norm * exp(-( u*u/2.0/sigmau/sigmau + v*v/2.0/sigmav/sigmav) -)/2.0/pi/sigmau/sigmav - -Here sigmau and sigmav are the widths of the major and minor axes. - -The "norm" parameter in the equation above corresponds to the normalisation. - -Suggest order: - -norm -x0 -y0 -sigma_u -sigma_v -theta -*/ - -psVector *psMinimizeLMChi2Gauss2D(psImage *deriv, - const psVector *params, - const psArray *coords) -{ - PS_ASSERT_PTR_NON_NULL(coords, NULL); - PS_ASSERT_PTR_NON_NULL(params, NULL); - - psF64 normalization = params->data.F32[0]; - psF64 x0 = params->data.F32[1]; - psF64 y0 = params->data.F32[2]; - psF64 sigmaX = params->data.F32[3]; - psF64 sigmaY = params->data.F32[4]; - psF64 theta = params->data.F32[5]; - psVector *out = psVectorAlloc(coords->n, PS_TYPE_F32); - - if (deriv == NULL) { - deriv = psImageAlloc(params->n, coords->n, PS_TYPE_F32); - } else { - PS_ASSERT_IMAGE_SIZE(deriv, 6, coords->n, NULL); - PS_ASSERT_IMAGE_TYPE(deriv, PS_TYPE_F32, NULL); - } - - psTrace(".psLib.dataManip.psMinimize", 4, - "---- psMinimizeLMChi2Gauss2D() begin ----\n"); - - for (psS32 i=0;in;i++) { - psF64 x = ((psVector *) coords->data[i])->data.F32[0]; - psF64 y = ((psVector *) coords->data[i])->data.F32[0]; - - psF64 u = - (x-x0)*cos(theta) + (y-y0)*sin(theta); - psF64 v = (x-x0)*cos(theta) + (y-y0)*sin(theta); - - psF64 flux = normalization * exp(-( u*u/(2.0 * sigmaX * sigmaX) + - v*v/(2.0 * sigmaY * sigmaY)))/ - (2.0 * M_PI * sigmaX * sigmaY); - out->data.F32[i] = flux; - - // XXX: Calculate these correctly. - deriv->data.F32[i][0] = 0.0; - deriv->data.F32[i][1] = 0.0; - deriv->data.F32[i][2] = 0.0; - deriv->data.F32[i][3] = 0.0; - deriv->data.F32[i][4] = 0.0; - deriv->data.F32[i][5] = 0.0; - } - - psTrace(".psLib.dataManip.psMinimize", 4, - "---- psMinimizeLMChi2Gauss2D() end ----\n"); - return(out); -} - -psF64 p_psImageGetElementF64(psImage *a, int i, int j); - -// XXX EAM this is my re-implementation of MinLM -bool psMinimizeLMChi2(psMinimization *min, - psImage *covar, - psVector *params, - const psVector *paramMask, - const psArray *x, - const psVector *y, - const psVector *yErr, - psMinimizeLMChi2Func func) -{ - PS_ASSERT_PTR_NON_NULL(min, NULL); - PS_ASSERT_VECTOR_NON_NULL(params, NULL); - PS_ASSERT_VECTOR_NON_EMPTY(params, NULL); - PS_ASSERT_PTR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_NON_NULL(y, NULL); - PS_ASSERT_VECTOR_NON_EMPTY(y, NULL); - PS_ASSERT_VECTORS_SIZE_EQUAL(x, y, NULL); - PS_ASSERT_PTR_NON_NULL(func, NULL); - - // this function has test and current values for several things - // the current best value is in lower case - // the next guess value is in upper case - - // allocate internal arrays (current vs Guess) - psImage *alpha = psImageAlloc (params->n, params->n, PS_TYPE_F64); - psImage *Alpha = psImageAlloc (params->n, params->n, PS_TYPE_F64); - psVector *beta = psVectorAlloc (params->n, PS_TYPE_F64); - psVector *Beta = psVectorAlloc (params->n, PS_TYPE_F64); - psVector *Params = psVectorAlloc (params->n, PS_TYPE_F64); - psVector *dy = NULL; - psF64 chisq = 0.0; - psF64 Chisq = 0.0; - psF64 lambda = 0.001; - - // the initial guess on params is provided by the user - Params = psVectorCopy (Params, params, PS_TYPE_F32); - - // the user provides the error or NULL. we need to convert - // to appropriate weights - dy = psVectorAlloc (y->n, PS_TYPE_F32); - if (yErr != NULL) { - for (int i = 0; i < dy->n; i++) { - dy->data.F32[i] = 1.0 / PS_SQR (yErr->data.F32[i]); - } - } else { - for (int i = 0; i < dy->n; i++) { - dy->data.F32[i] = 1.0; - } - } - - // calculate initial alpha and beta, set chisq (min->value) - min->value = p_psMinLM_SetABX (alpha, beta, params, x, y, dy, func); - # ifndef PS_NO_TRACE - // dump some useful info if trace is defined - if (psTraceGetLevel (".psLib.dataManip.psMinimizeLMChi2") > 4) { - p_psImagePrint (psTraceGetDestination(), alpha, "alpha guess"); - p_psVectorPrint (psTraceGetDestination(), beta, "beta guess"); - p_psVectorPrint (psTraceGetDestination(), params, "params guess"); - } - # endif /* PS_NO_TRACE */ - - - // iterate until the tolerance is reached, or give up - while ((min->lastDelta > min->tol) && (min->iter < min->maxIter)) { - - // set a new guess for Alpha, Beta, Params - p_psMinLM_GuessABP (Alpha, Beta, Params, alpha, beta, params, lambda); - - # ifndef PS_NO_TRACE - // dump some useful info if trace is defined - if (psTraceGetLevel (".psLib.dataManip.psMinimizeLMChi2") > 4) { - p_psImagePrint (psTraceGetDestination(), Alpha, "alpha guess"); - p_psVectorPrint (psTraceGetDestination(), Beta, "beta guess"); - p_psVectorPrint (psTraceGetDestination(), Params, "params guess"); - } - # endif /* PS_NO_TRACE */ - - // calculate Chisq for new guess, update Alpha & Beta - Chisq = p_psMinLM_SetABX (Alpha, Beta, Params, x, y, dy, func); - psTrace (".psLib.dataManip.psMinimizeLMChi2", 3, "chisq: %f, Chisq %f, delta: %f\n", chisq, Chisq, min->lastDelta); - - // accept new guess (if improvement), or increase lambda - if (Chisq < min->value) { - min->lastDelta = (min->value - Chisq) / (dy->n - params->n); - min->value = Chisq; - alpha = psImageCopy (alpha, Alpha, PS_TYPE_F64); - beta = psVectorCopy (beta, Beta, PS_TYPE_F64); - params = psVectorCopy (params, Params, PS_TYPE_F32); - lambda *= 0.1; - } else { - lambda *= 10.0; - } - min->iter ++; - } - psTrace (".psLib.dataManip.psMinimizeLMChi2", 3, "chisq: %f, Chisq %f, delta: %f\n", chisq, Chisq, min->lastDelta); - - // free the internal temporary data - psFree (alpha); - psFree (Alpha); - psFree (beta); - psFree (Beta); - psFree (Params); - psFree (dy); - return (true); -} - -// XXX EAM: this needs to respect the mask on params -// XXX EAM: check not NULL on alpha, beta, params -// alpha, beta, params are already allocated -psF64 p_psMinLM_SetABX (psImage *alpha, - psVector *beta, - psVector *params, - const psArray *x, - const psVector *y, - const psVector *dy, - psMinimizeLMChi2Func func) -{ - - psF64 chisq; - psF64 delta; - psF64 weight; - psF64 ymodel; - psVector *deriv = psVectorAlloc (params->n, PS_TYPE_F32); - - // zero alpha and beta for summing below - for (int j = 0; j < params->n; j++) { - for (int k = 0; k < params->n; k++) { - alpha->data.F64[j][k] = 0.0; - } - beta->data.F64[j] = 0.0; - } - chisq = 0.0; - - // calculate chisq, alpha, beta - for (int i = 0; i < y->n; i++) { - ymodel = func (deriv, params, (psVector *) x->data[i]); - - delta = ymodel - y->data.F32[i]; - chisq += PS_SQR (delta) * dy->data.F32[i]; - - for (int j = 0; j < params->n; j++) { - weight = deriv->data.F32[j] * dy->data.F32[i]; - for (int k = 0; k <= j; k++) { - alpha->data.F64[j][k] += weight * deriv->data.F32[k]; - } - beta->data.F64[j] += weight * delta; - } - } - - // calculate lower-left half of alpha - for (int j = 1; j < params->n; j++) { - for (int k = 0; k < j; k++) { - alpha->data.F64[k][j] = alpha->data.F64[j][k]; - } - } - psFree (deriv); - return (chisq); -} - -// XXX EAM : can we use static copies of LUv, LUm, A? -psBool p_psMinLM_GuessABP (psImage *Alpha, - psVector *Beta, - psVector *Params, - psImage *alpha, - psVector *beta, - psVector *params, - psF64 lambda) -{ - - # define USE_LU_DECOMP 1 - # if (USE_LU_DECOMP) - psVector *LUv = NULL; - psImage *LUm = NULL; - psImage *A = NULL; - psF32 det; - - // LU decomposition version - psTrace (".pslib.dataManip.psMinLM_GuessABP", 3, "using LUD version"); - - // set new guess values (creates matrix A) - A = psImageCopy (NULL, alpha, PS_TYPE_F64); - for (int j = 0; j < params->n; j++) { - A->data.F64[j][j] = alpha->data.F64[j][j] * (1.0 + lambda); - } - - // solve A*beta = Beta (Alpha = 1/A) - // these operations do not modify the input values (creates LUm, LUv) - LUm = psMatrixLUD (NULL, &LUv, A); - Beta = psMatrixLUSolve (Beta, LUm, beta, LUv); - Alpha = psMatrixInvert (Alpha, A, &det); - - # else - // gauss-jordan version - psTrace (".pslib.dataManip.psMinLM_GuessABP", 3, "using Gauss-J version"); - - // set new guess values (creates matrix A) - Beta = psVectorCopy (Beta, beta, PS_TYPE_F64); - Alpha = psImageCopy (Alpha, alpha, PS_TYPE_F64); - for (int j = 0; j < params->n; j++) { - Alpha->data.F64[j][j] = alpha->data.F64[j][j] * (1.0 + lambda); - } - - psGaussJordan (Alpha, Beta); - # endif - - // apply beta to get new params values - for (int j = 0; j < params->n; j++) { - Params->data.F32[j] = params->data.F32[j] - Beta->data.F64[j]; - } - - # if (USE_LU_DECOMP) - psFree (A); - psFree (LUm); - psFree (LUv); - # endif - - return true; -} - -// XXX: put this in constants.h -# define PS_SWAP(X,Y) {double tmp=(X); (X) = (Y); (Y) = tmp;} - -// XXX EAM : temporary gauss-jordan solver based on gene's -// version based on the Numerical Recipes version -bool psGaussJordan (psImage *a, psVector *b) -{ - - int *indxc,*indxr,*ipiv; - int Nx, icol, irow; - int i, j, k, l, ll; - float big, dum, pivinv; - psF64 *vector; - psF64 **matrix; - - Nx = a->numCols; - matrix = a->data.F64; - vector = b->data.F64; - - indxc = psAlloc (Nx*sizeof(int)); - indxr = psAlloc (Nx*sizeof(int)); - ipiv = psAlloc (Nx*sizeof(int)); - for (j = 0; j < Nx; j++) { - ipiv[j] = 0; - } - - irow = icol = 0; - big = fabs(matrix[0][0]); - - for (i = 0; i < Nx; i++) { - big = 0.0; - for (j = 0; j < Nx; j++) { - if (!isfinite(matrix[i][j])) { - // XXX EAM: this should use the psError stack - fprintf (stderr, "GAUSSJ: NaN\n"); - goto fescape; - } - if (ipiv[j] != 1) { - for (k = 0; k < Nx; k++) { - if (ipiv[k] == 0) { - if (fabs (matrix[j][k]) >= big) { - big = fabs (matrix[j][k]); - irow = j; - icol = k; - } - } else { - if (ipiv[k] > 1) { - // XXX EAM: this should use the psError stack - fprintf (stderr, "GAUSSJ: Singular Matrix! (1)\n"); - goto fescape; - } - } - } - } - } - ipiv[icol]++; - if (irow != icol) { - for (l = 0; l < Nx; l++) { - PS_SWAP (matrix[irow][l], matrix[icol][l]); - } - PS_SWAP (vector[irow], vector[icol]); - } - indxr[i] = irow; - indxc[i] = icol; - if (matrix[icol][icol] == 0.0) { - // XXX EAM: this should use the psError stack - fprintf (stderr, "GAUSSJ: Singular Matrix! (2)\n"); - goto fescape; - } - pivinv = 1.0 / matrix[icol][icol]; - matrix[icol][icol] = 1.0; - for (l = 0; l < Nx; l++) { - matrix[icol][l] *= pivinv; - } - vector[icol] *= pivinv; - - for (ll = 0; ll < Nx; ll++) { - if (ll != icol) { - dum = matrix[ll][icol]; - matrix[ll][icol] = 0.0; - for (l = 0; l < Nx; l++) { - matrix[ll][l] -= matrix[icol][l]*dum; - } - vector[ll] -= vector[icol]*dum; - } - } - } - - for (l = Nx - 1; l >= 0; l--) { - if (indxr[l] != indxc[l]) { - for (k = 0; k < Nx; k++) { - PS_SWAP (matrix[k][indxr[l]], matrix[k][indxc[l]]); - } - } - } - psFree (ipiv); - psFree (indxr); - psFree (indxc); - return (true); - -fescape: - psFree (ipiv); - psFree (indxr); - psFree (indxc); - return (false); -} - -/****************************************************************************** -psMinimizeLMChi2(): This routine will take an procedure which calculates -an arbitrary function and it's derivative and minimize the chi-squared match -between that function at the specified coords and the specified value at -those coords. - -XXX: Do this: - After checking that all entries in the paramMask are 1 or 0, when - forming the A matrix from alpha, try this: - - A[i][i] = (1 + lambda*paramask[i]) * alpha[i][i]; - -XXX: This is very different from what is specified in the SDR. Must -coordinate with IfA on new SDR. - -XXX: Do vector/image recycles. - -XXX: probably yErr will be part of the SDR. - -XXX: This must work for both F32 and F64. F32 is currently implemented. - Note: since the LUD routines are only implemented in F64, then we - will have to convert all F32 input vectors to F64 regardless. So, - the F64 port might be. - -XXX: Must update the covar matrix. - *****************************************************************************/ -psBool psMinimizeLMChi2Old(psMinimization *min, - psImage *covar, - psVector *params, - const psVector *paramMask, - const psArray *x, - const psVector *y, - const psVector *yErr, - psMinimizeLMChi2Func func) -{ - PS_ASSERT_PTR_NON_NULL(min, NULL); - PS_ASSERT_VECTOR_NON_NULL(params, NULL); - PS_ASSERT_VECTOR_NON_EMPTY(params, NULL); - PS_ASSERT_PTR_NON_NULL(x, NULL); - PS_ASSERT_VECTOR_NON_NULL(y, NULL); - PS_ASSERT_VECTOR_NON_EMPTY(y, NULL); - PS_ASSERT_VECTORS_SIZE_EQUAL(x, y, NULL); - PS_ASSERT_PTR_NON_NULL(func, NULL); - - if (paramMask != NULL) { - PS_ASSERT_VECTORS_SIZE_EQUAL(params, paramMask, NULL); - } - if (yErr != NULL) { - PS_ASSERT_VECTORS_SIZE_EQUAL(y, yErr, NULL); - } - if (covar != NULL) { - PS_ASSERT_IMAGE_SIZE(covar, params->n, params->n, NULL); - } - - psTrace(".psLib.dataManip.psMinimize", 4, - "---- psMinimizeLMChi2() begin ----\n"); - psS32 numData = y->n; - psS32 numParams = params->n; - psS32 i; - psS32 j; - psS32 k; - psS32 l; - psS32 n; - psS32 p; - psVector *beta = psVectorAlloc(numParams, PS_TYPE_F64); - psVector *perm = NULL; - - psVector *paramDeltasF64 = psVectorAlloc(numParams, PS_TYPE_F64); - psVector *origParams = psVectorAlloc(numParams, PS_TYPE_F32); - psVector *newParams = psVectorAlloc(numParams, PS_TYPE_F32); - - psImage *alpha = psImageAlloc(numParams, numParams, PS_TYPE_F32); - psImage *A = psImageAlloc(numParams, numParams, PS_TYPE_F64); - psImage *aOut = psImageAlloc(numParams, numParams, PS_TYPE_F64); - psImage *deriv = psImageAlloc(numParams, numData, PS_TYPE_F32); - psVector *currValueVec = NULL; - psVector *newValueVec = NULL; - psF32 currChi2 = 0.0; - psF32 newChi2 = 0.0; - psF32 lamda = 0.00005; // XXX EAM : this starting value is VERY small (lamda is mis-spelt) - lamda = 0.05; // XXX EAM : this starting value is quite large (lamda is mis-spelt) - - psTrace(".psLib.dataManip.psMinimize", 6, - "min->maxIter is %d\n", min->maxIter); - psTrace(".psLib.dataManip.psMinimize", 6, - "min->tol is %f\n", min->tol); - - for (p=0;pdata.F32[p] = params->data.F32[p]; - } - - min->lastDelta = PS_MAX_F32; - min->iter = 0; - - while ((min->lastDelta > min->tol) && (min->iter < min->maxIter)) { - psTrace(".psLib.dataManip.psMinimize", 4, - "------------------------------------------------------\n"); - psTrace(".psLib.dataManip.psMinimize", 4, - "Iteration %d. Delta is %f\n", min->iter, min->lastDelta); - - // - // Calculate the current values and chi-squared of the function. - // - currChi2 = 0.0; - // currValueVec = func(deriv, params, x); - - // XXX EAM: use BinaryOp ? - // t1 = BinaryOp (NULL, currValueVec, "-", y); - // t1 = BinaryOp (t1, t1, "*", t1); - - // XXX EAM: this ignores yErr - for (n=0;ndata.F32[n] - y->data.F32[n]) * - (currValueVec->data.F32[n] - y->data.F32[n]); - psTrace(".psLib.dataManip.psMinimize", 6, - "data[%d], chi2 calculation+= (%f - %f)^2\n", n, - currValueVec->data.F32[n], y->data.F32[n]); - } - - // XXX EAM: this is just for tracing - for (p=0;pdata.F32[%d] is %f.\n", p, params->data.F32[p]); - } - psTrace(".psLib.dataManip.psMinimize", 6, - "Current chi-squared is (%f)\n", currChi2); - - // - // Mask elements of the derivative for each data point. - // XXX EAM : is this necessary? probably not... - for (p=0;pdata.U8[p] != 0)) { - for (n=0;ndata.F32[n][p] = 0.0; - } - } - } - - // - // Calculate the BETA vector. - // XXX EAM: I think this is wrong - for (p=0;pdata.U8[p] != 0)) { - continue; - } - beta->data.F64[p] = 0.0; - for (n=0;ndata.F64[p])+= - (y->data.F32[n] - currValueVec->data.F32[n]) * - deriv->data.F32[n][p]; - } - // XXX: multiply by -1 here? - (beta->data.F64[p])*= -1.0; - psTrace(".psLib.dataManip.psMinimize", 6, - "beta->data.F64[%d] is %f.\n", p, beta->data.F64[p]); - } - psFree(currValueVec); - - // - // Calculate the ALPHA matrix. - // XXX EAM: also wrong? (missing yErr) - for (k=0;kdata.F32[k][l] = 0.0; - for (n=0;ndata.F32[k][l]+= deriv->data.F32[n][k] * - deriv->data.F32[n][l]; - } - } - } - - // - // Calculate the matrix A. - // - for (j=0;jdata.F64[j][k] = - (psF64) ((1.0 + lamda) * alpha->data.F32[j][k]); - } else { - A->data.F64[j][k] = (psF64) alpha->data.F32[j][k]; - } - } - } - for (j=0;jdata.F64[j][k]); - } - psTrace(".psLib.dataManip.psMinimize", 6, "Matrix A[][]:\n"); - } - - // - // Solve A * alpha = Beta - // - // XXX: How do we know if these functions were successful? - // - aOut = psMatrixLUD(aOut, &perm, A); - paramDeltasF64 = psMatrixLUSolve(paramDeltasF64, aOut, beta, perm); - - // - // Mask any masked parameters. - // - for (i=0;idata.F64[%d] is %f.\n", i, paramDeltasF64->data.F64[i]); - if ((paramMask != NULL) && (paramMask->data.U8[i] != 0)) { - newParams->data.F32[i] = origParams->data.F32[i]; - } else { - newParams->data.F32[i] = params->data.F32[i] - - (psF32) paramDeltasF64->data.F64[i]; - } - } - - psTrace(".psLib.dataManip.psMinimize", 6, - "Calling func() with new parameters:\n"); - for (i=0;idata.F32[%d] is %f.\n", i, newParams->data.F32[i]); - } - - - // - // Calculate new function values. - // - newChi2 = 0.0; - // newValueVec = func(deriv, newParams, x); - for (n=0;ndata.F32[n] - y->data.F32[n]) * - (newValueVec->data.F32[n] - y->data.F32[n]); - - } - psFree(newValueVec); - - psTrace(".psLib.dataManip.psMinimize", 4, - "old/new chi-squareds are (%f, %f)\n", currChi2, newChi2); - - // - // If the new chi-squared is lower, then keep it. - // - if (currChi2 > newChi2) { - min->lastDelta = (currChi2 - newChi2)/currChi2; - min->value = newChi2; - - // We already masked params. - for (i=0;idata.F32[i] = (psF32) newParams->data.F32[i]; - } - lamda*= 0.1; - psTrace(".psLib.dataManip.psMinimize", 4, "*** Reducing lamda by factor of 10\n"); - } else { - lamda*= 10.0; - psTrace(".psLib.dataManip.psMinimize", 4, "*** Increasing lamda by factor of 10\n"); - } - psTrace(".psLib.dataManip.psMinimize", 4, - "lamda is %f\n", lamda); - min->iter++; - } - psFree(beta); - psFree(perm); - psFree(paramDeltasF64); - psFree(origParams); - psFree(newParams); - psFree(alpha); - psFree(A); - psFree(aOut); - psFree(deriv); - - if ((min->iter < min->maxIter) || - (min->lastDelta <= min->tol)) { - return(true); - } - - psTrace(".psLib.dataManip.psMinimize", 4, - "---- psMinimizeLMChi2() end (false) ----\n"); - return(false); -} - -/****************************************************************************** -vectorFitPolynomial1DCheb(): This routine will fit a Chebyshev polynomial of -degree myPoly to the data points (x, y) and return the coefficients of that -polynomial. - -XXX: yErr is currently ignored. -*****************************************************************************/ -static psPolynomial1D *vectorFitPolynomial1DCheby(psPolynomial1D* myPoly, - const psVector* x, - const psVector* y, - const psVector* yErr) -{ - psS32 j; - psS32 k; - psS32 n = x->n; - psF64 fac; - psF64 sum; - PS_VECTOR_GEN_STATIC_RECYCLED(f, n, PS_TYPE_F64); - psScalar *fScalar; - psScalar tmpScalar; - tmpScalar.type.type = PS_TYPE_F64; - - // XXX: These assignments appear too simple to warrant code and - // variable declarations. I retain them here to maintain coherence - // with the NR code. - psF64 min = -1.0; - psF64 max = 1.0; - psF64 bma = 0.5 * (max-min); // 1 - psF64 bpa = 0.5 * (max+min); // 0 - - // In this loop, we first calculate the values of X for which the - // Chebyshev polynomials are zero (see NR, section 5.4). Then we - // calculate the value of the function we are fitting the Chebyshev - // polynomials to at those values of X. This is a bit tricky since - // we don't know that function. So, we instead do 3-order LaGrange - // interpolation at the point X for the psVectors x,y for which we - // are fitting this ChebyShev polynomial to. - - for (psS32 i=0;idata.F64[i] = fScalar->data.F64; - psFree(fScalar); - - psTrace(".psLib.dataManip.vectorFitPolynomial1DCheby", 6, - "(x, X, y, f(X)) is (%f, %f, %f, %f)\n", - x->data.F64[i], X, y->data.F64[i], f->data.F64[i]); - } - - // We have the values for f() at the zero points, we now calculate the - // coefficients of the Chebyshev polynomial: NR 5.8.7. - - fac = 2.0/((psF32) n); - // XXX: is this loop bound correct? - for (j=0;jn;j++) { - sum = 0.0; - for (k=0;kdata.F64[k] * - cos(M_PI * ((psF32) j) * (0.5 + ((psF32) k)) / ((psF32) n)); - } - - myPoly->coeff[j] = fac * sum; - } - - return(myPoly); -} - -/****************************************************************************** -VectorFitPolynomial1DOrd(): This routine will fit an ordinary polynomial of -degree myPoly to the data points (x, y) and return the coefficients of that -polynomial. - -XXX: Use private name? -XXX: Use recycled vectors. - *****************************************************************************/ -static psPolynomial1D* vectorFitPolynomial1DOrd(psPolynomial1D* myPoly, - const psVector* x, - const psVector* y, - const psVector* yErr) -{ - psS32 polyOrder = myPoly->n; - psImage* A = NULL; - psImage* ALUD = NULL; - psVector* B = NULL; - psVector* outPerm = NULL; - psVector* X = NULL; // NOTE: do we need this? - psVector* coeffs = NULL; - psS32 i = 0; - psS32 j = 0; - psS32 k = 0; - psVector* xSums = NULL; - - psTrace(".psLib.dataManip.vectorFitPolynomial1DOrd", 4, - "---- vectorFitPolynomial1DOrd() begin ----\n"); - // printf("VectorFitPolynomial1D()\n"); - // for (i=0;in;i++) { - // printf("(x, y, yErr) is (%f, %f, %f)\n", x->data.F64[i], y->data.F64[i], yErr->data.F64[i]); - // } - - A = psImageAlloc(polyOrder, polyOrder, PS_TYPE_F64); - ALUD = psImageAlloc(polyOrder, polyOrder, PS_TYPE_F64); - - B = psVectorAlloc(polyOrder, PS_TYPE_F64); - coeffs = psVectorAlloc(polyOrder, PS_TYPE_F64); - X = psVectorAlloc(x->n, PS_TYPE_F64); - xSums = psVectorAlloc(1 + 2 * polyOrder, PS_TYPE_F64); - - // Initialize data structures. - for (i = 0; i < polyOrder; i++) { - B->data.F64[i] = 0.0; - coeffs->data.F64[i] = 0.0; - for (j = 0; j < polyOrder; j++) { - A->data.F64[i][j] = 0.0; - ALUD->data.F64[i][j] = 0.0; - } - } - for (i = 0; i < X->n; i++) { - X->data.F64[i] = x->data.F64[i]; - } - - // Build the B and A data structs. - if (yErr == NULL) { - for (i = 0; i < X->n; i++) { - buildSums1D(X->data.F64[i], 2 * polyOrder, xSums); - - for (k = 0; k < polyOrder; k++) { - B->data.F64[k] += y->data.F64[i] * xSums->data.F64[k]; - } - - for (k = 0; k < polyOrder; k++) { - for (j = 0; j < polyOrder; j++) { - A->data.F64[k][j] += xSums->data.F64[k + j]; - } - } - } - } else { - for (i = 0; i < X->n; i++) { - buildSums1D(X->data.F64[i], 2 * polyOrder, xSums); - - for (k = 0; k < polyOrder; k++) { - B->data.F64[k] += y->data.F64[i] * xSums->data.F64[k] / - yErr->data.F64[i]; - } - - for (k = 0; k < polyOrder; k++) { - for (j = 0; j < polyOrder; j++) { - A->data.F64[k][j] += xSums->data.F64[k + j] / - yErr->data.F64[i]; - } - } - } - } - - // XXX: How do we know if these routines were successful? - ALUD = psMatrixLUD(ALUD, &outPerm, A); - coeffs = psMatrixLUSolve(coeffs, ALUD, B, outPerm); - - for (k = 0; k < polyOrder; k++) { - myPoly->coeff[k] = coeffs->data.F64[k]; - // printf("myPoly->coeff[%d] is %f\n", k, myPoly->coeff[k]); - } - - psFree(A); - psFree(ALUD); - psFree(B); - psFree(coeffs); - psFree(X); - psFree(outPerm); - psFree(xSums); - - psTrace(".psLib.dataManip.vectorFitPolynomial1DOrd", 4, - "---- vectorFitPolynomial1DOrd() begin ----\n"); - return (myPoly); -} - -/****************************************************************************** -psVectorFitPolynomial1D(): This routine must fit a polynomial of degree -myPoly to the data points (x, y) and return the coefficients of that -polynomial. - -XXX: type F32 is done via vector conversion only. - *****************************************************************************/ -psPolynomial1D* psVectorFitPolynomial1D(psPolynomial1D* poly, - const psVector* x, - const psVector* y, - const psVector* yErr) -{ - PS_ASSERT_POLY_NON_NULL(poly, NULL); - PS_ASSERT_INT_NONNEGATIVE(poly->n, NULL); - PS_ASSERT_VECTOR_NON_NULL(y, NULL); - PS_ASSERT_VECTOR_NON_EMPTY(y, NULL); - PS_ASSERT_VECTOR_TYPE_F32_OR_F64(y, NULL); - - psS32 i; - psVector *x64 = NULL; - psVector *y64 = NULL; - psVector *yErr64 = NULL; - static psVector *x64Static = NULL; - static psVector *y64Static = NULL; - static psVector *yErr64Static = NULL; - - PS_VECTOR_CONVERT_F32_TO_F64_STATIC(y, y64, y64Static); - // If yErr==NULL, set all errors equal. - if (yErr == NULL) { - PS_VECTOR_GEN_YERR_STATIC_F64(yErr64Static, y->n); - yErr64 = yErr64Static; - } else { - PS_ASSERT_VECTOR_TYPE_F32_OR_F64(yErr, NULL); - PS_VECTOR_CONVERT_F32_TO_F64_STATIC(yErr, yErr64, yErr64Static); - } - - // If x==NULL, create an x64 vector with x values set to (0:n). - if (x == NULL) { - PS_VECTOR_GEN_X_INDEX_STATIC_F64(x64Static, y->n); - if (poly->type == PS_POLYNOMIAL_CHEB) { - p_psNormalizeVectorRangeF64(x64Static, -1.0, 1.0); - } - x64 = x64Static; - } else { - PS_ASSERT_VECTOR_TYPE_F32_OR_F64(x, NULL); - PS_VECTOR_CONVERT_F32_TO_F64_STATIC(x, x64, x64Static); - if (poly->type == PS_POLYNOMIAL_CHEB) { - p_psNormalizeVectorRangeF64(x64, -1.0, 1.0); - } - } - PS_ASSERT_VECTORS_SIZE_EQUAL(x64, y64, NULL); - PS_ASSERT_VECTORS_SIZE_EQUAL(yErr64, y64, NULL); - - // Call the appropriate vector fitting routine. - psPolynomial1D *rc = NULL; - if (poly->type == PS_POLYNOMIAL_CHEB) { - rc = vectorFitPolynomial1DCheby(poly, x64, y64, yErr64); - } else if (poly->type == PS_POLYNOMIAL_ORD) { - rc = vectorFitPolynomial1DOrd(poly, x64, y64, yErr64); - } else { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - "unknown polynomial type.\n"); - return(NULL); - } - if (rc == NULL) { - psError(PS_ERR_UNKNOWN, true, "Could not fit a polynomial to the data. Returning NULL.\n"); - return(NULL); - } - - return(poly); -} - - - -/****************************************************************************** - *****************************************************************************/ -psMinimization *psMinimizationAlloc(int maxIter, - float tol) -{ - PS_ASSERT_INT_NONNEGATIVE(maxIter, NULL); - - psMinimization *min = psAlloc(sizeof(psMinimization)); - *(int*)&min->maxIter = maxIter; - *(float*)&min->tol = tol; - min->value = 0.0; - min->iter = 0; - min->lastDelta = NAN; - - return(min); -} - -// This macro takes as input the vector BASE and adds a multiple of the vector -// LINE to it. We assume BASEMASK is non-null. -#define PS_VECTOR_ADD_MULTIPLE(BASE, BASEMASK, LINE, OUT, MUL) \ -for (psS32 i=0;in;i++) { \ - if (BASEMASK->data.U8[i] == 0) { \ - OUT->data.F32[i] = BASE->data.F32[i] + (MUL * LINE->data.F32[i]); \ - } else { \ - OUT->data.F32[i] = BASE->data.F32[i]; \ - } \ -} \ - -#define PS_VECTOR_F32_CHECK_ZERO_VECTOR(IN, BOOL_VAR) \ -BOOL_VAR = true; \ -for (psS32 i=0;in;i++) { \ - if (fabs(IN->data.F32[i]) >= FLT_EPSILON) { \ - BOOL_VAR = false; \ - break; \ - } \ -} \ - -#define PS_VECTOR_WITH_MASK_F32_CHECK_ZERO_VECTOR(IN, INMASK, BOOL_VAR) \ -BOOL_VAR = true; \ -for (psS32 i=0;in;i++) { \ - if ((INMASK->data.U8[i] == 0) && (fabs(IN->data.F32[i]) >= FLT_EPSILON)) { \ - BOOL_VAR = false; \ - break; \ - } \ -} \ - - -/****************************************************************************** -p_psDetermineBracket(): This routine takes as input an arbitrary function, -and the parameter to vary, and the line along which it must vary. This -function produces as output a bracket [a, b, c] such that -f(param + b * line) < f(param + a * line) -f(param + b * line) < f(param + c * line) -a < b < c - -Algorithm: - -XXX completely ad hoc: -start with the user-supplied starting parameter and -call that b. Calculate a/c as a fractional amount smaller/larger than b. -Repeat this process until a local minimum is found. - -XXX: -new algorithm: -start at x=0, expand in one direction until the function -decreases. Then you have two points in the bracket. Keep going until it -increases, or x is too large. If thst does not work, expand in the other -direction. - -XXX: -This is F32 only. - -XXX: -output bracket vector should be an input as well. -*****************************************************************************/ -psVector *p_psDetermineBracket(psVector *params, - psVector *line, - const psVector *paramMask, - const psArray *coords, - psMinimizePowellFunc func) -{ - psF32 a = 0.0; - psF32 b = 0.0; - psF32 c = 0.0; - psF32 fa = 0.0; - psF32 fb = 0.0; - psF32 fc = 0.0; - psS32 iter = 100; - psF32 aDir = 0.0; - psF32 cDir = 0.0; - psF32 new_aDir = 0.0; - psF32 new_cDir = 0.0; - psVector *bracket = psVectorAlloc(3, PS_TYPE_F32); - psF32 stepSize = PS_DETERMINE_BRACKET_STEP_SIZE; - psVector *tmp = NULL; - psBool boolLineIsNull = true; - - psTrace(".psLib.dataManip.p_psDetermineBracket", 4, - "---- p_psDetermineBracket() begin ----\n"); - - // If the line vector is zero, then return NULL. - PS_VECTOR_WITH_MASK_F32_CHECK_ZERO_VECTOR(params, paramMask, boolLineIsNull); - if (boolLineIsNull == true) { - psTrace(".psLib.dataManip.p_psDetermineBracket", 2, - "p_psDetermineBracket() called with zero line vector.\n"); - psTrace(".psLib.dataManip.p_psDetermineBracket", 4, - "---- p_psDetermineBracket() end (NULL) ----\n"); - psFree(bracket); - return(NULL); - } - - tmp = psVectorAlloc(params->n, PS_TYPE_F32); - - b = 0; - a = -stepSize; - c = stepSize; - - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, tmp, a); - fa = func(tmp, coords); - - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, tmp, b); - fb = func(tmp, coords); - - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, tmp, c); - fc = func(tmp, coords); - - if (fa < fb) { - aDir = -1; - } else { - aDir = 1; - } - - if (fc < fb) { - cDir = -1; - } else { - cDir = 1; - } - - psTrace(".psLib.dataManip.p_psDetermineBracket", 6, - "(a, b, c) is (%f %f %f) (fa, fb, fc) is (%f %f %f)\n", a, b, c, fa, fb, fc); - - while (iter > 0) { - psTrace(".psLib.dataManip.p_psDetermineBracket", 6, - "psDetermineBracket(): iteration %d\n", iter); - if ((fb < fa) && (fb < fc)) { - bracket->data.F32[0] = a; - bracket->data.F32[1] = b; - bracket->data.F32[2] = c; - psFree(tmp); - psTrace(".psLib.dataManip.p_psDetermineBracket", 6, - "---- p_psDetermineBracket() end ----\n"); - return(bracket); - } - stepSize*= (1.0 + stepSize); - a =- stepSize; - c =+ stepSize; - - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, tmp, a); - fa = func(tmp, coords); - - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, tmp, c); - fc = func(tmp, coords); - - psTrace(".psLib.dataManip.p_psDetermineBracket", 6, - "Iter(%d): (a, b, c) is (%f %f %f) (fa, fb, fc) is (%f %f %f)\n", iter, a, b, c, fa, fb, fc); - - if (fa < fb) { - new_aDir = -1; - } else { - new_aDir = 1; - } - - if (fc < fb) { - new_cDir = -1; - } else { - new_cDir = 1; - } - if ((new_aDir == 1) && (aDir == -1)) { - bracket->data.F32[0] = a; - bracket->data.F32[1] = b; - bracket->data.F32[2] = c; - psFree(tmp); - psTrace(".psLib.dataManip.p_psDetermineBracket", 4, - "---- p_psDetermineBracket() end ----\n"); - return(bracket); - } - - if ((new_cDir == 1) && (cDir == -1)) { - bracket->data.F32[0] = a; - bracket->data.F32[1] = b; - bracket->data.F32[2] = c; - psFree(tmp); - psTrace(".psLib.dataManip.p_psDetermineBracket", 4, - "---- p_psDetermineBracket() end ----\n"); - return(bracket); - } - aDir = new_aDir; - cDir = new_cDir; - iter--; - } - psFree(tmp); - psFree(bracket); - psTrace(".psLib.dataManip.p_psDetermineBracket", 4, - "---- p_psDetermineBracket() end (NULL) ----\n"); - return(NULL); -} - - -#define RETURN_FINAL_BRACKET(d) \ -if (a < c) { \ - bracket->data.F32[0] = a; \ - bracket->data.F32[1] = b; \ - bracket->data.F32[2] = c; \ -} else { \ - bracket->data.F32[0] = c; \ - bracket->data.F32[1] = b; \ - bracket->data.F32[2] = a; \ -} \ -psTrace(".psLib.dataManip.p_psDetermineBracket", 4, \ - "---- p_psDetermineBracket() end ----\n"); \ -psTrace(".psLib.dataManip.p_psDetermineBracket", 4, "Final bracket (a, b, c) is (%f %f %f) (fa, fb, fc) is (%f %f %f)\n", a, b, c, fa, fb, fc); \ -return(bracket); \ - -#define PS_DETERMINE_BRACKET_MAX_ITERATIONS 100 -psVector *p_psDetermineBracket2(psVector *params, - psVector *line, - const psVector *paramMask, - const psArray *coords, - psMinimizePowellFunc func) -{ - psF32 a = 0.0; - psF32 b = 0.0; - psF32 c = 0.0; - psF32 fa = 0.0; - psF32 fb = 0.0; - psF32 fc = 0.0; - psS32 iter = 0; - PS_VECTOR_GEN_STATIC_RECYCLED(tmp, params->n, PS_TYPE_F32); - psBool boolLineIsNull = true; - psF32 prevMin = 0.0; - psS32 countMin = 0; - - psTrace(".psLib.dataManip.p_psDetermineBracket", 4, - "---- p_psDetermineBracket() begin ----\n"); - - // If the line vector is zero, then return NULL. - PS_VECTOR_WITH_MASK_F32_CHECK_ZERO_VECTOR(params, paramMask, boolLineIsNull); - if (boolLineIsNull == true) { - psTrace(".psLib.dataManip.p_psDetermineBracket", 2, - "p_psDetermineBracket() called with zero line vector.\n"); - psTrace(".psLib.dataManip.p_psDetermineBracket", 4, - "---- p_psDetermineBracket() end (NULL) ----\n"); - return(NULL); - } - - // We determine in what x-direction does the function decrease. - a = 0.0; - fa = func(params, coords); - b = 0.5; - iter = 0; - do { - b*= (1.0 + PS_DETERMINE_BRACKET_STEP_SIZE); - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, tmp, b); - fb = func(tmp, coords); - } while ((fabs(fb - fa) < FLT_EPSILON) && (iter++ < 100)); - - if (fb > fa) { - a = b; - fa = fb; - b = 0.0; - fb = func(params, coords); - } - c = b; - - // At this point we have (a, b) and we know that (fa >= fb). Initially, c=b; - // We keep stretching b out further from "a" until (fc > previous fc). If - // that happens, then we have our bracket. - psVector *bracket = psVectorAlloc(3, PS_TYPE_F32); - iter = 0; - while (iter < PS_DETERMINE_BRACKET_MAX_ITERATIONS) { - psTrace(".psLib.dataManip.p_psDetermineBracket", 6, - "psDetermineBracket(): iterationA %d\n", iter); - c+= (1.0 + PS_DETERMINE_BRACKET_STEP_SIZE) * (c - a); - - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, tmp, c); - fc = func(tmp, coords); - - psTrace(".psLib.dataManip.p_psDetermineBracket", 6, - "Iteration(%d) (bracket): (a, b, c) is (%f %f %f) (fa, fb, fc) is (%f %f %f)\n", iter, a, b, c, fa, fb, fc); - - if ((fb < fa) && (fb < fc)) { - RETURN_FINAL_BRACKET(); - } else { - b = c; - fb = fc; - } - - // This code maintains a count of how many times the minimum fc has - // stayed the same. If it gets too high, we exit this loop. - if (fc == prevMin) { - countMin++; - } else { - countMin = 0; - } - prevMin = fc; - if (countMin == 10) { - RETURN_FINAL_BRACKET(); - } - - iter++; - } - - psFree(bracket); - psTrace(".psLib.dataManip.p_psDetermineBracket", 4, - "---- p_psDetermineBracket() end (NULL) (BAD) ----\n"); - return(NULL); -} - -/****************************************************************************** -This routine takes as input a possibly multi-dimensional function, along -with an initial guess at the parameters of that function and vector "line" -of the same size as the parameter vector. It will minimize the function -along that vector and returns the offset along that vector at which the -minimum is determined. - -XXX: This routine is not very efficient in terms of total evaluations of the -function. -XXX: This is F32 only -XXX: Since this is an internal function, many of the parameter checks are - redundant. -XXX: Don't modify the psMinimization argument. - *****************************************************************************/ -#define PS_LINEMIN_MAX_ITERATIONS 30 -psF32 p_psLineMin(psMinimization *min, - psVector *params, - psVector *line, - const psVector *paramMask, - const psArray *coords, - psMinimizePowellFunc func) -{ - PS_ASSERT_PTR_NON_NULL(min, NAN); - PS_ASSERT_VECTOR_NON_NULL(params, NAN); - PS_ASSERT_VECTOR_NON_EMPTY(params, NAN); - PS_ASSERT_VECTOR_TYPE(params, PS_TYPE_F32, NAN); - PS_ASSERT_VECTOR_NON_NULL(line, NAN); - PS_ASSERT_VECTOR_NON_EMPTY(line, NAN); - PS_ASSERT_VECTOR_TYPE(line, PS_TYPE_F32, NAN); - PS_ASSERT_VECTOR_NON_NULL(paramMask, NAN); - PS_ASSERT_VECTOR_NON_EMPTY(paramMask, NAN); - PS_ASSERT_VECTOR_TYPE(paramMask, PS_TYPE_U8, NAN); - PS_ASSERT_PTR_NON_NULL(coords, NAN); - PS_ASSERT_PTR_NON_NULL(func, NAN); - psVector *bracket; - psF32 a = 0.0; - psF32 b = 0.0; - psF32 c = 0.0; - psF32 n = 0.0; - psF32 fa = 0.0; - psF32 fb = 0.0; - psF32 fc = 0.0; - psF32 fn = 0.0; - psF32 mul = 0.0; - PS_VECTOR_GEN_STATIC_RECYCLED(tmpa, params->n, PS_TYPE_F32); - PS_VECTOR_GEN_STATIC_RECYCLED(tmpb, params->n, PS_TYPE_F32); - PS_VECTOR_GEN_STATIC_RECYCLED(tmpc, params->n, PS_TYPE_F32); - PS_VECTOR_GEN_STATIC_RECYCLED(tmpn, params->n, PS_TYPE_F32); - psS32 i = 0; - psS32 boolLineIsNull = true; - psS32 numIterations = 0; - - psTrace(".psLib.dataManip.p_psLineMin", 4, "---- p_psLineMin() begin ----\n"); - PS_VECTOR_F32_CHECK_ZERO_VECTOR(line, boolLineIsNull); - - if (boolLineIsNull == true) { - min->value = func(params, coords); - psTrace(".psLib.dataManip.p_psLineMin", 2, - "p_psLineMin() called with zero line vector. Return 0.0. Function value is %f\n", min->value); - return(0.0); - } - - for (i=0;in;i++) { - psTrace(".psLib.dataManip.p_psLineMin", 6, - "(params, paramMask, line)[%d] is (%f %d %f)\n", i, - params->data.F32[i], - paramMask->data.U8[i], - line->data.F32[i]); - } - - bracket = p_psDetermineBracket2(params, line, paramMask, coords, func); - if (bracket == NULL) { - psError(PS_ERR_UNKNOWN, false, - "Could not bracket minimum. Returning NAN.\n"); - return(NAN); - } - numIterations = 0; - while (numIterations < PS_LINEMIN_MAX_ITERATIONS) { - numIterations++; - psTrace(".psLib.dataManip.p_psLineMin", 6, - "p_psLineMin(): iteration %d\n", numIterations); - - a = bracket->data.F32[0]; - b = bracket->data.F32[1]; - c = bracket->data.F32[2]; - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, tmpa, a); - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, tmpb, b); - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, tmpc, c); - fa = func(tmpa, coords); - fb = func(tmpb, coords); - fc = func(tmpc, coords); - psTrace(".psLib.dataManip.p_psLineMin", 6, - "LineMin: f(%f %f %f) is (%f %f %f)\n", a, b, c, fa, fb, fc); - - // We determine which is the biggest segment in [a,b,c] then split - // that with the point n. - if ((b-a) > (c-b)) { - // This is the golden section formula - n = a + (0.69 * (b-a)); - for (i=0;in;i++) { - tmpn->data.F32[i] = params->data.F32[i] + (n * line->data.F32[i]); - } - fn = func(tmpn, coords); - - if (fn > fb) { - // a = n, b = b, c = c - bracket->data.F32[0] = n; - } else { - // a = a, b = n, c = b - bracket->data.F32[1] = n; - bracket->data.F32[2] = b; - } - } else { - n = b + (0.69 * (c-b)); - for (i=0;in;i++) { - tmpn->data.F32[i] = params->data.F32[i] + (n * line->data.F32[i]); - } - fn = func(tmpn, coords); - - if (fn > fb) { - // a = a, b = b, c = n - bracket->data.F32[2] = n; - } else { - // a = b, b = n, c = c - bracket->data.F32[0] = b; - bracket->data.F32[1] = n; - } - } - psTrace(".psLib.dataManip.p_psLineMin", 6, - "LineMin: new bracket is (%f %f %f)\n", bracket->data.F32[0], bracket->data.F32[1], bracket->data.F32[2]); - - mul = bracket->data.F32[1]; - if ((fabs(a-b) < min->tol) && (fabs(b-c) < min->tol)) { - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, params, mul); - min->value = func(params, coords); - psFree(bracket); - psTrace(".psLib.dataManip.p_psLineMin", 4, - "---- p_psLineMin() end.a (%f) (%f) ----\n", mul, min->value); - return(mul); - } - } - - mul = bracket->data.F32[1]; - PS_VECTOR_ADD_MULTIPLE(params, paramMask, line, params, mul); - min->value = func(params, coords); - psTrace(".psLib.dataManip.p_psLineMin", 4, - "---- p_psLineMin() end.b (%f) %f ----\n", mul, min->value); - - psFree(bracket); - return(mul); -} - - -/****************************************************************************** -This routine must minimize a possibly multi-dimensional function. The -function to be minimized "func" is: - psF32 func(psVector *params, psArray *coords) -The "params" are the parameters of the function which are varied. The data -points at which the function is varied are in the argument "coords" which is -a psArray of psVectors: each vector represents a different coordinate. - -XXX: We do not use Brent's method. - -XXX: The SDR is silent about data types. F32 is implemented here. - -XXX: Check for F32 types? - *****************************************************************************/ -#define PS_MINIMIZE_POWELL_LINEMIN_MAX_ITERATIONS 20 -#define PS_MINIMIZE_POWELL_LINEMIN_ERROR_TOLERANCE 0.01 - -bool psMinimizePowell(psMinimization *min, - psVector *params, - const psVector *paramMask, - const psArray *coords, - psMinimizePowellFunc func) -{ - PS_ASSERT_PTR_NON_NULL(min, NULL); - PS_ASSERT_VECTOR_NON_NULL(params, NULL); - PS_ASSERT_VECTOR_NON_EMPTY(params, NULL); - PS_ASSERT_VECTOR_TYPE(params, PS_TYPE_F32, NULL); - PS_ASSERT_PTR_NON_NULL(coords, NULL); - PS_ASSERT_PTR_NON_NULL(func, NULL); - psS32 numDims = params->n; - PS_VECTOR_GEN_STATIC_RECYCLED(pQP, numDims, PS_TYPE_F32); - PS_VECTOR_GEN_STATIC_RECYCLED(u, numDims, PS_TYPE_F32); - PS_VECTOR_GEN_STATIC_RECYCLED(Q, numDims, PS_TYPE_F32); - psS32 i = 0; - psS32 j = 0; - psVector *myParamMask = NULL; - psMinimization dummyMin; - psF32 mul = 0.0; - psF32 baseFuncVal = 0.0; - psF32 currFuncVal = 0.0; - psS32 biggestIter = 0; - psF32 biggestDiff = 0.0; - psS32 iterationNumber = 0; - - psTrace(".psLib.dataManip.psMinimizePowell", 4, - "---- psMinimizePowell() begin ----\n"); - psTrace(".psLib.dataManip.psMinimizePowell", 6, - "min->maxIter is %d\n", min->maxIter); - psTrace(".psLib.dataManip.psMinimizePowell", 6, - "min->tol is %f\n", min->tol); - - if (paramMask == NULL) { - myParamMask = psVectorRecycle(myParamMask, params->n, PS_TYPE_U8); - p_psMemSetPersistent(myParamMask, true); - p_psMemSetPersistent(myParamMask->data.U8, true); - for (i=0;in;i++) { - myParamMask->data.U8[i] = 0; - } - } else { - myParamMask = (psVector *) paramMask; - } - PS_ASSERT_VECTORS_SIZE_EQUAL(params, myParamMask, NULL); - - // 1: Set v[i] to be the unit vectors for each dimension in params - psArray *v = psArrayAlloc(numDims); - for (i=0;idata[i]) = (psVector *) psVectorAlloc(numDims, PS_TYPE_F32); - for (j=0;jdata[i]))->data.F32[j] = 1.0; - } else { - ((psVector *) (v->data[i]))->data.F32[j] = 0.0; - } - } - } - - // 2: Set Q to be the initial params (P in the ADD) - for (i=0;idata.F32[i] = params->data.F32[i]; - } - - while (iterationNumber < min->maxIter) { - iterationNumber++; - psTrace(".psLib.dataManip.psMinimizePowell", 6, - "psMinimizePowell() iteration %d\n", iterationNumber); - - // 3: For each dimension in params, move Q only in the vector v[i] to - // minimize the function. - - baseFuncVal = func(Q, coords); - currFuncVal = baseFuncVal; - psTrace(".psLib.dataManip.psMinimizePowell", 6, - "Current function value is %f\n", currFuncVal); - - biggestDiff = 0; - biggestIter = 0; - for (i=0;idata.U8[i] == 0) { - *(int*)&dummyMin.maxIter = PS_MINIMIZE_POWELL_LINEMIN_MAX_ITERATIONS; - *(float*)&dummyMin.tol = PS_MINIMIZE_POWELL_LINEMIN_ERROR_TOLERANCE; - mul = p_psLineMin(&dummyMin, - Q, - ((psVector *) v->data[i]), - myParamMask, - coords, - func); - if (isnan(mul)) { - psError(PS_ERR_UNKNOWN, false, - "Could not perform line minimization. Returning FALSE.\n"); - psFree(v); - return(false); - } - psTrace(".psLib.dataManip.psMinimizePowell", 6, - "LineMin along dimension %d has multiple %f\n", i, mul); - - if (fabs(dummyMin.value - currFuncVal) > biggestDiff) { - biggestDiff = fabs(dummyMin.value - currFuncVal); - biggestIter = i; - } - currFuncVal = dummyMin.value; - } - } - psTrace(".psLib.dataManip.psMinimizePowell", 6, - "New function value is %f\n", currFuncVal); - - // 4: Set the vector u = Q - P - for (i=0;idata.U8[i] == 0) { - u->data.F32[i] = Q->data.F32[i] - params->data.F32[i]; - - psTrace(".psLib.dataManip.psMinimizePowell", 6, - "u[i]=Q[i]-P[i] (%f = %f - %f)\n", u->data.F32[i], - Q->data.F32[i], - params->data.F32[i]); - - } else { - u->data.F32[i] = 0.0; - } - } - - // 5: Move Q only in the direction u, and minimize the function. - for (i=0;idata.F32[i]); - } - - mul = p_psLineMin(&dummyMin, params, u, myParamMask, coords, func); - if (isnan(mul)) { - psError(PS_ERR_UNKNOWN, false, - "Could not perform line minimization. Returning FALSE.\n"); - psFree(v); - return(false); - } - - // 6: - if (dummyMin.value > currFuncVal) { - psFree(v); - min->iter = iterationNumber; - // XXX: Ensure that currFuncVal is the correct value to use here. - min->value = currFuncVal; - // XXX: ensure that the lastDelta should be 0.0. - min->lastDelta = 0.0; - psTrace(".psLib.dataManip.psMinimizePowell", 4, - "---- psMinimizePowell() end (1)(true) ----\n"); - return(true); - } - - for (i=0;idata.U8[i] == 0) { - pQP->data.F32[i] = (2 * Q->data.F32[i]) - params->data.F32[i]; - } else { - pQP->data.F32[i] = params->data.F32[i]; - } - } - psF32 fqp = func(pQP, coords); - psF32 term1 = (baseFuncVal - currFuncVal) - biggestDiff; - term1*= term1; - term1*= 2.0 * (baseFuncVal - (2.0 * currFuncVal) + fqp); - psF32 term2 = baseFuncVal - fqp; - term2*= term2 * biggestDiff; - if (term1 < term2) { - for (i=0;idata.U8[i] == 0) { - ((psVector *) v->data[biggestIter])->data.F32[i] = u->data.F32[i]; - } - } - } - - // 7: Set P to Q - for (i=0;idata.U8[i] == 0) { - params->data.F32[i] = Q->data.F32[i]; - } - } - - // 8: Go to step 3 until the change is less than some tolerance. - if (fabs(baseFuncVal - currFuncVal) <= min->tol) { - psFree(v); - // XXX: Ensure that currFuncVal is the correct value to use here. - min->value = currFuncVal; - min->iter = iterationNumber; - min->lastDelta = currFuncVal - baseFuncVal; - psTrace(".psLib.dataManip.psMinimizePowell", 4, - "---- psMinimizePowell() end (2) (true) ----\n"); - return(true); - } - } - - psFree(v); - min->iter = iterationNumber; - psTrace(".psLib.dataManip.psMinimizePowell", 4, - "---- psMinimizePowell() end (0) (false) ----\n"); - return(false); -} - - -/****************************************************************************** -XXX: We assume unnormalized gaussians. -XXX: Currently, yErr is ignored. - *****************************************************************************/ -psVector *psMinimizePowellChi2Gauss1D(const psVector *params, - const psArray *coords) -{ - PS_ASSERT_PTR_NON_NULL(coords, NULL); - PS_ASSERT_PTR_NON_NULL(params, NULL); - - psF32 x; - psS32 i; - psF32 mean = params->data.F32[0]; - psF32 stdev = params->data.F32[1]; - psVector *out = psVectorAlloc(coords->n, PS_TYPE_F32); - - for (i=0;in;i++) { - x = ((psVector *) (coords->data[i]))->data.F32[0]; - out->data.F32[i] = psGaussian(x, mean, stdev, false); - } - - return(out); -} - -/****************************************************************************** -This routine is to be used with the psMinimizeChi2Powell() function below. -and the psMinimizePowell() function above. - -The basic idea is calculate chi-squared for a set of params/coords/errors. -This functions uses global variables to receive the function pointer, the -data values, and the data errors. -XXX: This is F32 only - *****************************************************************************/ -static psF32 myPowellChi2Func(const psVector *params, - const psArray *coords) -{ - psTrace(".psLib.dataManip.myPowellChi2Func", 4, - "---- myPowellChi2Func() begin ----\n"); - PS_ASSERT_VECTOR_NON_NULL(params, NAN); - PS_ASSERT_VECTOR_NON_EMPTY(params, NAN); - PS_ASSERT_VECTOR_NON_NULL(myValue, NAN); - PS_ASSERT_VECTOR_NON_EMPTY(myValue, NAN); - PS_ASSERT_PTR_NON_NULL(coords, NAN); - - psF32 chi2 = 0.0; - psF32 d; - psS32 i; - psVector *tmp; - - tmp = Chi2PowellFunc(params, coords); - if (myError == NULL) { - for (i=0;in;i++) { - d = (tmp->data.F32[i] - myValue->data.F32[i]); - chi2+= d * d; - } - } else { - for (i=0;in;i++) { - d = (tmp->data.F32[i] - myValue->data.F32[i]) / myError->data.F32[i]; - chi2+= d * d; - } - } - psFree(tmp); - psTrace(".psLib.dataManip.myPowellChi2Func", 4, - "---- myPowellChi2Func() end (chi2 is %f) ----\n", chi2); - return(chi2); -} - - -/****************************************************************************** -This routine must minimize the chi-squared match of a set of data points and -values for a possibly multi-dimensional function. - -The basic idea is to use the psMinimizePowell() function defined above. In -order to do so, we defined above a function myPowellChi2Func() which takes -the "func" function and returns chi-squared over the params/coords/values. -We then use that function myPowellChi2Func() in the call to -psMinimizePowell(). - *****************************************************************************/ -bool psMinimizeChi2Powell(psMinimization *min, - psVector *params, - const psVector *paramMask, - const psArray *coords, - const psVector *value, - const psVector *error, - psMinimizeChi2PowellFunc model) -{ - myValue = (psVector *) value; - myError = (psVector *) error; - - Chi2PowellFunc = model; - - return(psMinimizePowell(min, params, paramMask, coords, myPowellChi2Func)); -} - - Index: unk/psLib/src/dataManip/psMinimize.h =================================================================== --- /trunk/psLib/src/dataManip/psMinimize.h (revision 4545) +++ (revision ) @@ -1,235 +1,0 @@ -/** @file psMinimize.c - * \brief basic minimization functions - * @ingroup Math - * - * This file will contain function prototypes for various minimization, - * chi-squared minimization, and 1-D polynomial fitting routines. - * - * @author GLG, MHPCC - * - * @version $Revision: 1.49 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-09 02:11:01 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - * - */ - -#ifndef PS_MINIMIZE_H -#define PS_MINIMIZE_H - -/** \file psMinimize.h - * \brief minimization operations - * \ingroup Stats - */ -/** \addtogroup Stats - * \{ - */ - -#include "psVector.h" -#include "psMemory.h" -#include "psArray.h" -#include "psImage.h" -#include "psMatrix.h" -#include "psFunctions.h" -#include "psStats.h" -#include "psTrace.h" -#include "psError.h" -#include "psConstants.h" - -/** A data structure for minimization routines. - * - * Contains numerical analysis parameters/values - */ -typedef struct -{ - const int maxIter; ///< Convergence limit - const float tol; ///< Error Tolerance - float value; ///< Value of function at minimum - int iter; ///< Number of iterations to date - float lastDelta; ///< The last difference for the fit -} -psMinimization; - -/** Allocates a psMinimization structure. - * - * @return psMinimization* : a new psMinimization struct -*/ -psMinimization *psMinimizationAlloc( - int maxIter, ///< Number of minimization iterations to perform. - float tol ///< Requested error tolerance -); - -/** Derive a polynomial fit. - * - * psVectorFitPolynomial1d returns the polynomial that best fits the - * observations. The input parameters are a polynomial that specifies the - * fit order, myPoly, which will be altered and returned with the best-fit - * coefficients; and the observations, x, y and yErr. The independent - * variable list, x may be NULL, in which case the vector index is used. - * The dependent variable error, yErr may be null, in which case the solution - * is determined in the assumption that all data errors are equal. This - * function must be valid only for types psF32, psF64. - * - * @return psPolynomial1D* polynomial fit - */ -psPolynomial1D* psVectorFitPolynomial1D( - psPolynomial1D* poly, ///< Polynomial to fit - const psVector* x, ///< Ordinates (or NULL to just use the indices) - const psVector* y, ///< Coordinates - const psVector* yErr ///< Errors in coordinates, or NULL -); - -/** Derive a one-dimensional spline fit. - * - * Given a psSpline1D data structure and a set of x,y vectors, this routine - * generates the linear splines which satisfy those data points. - * - * @return psSpline1D*: the calculated one-dimensional splines - */ -psSpline1D *psVectorFitSpline1D( - psSpline1D *mySpline, ///< The spline which will be generated. - const psVector* x, ///< Ordinates (or NULL to just use the indices) - const psVector* y, ///< Coordinates - const psVector* yErr ///< Errors in coordinates, or NULL -); - -/** Specifies the format of a user-defined function that the general Levenberg- - * Marquardt minimizer routine will accept. - * - * @return float: the single float value of the function given the parameters, - * positions, and derivatives. - */ -typedef -float (*psMinimizeLMChi2Func)( - psVector *deriv, ///< derivatives of the function - const psVector *params, ///< the parameters used to evaluate the function - const psVector *x ///< positions for evaluation -); - -/** Minimizes a specified function based on the Levenberg-Marquardt method. - * - * @return bool: True if successful. - */ -bool psMinimizeLMChi2( - psMinimization *min, ///< Minimization specification - psImage *covar, ///< Covariance matrix - psVector *params, ///< "Best Guess" for the parameters that minimize func - const psVector *paramMask, ///< Parameters to be held fixed by the minimizer - const psArray *x, ///< Measurement ordinates of multiple vectors - const psVector *y, ///< Measurement coordinates - const psVector *yErr, ///< Errors in the measurement coordinates - psMinimizeLMChi2Func func ///< Specified function -); - -/** Use specified alpha, beta, params to generate a new guess for Alpha, Beta, Params - * - * @return psBool: True if successful. - */ -psBool p_psMinLM_GuessABP( - psImage *Alpha, ///< New Alpha guess - psVector *Beta, ///< New Beta guess - psVector *Params, ///< New Params guess - psImage *alpha, ///< Old Alpha guess - psVector *beta, ///< Old Beta guess - psVector *params, ///< Old Params guess - psF64 lambda ///< Factor used in update - //XXX Got Better Desc? -); - -/** Function used to set parameters for generating "best guess" in minimizing Chi-Squared value. - * - * @return psF64: Chi-squared value for new guess - */ -psF64 p_psMinLM_SetABX ( - psImage *alpha, ///< alpha guess - psVector *beta, ///< beta guess - psVector *params, ///< params guess - const psArray *x, ///< Measurement ordinates - const psVector *y, ///< Measurement coordinates - const psVector *dy, ///< Weights calculated from y-errors - psMinimizeLMChi2Func func ///< Specified function -); - -/** Specifies the format of a user-defined function that the general Powell - * minimizer routine will accept. - * - * @return float: the single float value of the function given the parameters - * and coordinate vectors. -*/ -typedef -float (*psMinimizePowellFunc)( - const psVector *params, ///< Parameters used to evaluate the function - const psArray *coords ///< Coordinates at which to evaluate -); - -/** Minimizes a specified function based on the Powell method. - * - * @return bool: True if successful. - */ -bool psMinimizePowell( - psMinimization *min, ///< Minimization specification - psVector *params, ///< "Best guess" for parameters that minimize func - const psVector *paramMask, ///< Parameters to be held fixed by minimizer - const psArray *coords, ///< Measurement coordinates - psMinimizePowellFunc func ///< Specified function -); - -/** Calculates the one-dimensional Gaussian in a format acceptable to the Levenberg- - * Marquardt minimizer routine. - * - * @return psVector*: Calculated values - */ -psVector *psMinimizeLMChi2Gauss1D( - psImage *deriv, ///< Derivative Matrix - const psVector *params, ///< Parameters used in evaluation - const psArray *coords ///< Measurement coordinates -); - -/** Calculates the one-dimensional Gaussian in a format acceptable to the Powell - * chi-squared minimizer routine. - * - * @return psVector*: Calculated values - */ -psVector *psMinimizePowellChi2Gauss1D( - const psVector *params, ///< Parameters used in evaluation - const psArray *coords ///< Measurement coordinates -); - -/** Specifies the format of a user-defined function that the general Powell chi- - * squared minimizer routine will accept. - * - * @return psVector*: Calculated values given the parameters and coordinates. -*/ -typedef -psVector *(*psMinimizeChi2PowellFunc)( - const psVector *params, ///< Parameters used to evaluate the function - const psArray *coords ///< Coordinates at which to evaluate -); - -/** Minimizes a specified function based on the Powell chi-squared method. - * - * @return bool: True is successful. - */ -bool psMinimizeChi2Powell( - psMinimization *min, ///< Minimization specification - psVector *params, ///< "Best guess" for parameters that minimize func - const psVector *paramMask, ///< Parameters to be held fixed by minimizer - const psArray *coords, ///< Measurement coordinates - const psVector *value, ///< Measured values at the coordinates - const psVector *error, ///< Errors in the measure values (or NULL) - psMinimizeChi2PowellFunc model ///< Specified function -); - -/** Gauss-Jordan numerical solver. - * - * @return bool: True if successful. - */ -bool psGaussJordan( - psImage *a, ///< Matrix to be solved - psVector *b ///< Vector of values -); - -/* \} */// End of MathGroup Functions - -#endif // #ifndef PS_MINIMIZE_H - Index: unk/psLib/src/dataManip/psRandom.c =================================================================== --- /trunk/psLib/src/dataManip/psRandom.c (revision 4545) +++ (revision ) @@ -1,144 +1,0 @@ -/** @file psRandom.c -* \brief Random Number Generators -* \ingroup Math -* -* This file will hold the functions which allocate, free, -* and evaluate random number Generators. -* -* @ingroup Math -* -* @author GLG, MHPCC -* -* @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-21 03:01:37 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#include -#include -#include -#include -#include -#include -#include - -#include "psMemory.h" -#include "psRandom.h" -#include "psScalar.h" -#include "psError.h" -#include "psTrace.h" -#include "psLogMsg.h" -#include "psConstants.h" -#include "psDataManipErrors.h" - -psU64 p_psRandomGetSystemSeed() -{ - FILE* fd; - psU64 seedVal = 0; - time_t timeVal; - - fd = fopen("/dev/urandom","r"); - if(fd == NULL) { - // Read system clock to get seed - seedVal = (psU64)time(&timeVal); - } else { - // Read urandom to get seed - fread(&seedVal, sizeof(psU64),1,fd); - // Close file - fclose(fd); - } - - // Send log message of the system seed value used - psLogMsg(__func__,PS_LOG_INFO,"System random seed value used seed = %llX hex",seedVal); - - return seedVal; -} - -psRandom *psRandomAlloc(psRandomType type, - unsigned long seed) -{ - gsl_rng *r = NULL; - psRandom *myRNG = NULL; - - switch (type) { - case PS_RANDOM_TAUS: - myRNG = (psRandom*)psAlloc(sizeof(psRandom)); - r = gsl_rng_alloc(gsl_rng_taus); - myRNG->gsl = r; - if(seed == 0) { - gsl_rng_set(myRNG->gsl,p_psRandomGetSystemSeed()); - } else { - gsl_rng_set(myRNG->gsl,seed); - } - myRNG->type = type; - break; - - default: - psError(PS_ERR_UNEXPECTED_NULL, - true, - PS_ERRORTEXT_psRandom_UNKNOWN_RANDFOM_NUMBER_GENERATOR_TYPE); - break; - } - - return(myRNG); -} - -void psRandomReset(psRandom *rand, - unsigned long seed) -{ - // Check null psRandom - if(rand==NULL) { - psError(PS_ERR_UNEXPECTED_NULL, - true, - PS_ERRORTEXT_psRandom_NULL_RANDOM_VAR); - } else { - // Check seed value to see if system seed should be used - if(seed == 0) { - gsl_rng_set(rand->gsl,p_psRandomGetSystemSeed()); - } else { - gsl_rng_set(rand->gsl, seed); - } - } -} - -double psRandomUniform(const psRandom *r) -{ - // Check null psRandom variable - if(r == NULL) { - psError(PS_ERR_UNEXPECTED_NULL, - true, - PS_ERRORTEXT_psRandom_NULL_RANDOM_VAR); - return(0); - } else { - return(gsl_rng_uniform(r->gsl)); - } -} - -double psRandomGaussian(const psRandom *r) -{ - // Check null psRandom variable - if(r == NULL) { - psError(PS_ERR_UNEXPECTED_NULL, - true, - PS_ERRORTEXT_psRandom_NULL_RANDOM_VAR); - return(0); - } else { - // XXX: What should sigma be? - return(gsl_ran_gaussian(r->gsl, 1.0)); - } -} - -double psRandomPoisson(const psRandom *r, double mean) -{ - // Check null psRandom variable - if(r == NULL) { - psError(PS_ERR_UNEXPECTED_NULL, - true, - PS_ERRORTEXT_psRandom_NULL_RANDOM_VAR); - return(0); - } else { - return((psF64) gsl_ran_poisson(r->gsl, mean)); - } -} - Index: unk/psLib/src/dataManip/psRandom.h =================================================================== --- /trunk/psLib/src/dataManip/psRandom.h (revision 4545) +++ (revision ) @@ -1,98 +1,0 @@ -/** @file psRandom.h -* \brief Random Number Generators -* \ingroup Math -* -* This file will hold the prototypes for procedures which allocate, free, -* and evaluate random number Generators. -* -* @ingroup Math -* -* @author GLG, MHPCC -* -* @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-21 03:01:37 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#ifndef PS_RANDOM_H -#define PS_RANDOM_H - -#include -#include -#include -#include - -#include "psVector.h" -#include "psScalar.h" -#include -#include - -/** \addtogroup Math - * \{ - */ - -/** Enumeration containing a flag for psRandom types. */ -typedef enum { - PS_RANDOM_TAUS ///< A maximally equidistributed combined Tausworthe generator. -} psRandomType; - -/** Data structure for psRandom. - * Contains information on the psRandom type and GNU Scientific Library random number generator. - */ -typedef struct -{ - psRandomType type; ///< The type of RNG - gsl_rng *gsl; ///< The RNG itself -} -psRandom; - -/** Allocates a psRandom struct. - * - * @return psRandom*: A new psRandom structure. - */ -psRandom *psRandomAlloc( - psRandomType type, ///< The type of RNG - unsigned long seed ///< Known value with which to seed the RNG -); - -/** Resets an existing psRandom struct. - * - * @return void - */ -void psRandomReset( - psRandom *rand, ///< Existing psRandom struct to reset - unsigned long seed ///< Known value with which to seed the RNG -); - -/** Random number generator based on a uniform distribution on [0,1). - * Uses gsl_rng_uniform. - * - * @return double: Random number. - */ -double psRandomUniform( - const psRandom *r ///< psRandom struct for RNG -); - -/** Random number generator based on a Gaussian deviate, N(0,1). - * Uses gsl_ran_gaussian. - * - * @return double: Random number. - */ -double psRandomGaussian( - const psRandom *r ///< psRandom struct for RNG -); - -/** Random number generator based on a Poisson distribution with the given mean. - * Uses gsl_ran_poisson. - * - * @return double: Random number. - */ -double psRandomPoisson( - const psRandom *r, ///< psRandom struct for RNG - double mean ///< Mean value -); - -/* \} */// End of MathGroup Functions - -#endif // #ifndef PS_RANDOM_H Index: unk/psLib/src/dataManip/psStats.c =================================================================== --- /trunk/psLib/src/dataManip/psStats.c (revision 4545) +++ (revision ) @@ -1,2306 +1,0 @@ -/** @file psStats.c - * \brief basic statistical operations - * @ingroup Stats - * - * This file will hold the definition of the histogram and stats data - * structures. It also contains prototypes for procedures which operate - * on those data structures. - * - * @author GLG, MHPCC - * - * XXX: The following stats members are never used, or set in this code. - * stats->robustN50 - * stats->clippedNvalues - * stats->binsize - * - * @version $Revision: 1.137 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-09 01:24:30 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include -#include -#include -#include -#include - -/*****************************************************************************/ -/* INCLUDE FILES */ -/*****************************************************************************/ -#include "psMemory.h" -#include "psImage.h" -#include "psVector.h" -#include "psTrace.h" -#include "psLogMsg.h" -#include "psError.h" -#include "psStats.h" -#include "psMinimize.h" -#include "psFunctions.h" -#include "psConstants.h" - -#include "psDataManipErrors.h" - -/*****************************************************************************/ -/* DEFINE STATEMENTS */ -/*****************************************************************************/ -#define PS_GAUSS_WIDTH 5 // The width of the Gaussian or boxcar smoothing. -#define PS_CLIPPED_NUM_ITER_LB 1 -#define PS_CLIPPED_NUM_ITER_UB 10 -#define PS_CLIPPED_SIGMA_LB 1.0 -#define PS_CLIPPED_SIGMA_UB 10.0 -#define PS_POLY_MEDIAN_MAX_ITERATIONS 10 - -#define PS_BIN_MIDPOINT(HISTOGRAM, BIN_NUM) \ -(0.5 * (HISTOGRAM->bounds->data.F32[(BIN_NUM)] + HISTOGRAM->bounds->data.F32[(BIN_NUM)+1])) -/*****************************************************************************/ -/* TYPE DEFINITIONS */ -/*****************************************************************************/ -psVector* p_psConvertToF32(psVector* in); -/*****************************************************************************/ -/* GLOBAL VARIABLES */ -/*****************************************************************************/ - -// None - -/*****************************************************************************/ -/* FILE STATIC VARIABLES */ -/*****************************************************************************/ - -// None - -/*****************************************************************************/ -/* FUNCTION IMPLEMENTATION - LOCAL */ -/*****************************************************************************/ - -psBool p_psGetStatValue(const psStats* stats, psF64 *value) -{ - // switch (stats->options & ~(PS_STAT_USE_RANGE | PS_STAT_USE_BINSIZE | PS_STAT_ROBUST_FOR_SAMPLE)) { - switch (stats->options & ~(PS_STAT_USE_RANGE | PS_STAT_USE_BINSIZE)) { - case PS_STAT_SAMPLE_MEAN: - *value = stats->sampleMean; - return true; - - case PS_STAT_SAMPLE_MEDIAN: - *value = stats->sampleMedian; - return true; - - case PS_STAT_SAMPLE_STDEV: - *value = stats->sampleStdev; - return true; - - case PS_STAT_ROBUST_MEAN: - *value = stats->robustMean; - return true; - - case PS_STAT_ROBUST_MEDIAN: - *value = stats->robustMedian; - return true; - - case PS_STAT_ROBUST_MODE: - *value = stats->robustMode; - return true; - - case PS_STAT_ROBUST_STDEV: - *value = stats->robustStdev; - return true; - - case PS_STAT_CLIPPED_MEAN: - *value = stats->clippedMean; - return true; - - case PS_STAT_CLIPPED_STDEV: - *value = stats->clippedStdev; - return true; - - case PS_STAT_MAX: - *value = stats->max; - return true; - - case PS_STAT_MIN: - *value = stats->min; - return true; - - default: - return false; - } -} - -/****************************************************************************** -MISC PRIVATE STATISTICAL FUNCTIONS - -NOTE: it is assumed that any call to these statistical functions will have -been preceded by a call to the psVectorStats() function. Various sanity tests -will only be performed in psVectorStats(). Should we perform the sanity -checks in each routine anyway? - -XXX: For many of these private stats routines, what should be done if there -are no acceptable elements in the input vector (if no elements lie within -range, or there are no unmasked elements, or the input vector is NULL)? -Currently we set the value to NAN. - -XXX: Optimization: many routines have an "empty" boolean variable which keeps -track of whether or not the vector has any valid elements. This code can -possibly be optimized away. - *****************************************************************************/ -/****************************************************************************** -p_psVectorSampleMean(myVector, maskVector, maskVal, stats): calculates the -mean of the input vector. If there was a problem with the mean calculation, -this routine sets stats->sampleMean to NAN. - *****************************************************************************/ -psS32 p_psVectorSampleMean(const psVector* myVector, - const psVector* errors, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - - psS32 i = 0; // Loop index variable - psF32 mean = 0.0; // The mean - psS32 count = 0; // # of points in this mean - - // If PS_STAT_USE_RANGE is requested, then we enter a slightly different - // loop. - if (errors == NULL) { - if (stats->options & PS_STAT_USE_RANGE) { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - // Check if the data is with the specified range - if (!(maskVal & maskVector->data.U8[i]) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - mean += myVector->data.F32[i]; - count++; - } - } - if (count != 0) { - mean /= (psF32)count; - } else { - mean = NAN; - } - - } else { - for (i = 0; i < myVector->n; i++) { - if ((stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - mean += myVector->data.F32[i]; - count++; - } - } - if (count != 0) { - mean /= (psF32)count; - } else { - mean = NAN; - } - } - } else { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - mean += myVector->data.F32[i]; - count++; - } - } - if (count != 0) { - mean /= (psF32)count; - } else { - mean = NAN; - } - } else { - for (i = 0; i < myVector->n; i++) { - mean += myVector->data.F32[i]; - } - mean /= (psF32)myVector->n; - } - } - } else { - psF32 errorDivisor = 0.0; - psF32 errorSqr = 0.0; - if (stats->options & PS_STAT_USE_RANGE) { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - // Check if the data is with the specified range - if (!(maskVal & maskVector->data.U8[i]) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - errorSqr = errors->data.F32[i]*errors->data.F32[i]; - mean += myVector->data.F32[i]/errorSqr; - errorDivisor+= (1.0 / errorSqr); - count++; - } - } - if (count != 0) { - mean /= errorDivisor; - } else { - mean = NAN; - } - - } else { - for (i = 0; i < myVector->n; i++) { - if ((stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - errorSqr = errors->data.F32[i]*errors->data.F32[i]; - mean += myVector->data.F32[i]/errorSqr; - errorDivisor+= (1.0 / errorSqr); - count++; - } - } - if (count != 0) { - mean /= errorDivisor; - } else { - mean = NAN; - } - } - } else { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - errorSqr = errors->data.F32[i]*errors->data.F32[i]; - mean += myVector->data.F32[i]/errorSqr; - errorDivisor+= (1.0 / errorSqr); - count++; - } - } - if (count != 0) { - mean /= errorDivisor; - } else { - mean = NAN; - } - } else { - for (i = 0; i < myVector->n; i++) { - errorSqr = errors->data.F32[i]*errors->data.F32[i]; - mean += myVector->data.F32[i]/errorSqr; - errorDivisor+= (1.0 / errorSqr); - } - mean /= errorDivisor; - } - } - } - - stats->sampleMean = mean; - if (isnan(mean)) { - return(-1); - } else { - return(0); - } - -} - -/****************************************************************************** -p_psVectorSampleMax(myVector, maskVector, maskVal, stats): calculates the -max of the input vector. If there was a problem with the max calculation, -this routine sets stats->max to NAN. - *****************************************************************************/ -psS32 p_psVectorMax(const psVector* myVector, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - psS32 i = 0; // Loop index variable - psF32 max = -PS_MAX_F32; // The calculated maximum - psS32 empty = true; // Does this vector have valid elements? - - // If PS_STAT_USE_RANGE is requested, then we enter a different loop. - if (stats->options & PS_STAT_USE_RANGE) { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - if ((myVector->data.F32[i] > max) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - max = myVector->data.F32[i]; - empty = false; - } - } - } - } else { - for (i = 0; i < myVector->n; i++) { - if ((myVector->data.F32[i] > max) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - max = myVector->data.F32[i]; - empty = false; - } - } - } - } else { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - if (myVector->data.F32[i] > max) { - max = myVector->data.F32[i]; - empty = false; - } - } - } - } else { - for (i = 0; i < myVector->n; i++) { - if (myVector->data.F32[i] > max) { - max = myVector->data.F32[i]; - empty = false; - } - } - } - } - if (empty == false) { - stats->max = max; - } else { - stats->max = NAN; - return(1); - } - return(0); -} - -/****************************************************************************** -p_psVectorSampleMin(myVector, maskVector, maskVal, stats): calculates the -minimum of the input vector. If there was a problem with the min calculation, -this routine sets stats->min to NAN. - *****************************************************************************/ -psS32 p_psVectorMin(const psVector* myVector, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - psS32 i = 0; // Loop index variable - psF32 min = PS_MAX_F32; // The calculated maximum - psS32 empty = true; // Does this vector have valid elements? - - if (stats->options & PS_STAT_USE_RANGE) { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - if ((myVector->data.F32[i] < min) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - min = myVector->data.F32[i]; - empty = false; - } - } - } - } else { - for (i = 0; i < myVector->n; i++) { - if ((myVector->data.F32[i] < min) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - min = myVector->data.F32[i]; - empty = false; - } - } - } - } else { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - if (myVector->data.F32[i] < min) { - min = myVector->data.F32[i]; - empty = false; - } - } - } - } else { - for (i = 0; i < myVector->n; i++) { - if (myVector->data.F32[i] < min) { - min = myVector->data.F32[i]; - empty = false; - } - } - } - } - - if (empty == false) { - stats->min = min; - } else { - stats->min = NAN; - return(1); - } - return(0); -} - -/****************************************************************************** -p_psVectorNValues(myVector, maskVector, maskVal, stats): This routine returns -"true" if the inputPsVector has 1 or more valid elements (a valid element is an -unmasked element within the specified min/max range). Otherwise, return -"false". - *****************************************************************************/ -bool p_psVectorCheckNonEmpty(const psVector* myVector, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - PS_ASSERT_VECTOR_NON_NULL(myVector, -1); - PS_ASSERT_PTR_NON_NULL(stats, -1); - psS32 i = 0; // Loop index variable - - if (stats->options & PS_STAT_USE_RANGE) { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i]) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - return(true); - } - } - } else { - for (i = 0; i < myVector->n; i++) { - if ((stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - return(true); - } - } - } - } else { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - return(true); - } - } - } else { - if (myVector->n > 0) { - return(true); - } - } - } - return(false); -} - - -/****************************************************************************** -p_psVectorNValues(myVector, maskVector, maskVal, stats): calculates the -number of non-masked pixels in the vector that fall within the min/max -range, if specified. - *****************************************************************************/ -psS32 p_psVectorNValues(const psVector* myVector, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - PS_ASSERT_VECTOR_NON_NULL(myVector, -1); - PS_ASSERT_PTR_NON_NULL(stats, -1); - psS32 i = 0; // Loop index variable - psS32 numData = 0; // The number of data points - - if (stats->options & PS_STAT_USE_RANGE) { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i]) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - numData++; - } - } - } else { - for (i = 0; i < myVector->n; i++) { - if ((stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - numData++; - } - } - } - } else { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - numData++; - } - } - } else { - numData = myVector->n; - } - } - - return (numData); -} - -/****************************************************************************** -p_psVectorSampleMedian(myVector, maskVector, maskVal, stats): calculates the -median of the input vector. Returns true on success (including if there were -no valid input vector elements). - -XXX: Use static vectors for sort arrays. - *****************************************************************************/ -bool p_psVectorSampleMedian(const psVector* myVector, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - psVector* unsortedVector = NULL; // Temporary vector - psVector* sortedVector = NULL; // Temporary vector - psS32 i = 0; // Loop index variable - psS32 count = 0; - psS32 nValues = 0; - - // Determine how many data points fit inside this min/max range - // and are not masked, if the maskVector is not NULL. - nValues = p_psVectorNValues(myVector, maskVector, maskVal, stats); - - // XXX: Is a warning message appropriate? What value should we set the - // sampleMedian to? Should we generate an error? - if (nValues <= 0) { - psLogMsg(__func__, PS_LOG_WARN, "WARNING: p_psVectorSampleMedian(): no valid elements in input vector.\n"); - return(true); - stats->sampleMedian = NAN; - } - - // Allocate temporary vectors for the data. - unsortedVector = psVectorAlloc(nValues, PS_TYPE_F32); - - // Determine if we must only use data points within a min/max range. - if (stats->options & PS_STAT_USE_RANGE) { - // Store all non-masked data points within the min/max range - // into the temporary vectors. - count = 0; - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i]) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - unsortedVector->data.F32[count] = myVector->data.F32[i]; - count++; - } - } - } else { - for (i = 0; i < myVector->n; i++) { - if ((stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - unsortedVector->data.F32[count] = myVector->data.F32[i]; - count++; - } - } - } - } else { - // Store all non-masked data points into the temporary vectors. - count = 0; - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - unsortedVector->data.F32[count] = myVector->data.F32[i]; - count++; - } - } - } else { - for (i = 0; i < myVector->n; i++) { - unsortedVector->data.F32[i] = myVector->data.F32[i]; - } - } - } - // Sort the temporary vectors. - sortedVector = psVectorSort(sortedVector, unsortedVector); - if (sortedVector == NULL) { - psError(PS_ERR_UNEXPECTED_NULL, - false, - PS_ERRORTEXT_psStats_STATS_SAMPLE_MEDIAN_SORT_PROBLEM); - return(false); - } - - // Calculate the median exactly. Use the average if the number of samples - // is even. - if (0 == (nValues % 2)) { - stats->sampleMedian = 0.5 * (sortedVector->data.F32[(nValues / 2) - 1] + - sortedVector->data.F32[nValues / 2]); - } else { - stats->sampleMedian = sortedVector->data.F32[nValues / 2]; - } - - // Free the temporary data structures. - psFree(unsortedVector); - psFree(sortedVector); - - // Return "true" on success. - return(true); -} - -/****************************************************************************** -p_psVectorSmoothHistGaussian(): This routine smoothes the data in the input -robustHistogram with a Gaussian of width sigma. - -XXX: Only PS_TYPE_F32 is supported. - -XXX: Write a general routine which smoothes a psVector. This routine should -call that. Is that possible? - *****************************************************************************/ -psVector* p_psVectorSmoothHistGaussian(psHistogram* robustHistogram, - psF32 sigma) -{ - PS_ASSERT_PTR_NON_NULL(robustHistogram, NULL); - PS_ASSERT_PTR_NON_NULL(robustHistogram->bounds, NULL); - - psS32 i = 0; // Loop index variable - psS32 j = 0; // Loop index variable - psF32 iMid; - psF32 jMid; - psS32 numBins = robustHistogram->nums->n; - psS32 numBounds = robustHistogram->bounds->n; - psVector* smooth = psVectorAlloc(numBins, PS_TYPE_F32); - psS32 jMin = 0; - psS32 jMax = 0; - psF32 firstBound = robustHistogram->bounds->data.F32[0]; - psF32 lastBound = robustHistogram->bounds->data.F32[numBounds-1]; - psScalar x; - - x.type.type = PS_TYPE_F32; - for (i = 0; i < numBins; i++) { - // Determine the midpoint of bin i. - iMid = (robustHistogram->bounds->data.F32[i] + - robustHistogram->bounds->data.F32[i+1]) / 2.0; - - - // We determine the bin numbers corresponding to a range of data - // values surrounding iMid. The ranges is of size - // s*PS_GAUSS_WIDTH*sigma - - // YYY: The p_psVectorBinDisect() routine does much of the work of - // the following conditionals, however, it also reports a warning - // message. I don't want the warning message so I reproduce the - // conditionals here. Maybe p_psVectorBinDisect() should not produce - // warnings? - - x.data.F32 = iMid - (PS_GAUSS_WIDTH * sigma); - if ((x.data.F32 >= firstBound) && (x.data.F32 <= lastBound)) { - jMin = p_psVectorBinDisect( *(psVector* *)&robustHistogram->bounds, &x); - if (jMin < 0) { - psError(PS_ERR_UNEXPECTED_NULL, - false, - PS_ERRORTEXT_psStats_STATS_VECTOR_BIN_DISECT_PROBLEM); - return(NULL); - } - } else if (x.data.F32 <= firstBound) { - jMin = 0; - } else if (x.data.F32 >= lastBound) { - jMin = robustHistogram->bounds->n - 1; - } - - x.data.F32 = iMid + (PS_GAUSS_WIDTH * sigma); - if ((x.data.F32 >= firstBound) && (x.data.F32 <= lastBound)) { - jMax = p_psVectorBinDisect( *(psVector* *)&robustHistogram->bounds, &x); - if (jMax < 0) { - psError(PS_ERR_UNEXPECTED_NULL, - false, - PS_ERRORTEXT_psStats_STATS_VECTOR_BIN_DISECT_PROBLEM); - return(NULL); - } - } else if (x.data.F32 <= firstBound) { - jMax = 0; - } else if (x.data.F32 >= lastBound) { - jMax = robustHistogram->bounds->n - 1; - } - - smooth->data.F32[i] = 0.0; - for (j = jMin ; j <= jMax ; j++) { - jMid = (robustHistogram->bounds->data.F32[j] + - robustHistogram->bounds->data.F32[j+1]) / 2.0; - smooth->data.F32[i] += - robustHistogram->nums->data.F32[j] * - psGaussian(jMid, iMid, sigma, true); - } - } - - return(smooth); -} - -/****************************************************************************** -p_psVectorSampleQuartiles(myVector, maskVector, maskVal, stats): calculates -the upper and/or lower quartiles of the input vector. -Inputs - myVector - maskVector - maskVal - stats -Returns - NULL - -XXX: Use static vectors. - *****************************************************************************/ -bool p_psVectorSampleQuartiles(const psVector* myVector, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - psVector* unsortedVector = NULL; // Temporary vector - psVector* sortedVector = NULL; // Temporary vector - psS32 i = 0; // Loop index variable - psS32 count = 0; // # of points in this mean. - psS32 nValues = 0; // # data points - - // Determine how many data points fit inside this min/max range - // and are not maxed, IF the maskVector is not NULL. - nValues = p_psVectorNValues(myVector, maskVector, maskVal, stats); - - // Allocate temporary vectors for the data. - unsortedVector = psVectorAlloc(nValues, PS_TYPE_F32); - - // Determine if we must only use data points within a min/max range. - if (stats->options & PS_STAT_USE_RANGE) { - // Store all non-masked data points within the min/max range - // into the temporary vectors. - count = 0; - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i]) && - (stats->min <= myVector->data.F32[i]) && (myVector->data.F32[i] <= stats->max)) { - unsortedVector->data.F32[count++] = myVector->data.F32[i]; - } - } - } else { - for (i = 0; i < myVector->n; i++) { - if ((stats->min <= myVector->data.F32[i]) && (myVector->data.F32[i] <= stats->max)) { - unsortedVector->data.F32[count++] = myVector->data.F32[i]; - } - } - } - } else { - // Store all non-masked data points into the temporary vectors. - count = 0; - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - unsortedVector->data.F32[count++] = myVector->data.F32[i]; - } - } - } else { - for (i = 0; i < myVector->n; i++) { - unsortedVector->data.F32[i] = myVector->data.F32[i]; - } - } - } - - // Sort the temporary vectors. - sortedVector = psVectorSort(sortedVector, unsortedVector); - if (sortedVector == NULL) { - psError(PS_ERR_UNEXPECTED_NULL, - false, - PS_ERRORTEXT_psStats_STATS_SAMPLE_MEDIAN_SORT_PROBLEM); - return(false); - } - - // Calculate the quartile points exactly. - // XXX: We should probably do a bin-midpoint if the quartile is not an - // integer. - stats->sampleUQ = sortedVector->data.F32[3 * (nValues / 4)]; - stats->sampleLQ = sortedVector->data.F32[nValues / 4]; - - // Free the temporary data structures. - psFree(unsortedVector); - psFree(sortedVector); - return(true); -} - -/****************************************************************************** -p_psVectorSampleStdev(myVector, maskVector, maskVal, stats): calculates the -stdev of the input vector. -Inputs - myVector - maskVector - maskVal - stats -Returns - NULL - - *****************************************************************************/ -void p_psVectorSampleStdevOLD(const psVector* myVector, - const psVector* errors, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - psS32 i = 0; // Loop index variable - psS32 countInt = 0; // # of data points being used - psF32 countFloat = 0.0; // # of data points being used - psF32 mean = 0.0; // The mean - psF32 diff = 0.0; // Used in calculating stdev - psF32 sumSquares = 0.0; // temporary variable - psF32 sumDiffs = 0.0; // temporary variable - - // This procedure requires the mean. If it has not been already - // calculated, then call p_psVectorSampleMean() - if (0 != isnan(stats->sampleMean)) { - p_psVectorSampleMean(myVector, errors, maskVector, maskVal, stats); - } - // If the mean is NAN, then generate a warning and set the stdev to NAN. - if (0 != isnan(stats->sampleMean)) { - stats->sampleStdev = NAN; - psLogMsg(__func__, PS_LOG_WARN, "WARNING: p_psVectorSampleStdev(): p_psVectorSampleMean() reported a NAN mean.\n"); - return; - } - - mean = stats->sampleMean; - if (stats->options & PS_STAT_USE_RANGE) { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i]) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - diff = myVector->data.F32[i] - mean; - sumSquares += (diff * diff); - sumDiffs += diff; - countInt++; - } - } - } else { - for (i = 0; i < myVector->n; i++) { - if ((stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - diff = myVector->data.F32[i] - mean; - sumSquares += (diff * diff); - sumDiffs += diff; - countInt++; - } - } - countInt = myVector->n; - } - } else { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - diff = myVector->data.F32[i] - mean; - sumSquares += (diff * diff); - sumDiffs += diff; - countInt++; - } - } - } else { - for (i = 0; i < myVector->n; i++) { - diff = myVector->data.F32[i] - mean; - sumSquares += (diff * diff); - sumDiffs += diff; - countInt++; - } - countInt = myVector->n; - } - } - if (countInt == 0) { - stats->sampleStdev = NAN; - psLogMsg(__func__, PS_LOG_WARN, "WARNING: p_psVectorSampleStdev(): no valid psVector elements (%d). Setting stats->sampleStdev = NAN.\n", countInt); - } else if (countInt == 1) { - stats->sampleStdev = 0.0; - psLogMsg(__func__, PS_LOG_WARN, "WARNING: p_psVectorSampleStdev(): only one valid psVector elements (%d). Setting stats->sampleStdev = 0.0.\n", countInt); - } else { - countFloat = (psF32)countInt; - stats->sampleStdev = sqrtf((sumSquares - (sumDiffs * sumDiffs / countFloat)) / (countFloat - 1)); - } -} -/****************************************************************************** -p_psVectorSampleStdev(myVector, maskVector, maskVal, stats): calculates the -stdev of the input vector. -Inputs - myVector - maskVector - maskVal - stats -Returns - NULL - - *****************************************************************************/ -void p_psVectorSampleStdev(const psVector* myVector, - const psVector* errors, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - psS32 i = 0; // Loop index variable - psS32 countInt = 0; // # of data points being used - psF32 countFloat = 0.0; // # of data points being used - psF32 mean = 0.0; // The mean - psF32 diff = 0.0; // Used in calculating stdev - psF32 sumSquares = 0.0; // temporary variable - psF32 sumDiffs = 0.0; // temporary variable - // psF32 sum1; - // psF32 sum2; - psF32 errorDivisor = 0.0f; - - // This procedure requires the mean. If it has not been already - // calculated, then call p_psVectorSampleMean() - if (0 != isnan(stats->sampleMean)) { - p_psVectorSampleMean(myVector, errors, maskVector, maskVal, stats); - } - // If the mean is NAN, then generate a warning and set the stdev to NAN. - if (0 != isnan(stats->sampleMean)) { - stats->sampleStdev = NAN; - psLogMsg(__func__, PS_LOG_WARN, "WARNING: p_psVectorSampleStdev(): p_psVectorSampleMean() reported a NAN mean.\n"); - return; - } - - mean = stats->sampleMean; - if (stats->options & PS_STAT_USE_RANGE) { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i]) && - (stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - diff = myVector->data.F32[i] - mean; - sumSquares += (diff * diff); - sumDiffs += diff; - countInt++; - if (errors != NULL) { - errorDivisor+= (1.0 / PS_SQR(errors->data.F32[i])); - } - } - } - } else { - for (i = 0; i < myVector->n; i++) { - if ((stats->min <= myVector->data.F32[i]) && - (myVector->data.F32[i] <= stats->max)) { - diff = myVector->data.F32[i] - mean; - sumSquares += (diff * diff); - sumDiffs += diff; - countInt++; - if (errors != NULL) { - errorDivisor+= (1.0 / PS_SQR(errors->data.F32[i])); - } - } - } - countInt = myVector->n; - } - } else { - if (maskVector != NULL) { - for (i = 0; i < myVector->n; i++) { - if (!(maskVal & maskVector->data.U8[i])) { - diff = myVector->data.F32[i] - mean; - sumSquares += (diff * diff); - sumDiffs += diff; - countInt++; - if (errors != NULL) { - errorDivisor+= (1.0 / PS_SQR(errors->data.F32[i])); - } - } - } - } else { - for (i = 0; i < myVector->n; i++) { - diff = myVector->data.F32[i] - mean; - sumSquares += (diff * diff); - sumDiffs += diff; - countInt++; - } - countInt = myVector->n; - if (errors != NULL) { - errorDivisor+= (1.0 / PS_SQR(errors->data.F32[i])); - } - } - } - - if (countInt == 0) { - stats->sampleStdev = NAN; - psLogMsg(__func__, PS_LOG_WARN, "WARNING: p_psVectorSampleStdev(): no valid psVector elements (%d). Setting stats->sampleStdev = NAN.\n", countInt); - } else if (countInt == 1) { - stats->sampleStdev = 0.0; - psLogMsg(__func__, PS_LOG_WARN, "WARNING: p_psVectorSampleStdev(): only one valid psVector elements (%d). Setting stats->sampleStdev = 0.0.\n", countInt); - } else { - // XXX: The ADD specifies this as the definition of the standard - // deviation if the errors are known. Verify this with IfA: none of - // the data points in the vector are used. Verify that the masks and - // data ranges are used correctly. - if (errors != NULL) { - stats->sampleStdev = (1.0 / sqrtf(errorDivisor)); - } else { - countFloat = (psF32)countInt; - stats->sampleStdev = sqrtf((sumSquares - (sumDiffs * sumDiffs / countFloat)) / (countFloat - 1)); - - } - } -} - -/****************************************************************************** -p_psVectorClippedStats(myVector, errors, maskVector, maskVal, stats): calculates the -clipped stats (mean or stdev) of the input vector. - -Inputs - myVector - maskVector - maskVal - stats -Returns - 0 for success. - -1: error - -2: warning - -XXX: Do we really need to calculate median and mean? - -XXX: Use static vectors for tmpMask. - -XXX: This has not been tested. - *****************************************************************************/ -psS32 p_psVectorClippedStats(const psVector* myVector, - const psVector* errors, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - psF32 clippedMean = 0.0; // self-explanatory - psF32 clippedStdev = 0.0; // self-explanatory - psVector* tmpMask = NULL; // Temporary vector for masks during iterations. - static psStats *statsTmp = NULL; // Temporary psStats struct. - psS32 rc = 0; // Return code. - - // Ensure that stats->clipIter is within the proper range. - PS_ASSERT_INT_WITHIN_RANGE(stats->clipIter, - PS_CLIPPED_NUM_ITER_LB, - PS_CLIPPED_NUM_ITER_UB, -1); - - // Ensure that stats->clipSigma is within the proper range. - PS_ASSERT_INT_WITHIN_RANGE(stats->clipSigma, - PS_CLIPPED_SIGMA_LB, - PS_CLIPPED_SIGMA_UB, -1); - - // Allocate a psStats structure for calculating the mean, median, and - // stdev. - if (statsTmp == NULL) { - statsTmp = psStatsAlloc(PS_STAT_SAMPLE_MEAN); - p_psMemSetPersistent(statsTmp, true); - } - - // We allocate a temporary mask vector since during the iterative - // steps that follow, we will be masking off additional data points. - // However, we do no want to modify the original mask vector. - tmpMask = psVectorAlloc(myVector->n, PS_TYPE_U8); - - // If we were called with a mask vector, then initialize the temporary - // mask vector with those values. Otherwise, initialize to zero. - if (maskVector != NULL) { - for (psS32 i = 0; i < tmpMask->n; i++) { - tmpMask->data.U8[i] = maskVector->data.U8[i]; - } - } else { - for (psS32 i = 0; i < tmpMask->n; i++) { - tmpMask->data.U8[i] = 0; - } - } - - // 1. Compute the sample median. - p_psVectorSampleMedian(myVector, maskVector, maskVal, statsTmp); - if (isnan(statsTmp->sampleMedian)) { - psLogMsg(__func__, PS_LOG_WARN, "Call to p_psVectorSampleMedian returned NAN\n"); - stats->clippedMean = NAN; - stats->clippedStdev = NAN; - return(-2); - } - - // 2. Compute the sample standard deviation. - p_psVectorSampleStdev(myVector, errors, maskVector, maskVal, statsTmp); - if (isnan(statsTmp->sampleStdev)) { - psLogMsg(__func__, PS_LOG_WARN, "Call to p_psVectorSampleStdev returned NAN\n"); - stats->clippedMean = NAN; - stats->clippedStdev = NAN; - return(-2); - } - - // 3. Use the sample median as the first estimator of the mean X. - clippedMean = statsTmp->sampleMedian; - - // 4. Use the sample stdev as the first estimator of the mean stdev. - clippedStdev = statsTmp->sampleStdev; - - // 5. Repeat N (stats->clipIter) times: - for (psS32 iter = 0; iter < stats->clipIter; iter++) { - // a) Exclude all values x_i for which |x_i - x| > K * stdev - if (errors != NULL) { - for (psS32 j = 0; j < myVector->n; j++) { - if (fabs(myVector->data.F32[j] - clippedMean) > - (stats->clipSigma * errors->data.F32[j])) { - tmpMask->data.U8[j] = 0xff; - } - } - } else { - for (psS32 j = 0; j < myVector->n; j++) { - if (fabs(myVector->data.F32[j] - clippedMean) > - (stats->clipSigma * clippedStdev)) { - tmpMask->data.U8[j] = 0xff; - } - } - } - - // b) compute new mean and stdev - p_psVectorSampleMean(myVector, errors, tmpMask, 0xff, statsTmp); - p_psVectorSampleStdev(myVector, errors, tmpMask, 0xff, statsTmp); - - // If the new mean and stdev are NAN, we must exit the loop. - // Otherwise, use the new results and continue. - if (isnan(statsTmp->sampleMean) || isnan(statsTmp->sampleStdev)) { - // Exit loop. XXX: Should we throw an error/warning here? - iter = stats->clipIter; - rc = -1; - } else { - clippedMean = statsTmp->sampleMean; - clippedStdev = statsTmp->sampleStdev; - } - } - - // 7. The last calcuated value of x is the cliped mean. - if (stats->options & PS_STAT_CLIPPED_MEAN) { - stats->clippedMean = clippedMean; - } - // 8. The last calcuated value of stdev is the cliped stdev. - if (stats->options & PS_STAT_CLIPPED_STDEV) { - stats->clippedStdev = clippedStdev; - } - - psFree(tmpMask); - return(rc); -} - -/***************************************************************************** -These macros and functions define the following functions: - -< p_psNormalizeVectorRange(myData, low, high) - -That assumes that the low/high arguments are PS_TYPE_F64; the vector myData -can be of any type. Arguments low/high will be converted to the appropriate -type and one of the type-specific functions below will be called: - - p_psNormalizeVectorRangeU8(myData, low, high) - p_psNormalizeVectorRangeU16(myData, low, high) - p_psNormalizeVectorRangeU32(myData, low, high) - p_psNormalizeVectorRangeU64(myData, low, high) - p_psNormalizeVectorRangeS8(myData, low, high) - p_psNormalizeVectorRangeS16(myData, low, high) - p_psNormalizeVectorRangeS32(myData, low, high) - p_psNormalizeVectorRangeS64(myData, low, high) - p_psNormalizeVectorRangeF32(myData, low, high) - p_psNormalizeVectorRangeF64(myData, low, high) - *****************************************************************************/ -#define PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(TYPE) \ -void p_psNormalizeVectorRange##TYPE(psVector* myData, \ - ps##TYPE outLow, \ - ps##TYPE outHigh) \ -{ \ - ps##TYPE min = (ps##TYPE) PS_MAX_##TYPE; \ - ps##TYPE max = (ps##TYPE) -PS_MAX_##TYPE; \ - psS32 i = 0; \ - \ - for (i = 0; i < myData->n; i++) { \ - if (myData->data.TYPE[i] < min) { \ - min = myData->data.TYPE[i]; \ - } \ - if (myData->data.TYPE[i] > max) { \ - max = myData->data.TYPE[i]; \ - } \ - } \ - \ - /* Ensure that max!=min before we divide by (max-min) */ \ - if (max != min) { \ - for (i = 0; i < myData->n; i++) { \ - myData->data.TYPE[i] = (outLow + (myData->data.TYPE[i] - min) * \ - (outHigh - outLow) / (max - min)); \ - } \ - } else { \ - psLogMsg(__func__, PS_LOG_WARN, "WARNING: (max==min). Setting all elements to min.\n"); \ - for (i = 0; i < myData->n; i++) \ - { \ - \ - myData->data.TYPE[i] = outLow; \ - \ - } \ - } \ -} \ - -PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(U8) -PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(U16) -PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(U32) -PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(U64) -PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(S8) -PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(S16) -PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(S32) -PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(S64) -PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(F32) -PS_FUNC_MACRO_NORMALIZE_VECTOR_RANGE(F64) - -void p_psNormalizeVectorRange(psVector* myData, - psF64 outLow, - psF64 outHigh) -{ - switch (myData->type.type) { - case PS_TYPE_U8: - p_psNormalizeVectorRangeU8(myData, (psU8) outLow, (psU8) outHigh); - break; - case PS_TYPE_U16: - p_psNormalizeVectorRangeU16(myData, (psU16) outLow, (psU16) outHigh); - break; - case PS_TYPE_U32: - p_psNormalizeVectorRangeU32(myData, (psU32) outLow, (psU32) outHigh); - break; - case PS_TYPE_U64: - p_psNormalizeVectorRangeU64(myData, (psU64) outLow, (psU64) outHigh); - break; - case PS_TYPE_S8: - p_psNormalizeVectorRangeS8(myData, (psS8) outLow, (psS8) outHigh); - break; - case PS_TYPE_S16: - p_psNormalizeVectorRangeS16(myData, (psS16) outLow, (psS16) outHigh); - break; - case PS_TYPE_S32: - p_psNormalizeVectorRangeS32(myData, (psS32) outLow, (psS32) outHigh); - break; - case PS_TYPE_S64: - p_psNormalizeVectorRangeS64(myData, (psS64) outLow, (psS64) outHigh); - break; - case PS_TYPE_F32: - p_psNormalizeVectorRangeF32(myData, (psF32) outLow, (psF32) outHigh); - break; - case PS_TYPE_F64: - p_psNormalizeVectorRangeF64(myData, (psF64) outLow, (psF64) outHigh); - break; - case PS_TYPE_C32: - case PS_TYPE_C64: - default: - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - "Unallowable operation: %s has incorrect type.", - myData); - break; - } -} - -/****************************************************************************** -p_ps1DPolyMedian(myPoly, rangeLow, rangeHigh, midpoint): This routine takes -as input a 1-D polynomial of arbitrary order (though we are using 2nd-order -polynomials here) and a range of x-values for which it is defined: -[rangeLow, rangeHigh]. It determines the x-value of that polynomial such -that f(x) == midpoint. This functions uses a binary-search algorithm on the -range and assumes that the polynomial is monotonically increasing or -decreasing within that range. - -XXX: Terminate when f(x)-getThisValue is within some error tolerance. - -XXX: Create a 2nd-order polynomial version and solve for X analytically. - *****************************************************************************/ -psF32 p_ps1DPolyMedian(psPolynomial1D* myPoly, - psF32 rangeLow, - psF32 rangeHigh, - psF32 getThisValue) -{ - PS_ASSERT_POLY_NON_NULL(myPoly, NAN); - PS_FLOAT_COMPARE(rangeLow, rangeHigh, NAN); - // We ensure that the requested f(y) value, which is getThisValue, is - // falls within the range of y-values of the polynomial "myPoly" in the - // specified x-range (rangeLow:rangeHigh). - psF32 fLo = psPolynomial1DEval( - myPoly, - rangeLow - ); - psF32 fHi = psPolynomial1DEval( - myPoly, - rangeHigh - ); - if (!((fLo <= getThisValue) && (fHi >= getThisValue))) { - psError(PS_ERR_UNKNOWN, - true, - PS_ERRORTEXT_psStats_STATS_POLY_MEDIAN_OUT_OF_RANGE); - return(NAN); - } - - psS32 numIterations = 0; - psF32 midpoint = 0.0; - psF32 oldMidpoint = 1.0; - psF32 f = 0.0; - - while (numIterations < PS_POLY_MEDIAN_MAX_ITERATIONS) { - midpoint = (rangeHigh + rangeLow) / 2.0; - if (fabs(midpoint - oldMidpoint) <= FLT_EPSILON) { - return (midpoint); - } - oldMidpoint = midpoint; - - f = psPolynomial1DEval( - myPoly, - midpoint - ); - if (fabs(f - getThisValue) <= FLT_EPSILON) { - return (midpoint); - } - - if (f > getThisValue) { - rangeHigh = midpoint; - } else { - rangeLow = midpoint; - } - numIterations++; - } - return (midpoint); -} - -/****************************************************************************** -fitQuadraticSearchForYThenReturnX(*xVec, *yVec, binNum, yVal): A general -routine which fits a quadratic to three points and returns the x-value -corresponding to the input y-value. This routine takes psVectors of x/y pairs -as input, and fits a quadratic to the 3 points surrounding element binNum in -the vectors (the midpoint between element i and i+1 is used for x[i]). It -then determines for what value x does that quadratic f(x) = yVal (the input -parameter). - -XXX: After you fit the polynomial, solve for X analytically. - -XXX: the vectors do not have to be the same length. Must insert the proper -tests to ensure that binNum is within acceptable ranges for both vectors. -*****************************************************************************/ -psF32 fitQuadraticSearchForYThenReturnX(psVector *xVec, - psVector *yVec, - psS32 binNum, - psF32 yVal) -{ - PS_ASSERT_VECTOR_NON_NULL(xVec, NAN); - PS_ASSERT_VECTOR_NON_NULL(yVec, NAN); - PS_ASSERT_VECTOR_TYPE(xVec, PS_TYPE_F32, NAN); - PS_ASSERT_VECTOR_TYPE(yVec, PS_TYPE_F32, NAN); - // PS_ASSERT_VECTORS_SIZE_EQUAL(xVec, yVec, NAN); - PS_ASSERT_INT_WITHIN_RANGE(binNum, 0, (xVec->n - 1), NAN); - PS_ASSERT_INT_WITHIN_RANGE(binNum, 0, (yVec->n - 1), NAN); - - // PS_VECTOR_DECLARE_ALLOC_STATIC(x, 3, PS_TYPE_F64); - // PS_VECTOR_DECLARE_ALLOC_STATIC(y, 3, PS_TYPE_F64); - // PS_VECTOR_DECLARE_ALLOC_STATIC(yErr, 3, PS_TYPE_F64); - // PS_POLY_1D_DECLARE_ALLOC_STATIC(myPoly, 2, PS_POLYNOMIAL_ORD); - psVector *x = psVectorAlloc(3, PS_TYPE_F64); - psVector *y = psVectorAlloc(3, PS_TYPE_F64); - psVector *yErr = psVectorAlloc(3, PS_TYPE_F64); - psPolynomial1D *myPoly = psPolynomial1DAlloc(2, PS_POLYNOMIAL_ORD); - - psF32 tmpFloat = 0.0f; - - if ((binNum > 0) && (binNum < (yVec->n - 2))) { - // The general case. We have all three points. - x->data.F64[0] = (psF64) (0.5 * (xVec->data.F32[binNum - 1] + xVec->data.F32[binNum])); - x->data.F64[1] = (psF64) (0.5 * (xVec->data.F32[binNum] + xVec->data.F32[binNum+1])); - x->data.F64[2] = (psF64) (0.5 * (xVec->data.F32[binNum+1] + xVec->data.F32[binNum+2])); - y->data.F64[0] = yVec->data.F32[binNum - 1]; - y->data.F64[1] = yVec->data.F32[binNum]; - y->data.F64[2] = yVec->data.F32[binNum + 1]; - - // Ensure that yVal is within the range of the bins we are using. - if (!((y->data.F64[0] <= yVal) && (yVal <= y->data.F64[2]))) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psStats_YVAL_OUT_OF_RANGE, - (psF64)yVal,y->data.F64[2],y->data.F64[0]); - } - yErr->data.F64[0] = 1.0; - yErr->data.F64[1] = 1.0; - yErr->data.F64[2] = 1.0; - - // Determine the coefficients of the polynomial. - myPoly = psVectorFitPolynomial1D(myPoly, x, y, yErr); - if (myPoly == NULL) { - psError(PS_ERR_UNEXPECTED_NULL, - false, - PS_ERRORTEXT_psStats_STATS_FIT_QUADRATIC_POLYNOMIAL_1D_FIT); - psFree(myPoly); - psFree(x); - psFree(y); - psFree(yErr); - return(NAN); - } - // Call p_ps1DPolyMedian(), which does a binary search on the - // polynomial, looking for the value x such that f(x) = yVal - tmpFloat = p_ps1DPolyMedian(myPoly, x->data.F64[0], x->data.F64[2], yVal); - if (isnan(tmpFloat)) { - psError(PS_ERR_UNEXPECTED_NULL, - false, - PS_ERRORTEXT_psStats_STATS_FIT_QUADRATIC_POLY_MEDIAN); - psFree(myPoly); - psFree(x); - psFree(y); - psFree(yErr); - return(NAN); - } - - } else { - // The special case where we have two points only at the beginning of - // the vectors x and y. - if (binNum == 0) { - tmpFloat = 0.5 * (xVec->data.F32[binNum] + - xVec->data.F32[binNum + 1]); - } else if (binNum == (xVec->n - 1)) { - // The special case where we have two points only at the end of - // the vectors x and y. - // XXX: Is this right? - tmpFloat = xVec->data.F32[binNum]; - } else if (binNum == (xVec->n - 2)) { - // XXX: Is this right? - tmpFloat = 0.5 * (xVec->data.F32[binNum] + - xVec->data.F32[binNum + 1]); - } - } - - psFree(myPoly); - psFree(x); - psFree(y); - psFree(yErr); - return(tmpFloat); -} - -/****************************************************************************** -p_psVectorRobustStats(myVector, maskVector, maskVal, stats): this procedure -calculates a variety of robust stat measures: - PS_STAT_ROBUST_MEAN - PS_STAT_ROBUST_MEDIAN - PS_STAT_ROBUST_MODE - PS_STAT_ROBUST_STDEV - PS_STAT_ROBUST_QUARTILE -I have included all that computation in a single function, as opposed to -breaking it across several functions for one primary reason: they all require -the same basic initial processing steps (calculate the histogram, etc.). - -Inputs - myVector - maskVector - maskVal - stats -Returns - 0 on success. - -XXX: Check for errors in psLib routines that we call. -*****************************************************************************/ -psS32 p_psVectorRobustStats(const psVector* myVector, - const psVector* errors, - const psVector* maskVector, - psU32 maskVal, - psStats* stats) -{ - psHistogram* robustHistogram = NULL; - psVector* robustHistogramVector = NULL; - psF32 binSize = 0.0; // Size of the histogram bins - psS32 LQBinNum = -1; // Bin num for lower quartile - psS32 UQBinNum = -1; // Bin num for upper quartile - psS32 medianBinNum = -1; - psS32 i = 0; // Loop index variable - psS32 modeBinNum = 0; - psF32 modeBinCount = 0.0; - psF32 dL = 0.0; - psS32 numBins = 0; - psF32 myMean = 0.0; - psF32 myStdev = 0.0; - psF32 countFloat = 0.0; - psF32 diff = 0.0; - psF32 sumSquares = 0.0; - psF32 sumDiffs = 0.0; - psVector* cumulativeRobustSums = NULL; - psF32 sumRobust = 0.0; - psF32 sumN50 = 0.0; - psF32 sumNfit = 0.0; - psScalar tmpScalar; - tmpScalar.type.type = PS_TYPE_F32; - psStats* tmpStats = psStatsAlloc(PS_STAT_CLIPPED_STDEV | PS_STAT_CLIPPED_MEAN); - - // Compute the initial bin size of the robust histogram. This is done - // by computing the clipped standard deviation of the vector, and dividing - // that by 10.0; - //XXX: add errors - psS32 rc = p_psVectorClippedStats(myVector, NULL, maskVector, maskVal, tmpStats); - if (rc != 0) { - psError(PS_ERR_UNEXPECTED_NULL, - false, - PS_ERRORTEXT_psStats_ROBUST_STATS_CLIPPED_STATS); - return(1); - } - binSize = tmpStats->clippedStdev / 10.0f; - - // If stats->clippedStdev == 0.0, then all data elements have the same - // value. Therefore, we can set the appropiate results and return. - if (fabs(binSize) <= FLT_EPSILON) { - if (stats->options & PS_STAT_ROBUST_MEAN) { - stats->robustMean = tmpStats->clippedMean; - } - if (stats->options & PS_STAT_ROBUST_MEDIAN) { - stats->robustMedian = tmpStats->clippedMean; - } - if (stats->options & PS_STAT_ROBUST_MODE) { - stats->robustMode = tmpStats->clippedMean; - } - if (stats->options & PS_STAT_ROBUST_STDEV) { - stats->robustStdev = 0.0; - } - if (stats->options & PS_STAT_ROBUST_QUARTILE) { - stats->robustUQ = tmpStats->clippedMean; - stats->robustLQ = tmpStats->clippedMean; - } - // XXX: Set these to the number of unmasked data points? - stats->robustNfit = 0.0; - stats->robustN50 = 0.0; - psFree(tmpStats); - return(0); - } - - // Determine minimum and maximum values in the data vector. - // XXX: remove this conditional? - if (isnan(tmpStats->min)) { - if (0 != p_psVectorMin(myVector, maskVector, maskVal, tmpStats)) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: p_psVectorMin(): p_psVectorMin() reported a NAN mean.\n"); - return(1); - } - } - // XXX: remove this conditional? - if (isnan(tmpStats->max)) { - if (0 != p_psVectorMax(myVector, maskVector, maskVal, tmpStats)) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: p_psVectorMin(): p_psVectorMax() reported a NAN mean.\n"); - return(1); - } - } - - // Create the histogram structure. NOTE: we can not specify the bin size - // precisely since the argument to psHistogramAlloc() is the number of - // bins, not the binSize. Also, if we get here, we know that - // binSize != 0.0. - numBins = (psS32)((tmpStats->max - tmpStats->min) / binSize); - robustHistogram = psHistogramAlloc(tmpStats->min, tmpStats->max, numBins); - - // Populate the histogram array. - psVectorHistogram(robustHistogram, myVector, errors, maskVector, maskVal); - - // Smooth the histogram, Gaussian-style. - robustHistogramVector = p_psVectorSmoothHistGaussian(robustHistogram, - tmpStats->clippedStdev / 4.0f); - - /************************************************************************** - Determine the median/lower/upper quartile bin numbers. - - We define a vector called "cumulativeRobustSums" where the value at - index position i is equal to the sum of bins 0:i. This will be used in - determining the median and lower/upper quartiles. - **************************************************************************/ - cumulativeRobustSums = psVectorAlloc(robustHistogramVector->n, PS_TYPE_F32); - cumulativeRobustSums->data.F32[0] = robustHistogramVector->data.F32[0]; - for (i = 1; i < robustHistogramVector->n; i++) { - cumulativeRobustSums->data.F32[i] = cumulativeRobustSums->data.F32[i - 1] + - robustHistogramVector->data.F32[i]; - } - sumRobust = cumulativeRobustSums->data.F32[robustHistogramVector->n - 1]; - - tmpScalar.data.F32 = sumRobust / 4.0; - LQBinNum = p_psVectorBinDisect(cumulativeRobustSums, &tmpScalar); - tmpScalar.data.F32 = 3.0 * sumRobust / 4.0; - UQBinNum = p_psVectorBinDisect(cumulativeRobustSums, &tmpScalar); - tmpScalar.data.F32 = sumRobust / 2.0; - medianBinNum = p_psVectorBinDisect(cumulativeRobustSums, &tmpScalar); - - if ((LQBinNum < 0) || (UQBinNum < 0)) { - psError(PS_ERR_UNKNOWN, true, - PS_ERRORTEXT_psStats_ROBUST_QUARTILE_BINS_FAILED); - return(1); - } - if (medianBinNum < 0) { - psError(PS_ERR_UNKNOWN, true, - PS_ERRORTEXT_psStats_ROBUST_QUARTILE_BINS_FAILED); - return(1); - } - /************************************************************************** - Determine the mode in the range LQ:UQ. - **************************************************************************/ - // Determine the bin with the peak value in the range LQ to UQ. - modeBinNum = LQBinNum; - modeBinCount = robustHistogramVector->data.F32[LQBinNum]; - sumN50 = robustHistogram->nums->data.F32[LQBinNum]; - for (i = LQBinNum + 1; i <= UQBinNum; i++) { - if (robustHistogramVector->data.F32[i] > modeBinCount) { - modeBinNum = i; - modeBinCount = robustHistogramVector->data.F32[i]; - } - sumN50 += robustHistogram->nums->data.F32[i]; - } - - dL = (UQBinNum - LQBinNum) / 4; - /************************************************************************** - Determine the mean/stdev for the bins in the range mode-dL to mode+dL - **************************************************************************/ - // Calculate the mean of the smoothed robust histogram in the range - // mode-dL to mode+dL. We use the midpoint of each bin as the mean for - // that bin (this is a non-exact approximation). - sumNfit = 0.0; - myMean = 0.0; - for (i = modeBinNum - dL; i <= modeBinNum + dL; i++) { - if ((0 <= i) && (i < robustHistogramVector->n)) { - myMean += (robustHistogramVector->data.F32[i]) * PS_BIN_MIDPOINT(robustHistogram, i); - countFloat += robustHistogramVector->data.F32[i]; - } - - sumNfit += robustHistogram->nums->data.F32[i]; - } - // XXX: divide by zero? - myMean /= countFloat; - - // Calculate the stdev of the smoothed robust histogram in the range - // mode-dL to mode+dL. We use the midpoint of each bin as the mean for - // that bin. - for (i = modeBinNum - dL; i <= modeBinNum + dL; i++) { - if ((0 <= i) && (i < robustHistogramVector->n)) { - diff = PS_BIN_MIDPOINT(robustHistogram, i) - myMean; - sumSquares += diff * diff * robustHistogramVector->data.F32[i]; - sumDiffs += diff * robustHistogramVector->data.F32[i]; - } - } - myStdev = sqrtf((sumSquares - (sumDiffs * sumDiffs / countFloat)) / (countFloat - 1)); - - p_psNormalizeVectorRangeF32(robustHistogramVector, 0.0, 1.0); - - if ((stats->options & PS_STAT_ROBUST_MEAN) || - (stats->options & PS_STAT_ROBUST_STDEV)) { - // We fit a 1-D polynomial to the data. - // XXX: I implement the changes requested in bug 366. However, this - // code no longer produces sensible results. - // XXX: Since we are no longer fitting a 1-D Gaussian, we can probably - // remove some of theabove code that calculated the initial estimate - // for the mean and sigma. - - psVector *y = psVectorAlloc(2 * dL + 1, PS_TYPE_F32); - psVector *x = psVectorAlloc(2 * dL + 1, PS_TYPE_F32); - for (i = modeBinNum - dL; i <= modeBinNum + dL; i++) { - int index = i - modeBinNum + dL; - // XXX: Should this be the natural log? - y->data.F32[index] = robustHistogramVector->data.F32[i]; - // y->data.F32[index] = logf(robustHistogramVector->data.F32[i]); - x->data.F32[index] = (psF32) index; - } - - psPolynomial1D *tmpPoly = psPolynomial1DAlloc(3, PS_POLYNOMIAL_ORD); - // XXX: What about the NULL x argument? - tmpPoly = psVectorFitPolynomial1D(tmpPoly, NULL, y, NULL); - if (tmpPoly == NULL) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: failed fit a 1D polynomial.\n"); - } - psF32 polyFitSigma = sqrtf(-0.5 / tmpPoly->coeff[2]); - psF32 polyFitMean = tmpPoly->coeff[1] * PS_SQR(polyFitSigma); - // psF32 polyFitNorm = exp(tmpPoly->coedd[0] + PS_SQR(polyFitMean) / (2.0 * PS_SQR(polyFitSigma))); - - if (stats->options & PS_STAT_ROBUST_MEAN) { - stats->robustMean = polyFitMean; - } - - if (stats->options & PS_STAT_ROBUST_STDEV) { - stats->robustStdev = polyFitSigma; - } - // For testing only. This shows that the polynomial fit is successful. - if (0) { - printf("--- Results of the 1-D polynomial fit:\n"); - for (i = modeBinNum - dL; i <= modeBinNum + dL; i++) { - int index = i - modeBinNum + dL; - printf("(x, y, poly(x)) is (%.2f, %.2f, %.2f)\n", - x->data.F32[index], - y->data.F32[index], - psPolynomial1DEval(tmpPoly, x->data.F32[index])); - } - } - - psFree(x); - psFree(y); - psFree(tmpPoly); - } - - - /************************************************************************** - Set the appropriate members in the output stats struct. - **************************************************************************/ - - if (stats->options & PS_STAT_ROBUST_MODE) { - stats->robustMode = PS_BIN_MIDPOINT(robustHistogram, modeBinNum); - } - - - // To determine the median, we fit a quadratic y=f(x) to the three bins - // surrounding the bin containing the median (x is the midpoint of each - // bin and y is the value of each bin). Then we figure out what value - // of x corresponds to f(x) being the median (half of all points). - if (stats->options & PS_STAT_ROBUST_MEDIAN) { - // Take a psVector. Fit a polynomial y = f(x) to the 3 data elements - // surrounding medianBinNum, then find the x-value corresponding y = sumRobust/2.0. - - //XXX: robustHistogram->bounds and cumulativeRobustSums are of different lengths. - //Determine id that is okay. - stats->robustMedian = fitQuadraticSearchForYThenReturnX( - *(psVector* *)&robustHistogram->bounds, - cumulativeRobustSums, - medianBinNum, - sumRobust/2.0); - } - - // To determine the quartiles, we fit a quadratic y=f(x) to the three bins - // surrounding the bin containing LQ/UQ (x is the midpoint of each - // bin and y is the value of each bin). Then we figure out what value - // of x corresponds to f(x) being the LQ/UQ. - if (stats->options & PS_STAT_ROBUST_QUARTILE) { - countFloat = cumulativeRobustSums->data.F32[robustHistogramVector->n - 1]; - - //XXX: robustHistogram->bounds and cumulativeRobustSums are of different lengths. - //Determine id that is okay. - stats->robustLQ = fitQuadraticSearchForYThenReturnX( - *(psVector* *)&robustHistogram->bounds, - cumulativeRobustSums, - LQBinNum, - countFloat/4.0); - //XXX: robustHistogram->bounds and cumulativeRobustSums are of different lengths. - //Determine id that is okay. - stats->robustUQ = fitQuadraticSearchForYThenReturnX( - *(psVector* *)&robustHistogram->bounds, - cumulativeRobustSums, - UQBinNum, - 3.0 * countFloat/4.0); - } - // XXX: I think sumNfit == sumN50 here. - stats->robustNfit = sumNfit; - stats->robustN50 = sumN50; - - psFree(tmpStats); - psFree(robustHistogram); - psFree(robustHistogramVector); - psFree(cumulativeRobustSums); - return(0); -} - -/*****************************************************************************/ - -/* FUNCTION IMPLEMENTATION - PUBLIC */ - -/*****************************************************************************/ - -static void histogramFree(psHistogram* myHist); - -/****************************************************************************** - psStatsAlloc(): This routine must create a new psStats data structure. - *****************************************************************************/ -psStats* psStatsAlloc(psStatsOptions options) -{ - psStats* newStruct = NULL; - - newStruct = (psStats* ) psAlloc(sizeof(psStats)); - newStruct->sampleMean = NAN; - newStruct->sampleMedian = NAN; - newStruct->sampleStdev = NAN; - newStruct->sampleUQ = NAN; - newStruct->sampleLQ = NAN; - newStruct->robustMean = NAN; - newStruct->robustMedian = NAN; - newStruct->robustMode = NAN; - newStruct->robustStdev = NAN; - newStruct->robustUQ = NAN; - newStruct->robustLQ = NAN; - newStruct->robustN50 = -1; // XXX: This is never used - newStruct->robustNfit = -1; - newStruct->clippedMean = NAN; - newStruct->clippedStdev = NAN; - newStruct->clippedNvalues = -1; // XXX: This is never used - newStruct->clipSigma = 3.0; - newStruct->clipIter = 3; - newStruct->min = NAN; - newStruct->max = NAN; - newStruct->binsize = NAN; // XXX: This is never used - newStruct->options = options; - - return (newStruct); -} - -/****************************************************************************** -psHistogramAlloc(lower, upper, n): allocate a uniform histogram structure -with the specifed upper and lower limits, and the specifed number of bins. -This routine will also set the bounds for each of the bins. - -Input: - lower - upper - n -Returns: - The histogram structure - *****************************************************************************/ -psHistogram* psHistogramAlloc(float lower, float upper, int n) -{ - PS_ASSERT_INT_POSITIVE(n, NULL); - PS_FLOAT_COMPARE(lower, upper, NULL); - - psS32 i = 0; // Loop index variable - psHistogram* newHist = NULL; // The new histogram structure - psF32 binSize = 0.0; // The histogram bin size - - // Allocate memory for the new histogram structure. If there are N - // bins, then there are N+1 bounds to those bins. - newHist = (psHistogram* ) psAlloc(sizeof(psHistogram)); - psMemSetDeallocator(newHist, (psFreeFunc) histogramFree); - newHist->bounds = psVectorAlloc(n + 1, PS_TYPE_F32); - *(int *)&newHist->bounds->n = newHist->bounds->nalloc; - - // Calculate the bounds for each bin. - binSize = (upper - lower) / (psF32)n; - // XXX: Is the following necessary? It prevents the max data point - // from being in a non-existant bin. - binSize += FLT_EPSILON; - for (i = 0; i < n + 1; i++) { - newHist->bounds->data.F32[i] = lower + (binSize * (psF32)i); - } - - // Allocate the bins, and initialize them to zero. - newHist->nums = psVectorAlloc(n, PS_TYPE_F32); - for (i = 0; i < newHist->nums->n; i++) { - newHist->nums->data.F32[i] = 0.0; - } - - // Initialize the other members. - newHist->minNum = 0; - newHist->maxNum = 0; - newHist->uniform = true; - - return (newHist); -} - -/****************************************************************************** -psHistogramAllocGeneric(bounds): allocate a non-uniform histogram structure -with the specifed bounds. - -Input: - bounds -Returns: - The histogram structure - *****************************************************************************/ -psHistogram* psHistogramAllocGeneric(const psVector* bounds) -{ - PS_ASSERT_VECTOR_NON_NULL(bounds, NULL); - PS_ASSERT_VECTOR_TYPE(bounds, PS_TYPE_F32, NULL); - PS_INT_COMPARE(2, bounds->n, NULL); - - psHistogram* newHist = NULL; // The new histogram structure - psS32 i; // Loop index variable - - // Allocate memory for the new histogram structure. - newHist = (psHistogram* ) psAlloc(sizeof(psHistogram)); - psMemSetDeallocator(newHist, (psFreeFunc) histogramFree); - newHist->bounds = psVectorAlloc(bounds->n, PS_TYPE_F32); - *(int *)&newHist->bounds->n = newHist->bounds->nalloc; - for (i = 0; i < bounds->n; i++) { - newHist->bounds->data.F32[i] = bounds->data.F32[i]; - } - - // Allocate the bins, and initialize them to zero. If there are N bounds, - // then there are N-1 bins. - newHist->nums = psVectorAlloc((bounds->n) - 1, PS_TYPE_F32); - for (i = 0; i < newHist->nums->n; i++) { - newHist->nums->data.F32[i] = 0.0; - } - - // Initialize the other members. - newHist->minNum = 0; - newHist->maxNum = 0; - newHist->uniform = false; - - return (newHist); -} - -static void histogramFree(psHistogram* myHist) -{ - psFree(myHist->bounds); - psFree(myHist->nums); -} - -/***************************************************************************** -UpdateHistogramBins(binNum, out, data, error): This routine is to be used when -updating the histogram in the presence of errors in the input data. We treat -the data point as a boxcar PDF and update a range of points surrounding the -histogram bin which contains the point. The width of that boxcar is defined -as 2.35 * error. Inputs: - binNum: the bin number of the data point in the histogram - out: the histogram structure - data: the data point value - error: the error in that data point - -XXX: Must test this. - *****************************************************************************/ -psS32 UpdateHistogramBins(psS32 binNum, - psHistogram* out, - psF32 data, - psF32 error) -{ - PS_ASSERT_PTR_NON_NULL(out, -1); - PS_ASSERT_PTR_NON_NULL(out->bounds, -1); - PS_ASSERT_PTR_NON_NULL(out->nums, -1); - PS_ASSERT_INT_WITHIN_RANGE(binNum, 0, ((out->nums->n)-1), -2); - PS_FLOAT_COMPARE(0.0, error, -3); - PS_ASSERT_FLOAT_WITHIN_RANGE(data, out->bounds->data.F32[0], out->bounds->data.F32[(out->bounds->n)-1], -4); - - psF32 boxcarWidth = 2.35 * error; - psF32 boxcarCenter = (out->bounds->data.F32[binNum] + - out->bounds->data.F32[binNum+1]) / 2.0; - psF32 boxcarLeft = boxcarCenter - (boxcarWidth / 2.0); - psF32 boxcarRight = boxcarCenter + (boxcarWidth / 2.0); - psS32 bin; - psS32 boxcarLeftBinNum = 0; - psS32 boxcarRightBinNum = 0; - - // Determine the left endpoint of the boxcar for the PDF. - for (bin=binNum ; bin >= 0 ; bin--) { - if (out->nums->data.F32[bin] <= boxcarLeft) { - boxcarLeftBinNum = bin; - break; - } - } - - // Determine the right endpoint of the boxcar for the PDF. - for (bin=binNum ; bin < out->nums->n ; bin++) { - if (out->nums->data.F32[bin] >= boxcarRight) { - boxcarRightBinNum = bin; - break; - } - } - - // - // If the boxcar fits entirely inside this bin, then simply add 1.0 to the - // bin and return. - // - if (boxcarLeftBinNum == boxcarRightBinNum) { - out->nums->data.F32[binNum]+= 1.0; - return(0); - } - - // - // If we get here, multiple bins must be updated. We handle the left - // endpoint, and right endpoint differently. - // - out->nums->data.F32[boxcarLeftBinNum]+= - (out->bounds->data.F32[boxcarLeftBinNum+1] - boxcarLeft) / boxcarWidth; - - // - // Loop through the center bins, if any. - // - for (bin = boxcarLeftBinNum + 1 ; bin < (boxcarRightBinNum - 1) ; bin++) { - out->nums->data.F32[bin]+= - (out->bounds->data.F32[bin+1] - out->bounds->data.F32[bin]) / boxcarWidth; - } - - // - // Handle the right endpoint differently. - // - out->nums->data.F32[boxcarRightBinNum]+= - (boxcarRight - out->bounds->data.F32[boxcarRightBinNum]) / boxcarWidth; - - // - // Return 0 on success. - // - return(0); -} - - -/***************************************************************************** -psVectorHistogram(out, in, errors, mask, maskVal): this procedure takes as -input a preallocated and initialized histogram structure. It fills the bins -in that histogram structure in accordance with the input data "in" and the, -possibly NULL, mask vector. - -Inputs: - out - in - mask - maskVal -Returns: - The histogram structure "out". - *****************************************************************************/ -psHistogram* psVectorHistogram(psHistogram* out, - const psVector* values, - const psVector* errors, - const psVector* mask, - psMaskType maskVal) -{ - PS_ASSERT_PTR_NON_NULL(out, NULL); - PS_ASSERT_VECTOR_NON_NULL(out->bounds, NULL); - PS_ASSERT_VECTOR_TYPE(out->bounds, PS_TYPE_F32, NULL); - PS_ASSERT_INT_NONNEGATIVE(out->bounds->n, NULL); - PS_ASSERT_VECTOR_NON_NULL(out->nums, NULL); - PS_ASSERT_VECTOR_TYPE(out->nums, PS_TYPE_F32, NULL); - PS_ASSERT_INT_NONNEGATIVE(out->nums->n, NULL); - PS_ASSERT_VECTOR_NON_NULL(values, out); - if (mask != NULL) { - PS_ASSERT_VECTORS_SIZE_EQUAL(values, mask, NULL); - PS_ASSERT_VECTOR_TYPE(mask, PS_TYPE_U8, NULL); - } - if (errors != NULL) { - PS_ASSERT_VECTORS_SIZE_EQUAL(values, errors, NULL); - PS_ASSERT_VECTOR_TYPE(errors, values->type.type, NULL); - } - - psS32 i = 0; // Loop index variable - psF32 binSize = 0.0; // Histogram bin size - psS32 binNum = 0; // A temporary bin number - psS32 numBins = 0; // The total number of bins - psScalar tmpScalar; - tmpScalar.type.type = PS_TYPE_F32; - psVector* inF32 = NULL; - psVector* errorsF32 = NULL; - psS32 mustFreeVectorIn = 1; - psS32 mustFreeVectorErrors = 1; - - // Convert input and errors vectors to F32 if necessary. - inF32 = p_psConvertToF32((psVector *) values); - if (inF32 == NULL) { - inF32 = (psVector *) values; - mustFreeVectorIn = 0; - } - errorsF32 = p_psConvertToF32((psVector *) errors); - if (errorsF32 == NULL) { - errorsF32 = (psVector *) errors; - mustFreeVectorErrors = 0; - } - - numBins = out->nums->n; - for (i = 0; i < inF32->n; i++) { - // Check if this pixel is masked, and if so, skip it. - if ((mask == NULL) || ((mask != NULL) && (!(mask->data.U8[i] & maskVal)))) { - if (inF32->data.F32[i] < out->bounds->data.F32[0]) { - // If this pixel is below minimum value, count it, then skip. - out->minNum++; - } else if (inF32->data.F32[i] > out->bounds->data.F32[numBins]) { - // If this pixel is above maximum value, count it, then skip. - out->maxNum++; - } else { - // If this is a uniform histogram, determining the correct - // number is trivial. - if (out->uniform == true) { - binSize = out->bounds->data.F32[1] - out->bounds->data.F32[0]; - binNum = (psS32)((inF32->data.F32[i] - out->bounds->data.F32[0]) / binSize); - if (errorsF32 != NULL) { - // XXX: Check return codes. - UpdateHistogramBins(binNum, out, - inF32->data.F32[i], - errorsF32->data.F32[i]); - } else { - // XXX: This if-statement really shouldn't be necessary. - // However, due to numerical lack of precision, we - // occasionally produce a binNum outside the range. - if (binNum >= out->nums->n) { - binNum = out->nums->n - 1; - } - (out->nums->data.F32[binNum])+= 1.0; - } - - } else { - // If this is a non-uniform histogram, determining the - // correct bin number requires a bit more work. - tmpScalar.data.F32 = inF32->data.F32[i]; - binNum = p_psVectorBinDisect( *(psVector* *)&out->bounds, &tmpScalar); - if (binNum < 0) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: psVectorHistogram(): element outside histogram bounds.\n"); - } else { - if (errorsF32 != NULL) { - // XXX: Check return codes. - UpdateHistogramBins(binNum, out, - inF32->data.F32[i], - errors->data.F32[i]); - } else { - (out->nums->data.F32[binNum])+= 1.0; - } - } - } - } - } - } - - if (mustFreeVectorIn == 1) { - psFree(inF32); - } - if (mustFreeVectorErrors == 1) { - psFree(errorsF32); - } - return (out); -} - -/****************************************************************************** -p_psConvertToF32(in): this is the cheap way to support a variety of vector -data types: we simply convert the input vector to F32 at the beginning, and -write all of our functions in F32. If the vast majority of all vector stat -operations are F32 (or any other single type), then this is probably the -best way to go. Otherwise, when the algorithms stablize, we will then macro -everything and put type support in the various stat functions. - -XXX: Should the default data type be F64? Since we are buying Opterons... - *****************************************************************************/ -psVector* p_psConvertToF32(psVector* in) -{ - if (in == NULL) { - return(NULL); - } - psS32 i = 0; - psVector* tmp = NULL; - - if (in->type.type == PS_TYPE_S8) { - tmp = psVectorAlloc(in->n, PS_TYPE_F32); - for (i = 0; i < in->n; i++) { - tmp->data.F32[i] = (psF32)in->data.S8[i]; - } - } else if (in->type.type == PS_TYPE_S16) { - tmp = psVectorAlloc(in->n, PS_TYPE_F32); - for (i = 0; i < in->n; i++) { - tmp->data.F32[i] = (psF32) in->data.S16[i]; - } - } else if (in->type.type == PS_TYPE_S32) { - tmp = psVectorAlloc(in->n, PS_TYPE_F32); - for (i = 0; i < in->n; i++) { - tmp->data.F32[i] = (psF32)in->data.S32[i]; - } - } else if (in->type.type == PS_TYPE_S64) { - tmp = psVectorAlloc(in->n, PS_TYPE_F32); - for (i = 0; i < in->n; i++) { - tmp->data.F32[i] = (psF32)in->data.S64[i]; - } - } else if (in->type.type == PS_TYPE_U8) { - tmp = psVectorAlloc(in->n, PS_TYPE_F32); - for (i = 0; i < in->n; i++) { - tmp->data.F32[i] = (psF32)in->data.U8[i]; - } - } else if (in->type.type == PS_TYPE_U16) { - tmp = psVectorAlloc(in->n, PS_TYPE_F32); - for (i = 0; i < in->n; i++) { - tmp->data.F32[i] = (psF32)in->data.U16[i]; - } - } else if (in->type.type == PS_TYPE_U32) { - tmp = psVectorAlloc(in->n, PS_TYPE_F32); - for (i = 0; i < in->n; i++) { - tmp->data.F32[i] = (psF32)in->data.U32[i]; - } - } else if (in->type.type == PS_TYPE_U64) { - tmp = psVectorAlloc(in->n, PS_TYPE_F32); - for (i = 0; i < in->n; i++) { - tmp->data.F32[i] = (psF32)in->data.U64[i]; - } - } else if (in->type.type == PS_TYPE_F64) { - tmp = psVectorAlloc(in->n, PS_TYPE_F32); - for (i = 0; i < in->n; i++) { - tmp->data.F32[i] = (psF32)in->data.F64[i]; - } - } else if (in->type.type == PS_TYPE_F32) { - // do nothing - } else { - char* strType; - PS_TYPE_NAME(strType, in->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psStats_VECTOR_TYPE_UNSUPPORTED, - strType); - } - return (tmp); -} - -/****************************************************************************** -psVectorStats(myVector, maskVector, maskVal, stats): this is the public API -function which calls the above private stats functions based on what bits -were set in stats->options. - -Inputs - myVector - maskVector - maskVal - stats -Returns - The stats structure. - *****************************************************************************/ -psStats* psVectorStats(psStats* stats, - const psVector* in, - const psVector* errors, - const psVector* mask, - psMaskType maskVal) -{ - PS_ASSERT_PTR_NON_NULL(stats, NULL); - PS_ASSERT_VECTOR_NON_NULL(in, stats); - if (mask != NULL) { - PS_ASSERT_VECTORS_SIZE_EQUAL(mask, in, stats); - PS_ASSERT_VECTOR_TYPE(mask, PS_TYPE_U8, stats); - } - if (errors != NULL) { - PS_ASSERT_VECTORS_SIZE_EQUAL(errors, in, stats); - PS_ASSERT_VECTOR_TYPE(errors, in->type.type, stats); - } - - psVector* inF32 = NULL; - psVector* errorsF32 = NULL; - psS32 mustFreeVectorIn = 1; - psS32 mustFreeVectorErrors = 1; - - inF32 = p_psConvertToF32((psVector *) in); - if (inF32 == NULL) { - inF32 = (psVector *) in; - mustFreeVectorIn = 0; - } - errorsF32 = p_psConvertToF32((psVector *) errors); - if (errorsF32 == NULL) { - errorsF32 = (psVector *) errors; - mustFreeVectorErrors = 0; - } - - if ((stats->options & PS_STAT_USE_RANGE) && (stats->min >= stats->max)) { - PS_FLOAT_COMPARE(stats->min, stats->max, stats); - } - - // ************************************************************************ - if (stats->options & PS_STAT_SAMPLE_MEAN) { - if (0 != p_psVectorSampleMean(inF32, errorsF32, mask, maskVal, stats)) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: psVectorStats(): p_psVectorSampleMean() returned an error.\n"); - } - } - // ************************************************************************ - if (stats->options & PS_STAT_SAMPLE_MEDIAN) { - if (false == p_psVectorSampleMedian(inF32, mask, maskVal, stats)) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: psVectorStats(): p_psVectorSampleMedian() returned an error.\n"); - } - } - // ************************************************************************ - if (stats->options & PS_STAT_SAMPLE_STDEV) { - if (0 != p_psVectorSampleMean(inF32, errorsF32, mask, maskVal, stats)) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: psVectorStats(): p_psVectorSampleMean() returned an error.\n"); - } - p_psVectorSampleStdev(inF32, errorsF32, mask, maskVal, stats); - } - // ************************************************************************ - if (stats->options & PS_STAT_SAMPLE_QUARTILE) { - if (false == p_psVectorSampleQuartiles(inF32, mask, maskVal, stats)) { - psLogMsg(__func__, PS_LOG_WARN, - "WARNING: psVectorStats(): p_psVectorSampleQuartiles() returned an error.\n"); - } - } - // Since the various robust stats quantities share much computation, they - // are grouped together in a single private function: - // p_psVectorRobustStats() - if ((stats->options & PS_STAT_ROBUST_MEAN) || - (stats->options & PS_STAT_ROBUST_MEDIAN) || - (stats->options & PS_STAT_ROBUST_MODE) || - (stats->options & PS_STAT_ROBUST_STDEV) || - (stats->options & PS_STAT_ROBUST_QUARTILE)) { - if (0 != p_psVectorRobustStats(inF32, errorsF32, mask, maskVal, stats)) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psStats_STATS_FAILED); - // XXX: Set to NAN - } - } - - // XXX: Different conditions for return -1 and -2? - if ((stats->options & PS_STAT_CLIPPED_MEAN) || (stats->options & PS_STAT_CLIPPED_STDEV)) { - psS32 rc = p_psVectorClippedStats(inF32, errorsF32, mask, maskVal, stats); - if (-1 == rc) { - psError(PS_ERR_UNKNOWN, false, - "Failed to calculate clipped statistics for input psVector.\n"); - stats->clippedMean = NAN; - stats->clippedStdev = NAN; - } else if (-2 == rc) { - psLogMsg(__func__, PS_LOG_WARN, "Failed to calculate clipped statistics for input psVector."); - stats->clippedMean = NAN; - stats->clippedStdev = NAN; - } - } - // ************************************************************************ - if (stats->options & PS_STAT_MAX) { - if (0 != p_psVectorMax(inF32, mask, maskVal, stats)) { - psError(PS_ERR_UNKNOWN, false, - "Failed to calculate vector maximum"); - stats->max = NAN; - } - } - // ************************************************************************ - if (stats->options & PS_STAT_MIN) { - if (0 != p_psVectorMin(inF32, mask, maskVal, stats)) { - psError(PS_ERR_UNKNOWN, false, - "Failed to calculate vector minimum"); - stats->min = NAN; - } - } - - if (mustFreeVectorIn == 1) { - psFree(inF32); - } - if (mustFreeVectorErrors == 1) { - psFree(errorsF32); - } - return (stats); -} - Index: unk/psLib/src/dataManip/psStats.h =================================================================== --- /trunk/psLib/src/dataManip/psStats.h (revision 4545) +++ (revision ) @@ -1,255 +1,0 @@ -/** @file psStats.h - * \brief basic statistical operations - * @ingroup Stats - * - * This file will hold the definition of the histogram and stats data - * structures. It also contains prototypes for procedures which operate - * on those data structures. - * - * XXX: The following stats members are never used, or set in this code. - * stats->robustN50 - * stats->clippedNvalues - * stats->binsize - * - * @author GLG, MHPCC - * - * @version $Revision: 1.46 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-09 01:24:30 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ -#ifndef PS_STATS_H -#define PS_STATS_H - -#include "psVector.h" - -/// @addtogroup Stats -/// @{ - -/****************************************************************************** - Statistical functions and data structures. - *****************************************************************************/ - -/** enumeration of statistical calculation options - * - * @see psStats, psVectorStats, psImageStats - */ -// XXX: Is PS_STAT_ROBUST_FOR_SAMPLE obsolete? -typedef enum { - PS_STAT_SAMPLE_MEAN = 0x000001, ///< Sample Mean - PS_STAT_SAMPLE_MEDIAN = 0x000002, ///< Sample Median - PS_STAT_SAMPLE_STDEV = 0x000004, ///< Sample Standard Deviation - PS_STAT_SAMPLE_QUARTILE = 0x000008, ///< Sample Quartile - PS_STAT_ROBUST_MEAN = 0x000010, ///< Robust Mean - PS_STAT_ROBUST_MEDIAN = 0x000020, ///< Robust Median - PS_STAT_ROBUST_MODE = 0x000040, ///< Robust Mode - PS_STAT_ROBUST_STDEV = 0x000080, ///< Robust Standarad Deviation - PS_STAT_ROBUST_QUARTILE = 0x000100, ///< Robust Quartile - PS_STAT_CLIPPED_MEAN = 0x000200, ///< Clipped Mean - PS_STAT_CLIPPED_STDEV = 0x000400, ///< Clipped Standard Deviation - PS_STAT_MAX = 0x000800, ///< Maximum - PS_STAT_MIN = 0x001000, ///< Minumum - PS_STAT_USE_RANGE = 0x002000, ///< Range - PS_STAT_USE_BINSIZE = 0x004000, ///< Binsize - // PS_STAT_ROBUST_FOR_SAMPLE = 0x008000 ///< Robust for sample -} psStatsOptions; - -/** This is the generic statistics structure. It contails the data members - for the various statistic values. It also contains the options member to - specifiy which statistics should be calculated. */ -typedef struct -{ - double sampleMean; ///< formal mean of sample - double sampleMedian; ///< formal median of sample - double sampleStdev; ///< standard deviation of sample - double sampleUQ; ///< upper quartile of sample - double sampleLQ; ///< lower quartile of sample - double robustMean; ///< robust mean of array - double robustMedian; ///< robust median of array - double robustMode; ///< Robust mode of array - double robustStdev; ///< robust standard deviation of array - double robustUQ; ///< robust upper quartile - double robustLQ; ///< robust lower quartile - int robustN50; ///< Number of points in Gaussian fit. XXX: This is currently never set. - int robustNfit; ///< The number of points between the quartiles. - double clippedMean; ///< Nsigma clipped mean - double clippedStdev; ///< standard deviation after clipping - int clippedNvalues; ///< Number of data points used for clipped mean: This value is never used. - double clipSigma; ///< Nsigma used for clipping; user input - int clipIter; ///< Number of clipping iterations; user input - double min; ///< minimum data value in array - double max; ///< maximum data value in array - double binsize; ///< binsize for robust fit (input/ouput) - psStatsOptions options; ///< bitmask of calculated values -} -psStats; - -/** Performs statistical calculations on a vector. - * - * @return psStats* the statistical results as specified by stats->options - */ -psStats* psVectorStats( - psStats* stats, ///< stats structure defines stats to be calculated and how - const psVector* in, ///< Vector to be analysed. - const psVector* errors, ///< Errors. - const psVector* mask, ///< Ignore elements where (maskVector & maskVal) != 0: must be INT or NULL - psMaskType maskVal ///< Only mask elements with one of these bits set in maskVector -); - -/** Allocator of the psStats structure. - * - * @return psStats* A new psStats struct with the options member set to the - * value given. - */ -psStats* psStatsAlloc( - psStatsOptions options ///< Statistics to calculate -); - -/****************************************************************************** - Histogram functions and data structures. - *****************************************************************************/ - -/** The basic histogram structure which contains bounds and bins. - * - * In this structure, the vector bounds specifies the boundaries of the - * histogram bins, and must of type psF32, while nums specifies the number - * of entries in the bin, and must of type psU32. The value of bounds.n must - * therefore be 1 greater than than nums.n. The two values minNum and maxNum - * are the number of data values which fell below the lower limit bound or - * above the upper limit bound, respectively. - */ -typedef struct -{ - const psVector* bounds; ///< Bounds for the bins (type F32) - psVector* nums; ///< Number in each of the bins (INT) - int minNum; ///< Number below the minimum - int maxNum; ///< Number above the maximum - bool uniform; ///< Is it a uniform distribution? -} -psHistogram; - -/** Allocator for psHistogram where the bounds of the bins are implicitly - * specified through simply specifying an upper and lower limit along with - * the size of the bins. - * - * @return psHistogram* Newly allocated psHistogram - */ -psHistogram* psHistogramAlloc( - float lower, ///< Lower limit for the bins - float upper, ///< Upper limit for the bins - int n ///< Number of bins -); - -/** Allocator for psHistogram where the bounds of the bins are explicitly - * specified. - * - * @return psHistogram* Newly allocated psHistogram - */ -psHistogram* psHistogramAllocGeneric( - const psVector* bounds ///< Bounds for the bins -); - -/** Calculate a histogram - * - * The following function populates the histogram bins from the specified - * vector (in). It alters and returns the histogram out structure. The input - * vector may be of types psU8, psU16, psF32, psF64. - * - * @return psHistogram* histogram result - */ -psHistogram* psVectorHistogram( - psHistogram* out, ///< Histogram data - const psVector* values, ///< Vector to analyse - const psVector* errors, ///< Errors - const psVector* mask, ///< Mask dat for input vector - psMaskType maskVal ///< Mask value -); - -/** Extracts the statistic value specified by stats->options. - * - * @return psBool If more than one statistic result is set in stats->options, - * false is returned and the value parameter is not set, - * otherwise true is returned. - */ -psBool p_psGetStatValue( - const psStats* stats, ///< the statistic struct to operate on - - psF64 *value ///< if return is true, this is set to the specified statistic value by stats->options -); - -// XXX: Create a single, generic, version of the vector normalize function. -// XXX: Ask IfA for a public psLib function. - -/** Normalize the range of a vector containing U8 values */ -void p_psNormalizeVectorRangeU8( - psVector* myData, ///< Vector containing the U8 values - psU8 low, ///< Minimum value - psU8 high ///< Maximum value -); - -/** Normalize the range of a vector containing U16 values */ -void p_psNormalizeVectorRangeU16( - psVector* myData, ///< Vector containing the U16 values - psU16 low, ///< Minimum value - psU16 high ///< Maximum value -); - -/** Normalize the range of a vector containing U32 values */ -void p_psNormalizeVectorRangeU32( - psVector* myData, ///< Vector containing the U32 values - psU32 low, ///< Minimum value - psU32 high ///< Maximum value -); - -/** Normalize the range of a vector containing U64 values */ -void p_psNormalizeVectorRangeU64( - psVector* myData, ///< Vector containing the U64 values - psU64 low, ///< Minimum value - psU64 high ///< Maximum value -); - -/** Normalize the range of a vector containing S8 values */ -void p_psNormalizeVectorRangeS8( - psVector* myData, ///< Vector containing the S8 values - psS8 low, ///< Minimum value - psS8 high ///< Maximum value -); - -/** Normalize the range of a vector containing S16 values */ -void p_psNormalizeVectorRangeS16( - psVector* myData, ///< Vector containing the S16 values - psS16 low, ///< Minimum value - psS16 high ///< Maximum value -); - -/** Normalize the range of a vector containing S32 values */ -void p_psNormalizeVectorRangeS32( - psVector* myData, ///< Vector containing the S32 values - psS32 low, ///< Minimum value - psS32 high ///< Maximum value -); - -/** Normalize the range of a vector containing S64 values */ -void p_psNormalizeVectorRangeS64( - psVector* myData, ///< Vector containing the S64 values - psS64 low, ///< Minimum value - psS64 high ///< Maximum value -); - -/** Normalize the range of a vector containing F32 values */ -void p_psNormalizeVectorRangeF32( - psVector* myData, ///< Vector containing the F32 values - psF32 low, ///< Minimum value - psF32 high ///< Maximum value -); - -/** Normalize the range of a vector containing F64 values */ -void p_psNormalizeVectorRangeF64( - psVector* myData, ///< Vector containing the F64 values - psF64 low, ///< Minimum value - psF64 high ///< Maximum value -); - -/// @} - -#endif // #ifndef PS_STATS_H Index: unk/psLib/src/dataManip/psUnaryOp.c =================================================================== --- /trunk/psLib/src/dataManip/psUnaryOp.c (revision 4545) +++ (revision ) @@ -1,388 +1,0 @@ -/** @file psUnary.c - * - * @brief Provides unary functions for simple matrix and vector element operations. Functions - * include: - * - * Addition (+) - * Subtraction (-) - * Multiplication (*) - * Division (/) - * Power (^) - * Minimum (min) - * Maximum (max) - * Absolute value (abs) - * Exponent (exp) - * Natural Log (ln) - * Power of 10 (ten) - * Log (log) - * Sine (sin or dsin) - * Cosine (cos or dcos) - * Tangent (tan or dtan) - * Arcsine (asin or dasin) - * Arccosine (acos or dacos) - * Arctan (atan or datan) - * - * Currently only vector-vector and image-image binary operations are supported. - * - * @ingroup MatrixArithmetic - * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -/****************************************************************************** - * INCLUDE FILES * - ******************************************************************************/ -#include -#include -#include -#include - -#include "psMemory.h" -#include "psError.h" -#include "psImage.h" -#include "psVector.h" -#include "psScalar.h" -#include "psLogMsg.h" -#include "psConstants.h" -#include "psDataManipErrors.h" - -/***************************************************************************** - * FUNCTION IMPLEMENTATION - LOCAL * - *****************************************************************************/ - -// Conversion for degrees to radians -#define D2R 0.01745329252111111 /* PI/180 */ - -// Conversion for radians to degrees -#define R2D 57.29577950924861 /* 180.0/PI */ - - -// Unary SCALAR operations -#define SCALAR(OUT,IN,OP,TYPE) \ -{ \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - o = &((psScalar* )OUT)->data.TYPE; \ - i1 = &((psScalar* )IN)->data.TYPE; \ - *o = OP; \ -} - -// Unary IMAGE operations -#define VECTOR(OUT,IN,OP,TYPE) \ -{ \ - psS32 i = 0; \ - psS32 nIn = 0; \ - psS32 nOut = 0; \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - nIn = ((psVector* )IN)->n; \ - nOut = ((psVector* )OUT)->n; \ - if(nIn != nOut) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - PS_ERRORTEXT_psMatrix_COUNT_DIFFERS, \ - nIn, nOut); \ - if (OUT != IN) { \ - psFree(OUT); \ - } \ - return NULL; \ - } \ - o = ((psVector* )OUT)->data.TYPE; \ - i1 = ((psVector* )IN)->data.TYPE; \ - for(i = 0; i < nIn; i++, o++, i1++) { \ - *o = OP; \ - } \ -} - -// Unary IMAGE operations -#define IMAGE(OUT,IN,OP,TYPE) \ -{ \ - psS32 i = 0; \ - psS32 j = 0; \ - psS32 numRowsIn = 0; \ - psS32 numColsIn = 0; \ - psS32 numRowsOut = 0; \ - psS32 numColsOut = 0; \ - ps##TYPE *o = NULL; \ - ps##TYPE *i1 = NULL; \ - numRowsIn = ((psImage* )IN)->numRows; \ - numColsIn = ((psImage* )IN)->numCols; \ - numRowsOut = ((psImage* )OUT)->numRows; \ - numColsOut = ((psImage* )OUT)->numCols; \ - if(numRowsIn!=numRowsOut || numColsIn!=numColsOut) { \ - psError(PS_ERR_BAD_PARAMETER_SIZE, true, \ - PS_ERRORTEXT_psMatrix_IMAGE_SIZE_DIFFERS, \ - numColsIn, numRowsIn, numColsOut, numRowsOut); \ - if (OUT != IN) { \ - psFree(OUT); \ - } \ - return NULL; \ - } \ - for(j = 0; j < numRowsIn; j++) { \ - o = ((psImage* )OUT)->data.TYPE[j]; \ - i1 = ((psImage* )IN)->data.TYPE[j]; \ - for(i = 0; i < numColsIn; i++, o++, i1++) { \ - *o = OP; \ - } \ - } \ -} - -// Preprocessor macro function to create arithmetic function based on input type -#define UNARY_TYPE(DIM,OUT,IN,OP) \ -switch (IN->type) { \ -case PS_TYPE_S32: \ - DIM(OUT,IN,OP,S32); \ - break; \ -case PS_TYPE_F32: \ - DIM(OUT,IN,OP,F32); \ - break; \ -case PS_TYPE_F64: \ - DIM(OUT,IN,OP,F64); \ - break; \ -case PS_TYPE_C32: \ - DIM(OUT,IN,OP,C32); \ - break; \ -case PS_TYPE_S8: \ - DIM(OUT,IN,OP,C32); \ - break; \ -case PS_TYPE_U8: \ - DIM(OUT,IN,OP,C32); \ - break; \ -case PS_TYPE_S16: \ - DIM(OUT,IN,OP,C32); \ - break; \ -case PS_TYPE_U16: \ - DIM(OUT,IN,OP,C32); \ - break; \ -case PS_TYPE_U32: \ - DIM(OUT,IN,OP,C32); \ - break; \ -case PS_TYPE_S64: \ - DIM(OUT,IN,OP,C32); \ - break; \ -case PS_TYPE_U64: \ - DIM(OUT,IN,OP,C32); \ - break; \ -case PS_TYPE_C64: \ - DIM(OUT,IN,OP,C32); \ - break; \ -default: { \ - char* strType; \ - PS_TYPE_NAME(strType, IN->type); \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - PS_ERRORTEXT_psMatrix_TYPE_MISMATCH, \ - strType); \ - if (OUT != IN) { \ - psFree(OUT); \ - } \ - return NULL; \ - } \ -} - -// Preprocessor macro function to create arithmetic function operation name. Functions below that add -// FLT_EPSILON are done so to align results with a 64 bit computing architecture -#define UNARY_OP(DIM,OUT,IN,OP) \ -if(!strncmp(OP, "abs", 3)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,cabs(*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,fabs(*i1)); \ - } \ -} else if(!strncmp(OP, "exp", 3)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,cexp(*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,exp(*i1)); \ - } \ -} else if(!strncmp(OP, "ln", 2)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,clog(*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,log(*i1)); \ - } \ -} else if(!strncmp(OP, "ten", 3)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,cpow(10.0,*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,pow(10.0,*i1)); \ - } \ -} else if(!strncmp(OP, "log", 3)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,clog(*i1)/log(10.0)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,log10(*i1)); \ - } \ -} else if(!strncmp(OP, "sin", 3)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,csin(*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,sin(*i1)); \ - } \ -} else if(!strncmp(OP, "dsin", 4)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,csin(*i1*D2R)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,sin(*i1*D2R)); \ - } \ -} else if(!strncmp(OP, "cos", 3)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,ccos(*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,cos(*i1)); \ - } \ -} else if(!strncmp(OP, "dcos", 4)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,ccos(*i1*D2R)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,cos(*i1*D2R)); \ - } \ -} else if(!strncmp(OP, "tan", 3)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,ctan(*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,tan(*i1)); \ - } \ -} else if(!strncmp(OP, "dtan", 4)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,ctan(*i1*D2R)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,tan(*i1*D2R)); \ - } \ -} else if(!strncmp(OP, "asin", 4)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,casin(*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,asin(*i1)); \ - } \ -} else if(!strncmp(OP, "dasin", 5)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,R2D*casin(*i1)); \ - } else if(PS_IS_PSELEMTYPE_INT(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,(R2D*asin(*i1))); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,(R2D*asin(*i1))); \ - } \ -} else if(!strncmp(OP, "acos", 4)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,cacos(*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,acos(*i1)); \ - } \ -} else if(!strncmp(OP, "dacos", 5)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,R2D*cacos(*i1)); \ - } else if(PS_IS_PSELEMTYPE_INT(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,(R2D*acos(*i1))); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,R2D*acos(*i1)); \ - } \ -} else if(!strncmp(OP, "atan", 4)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,catan(*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,atan(*i1)); \ - } \ -} else if(!strncmp(OP, "datan", 5)) { \ - if(PS_IS_PSELEMTYPE_COMPLEX(IN->type)) { \ - UNARY_TYPE(DIM,OUT,IN,R2D*catan(*i1)); \ - } else { \ - UNARY_TYPE(DIM,OUT,IN,R2D*atan(*i1)); \ - } \ -} else { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - PS_ERRORTEXT_psMatrix_OPERATION_UNSUPPORTED, \ - OP); \ - if (OUT != IN) { \ - psFree(OUT); \ - } \ - return NULL; \ -} - -psMathType* psUnaryOp(psPtr out, const psPtr in, const char *op) -{ - #define psUnaryOp_EXIT { \ - if (out != in) { \ - psFree(out); \ - } \ - return NULL; \ - } - - psType* psTypeIn = (psType* ) in; - - PS_ASSERT_GENERAL_PTR_NON_NULL(in, psUnaryOp_EXIT); - PS_ASSERT_GENERAL_PTR_NON_NULL(op, psUnaryOp_EXIT); - - psDimen dimIn = psTypeIn->dimen; - psElemType elTypeIn = psTypeIn->type; - - switch (dimIn) { - case PS_DIMEN_SCALAR: - if (out == NULL || - ((psType*)out)->dimen != PS_DIMEN_SCALAR || - ((psScalar*)out)->type.type != elTypeIn) { - psFree(out); - out = psScalarAlloc(0.0,elTypeIn); - } - UNARY_OP(SCALAR, out, psTypeIn, op); // scalar - break; - case PS_DIMEN_VECTOR: - case PS_DIMEN_TRANSV: - if (((psVector*)in)->n == 0) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psMatrix_VECTOR_EMPTY); - psUnaryOp_EXIT; - } - - out = psVectorRecycle(out, - ((psVector*)in)->n, - elTypeIn); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psMatrix_OUTPUT_VECTOR_NOT_CREATED); - psUnaryOp_EXIT; - } - - UNARY_OP(VECTOR, out, psTypeIn, op); // vector - break; - case PS_DIMEN_IMAGE: - if (((psImage* ) in)->numCols == 0 || ((psImage* ) in)->numRows == 0) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psMatrix_IMAGE_EMPTY); - psUnaryOp_EXIT; - } - - out = psImageRecycle(out, - ((psImage*)in)->numCols, - ((psImage*)in)->numRows, - elTypeIn); - if (out == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psMatrix_OUTPUT_IMAGE_NOT_CREATED); - psUnaryOp_EXIT; - } - - UNARY_OP(IMAGE, out, psTypeIn, op); // image - break; - default: - if (out != in) { - psFree(out); - } - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psMatrix_DIMEN_INVALID, - "in", dimIn); - psUnaryOp_EXIT; - } - - // Automtically free psScalar types, since they are usually allocated in the argument list when this - // function is called, provided that the input is not the output. - if(psTypeIn->dimen==PS_DIMEN_SCALAR && in!=out) { - psFree(in); - } - - return out; -} Index: unk/psLib/src/dataManip/psUnaryOp.h =================================================================== --- /trunk/psLib/src/dataManip/psUnaryOp.h (revision 4545) +++ (revision ) @@ -1,69 +1,0 @@ -/** @file psUnaryOp.h - * - * @brief Provides unary functions for simple matrix and vector element operations. Functions - * include: - * - * Addition (+) - * Subtraction (-) - * Multiplication (*) - * Division (/) - * Power (^) - * Minimum (min) - * Maximum (max) - * Absolute value (abs) - * Exponent (exp) - * Natural Log (ln) - * Power of 10 (ten) - * Log (log) - * Sine (sin or dsin) - * Cosine (cos or dcos) - * Tangent (tan or dtan) - * Arcsine (asin or dasin) - * Arccosine (acos or dacos) - * Arctan (atan or datan) - * - * Currently only vector-vector and image-image binary operations are supported. - * - * @ingroup MatrixArithmetic - * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PSUNARY_OP_H -#define PSUNARY_OP_H - -/// @addtogroup MatrixArithmetic -/// @{ - - -/** Perform simple unary arithmetic with images or vectors - * - * Performs absolute value, exponent, natural log, power of 10, log, sine, cosine, tangent, arcsine, - * arccosine, or arctan. operations with images and vectors. Uses the form: - * - * out = op(in), - * - * Where op is: "abs", "exp", "ln", "ten", "log", "sin", "cos", "tan" "asin", "acos", "atan", "dsin", - * "dcos", dtan", "dasin", "dacos", or "datan". - * - * Trigometric Operations with "d" prefix use units of degrees. Those without are in radians. - * - * This function only supports vector-vector or image-image opertions. - * - * @return psType* : Pointer to either psImage or psVector. - */ -psMathType* psUnaryOp( - psPtr out, ///< Output type, either psImage or psVector. - const psPtr in, ///< Input, either psImage or psVector. - const char *op ///< Operator. -); - -/// @} - -#endif // #ifndef PSUNARY_OP_H Index: unk/psLib/src/dataManip/psVectorFFT.c =================================================================== --- /trunk/psLib/src/dataManip/psVectorFFT.c (revision 4545) +++ (revision ) @@ -1,417 +1,0 @@ -/** @file psVectorFFT.c - * - * @brief Contains FFT transform related functions for psVector - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.32 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-05-19 02:09:39 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include -#include -#include -#include - -#include "psVectorFFT.h" -#include "psError.h" -#include "psMemory.h" -#include "psLogMsg.h" - -#include "psDataManipErrors.h" - -#define P_FFTW_PLAN_RIGOR FFTW_ESTIMATE - -static psBool p_fftwWisdomImported = false; - -psVector* psVectorFFT(psVector* out, const psVector* in, psFFTFlags direction) -{ - psU32 numElements; - psElemType type; - fftwf_plan plan; - - /* got good image data? */ - if (in == NULL) { - psFree(out); - return NULL; - } - - type = in->type.type; - - /* make sure the system-level wisdom information is imported. */ - if (!p_fftwWisdomImported) { - fftwf_import_system_wisdom(); - p_fftwWisdomImported = true; - } - - numElements = in->n; - - out = psVectorCopy(out, in, PS_TYPE_C32); - out->n = numElements; - - if ((direction & PS_FFT_FORWARD) != 0) { - plan = fftwf_plan_dft_1d(numElements, - (fftwf_complex *) out->data.C32, - (fftwf_complex *) out->data.C32, FFTW_FORWARD, P_FFTW_PLAN_RIGOR); - } else if ((direction & PS_FFT_REVERSE) != 0) { - plan = fftwf_plan_dft_1d(numElements, - (fftwf_complex *) out->data.C32, - (fftwf_complex *) out->data.C32, FFTW_BACKWARD, P_FFTW_PLAN_RIGOR); - } else { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psVectorFFT_DIRECTION_NOTSET); - psFree(out); - return NULL; - } - - /* check if a plan exists now */ - if (plan == NULL) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVectorFFT_FFTW_PLAN_NULL); - psFree(out); - return NULL; - } - - /* finally, call FFTW with the plan made above */ - fftwf_execute(plan); - - fftwf_destroy_plan(plan); - - if ((direction & PS_FFT_REAL_RESULT) != 0) { - for (psS32 i = 0; i < numElements; i++) { - out->data.F32[i] = out->data.C32[i]; - } - out->type.type = PS_TYPE_F32; - out->data.U8 = psRealloc(out->data.U8,PSELEMTYPE_SIZEOF(PS_TYPE_F32)*out->nalloc); - } - - return out; -} - -psVector* psVectorReal(psVector* out, const psVector* in) -{ - psElemType type; - psU32 numElements; - - if (in == NULL) { - psFree(out); - return NULL; - } - - type = in->type.type; - numElements = in->n; - - /* if not a complex number, this is logically just a copy */ - if (!PS_IS_PSELEMTYPE_COMPLEX(type)) { - // Warn user, as this is probably not expected - psLogMsg(__func__, PS_LOG_WARN, "Real portion of a non-Complex type called called for. " - "Just a vector copy was performed."); - out = psVectorRecycle(out, numElements, type); - out->n = numElements; - memcpy(out->data.U8, in->data.U8, numElements * PSELEMTYPE_SIZEOF(type)); - return out; - } - - if (type == PS_TYPE_C32) { - psF32* outVec; - psC32* inVec = in->data.C32; - - out = psVectorRecycle(out, numElements, PS_TYPE_F32); - out->n = numElements; - outVec = out->data.F32; - - for (psU32 i = 0; i < numElements; i++) { - outVec[i] = crealf(inVec[i]); - } - } else if (type == PS_TYPE_C64) { - psF64* outVec; - psC64* inVec = in->data.C64; - - out = psVectorRecycle(out, numElements, PS_TYPE_F64); - out->n = numElements; - outVec = out->data.F64; - - for (psU32 i = 0; i < numElements; i++) { - outVec[i] = creal(inVec[i]); - } - } else { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVectorFFT_TYPE_UNSUPPORTED, - typeStr); - psFree(out); - return NULL; - } - - return out; -} - -psVector* psVectorImaginary(psVector* out, const psVector* in) -{ - psElemType type; - psU32 numElements; - - if (in == NULL) { - psFree(out); - return NULL; - } - - type = in->type.type; - numElements = in->n; - - /* if not a complex number, this is logically just zeroed image of same size */ - if (!PS_IS_PSELEMTYPE_COMPLEX(type)) { - // Warn user, as this is probably not expected - psLogMsg(__func__, PS_LOG_WARN, "Imaginary portion of a non-Complex type called for. " - "A zeroed vector was returned."); - out = psVectorRecycle(out, numElements, type); - out->n = numElements; - memset(out->data.U8, 0, PSELEMTYPE_SIZEOF(type) * numElements); - return out; - } - - if (type == PS_TYPE_C32) { - psF32* outVec; - psC32* inVec = in->data.C32; - - out = psVectorRecycle(out, numElements, PS_TYPE_F32); - out->n = numElements; - outVec = out->data.F32; - - for (psU32 i = 0; i < numElements; i++) { - outVec[i] = cimagf(inVec[i]); - } - } else if (type == PS_TYPE_C64) { - psF64* outVec; - psC64* inVec = in->data.C64; - - out = psVectorRecycle(out, numElements, PS_TYPE_F64); - out->n = numElements; - outVec = out->data.F64; - - for (psU32 i = 0; i < numElements; i++) { - outVec[i] = cimag(inVec[i]); - } - } else { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVectorFFT_TYPE_UNSUPPORTED, - typeStr); - psFree(out); - return NULL; - } - - return out; -} - -psVector* psVectorComplex(psVector* out, const psVector* real, const psVector* imag) -{ - psElemType type; - psU32 numElements; - - if (real == NULL || imag == NULL) { - psFree(out); - return NULL; - } - - type = real->type.type; - if (real->n < imag->n) { - numElements = real->n; - } else { - numElements = imag->n; - } - - if (imag->type.type != type) { - char* typeStrReal; - char* typeStrImag; - PS_TYPE_NAME(typeStrReal,type); - PS_TYPE_NAME(typeStrImag,imag->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVectorFFT_REAL_IMAG_TYPE_MISMATCH, - typeStrReal,typeStrImag); - psFree(out); - return NULL; - } - - if (type == PS_TYPE_F32) { - psC32* outVec; - psF32* realVec = real->data.F32; - psF32* imagVec = imag->data.F32; - - out = psVectorRecycle(out, numElements, PS_TYPE_C32); - out->n = numElements; - outVec = out->data.C32; - - for (psU32 i = 0; i < numElements; i++) { - outVec[i] = realVec[i] + I * imagVec[i]; - } - } else if (type == PS_TYPE_F64) { - psC64* outVec; - psF64* realVec = real->data.F64; - psF64* imagVec = imag->data.F64; - - out = psVectorRecycle(out, numElements, PS_TYPE_C64); - out->n = numElements; - outVec = out->data.C64; - - for (psU32 i = 0; i < numElements; i++) { - outVec[i] = realVec[i] + I * imagVec[i]; - } - } else { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVectorFFT_NONREAL_NOTSUPPORTED, - typeStr); - psFree(out); - return NULL; - } - - return out; -} - -psVector* psVectorConjugate(psVector* out, const psVector* in) -{ - psElemType type; - psU32 numElements; - - if (in == NULL) { - psFree(out); - return NULL; - } - - type = in->type.type; - numElements = in->n; - - /* if not a complex number, this is logically just a image copy */ - if (!PS_IS_PSELEMTYPE_COMPLEX(type)) { - // Warn user, as this is probably not expected - psLogMsg(__func__, PS_LOG_WARN, "Complex Conjugate of a non-Complex type called for. " - "Vector copy was performed instead."); - - out = psVectorRecycle(out, numElements, type); - out->n = numElements; - memcpy(out->data.U8, in->data.U8, PSELEMTYPE_SIZEOF(type) * numElements); - return out; - } - - if (type == PS_TYPE_C32) { - psC32* outVec; - psC32* inVec = in->data.C32; - - out = psVectorRecycle(out, numElements, PS_TYPE_C32); - out->n = numElements; - outVec = out->data.C32; - - for (psU32 i = 0; i < numElements; i++) { - outVec[i] = crealf(inVec[i]) - I * cimagf(inVec[i]); - } - } else if (type == PS_TYPE_C64) { - psC64* outVec; - psC64* inVec = in->data.C64; - - out = psVectorRecycle(out, numElements, PS_TYPE_C64); - out->n = numElements; - outVec = out->data.C64; - - for (psU32 i = 0; i < numElements; i++) { - outVec[i] = creal(inVec[i]) - I * cimag(inVec[i]); - } - } else { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVectorFFT_NONCOMPLEX_NOTSUPPORTED, - typeStr); - psFree(out); - return NULL; - } - - return out; -} - -psVector* psVectorPowerSpectrum(psVector* out, const psVector* in) -{ - psElemType type; - psU32 outNumElements; - psU32 inNumElements; - psU32 inHalfNumElements; - psU32 inNumElementsSquared; - - if (in == NULL) { - psFree(out); - return NULL; - } - - type = in->type.type; - inNumElements = in->n; - inNumElementsSquared = inNumElements * inNumElements; - inHalfNumElements = inNumElements / 2; - outNumElements = inHalfNumElements + 1; - - if (type == PS_TYPE_C32) { - psF32* outVec; - psC32* inVec = in->data.C32; - psF32 inAbs1; - psF32 inAbs2; - - out = psVectorRecycle(out, outNumElements, PS_TYPE_F32); - out->n = outNumElements; - outVec = out->data.F32; - - // from ADD: P_0 = |C_0|^2/N^2 - inAbs1 = cabsf(inVec[0]); - outVec[0] = inAbs1 * inAbs1 / inNumElementsSquared; - - // from ADD: P_j = (|C_j|^2+|C_N-j|^2)/N^2, where j = 1,2,...,(N/2-1) - for (psU32 i = 1; i < inHalfNumElements; i++) { - inAbs1 = cabsf(inVec[i]); - inAbs2 = cabsf(inVec[inNumElements - i]); - outVec[i] = (inAbs1 * inAbs1 + inAbs2 * inAbs2) / inNumElementsSquared; - } - - // from ADD: P_N/2 = |C_N/2|^2/N^2 - inAbs1 = cabsf(inVec[inHalfNumElements]); - outVec[inHalfNumElements] = inAbs1 * inAbs1 / inNumElementsSquared; - } else if (type == PS_TYPE_C64) { - psF64* outVec; - psC64* inVec = in->data.C64; - psF64 inAbs1; - psF64 inAbs2; - - out = psVectorRecycle(out, outNumElements, PS_TYPE_F64); - out->n = outNumElements; - outVec = out->data.F64; - - // from ADD: P_0 = |C_0|^2/N^2 - inAbs1 = cabs(inVec[0]); - outVec[0] = inAbs1 * inAbs1 / inNumElementsSquared; - - // from ADD: P_j = (|C_j|^2+|C_N-j|^2)/N^2, where j = 1,2,...,(N/2-1) - for (psU32 i = 1; i < inHalfNumElements; i++) { - inAbs1 = cabs(inVec[i]); - inAbs2 = cabs(inVec[inNumElements - i]); - outVec[i] = (inAbs1 * inAbs1 + inAbs2 * inAbs2) / inNumElementsSquared; - } - - // from ADD: P_N/2 = |C_N/2|^2/N^2 - inAbs1 = cabs(inVec[inHalfNumElements]); - outVec[inHalfNumElements] = inAbs1 * inAbs1 / inNumElementsSquared; - } else { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psVectorFFT_NONCOMPLEX_NOTSUPPORTED, - typeStr); - psFree(out); - return NULL; - } - - return out; - -} Index: unk/psLib/src/dataManip/psVectorFFT.h =================================================================== --- /trunk/psLib/src/dataManip/psVectorFFT.h (revision 4545) +++ (revision ) @@ -1,99 +1,0 @@ -/** @file psVectorFFT.h - * - * @brief Contains FFT transform related functions for psVector - * - * @ingroup Transform - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.18 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_VECTOR_FFT_H -#define PS_VECTOR_FFT_H - -#include "psVector.h" - -/// @addtogroup Transform -/// @{ - -/** Specify direction of FFT */ -typedef enum { - /// psImageFFT/psVectorFFT should perform a forward FFT. - PS_FFT_FORWARD = 1, - - /// psImageFFT/psVectorFFT should perform a reverse FFT. - PS_FFT_REVERSE = 2, - - /// psImageFFT/psVectorFFT should perform a reverse FFT with a real result. - PS_FFT_REAL_RESULT = 4 -} psFFTFlags; - - -/** Forward and reverse FFT calculations. - * - * This takes as input the vector of interest (in) and the direction - * (direction), which is specified by an enumerated type psFftDirection. - * The input vector may be of type psF32 or psC32, the result is always - * psC32. If the input vector is psF32, the direction must be forward. - * - * @return psVector* the FFT transformation result - */ -psVector* psVectorFFT( - psVector* out, ///< a psVector to recycle. If NULL, a new psVector is made. - const psVector* in, ///< the vector to apply transform to - psFFTFlags direction ///< the direction of the transform -); - -/** extract the real portion of a complex vector - * - * @return psVector* real portion of the input vector. - */ -psVector* psVectorReal( - psVector* out, ///< a psVector to recycle. If NULL, a new psVector is made. - const psVector* in ///< the psVector to extract real portion from -); - -/** extract the imaginary portion of a complex vector - * - * @return psVector* imaginary portion of the input vector. - */ -psVector* psVectorImaginary( - psVector* out, ///< a psVector to recycle. If NULL, a new psVector is made. - const psVector* in ///< the psVector to extract imaginary portion from -); - -/** creates a complex vector from separate real and imaginary vectors - * - * @return psVector* resulting complex vector - */ -psVector* psVectorComplex( - psVector* out, ///< a psVector to recycle. If NULL, a new psVector is made. - const psVector* real, ///< the real vector - const psVector* imag ///< the imaginary vector -); - -/** computes the complex conjugate of a vector - * - * @return psVector* the complex conjugate of the 'in' vector - */ -psVector* psVectorConjugate( - psVector* out, ///< a psVector to recycle. If NULL, a new psVector is made. - const psVector* in ///< the psVector to compute conjugate of -); - -/** computes the power spectrum of a vector - * - * @return psVector* the power spectrum of the 'in' vector - */ -psVector* psVectorPowerSpectrum( - psVector* out, ///< a psVector to recycle. If NULL, a new psVector is made. - const psVector* in ///< the psVector to power spectrum of -); - -/// @} - -#endif // #ifndef PS_VECTOR_FFT_H Index: unk/psLib/src/image/.cvsignore =================================================================== --- /trunk/psLib/src/image/.cvsignore (revision 4545) +++ (revision ) @@ -1,7 +1,0 @@ -Makefile.in -.deps -.libs -Makefile -*.lo -*.la - Index: unk/psLib/src/image/Makefile.am =================================================================== --- /trunk/psLib/src/image/Makefile.am (revision 4545) +++ (revision ) @@ -1,38 +1,0 @@ -#Makefile for image functions of psLib -# -INCLUDES = \ - -I$(top_srcdir)/src/astronomy \ - -I$(top_srcdir)/src/collections \ - -I$(top_srcdir)/src/dataManip \ - -I$(top_srcdir)/src/dataIO \ - -I$(top_srcdir)/src/sysUtils \ - $(all_includes) - -noinst_LTLIBRARIES = libpslibimage.la - -libpslibimage_la_SOURCES = \ - psImage.c \ - psImagePixelExtract.c \ - psImageStructManip.c \ - psImageGeomManip.c \ - psImagePixelManip.c \ - psImageStats.c \ - psImageFFT.c \ - psImageConvolve.c - -BUILT_SOURCES = psImageErrors.h -EXTRA_DIST = psImageErrors.dat psImageErrors.h image.i - -psImageErrors.h: psImageErrors.dat - $(top_srcdir)/src/psParseErrorCodes --data=$? $@ - -pslibincludedir = $(includedir) -pslibinclude_HEADERS = \ - psImage.h \ - psImagePixelExtract.h \ - psImageStructManip.h \ - psImageGeomManip.h \ - psImagePixelManip.h \ - psImageStats.h \ - psImageFFT.h \ - psImageConvolve.h Index: unk/psLib/src/image/image.i =================================================================== --- /trunk/psLib/src/image/image.i (revision 4545) +++ (revision ) @@ -1,11 +1,0 @@ -/* image headers */ -%include "psImageConvolve.h" -%include "psImageErrors.h" -%include "psImageStructManip.h" -%include "psImagePixelExtract.h" -%include "psImageFFT.h" -%include "psImage.h" -%include "psImageGeomManip.h" -%include "psImagePixelManip.h" -%include "psImageStats.h" - Index: unk/psLib/src/image/psImage.c =================================================================== --- /trunk/psLib/src/image/psImage.c (revision 4545) +++ (revision ) @@ -1,656 +1,0 @@ -/** @file psImage.c - * - * @brief Contains basic image definitions and operations. - * - * This file defines the basic type for an image struct and functions useful - * in manupulating images. - * - * @author Robert DeSonia, MHPCC - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.75 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - * - * That is the routine used to generate matrices. - */ - -#include -#include - -#include "psMemory.h" -#include "psError.h" -#include "psImage.h" -#include "psString.h" - -#include "psImageErrors.h" - -#define SQUARE(x) ((x)*(x)) -#define MIN(x,y) (((x) > (y)) ? (y) : (x)) -#define MAX(x,y) (((x) > (y)) ? (x) : (y)) - -static void imageFree(psImage* image) -{ - if (image == NULL) { - return; - } - - if (image->parent != NULL) { - psArrayRemove(image->parent->children,image); - image->parent = NULL; - } - - psImageFreeChildren(image); - - psFree(image->rawDataBuffer); - psFree(image->data.V); -} - -psImage* psImageAlloc(int numCols, - int numRows, - psElemType type) -{ - psS32 area = 0; - psS32 elementSize = PSELEMTYPE_SIZEOF(type); // element size in bytes - psS32 rowSize = numCols * elementSize; // row size in bytes. - - area = numCols * numRows; - - if (area < 1) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_AREA_NEGATIVE, - numRows, numCols); - return NULL; - } - - psImage* image = (psImage* ) psAlloc(sizeof(psImage)); - - psMemSetDeallocator(image, (psFreeFunc) imageFree); - - image->data.V = psAlloc(sizeof(psPtr ) * numRows); - - image->rawDataBuffer = psAlloc(area * elementSize); - - // set the row pointers. - image->data.V[0] = image->rawDataBuffer; - for (psS32 i = 1; i < numRows; i++) { - image->data.V[i] = (psPtr )((int8_t *) image->data.V[i - 1] + rowSize); - } - - *(psS32 *)&image->col0 = 0; - *(psS32 *)&image->row0 = 0; - *(psU32 *)&image->numCols = numCols; - *(psU32 *)&image->numRows = numRows; - *(psDimen* ) & image->type.dimen = PS_DIMEN_IMAGE; - *(psElemType* ) & image->type.type = type; - image->parent = NULL; - image->children = NULL; - - return image; -} - -psRegion psRegionSet(float x0, - float x1, - float y0, - float y1) -{ - psRegion out; - - out.x0 = x0; - out.y0 = y0; - out.x1 = x1; - out.y1 = y1; - - return out; -} - -psRegion psRegionFromString(const char* region) -{ - psS32 col0; - psS32 col1; - psS32 row0; - psS32 row1; - - // section should be of the form '[col0:col1,row0:row1]' - if (region == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_SUBSECTION_NULL); - return psRegionSet(NAN,NAN,NAN,NAN); - } - - if (sscanf(region,"[%d:%d,%d:%d]",&col0,&col1,&row0,&row1) < 4) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_SUBSECTION_INVALID, - region); - return psRegionSet(NAN,NAN,NAN,NAN); - } - - if (col0 > col1 || row0 > row1) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_SUBSET_RANGE_MALFORMED, - col0,col1,row0,row1); - return psRegionSet(NAN,NAN,NAN,NAN); - } - - return psRegionSet(col0,col1,row0,row1); -} - -psString psRegionToString(const psRegion region) -{ - char tmpText[256]; // big enough to store any region as text - - snprintf(tmpText,256,"[%g:%g,%g:%g]", - region.x0, region.x1, - region.y0, region.y1); - - return psStringCopy(tmpText); -} - -psImage* psImageRecycle(psImage* old, - int numCols, - int numRows, - const psElemType type) -{ - psS32 elementSize = PSELEMTYPE_SIZEOF(type); // element size in bytes - psS32 rowSize = numCols * elementSize; // row size in bytes. - - if (old == NULL) { - old = psImageAlloc(numCols, numRows, type); - return old; - } - - if (old->type.dimen != PS_DIMEN_IMAGE) { - psFree(old); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_NOT_AN_IMAGE); - return NULL; - } - - /* image already the right size/type? */ - if (numCols == old->numCols && numRows == old->numRows && - type == old->type.type) { - return old; - } - // Resize the image buffer - old->rawDataBuffer = psRealloc(old->data.V[0], - numCols * numRows * elementSize); - old->data.V = (psPtr *)psRealloc(old->data.V, numRows * sizeof(psPtr )); - - // recreate the row pointers - old->data.V[0] = old->rawDataBuffer; - for (psS32 i = 1; i < numRows; i++) { - old->data.V[i] = (psPtr )((int8_t *) old->data.V[i - 1] + rowSize); - } - - *(psU32 *)&old->numCols = numCols; - *(psU32 *)&old->numRows = numRows; - *(psElemType* ) & old->type.type = type; - - return old; -} - -bool p_psImageCopyToRawBuffer(void* buffer, - const psImage* input, - psElemType type) -{ - psElemType inDatatype; - psS32 numRows; - psS32 numCols; - - if (input == NULL || input->data.V == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - return false; - } - - if (input->type.dimen != PS_DIMEN_IMAGE) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_NOT_AN_IMAGE); - return false; - } - - inDatatype = input->type.type; - numRows = input->numRows; - numCols = input->numCols; - - // cover the trival case of copy of the same - // datatype. - if (type == inDatatype) { - int rowSize = PSELEMTYPE_SIZEOF(inDatatype)*numCols; - for (psS32 row=0;rowdata.V[row], rowSize); - } - return true; - } - - #define PSIMAGE_BUFFER_COPY(INTYPE,OUTTYPE) { \ - ps##INTYPE *in; \ - ps##OUTTYPE *out = buffer; \ - for(psS32 row=0;rowdata.INTYPE[row]; \ - for (psS32 col=0;colchildren != NULL) { - psImage** children = (psImage**)image->children->data; - numFreed = image->children->n; - - // orphan the children first - // (so psFree doesn't try to modify the parent's children array while I'm using it) - for (psS32 i=0;iparent = NULL; - } - - psFree(image->children); - image->children = NULL; - } - - return numFreed; -} - -bool p_psImagePrint (FILE *f, psImage *a, char *name) -{ - - fprintf (f, "matrix: %s\n", name); - - for (int j = 0; j < a[0].numRows; j++) { - for (int i = 0; i < a[0].numCols; i++) { - fprintf (f, "%f ", p_psImageGetElementF64(a, i, j)); - } - fprintf (f, "\n"); - } - fprintf (f, "\n"); - return (true); -} - -complex psImagePixelInterpolate(const psImage* input, - float x, - float y, - const psImage* mask, - psMaskType maskVal, - complex unexposedValue, - psImageInterpolateMode mode) -{ - - if (input == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL,true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - return unexposedValue; - } - - #define PSIMAGE_PIXEL_INTERPOLATE_CASE(TYPE) \ -case PS_TYPE_##TYPE: \ - switch (mode) { \ - case PS_INTERPOLATE_FLAT: \ - return p_psImagePixelInterpolateFLAT_##TYPE( \ - input, \ - x, \ - y, \ - mask, \ - maskVal, \ - unexposedValue); \ - break; \ - case PS_INTERPOLATE_BILINEAR: \ - return p_psImagePixelInterpolateBILINEAR_##TYPE( \ - input, \ - x, \ - y, \ - mask, \ - maskVal, \ - unexposedValue); \ - break; \ - case PS_INTERPOLATE_BILINEAR_VARIANCE: \ - return p_psImagePixelInterpolateBILINEAR_VARIANCE_##TYPE( \ - input, \ - x, \ - y, \ - mask, \ - maskVal, \ - unexposedValue); \ - break; \ - default: \ - psError(PS_ERR_BAD_PARAMETER_VALUE,true, \ - PS_ERRORTEXT_psImage_INTERPOLATE_METHOD_INVALID, \ - mode); \ - } \ - break; - - switch (input->type.type) { - PSIMAGE_PIXEL_INTERPOLATE_CASE(U8); - PSIMAGE_PIXEL_INTERPOLATE_CASE(U16); - PSIMAGE_PIXEL_INTERPOLATE_CASE(U32); - PSIMAGE_PIXEL_INTERPOLATE_CASE(U64); - PSIMAGE_PIXEL_INTERPOLATE_CASE(S8); - PSIMAGE_PIXEL_INTERPOLATE_CASE(S16); - PSIMAGE_PIXEL_INTERPOLATE_CASE(S32); - PSIMAGE_PIXEL_INTERPOLATE_CASE(S64); - PSIMAGE_PIXEL_INTERPOLATE_CASE(F32); - PSIMAGE_PIXEL_INTERPOLATE_CASE(F64); - PSIMAGE_PIXEL_INTERPOLATE_CASE(C32); - PSIMAGE_PIXEL_INTERPOLATE_CASE(C64); - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,input->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE,true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - } - } - - return unexposedValue; -} - -psF64 p_psImageGetElementF64(psImage* image, - int col, - int row) -{ - if (image == NULL) { - return NAN; - } - if (col < 0 || col >= image->numCols) { - return NAN; - } - if (row < 0 || row >= image->numRows) { - return NAN; - } - - switch (image->type.type) { - case PS_TYPE_U8: - return image->data.U8[row][col]; - break; - case PS_TYPE_U16: - return image->data.U16[row][col]; - break; - case PS_TYPE_U32: - return image->data.U32[row][col]; - break; - case PS_TYPE_U64: - return image->data.U64[row][col]; - break; - case PS_TYPE_S8: - return image->data.S8[row][col]; - break; - case PS_TYPE_S16: - return image->data.S16[row][col]; - break; - case PS_TYPE_S32: - return image->data.S32[row][col]; - break; - case PS_TYPE_S64: - return image->data.S64[row][col]; - break; - case PS_TYPE_F32: - return image->data.F32[row][col]; - break; - case PS_TYPE_F64: - return image->data.F64[row][col]; - default: - return NAN; - } -} - -#define PSIMAGE_PIXEL_INTERPOLATE_FLAT(TYPE,RETURNTYPE) \ -inline RETURNTYPE p_psImagePixelInterpolateFLAT_##TYPE( \ - const psImage* input, \ - float x, \ - float y, \ - const psImage* mask, \ - psU32 maskVal, \ - RETURNTYPE unexposedValue) \ -{ \ - psS32 intX = (psS32) round((psF64)(x) - 0.5 + FLT_EPSILON); \ - psS32 intY = (psS32) round((psF64)(y) - 0.5 + FLT_EPSILON); \ - psS32 lastX = input->numCols - 1; \ - psS32 lastY = input->numRows - 1; \ - \ - if ((intX < 0) || \ - (intX > lastX) || \ - (intY < 0) || \ - (intY > lastY) || \ - ( (mask!=NULL) && \ - ((mask->data.PS_TYPE_MASK_DATA[intY][intX] & maskVal) != 0) ) ) { \ - return unexposedValue; \ - } \ - \ - return input->data.TYPE[intY][intX]; \ -} - -PSIMAGE_PIXEL_INTERPOLATE_FLAT(U8,psF64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(U16,psF64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(U32,psF64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(U64,psF64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(S8,psF64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(S16,psF64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(S32,psF64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(S64,psF64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(F32,psF64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(F64,psF64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(C32,psC64) -PSIMAGE_PIXEL_INTERPOLATE_FLAT(C64,psC64) - -#define PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(TYPE, RETURNTYPE, SUFFIX, FRACFUNC) \ -inline RETURNTYPE p_psImagePixelInterpolateBILINEAR_##SUFFIX( \ - const psImage* input, \ - float x, \ - float y, \ - const psImage* mask, \ - psU32 maskVal, \ - RETURNTYPE unexposedValue) \ -{ \ - double floorX = floor((psF64)(x) - 0.5); \ - double floorY = floor((psF64)(y) - 0.5); \ - psF64 fracX = x - 0.5 - floorX; \ - psF64 fracY = y - 0.5 - floorY; \ - psS32 intFloorX = (psS32) floorX; \ - psS32 intFloorY = (psS32) floorY; \ - psS32 lastX = input->numCols - 1; \ - psS32 lastY = input->numRows - 1; \ - ps##TYPE V00 = 0; \ - ps##TYPE V01 = 0; \ - ps##TYPE V10 = 0; \ - ps##TYPE V11 = 0; \ - psBool valid00 = false; \ - psBool valid01 = false; \ - psBool valid10 = false; \ - psBool valid11 = false; \ - \ - if (intFloorY >= 0 && intFloorY <= lastY) { \ - if (intFloorX >= 0 && intFloorX <= lastX) { \ - V00 = input->data.TYPE[intFloorY][intFloorX]; \ - valid00 = (mask == NULL) || \ - ((mask->data.PS_TYPE_MASK_DATA[intFloorY][intFloorX] & maskVal) == 0); \ - } \ - if (intFloorX >= -1 && intFloorX < lastX) { \ - V10 = input->data.TYPE[intFloorY][intFloorX+1]; \ - valid10 = (mask == NULL) || \ - ((mask->data.PS_TYPE_MASK_DATA[intFloorY][intFloorX+1] & maskVal) == 0); \ - } \ - } \ - if (intFloorY >= -1 && intFloorY < lastY) { \ - if (intFloorX >= 0 && intFloorX <= lastX) { \ - V01 = input->data.TYPE[intFloorY+1][intFloorX]; \ - valid01 = (mask == NULL) || \ - ((mask->data.PS_TYPE_MASK_DATA[intFloorY+1][intFloorX] & maskVal) == 0); \ - } \ - if (intFloorX >= -1 && intFloorX < lastX) { \ - V11 = input->data.TYPE[intFloorY+1][intFloorX+1]; \ - valid11 = (mask == NULL) || \ - ((mask->data.PS_TYPE_MASK_DATA[intFloorY+1][intFloorX+1] & maskVal) == 0); \ - } \ - } \ - \ - /* cover likely case of all pixels being valid more efficiently */ \ - if (valid00 && valid10 && valid01 && valid11) { \ - /* formula from the ADD */ \ - return V00*FRACFUNC((1.0-fracX)*(1.0-fracY)) + V10*FRACFUNC(fracX*(1.0-fracY)) + \ - V01*FRACFUNC(fracY*(1.0-fracX)) + V11*FRACFUNC(fracX*fracY); \ - } \ - \ - /* OK, at least one pixel is not valid - need to do it piecemeal */ \ - \ - RETURNTYPE V0 = 0.0; \ - psBool valid0 = true; \ - if (valid00 && valid10) { \ - V0 = V00*FRACFUNC(1-fracX)+V10*FRACFUNC(fracX); \ - } else if (valid00) { \ - V0 = V00; \ - } else if (valid10) { \ - V0 = V10; \ - } else { \ - valid0 = false; \ - } \ - \ - RETURNTYPE V1 = 0.0; \ - psBool valid1 = true; \ - if (valid01 && valid11) { \ - V1 = V01*FRACFUNC(1-fracX)+V11*FRACFUNC(fracX); \ - } else if (valid01) { \ - V1 = V01; \ - } else if (valid11) { \ - V1 = V11; \ - } else { \ - valid1 = false; \ - } \ - \ - if (valid0 && valid1) { \ - return V0*FRACFUNC(1-fracY) + V1*FRACFUNC(fracY); \ - } else if (valid0) { \ - return V0; \ - } else if (valid1) { \ - return V1; \ - } \ - \ - return unexposedValue; \ -} - -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(U8,psF64,U8,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(U16,psF64,U16,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(U32,psF64,U32,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(U64,psF64,U64,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(S8,psF64,S8,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(S16,psF64,S16,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(S32,psF64,S32,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(S64,psF64,S64,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(F32,psF64,F32,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(F64,psF64,F64,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(C32,psC64,C32,) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(C64,psC64,C64,) - -// Variance Version -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(U8,psF64,VARIANCE_U8,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(U16,psF64,VARIANCE_U16,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(U32,psF64,VARIANCE_U32,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(U64,psF64,VARIANCE_U64,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(S8,psF64,VARIANCE_S8,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(S16,psF64,VARIANCE_S16,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(S32,psF64,VARIANCE_S32,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(S64,psF64,VARIANCE_S64,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(F32,psF64,VARIANCE_F32,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(F64,psF64,VARIANCE_F64,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(C32,psC64,VARIANCE_C32,SQUARE) -PSIMAGE_PIXEL_INTERPOLATE_BILINEAR(C64,psC64,VARIANCE_C64,SQUARE) Index: unk/psLib/src/image/psImage.h =================================================================== --- /trunk/psLib/src/image/psImage.h (revision 4545) +++ (revision ) @@ -1,244 +1,0 @@ -/** @file psImage.h - * - * @brief Contains basic image definitions and operations - * - * This file defines the basic type for an image struct and functions useful - * in manupulating images. - * - * @ingroup Image - * - * @author Robert DeSonia, MHPCC - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.62 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ -#ifndef PS_IMAGE_H -#define PS_IMAGE_H - -#include -#include -#include "psType.h" -#include "psArray.h" - -/// @addtogroup Image -/// @{ - -/** enumeration of options in interpolation - * - */ -typedef enum { - PS_INTERPOLATE_FLAT, ///< 'flat' interpolation (nearest pixel) - PS_INTERPOLATE_BILINEAR, ///< bi-linear interpolation - PS_INTERPOLATE_LANCZOS2, ///< Sinc interpolation with 4x4 pixel kernel - PS_INTERPOLATE_LANCZOS3, ///< Sinc interpolation with 6x6 pixel kernel - PS_INTERPOLATE_LANCZOS4, ///< Sinc interpolation with 8x8 pixel kernel - PS_INTERPOLATE_BILINEAR_VARIANCE, ///< Variance version of PS_INTERPOLATE_BILINEAR - PS_INTERPOLATE_LANCZOS2_VARIANCE, ///< Variance version of PS_INTERPOLATE_LANCZOS2 - PS_INTERPOLATE_LANCZOS3_VARIANCE, ///< Variance version of PS_INTERPOLATE_LANCZOS3 - PS_INTERPOLATE_LANCZOS4_VARIANCE, ///< Variance version of PS_INTERPOLATE_LANCZOS4 - // PS_INTERPOLATE_NUM_MODES ///< enum end-marker; does not coorespond to a interpolation mode -} psImageInterpolateMode; - -/** Basic image data structure. - * - * Struct for maintaining image data of varying types. It also contains - * information about image size, parent images and children images. - * - */ -typedef struct psImage -{ - const psMathType type; ///< Image data type and dimension. - const int numCols; ///< Number of columns in image - const int numRows; ///< Number of rows in image. - const int col0; ///< Column position relative to parent. - const int row0; ///< Row position relative to parent. - - union { - psU8** U8; ///< Unsigned 8-bit integer data. - psU16** U16; ///< Unsigned 16-bit integer data. - psU32** U32; ///< Unsigned 32-bit integer data. - psU64** U64; ///< Unsigned 64-bit integer data. - psS8** S8; ///< Signed 8-bit integer data. - psS16** S16; ///< Signed 16-bit integer data. - psS32** S32; ///< Signed 32-bit integer data. - psS64** S64; ///< Signed 64-bit integer data. - psF32** F32; ///< Single-precision float data. - psF64** F64; ///< Double-precision float data. - psC32** C32; ///< Single-precision complex data. - psC64** C64; ///< Double-precision complex data. - psPtr** PTR; ///< Void pointers. - psPtr* V; ///< Pointer to data. - } data; ///< Union for data types. - const struct psImage* parent; ///< Parent, if a subimage. - psArray* children; ///< Children of this region. - - psPtr rawDataBuffer; ///< Raw data buffer for Allocating/Freeing Images - void *lock; ///< Optional lock for thread safety -} -psImage; - -/** Basic image region structure. - * - * Struct for specifying a rectangular area in an image. - * - */ -typedef struct -{ - float x0; ///< the first column of the region. - float x1; ///< the last column of the region. - float y0; ///< the first row of the region. - float y1; ///< the last row of the region. -} -psRegion; - -/** Create an image of the specified size and type. - * - * Uses psLib memory allocation functions to create an image struct of the - * specified size and type. - * - * @return psImage* : Pointer to psImage. - * - */ -psImage* psImageAlloc( - int numCols, ///< Number of rows in image. - int numRows, ///< Number of columns in image. - psElemType type ///< Type of data for image. -) -; - -/** Create a psRegion with the specified attributes. - * - * @return psRegion : a cooresponding psRegion. - */ -psRegion psRegionSet( - float x0, ///< the first column of the region. - float x1, ///< the last column of the region + 1. - float y0, ///< the first row of the region. - float y1 ///< the last row of the region + 1. -); - -/** Create a psRegion with the attribute values given as a string. - * - * Create a psRegion with the attribute values given as a string. The format - * shall be of the standard IRAF form '[x0:x1,y0:y1]' - * - * @return psRegion: A new psRegion struct, or NULL is not successful. - */ -psRegion psRegionFromString( - const char* region ///< image rectangular region in the form '[x0:x1,y0:y1]' -); - -/** Create a string of the standard IRAF form '[x0:x1,y0:y1]' from a psRegion. - * - * @return psString: A new string representing the psRegion as text, or NULL - * is not successful. - */ -psString psRegionToString( - const psRegion region ///< the psRegion to convert to a string -); - -/** Resize a given image to the given size/type. - * - * @return psImage* Resized psImage. - * - */ -psImage* psImageRecycle( - psImage* old, ///< the psImage to recycle by resizing image buffer - int numCols, ///< the desired number of columns in image - int numRows, ///< the desired number of rows in image - const psElemType type ///< the desired datatype of the image -); - -/** Copy an image to a new buffer - * - * @return True if image copied or false if error - */ -bool p_psImageCopyToRawBuffer( - void* buffer, ///< the buffer used to copy the image - const psImage* input, ///< the input image to be copied - psElemType type ///< the datatype of the image to be copied -); - -/** Frees all children of a psImage. - * - * @return int Number of children freed. - * - */ -int psImageFreeChildren( - psImage* image ///< psImage in which all children shall be deallocated -); - -/** get an element of an image as a psF64. - * - * @return psF64 pixel value at specified location - */ -psF64 p_psImageGetElementF64( - psImage* image, ///< input image - int col, ///< pixel column - int row ///< pixel row -); - -/** print image pixel values. - * - * @return bool TRUE is successful, otherwise FALSE. - */ -bool p_psImagePrint( - FILE *f, ///< Destination stream - psImage *a, ///< image to print - char *name ///< name of the image (for title) -); - -/** Interpolate image pixel value given floating point coordinates. - * - * @return psF32 Pixel value interpolated from image or unexposedValue if - * given x,y doesn't coorespond to a valid image location - */ -complex psImagePixelInterpolate( - const psImage* input, ///< input image for interpolation - float x, ///< column location to derive value of - float y, ///< row location ot derive value of - const psImage* mask, ///< if not NULL, the mask of the input image - psMaskType maskVal, ///< the mask value - complex unexposedValue, ///< return value if x,y location is not in image. - psImageInterpolateMode mode ///< interpolation mode -); - -#define PIXEL_INTERPOLATE_FCN_PROTOTYPE(SUFFIX, RETURNTYPE) \ -inline RETURNTYPE p_psImagePixelInterpolate##SUFFIX( \ - const psImage* input, /**< input image for interpolation */ \ - float x, /**< column location to derive value of */ \ - float y, /**< row location ot derive value of */ \ - const psImage* mask, /**< if not NULL, the mask of the input image */ \ - psU32 maskVal, /**< the mask value */ \ - RETURNTYPE unexposedValue /**< return value if x,y location is not in image. */ \ - ); - -#define PIXEL_INTERPOLATE_FCNS(MODE) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_U8,psF64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_U16,psF64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_U32,psF64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_U64,psF64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_S8,psF64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_S16,psF64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_S32,psF64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_S64,psF64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_F32,psF64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_F64,psF64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_C32,psC64) \ -PIXEL_INTERPOLATE_FCN_PROTOTYPE(MODE##_C64,psC64) - -#ifndef SWIG -PIXEL_INTERPOLATE_FCNS(FLAT) -PIXEL_INTERPOLATE_FCNS(BILINEAR) -PIXEL_INTERPOLATE_FCNS(BILINEAR_VARIANCE) -#endif // ! SWIG - -#undef PIXEL_INTERPOLATE_FCN_PROTOTYPE -#undef PIXEL_INTERPOLATE_FCNS - -/// @} - -#endif // PS_IMAGE_H Index: unk/psLib/src/image/psImageConvolve.c =================================================================== --- /trunk/psLib/src/image/psImageConvolve.c (revision 4545) +++ (revision ) @@ -1,477 +1,0 @@ -/* @file psImageConvolve.c - * - * @brief Contains FFT transform related functions for psImage. - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.21 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include - -#include "psImageConvolve.h" -#include "psImageFFT.h" -#include "psImageStructManip.h" -#include "psBinaryOp.h" -#include "psMemory.h" -#include "psLogMsg.h" -#include "psError.h" - -#include "psImageErrors.h" - -#define FOURIER_PADDING 32 /* padding amount in every side of the image for fourier convolution */ - -static void freeKernel(psKernel* ptr); - -psKernel* psKernelAlloc(int xMin, int xMax, int yMin, int yMax) -{ - psKernel* result; - psS32 numRows; - psS32 numCols; - - // following is explicitly spelled out in the SDRS as a requirement - if (yMin > yMax) { - psLogMsg(__func__, PS_LOG_WARN, - "Specified yMin, %d, was greater than yMax, %d. Values swapped.", - yMin, yMax); - - psS32 temp = yMin; - yMin = yMax; - yMax = temp; - } - - // following is explicitly spelled out in the SDRS as a requirement - if (xMin > xMax) { - psLogMsg(__func__, PS_LOG_WARN, - "Specified xMin, %d, was greater than xMax, %d. Values swapped.", - xMin, xMax); - - psS32 temp = xMin; - xMin = xMax; - xMax = temp; - } - - numRows = yMax - yMin + 1; - numCols = xMax - xMin + 1; - - result = psAlloc(sizeof(psKernel)); - result->xMin = xMin; - result->xMax = xMax; - result->yMin = yMin; - result->yMax = yMax; - result->image = psImageAlloc(numCols,numRows,PS_TYPE_KERNEL); - memset(result->image->rawDataBuffer,0,numCols*numRows*PSELEMTYPE_SIZEOF(PS_TYPE_KERNEL)); - result->p_kernelRows = psAlloc(sizeof(float*)*numRows); - - float** kernelRows = result->p_kernelRows; - float** imageRows = result->image->data.PS_TYPE_KERNEL_DATA; - for (psS32 i = 0; i < numRows; i++) { - kernelRows[i] = imageRows[i] - xMin; - } - result->kernel = kernelRows - yMin; - - psMemSetDeallocator(result,(psFreeFunc)freeKernel); - - return result; -} - -void freeKernel(psKernel* ptr) -{ - if (ptr != NULL) { - psFree(ptr->image); - psFree(ptr->p_kernelRows); - } -} - -psKernel* psKernelGenerate(const psVector* tShifts, - const psVector* xShifts, - const psVector* yShifts, - bool relative) -{ - psS32 lastX; - psS32 lastY; - psS32 lastT; - psS32 x; - psS32 y; - psS32 t; - psS32 xMin = 0; - psS32 xMax = 0; - psS32 yMin = 0; - psS32 yMax = 0; - psS32 length = 0; - float normalizeTime = 1.0; // fraction of total time for each shift clock - psKernel* result = NULL; - float** kernel = NULL; - - // got non-NULL vectors? - if (tShifts == NULL || xShifts == NULL || yShifts == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImageConvolve_SHIFT_NULL); - return NULL; - } - - // types match? - if (xShifts->type.type != yShifts->type.type || - tShifts->type.type != xShifts->type.type) { - char* typeXStr; - char* typeYStr; - char* typeTStr; - PS_TYPE_NAME(typeXStr,xShifts->type.type); - PS_TYPE_NAME(typeYStr,yShifts->type.type); - PS_TYPE_NAME(typeTStr,tShifts->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImageConvolve_SHIFT_TYPE_MISMATCH, - typeTStr, typeXStr, typeYStr); - return NULL; - } - - // sizes match? - length = xShifts->n; - if (length != yShifts->n || - length != tShifts->n) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "Shift vectors can not be of different sizes."); - return NULL; - } - - // if no shifts, the kernel is just a 1 at 0,0 - if (length < 1) { - result = psKernelAlloc(0,0,0,0); - result->kernel[0][0] = 1; - return result; - } - - #define KERNEL_GENERATE_CASE(TYPE) \ -case PS_TYPE_##TYPE: { \ - ps##TYPE *tShiftData = tShifts->data.TYPE; \ - ps##TYPE *xShiftData = xShifts->data.TYPE; \ - ps##TYPE *yShiftData = yShifts->data.TYPE; \ - lastX = xShiftData[length-1]; \ - lastY = yShiftData[length-1]; \ - lastT = tShiftData[length-1]; \ - \ - for (int lcv = 0; lcv < length; lcv++) { \ - x = lastX - xShiftData[lcv]; \ - y = lastY - yShiftData[lcv]; \ - \ - if (x < xMin) { \ - xMin = x; \ - } else if (x > xMax) { \ - xMax = x; \ - } \ - if (y < yMin) { \ - yMin = y; \ - } else if (y > yMax) { \ - yMax = y; \ - } \ - } \ - \ - normalizeTime = 1.0 / (float)(tShiftData[length-1]); \ - result = psKernelAlloc(xMin,xMax,yMin,yMax); \ - kernel = result->kernel; \ - \ - psS32 prevT = 0; \ - for (int i = 0; i < length; i++) { \ - t = tShiftData[i] - prevT; \ - x = lastX - xShiftData[i]; \ - y = lastY - yShiftData[i]; \ - \ - kernel[y][x] += (float)t / (float)lastT; \ - prevT = tShiftData[i]; \ - } \ - break; \ - } - - #define RELATIVE_KERNEL_GENERATE_CASE(TYPE) \ -case PS_TYPE_##TYPE: { \ - ps##TYPE *tShiftData = tShifts->data.TYPE; \ - ps##TYPE *xShiftData = xShifts->data.TYPE; \ - ps##TYPE *yShiftData = yShifts->data.TYPE; \ - \ - x = 0; \ - y = 0; \ - t = 0; \ - \ - for (int lcv = length-1; lcv >= 0; lcv--) { \ - t += tShiftData[lcv]; \ - \ - if (x < xMin) { \ - xMin = x; \ - } else if (x > xMax) { \ - xMax = x; \ - } \ - if (y < yMin) { \ - yMin = y; \ - } else if (y > yMax) { \ - yMax = y; \ - } \ - x -= xShiftData[lcv]; \ - y -= yShiftData[lcv]; \ - \ - } \ - result = psKernelAlloc(xMin,xMax,yMin,yMax); \ - kernel = result->kernel; \ - \ - normalizeTime = 1.0 / (float)t; \ - x = 0; \ - y = 0; \ - for (psS32 i = length-1; i >= 0; i--) { \ - kernel[y][x] += (float)(tShiftData[i]) * normalizeTime; \ - x -= xShiftData[i]; \ - y -= yShiftData[i]; \ - \ - } \ - break; \ - } - - if (relative) { - switch (xShifts->type.type) { - RELATIVE_KERNEL_GENERATE_CASE(U8); - RELATIVE_KERNEL_GENERATE_CASE(U16); - RELATIVE_KERNEL_GENERATE_CASE(U32); - RELATIVE_KERNEL_GENERATE_CASE(U64); - RELATIVE_KERNEL_GENERATE_CASE(S8); - RELATIVE_KERNEL_GENERATE_CASE(S16); - RELATIVE_KERNEL_GENERATE_CASE(S32); - RELATIVE_KERNEL_GENERATE_CASE(S64); - RELATIVE_KERNEL_GENERATE_CASE(F32); - RELATIVE_KERNEL_GENERATE_CASE(F64); - RELATIVE_KERNEL_GENERATE_CASE(C32); - RELATIVE_KERNEL_GENERATE_CASE(C64); - - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,xShifts->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - } - } - } else { - switch (xShifts->type.type) { - KERNEL_GENERATE_CASE(U8); - KERNEL_GENERATE_CASE(U16); - KERNEL_GENERATE_CASE(U32); - KERNEL_GENERATE_CASE(U64); - KERNEL_GENERATE_CASE(S8); - KERNEL_GENERATE_CASE(S16); - KERNEL_GENERATE_CASE(S32); - KERNEL_GENERATE_CASE(S64); - KERNEL_GENERATE_CASE(F32); - KERNEL_GENERATE_CASE(F64); - KERNEL_GENERATE_CASE(C32); - KERNEL_GENERATE_CASE(C64); - - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,xShifts->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - } - } - } - - return result; -} - -psImage* psImageConvolve(psImage* out, const psImage* in, const psKernel* kernel, bool direct) -{ - if (in == NULL) { - psFree(out); - return NULL; - } - - if (kernel == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImageConvolve_KERNEL_NULL); - psFree(out); - return NULL; - } - psS32 xMin = kernel->xMin; - psS32 xMax = kernel->xMax; - psS32 yMin = kernel->yMin; - psS32 yMax = kernel->yMax; - float** kData = kernel->kernel; - - // make the output image to the proper size and type - psS32 numRows = in->numRows; - psS32 numCols = in->numCols; - - - - if (direct) { - // spatial convolution - - #define SPATIAL_CONVOLVE_CASE(TYPE) \ - case PS_TYPE_##TYPE: { \ - ps##TYPE** inData = in->data.TYPE; \ - out = psImageRecycle(out, numCols, numRows, PS_TYPE_##TYPE); \ - for (psS32 row=0;rowdata.TYPE[row]; \ - for (psS32 col=0;col= 0 && row-kRow < numRows) { \ - for (psS32 kCol = xMin; kCol < xMax; kCol++) { \ - if (col-kCol >= 0 && col-kCol < numCols) { \ - pixel += kData[kRow][kCol] * inData[row-kRow][col-kCol]; \ - } \ - } \ - } \ - } \ - outRow[col] = pixel; \ - } \ - } \ - } \ - break; - - switch (in->type.type) { - SPATIAL_CONVOLVE_CASE(U8) - SPATIAL_CONVOLVE_CASE(U16) - SPATIAL_CONVOLVE_CASE(U32) - SPATIAL_CONVOLVE_CASE(U64) - SPATIAL_CONVOLVE_CASE(S8) - SPATIAL_CONVOLVE_CASE(S16) - SPATIAL_CONVOLVE_CASE(S32) - SPATIAL_CONVOLVE_CASE(S64) - SPATIAL_CONVOLVE_CASE(F32) - SPATIAL_CONVOLVE_CASE(F64) - SPATIAL_CONVOLVE_CASE(C32) - SPATIAL_CONVOLVE_CASE(C64) - - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,in->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - psFree(out); - return NULL; - - } - } - - - } else { - // fourier convolution - psS32 paddedCols = numCols+2*FOURIER_PADDING; - psS32 paddedRows = numRows+2*FOURIER_PADDING; - - // check to see if kernel is smaller, otherwise padding it up will fail. - psS32 kRows = kernel->image->numRows; - psS32 kCols = kernel->image->numCols; - if (kRows >= numRows || kCols >= numCols) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psImageConvolve_KERNEL_TOO_LARGE, - kCols,kRows, - numCols, numRows); - psFree(out); - return NULL; - } - - // pad the image - psImage* paddedImage = psImageAlloc(paddedCols,paddedRows,in->type.type); - psS32 elementSize = PSELEMTYPE_SIZEOF(in->type.type); - - // zero out padded area on top and bottom - memset(paddedImage->data.U8[0],0,FOURIER_PADDING*paddedCols*elementSize); - memset(paddedImage->data.U8[FOURIER_PADDING+numRows-1],0,FOURIER_PADDING*paddedCols*elementSize); - - // fill in the image-containing rows. - psS32 sidePaddingSize = FOURIER_PADDING*elementSize; - psS32 imageRowSize = numCols*elementSize; - psU8* paddedData = paddedImage->data.U8[FOURIER_PADDING]; - for (psS32 row=0;rowdata.U8[row],imageRowSize); - paddedData += imageRowSize; - // zero out padded area on right edge. - memset(paddedData,0,sidePaddingSize); - paddedData += sidePaddingSize; - } - - // pad the kernel to the same size of paddedImage - psImage* paddedKernel = psImageAlloc(paddedCols,paddedRows,PS_TYPE_KERNEL); - memset(paddedKernel->data.U8[0],0,sizeof(float)*numCols*numRows); // zero-out image - psS32 yMax = kernel->yMax; - psS32 xMax = kernel->xMax; - for (psS32 row = kernel->yMin; row <= yMax;row++) { - psS32 padRow = row; - if (padRow < 0) { - padRow += paddedRows; - } - float* padData = paddedKernel->data.PS_TYPE_KERNEL_DATA[padRow]; - float* kernelRow = kernel->kernel[row]; - for (psS32 col = kernel->xMin; col <= xMax; col++) { - if (col < 0) { - padData[col+paddedCols] = kernelRow[col]; - } else { - padData[col] = kernelRow[col]; - } - } - } - - psImage* kernelFourier = psImageFFT(NULL, paddedKernel, PS_FFT_FORWARD); - if (kernelFourier == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psImageConvolve_KERNEL_FFT_FAILED); - psFree(out); - return NULL; - } - - psImage* inFourier = psImageFFT(NULL, paddedImage, PS_FFT_FORWARD); - if (inFourier == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psImageConvolve_FFT_FAILED); - psFree(out); - return NULL; - } - - // convolution in fourier domain is just a pixel-wise multiplication - for (int row = 0; row < paddedRows; row++) { - psC32* inRow = inFourier->data.C32[row]; - psC32* kRow = kernelFourier->data.C32[row]; - for (int col = 0; col < paddedCols; col++) { - inRow[col] *= kRow[col]; - } - } - - psImage* complexOut = psImageFFT(NULL, inFourier, - PS_FFT_REVERSE); - if (complexOut == NULL) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psImageConvolve_FFT_FAILED); - psFree(out); - return NULL; - } - - // subset out the padded area now. - psImage* complexOutSansPad = psImageSubset(complexOut, - psRegionSet(FOURIER_PADDING, FOURIER_PADDING+numCols,FOURIER_PADDING,FOURIER_PADDING+numRows)); - - out = psImageRecycle(out,numCols,numRows,PS_TYPE_F32); - float factor = 1.0f/(float)paddedCols/(float)paddedRows; - for (psS32 row = 0; row < numRows; row++) { - psF32* outRow = out->data.F32[row]; - psC32* resultRow = complexOutSansPad->data.C32[row]; - for (psS32 col = 0; col < numCols; col++) { - outRow[col] = crealf(resultRow[col])*factor; - } - } - - psFree(complexOut); // frees complexOutSansPad, as it is a child. - psFree(kernelFourier); - psFree(inFourier); - psFree(paddedImage); - psFree(paddedKernel); - - } - - return out; -} Index: unk/psLib/src/image/psImageConvolve.h =================================================================== --- /trunk/psLib/src/image/psImageConvolve.h (revision 4545) +++ (revision ) @@ -1,128 +1,0 @@ -/** @file psImageConvolve.h - * - * @brief image convolution functionality - * - * @ingroup Transform - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_IMAGE_CONVOLVE_H -#define PS_IMAGE_CONVOLVE_H - -#include "psImage.h" -#include "psVector.h" -#include "psType.h" - -#define PS_TYPE_KERNEL PS_TYPE_F32 /**< the data member to use for kernel image */ -#define PS_TYPE_KERNEL_DATA F32 /**< the data member to use for kernel image */ -#define PS_TYPE_KERNEL_NAME "psF32" /**< the data type for kernel as a string */ - -/** Kernel Type - * - * A floating-point data type used for storing kernel data. - * - */ -//typedef float psKernelType; - -/** A convolution kernel */ -typedef struct -{ - psImage* image; ///< Kernel data, in the form of an image - int xMin; ///< Most negative x index - int yMin; ///< Most negative y index - int xMax; ///< Most positive x index - int yMax; ///< Most positive y index - float** kernel; ///< Pointer to the kernel data - float** p_kernelRows; ///< Pointer to the rows of the kernel data; not intended for user use. -} -psKernel; - -/** Allocates a convolution kernel of the given range - * - * In order to perform a convolution, we need to define the convolution - * kernel. We need a more general object than a psImage so that we can - * incorporate the offset from the (0, 0) pixel to the (0, 0) value of the - * kernel. It might be convenient to allow both positive and negative - * indices to convey the positive and negative shifts. One might consider - * setting the x0 and y0 members of a psImage to the appropriate offsets, - * but this is not the purpose of these members, and doing so may affect the - * behavior of other psImage operations. - * - * This construction allows the kernel member to use negative indices, while - * preserving the location of psMemBlocks relative to allocated memory. - * - * The maximum extent of the kernel shifts shall be defined by the xMin, - * xMax, yMin and yMax members. Note that xMin and yMin, under normal - * circumstances, should be negative numbers. That is, - * myKernel->kernel[-3][-2] may be defined if yMin and xMin are equal to or - * more negative than -3 and -2, respectively. - * - * In the event that one of the minimum values is greater than the - * corresponding maximum value, the function shall generate a warning, and - * the offending values shall be exchanged. - * - * @return psKernel* A new kernel object - */ -psKernel* psKernelAlloc( - int xMin, ///< Most negative x index - int xMax, ///< Most positive x index - int yMin, ///< Most negative y index - int yMax ///< Most positive y index -); - -/** Generates a kernel given a list of shift values - * - * Given a list of values (e.g., shifts made in the course of OT guiding), - * psKernelGenerate shall return the appropriate kernel. The vectors xShifts - * and yShifts, which are a list of shifts relative to some starting point, - * will be supplied by the user. The elements of the vectors should be of an - * integer type; otherwise the values shall be truncated to integers. The - * output kernel shall be normalized such that the sum over the kernel is - * unity. - * - * If the vectors are not of the same number of elements, then the function - * shall generate a warning shall be generated, following which, the longer - * vector trimmed to the length of the shorter, and the function shall continue. - * - * @return psKernel* new Kernel object - */ -psKernel* psKernelGenerate( - const psVector* tShifts, ///< list of time shifts - const psVector* xShifts, ///< list of x-axis shifts - const psVector* yShifts, ///< list of y-axis shifts - bool relative - /**< specifies the starting point for the shifts; true=relative to previous shift - * false = relative to some other starting point. */ -); - -/** convolve an image with a kernel - * - * Given an input image and the convolution kernel, psImageConvolve shall - * convolve the input image, in, with the kernel, kernel and return the - * convolved image, out. - * - * Two methods shall be available for the convolution: if direct is true, - * then the convolution shall be performed in real space (appropriate for - * small kernels); otherwise, the convolution shall be performed using Fast - * Fourier Transforms (FFTs; appropriate for larger kernels). The latter - * option involves padding the input image, copying the kernel into an image - * of the same size as the padded input image, performing an FFT on each, - * multiplying the FFTs, and performing an inverse FFT before trimming the - * image back to the original size. - * - * @return psImage* resulting image - */ -psImage* psImageConvolve( - psImage* out, ///< a psImage to recycle. If NULL, a new psImage is made. - const psImage* in, ///< the psImage to convolve - const psKernel* kernel, ///< kernel to colvolve with - bool direct ///< specifies method, true=direct convolution, false=fourier -); - -#endif // #ifndef PS_IMAGE_CONVOLVE_H Index: unk/psLib/src/image/psImageErrors.dat =================================================================== --- /trunk/psLib/src/image/psImageErrors.dat (revision 4545) +++ (revision ) @@ -1,81 +1,0 @@ -# -# This file is used to generate psImageErrors.h content -# -# Format is: -# ERRORNAME(one word) ERRORTEXT -# -# N.B. in code, the ERRORNAME appears as PS_ERRORTEXT_ERRORNAME -#################################################################### -# psImage -psImage_AREA_NEGATIVE Specified number of rows (%d) or columns (%d) is invalid. -psImage_NOT_AN_IMAGE The input psImage must have a PS_DIMEN_IMAGE dimension type. -psImage_IMAGE_NULL Can not operate on a NULL psImage. -psImage_IMAGE_TYPE_UNSUPPORTED Specified psImage type, %s, is not supported. -psImage_INTERPOLATE_METHOD_INVALID Specified interpolation method (%d) is not supported. -psImage_REGION_NULL Specified psRegion is NULL. Operation could not be performed. -psImage_SUBSET_RANGE_INVALID Specified subset range, [%d:%d,%d:%d], is invalid or outside input psImage's boundaries, [0:%d,0:%d]. -psImage_SUBSET_RANGE_MALFORMED Specified subset range, [%d:%d,%d:%d], is invalid. Ranges must be incremental. -psImage_SUBSECTION_NULL Specified subsection string can not be NULL. -psImage_SUBSECTION_INVALID Specified subsection string, '%s', can not be parsed. Must be in the form '[x1:x2,y1:y2]'. -psImage_NOT_PARENT Specified psImage can not be a child of another psImage. -psImage_INPLACE_NOTSUPPORTED Specified input and output psImage can not reference the same psImage. -psImage_SUBSET_ZERO_SIZE Specified subset, [%d:%d,%d:%d], contains no pixel data. -psImage_IMAGE_MASK_SIZE Input psImage mask size, %dx%d, does not match psImage input size, %dx%d. -psImage_IMAGE_MASK_TYPE Input psImage mask type, %s, is not the supported mask datatype of %s. -psImage_BAD_STAT Specified statistic option, %d, is not valid. Must specify one and only one statistic type. -psImage_NO_STAT_OPTIONS Specified statistic option did not indicate any operation to perform. -psImage_STAT_NULL Specified statistic can not be NULL. -psImage_SLICE_DIRECTION_INVALID Specified slice direction, %d, is invalid. -psImage_PARAMETER_OUTOF_TYPERANGE Specified %s value, %g, is outside of psImage type's range (%s: %g to %g). -psImage_nSamples_TOOSMALL Specified number of samples, %d, must be greater than 1 to make a line. -psImage_LINE_NOT_IN_IMAGE Specified line, (%f,%f)->(%f,%f), does not entirely lie in psImage's boundaries, [0:%d,0:%d]. -psImage_RADII_VECTOR_NULL Specified radii vector can not be NULL. -psImage_CENTER_NOT_IN_IMAGE Specified center, (%g,%g), is outside of the psImage boundaries, [0:%d,0:%d]. -psImage_RADII_VECTOR_TOOSMALL Input radii vector size, %d, can not be less than 2. -# -psImageFFT_IMAGE_TYPE_UNSUPPORTED Input psImage type (%s) is not supported. Valid image types are psF32 and psC32. -psImageFFT_REVERSE_NOT_COMPLEX Input psImage (%s) is not complex. Reverse FFT operation requires a complex psImage input. -psImageFFT_FORWARD_NOT_REAL Input psImage (%s) is not real. Forward FFT operation requires a real psImage input. -psImageFFT_FFTW_PLAN_NULL Could not create a valid FFT plan to perform the transform. -psImageFFT_REAL_IMAG_TYPE_MISMATCH Real psImage type (%s) and imaginary psImage type (%s) must be the same. -psImageFFT_REAL_IMAG_SIZE_MISMATCH Real psImage size (%dx%d) and imaginary psImage size (%dx%d) must be the same. -psImageFFT_NONREAL_NOTSUPPORTED Input psImage type, %s, is required to be either psF32 or psF64. -psImageFFT_NONCOMPLEX_NOTSUPPORTED Input psImage type, %s, is required to be either psC32 or psC64. -psImageFFT_REAL_FORWARD_NOTSUPPORTED The PS_FFT_FORWARD and PS_FFT_REAL_RESULT combinition is not supported. -psImageFFT_FORWARD_REVERSE Can not specify both PS_FFT_FORWARD and PS_FFT_REVERSE options. -psImageFFT_NO_DIRECTION_OPTION Must specify either PS_FFT_FORWARD or PS_FFT_REVERSE option. -# -psImageIO_FILENAME_NULL Specified filename can not be NULL. -psImageIO_FILENAME_INVALID Could not open file,'%s'.\nCFITSIO Error: %s -psImageIO_EXTNAME_INVALID Could not find HDU with extension name '%s' in file %s.\nCFITSIO Error: %s -psImageIO_EXTNUM_INVALID Could not find HDU #%d in file %s.\nCFITSIO Error: %s -psImageIO_DATATYPE_UNKNOWN Could not determine image data type for file %s.\nCFITSIO Error: %s -psImageIO_IMAGE_DIM_UNKNOWN Could not determine image dimensions for file %s.\nCFITSIO Error: %s -psImageIO_IMAGE_SIZE_UNKNOWN Could not determine image size for file %s.\nCFITSIO Error: %s -psImageIO_IMAGE_DIMENSION_UNSUPPORTED Image number of dimensions, %d, is not valid. Only two or three dimensions supported for FITS I/O. -psImageIO_FITS_TYPE_UNSUPPORTED FITS image type, BITPIX=%d, in file %s is not supported. -psImageIO_READ_FAILED Reading from FITS file %s failed.\nCFITSIO Error: %s -psImageIO_TYPE_UNSUPPORTED Input psImage type, %s, is not supported. -psImageIO_WRITE_EXTNUM_INVALID Specified extension number, %d, must not exceed number of HDUs, %d, by more than one. -psImageIO_FILENAME_CREATE_FAILED Could not create file,'%s'.\nCFITSIO Error: %s -psImageIO_CREATE_EXTENSION_FAILED Could not create EXTNAME keyword for file,'%s'.\nCFITSIO Error: %s -psImageIO_CREATE_HDU_FAILED Could not create HDU for writing psImage in file,'%s'.\nCFITSIO Error: %s -psImageIO_WRITE_FAILED Could not write psImage data to file,'%s'.\nCFITSIO Error: %s -# -psImageManip_MAXMIN Specified min value, %g, can not be greater than the specified max value, %g. -psImageManip_MAXMIN_REAL Specified real-portion of min value, %g, can not be greater than the real-portion of max value, %g. -psImageManip_MAXMIN_IMAG Specified imaginary-portion of min value, %g, can not be greater than the imaginary-portion of max value, %g. -psImageManip_OPERATION_NULL Operation can not be NULL. -psImageManip_OVERLAY_TYPE_MISMATCH Input overlay psImage type, %s, must match input psImage type, %s. -psImageManip_CLIP_VALUE_INVALID Specified %s value, %g%+gi, is not the the range of input psImage's valid pixel values (%s), i.e. [%g:%g]. -psImageManip_OVERLAY_OPERATOR_INVALID Specified operation, '%s', is not supported. -psImageManip_SCALE_NOT_POSITIVE Specified scale value, %d, must be a positive value. -psImageManip_INTERPOLATION_MODE_UNSUPPORTED Specified interpolation mode, %d, is unsupported. -psImageConvolve_SHIFT_NULL Specified shift vectors can not be NULL. -psImageConvolve_KERNEL_NULL Specified psKernel can not be NULL. -psImageConvolve_SHIFT_TYPE_MISMATCH Input t-, x-, and y-shift vector types (%s/%s/%s) must match. -psImageConvolve_FFT_FAILED Failed to perform a fourier transform of input image. -psImageConvolve_KERNEL_FFT_FAILED Failed to perform a fourier transform of kernel. -psImageConvolve_KERNEL_TOO_LARGE Specified psKernel size, %dx%d, can not be larger than input psImage size, %dx%d. -psImage_COEFF_NULL Polynomial coefficients cannot be NULL. -psImageManip_TRANSFORM_NULL Specified input transform can not be NULL. Index: unk/psLib/src/image/psImageErrors.h =================================================================== --- /trunk/psLib/src/image/psImageErrors.h (revision 4545) +++ (revision ) @@ -1,101 +1,0 @@ -/** @file psImageErrors.h - * - * @brief Contains the error text for the image functions - * - * @ingroup ErrorHandling - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_IMAGE_ERRORS_H -#define PS_IMAGE_ERRORS_H - -/* N.B., lines between '//~Start' and '//~End' are automatic generated from - * the template following the '//~Start'. The template is used to generate - * the other lines by, for each error text in psImageErrors.dat, the following - * substitutions are made: - * $1 The error text macro name (first word in the psImageErrors.dat lines) - * $2 The error text (rest of the line in psImageErrors.dat) - * $n The order of the source line in psImageErrors.dat (comments excluded) - * - * DO NOT EDIT THE LINES BETWEEN //~Start and //~End! ANY CHANGES WILL BE OVERWRITTEN. - */ - -//~Start #define PS_ERRORTEXT_$1 "$2" -#define PS_ERRORTEXT_psImage_AREA_NEGATIVE "Specified number of rows (%d) or columns (%d) is invalid." -#define PS_ERRORTEXT_psImage_NOT_AN_IMAGE "The input psImage must have a PS_DIMEN_IMAGE dimension type." -#define PS_ERRORTEXT_psImage_IMAGE_NULL "Can not operate on a NULL psImage." -#define PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED "Specified psImage type, %s, is not supported." -#define PS_ERRORTEXT_psImage_INTERPOLATE_METHOD_INVALID "Specified interpolation method (%d) is not supported." -#define PS_ERRORTEXT_psImage_REGION_NULL "Specified psRegion is NULL. Operation could not be performed." -#define PS_ERRORTEXT_psImage_SUBSET_RANGE_INVALID "Specified subset range, [%d:%d,%d:%d], is invalid or outside input psImage's boundaries, [0:%d,0:%d]." -#define PS_ERRORTEXT_psImage_SUBSET_RANGE_MALFORMED "Specified subset range, [%d:%d,%d:%d], is invalid. Ranges must be incremental." -#define PS_ERRORTEXT_psImage_SUBSECTION_NULL "Specified subsection string can not be NULL." -#define PS_ERRORTEXT_psImage_SUBSECTION_INVALID "Specified subsection string, '%s', can not be parsed. Must be in the form '[x1:x2,y1:y2]'." -#define PS_ERRORTEXT_psImage_NOT_PARENT "Specified psImage can not be a child of another psImage." -#define PS_ERRORTEXT_psImage_INPLACE_NOTSUPPORTED "Specified input and output psImage can not reference the same psImage." -#define PS_ERRORTEXT_psImage_SUBSET_ZERO_SIZE "Specified subset, [%d:%d,%d:%d], contains no pixel data." -#define PS_ERRORTEXT_psImage_IMAGE_MASK_SIZE "Input psImage mask size, %dx%d, does not match psImage input size, %dx%d." -#define PS_ERRORTEXT_psImage_IMAGE_MASK_TYPE "Input psImage mask type, %s, is not the supported mask datatype of %s." -#define PS_ERRORTEXT_psImage_BAD_STAT "Specified statistic option, %d, is not valid. Must specify one and only one statistic type." -#define PS_ERRORTEXT_psImage_NO_STAT_OPTIONS "Specified statistic option did not indicate any operation to perform." -#define PS_ERRORTEXT_psImage_STAT_NULL "Specified statistic can not be NULL." -#define PS_ERRORTEXT_psImage_SLICE_DIRECTION_INVALID "Specified slice direction, %d, is invalid." -#define PS_ERRORTEXT_psImage_PARAMETER_OUTOF_TYPERANGE "Specified %s value, %g, is outside of psImage type's range (%s: %g to %g)." -#define PS_ERRORTEXT_psImage_nSamples_TOOSMALL "Specified number of samples, %d, must be greater than 1 to make a line." -#define PS_ERRORTEXT_psImage_LINE_NOT_IN_IMAGE "Specified line, (%f,%f)->(%f,%f), does not entirely lie in psImage's boundaries, [0:%d,0:%d]." -#define PS_ERRORTEXT_psImage_RADII_VECTOR_NULL "Specified radii vector can not be NULL." -#define PS_ERRORTEXT_psImage_CENTER_NOT_IN_IMAGE "Specified center, (%g,%g), is outside of the psImage boundaries, [0:%d,0:%d]." -#define PS_ERRORTEXT_psImage_RADII_VECTOR_TOOSMALL "Input radii vector size, %d, can not be less than 2." -#define PS_ERRORTEXT_psImageFFT_IMAGE_TYPE_UNSUPPORTED "Input psImage type (%s) is not supported. Valid image types are psF32 and psC32." -#define PS_ERRORTEXT_psImageFFT_REVERSE_NOT_COMPLEX "Input psImage (%s) is not complex. Reverse FFT operation requires a complex psImage input." -#define PS_ERRORTEXT_psImageFFT_FORWARD_NOT_REAL "Input psImage (%s) is not real. Forward FFT operation requires a real psImage input." -#define PS_ERRORTEXT_psImageFFT_FFTW_PLAN_NULL "Could not create a valid FFT plan to perform the transform." -#define PS_ERRORTEXT_psImageFFT_REAL_IMAG_TYPE_MISMATCH "Real psImage type (%s) and imaginary psImage type (%s) must be the same." -#define PS_ERRORTEXT_psImageFFT_REAL_IMAG_SIZE_MISMATCH "Real psImage size (%dx%d) and imaginary psImage size (%dx%d) must be the same." -#define PS_ERRORTEXT_psImageFFT_NONREAL_NOTSUPPORTED "Input psImage type, %s, is required to be either psF32 or psF64." -#define PS_ERRORTEXT_psImageFFT_NONCOMPLEX_NOTSUPPORTED "Input psImage type, %s, is required to be either psC32 or psC64." -#define PS_ERRORTEXT_psImageFFT_REAL_FORWARD_NOTSUPPORTED "The PS_FFT_FORWARD and PS_FFT_REAL_RESULT combinition is not supported." -#define PS_ERRORTEXT_psImageFFT_FORWARD_REVERSE "Can not specify both PS_FFT_FORWARD and PS_FFT_REVERSE options." -#define PS_ERRORTEXT_psImageFFT_NO_DIRECTION_OPTION "Must specify either PS_FFT_FORWARD or PS_FFT_REVERSE option." -#define PS_ERRORTEXT_psImageIO_FILENAME_NULL "Specified filename can not be NULL." -#define PS_ERRORTEXT_psImageIO_FILENAME_INVALID "Could not open file,'%s'.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageIO_EXTNAME_INVALID "Could not find HDU with extension name '%s' in file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageIO_EXTNUM_INVALID "Could not find HDU #%d in file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageIO_DATATYPE_UNKNOWN "Could not determine image data type for file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageIO_IMAGE_DIM_UNKNOWN "Could not determine image dimensions for file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageIO_IMAGE_SIZE_UNKNOWN "Could not determine image size for file %s.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageIO_IMAGE_DIMENSION_UNSUPPORTED "Image number of dimensions, %d, is not valid. Only two or three dimensions supported for FITS I/O." -#define PS_ERRORTEXT_psImageIO_FITS_TYPE_UNSUPPORTED "FITS image type, BITPIX=%d, in file %s is not supported." -#define PS_ERRORTEXT_psImageIO_READ_FAILED "Reading from FITS file %s failed.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageIO_TYPE_UNSUPPORTED "Input psImage type, %s, is not supported." -#define PS_ERRORTEXT_psImageIO_WRITE_EXTNUM_INVALID "Specified extension number, %d, must not exceed number of HDUs, %d, by more than one." -#define PS_ERRORTEXT_psImageIO_FILENAME_CREATE_FAILED "Could not create file,'%s'.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageIO_CREATE_EXTENSION_FAILED "Could not create EXTNAME keyword for file,'%s'.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageIO_CREATE_HDU_FAILED "Could not create HDU for writing psImage in file,'%s'.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageIO_WRITE_FAILED "Could not write psImage data to file,'%s'.\nCFITSIO Error: %s" -#define PS_ERRORTEXT_psImageManip_MAXMIN "Specified min value, %g, can not be greater than the specified max value, %g." -#define PS_ERRORTEXT_psImageManip_MAXMIN_REAL "Specified real-portion of min value, %g, can not be greater than the real-portion of max value, %g." -#define PS_ERRORTEXT_psImageManip_MAXMIN_IMAG "Specified imaginary-portion of min value, %g, can not be greater than the imaginary-portion of max value, %g." -#define PS_ERRORTEXT_psImageManip_OPERATION_NULL "Operation can not be NULL." -#define PS_ERRORTEXT_psImageManip_OVERLAY_TYPE_MISMATCH "Input overlay psImage type, %s, must match input psImage type, %s." -#define PS_ERRORTEXT_psImageManip_CLIP_VALUE_INVALID "Specified %s value, %g%+gi, is not the the range of input psImage's valid pixel values (%s), i.e. [%g:%g]." -#define PS_ERRORTEXT_psImageManip_OVERLAY_OPERATOR_INVALID "Specified operation, '%s', is not supported." -#define PS_ERRORTEXT_psImageManip_SCALE_NOT_POSITIVE "Specified scale value, %d, must be a positive value." -#define PS_ERRORTEXT_psImageManip_INTERPOLATION_MODE_UNSUPPORTED "Specified interpolation mode, %d, is unsupported." -#define PS_ERRORTEXT_psImageConvolve_SHIFT_NULL "Specified shift vectors can not be NULL." -#define PS_ERRORTEXT_psImageConvolve_KERNEL_NULL "Specified psKernel can not be NULL." -#define PS_ERRORTEXT_psImageConvolve_SHIFT_TYPE_MISMATCH "Input t-, x-, and y-shift vector types (%s/%s/%s) must match." -#define PS_ERRORTEXT_psImageConvolve_FFT_FAILED "Failed to perform a fourier transform of input image." -#define PS_ERRORTEXT_psImageConvolve_KERNEL_FFT_FAILED "Failed to perform a fourier transform of kernel." -#define PS_ERRORTEXT_psImageConvolve_KERNEL_TOO_LARGE "Specified psKernel size, %dx%d, can not be larger than input psImage size, %dx%d." -#define PS_ERRORTEXT_psImage_COEFF_NULL "Polynomial coefficients cannot be NULL." -#define PS_ERRORTEXT_psImageManip_TRANSFORM_NULL "Specified input transform can not be NULL" -//~End - -#endif // #ifndef PS_IMAGE_ERRORS_H Index: unk/psLib/src/image/psImageFFT.c =================================================================== --- /trunk/psLib/src/image/psImageFFT.c (revision 4545) +++ (revision ) @@ -1,456 +1,0 @@ -/** @file psImageFFT.c - * - * @brief Contains FFT transform related functions for psImage. - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-18 03:13:02 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ -#include -#include -#include -#include - -#include "psImageFFT.h" -#include "psError.h" -#include "psMemory.h" -#include "psLogMsg.h" -#include "psImageStructManip.h" - -#include "psImageErrors.h" - -#define PS_FFTW_PLAN_RIGOR FFTW_ESTIMATE - -static psBool p_fftwWisdomImported = false; - -psImage* psImageFFT(psImage* out, const psImage* image, psFFTFlags direction) -{ - psU32 numCols; - psU32 numRows; - psElemType type; - fftwf_plan plan; - - /* got good image data? */ - if (image == NULL) { - psFree(out); - return NULL; - } - - if ( ((direction & PS_FFT_FORWARD) != 0) ) { - if ((direction & PS_FFT_REVERSE) != 0) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageFFT_FORWARD_REVERSE); - psFree(out); - return NULL; - } - if ((direction & PS_FFT_REAL_RESULT) != 0) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageFFT_REAL_FORWARD_NOTSUPPORTED); - psFree(out); - return NULL; - } - } else if ((direction & PS_FFT_REVERSE) == 0) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageFFT_NO_DIRECTION_OPTION); - psFree(out); - return NULL; - } - - type = image->type.type; - - /* make sure the system-level wisdom information is imported. */ - if (!p_fftwWisdomImported) { - fftwf_import_system_wisdom(); - p_fftwWisdomImported = true; - } - - numRows = image->numRows; - numCols = image->numCols; - - // n.b. FFTW can perform a in-place transform at the same rate or faster than out-of-place. - psS32 sign = ((direction & PS_FFT_FORWARD) != 0) ? FFTW_FORWARD : FFTW_BACKWARD; - - fftwf_complex* outBuffer = fftwf_malloc(numRows*numCols*sizeof(fftwf_complex)); - p_psImageCopyToRawBuffer(outBuffer, image, PS_TYPE_C32); - - plan = fftwf_plan_dft_2d(numRows, numCols, - outBuffer, - outBuffer, - sign, - PS_FFTW_PLAN_RIGOR); - - /* check if a plan exists now -- if not, it is a real problem at this point */ - if (plan == NULL) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImageFFT_FFTW_PLAN_NULL); - psFree(out); - return NULL; - } - - /* finally, call FFTW with the plan made above */ - fftwf_execute(plan); - - fftwf_destroy_plan(plan); - - if (direction & PS_FFT_REAL_RESULT) { - // n.b., we do this instead of using fftwf_plan_dft_c2r because that - // plan requires a half-image, which would require a image reordering - // that is not as simple as performing a normal complex transform and - // then taking the real part of the result. If performance here - // becomes an issue, the use of fftwf_plan_dft_r2c should be considered - // as well as fftwf_plan_dft_c2r. - out = psImageRecycle(out,numCols,numRows,PS_TYPE_F32); - int index = 0; - for (int row=0; row < numRows; row++) { - psF32* outRow = out->data.F32[row]; - for (int col=0; col < numCols; col++) { - outRow[col] = crealf(outBuffer[index++]); // take just the real part - } - } - } else { - out = psImageRecycle(out,numCols,numRows,PS_TYPE_C32); - int index = 0; - for (int row=0; row < numRows; row++) { - psC32* outRow = out->data.C32[row]; - for (int col=0; col < numCols; col++) { - outRow[col] = outBuffer[index++]; // take just the real part - } - } - // memcpy(out->rawDataBuffer, outBuffer, numRows*numCols*sizeof(fftwf_complex)); - } - - fftwf_free(outBuffer); - - return out; - -} - -psImage* psImageReal(psImage* out, const psImage* in) -{ - psElemType type; - psU32 numCols; - psU32 numRows; - - if (in == NULL) { - psFree(out); - return NULL; - } - - type = in->type.type; - numCols = in->numCols; - numRows = in->numRows; - - /* if not a complex number, this is logically just a copy then */ - if (!PS_IS_PSELEMTYPE_COMPLEX(type)) { - return psImageCopy(out, in, type); - } - - if (type == PS_TYPE_C32) { - psF32* outRow; - psC32* inRow; - - out = psImageRecycle(out, numCols, numRows, PS_TYPE_F32); - for (psU32 row = 0; row < numRows; row++) { - outRow = out->data.F32[row]; - inRow = in->data.C32[row]; - - for (psU32 col = 0; col < numCols; col++) { - outRow[col] = crealf(inRow[col]); - } - } - } else if (type == PS_TYPE_C64) { - psF64* outRow; - psC64* inRow; - - out = psImageRecycle(out, numCols, numRows, PS_TYPE_F64); - for (psU32 row = 0; row < numRows; row++) { - outRow = out->data.F64[row]; - inRow = in->data.C64[row]; - - for (psU32 col = 0; col < numCols; col++) { - outRow[col] = creal(inRow[col]); - } - } - } else { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - - psFree(out); - return NULL; - } - - return out; -} - -psImage* psImageImaginary(psImage* out, const psImage* in) -{ - psElemType type; - psU32 numCols; - psU32 numRows; - - if (in == NULL) { - psFree(out); - return NULL; - } - - type = in->type.type; - numCols = in->numCols; - numRows = in->numRows; - - /* if not a complex image type, this is logically just zeroed image of same size */ - if (!PS_IS_PSELEMTYPE_COMPLEX(type)) { - out = psImageRecycle(out, numCols, numRows, type); - memset(out->data.V[0], 0, PSELEMTYPE_SIZEOF(type) * numCols * numRows); - return out; - } - - if (type == PS_TYPE_C32) { - psF32* outRow; - psC32* inRow; - - out = psImageRecycle(out, numCols, numRows, PS_TYPE_F32); - for (psU32 row = 0; row < numRows; row++) { - outRow = out->data.F32[row]; - inRow = in->data.C32[row]; - - for (psU32 col = 0; col < numCols; col++) { - outRow[col] = cimagf(inRow[col]); - } - } - } else if (type == PS_TYPE_C64) { - psF64* outRow; - psC64* inRow; - - out = psImageRecycle(out, numCols, numRows, PS_TYPE_F64); - for (psU32 row = 0; row < numRows; row++) { - outRow = out->data.F64[row]; - inRow = in->data.C64[row]; - - for (psU32 col = 0; col < numCols; col++) { - outRow[col] = cimag(inRow[col]); - } - } - } else { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - psFree(out); - return NULL; - } - - return out; -} - -psImage* psImageComplex(psImage* out, const psImage* real, const psImage* imag) -{ - psElemType type; - psU32 numCols; - psU32 numRows; - - if (real == NULL || imag == NULL) { - psFree(out); - return NULL; - } - - type = real->type.type; - numCols = real->numCols; - numRows = real->numRows; - - if (imag->type.type != type) { - char* typeStrReal; - char* typeStrImag; - PS_TYPE_NAME(typeStrReal,type); - PS_TYPE_NAME(typeStrImag,imag->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImageFFT_REAL_IMAG_TYPE_MISMATCH, - typeStrReal,typeStrImag); - psFree(out); - return NULL; - } - - if (imag->numCols != numCols || imag->numRows != numRows) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageFFT_REAL_IMAG_SIZE_MISMATCH, - numCols, numRows, imag->numCols, imag->numRows); - psFree(out); - return NULL; - } - - if (type == PS_TYPE_F32) { - psC32* outRow; - psF32* realRow; - psF32* imagRow; - - out = psImageRecycle(out, numCols, numRows, PS_TYPE_C32); - - for (psU32 row = 0; row < numRows; row++) { - outRow = out->data.C32[row]; - realRow = real->data.F32[row]; - imagRow = imag->data.F32[row]; - - for (psU32 col = 0; col < numCols; col++) { - outRow[col] = realRow[col] + I * imagRow[col]; - } - } - } else if (type == PS_TYPE_F64) { - psC64* outRow; - psF64* realRow; - psF64* imagRow; - - out = psImageRecycle(out, numCols, numRows, PS_TYPE_C64); - for (psU32 row = 0; row < numRows; row++) { - outRow = out->data.C64[row]; - realRow = real->data.F64[row]; - imagRow = imag->data.F64[row]; - - for (psU32 col = 0; col < numCols; col++) { - outRow[col] = realRow[col] + I * imagRow[col]; - } - } - } else { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImageFFT_NONREAL_NOTSUPPORTED, - typeStr); - psFree(out); - return NULL; - } - - - return out; -} - -psImage* psImageConjugate(psImage* out, const psImage* in) -{ - psElemType type; - psU32 numCols; - psU32 numRows; - - if (in == NULL) { - psFree(out); - return NULL; - } - - type = in->type.type; - numCols = in->numCols; - numRows = in->numRows; - - /* if not a complex image, this is logically just a image copy */ - if (!PS_IS_PSELEMTYPE_COMPLEX(type)) { - return psImageCopy(out, in, type); - } - - if (type == PS_TYPE_C32) { - psC32* outRow; - psC32* inRow; - - out = psImageRecycle(out, numCols, numRows, PS_TYPE_C32); - for (psU32 row = 0; row < numRows; row++) { - outRow = out->data.C32[row]; - inRow = in->data.C32[row]; - - for (psU32 col = 0; col < numCols; col++) { - outRow[col] = crealf(inRow[col]) - I * cimagf(inRow[col]); - } - } - } else if (type == PS_TYPE_C64) { - psC64* outRow; - psC64* inRow; - - out = psImageRecycle(out, numCols, numRows, PS_TYPE_C64); - for (psU32 row = 0; row < numRows; row++) { - outRow = out->data.C64[row]; - inRow = in->data.C64[row]; - - for (psU32 col = 0; col < numCols; col++) { - outRow[col] = creal(inRow[col]) - I * cimag(inRow[col]); - } - } - } else { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImageFFT_NONCOMPLEX_NOTSUPPORTED, - typeStr); - psFree(out); - return NULL; - } - - return out; -} - -psImage* psImagePowerSpectrum(psImage* out, const psImage* in) -{ - psElemType type; - psU32 numCols; - psU32 numRows; - - if (in == NULL) { - psFree(out); - return NULL; - } - - type = in->type.type; - numCols = in->numCols; - numRows = in->numRows; - - if (type == PS_TYPE_C32) { - psF32* outRow; - psC32* inRow; - psF32 real; - psF32 imag; - psF32 fNumCols = numCols; - psF32 fNumRows = numRows; - psF32 numElementsSquared = fNumCols * fNumCols * fNumRows * fNumRows; - - out = psImageRecycle(out, numCols, numRows, PS_TYPE_F32); - for (psU32 row = 0; row < numRows; row++) { - outRow = out->data.F32[row]; - inRow = in->data.C32[row]; - - for (psU32 col = 0; col < numCols; col++) { - real = crealf(inRow[col]); - imag = cimagf(inRow[col]); - outRow[col] = (real * real + imag * imag) / numElementsSquared; - } - } - } else if (type == PS_TYPE_C64) { - psF64* outRow; - psC64* inRow; - psF64 real; - psF64 imag; - psF64 numElementsSquared = numCols * numCols * numRows * numRows; - - out = psImageRecycle(out, numCols, numRows, PS_TYPE_F64); - for (psU32 row = 0; row < numRows; row++) { - outRow = out->data.F64[row]; - inRow = in->data.C64[row]; - - for (psU32 col = 0; col < numCols; col++) { - real = creal(inRow[col]); - imag = cimag(inRow[col]); - outRow[col] = (real * real + imag * imag) / numElementsSquared; - } - } - } else { - char* typeStr; - PS_TYPE_NAME(typeStr,type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImageFFT_NONCOMPLEX_NOTSUPPORTED, - typeStr); - psFree(out); - return NULL; - } - - return out; - -} Index: unk/psLib/src/image/psImageFFT.h =================================================================== --- /trunk/psLib/src/image/psImageFFT.h (revision 4545) +++ (revision ) @@ -1,87 +1,0 @@ -/** @file psImageFFT.h - * - * @brief Contains FFT transform related functions for psImage - * - * @ingroup Transform - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_IMAGE_FFT_H -#define PS_IMAGE_FFT_H - -#include "psImage.h" -#include "psVectorFFT.h" // for psFFTFlags - -/// @addtogroup Transform -/// @{ - -/** Forward and reverse FFT calculations. - * - * This takes as input the image of interest (in) and the direction - * (direction), which is specified by an enumerated type psFftDirection. - * The input image may be of type psF32 or psC32, the result is always - * psC32. If the input vector is psF32, the direction must be forward. - * - * @return psImage* the FFT transformation result - */ -psImage* psImageFFT( - psImage* out, ///< a psImage to recycle. If NULL, a new psImage is made. - const psImage* image, ///< the psImage to apply transform to - psFFTFlags direction ///< the direction of the transform -); - -/** extract the real portion of a complex image - * - * @return psImage* real portion of the input image. - */ -psImage* psImageReal( - psImage* out, ///< a psImage to recycle. If NULL, a new psImage is made. - const psImage* in ///< the psImage to extract real portion from -); - -/** extract the imaginary portion of a complex image - * - * @return psImage* imaginary portion of the input image. - */ -psImage* psImageImaginary( - psImage* out, ///< a psImage to recycle. If NULL, a new psImage is made. - const psImage* in ///< the psImage to extract imaginary portion from -); - -/** creates a complex image from separate real and imaginary plane images - * - * @return psImage* resulting complex image - */ -psImage* psImageComplex( - psImage* out, ///< a psImage to recycle. If NULL, a new psImage is made. - const psImage* real, ///< the real plane image - const psImage* imag ///< the imaginary plane image -); - -/** computes the complex conjugate of an image - * - * @return psImage* the complex conjugate of the 'in' image - */ -psImage* psImageConjugate( - psImage* out, ///< a psImage to recycle. If NULL, a new psImage is made. - const psImage* in ///< the psImage to compute conjugate of -); - -/** computes the power spectrum of an image - * - * @return psImage* the power spectrum of the 'in' image - */ -psImage* psImagePowerSpectrum( - psImage* out, ///< a psImage to recycle. If NULL, a new psImage is made. - const psImage* in ///< the psImage to power spectrum of -); - -/// @} - -#endif // #ifndef PS_IMAGE_FFT_H Index: unk/psLib/src/image/psImageGeomManip.c =================================================================== --- /trunk/psLib/src/image/psImageGeomManip.c (revision 4545) +++ (revision ) @@ -1,871 +1,0 @@ -/** @file psImageGeomManip.c - * - * @brief Contains basic image pixel and geometry manipulation operations, as - * specified in the PSLIB SDRS sections "Image Pixel Manipulations" and - * "Image Geometry Manipulations". - * - * @ingroup Image - * - * @author Robert DeSonia, MHPCC - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include // for isfinite(), etc. -#include -#include // for memcpy, etc. - -#include "psImageGeomManip.h" - -#include "psError.h" -#include "psImage.h" -#include "psImageStructManip.h" -#include "psStats.h" -#include "psMemory.h" -#include "psConstants.h" -#include "psImageErrors.h" -#include "psCoord.h" - -psImage* psImageRebin(psImage* out, - const psImage* in, - const psImage* restrict mask, - psMaskType maskVal, - int scale, - const psStats* stats) -{ - psS32 inRows; - psS32 inCols; - psS32 outRows; - psS32 outCols; - psVector* vec; // vector to hold the values of a single bin. - psVector* maskVec = NULL; // vector to hold the mask of a single bin. - psMaskType* maskData = NULL; - psStats* myStats; - double statVal; - - if (in == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - psFree(out); - return NULL; - } - - if (scale < 1) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageManip_SCALE_NOT_POSITIVE, - scale); - psFree(out); - return NULL; - } - - if (stats == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_STAT_NULL); - psFree(out); - return NULL; - } - - if (p_psGetStatValue(stats, &statVal) == false) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_BAD_STAT, - stats->options); - psFree(out); - return NULL; - } - - vec = psVectorAlloc(scale * scale, in->type.type); - - if (mask != NULL) { - if (mask->type.type != PS_TYPE_MASK) { - char* typeStr; - PS_TYPE_NAME(typeStr,mask->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_MASK_TYPE, - typeStr, PS_TYPE_MASK_NAME); - psFree(out); - psFree(vec); - return NULL; - } - maskVec = psVectorAlloc(scale * scale, PS_TYPE_MASK); - maskData = maskVec->data.PS_TYPE_MASK_DATA; - } - - myStats = psAlloc(sizeof(psStats)); - *myStats = *stats; - - // create output image. - inRows = in->numRows; - inCols = in->numCols; - outRows = (inRows + scale - 1) / scale; // round-up for remainders - outCols = (inCols + scale - 1) / scale; // round-up for remainders - out = psImageRecycle(out, outCols, outRows, in->type.type); - - #define PS_IMAGE_REBIN_CASE(type) \ -case PS_TYPE_##type: { \ - ps##type* outRowData; \ - ps##type* vecData = vec->data.type; \ - psMaskType* inRowMask = NULL; \ - for (psS32 row = 0; row < outRows; row++) { \ - outRowData = out->data.type[row]; \ - psS32 inCurrentRow = row*scale; \ - psS32 inNextRow = (row+1)*scale; \ - for (psS32 col = 0; col < outCols; col++) { \ - psS32 inCurrentCol = col*scale; \ - psS32 inNextCol = (col+1)*scale; \ - psS32 n = 0; \ - for (psS32 inRow = inCurrentRow; inRow < inNextRow && inRow < inRows; inRow++) { \ - ps##type* inRowData = in->data.type[inRow]; \ - if (mask != NULL) { \ - inRowMask = mask->data.PS_TYPE_MASK_DATA[inRow]; \ - } \ - for (psS32 inCol = inCurrentCol; inCol < inNextCol && inCol < inCols; inCol++) { \ - if (maskData != NULL) { \ - maskData[n] = inRowMask[inCol]; \ - } \ - vecData[n++] = inRowData[inCol]; \ - } \ - } \ - vec->n = n; \ - myStats = psVectorStats(myStats,vec,NULL,maskVec,maskVal); \ - p_psGetStatValue(myStats,&statVal); \ - outRowData[col] = (ps##type)statVal; \ - } \ - } \ - } \ - break; - - switch (in->type.type) { - // PS_IMAGE_REBIN_CASE(U8); Not valid since psVectorStats doesn't allow - PS_IMAGE_REBIN_CASE(U16); - PS_IMAGE_REBIN_CASE(U32); // Not a requirement - PS_IMAGE_REBIN_CASE(U64); // Not a requirement - PS_IMAGE_REBIN_CASE(S8); - // PS_IMAGE_REBIN_CASE(S16); Not valid since psVectorStats doesn't allow - PS_IMAGE_REBIN_CASE(S32); // Not a requirement - PS_IMAGE_REBIN_CASE(S64); // Not a requirement - PS_IMAGE_REBIN_CASE(F32); - PS_IMAGE_REBIN_CASE(F64); - // PS_IMAGE_REBIN_CASE(C32); Not valid since psVectorStats doesn't allow - // PS_IMAGE_REBIN_CASE(C64); Not valid since psVectorStats doesn't allow - - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,in->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - psFree(out); - out = NULL; - } - } - - psFree(vec); - psFree(maskVec); - psFree(myStats); - - return out; -} - -psImage* psImageResample(psImage* out, - const psImage* in, - int scale, - psImageInterpolateMode mode) -{ - psS32 outRows; - psS32 outCols; - float invScale; - - if (in == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - psFree(out); - return NULL; - } - - if (scale < 1) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageManip_SCALE_NOT_POSITIVE, - scale); - psFree(out); - return NULL; - } - - if (mode > PS_INTERPOLATE_LANCZOS4_VARIANCE ) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageManip_INTERPOLATION_MODE_UNSUPPORTED, - mode); - psFree(out); - return NULL; - } - - // create an output image of the same size - // and type - outRows = in->numRows * scale; - outCols = in->numCols * scale; - invScale = 1.0f / (float)scale; - - #define PSIMAGE_RESAMPLE_CASE(TYPE) \ -case PS_TYPE_##TYPE: { \ - out = psImageRecycle(out,outCols, outRows, PS_TYPE_##TYPE); \ - for (psS32 row=0;rowdata.TYPE[row]; \ - float inRow = (float)row * invScale; \ - for (psS32 col=0;coltype.type) { - PSIMAGE_RESAMPLE_CASE(U8) - PSIMAGE_RESAMPLE_CASE(U16) - PSIMAGE_RESAMPLE_CASE(U32) - PSIMAGE_RESAMPLE_CASE(U64) - PSIMAGE_RESAMPLE_CASE(S8) - PSIMAGE_RESAMPLE_CASE(S16) - PSIMAGE_RESAMPLE_CASE(S32) - PSIMAGE_RESAMPLE_CASE(S64) - PSIMAGE_RESAMPLE_CASE(F32) - PSIMAGE_RESAMPLE_CASE(F64) - PSIMAGE_RESAMPLE_CASE(C32) - PSIMAGE_RESAMPLE_CASE(C64) - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,in->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - psFree(out); - out = NULL; - } - } - - return out; -} - -psImage* psImageRoll(psImage* out, - const psImage* input, - int dx, - int dy) -{ - psS32 outRows; - psS32 outCols; - psS32 elementSize; - - if (input == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - psFree(out); - return NULL; - } - // create an output image of the same size - // and type - outRows = input->numRows; - outCols = input->numCols; - elementSize = PSELEMTYPE_SIZEOF(input->type.type); - out = psImageRecycle(out, outCols, outRows, input->type.type); - - // make dx and dy between 0 and outCols or - // outRows, respectively - dx = dx % outCols; - dy = dy % outRows; - if (dx < 0) { - dx += outCols; - } - if (dy < 0) { - dy += outRows; - } - - psS32 segment1Size = elementSize * (outCols - dx); - psS32 segment2Size = elementSize * dx; - - for (psS32 row = 0; row < outRows; row++) { - psS32 inRowNumber = row + dy; - - if (inRowNumber >= outRows) { - inRowNumber -= outRows; - } - psU8* inRow = input->data.U8[inRowNumber]; // use byte arithmetic for all types - psU8* outRow = out->data.U8[row]; - - memcpy(outRow, inRow + segment2Size, segment1Size); - memcpy(outRow + segment1Size, inRow, segment2Size); - } - - return out; -} - -psImage* psImageRotate(psImage* out, - const psImage* input, - float angle, - complex exposed, - psImageInterpolateMode mode) -{ - if (input == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - psFree(out); - return NULL; - } - // put the angle in the range of 0...2PI. - angle = (float)((double)angle - (2.0*M_PI) * floor(angle / (2.0*M_PI))); - - if (fabsf(angle - M_PI_2) < FLT_EPSILON) { - // perform 1/4 rotate counter-clockwise - psS32 numRows = input->numCols; - psS32 numCols = input->numRows; - psS32 lastCol = numCols - 1; - psElemType type = input->type.type; - - out = psImageRecycle(out, numCols, numRows, type); - - #define PSIMAGE_ROTATE_LEFT_90(TYPE) \ - case PS_TYPE_##TYPE: { \ - ps##TYPE** inData = input->data.TYPE; \ - for (psS32 row=0;rowdata.TYPE[row]; \ - for (psS32 col=0;colnumRows; - psS32 lastRow = numRows - 1; - psS32 numCols = input->numCols; - psS32 lastCol = numCols - 1; - psElemType type = input->type.type; - - out = psImageRecycle(out, numCols, numRows, type); - - #define PSIMAGE_ROTATE_180_CASE(TYPE) \ - case PS_TYPE_##TYPE: { \ - for (psS32 row=0;rowdata.TYPE[row]; \ - ps##TYPE* inRow = input->data.TYPE[lastRow-row]; \ - for (psS32 col=0;colnumCols; - psS32 lastRow = numRows - 1; - psS32 numCols = input->numRows; - psElemType type = input->type.type; - - out = psImageRecycle(out, numCols, numRows, type); - - #define PSIMAGE_ROTATE_RIGHT_90(TYPE) \ - case PS_TYPE_##TYPE: { \ - ps##TYPE** inData = input->data.TYPE; \ - for (psS32 row=0;rowdata.TYPE[row]; \ - for (psS32 col=0;coltype.type); - } else { - psElemType type = input->type.type; - psS32 numRows = input->numRows; - psS32 numCols = input->numCols; - float centerX = (float)(numCols) / 2.0f; - float centerY = (float)(numRows) / 2.0f; - double cosT = cosf(angle); - double sinT = sinf(angle); - - // calculate the corners of the rotated image so we know the proper output image size. - // x' = x cos(t) + y sin(t); i.e, x' = (x-centerX)*cosT + (y-centerY)*sinT; - // y' = y cos(t) - x sin(t); i.e. y' = (y-centerY)*cosT - (x-centerX)*sinT; - - psS32 outCols = ceil(abs(numCols * cosT) + abs(numRows * sinT)) + 1; - psS32 outRows = ceil(abs(numCols * sinT) + abs(numRows * cosT)) + 1; - float minX = (float)outCols / -2.0f; - psS32 intMinY = outRows / -2; - - out = psImageRecycle(out, outCols, outRows, type); - - /* optimized public domain rotation routine by Karl Lager - * - * float cosT,sinT; - * cosT = cos(t); - * sinT = sin(t); - * for (y = min_y; y <= max_y; y++) { - * x' = min_x * cosT + y * sinT + x1'; - * y' = y * cosT - min_x * sinT + y1'; - * for (x = min_x; x <= max_x; x++) { - * if (x', y') is in the bounds of the bitmap, get pixel - * (x', y') and plot the pixel to (x, y) on screen. - * x' += cosT; - * y' -= sinT; - * } - * } - */ - - // precalculate some figures that are used within loop - float minXTimesCosTPlusCenterX = minX * cosT + centerX; - float CenterYMinusminXTimesSinT = centerY - minX * sinT; - - #define PSIMAGE_ROTATE_ARBITRARY_LOOP(TYPE,MODE) { \ - if (creal(exposed) < PS_MIN_##TYPE || \ - creal(exposed) > PS_MAX_##TYPE || \ - cimag(exposed) < PS_MIN_##TYPE || \ - cimag(exposed) > PS_MAX_##TYPE) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - PS_ERRORTEXT_psImageManip_CLIP_VALUE_INVALID, \ - "exposed", \ - creal(exposed),cimag(exposed), \ - PS_TYPE_##TYPE##_NAME, \ - (double)PS_MIN_##TYPE,(double)PS_MAX_##TYPE); \ - psFree(out); \ - out = NULL; \ - break; \ - } \ - float inX; \ - float inY; \ - ps##TYPE* outRow; \ - for (psS32 y = 0; y < outRows; y++) { \ - inX = minXTimesCosTPlusCenterX + (y+intMinY) * sinT; \ - inY = CenterYMinusminXTimesSinT + (y+intMinY) * cosT; \ - outRow = out->data.TYPE[y]; \ - for (psS32 x = 0; x < outCols; x++) { \ - outRow[x] = p_psImagePixelInterpolate##MODE##_##TYPE(input,inX,inY,NULL,0,exposed); \ - inX += cosT; \ - inY -= sinT; \ - } \ - } \ - } - - #define PSIMAGE_ROTATE_ARBITRARY_CASE(MODE) \ - case PS_INTERPOLATE_##MODE: \ - switch (type) { \ - case PS_TYPE_U8: \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(U8,MODE); \ - break; \ - case PS_TYPE_U16: \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(U16,MODE); \ - break; \ - case PS_TYPE_U32: /* Not a requirement */ \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(U32,MODE); \ - break; \ - case PS_TYPE_U64: /* Not a requirement */ \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(U64,MODE); \ - break; \ - case PS_TYPE_S8: \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(S8,MODE); \ - break; \ - case PS_TYPE_S16: \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(S16,MODE); \ - break; \ - case PS_TYPE_S32: /* Not a requirement */ \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(S32,MODE); \ - break; \ - case PS_TYPE_S64: /* Not a requirement */ \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(S64,MODE); \ - break; \ - case PS_TYPE_F32: \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(F32,MODE); \ - break; \ - case PS_TYPE_F64: \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(F64,MODE); \ - break; \ - case PS_TYPE_C32: \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(C32,MODE); \ - break; \ - case PS_TYPE_C64: \ - PSIMAGE_ROTATE_ARBITRARY_LOOP(C64,MODE); \ - break; \ - default: { \ - char* typeStr; \ - PS_TYPE_NAME(typeStr,type); \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, \ - typeStr); \ - psFree(out); \ - out = NULL; \ - } \ - } \ - break; - - switch (mode) { - PSIMAGE_ROTATE_ARBITRARY_CASE(FLAT); - PSIMAGE_ROTATE_ARBITRARY_CASE(BILINEAR); - PSIMAGE_ROTATE_ARBITRARY_CASE(BILINEAR_VARIANCE); - default: - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageManip_INTERPOLATION_MODE_UNSUPPORTED, - mode); - psFree(out); - out = NULL; - } - } - - return out; -} - -psImage* psImageShift(psImage* out, - const psImage* input, - float dx, - float dy, - complex exposed, - psImageInterpolateMode mode) -{ - psS32 outRows; - psS32 outCols; - psS32 elementSize; - psElemType type; - - if (input == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - psFree(out); - return NULL; - } - // create an output image of the same size - // and type - outRows = input->numRows; - outCols = input->numCols; - type = input->type.type; - elementSize = PSELEMTYPE_SIZEOF(type); - out = psImageRecycle(out, outCols, outRows, type); - - #define PSIMAGE_SHIFT_CASE(MODE,TYPE) \ -case PS_TYPE_##TYPE: \ - if (creal(exposed) < PS_MIN_##TYPE || \ - creal(exposed) > PS_MAX_##TYPE || \ - cimag(exposed) < PS_MIN_##TYPE || \ - cimag(exposed) > PS_MAX_##TYPE) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - PS_ERRORTEXT_psImageManip_CLIP_VALUE_INVALID, \ - "exposed", \ - creal(exposed),cimag(exposed), \ - PS_TYPE_##TYPE##_NAME, \ - (double)PS_MIN_##TYPE,(double)PS_MAX_##TYPE); \ - psFree(out); \ - out = NULL; \ - break; \ - } \ - for (psS32 row=0;rowdata.TYPE[row]; \ - float y = dy+(float)row; \ - for (psS32 col=0;coltype.type) { \ - PSIMAGE_SHIFT_CASE(MODE,U8); \ - PSIMAGE_SHIFT_CASE(MODE,U16); \ - PSIMAGE_SHIFT_CASE(MODE,U32); /* Not a requirement */ \ - PSIMAGE_SHIFT_CASE(MODE,U64); /* Not a requirement */ \ - PSIMAGE_SHIFT_CASE(MODE,S8); \ - PSIMAGE_SHIFT_CASE(MODE,S16); \ - PSIMAGE_SHIFT_CASE(MODE,S32); /* Not a requirement */ \ - PSIMAGE_SHIFT_CASE(MODE,S64); /* Not a requirement */ \ - PSIMAGE_SHIFT_CASE(MODE,F32); \ - PSIMAGE_SHIFT_CASE(MODE,F64); \ - PSIMAGE_SHIFT_CASE(MODE,C32); \ - PSIMAGE_SHIFT_CASE(MODE,C64); \ - \ - default: { \ - char* typeStr; \ - PS_TYPE_NAME(typeStr,type); \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, \ - typeStr); \ - psFree(out); \ - out = NULL; \ - } \ - } \ - break; - - switch (mode) { - PSIMAGE_SHIFT_ARBITRARY_CASE(FLAT); - PSIMAGE_SHIFT_ARBITRARY_CASE(BILINEAR); - PSIMAGE_SHIFT_ARBITRARY_CASE(BILINEAR_VARIANCE); - default: - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageManip_INTERPOLATION_MODE_UNSUPPORTED, - mode); - psFree(out); - out = NULL; - } - - return out; -} - -psImage* psImageTransform(psImage *output, - psPixels* blankPixels, - const psImage *input, - const psImage *inputMask, - psMaskType inputMaskVal, - const psPlaneTransform *outToIn, - psRegion region, - const psPixels* pixels, - psImageInterpolateMode mode, - double exposedValue) -{ - if (input == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - psFree(output); - return NULL; - } - psElemType type = input->type.type; - - if (inputMask != NULL) { - if (input->numRows != inputMask->numRows || input->numCols != inputMask->numCols) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psImage_IMAGE_MASK_SIZE, - input->numCols, input->numRows, - inputMask->numCols, inputMask->numRows ); - psFree(output); - return NULL; - } - if (inputMask->type.type != PS_TYPE_MASK) { - char* typeStr; - PS_TYPE_NAME(typeStr,inputMask->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_MASK_TYPE, - typeStr, PS_TYPE_MASK_NAME); - psFree(output); - return NULL; - } - } - - if (outToIn == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImageManip_TRANSFORM_NULL); - return NULL; - } - - int row0; - int row1; - int col0; - int col1; - int numRows; - int numCols; - if (output == NULL) { // output image size is determined by psRegion - row0 = region.y0; - row1 = region.y1; - col0 = region.x0; - col1 = region.x1; - if (col1 < 1) { - col1 += input->numCols; - } - - if (row1 < 1) { - row1 += input->numRows; - } - - numRows = row1 - row0; - numCols = col1 - col0; - - if (numRows < 1 || numCols < 1) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - "The specified region is invalid."); - psFree(output); - return NULL; - } - // create the output image. - output = psImageRecycle(output, numCols, numRows, input->type.type); - *(psS32*)&output->col0 = region.x0; - *(psS32*)&output->row0 = region.y0; - } else { // size of output is determined by output parameter - numRows = output->numRows; - numCols = output->numCols; - row0 = output->row0; - col0 = output->col0; - row1 = row0+numRows; - col1 = col0+numCols; - } - - // loop through the output image using the domain above and transform - // each output pixel to input coordinates and use psImagePixelInterpolate - // to determine the pixel value. - psPlane outPosition; - psPlane* inPosition = NULL; - - - - - - #define PSIMAGE_TRANSFORM_DOTRANSFORM(TYPE,MODE) \ - /* apply the transform to get the position in the input image */ \ - inPosition = psPlaneTransformApply(inPosition, outToIn, &outPosition); \ - \ - if (inPosition == NULL) { \ - psError(PS_ERR_UNKNOWN, false, \ - "Failed to apply the transform"); \ - psFree(output); \ - return NULL; \ - } \ - /* interpolate the cooresponding input pixel to get the output pixel value. */ \ - ps##TYPE value = p_psImagePixelInterpolate##MODE##_##TYPE(input, \ - inPosition->x, inPosition->y, \ - inputMask, inputMaskVal, NAN); \ - /* psFree(inPosition); */\ - if (isnan(value)) { \ - if (blankPixels != NULL) { \ - p_psPixelsAppend(blankPixels, blankPixels->nalloc, outPosition.x, outPosition.y); \ - } \ - value = exposedValue; \ - } \ - - #define PSIMAGE_TRANSFORM_LOOP(TYPE, MODE) { \ - for (int row = 0; row < numRows; row++) { \ - outPosition.y = row+row0; \ - ps##TYPE* outputData=output->data.TYPE[row]; \ - for (int col = 0; col < numCols; col++) { \ - outPosition.x = col+col0; \ - PSIMAGE_TRANSFORM_DOTRANSFORM(TYPE,MODE) \ - outputData[col] = value; \ - } \ - } \ - } - - #define PSIMAGE_TRANSFORM_FROMLIST(TYPE, MODE) { \ - int n = pixels->n; \ - for (int i= 0; i < n; i++) { \ - int x = pixels->data[i].x; \ - int y = pixels->data[i].y; \ - if (x >= col0 && x < col1 && y >= row0 && y < row1) { \ - outPosition.x = x; \ - outPosition.y = y; \ - PSIMAGE_TRANSFORM_DOTRANSFORM(TYPE,MODE) \ - output->data.TYPE[y][x] = value; \ - } \ - } \ - } - - #define PSIMAGE_TRANSFORM_CASE(MODE) \ -case PS_INTERPOLATE_##MODE: \ - switch (type) { \ - case PS_TYPE_F32: \ - PSIMAGE_TRANSFORM_LOOP(F32,MODE); \ - break; \ - case PS_TYPE_F64: \ - PSIMAGE_TRANSFORM_LOOP(F64,MODE); \ - break; \ - default: { \ - char* typeStr; \ - PS_TYPE_NAME(typeStr,type); \ - psError(PS_ERR_BAD_PARAMETER_TYPE, true, \ - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, \ - typeStr); \ - psFree(output); \ - return NULL; \ - } \ - } \ - break; - - switch (mode) { - PSIMAGE_TRANSFORM_CASE(FLAT); - PSIMAGE_TRANSFORM_CASE(BILINEAR); - PSIMAGE_TRANSFORM_CASE(BILINEAR_VARIANCE); - default: - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageManip_INTERPOLATION_MODE_UNSUPPORTED, - mode); - psFree(output); - return NULL; - } - - psFree(inPosition); - - return output; -} - Index: unk/psLib/src/image/psImageGeomManip.h =================================================================== --- /trunk/psLib/src/image/psImageGeomManip.h (revision 4545) +++ (revision ) @@ -1,158 +1,0 @@ -/** @file psImageGeomManip.h - * - * @brief Contains basic image geometry manipulation operations, as - * specified in the PSLIB SDRS sections "Image Geometry Manipulations". - * - * @ingroup Image - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-25 00:51:28 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ -#ifndef PS_IMAGE_GEOM_MANIP_H -#define PS_IMAGE_GEOM_MANIP_H - -#include "psImage.h" -#include "psCoord.h" -#include "psStats.h" -#include "psPixels.h" - -/// @addtogroup Image -/// @{ - -/** Rebin image to new scale. - * - * A new image is constructed in which the dimensions are reduced by a factor of - * 1/scale. The scale, always a positive number, is equal in each dimension and - * specified the number of pixels used to define a new pixel in the output image. - * The output image is generated from all input image pixels. This function is - * defined for psU8, psS8, psS16, psF32, psF64, psC32, and psC64. - * - * @return psImage new image formed by rebinning input image. - */ -psImage* psImageRebin( - psImage* out, ///< an psImage to recycle. If NULL, a new image is created - const psImage* in, ///< input image - const psImage* mask, ///< mask for input image. If NULL, no masking is done. - psMaskType maskVal, ///< the bits to check in mask. - int scale, ///< the scale to rebin for each dimension - const psStats* stats - ///< the statistic to perform when rebinning. Only one method should be set. -); - -/** Resample image to new scale. - * - * A new image is constructed in which the dimensions are increased by a - * factor of scale. The scale, always a positive number, is equal in each - * dimension. The output image is generated from all input image pixels. - * Each pixel in the output image is derived by interpolating between - * neighboring pixels using the specified interpolation method (mode). - * - * @return psImage* resampled image result - */ -psImage* psImageResample( - psImage* out, ///< an psImage to recycle. If NULL, a new image is created - const psImage* in, ///< input image - int scale, ///< resample scaling factor - psImageInterpolateMode mode ///< the interpolation mode used in resampling -); - -/** Rotate the input image by given angle, specified in degrees. - * - * The output image must contain all of the pixels from the input image in - * their new frame. Pixels in the output image which do not map to input - * pixels should be set to exposed. The center of rotation is always the - * center pixel of the image. The rotation is specified in the sense that a - * positive angle is an anti-clockwise rotation. This function must be - * defined for the following types: psU8, psU16, psS8, psS16, psF32, psF64, - * psC32, psC64. - * - * @return psImage* the rotated image result. - */ -psImage* psImageRotate( - psImage* out, ///< an psImage to recycle. If NULL, a new image is created - const psImage* input, ///< input image - float angle, ///< the rotation angle in radians. - complex exposed, ///< the output image pixel values for non-imagery areas - psImageInterpolateMode mode ///< the interpolation mode used -); - -/** Shift image by an arbitrary number of pixels (dx,dy) in either direction. - * - * If the shift values are fractional, the output pixel values should - * interpolate between the input pixel values. The output image has the same - * dimensions as the input image. Pixels which fall off the edge of the - * output image are lost. Newly exposed pixels are set to the value given by - * exposed. This function must be defined for the following types: psU8, - * psU16, psS8, psS16, psF32, psF64, psC32, psC64. - * - * @return psImage* the shifted image result. - */ -psImage* psImageShift( - psImage* out, ///< an psImage to recycle. If NULL, a new image is created - const psImage* input, ///< input image - float dx, ///< the shift in x direction. - float dy, ///< the shift in y direction. - complex exposed, ///< the output image pixel values for non-imagery areas - psImageInterpolateMode mode ///< the interpolation mode to use -); - -/** Roll image by an integer number of pixels in either direction. - * - * The output image is the same dimensions as the input image. Edge pixels - * wrap to the other side (no values are lost). This function is - * defined for psU8, psS8, psS16, psF32, psF64, psC32, and psC64. - * - * @return psImage* the rolled version of the input image. - */ -psImage* psImageRoll( - psImage* out, ///< an psImage to recycle. If NULL, a new image is created - const psImage* input, ///< input image - int dx, ///< number of pixels to roll in the x-dimension - int dy ///< number of pixels to roll in the y-dimension -); - -/** Transform the input image according the supplied transformation. - * - * Transform the input image according the supplied transformation. The size - * of the transformed image is defined by the supplied output image, if - * non-NULL, or the region otherwise (size region.x1 - region.x0 by region.y1 - * region.y0, with out->x0 = region.x0 and out->y0 = region.y0). If the - * inputMask is non-NULL, those pixels in the inputMask matching inputMaskVal - * are to be ignored in the transformation. The inputMask must be of type - * psU8, and of the same size as the input, otherwise the function shall - * generate an error and return NULL. The transformation outToIn specifies the - * coordinates in the input image of a pixel in the output image — note that - * this is the reverse of what might be naively expected, but it is what is - * required in order to use psImagePixelInterpolate. If the pixels array is - * non-NULL, it shall consist of psPixelCoords, and only those pixels in the - * output image shall be transformed; otherwise, the entire image is - * generated. The interpolation is performed using the specified interpolation - * mode. Where a pixel in the output image does not correspond to a pixel in - * the input image (or all appropriate pixels in the input image are - * masked), the value shall be set to exposed, and the pixel added to the - * appropriate list of pixels (psPixels) in the array of blankPixels for - * return to the user. This function must be capable of handling the following - * types for the input (with corresponding types for the output): psF32, psF64. - - * - * @return psImage* The transformed image. - */ -psImage* psImageTransform( - psImage *output, ///< psImage to recycle, or NULL - psPixels* blankPixels, ///< list of pixels in output image not set, or NULL if no list is desired. - const psImage *input, ///< psImage to apply transform to - const psImage *inputMask, ///< if not NULL, mask of input psImage - psMaskType inputMaskVal, ///< masking value for inputMask - const psPlaneTransform *outToIn, ///< the transform to apply - psRegion region, ///< the size of the transformed image - const psPixels* pixels, /**< if not NULL, consists of psPixelCoords and specifies which pixels in - * output image shall be transformed; otherwise, entire image generated*/ - psImageInterpolateMode mode, ///< the interpolation scheme to be used - double exposedValue ///< Exposed value to which non-corresponding pixels are set -); - -#endif // #ifndef PS_IMAGE_GEOM_MANIP_H Index: unk/psLib/src/image/psImagePixelExtract.c =================================================================== --- /trunk/psLib/src/image/psImagePixelExtract.c (revision 4545) +++ (revision ) @@ -1,600 +1,0 @@ -/** @file psImagePixelExtract.c - * - * @brief Contains basic image extraction operations, as specified in the - * PSLIB SDRS sections "Image Pixel Extractions". - * - * @ingroup Image - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - * - */ - -#include - -#include "psMemory.h" -#include "psImagePixelExtract.h" -#include "psError.h" - -#include "psImageErrors.h" - -psVector* psImageSlice(psVector* out, - psVector* coords, - const psImage* restrict input, - const psImage* restrict mask, - psMaskType maskVal, - psRegion region, - psImageCutDirection direction, - const psStats* stats) -{ - double statVal; - psStats* myStats; - psElemType type; - psS32 inRows; - psS32 inCols; - psS32 delta = 1; - psF64* outData; - psS32 row0 = region.y0; - psS32 row1 = region.y1; - psS32 col0 = region.x0; - psS32 col1 = region.x1; - - if (input == NULL || input->data.V == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - psFree(out); - return NULL; - } - - if (col1 < 1) { - col1 += input->numCols; - } - - if (row1 < 1) { - row1 += input->numRows; - } - - if ( col0 < 0 || - row0 < 0 || - col1 > input->numCols || - row1 > input->numRows || - col0 >= col1 || - row0 >= row1) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_SUBSET_RANGE_INVALID, - col0, col1, row0, row1, - input->numCols, input->numRows); - psFree(out); - return NULL; - } - - type = input->type.type; - inRows = input->numRows; - inCols = input->numCols; - - if (direction == PS_CUT_X_NEG || direction == PS_CUT_Y_NEG) { - delta = -1; - } - - if (mask != NULL) { - if (inRows != mask->numRows || inCols != mask->numCols) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_IMAGE_MASK_SIZE, - mask->numCols,mask->numRows, - inCols, inRows); - psFree(out); - return NULL; - } - if (mask->type.type != PS_TYPE_MASK) { - char* typeStr; - PS_TYPE_NAME(typeStr,mask->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_MASK_TYPE, - typeStr, PS_TYPE_MASK_NAME); - psFree(out); - return NULL; - } - } - - if (stats == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_STAT_NULL); - psFree(out); - return NULL; - } - - // verify that the stats struct specifies a - // single stats operation - if (p_psGetStatValue(stats, &statVal) == false) { - psError(PS_ERR_BAD_PARAMETER_VALUE, false, - PS_ERRORTEXT_psImage_BAD_STAT,stats->options); - psFree(out); - return NULL; - } - // since stats input is const, I need to - // create a 'scratch' stats struct - myStats = psAlloc(sizeof(psStats)); - *myStats = *stats; - - psS32 numCols = col1-col0; - psS32 numRows = row1-row0; - - if (direction == PS_CUT_X_POS || direction == PS_CUT_X_NEG) { - psVector* imgVec = psVectorAlloc(numRows, type); - psVector* maskVec = NULL; - psMaskType* maskData = NULL; - psU32* outPosition = NULL; - - // recycle output to make a proper sized/type output structure - // n.b. type is double as that is the type given for all stats is - // psStats. - out = psVectorRecycle(out, numCols, PS_TYPE_F64); - if (coords != NULL) { - coords = psVectorRecycle(coords, numCols, PS_TYPE_U32); - outPosition = coords->data.U32; - } - outData = out->data.F64; - if (delta < 0) { - outData += numCols - 1; - if (outPosition != NULL) { - outPosition += numCols - 1; - } - } - - if (mask != NULL) { - maskVec = psVectorAlloc(numRows, mask->type.type); - } - #define PSIMAGE_CUT_VERTICAL(TYPE) \ - case PS_TYPE_##TYPE: { \ - psMaskType* maskVecData = NULL; \ - for (psS32 c=col0;cdata.TYPE[row0] + c; \ - ps##TYPE *imgVecData = imgVec->data.TYPE; \ - if (maskVec != NULL) { \ - maskVecData = maskVec->data.U8; \ - maskData = (psMaskType* )(mask->data.U8[row0]) + c; \ - } \ - for (psS32 r=row0;rtype = input->type; - imgVec->n = *(int*)&imgVec->nalloc = numCols; - if (mask != NULL) { - maskVec = psAlloc(sizeof(psVector)); - maskVec->type = mask->type; - maskVec->n = *(int*)&maskVec->nalloc = numCols; - } - // recycle output to make a proper sized/type output structure - // n.b. type is double as that is the type given for all stats in - // psStats. - out = psVectorRecycle(out, numRows, PS_TYPE_F64); - if (coords != NULL) { - coords = psVectorRecycle(coords, numRows, PS_TYPE_U32); - outPosition = coords->data.U32; - } - outData = out->data.F64; - if (delta < 0) { - outData += numRows-1; - if (outPosition != NULL) { - outPosition += numRows-1; - } - } - - for (psS32 r = row0; r < row1; r++) { - // point the vector struct to the - // data to calculate the stats - imgVec->data.U8 = (psPtr )(input->data.U8[r] + col0 * elementSize); - if (maskVec != NULL) { - maskVec->data.U8 = (psPtr )(mask->data.U8[r] + col0 * sizeof(psMaskType)); - } - myStats = psVectorStats(myStats, imgVec, NULL, maskVec, maskVal); - (void)p_psGetStatValue(myStats, &statVal); // we know it works cause we tested it above - *outData = statVal; - if (outPosition != NULL) { - *outPosition = r; - outPosition += delta; - - } - outData += delta; - } - psFree(imgVec); - psFree(maskVec); - } else { // don't know what the direction flag is - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_SLICE_DIRECTION_INVALID, - direction); - psFree(out); - out = NULL; - } - - psFree(myStats); - - return out; -} - -psVector* psImageCut(psVector* out, - psVector* cutCols, - psVector* cutRows, - const psImage* input, - const psImage* mask, - psMaskType maskVal, - psRegion region, - unsigned int nSamples, - psImageInterpolateMode mode) -{ - - if (input == NULL || input->data.V == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - psFree(out); - return NULL; - } - psS32 numCols = input->numCols; - psS32 numRows = input->numRows; - - if (nSamples < 2) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_nSamples_TOOSMALL, - nSamples); - psFree(out); - return NULL; - } - - float startCol = region.x0; - float startRow = region.y0; - float endCol = region.x1; - float endRow = region.y1; - if (startCol < 0 || startCol >= numCols || - startRow < 0 || startRow >= numRows || - endCol < 0 || endCol >= numCols || - endRow < 0 || endRow >= numRows) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_LINE_NOT_IN_IMAGE, - startCol,startRow,endCol,endRow, - numCols-1,numRows-1); - psFree(out); - return NULL; - } - - if (mode < PS_INTERPOLATE_FLAT ) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageManip_INTERPOLATION_MODE_UNSUPPORTED, - mode); - psFree(out); - return NULL; - } - - if (mask != NULL) { - if (numRows != mask->numRows || numCols != mask->numCols) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_IMAGE_MASK_SIZE, - mask->numCols,mask->numRows, - numCols-1, numRows); - psFree(out); - return NULL; - } - if (mask->type.type != PS_TYPE_MASK) { - char* typeStr; - PS_TYPE_NAME(typeStr,mask->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_MASK_TYPE, - typeStr, PS_TYPE_MASK_NAME); - psFree(out); - return NULL; - } - } - - //resize the vectors for the coordinate output - psF32* cutColsData = NULL; - psF32* cutRowsData = NULL; - if (cutCols != NULL) { - cutCols = psVectorRecycle(cutCols, nSamples, PS_TYPE_F32); - cutColsData = cutCols->data.F32; - } - if (cutRows != NULL) { - cutRows = psVectorRecycle(cutRows, nSamples, PS_TYPE_F32); - cutRowsData = cutRows->data.F32; - } - - out = psVectorRecycle(out, nSamples, input->type.type); - - float dX = (endCol - startCol) / (float)(nSamples-1); - float dY = (endRow - startRow) / (float)(nSamples-1); - - #define LINEAR_CUT_CASE(TYPE) \ -case PS_TYPE_##TYPE: { \ - ps##TYPE* outData = out->data.TYPE; \ - for (psS32 i = 0; i < nSamples; i++) { \ - float x = startCol + (float)i*dX; \ - float y = startRow + (float)i*dY; \ - /* store off the location of the sample. */ \ - if (cutColsData != NULL) { \ - cutColsData[i] = x; \ - } \ - if (cutRowsData != NULL) { \ - cutRowsData[i] = y; \ - } \ - outData[i] = psImagePixelInterpolate(input,x,y,mask,maskVal,0,mode); \ - } \ - } \ - break; - - - switch (input->type.type) { - LINEAR_CUT_CASE(U8); - LINEAR_CUT_CASE(U16); - LINEAR_CUT_CASE(U32); - LINEAR_CUT_CASE(U64); - LINEAR_CUT_CASE(S8); - LINEAR_CUT_CASE(S16); - LINEAR_CUT_CASE(S32); - LINEAR_CUT_CASE(S64); - LINEAR_CUT_CASE(F32); - LINEAR_CUT_CASE(F64); - LINEAR_CUT_CASE(C32); - LINEAR_CUT_CASE(C64); - - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,input->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - psFree(out); - out = NULL; - } - } - - return out; -} - -psVector* psImageRadialCut(psVector* out, - const psImage* input, - const psImage* restrict mask, - psMaskType maskVal, - float x, - float y, - const psVector* radii, - const psStats* stats) -{ - double statVal; - - /* check the parameters */ - - if (input == NULL || input->data.V == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - psFree(out); - return NULL; - } - psS32 numCols = input->numCols; - psS32 numRows = input->numRows; - - if (mask != NULL) { - if (numRows != mask->numRows || numCols != mask->numCols) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psImage_IMAGE_MASK_SIZE, - mask->numCols,mask->numRows, - numCols, numRows); - psFree(out); - return NULL; - } - if (mask->type.type != PS_TYPE_MASK) { - char* typeStr; - PS_TYPE_NAME(typeStr,mask->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_MASK_TYPE, - typeStr, PS_TYPE_MASK_NAME); - psFree(out); - return NULL; - } - } - - if (x < 0 || x >= numCols || - y < 0 || y >= numRows) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_CENTER_NOT_IN_IMAGE, - x, y, - numCols-1, numRows-1); - psFree(out); - return NULL; - } - - if (radii == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_RADII_VECTOR_NULL); - psFree(out); - return NULL; - } - - if (radii->n < 2) { - psError(PS_ERR_BAD_PARAMETER_SIZE, true, - PS_ERRORTEXT_psImage_RADII_VECTOR_TOOSMALL, - radii->n); - psFree(out); - return NULL; - } - - if (stats == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_STAT_NULL); - psFree(out); - return NULL; - } - - // verify that the stats struct specifies a - // single stats operation - if (p_psGetStatValue(stats, &statVal) == false) { - psError(PS_ERR_BAD_PARAMETER_VALUE, false, - PS_ERRORTEXT_psImage_BAD_STAT, - stats->options); - psFree(out); - return NULL; - } - - /* completed checking the parameters */ - - // size the output vector to proper size. - psS32 numOut = radii->n - 1; - out = psVectorRecycle(out, numOut, PS_TYPE_F64); - psF64* outData = out->data.F64; - - psVector* rSqVec = psVectorCopy(NULL, radii, PS_TYPE_F32); - psF32* rSq = rSqVec->data.F32; - - psS32 startRow = y - rSq[numOut]; - psS32 endRow = y + rSq[numOut]; - psS32 startCol = x - rSq[numOut]; - psS32 endCol = x + rSq[numOut]; - - if (startRow < 0) { - startRow = 0; - } - - if (startCol < 0) { - startCol = 0; - } - - if (endRow >= numRows) { - endRow = numRows - 1; - } - - if (endCol >= numCols) { - endCol = numCols - 1; - } - - // Square the radii data - for (psS32 d = 0; d <= numOut; d++) { - rSq[d] *= rSq[d]; - } - - // create temporary vectors for the data binning step - psVector** buffer = psAlloc(sizeof(psVector*)*numOut); - psVector** bufferMask = psAlloc(sizeof(psVector*)*numOut); - for (psS32 lcv = 0; lcv < numOut; lcv++) { - // n.b. alloc enough for the data by making the vectors slightly larger - // than the area of the region of interest. - buffer[lcv] = psVectorAlloc(1+4*(rSq[lcv+1]-rSq[lcv]), - input->type.type); - buffer[lcv]->n = 0; - - bufferMask[lcv] = NULL; - if (mask != NULL) { - bufferMask[lcv] = psVectorAlloc(1+4*(rSq[lcv+1]-rSq[lcv]), - PS_TYPE_MASK); - bufferMask[lcv]->n = 0; - } - } - - float dX; - float dY; - float dist; - for (psS32 row=startRow; row <= endRow; row++) { - psF32* inRow = input->data.F32[row]; - psMaskType* maskRow = NULL; - if (mask != NULL) { - maskRow = mask->data.PS_TYPE_MASK_DATA[row]; - } - for (psS32 col=startCol; col <= endCol; col++) { - dX = x - (float)col - 0.5f; - dY = y - (float)row - 0.5f; - dist = dX*dX+dY*dY; - for (psS32 r = 0; r < numOut; r++) { - if (rSq[r] < dist && dist < rSq[r+1]) { - psS32 n = buffer[r]->n; - if (n == buffer[r]->nalloc) { // in case buffers already full, expand - buffer[r] = psVectorRealloc(buffer[r], n*2); - if (bufferMask[r] != NULL) { - bufferMask[r] = psVectorRealloc(bufferMask[r], n*2); - } - } - - buffer[r]->data.F32[n] = inRow[col]; - buffer[r]->n = n+1; - - if (maskRow != NULL) { - bufferMask[r]->data.PS_TYPE_MASK_DATA[n] = maskRow[col]; - bufferMask[r]->n = n+1; - } - - break; - } - } - } - } - - psStats* myStats = psAlloc(sizeof(psStats)); - *myStats = *stats; - - for (psS32 r = 0; r < numOut; r++) { - myStats = psVectorStats(myStats,buffer[r], NULL, bufferMask[r],maskVal); - (void)p_psGetStatValue(myStats,&statVal); - outData[r] = statVal; - } - - psFree(myStats); - - for (psS32 lcv = 0; lcv < numOut; lcv++) { - psFree(buffer[lcv]); - psFree(bufferMask[lcv]); - } - psFree(buffer); - psFree(bufferMask); - psFree(rSqVec); - return out; -} Index: unk/psLib/src/image/psImagePixelExtract.h =================================================================== --- /trunk/psLib/src/image/psImagePixelExtract.h (revision 4545) +++ (revision ) @@ -1,126 +1,0 @@ -/** @file psImagePixelExtract.h -* -* @brief Contains basic image extraction operations, as specified in the -* PSLIB SDRS sections "Image Pixel Extractions". -* -* @ingroup Image -* -* @author Robert DeSonia, MHPCC -* -* @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-25 00:51:28 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#ifndef PSIMAGE_PIXEL_EXTRACT_H -#define PSIMAGE_PIXEL_EXTRACT_H - -#include "psImage.h" -#include "psVector.h" -#include "psStats.h" - -/// @addtogroup Image -/// @{ - -/* Cut direction flag. Used with psImageCut function. - */ -typedef enum { - PS_CUT_X_POS, ///< Cut in the x dimension from left to right - PS_CUT_X_NEG, ///< Cut in the x dimension from rigth to left - PS_CUT_Y_POS, ///< Cut in the y dimension from bottom up - PS_CUT_Y_NEG, ///< Cut in the y dimension from top down. -} psImageCutDirection; - -/** Extract pixels from rectlinear region to a vector (array of floats). - * - * The output vector contains either col1-col0 or row1-row0 elements, based - * on the value of the direction: e.g., if direction is PS_CUT_X_POS, there - * are col1-col0 elements. The region to be sliced is defined by the - * lower-left corner, (col0,row0), and the upper-right corner, (col1,row1). - * Note that the row and column of the upper right-hand corner are NOT - * included in the region. In the event that col1 or row1 are negative, they - * shall be interpreted as being relative to the size of the parent image in - * that dimension. The input region is collapsed in the direction perpendicular - * to that specified by direction, and each element of the output vectors is - * derived from the statistics of the pixels at that direction coordinate. The - * statistic used to derive the output vector value is specified by stats. - * If mask is non-NULL, pixels for which the corresponding mask pixel - * matches maskVal are excluded from operations. If coords is not NULL, the - * calculated coordinates along the slice are returned in this vector. Only - * one of the statistics choices may be specified, otherwise the function - * must return an error. - * - * This function is defined for the following types: psS8, psU16, psF32, psF64. - * - * @return psVector the resulting vector - */ -psVector* psImageSlice( - psVector* out, ///< psVector to recycle, or NULL. - psVector* coords, - ///< If not NULL, it is populated with the coordinate in the slice dimension - ///< coorsponding to the output vector's value of the same position in the - ///< vector. This vector maybe resized and retyped as appropriate. - const psImage* input, ///< the input image in which to perform the slice - const psImage* mask, ///< the mask for the input image. - psMaskType maskVal, ///< the mask value to apply to the mask - psRegion region, ///< the slice region - psImageCutDirection direction, ///< the slice dimension and direction - const psStats* stats ///< the statistic to perform in slice operation -); - -/** Extract pixels from an image along a line to a vector (array of floats). - * - * The vector (xs,ys) - (xe,ye) forms the basis of the output vector. Pixels - * are considered in a rectangular region of width dw about this vector. The - * input region is collapsed in the perpendicular direction, and each element - * of the output vector represents pixel-sized boxes, where the value is - * derived from the statistics of the pixels interpolated along the - * perpendicular direction. The specific algorithm which must be used is - * described in the PSLib ADD (PSDC-430-006). The statistic used to derive - * the output vector value is specified by stats. Only one of the statistics - * choices may be specified, otherwise the function must return an error. - * This function must be defined for the following types: psS8, psU16, psF32, - * psF64. - * - * @return psVector* resulting vector - */ -psVector* psImageCut( - psVector* out, ///< psVector to recycle, or NULL. - psVector* cutCols, ///< if not NULL, the calculated column values along the slice (output) - psVector* cutRows, ///< if not NULL, the calculated row values along the slice (output) - const psImage* input, ///< the input image in which to perform the cut - const psImage* mask, ///< the mask for the input image. - psMaskType maskVal, ///< the mask value to apply to the mask - psRegion region, ///< the start and end points to cut along - unsigned int nSamples, ///< the number of samples along the cut - psImageInterpolateMode mode ///< the interpolation method to use -); - -/** Extract radial region data to a vector. A vector is constructed where each - * vector elements is derived from the statistics of the pixels which land - * within one of a sequence of radii. The radii are centered on the image - * pixel coordinate x,y, and are defined by the sequence of values in the - * vector radii. The specific algorithm which must be used is described in - * the PSLib ADD (PSDC-430-006). The statistic used to derive the output - * vector value is specified by stats. Only one of the statistics choices - * may be specified, otherwise the function must return an error. This - * function must be defined for the following types: psS8, psU16, psF32, - * psF64. - * - * @return psVector resulting vector - */ -psVector* psImageRadialCut( - psVector* out, ///< psVector to recycle, or NULL. - const psImage* input, ///< the input image in which to perform the cut - const psImage* mask, ///< the mask for the input image. - psMaskType maskVal, ///< the mask value to apply to the mask - float x, ///< the column of the center of the cut circle - float y, ///< the row of the center of the cut circle - const psVector* radii, ///< the radii of the cut circle - const psStats* stats ///< the statistic to perform in operation -); - -/// @} - -#endif // #ifndef PSIMAGE_PIXEL_EXTRACT_H Index: unk/psLib/src/image/psImagePixelManip.c =================================================================== --- /trunk/psLib/src/image/psImagePixelManip.c (revision 4545) +++ (revision ) @@ -1,397 +1,0 @@ -/** @file psImagePixelManip.c - * - * @brief Contains basic image pixel and geometry manipulation operations, as - * specified in the PSLIB SDRS sections "Image Pixel Manipulations" and - * "Image Geometry Manipulations". - * - * @ingroup Image - * - * @author Robert DeSonia, MHPCC - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-11 21:38:19 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include // for isfinite(), etc. -#include -#include // for memcpy, etc. - -#include "psImagePixelManip.h" - -#include "psError.h" -#include "psImage.h" -#include "psStats.h" -#include "psMemory.h" -#include "psConstants.h" -#include "psImageErrors.h" -#include "psCoord.h" - -int psImageClip(psImage* input, - double min, - double vmin, - double max, - double vmax) -{ - psS32 numClipped = 0; - psU32 numRows; - psU32 numCols; - - if (input == NULL) { - return 0; - } - - if (max < min) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImageManip_MAXMIN, - (double)min,(double)max); - return 0; - } - - numRows = input->numRows; - numCols = input->numCols; - - switch (input->type.type) { - - #define psImageClipCase(type) \ - case PS_TYPE_##type: { \ - if (vmin < PS_MIN_##type || vmin > PS_MAX_##type) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - PS_ERRORTEXT_psImage_PARAMETER_OUTOF_TYPERANGE, \ - "vmin",vmin, PS_TYPE_##type##_NAME, \ - (psF64)PS_MIN_##type,(psF64)PS_MAX_##type); \ - } \ - if (vmax > PS_MAX_##type || vmax < PS_MIN_##type) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - PS_ERRORTEXT_psImage_PARAMETER_OUTOF_TYPERANGE, \ - "vmax",vmax, PS_TYPE_##type##_NAME, \ - (psF64)PS_MIN_##type,(psF64)PS_MAX_##type); \ - } \ - for (psU32 row = 0;rowdata.type[row]; \ - for (psU32 col = 0; col < numCols; col++) { \ - if ((psF64)inputRow[col] < min) { \ - inputRow[col] = (ps##type)vmin; \ - numClipped++; \ - } else if ((psF64)inputRow[col] > max) { \ - inputRow[col] = (ps##type)vmax; \ - numClipped++; \ - } \ - } \ - } \ - } \ - break; - - #define psImageClipCaseComplex(type,absfcn)\ - case PS_TYPE_##type: { \ - if (vmin < PS_MIN_##type || vmin > PS_MAX_##type) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - PS_ERRORTEXT_psImage_PARAMETER_OUTOF_TYPERANGE, \ - "vmin",vmin, PS_TYPE_##type##_NAME, \ - (psF64)PS_MIN_##type,(psF64)PS_MAX_##type); \ - } \ - if (vmax > PS_MAX_##type || vmax < PS_MIN_##type) { \ - psError(PS_ERR_BAD_PARAMETER_VALUE, true, \ - PS_ERRORTEXT_psImage_PARAMETER_OUTOF_TYPERANGE, \ - "vmax",vmax, PS_TYPE_##type##_NAME, \ - (psF64)PS_MIN_##type,(psF64)PS_MAX_##type); \ - } \ - for (psU32 row = 0;rowdata.type[row]; \ - for (psU32 col = 0; col < numCols; col++) { \ - if (absfcn(inputRow[col]) < min) { \ - inputRow[col] = (ps##type)vmin; \ - numClipped++; \ - } else if (absfcn(inputRow[col]) > max) { \ - inputRow[col] = (ps##type)vmax; \ - numClipped++; \ - } \ - } \ - } \ - } \ - break; - - psImageClipCase(S8) - psImageClipCase(S16) - psImageClipCase(S32) // Not a requirement - psImageClipCase(S64) // Not a requirement - psImageClipCase(U8) - psImageClipCase(U16) - psImageClipCase(U32) // Not a requirement - psImageClipCase(U64) // Not a requirement - psImageClipCase(F32) - psImageClipCase(F64) - psImageClipCaseComplex(C32, cabsf) - psImageClipCaseComplex(C64, cabs) - - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,input->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - } - } - - return numClipped; -} - -int psImageClipNaN(psImage* input, - float value) -{ - psS32 numClipped = 0; - psU32 numRows; - psU32 numCols; - - if (input == NULL) { - return 0; - } - numRows = input->numRows; - numCols = input->numCols; - - switch (input->type.type) { - - #define psImageClipNaNCase(type) \ - case PS_TYPE_##type: \ - for (psU32 row = 0;rowdata.type[row]; \ - for (psU32 col = 0; col < numCols; col++) { \ - if (! isfinite(inputRow[col])) { \ - inputRow[col] = (ps##type)value; \ - numClipped++; \ - } \ - } \ - } \ - break; - - psImageClipNaNCase(F32) - psImageClipNaNCase(F64) - psImageClipNaNCase(C32) - psImageClipNaNCase(C64) - - default: { - char* typeStr; - PS_TYPE_NAME(typeStr,input->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_IMAGE_TYPE_UNSUPPORTED, - typeStr); - } - } - - return numClipped; -} - -int psImageOverlaySection(psImage* image, - const psImage* overlay, - int col0, - int row0, - const char *op) -{ - psU32 imageNumRows; - psU32 imageNumCols; - psU32 overlayNumRows; - psU32 overlayNumCols; - psU32 imageRowLimit; - psU32 imageColLimit; - psElemType type; - psU32 pixelsOverlaid = 0; - - if (image == NULL || overlay == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - return pixelsOverlaid; - } - - if (op == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImageManip_OPERATION_NULL); - return pixelsOverlaid; - } - - type = image->type.type; - - if (type != overlay->type.type) { - char* typeStr; - char* typeStrOverlay; - PS_TYPE_NAME(typeStr,type); - PS_TYPE_NAME(typeStrOverlay,overlay->type.type); - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImageManip_OVERLAY_TYPE_MISMATCH, - typeStrOverlay, typeStr); - return pixelsOverlaid; - } - - imageNumRows = image->numRows; - imageNumCols = image->numCols; - overlayNumRows = overlay->numRows; - overlayNumCols = overlay->numCols; - imageRowLimit = row0 + overlayNumRows; - imageColLimit = col0 + overlayNumCols; - - /* check to see if overlay is within the input image */ - if ( row0 < 0 || - col0 < 0 || - imageRowLimit > imageNumRows || - imageColLimit > imageNumCols) { - - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_SUBSET_RANGE_INVALID, - col0, imageColLimit, row0, imageRowLimit, - imageNumCols, imageNumRows); - return pixelsOverlaid; - } - - - #define psImageOverlayLoop(DATATYPE,OP) { \ - for (int row=row0;rowdata.DATATYPE[row]; \ - ps##DATATYPE* overlayRow = overlay->data.DATATYPE[row-row0]; \ - for (int col=col0;coloptions, NULL); - PS_ASSERT_IMAGE_NON_NULL(in, NULL) - if (mask != NULL) { - PS_ASSERT_IMAGE_TYPE(mask, PS_TYPE_U8, NULL); - PS_ASSERT_IMAGES_SIZE_EQUAL(in, mask, NULL); - } - - if (in->parent == NULL) { - // stuff the image data into a psVector struct. - junkData = (psVector *) psAlloc(sizeof(psVector)); - junkData->type = in->type; - *(int*)&junkData->nalloc = in->numRows * in->numCols; - junkData->n = junkData->nalloc; - junkData->data.U8 = in->data.V[0]; // since psImage data is contiguous... - } else { - // image not necessarily contiguous - int numRows = in->numRows; - int numCols = in->numCols; - int rowSize = numCols * (PSELEMTYPE_SIZEOF(in->type.type)); - - junkData = psVectorAlloc(numRows*numCols, in->type.type); - junkData->n = junkData->nalloc; - - psU8* data = junkData->data.U8; - for (int row = 0; row < numRows; row++) { - memcpy(data, in->data.V[row], rowSize); - data += rowSize; - } - } - - if (mask != NULL) { - if (mask->parent == NULL) { - // stuff the mask data into a psVector struct. - junkMask = psAlloc(sizeof(psVector)); - junkMask->type = mask->type; - *(int*)&junkMask->nalloc = mask->numRows * mask->numCols; - junkMask->n = junkMask->nalloc; - junkMask->data.U8 = mask->data.V[0]; - } else { - // image not necessarily contiguous - int numRows = mask->numRows; - int numCols = mask->numCols; - int rowSize = numCols * (PSELEMTYPE_SIZEOF(mask->type.type)); - - junkMask = psVectorAlloc(numRows*numCols, mask->type.type); - junkMask->n = junkMask->nalloc; - - psU8* data = junkMask->data.U8; - for (int row = 0; row < numRows; row++) { - memcpy(data, mask->data.V[row], rowSize); - data += rowSize; - } - } - } - - stats = psVectorStats(stats, junkData, NULL, junkMask, maskVal); - - psFree(junkMask); - psFree(junkData); - return (stats); -} - -/***************************************************************************** -NOTE: We assume that the psHistogram structure out has already been allocated -and initialized. - *****************************************************************************/ -psHistogram* psImageHistogram(psHistogram* out, - const psImage* in, - const psImage* mask, - psMaskType maskVal) -{ - PS_ASSERT_PTR_NON_NULL(out, NULL); - PS_ASSERT_PTR_NON_NULL(in, NULL); - if (mask != NULL) { - PS_ASSERT_IMAGE_TYPE(mask, PS_TYPE_U8, NULL); - PS_ASSERT_IMAGES_SIZE_EQUAL(in, mask, NULL); - } - psVector* junkData = NULL; - psVector* junkMask = NULL; - - if (in->parent == NULL) { - // stuff the image data into a psVector struct. - junkData = (psVector *) psAlloc(sizeof(psVector)); - junkData->type = in->type; - *(int*)&junkData->nalloc = in->numRows * in->numCols; - junkData->n = junkData->nalloc; - junkData->data.U8 = in->data.V[0]; // since psImage data is contiguous... - } else { - // image not necessarily contiguous - int numRows = in->numRows; - int numCols = in->numCols; - int rowSize = numCols * (PSELEMTYPE_SIZEOF(in->type.type)); - - junkData = psVectorAlloc(numRows*numCols, in->type.type); - junkData->n = junkData->nalloc; - - psU8* data = junkData->data.U8; - for (int row = 0; row < numRows; row++) { - memcpy(data, in->data.V[row], rowSize); - data += rowSize; - } - } - - if (mask != NULL) { - if (mask->parent == NULL) { - // stuff the mask data into a psVector struct. - junkMask = psAlloc(sizeof(psVector)); - junkMask->type = mask->type; - *(int*)&junkMask->nalloc = mask->numRows * mask->numCols; - junkMask->n = junkMask->nalloc; - junkMask->data.U8 = mask->data.V[0]; - } else { - // image not necessarily contiguous - int numRows = mask->numRows; - int numCols = mask->numCols; - int rowSize = numCols * (PSELEMTYPE_SIZEOF(mask->type.type)); - - junkMask = psVectorAlloc(numRows*numCols, mask->type.type); - junkMask->n = junkMask->nalloc; - - psU8* data = junkMask->data.U8; - for (int row = 0; row < numRows; row++) { - memcpy(data, mask->data.V[row], rowSize); - data += rowSize; - } - } - } - - out = psVectorHistogram(out, junkData, NULL, junkMask, maskVal); - - psFree(junkMask); - psFree(junkData); - - return (out); -} - -/***************************************************************************** -calcScaleFactorsEval(n): The Chebyshev polynomials are defined over the -interval [-1.0 : 1.0]. Images typically have sizes of 512x512 or more. In -order to use Chebyshev polynomials, we must scale the coordinates from -0:512 to -1:1. This routine takes as input an integer N and produces as -output a vector of evenly spaced floating point values between -1.0:1.0. - -XXX: Use the p_psNormalizeVector here? - *****************************************************************************/ -double* calcScaleFactors(psS32 n) -{ - PS_ASSERT_INT_NONNEGATIVE(n, NULL); - psS32 i = 0; - double tmp = 0.0; - double *scalingFactors = (double *)psAlloc(n * sizeof(double)); - - for (i = 0; i < n; i++) { - tmp = (double)(n - i); - tmp = (M_PI * (tmp - 0.5)) / ((double)n); - scalingFactors[i] = cos(tmp); - } - - return (scalingFactors); -} - -// XXX: Use a static array of Chebyshev polynomials. -psPolynomial1D **p_psCreateChebyshevPolys(psS32 maxChebyPoly) -{ - PS_ASSERT_INT_POSITIVE(maxChebyPoly, NULL); - psPolynomial1D **chebPolys = NULL; - psS32 i = 0; - psS32 j = 0; - - chebPolys = (psPolynomial1D **) psAlloc(maxChebyPoly * sizeof(psPolynomial1D *)); - for (i = 0; i < maxChebyPoly; i++) { - chebPolys[i] = psPolynomial1DAlloc(i + 1, PS_POLYNOMIAL_ORD); - } - - // Create the Chebyshev polynomials. - // Polynomial i has i-th order. - chebPolys[0]->coeff[0] = 1; - chebPolys[1]->coeff[1] = 1; - for (i = 2; i < maxChebyPoly; i++) { - for (j = 0; j < chebPolys[i - 1]->n; j++) { - chebPolys[i]->coeff[j + 1] = 2 * chebPolys[i - 1]->coeff[j]; - } - for (j = 0; j < chebPolys[i - 2]->n; j++) { - chebPolys[i]->coeff[j] -= chebPolys[i - 2]->coeff[j]; - } - } - - return (chebPolys); -} - -/***************************************************************************** -psImageFitPolynomial(): This routine takes as input a 2-D image and produces -as output the coefficients of the Chebyshev polynomials which match that -input image. - Input: - Output: - Internal Data Structures: - chebPolys[i][j] - sums[i][j]: This will contain the sum of - input->data.F32[x][y] * - psPolynomial1DEval( -chebPolys[i], -(float) x) * - psPolynomial1DEval( -chebPolys[j], -(float) y, -); - over all pixels (x,y) in the image. - *****************************************************************************/ -psPolynomial2D* psImageFitPolynomial(psPolynomial2D* coeffs, - const psImage* input) -{ - PS_ASSERT_IMAGE_NON_NULL(input, NULL); - PS_ASSERT_IMAGE_NON_EMPTY(input, NULL); - if ((input->type.type != PS_TYPE_S8) && - (input->type.type != PS_TYPE_U16) && - (input->type.type != PS_TYPE_F32) && - (input->type.type != PS_TYPE_F64)) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, "Unallowable image type.\n"); - } - PS_ASSERT_POLY_NON_NULL(coeffs, NULL); - PS_ASSERT_POLY_TYPE(coeffs, PS_POLYNOMIAL_CHEB, NULL); - psS32 x = 0; - psS32 y = 0; - psS32 i = 0; - psS32 j = 0; - double **sums = NULL; - psPolynomial1D* *chebPolys = NULL; - psS32 maxChebyPoly = 0; - double *cScalingFactors = NULL; - double *rScalingFactors = NULL; - - // Create the sums[][] data structure. This - // will hold the LHS of - // equation - // 29 in the ADD: sums[k][l] = SUM { - // image(x,y) * Tk(x) * Tl(y) } - sums = (double **)psAlloc(coeffs->nX * sizeof(double *)); - for (i = 0; i < coeffs->nX; i++) { - sums[i] = (double *)psAlloc(coeffs->nY * sizeof(double)); - } - // We scale the pixel positions to values - // between -1.0 and 1.0 - rScalingFactors = calcScaleFactors(input->numRows); - cScalingFactors = calcScaleFactors(input->numCols); - - // Determine how many Chebyshev polynomials - // are needed, then create them. - maxChebyPoly = coeffs->nX; - if (coeffs->nY > coeffs->nX) { - maxChebyPoly = coeffs->nY; - } - chebPolys = p_psCreateChebyshevPolys(maxChebyPoly); - - // Compute the sums[][] data structure. - for (i = 0; i < coeffs->nX; i++) { - for (j = 0; j < coeffs->nY; j++) { - sums[i][j] = 0.0; - for (x = 0; x < input->numRows; x++) { - for (y = 0; y < input->numCols; y++) { - double pixel = 0.0; - if (input->type.type == PS_TYPE_S8) { - pixel = (double) input->data.S8[x][y]; - } else if (input->type.type == PS_TYPE_U16) { - pixel = (double) input->data.U16[x][y]; - } else if (input->type.type == PS_TYPE_F32) { - pixel = (double) input->data.F32[x][y]; - } else if (input->type.type == PS_TYPE_F64) { - pixel = input->data.F64[x][y]; - } - sums[i][j] += pixel * psPolynomial1DEval(chebPolys[i],rScalingFactors[x]) * - psPolynomial1DEval(chebPolys[j], cScalingFactors[y]); - } - } - } - } - - for (i = 0; i < coeffs->nX; i++) { - for (j = 0; j < coeffs->nY; j++) { - coeffs->coeff[i][j] = sums[i][j]; - coeffs->coeff[i][j] /= (double)(input->numRows * input->numCols); - - if ((i != 0) && (j != 0)) { - coeffs->coeff[i][j] *= 4.0; - } else if ((i == 0) && (j == 0)) { - coeffs->coeff[i][j] *= 1.0; - } else { - coeffs->coeff[i][j] *= 2.0; - } - } - } - - // Free the Chebyshev polynomials that were - // created in this routine. - for (i = 0; i < maxChebyPoly; i++) { - psFree(chebPolys[i]); - } - psFree(chebPolys); - - // Free some data - for (i = 0; i < coeffs->nX; i++) { - psFree(sums[i]); - } - psFree(sums); - psFree(cScalingFactors); - psFree(rScalingFactors); - - return (coeffs); -} - - - - -/***************************************************************************** -psImageFitPolynomial(): This routine takes as input a 2-D image and produces -as output the coefficients of the Chebyshev polynomials which match that input -image. This is a TEST version of the code. It is not used by anything. - Input: - Output: - Internal Data Structures: - chebPolys[i][j] - sums[i][j]: This will contain the sum of - input->data.F32[x][y] * - psPolynomial1DEval( -chebPolys[i], -(float) x) * - psPolynomial1DEval( -chebPolys[j], -(float) y, -); - over all pixels (x,y) in the image. - *****************************************************************************/ -psPolynomial2D* psImageFitPolynomialTest(psPolynomial2D* coeffs, - const psImage* input) -{ - PS_ASSERT_IMAGE_NON_NULL(input, NULL); - PS_ASSERT_IMAGE_NON_EMPTY(input, NULL); - if ((input->type.type != PS_TYPE_S8) && - (input->type.type != PS_TYPE_U16) && - (input->type.type != PS_TYPE_F32) && - (input->type.type != PS_TYPE_F64)) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, "Unallowable image type.\n"); - } - PS_ASSERT_POLY_NON_NULL(coeffs, NULL); - PS_ASSERT_POLY_TYPE(coeffs, PS_POLYNOMIAL_CHEB, NULL); - psS32 x = 0; - psS32 y = 0; - psS32 i = 0; - psS32 j = 0; - double **sums = NULL; - psPolynomial1D* *chebPolys = NULL; - psS32 maxChebyPoly = 0; - double *cScalingFactors = NULL; - double *rScalingFactors = NULL; - psImage *nodes = psImageAlloc(input->numCols, input->numRows, PS_TYPE_F64); - - double min = -1.0; - double max = 1.0; - double bma = 0.5 * (max-min); // 1 - double bpa = 0.5 * (max+min); // 0 - // We must calculate the value of the image at the nodes where the - // Chebyshev polynomials are 0. - for (x = 0; x < input->numRows; x++) { - double xTmp = cos(M_PI * (0.5 + ((float) x)) / ((float) input->numRows)); - double xNode = - ((xTmp + bma + bpa) - 1.0); - double xOrig = ((float) input->numRows) * (xNode - min) / (max - min); - - for (y = 0; y < input->numCols; y++) { - double yTmp = cos(M_PI * (0.5 + ((float) y)) / ((float) input->numCols)); - double yNode = - ((yTmp + bma + bpa) - 1.0); - double yOrig = ((float) input->numCols) * (yNode - min) / (max - min); - - // nodes->data.F64[x][y] = psImagePixelInterpolate(input, yNode, xNode, NULL, 0, 0.0, PS_INTERPOLATE_BILINEAR); - // nodes->data.F64[x][y] = psImagePixelInterpolate(input, yTmp, xTmp, NULL, 0, 0.0, PS_INTERPOLATE_BILINEAR); - nodes->data.F64[x][y] = psImagePixelInterpolate(input, yOrig, xOrig, NULL, 0, 0.0, PS_INTERPOLATE_BILINEAR); - } - } - - // Create the sums[][] data structure. This - // will hold the LHS of - // equation - // 29 in the ADD: sums[k][l] = SUM { - // image(x,y) * Tk(x) * Tl(y) } - sums = (double **)psAlloc(coeffs->nX * sizeof(double *)); - for (i = 0; i < coeffs->nX; i++) { - sums[i] = (double *)psAlloc(coeffs->nY * sizeof(double)); - } - // We scale the pixel positions to values - // between -1.0 and 1.0 - rScalingFactors = calcScaleFactors(input->numRows); - cScalingFactors = calcScaleFactors(input->numCols); - - // Determine how many Chebyshev polynomials - // are needed, then create them. - maxChebyPoly = coeffs->nX; - if (coeffs->nY > coeffs->nX) { - maxChebyPoly = coeffs->nY; - } - chebPolys = p_psCreateChebyshevPolys(maxChebyPoly); - - // Compute the sums[][] data structure. - for (i = 0; i < coeffs->nX; i++) { - for (j = 0; j < coeffs->nY; j++) { - sums[i][j] = 0.0; - for (x = 0; x < input->numRows; x++) { - for (y = 0; y < input->numCols; y++) { - double pixel; - /* - if (input->type.type == PS_TYPE_S8) { - pixel = (double) input->data.S8[x][y]; - } else if (input->type.type == PS_TYPE_U16) { - pixel = (double) input->data.U16[x][y]; - } else if (input->type.type == PS_TYPE_F32) { - pixel = (double) input->data.F32[x][y]; - } else if (input->type.type == PS_TYPE_F64) { - pixel = input->data.F64[x][y]; - } - */ - pixel = nodes->data.F64[x][y]; - sums[i][j] += pixel * psPolynomial1DEval(chebPolys[i], rScalingFactors[x]) * - psPolynomial1DEval(chebPolys[j], cScalingFactors[y]); - } - } - } - } - - for (i = 0; i < coeffs->nX; i++) { - for (j = 0; j < coeffs->nY; j++) { - coeffs->coeff[i][j] = sums[i][j]; - coeffs->coeff[i][j] /= (double)(input->numRows * input->numCols); - - if ((i != 0) && (j != 0)) { - coeffs->coeff[i][j] *= 4.0; - } else if ((i == 0) && (j == 0)) { - coeffs->coeff[i][j] *= 1.0; - } else { - coeffs->coeff[i][j] *= 2.0; - } - } - } - - // Free the Chebyshev polynomials that were - // created in this routine. - for (i = 0; i < maxChebyPoly; i++) { - psFree(chebPolys[i]); - } - psFree(chebPolys); - - // Free some data - for (i = 0; i < coeffs->nX; i++) { - psFree(sums[i]); - } - psFree(sums); - psFree(cScalingFactors); - psFree(rScalingFactors); - psFree(nodes); - - return (coeffs); -} - -/***************************************************************************** -XXX: Use static variables for Chebyshev polynomials and scaling factors. - *****************************************************************************/ -psImage* p_psImageEvalPolynomialCheb(psImage* input, - const psPolynomial2D* coeffs) -{ - PS_ASSERT_POLY_TYPE(coeffs, PS_POLYNOMIAL_CHEB, NULL); - - psS32 x = 0; - psS32 y = 0; - psS32 i = 0; - psS32 j = 0; - psPolynomial1D* *chebPolys = NULL; - psS32 maxChebyPoly = 0; - double *cScalingFactors = NULL; - double *rScalingFactors = NULL; - float polySum = 0.0; - - // We scale the pixel positions to values between -1.0 and 1.0 - // Use static data structures here. - rScalingFactors = calcScaleFactors(input->numRows); - cScalingFactors = calcScaleFactors(input->numCols); - - // Determine how many Chebyshev polynomials - // are needed, then create them. - maxChebyPoly = coeffs->nX; - if (coeffs->nY > coeffs->nX) { - maxChebyPoly = coeffs->nY; - } - - chebPolys = p_psCreateChebyshevPolys(maxChebyPoly); - - for (x = 0; x < input->numRows; x++) { - for (y = 0; y < input->numCols; y++) { - polySum = 0.0; - for (i = 0; i < coeffs->nX; i++) { - for (j = 0; j < coeffs->nY; j++) { - polySum += - psPolynomial1DEval(chebPolys[i], rScalingFactors[x]) * - psPolynomial1DEval(chebPolys[j], cScalingFactors[y]) * - coeffs->coeff[i][j]; - } - } - - if (input->type.type == PS_TYPE_S8) { - input->data.S8[x][y] = (char) polySum; - } else if (input->type.type == PS_TYPE_U16) { - input->data.U16[x][y] = (short int) polySum; - } else if (input->type.type == PS_TYPE_F32) { - input->data.F32[x][y] = (float) polySum; - } else if (input->type.type == PS_TYPE_F64) { - input->data.F64[x][y] = polySum; - } - } - } - - // Free the Chebyshev polynomials that were - // created in this routine. - // XXX: Use static data structures here. - for (i = 0; i < maxChebyPoly; i++) { - psFree(chebPolys[i]); - } - psFree(chebPolys); - - psFree(cScalingFactors); - psFree(rScalingFactors); - - return input; -} - -psImage* p_psImageEvalPolynomialOrd(psImage* input, - const psPolynomial2D* coeffs) -{ - PS_ASSERT_POLY_TYPE(coeffs, PS_POLYNOMIAL_ORD, NULL); - - for (int row = 0; row < input->numRows ; row++) { - for (int col = 0; col < input->numCols ; col++) { - if (input->type.type == PS_TYPE_S8) { - input->data.S8[row][col] = (psS8) psPolynomial2DEval(coeffs, (psF32) row, (psF32) col); - } else if (input->type.type == PS_TYPE_U16) { - input->data.U16[row][col] = (psS16) psPolynomial2DEval(coeffs, (psF32) row, (psF32) col); - } else if (input->type.type == PS_TYPE_F32) { - input->data.F32[row][col] = psPolynomial2DEval(coeffs, (psF32) row, (psF32) col); - } else if (input->type.type == PS_TYPE_F64) { - input->data.F64[row][col] = (psF64) psPolynomial2DEval(coeffs, (psF32) row, (psF32) col); - } - } - } - - return(input); -} - - -/***************************************************************************** -XXX: I added normal polynomials to this routine. Let IfA know, put it in the -psLib SDR. - *****************************************************************************/ -psImage* psImageEvalPolynomial(psImage* input, - const psPolynomial2D* coeffs) -{ - PS_ASSERT_IMAGE_NON_NULL(input, NULL); - PS_ASSERT_IMAGE_NON_EMPTY(input, NULL); - if ((input->type.type != PS_TYPE_S8) && - (input->type.type != PS_TYPE_U16) && - (input->type.type != PS_TYPE_F32) && - (input->type.type != PS_TYPE_F64)) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - "Unallowable image type.\n"); - } - PS_ASSERT_POLY_NON_NULL(coeffs, NULL); - - if (coeffs->type == PS_POLYNOMIAL_ORD) { - return(p_psImageEvalPolynomialOrd(input, coeffs)); - } else if (coeffs->type == PS_POLYNOMIAL_CHEB) { - return(p_psImageEvalPolynomialCheb(input, coeffs)); - } - printf("XXX: Error: wrong polynomial type\n"); - // XXX: psError() - return(NULL); -} - Index: unk/psLib/src/image/psImageStats.h =================================================================== --- /trunk/psLib/src/image/psImageStats.h (revision 4545) +++ (revision ) @@ -1,89 +1,0 @@ -/** @file psImageStats.h -* \brief Routines for calculating statistics on images. -* @ingroup ImageStats -* -* This file will hold the prototypes for procedures which calculate -* statistic on images, histograms on images, and fit/evaluate Chebyshev -* polynomials to images. -* -* @author GLG, MHPCC -* -* @version $Revision: 1.24 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-25 00:51:28 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ -#ifndef PS_IMAGE_STATS_H -#define PS_IMAGE_STATS_H - -#include "psType.h" -#include "psVector.h" -#include "psImage.h" -#include "psStats.h" -#include "psFunctions.h" - -/// @addtogroup ImageStats -/// @{ - -/** This routine must determine the various statistics for the image. - * - * Determine statistics for image (or subimage). The statistics to be - * determined are specified by stats. The mask allows pixels to be excluded - * if their corresponding mask pixel value matches the value of maskVal. - * This function must be defined for the following types: psS8, psU16, psF32, - * psF64. - * - * @return psStats* the resulting statistics result(s) - */ -psStats* psImageStats( - psStats* stats, ///< defines statistics to be calculated - const psImage* in, ///< image (or subimage) to calculate stats - const psImage* mask, ///< mask data for image (NULL ok) - psMaskType maskVal ///< mask value for mask -); - -/** Construct a histogram from an image (or subimage). - * - * The histogram to generate is specified by psHistogram hist (see section - * 4.3.2 in SDRS). This function must be defined for the following types: - * psS8, psU16, psF32, psF64. - * - * @return psHistogram* the resulting histogram - */ -psHistogram* psImageHistogram( - psHistogram* out, ///< input histogram description & target - const psImage* in, ///< Image data to be histogramed. - const psImage* mask, ///< mask data for image (NULL ok) - psMaskType maskVal ///< mask Mask for mask -); - -/** Fit a 2-D polynomial surface to an image. - * - * The input structure coeffs contains the desired order and terms of - * interest. This function must be defined for the following types: psS8, - * psU16, psF32, psF64. - * - * @return psPolynomial2D* fitted polynomial result - * - */ -psPolynomial2D* psImageFitPolynomial( - psPolynomial2D* coeffs, ///< coefficient structure carries in desired terms & target - const psImage* input ///< input image -); - -/** Evaluate a 2-D polynomial surface for the image pixels. - * - * Given the input polynomial coefficients, set the image pixel values on the - * basis of the polynomial function. This function must be defined for the - * following types: psS8, psU16, psF32, psF64. - * - * @return psImage* the resulting image - */ -psImage* psImageEvalPolynomial( - psImage* input, ///< input image - const psPolynomial2D* coeffs ///< coefficient structure carries in desired terms -); - -/// @} - -#endif // #ifndef PS_IMAGE_STATS_H Index: unk/psLib/src/image/psImageStructManip.c =================================================================== --- /trunk/psLib/src/image/psImageStructManip.c (revision 4545) +++ (revision ) @@ -1,379 +1,0 @@ -/** @file psImageStructManip.c - * - * @brief Contains basic image structure manipulations, as specified in the - * PSLIB SDRS sections "Image Structure Manipulation". - * - * @ingroup Image - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-09 01:24:30 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - * - */ - -#include - -#include "psMemory.h" -#include "psImageStructManip.h" -#include "psError.h" - -#include "psImageErrors.h" - -static psImage* imageSubset(psImage* out, - psImage* image, - psS32 col0, - psS32 row0, - psS32 col1, - psS32 row1) -{ - psU32 elementSize; // size of image element in bytes - psS32 inputColOffset; // offset in bytes to first subset pixel in input row - - if ( col0 < 0 || row0 < 0 ) { - // psError(PS_ERR_BAD_PARAMETER_VALUE, true, - // PS_ERRORTEXT_psImage_SUBSET_RANGE_INVALID); - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_SUBSET_RANGE_INVALID, - col0, col1-1, row0, row1-1, - image->numCols-1, image->numRows-1); - return NULL; - } - - if (image == NULL || image->data.V == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - return NULL; - } - - if (image->type.dimen != PS_DIMEN_IMAGE) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_NOT_AN_IMAGE); - return NULL; - } - - if (col1 < 1) { - col1 = image->numCols + col1; - } - if (row1 < 1) { - row1 = image->numRows + row1; - } - - if ( col1 <= col0 || - row1 <= row0 || - col0 >= image->numCols || - row0 >= image->numRows || - col1 > image->numCols || - row1 > image->numRows ) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_SUBSET_RANGE_INVALID, - col0, col1-1, row0, row1-1, - image->numCols-1, image->numRows-1); - return NULL; - } - - - - psS32 numRows = row1-row0; - psS32 numCols = col1-col0; - - elementSize = PSELEMTYPE_SIZEOF(image->type.type); - - if (image->parent != NULL) { // if this is a child, we need to start working with parent. - col0 += image->col0; - col1 += image->col0; - row0 += image->row0; - row1 += image->row0; - image = (psImage*)image->parent; - } - - // increment the raw data buffer before freeing anything in the 'out' - psPtr rawData = psMemIncrRefCounter(image->rawDataBuffer); - - if (out != NULL) { - // if a child, need to orphan (disassociate from parent) first - if (out->parent != NULL) { - psArrayRemove(out->parent->children,out); // remove from parent's knowledge - out->parent = NULL; // break link to parent - } - - psFree(out->rawDataBuffer); // free the previous data reference - } else { - out = psAlloc(sizeof(psImage)); - out->data.V = NULL; - } - - out->data.V = psRealloc(out->data.V,sizeof(psPtr)*numRows); // resize row pointer array - *(psMathType*)&out->type = image->type; - // *(psU32*)&out->numCols = numCols; - // *(psU32*)&out->numRows = numRows; - *(psS32*)&out->numCols = numCols; - *(psS32*)&out->numRows = numRows; - *(psS32*)&out->row0 = row0; - *(psS32*)&out->col0 = col0; - out->parent = image; - out->children = NULL; - out->rawDataBuffer = rawData; - - // set the new psImage's deallocator to the same as the input image - psMemSetDeallocator(out,psMemGetDeallocator(image)); - - inputColOffset = elementSize * col0; - for (psS32 row = 0; row < numRows; row++) { - out->data.V[row] = image->data.U8[row0 + row] + inputColOffset; - } - - // add output image as a child of the input image. - psS32 n = 0; - psArray* children = image->children; - if (children == NULL) { - children = psArrayAlloc(16); // start with a reasonable size for growth - } else if (children->nalloc == children->n) { // full? - n = children->n; - children = psArrayRealloc(children,n*2); // double the array size - } else { - n = children->n; - } - children->data[n] = out; - children->n = n+1; - image->children = children; // push back any change (esp. if children==NULL before) - - return (out); -} - -psImage* psImageSubset(psImage* image, - psRegion region) -{ - return imageSubset(NULL,image,region.x0, region.y0, - region.x1, region.y1); -} - -psImage* psImageCopy(psImage* output, - const psImage* input, - psElemType type) -{ - psElemType inDatatype; - psS32 elementSize; - psS32 elements; - psS32 numRows; - psS32 numCols; - - if (input == NULL || input->data.V == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - psFree(output); - return NULL; - } - - if (input == output) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_INPLACE_NOTSUPPORTED); - psFree(output); - return NULL; - } - - if (input->type.dimen != PS_DIMEN_IMAGE) { - psError(PS_ERR_BAD_PARAMETER_TYPE, true, - PS_ERRORTEXT_psImage_NOT_AN_IMAGE); - psFree(output); - return NULL; - } - - inDatatype = input->type.type; - numRows = input->numRows; - numCols = input->numCols; - elements = numRows * numCols; - elementSize = PSELEMTYPE_SIZEOF(inDatatype); - - output = psImageRecycle(output, numCols, numRows, type); - - // cover the trival case of copy of the same - // datatype. - if (type == inDatatype) { - for (psS32 row=0;rowdata.V[row], input->data.V[row], elementSize * numCols); - } - return output; - } - - #define PSIMAGE_ELEMENT_COPY(IN,INTYPE,OUT,OUTTYPE,ELEMENTS) { \ - ps##INTYPE *in; \ - ps##OUTTYPE *out; \ - for(psS32 row=0;rowdata.INTYPE[row]; \ - out = OUT->data.OUTTYPE[row]; \ - for (psS32 col=0;coldata.V == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psImage_IMAGE_NULL); - return NULL; - } - - if (image->parent != NULL) { - return imageSubset(image, - (psImage*)image->parent, - region.x0+image->col0, - region.y0+image->row0, - region.x1+image->col0, - region.y1+image->row0); - } - - int col0 = region.x0; - int row0 = region.y0; - int col1 = region.x1; - int row1 = region.y1; - - if (col1 < 1) { - col1 += image->numCols; - } - - if (row1 < 1) { - row1 += image->numRows; - } - - if ( col0 < 0 || - row0 < 0 || - col1 > image->numCols || - row1 > image->numRows || - col0 >= col1 || - row0 >= row1 ) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psImage_SUBSET_RANGE_INVALID, - col0, col1-1, row0, row1-1, - image->numCols-1, image->numRows-1); - psFree(image); - return NULL; - } - - psImageFreeChildren(image); - - psU32 elementSize = PSELEMTYPE_SIZEOF(image->type.type); - psU32 numCols = col1-col0; - psU32 numRows = row1-row0; - psU32 rowSize = elementSize*numCols; - psU32 colOffset = elementSize * col0; - psU8* imageData = image->rawDataBuffer; - for (psS32 row = row0; row < row1; row++) { - memmove(imageData,image->data.U8[row] + colOffset,rowSize); - imageData += rowSize; - } - - *(psU32*)&image->numRows = numRows; - *(psU32*)&image->numCols = numCols; - - // XXX: should I really resize the buffers? - image->data.V = psRealloc(image->data.V,sizeof(psPtr)*numRows); - image->rawDataBuffer = psRealloc(image->rawDataBuffer,rowSize*numRows); - - image->data.V[0] = image->rawDataBuffer; - for (psS32 r = 1; r < numRows; r++) { - image->data.U8[r] = image->data.U8[r-1] + rowSize; - } - - return (image); -} - Index: unk/psLib/src/image/psImageStructManip.h =================================================================== --- /trunk/psLib/src/image/psImageStructManip.h (revision 4545) +++ (revision ) @@ -1,84 +1,0 @@ -/** @file psImageStructManip.h -* -* @brief Contains basic image structure manipulation operations, as specified -* in the PSLIB SDRS sections "Image Structure Manipulation". -* -* @ingroup Image -* -* @author Robert DeSonia, MHPCC -* -* @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-06-08 23:40:45 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#ifndef PSIMAGE_STRUCT_MANIP_H -#define PSIMAGE_STRUCT_MANIP_H - -#include "psImage.h" - -/// @addtogroup Image -/// @{ - -/** Create a subimage of the specified area. - * - * Define a subimage of the specified area of the given image. This function - * must raise an error if the requested subset area lies outside of the - * parent image and return NULL. The argument image is the parent image, - * region.x0, region.y0 specify the starting pixel of the subraster, and - * region.x1,region.y1 specify the extent of the desired subraster. Note - * that the row and column of this “upper right-hand corner” are NOT included - * in the region. In the event that x1 or y1 are negative, they shall be - * interpreted as being relative to the size of the parent image in that - * dimension. The entire subraster must be contained within the raster of the - * parent image. Note that the refCounter for the parent should be - * incremented. This function must be defined for the following types: psU8, - * psU16, psS8, psS16, psF32, psF64, psC32, psC64. - * - * @return psImage* : Pointer to psImage. - * - */ -psImage* psImageSubset( - psImage* image, ///< Parent image. - psRegion region ///< region of subimage -); - -/** Makes a copy of a psImage - * - * @return psImage* Copy of the input psImage. This may not be equal to the - * output parameter - * - */ -psImage* psImageCopy( - psImage* output, ///< if not NULL, a psImage that could be recycled. - const psImage* input, ///< the psImage to copy - psElemType type ///< the desired datatype of the returned copy -); - -/** Trim an image - * - * Trim the specified image in-place, which involves shuffling the pixels - * around in memory. The pixels in the region [col0:col1,row0:row1] shall consist - * the output image. The column col1 and row row1 are NOT included in the range. - * In the event that x1 or y1 are non-positive, they shall be interpreted as - * being relative to the size of the parent image in that dimension. - * - * If the entire specified subimage is not contained within the parent - * image, an error results and the return value will be NULL. - * - * N.B. If the input psImage is a child of another psImage, no pixel data - * will be trimmed, rather it equivalent to calling psImageSubset. If the input - * psImage is, however, a parent psImage, any children will be obliterated, - * i.e., freed from memory. - * - * @return psImage* trimmed image result - */ -psImage* psImageTrim( - psImage* image, ///< image to trim - psRegion region ///< trim region -); - -/// @} - -#endif // #ifndef PSIMAGE_STRUCT_MANIP_H Index: unk/psLib/src/sysUtils/.cvsignore =================================================================== --- /trunk/psLib/src/sysUtils/.cvsignore (revision 4545) +++ (revision ) @@ -1,7 +1,0 @@ -Makefile.in -.deps -.libs -Makefile -*.lo -*.la - Index: unk/psLib/src/sysUtils/Makefile.am =================================================================== --- /trunk/psLib/src/sysUtils/Makefile.am (revision 4545) +++ (revision ) @@ -1,40 +1,0 @@ -#Makefile for sysUtils functions of psLib -# -INCLUDES = \ - -I$(top_srcdir)/src/astronomy \ - -I$(top_srcdir)/src/collections \ - -I$(top_srcdir)/src/dataManip \ - -I$(top_srcdir)/src/dataIO \ - -I$(top_srcdir)/src/image \ - $(all_includes) - -noinst_LTLIBRARIES = libpslibsysUtils.la - -libpslibsysUtils_la_SOURCES = \ - psMemory.c \ - psError.c \ - psTrace.c \ - psLogMsg.c \ - psAbort.c \ - psString.c \ - psConfigure.c \ - psErrorCodes.c - -BUILT_SOURCES = psSysUtilsErrors.h -EXTRA_DIST = psSysUtilsErrors.dat psSysUtilsErrors.h sysUtils.i - -psSysUtilsErrors.h: psSysUtilsErrors.dat - $(top_srcdir)/src/psParseErrorCodes --data=$? $@ - -pslibincludedir = $(includedir) -pslibinclude_HEADERS = \ - psType.h \ - psMemory.h \ - psError.h \ - psTrace.h \ - psLogMsg.h \ - psAbort.h \ - psString.h \ - psConfigure.h \ - psErrorCodes.h - Index: unk/psLib/src/sysUtils/psAbort.c =================================================================== --- /trunk/psLib/src/sysUtils/psAbort.c (revision 4545) +++ (revision ) @@ -1,38 +1,0 @@ - -/** @file psAbort.c - * - * @brief Contains the definition for abort function - * - * The abort logging and handling shall be performed by psAbort function. - * This will allow for consistent handling of other software units - * needing to abort from program execution. - * - * @author Eric Van Alst, MHPCC - * - * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-17 23:39:51 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include -#include "psAbort.h" -#include "psLogMsg.h" - -void psAbort(const char *name, const char *format, ...) -{ - va_list argPtr; // variable list arguement pointer - - // Get the variable list parameters to pass to logging function - va_start(argPtr, format); - - // Call logging function with PS_LOG_ABORT level - psLogMsgV(name, PS_LOG_ABORT, format, argPtr); - - // Clean up stack after variable arguement has been used - va_end(argPtr); - - // Call system abort function to terminate program execution - abort(); -} Index: unk/psLib/src/sysUtils/psAbort.h =================================================================== --- /trunk/psLib/src/sysUtils/psAbort.h (revision 4545) +++ (revision ) @@ -1,47 +1,0 @@ - -/** @file psAbort.h - * - * @brief Contains the declarations for the abort function - * - * The abort logging and handling shall be performed by psAbort function. - * This will allow for consistent handling of other software units - * needing to abort from program execution. - * - * @ingroup ErrorHandling - * - * @author Eric Van Alst, MHPCC - * - * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-17 23:39:51 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_ABORT_H -#define PS_ABORT_H - -// Doxygen grouping tags - -/** @addtogroup ErrorHandling - * @{ - */ - -/** Reports an abort message to logging facility - * - * This function will invoke the psLogMsg function with a level of - * PS_LOG_ABORT and pass the parameters name and fmt to generate a proper - * log message. After logging, this function will call system abort - * function to abnormally terminate the program. - * - * @return void No return value - * - */ -void psAbort( - const char *name, ///< Source of abort such as file or function detected - const char *format, ///< A printf style formatting statement defining msg - ... -); - -/** @} */ // Doxygen - End of SystemGroup Functions - -#endif // #ifndef PS_ABORT_H Index: unk/psLib/src/sysUtils/psConfigure.c =================================================================== --- /trunk/psLib/src/sysUtils/psConfigure.c (revision 4545) +++ (revision ) @@ -1,56 +1,0 @@ -/** @file psConfigure.c - * - * @brief Contains the declarations for initialization, memory finalization, - * and configuration. - * - * These functions initalize psLib data before the beginning of a run and - * remove (finalize) the same data after the run is complete. A function is - * also provided to return the current psLib version. - * - * @ingroup Configure - * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-11 02:19:05 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ -#include "psString.h" -#include "psTime.h" -#include "psError.h" -#include "psConfigure.h" -#include "psSysUtilsErrors.h" -#include "config.h" - -char* psLibVersion(void) -{ - char version[80]; - snprintf(version,80,"%s-v%s",PACKAGE_NAME,PACKAGE_VERSION); - - return(psStringCopy(version)); -} - -void psLibInit(const char* timeConfig) -{ - // XXX: Still needs error codes to be set - // XXX: Still needs random number generator initialization - - if(!p_psTimeInit(timeConfig)) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psConfigure_INITIALIZATION_FAILED, "psTime"); - return; - } -} - -void psLibFinalize(void) -{ - // Users of persistent memory should free them in this function - - if(!p_psTimeFinalize()) { - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psConfigure_FINALIZATION_FAILED, "psTime"); - return; - } -} Index: unk/psLib/src/sysUtils/psConfigure.h =================================================================== --- /trunk/psLib/src/sysUtils/psConfigure.h (revision 4545) +++ (revision ) @@ -1,63 +1,0 @@ -/** @file psConfigure.h - * - * @brief Contains the declarations for initialization, memory finalization, - * and configuration. - * - * These functions initalize psLib data before the beginning of a run and - * remove (finalize) the same data after the run is complete. A function is - * also provided to return the current psLib version. - * - * @ingroup Configure - * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-10 01:41:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_CONFIGURE_H -#define PS_CONFIGURE_H - -/** @addtogroup Configure - * @{ - */ - -/** Get current psLib version - * - * Returns the current psLib version name as a string. - * - * @return char*: String with version name. - */ -char* psLibVersion( - void -); - -/** Initializes persistent memory. - * - * Creates persistant memory items used throughout psLib. Items created - * within this method should be freed with the psLibFinalize function. - * current, a non-NULL psErr is returned with code PS_ERR_NONE. - * - */ -void psLibInit( - const char* timeConfig ///< Filename of config file for psTime. -); - -/** Removes persistant memory created with the psLibInit function. - * - * The memory created but not freed by psLib modules should be freed - * within this function at the end of a psLib execution cycle. - * - * @return void: void. - */ -void psLibFinalize( - void -); - - -/** @} */ - -#endif // #ifndef PS_CONFIGURE_H Index: unk/psLib/src/sysUtils/psError.c =================================================================== --- /trunk/psLib/src/sysUtils/psError.c (revision 4545) +++ (revision ) @@ -1,216 +1,0 @@ -/** @file psError.c - * - * @brief Contains the definitions for the error reporting functions - * - * Error reporting functions shall be used to create log entries in the - * event errors are detected. The messages shall give enough information - * to allow the user to know where the error has occurred and the type - * of error detected. - * - * @author Eric Van Alst, MHPCC - * - * @version $Revision: 1.28 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include -#include - -#include "psLogMsg.h" -#include "psError.h" -#include "psMemory.h" - -#define MAX_ERROR_STACK_SIZE 64 -static psErr* errorStack[MAX_ERROR_STACK_SIZE]; -static psU32 errorStackSize = 0; -pthread_mutex_t lockErrorStack = PTHREAD_MUTEX_INITIALIZER; - -static void pushErrorStack(psErr* err); - -static void pushErrorStack(psErr* err) -{ - - pthread_mutex_lock(&lockErrorStack); - - if (errorStackSize < MAX_ERROR_STACK_SIZE) { - errorStack[errorStackSize] = psMemIncrRefCounter(err); - errorStackSize++; - p_psMemSetPersistent(err,true); - p_psMemSetPersistent(err->msg,true); - p_psMemSetPersistent(err->name,true); - } - - pthread_mutex_unlock(&lockErrorStack); -} - -static void errFree(psErr* err) -{ - if (err != NULL) { - psFree(err->msg); - psFree(err->name); - } -} - -psErr* psErrAlloc(const char* name, psErrorCode code, const char* msg) -{ - psErr* err = psAlloc(sizeof(psErr)); - err->msg = strcpy(psAlloc(strlen(msg) + 1), msg); - err->name = strcpy(psAlloc(strlen(name) + 1), name); - err->code = code; - - psMemSetDeallocator(err,(psFreeFunc)errFree); - - return err; -} - -psErrorCode p_psError(const char* filename, - unsigned int lineno, - const char* func, - psErrorCode code, - bool new, - const char* format, - ...) -{ - char errMsg[2048]; - psErr* err; - char msgName[1024]; - - snprintf(msgName,1024,"%s (%s:%d)",func,filename,lineno); - - va_list argPtr; // variable list arguement pointer - - if (new) { - psErrorClear(); - } - - // Get the variable list parameters to pass to logging function - va_start(argPtr, format); - - vsnprintf(errMsg,2048,format,argPtr); - err = psErrAlloc(msgName,code,errMsg); - pushErrorStack(err); - - // Call logging function with PS_LOG_ERROR level - psLogMsg(msgName, PS_LOG_ERROR, errMsg); - - // Clean up stack after variable argument has been used - va_end(argPtr); - - psFree(err); - - return code; -} - -void p_psWarning(const char* file, - int lineno, - const char* func, - const char* fmt, - ...) -{ - char msgName[1024]; - - snprintf(msgName,1024,"%s (%s:%d)",func,file,lineno); - - va_list argPtr; // variable list argument pointer - - // Get the variable list parameters to pass to logging function - va_start(argPtr, fmt); - - psLogMsgV(msgName, PS_LOG_WARN, fmt, argPtr); - - // Clean up stack after variable argument has been used - va_end(argPtr); - - return; -} - -psErr* psErrorGet(psS32 which) -{ - psErr* result; - - pthread_mutex_lock(&lockErrorStack); - - // Check for negative reference and if found return PS_ERR_NONE - if (which < 0 ) { - result = psErrAlloc("", PS_ERR_NONE, ""); - } else { - - which = errorStackSize-1-which; // the which input is from the end of errorStack - if (which < 0 || which >= errorStackSize) { - result = psErrAlloc("",PS_ERR_NONE,""); // no error at the given location - } else { - result = psMemIncrRefCounter(errorStack[which]); // a new reference passed back - } - } - - pthread_mutex_unlock(&lockErrorStack); - - return result; -} - -unsigned int psErrorGetStackSize() -{ - return errorStackSize; -} - -psErr* psErrorLast(void) -{ - return psErrorGet(0); -} - -void psErrorClear(void) -{ - pthread_mutex_lock(&lockErrorStack); - - for (int lcv=0;lcv < errorStackSize; lcv++) { - p_psMemSetPersistent(errorStack[lcv],false); - p_psMemSetPersistent(errorStack[lcv]->msg,false); - p_psMemSetPersistent(errorStack[lcv]->name,false); - psFree(errorStack[lcv]); - } - errorStackSize = 0; - - pthread_mutex_unlock(&lockErrorStack); - -} -void psErrorStackPrint(FILE *fd, const char *format, ...) -{ - va_list argPtr; // variable list arguement pointer - - // Get the variable list parameters to pass to logging function - va_start(argPtr, format); - - psErrorStackPrintV(fd,format,argPtr); - - va_end(argPtr); -} - -void psErrorStackPrintV(FILE *fd, const char *format, va_list va) -{ - - pthread_mutex_lock(&lockErrorStack); - - if (errorStackSize > 0) { - vfprintf(fd,format,va); - - for (psS32 lcv=0;lcvcode >= PS_ERR_BASE) { - fprintf(fd," -> %s: %s\n %s\n", - errorStack[lcv]->name, - psErrorCodeString(errorStack[lcv]->code), - errorStack[lcv]->msg); - } else { - fprintf(fd," -> %s: %s\n %s\n", - errorStack[lcv]->name, - strerror(errorStack[lcv]->code), - errorStack[lcv]->msg); - } - } - } - - pthread_mutex_unlock(&lockErrorStack); -} - Index: unk/psLib/src/sysUtils/psError.h =================================================================== --- /trunk/psLib/src/sysUtils/psError.h (revision 4545) +++ (revision ) @@ -1,196 +1,0 @@ -/** @file psError.h - * - * @brief Contains the declarations for the error reporting functions - * - * Error reporting functions shall be used to create log entries in the - * event errors are detected. The messages shall give enough information - * to allow the user to know where the error has occurred and the type - * of error detected. - * - * @ingroup ErrorHandling - * - * @author Eric Van Alst, MHPCC - * - * @version $Revision: 1.25 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_ERROR_H -#define PS_ERROR_H - -#include -#include -#include - -#include "psErrorCodes.h" - -/** @addtogroup ErrorHandling - * @{ - */ - -/** Error message object */ -typedef struct -{ - char* name; ///< category of code that caused the error - psErrorCode code; ///< class of error - char* msg; ///< the message associated with the error -} -psErr; - -/** Get a error from the error stack - * - * Previous errors on the stack are returned by psErrorGet (a value of 0 - * passed to psErrorGet is equivalent to a call to psErrorLast). - * - * if no error is at the which position, a non-NULL psErr is returned with - * code PS_ERR_NONE. - * - * @return Error message object at 'which' - */ -psErr* psErrorGet( - psS32 which ///< position in the error stack. 0 is last error on stack. -); - -/** Get last error put on the error stack - * - * The last error reported is available from psErrorLast; if no errors are - * current, a non-NULL psErr is returned with code PS_ERR_NONE. - * - * @return psErr* Reference to last error message on error stack - */ -psErr* psErrorLast(void); - -/** Clears the error stack. - * - * The error stack may be completely cleared with psErrorClear. - * - */ -void psErrorClear(void); - -/** Get the error stack depth - * - * @return psS32 The number of items on the error stack - */ -unsigned int psErrorGetStackSize(); - -/** Prints error stack to specified open file descriptor - * - * The entire error stack may be printed to an open file descriptor by - * calling psErrorStackPrint; if and only if there are current errors, the - * printf-style string fmt is first printed to the file descriptor fd. In - * this printout, error codes are replaced by their string equivalents. - * - */ -void psErrorStackPrint( - FILE* fd, ///< destination file descriptor - const char* format, ///< printf-style format of header line - ... ///< any parameters required in fmt -); - -#ifndef SWIG -/** Prints error stack to specified open file descriptor - * - * The entire error stack may be printed to an open file descriptor by - * calling psErrorStackPrintV; if and only if there are current errors, the - * vprintf-style string fmt is first printed to the file descriptor fd. In - * this printout, error codes are replaced by their string equivalents. - * - */ -void psErrorStackPrintV( - FILE* fd, ///< destination file descriptor - const char* format, ///< printf-style format of header line - va_list va ///< any parameters required in fmt -); -#endif // #ifndef SWIG - -#ifdef DOXYGEN -/** Reports an error message to the logging facility - * - * This function will invoke the psLogMsg function with a level of - * PS_LOG_ERROR and pass the parameters name and fmt to generate a proper - * log message. - * - * This function modifies the error stack. - * - * @return psErrorCode the given error code - */ -psErrorCode psError( - psErrorCode code, ///< Error class code - psBool new, ///< true if error originates at this location - const char* fmt, ///< printf-style format of header line - ... ///< any parameters required in fmt -); - -/** Logs a warning message. - * - * This procedure logs a message to the destination set by a prior - * call to psLogSetDestination(), This is equivalent to calling - * psLogMsg with a level of PS_LOG_WARN. - * - */ -void psWarning( - const char* fmt, ///< printf-style format of header line - ... ///< any parameters required in fmt -); -#else // #ifdef DOXYGEN - -/** Reports an error message to the logging facility - * - * This function will invoke the psLogMsg function with a level of - * PS_LOG_ERROR and pass the parameters name and fmt to generate a proper - * log message. This function is used to check a specific code location. - * - * This function modifies the error stack. - * - * @return psErrorcode the given error code - */ -psErrorCode p_psError( - const char* filename, ///< file name - unsigned int lineno, ///< line number in file - const char* func, ///< function name - psErrorCode code, ///< Error class code - bool new, ///< true if error originates at this location - const char* format, ///< printf-style format of header line - ... ///< any parameters required in fmt -); - -/** Logs a warning message. - * - * This procedure logs a message to the destination set by a prior call to - * psLogSetDestination(). This is equivalent to calling psLogMsg with a level of - * PS_LOG_WARN. This function is used to check a specific code location. - * -*/ -void p_psWarning( - const char* file, ///< file name - int lineno, ///< line number in file - const char* func, ///< function name - const char* fmt, ///< printf-style format of header line - ... ///< any parameters required in fmt -); - - -#ifndef SWIG -#define psError(code,new,...) p_psError(__FILE__,__LINE__,__func__,code,new,__VA_ARGS__) -#define psWarning(...) p_psWarning(__FILE__,__LINE__,__func__,__VA_ARGS__) -#endif // #ifndef SWIG - -#endif // ! DOXYGEN - -/** Create a new psErr struct - * - * Creates a new psErr struct, making a copy of the parameters. - * - * @return psErr* new psErr object - */ -psErr* psErrAlloc( - const char* name, ///< Name of error in the form aaa.bbb.ccc - psErrorCode code, ///< Error class code - const char* msg ///< Error message -); - -/* @} */// End of SysUtils Functions - -#endif Index: unk/psLib/src/sysUtils/psErrorCodes.c =================================================================== --- /trunk/psLib/src/sysUtils/psErrorCodes.c (revision 4545) +++ (revision ) @@ -1,188 +1,0 @@ -/** @file psErrorCodes.c - * - * @brief Contains the error codes for the error classes - * - * @ingroup ErrorHandling - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.19 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-25 02:02:05 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include - -#include "psError.h" -#include "psErrorCodes.h" -#include "psList.h" -#include "psMemory.h" - -#include "psSysUtilsErrors.h" - -/* N.B., lines between '//~Start' and '//~End' are automatic generated from - * the template following the '//~Start'. The template is used to generate - * the other lines by, for each error class in psErrorCodes.dat, the following - * substitutions are made: - * $1 The error code name (first word in the psErrorCodes.dat lines) - * $2 The error description (rest of the line in psErrorCodes.dat) - * $n The order of the source line in psErrorCodes.dat (comments excluded) - * - * DO NOT EDIT THE LINES BETWEEN //~Start and //~End! ANY CHANGES WILL BE OVERWRITTEN. - */ - -static psErrorDescription staticErrorCodes[] = { - {PS_ERR_NONE,"not an error"}, - {PS_ERR_BASE,"base error"}, - //~Start {PS_ERR_$1,"$2"}, - {PS_ERR_UNKNOWN,"unknown error"}, - {PS_ERR_IO,"I/O error"}, - {PS_ERR_LOCATION_INVALID,"specified location is unknown"}, - {PS_ERR_MEMORY_CORRUPTION,"memory corruption detected"}, - {PS_ERR_MEMORY_DEREF_USAGE,"dereferenced memory still used"}, - {PS_ERR_BAD_PARAMETER_VALUE,"parameter is out-of-range"}, - {PS_ERR_BAD_PARAMETER_TYPE,"parameter is of unsupported type"}, - {PS_ERR_BAD_PARAMETER_NULL,"parameter is null"}, - {PS_ERR_BAD_PARAMETER_SIZE,"size of parameter's data is outside of acceptable range."}, - {PS_ERR_UNEXPECTED_NULL,"unexpected NULL found"}, - {PS_ERR_OS_CALL_FAILED,"unexpected result from an OS standard library call"}, - //~End - {PS_ERR_N_ERR_CLASSES,"error classes end marker"} - }; - -static psList* dynamicErrorCodes = NULL; -static const psErrorDescription* getErrorDescription(psErrorCode code); - - -static const psErrorDescription* getErrorDescription(psErrorCode code) -{ - // first, search the static error codes - - psS32 n = 0; - while(staticErrorCodes[n].code != PS_ERR_N_ERR_CLASSES && - staticErrorCodes[n].code != code) { - n++; - } - - if (staticErrorCodes[n].code == code) { - return &staticErrorCodes[n]; - } else { - psErrorDescription* desc; - // make sure there is a list to search - if (dynamicErrorCodes == NULL) { - return NULL; - } - - // search dynamic list of error descriptions before giving up. - psListIterator* iter = psListIteratorAlloc(dynamicErrorCodes,PS_LIST_HEAD,true); - while ((desc = (psErrorDescription*)psListGetAndIncrement(iter)) != NULL) { - if (desc->code == code) { - psFree(iter); - return desc; - } - } - psFree(iter); - } - return NULL; -} - -static void freeErrorDescription(psErrorDescription* err) -{ - psFree(err->description); -} - -psErrorDescription* psErrorDescriptionAlloc(psErrorCode code, - const char *description) -{ - psErrorDescription* err = psAlloc(sizeof(psErrorDescription)); - err->code = code; - if (description == NULL) { - err->description = NULL; - } else { - err->description = psAlloc(sizeof(char)*strlen(description)+1); - strcpy((char*)err->description,description); - } - - psMemSetDeallocator(err,(psFreeFunc)freeErrorDescription); - return err; -} - - -const char *psErrorCodeString(psErrorCode code) -{ - // Check input argument is non-negative - if ( code < 0 ) { - return NULL; - } - - const psErrorDescription* desc = getErrorDescription(code); - - if (desc == NULL) { - return NULL; - } - - return desc->description; -} - -void psErrorRegister(const psErrorDescription* errors, - psS32 nerror) -{ - if (nerror < 1) { - return; - } - - if (errors == NULL) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psErrorCode_NULL_ERRORDESCRIPTION); - return; - } - - if (dynamicErrorCodes == NULL) { - dynamicErrorCodes = psListAlloc(NULL); - p_psMemSetPersistent(dynamicErrorCodes,true); - - p_psMemSetPersistent(dynamicErrorCodes->iterators,true); - p_psMemSetPersistent(dynamicErrorCodes->iterators->data,true); - for (int i = 0; i < dynamicErrorCodes->iterators->n;i++) { - p_psMemSetPersistent(dynamicErrorCodes->iterators->data[i],true); - } - } - - for (psS32 i=0;idescription,true); - if (! psListAdd(dynamicErrorCodes, - PS_LIST_HEAD, - err) ) { - - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psErrorCode_ERRORCODE_REGISTER_FAILED, - i); - } - p_psMemSetPersistent(dynamicErrorCodes->head,true); - psFree(err); - } -} - -psBool p_psErrorUnregister(psErrorCode code) -{ - // Check input argument is non-negative - if ( code < 0 ) { - return false; - } - - const psErrorDescription* desc = getErrorDescription(code); - - if (desc == NULL) { - return false; - } - - if (dynamicErrorCodes == NULL) { - return false; - } - - return psListRemoveData(dynamicErrorCodes,(psPtr)desc); -} Index: unk/psLib/src/sysUtils/psErrorCodes.h =================================================================== --- /trunk/psLib/src/sysUtils/psErrorCodes.h (revision 4545) +++ (revision ) @@ -1,111 +1,0 @@ -/** @file psErrorCodes.h - * - * @brief Contains the error codes for the error classes - * - * @ingroup ErrorHandling - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_ERROR_CODES_H -#define PS_ERROR_CODES_H - -#include "psType.h" - -/* N.B., lines between '//~Start' and '//~End' are automatic generated from - * the template following the '//~Start'. The template is used to generate - * the other lines by, for each error class in psErrorCodes.dat, the following - * substitutions are made: - * $1 The error code name (first word in the psErrorCodes.dat lines) - * $2 The error description (rest of the line in psErrorCodes.dat) - * $n The order of the source line in psErrorCodes.dat (comments excluded) - * - * DO NOT EDIT THE LINES BETWEEN //~Start and //~End! ANY CHANGES WILL BE OVERWRITTEN. - */ - -/** @addtogroup ErrorHandling - * @{ - */ - -/** enumeration of the static error code classes - */ -typedef enum { - PS_ERR_NONE = 0, ///< not an error - PS_ERR_BASE = 256, - /**< base error. Any psErrorCode less than this should be taken to be - * valid values of errno - */ - - //~Start PS_ERR_$1, ///< $2 - PS_ERR_UNKNOWN, ///< unknown error - PS_ERR_IO, ///< I/O error - PS_ERR_LOCATION_INVALID, ///< specified location is unknown - PS_ERR_MEMORY_CORRUPTION, ///< memory corruption detected - PS_ERR_MEMORY_DEREF_USAGE, ///< dereferenced memory still used - PS_ERR_BAD_PARAMETER_VALUE, ///< parameter is out-of-range - PS_ERR_BAD_PARAMETER_TYPE, ///< parameter is of unsupported type - PS_ERR_BAD_PARAMETER_NULL, ///< parameter is null - PS_ERR_BAD_PARAMETER_SIZE, ///< size of parameter's data is outside of acceptable range. - PS_ERR_UNEXPECTED_NULL, ///< unexpected NULL found - PS_ERR_OS_CALL_FAILED, ///< unexpected result from an OS standard library call - //~End - PS_ERR_N_ERR_CLASSES ///< end marker - should not be used as a true error -} psErrorCode; - -/** An error code with description - */ -typedef struct -{ - psErrorCode code; ///< An error code - const char *description; ///< the associated description -} -psErrorDescription; - -/** Allocates a new psErrorDescription - * - * @return psErrorDescription* new psErrorDescription struct. - */ -psErrorDescription* psErrorDescriptionAlloc( - psErrorCode code, ///< An error code - const char *description ///< the associated description -); - -/** Retrieves the description of an error code. - * - * The routine psErrorCodeString returns the string associated with an error - * code. - * - * @return const char* the description associated with the given code. - */ -const char *psErrorCodeString( - psErrorCode code ///< the associated error code -); - -/** Register an error code - * - * Any project needed to use psLib must define the necessary error codes and - * associated message strings. This function registers an array of error - * codes with the error handling subsystem. - * - */ -void psErrorRegister( - const psErrorDescription* errors, ///< Array of error codes to register - int errorCode ///< Error code to register -); - -/** Clears error codes registered via psErrorRegister. - * - * @return psBool TRUE if given errorcode was removed, otherwise FALSE. - */ -psBool p_psErrorUnregister( - psErrorCode code ///< the error code to find and remove -); - -/// @} - -#endif // #ifndef PS_ERROR_CODES_H Index: unk/psLib/src/sysUtils/psLogMsg.c =================================================================== --- /trunk/psLib/src/sysUtils/psLogMsg.c (revision 4545) +++ (revision ) @@ -1,372 +1,0 @@ - -/** @file psLogMsg.c - * @brief Procedures for logging messages. - * \ingroup LogTrace - * - * This file contains code for setting message log levels, message log - * formats, message log destinations, and for generating the messages - * themselves. - * @ingroup LogTrace - * - * @author Robert Lupton, Princeton University - * @author GLG, MHPCC - * - * @version $Revision: 1.47 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-23 03:50:29 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -/***************************************************************************** -NOTES: currently, the prototype code has the following global variables: - static psS32 p_psGlobalLogDest; - static psS32 p_psGlobalLogLevel; - static psS32 p_psLogTime; - static psS32 p_psLogHost; - static psS32 p_psLogLevel; - static psS32 p_psLogName; - static psS32 p_psLogMsg; - *****************************************************************************/ -#include "config.h" - -#include -#include -#include -#include -#include -#include -#include - -#include "psLogMsg.h" -#include "psError.h" -#include "psTrace.h" - -#include "psSysUtilsErrors.h" - -#define MIN_LOG_LEVEL 0 -#define MAX_LOG_LEVEL 9 - -#define MAX_LOG_LINE_LENGTH 256 - -static FILE *logDest = (FILE *) 1; // flag to initialize to stderr before using. -static psS32 globalLogLevel = PS_LOG_INFO; // log all messages at this or above -static psBool logTime = true; // Flag to include time info -static psBool logHost = true; // Flag to include host info -static psBool logLevel = true; // Flag to include level info -static psBool logName = true; // Flag to include name info -static psBool logMsg = true; // Flag to include message info - -/***************************************************************************** -psLogSetLevel(): Set the current log level and return old level. -Input: - level (psS32): the new log level. -Output: - The old log level. - *****************************************************************************/ -int psLogSetLevel(int level) -{ - // Save old global log level for changing it. - psS32 oldLevel = globalLogLevel; - - if ((level < MIN_LOG_LEVEL) || (level > MAX_LOG_LEVEL)) { - psLogMsg("logmsg", PS_LOG_WARN, "Attempt to set invalid logMsg level: %d", level); - level = (level < MIN_LOG_LEVEL) ? MIN_LOG_LEVEL : MAX_LOG_LEVEL; - } - // Set new global log level - globalLogLevel = level; - - // Return old global log level - return oldLevel; -} - -/***************************************************************************** -psLogSetDestination(): sets the log message destination. -Input: - dest (psS32): the new log destination -Return: - An psBool: TRUE if successful. - *****************************************************************************/ -bool psLogSetDestination(const char *dest) -{ - char protocol[5]; - char location[257]; - - // if logDest has not been initialized, do so before using it - if (logDest == (FILE *) 1) { - logDest = stderr; - } - - if (dest == NULL || strcmp(dest, "none") == 0) { - if (logDest != NULL && logDest != stderr && logDest != stdout) { - fclose(logDest); - } - logDest = NULL; - return true; - } - - if (sscanf(dest, "%4s:%256s", protocol, location) < 2) { - psError(PS_ERR_LOCATION_INVALID, true, - PS_ERRORTEXT_psLogMsg_DESTINATION_MALFORMED, - dest); - return false; - } - - if (strcmp(protocol, "dest") == 0) { - if (strcmp(location, "stderr") == 0) { - if (logDest != NULL && logDest != stderr && logDest != stdout) { - fclose(logDest); - } - logDest = stderr; - return true; - } - if (strcmp(location, "stdout") == 0) { - if (logDest != NULL && logDest != stderr && logDest != stdout) { - fclose(logDest); - } - logDest = stdout; - return true; - } - psError(PS_ERR_LOCATION_INVALID, true, PS_ERRORTEXT_psLogMsg_DEST_LOCATION_INVALID, - location); - return 1; - } else if (strcmp(protocol, "file") == 0) { - FILE *file = fopen(location, "w"); - - if (file == NULL) { - psError(PS_ERR_IO, true, PS_ERRORTEXT_psLogMsg_OPEN_FILE_FAILED, - location); - return false; - } - if (logDest != NULL && logDest != stderr && logDest != stdout) { - fclose(logDest); - } - logDest = file; - return true; - } - - psError(PS_ERR_LOCATION_INVALID, true, PS_ERRORTEXT_psLogMsg_UNSUPPORTED_PROTOCOL, - protocol); - return false; -} - -/***************************************************************************** -psLogSetFormat(): Set the format of psLogMsg output. More precisely, - provide a string consisting of the letters {H (host), L (level), M - (message), N (name), T (time)}. The default is "HLMNT". This string - determines whether or not they associated type of information will be - included in message logs. It does not determine the order in which that - information will appear (that order is fixed). - -Input: - fmt: a string specifying the format. -Return: - NULL. - *****************************************************************************/ -void psLogSetFormat(const char *format) -{ - // assume none. - logHost = false; - logLevel = false; - logMsg = false; - logName = false; - logTime = false; - - // if fmt is NULL, no logging is desired. - if (format == NULL) { - return; - } - - // XXX: What is the purpose of this conditional. - if (strlen(format) == 0) { - format = "THLNM"; - } - // Step through each character in the format string. For each letter - // in that string, set the appropriate logging. - - for (const char *ptr = format; *ptr != '\0'; ptr++) { - switch (*ptr) { - case 'H': - case 'h': - logHost = true; - break; - case 'L': - case 'l': - logLevel = true; - break; - case 'M': - case 'm': - logMsg = true; - break; - case 'N': - case 'n': - logName = true; - break; - case 'T': - case 't': - logTime = true; - break; - default: - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psLogMsg_UNKNOWN_KEY, *ptr); - break; - } - } - - // XXX: If one must at least log error messages, why don't we set logMsg = true here? - if (!logMsg) { - psTrace("utils.logMsg", 1, "You must at least log error messages (You chose \"%s\")", format); - } -} - -#ifndef HOST_NAME_MAX // should be in limits.h -#define HOST_NAME_MAX 256 -#endif // #ifndef HOST_NAME_MAX - -/***************************************************************************** -psVLogMsg(): This routine sends the message, which is a printf style string -specified in the "..." argument, to the current message log destination with -the severity specified by the "level" argument. - Input: - name - level - fmt - ap - *****************************************************************************/ -void psLogMsgV(const char *name, int level, const char *format, va_list ap) -{ - static psS32 first = 1; // Flag for calling gethostname() - static char hostname[HOST_NAME_MAX + 1]; - - // Buffer for hostname. - char clevel = 0; // letter-name for level - char head[MAX_LOG_LINE_LENGTH + 2]; // the added two are for the ending | and \0 - char *head_ptr = head; // where we've got to in head - psS32 maxLength = MAX_LOG_LINE_LENGTH; - time_t clock = time(NULL); // The current time. - struct tm *utc = gmtime(&clock); // The current gm time. - - // if logDest has not been initialized, do so before using it - if (logDest == (FILE *) 1) { - logDest = stderr; - } - // If logging is off, or if the level is too high, return immediately. - if ((level > globalLogLevel) || (logDest == NULL)) { - return; - } - // If I have not been here yet, determine my hostname and save it. - if (first) { - first = 0; - gethostname(hostname, HOST_NAME_MAX); - } - - switch (level) { - case PS_LOG_ABORT: - clevel = 'A'; - break; - - case PS_LOG_ERROR: - clevel = 'E'; - break; - - case PS_LOG_WARN: - clevel = 'W'; - break; - - case PS_LOG_INFO: - clevel = 'I'; - break; - - case 4: - case 5: - case 6: - case 7: - case 8: - case 9: - clevel = level + '0'; - break; - - default: - psTrace("utils.logMsg", 2, "Invalid logMsg level: %d (%s)\n", level, format); - level = (level < 0) ? 0 : 9; - clevel = level + '0'; - break; - } - - // Create the various log fields... - if (logTime) { - maxLength -= snprintf(head_ptr, maxLength, "%4d:%02d:%02d %02d:%02d:%02dZ", - utc->tm_year + 1900, utc->tm_mon + 1, utc->tm_mday, - utc->tm_hour, utc->tm_min, utc->tm_sec) - 1; - head_ptr += strlen(head_ptr); - } - // Hostname should be 20 characters. - if (logHost) { - if (head_ptr > head) { - *head_ptr++ = '|'; - } - maxLength -= snprintf(head_ptr, maxLength, "%-20s", hostname); - head_ptr += strlen(head_ptr); - } - if (logLevel) { - if (head_ptr > head) { - *head_ptr++ = '|'; - } - maxLength -= snprintf(head_ptr, maxLength, "%c", clevel); - head_ptr += strlen(head_ptr); - } - if (logName) { - if (head_ptr > head) { - *head_ptr++ = '|'; - } - maxLength -= snprintf(head_ptr, maxLength, "%s", name); - - head_ptr += strlen(head_ptr); - } - - if (head_ptr > head) { - *head_ptr++ = '\n'; - } else if (!logMsg) { // no output desired - return; - } - *head_ptr = '\0'; - - fputs(head, logDest); - if (logMsg) { - char msg[1024]; - char* msgPtr; - vsnprintf(msg,1024, format, ap); // create message - - // detect multiple lines in message and indent each line by 4 spaces. - char* line = strtok_r(msg,"\n",&msgPtr); - while (line != NULL) { - fprintf(logDest," %s\n",line); - line = strtok_r(NULL,"\n",&msgPtr); - } - } else { - fputc('\n', logDest); - } -} - -/***************************************************************************** -psLogMsg(): This routine sends the message, which is a printf style string -specified in the "..." argument, to the current message log destination with -the severity specified by the "level" argument. - -Input: - name: Indicates the source of this log message. - level: The severity of this log message. - fmt: The printf-stype formatted string, followed by the arguments - to that string. - ... The arguments to the above printf-style string. - -Return: - NULL - *****************************************************************************/ -void psLogMsg(const char *name, int level, const char *format, ...) -{ - va_list ap; - - va_start(ap, format); - psLogMsgV(name, level, format, ap); - va_end(ap); -} Index: unk/psLib/src/sysUtils/psLogMsg.h =================================================================== --- /trunk/psLib/src/sysUtils/psLogMsg.h (revision 4545) +++ (revision ) @@ -1,104 +1,0 @@ -/** @file psLogMsg.h - * @brief Procedures for logging messages. - * \ingroup LogTrace - * - * This file will hold the prototypes for defining procedure which set - * message log levels, messahe log formats, message log destinations, and - * for generating the messages themselves. - * @ingroup LogTrace - * - * @author Robert Lupton, Princeton University - * @author GLG, MHPCC - * - * @version $Revision: 1.29 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-06 03:04:35 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ -#ifndef PS_LOG_MSG_H -#define PS_LOG_MSG_H -#include - -#include "psType.h" - -/** @addtogroup LogTrace - * @{ - */ - -/** This procedure sets the destination for future log messages. - * This procedure will take a character string as an - * argument which can specify general log destinations. - * - * @return bool true if set successfully, otherwise false. - */ -bool psLogSetDestination( - const char *dest ///< Specifies where to send messages. -); - -/** This procedure sets the message level for future log messages. Subsequent - * log messages, with a log level of "mylevel", will only be logged if - * "mylevel" is less than the current log level set by this procedure. - * Ie. higher values set by this procedure will cause more log messages to - * be displayed. The old log level will be returned. - * - * @return int old logging level - */ -int psLogSetLevel( - int level ///< Specifies the system log level -); - -/** This procedure sets the log format for future log messages. The argument - * must be a character string consistsing of the letters H (host), L - * (level), M (message), N (name), and T (time). The default is "THLNM". - * Deleting a letter from the string will cause the associated information - * to not be logged. This procedure does not alter the order in which - * the messages are displayed. - */ -void psLogSetFormat( - const char *format ///< Specifies the system log format -); - -/** This procedure logs a message to the destination set by a prior - * call to psLogSetDestination(), if myLevel is less than the level - * specified by a prior call to psLogSetLevel(). The message is specified - * with a printf-type string and arguments. - * - */ -void psLogMsg( - const char *name, ///< name of the log source - int level, ///< severity level of this log message - const char *format, ///< printf-style format command - ... -); - -#ifndef SWIG -/** This procedure is functionally equivalent to psLogMsg(), except that - * it takes a va_list as the message parameter, not a printf-style string. - * - */ -void psLogMsgV( - const char *name, ///< name of the log source - int level, ///< severity level of this log message - const char *format, ///< printf-style format command - va_list ap ///< varargs argument list -); -#endif // #ifndef SWIG - -///< Status codes for log messages -enum { - PS_LOG_ABORT = 0, ///< log message is a critical error, perform an abort after printing - PS_LOG_ERROR, ///< log message is an error, but don't abort - PS_LOG_WARN, ///< log message is a warning - PS_LOG_INFO ///< log message is informational only -}; - -///< Destinations for log messages -enum { - PS_LOG_NONE, ///< turn off logging - PS_LOG_TO_STDERR, ///< log to system's stderr - PS_LOG_TO_STDOUT ///< log to system's stdout -}; - -/// @} - -#endif // #ifndef PS_LOG_MSG_H Index: unk/psLib/src/sysUtils/psMemory.c =================================================================== --- /trunk/psLib/src/sysUtils/psMemory.c (revision 4545) +++ (revision ) @@ -1,700 +1,0 @@ -/** @file psMemory.c -* -* @brief Contains the definitions for the memory management system -* -* psMemory.h has additional information and documentation of the routines found in this file. -* -* @author Robert DeSonia, MHPCC -* @author Robert Lupton, Princeton University -* -* @version $Revision: 1.59 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-01 22:01:17 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#define PS_ALLOW_MALLOC // we're allowed to call malloc() - -#include -#include -#include - -#include "psMemory.h" -#include "psError.h" -#include "psAbort.h" -#include "psLogMsg.h" - -#include "psSysUtilsErrors.h" - -#define P_PS_MEMMAGIC (psPtr )0xdeadbeef // Magic number in psMemBlock header - -#define P_PS_LARGE_BLOCK_SIZE 65536 // size where under, we try to recycle - -static psS32 checkMemBlock(const psMemBlock* m, const char *funcName); -static psMemBlock* lastMemBlockAllocated = NULL; -static pthread_mutex_t memBlockListMutex = PTHREAD_MUTEX_INITIALIZER; -static pthread_mutex_t memIdMutex = PTHREAD_MUTEX_INITIALIZER; - -static pthread_mutex_t recycleMemBlockListMutex = PTHREAD_MUTEX_INITIALIZER; - -static psS32 recycleBins = 13; -static psS32 recycleBinSize[14] = { - 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, P_PS_LARGE_BLOCK_SIZE - }; - -// N.B. recycleBinSize should be terminated by P_PS_LARGE_BLOCK_SIZE (simplifies search loops) -static psMemBlock* recycleMemBlockList[13] = { - NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL - }; - -#ifdef PS_MEM_DEBUG -static psMemBlock* deadBlockList; // a place to put dead memBlocks in debug mode. -#endif // #ifdef PS_MEM_DEBUG - -/** - * Unique ID for allocated blocks - */ -static psMemId memid = 0; - -/** - * Default memExhausted callback. - */ -static psPtr memExhaustedCallbackDefault(size_t size) -{ - psPtr ptr = NULL; - - pthread_mutex_lock(&recycleMemBlockListMutex); - psS32 level = recycleBins - 1; - - while (level >= 0 && ptr == NULL) { - while (recycleMemBlockList[level] != NULL && ptr == NULL) { - psMemBlock* old = recycleMemBlockList[level]; - - recycleMemBlockList[level] = recycleMemBlockList[level]->nextBlock; - free(old); - ptr = malloc(size); - } - level--; - } - pthread_mutex_unlock(&recycleMemBlockListMutex); - - return ptr; -} - -/* - * Default callback for both allocate and free. Note that the - * value of p_psMemAllocID/p_psMemFreeID is incremented - * by the return value (so returning 0 means that the callback - * isn't resignalled) - */ -static psMemId memAllocCallbackDefault(const psMemBlock* ptr) -{ - static psMemId incr = 0; // "p_psMemAllocID += incr" - - return incr; -} - -static psMemId memFreeCallbackDefault(const psMemBlock* ptr) -{ - static psMemId incr = 0; // "p_psMemFreeID += incr" - - return incr; -} - -static void memProblemCallbackDefault( psMemBlock* ptr, const char *file, unsigned int lineno) -{ - if (ptr->refCounter < 1) { - psError(PS_ERR_MEMORY_CORRUPTION, false, - PS_ERRORTEXT_psMemory_MULTIPLE_FREE, - ptr->id, ptr->file, ptr->lineno, file, lineno); - } - - if (lineno > 0) { - psAbort(__func__, "Detected a problem in the memory system at %s:%d", file, lineno); - } -} - -/* - * Routines to check the consistency of the allocated and/or free memory arena - * - * N.b. If the block wasn't allocated by psAlloc, it will appear corrupted - */ -static psS32 checkMemBlock(const psMemBlock* m, const char *funcName) -{ - // n.b. since this is called by psMemCheckCorruption while the memblock list is mutex locked, - // we shouldn't call such things as p_psAlloc/p_psFree here. - - if (m == NULL) { - psError(PS_ERR_MEMORY_CORRUPTION, true, - PS_ERRORTEXT_psMemory_NULL_BLOCK); - return 1; - } - - if (m->refCounter == 0) { - // using an unreferenced block of memory, are you? - psError(PS_ERR_MEMORY_CORRUPTION, true, - PS_ERRORTEXT_psMemory_DEREF_BLOCK_USE, - m->id); - return 1; - } - - if (m->startblock != P_PS_MEMMAGIC || m->endblock != P_PS_MEMMAGIC) { - psError(PS_ERR_MEMORY_CORRUPTION, true, - PS_ERRORTEXT_psMemory_UNDERFLOW, - m->id); - return 1; - } - if (*(psPtr *)((int8_t *) (m + 1) + m->userMemorySize) != P_PS_MEMMAGIC) { - psError(PS_ERR_MEMORY_CORRUPTION, true, - PS_ERRORTEXT_psMemory_OVERFLOW, - m->id); - return 1; - } - - return 0; -} - -/* - * The default callbacks - */ -static psMemAllocCallback memAllocCallback = memAllocCallbackDefault; -static psMemFreeCallback memFreeCallback = memFreeCallbackDefault; -static psMemProblemCallback memProblemCallback = memProblemCallbackDefault; -static psMemExhaustedCallback memExhaustedCallback = memExhaustedCallbackDefault; - -psMemExhaustedCallback psMemExhaustedCallbackSet(psMemExhaustedCallback func) -{ - psMemExhaustedCallback old = memExhaustedCallback; - - if (func != NULL) { - memExhaustedCallback = func; - } else { - memExhaustedCallback = memExhaustedCallbackDefault; - } - - return old; -} - -psMemProblemCallback psMemProblemCallbackSet(psMemProblemCallback func) -{ - psMemProblemCallback old = memProblemCallback; - - if (func != NULL) { - memProblemCallback = func; - } else { - memProblemCallback = memProblemCallbackDefault; - } - - return old; -} - -/* - * And now the I-want-to-be-informed callbacks - * - * Call the callbacks when these IDs are allocated/freed - */ -psMemId p_psMemAllocID = 0; // notify user this block is allocated -psMemId p_psMemFreeID = 0; // notify user this block is freed - -psMemId psMemAllocCallbackSetID(psMemId id) -{ - psMemId old = p_psMemAllocID; - - p_psMemAllocID = id; - - return old; -} - -psMemId psMemFreeCallbackSetID(psMemId id) -{ - psMemId old = p_psMemFreeID; - - p_psMemFreeID = id; - - return old; -} - -psMemAllocCallback psMemAllocCallbackSet(psMemAllocCallback func) -{ - psMemFreeCallback old = memAllocCallback; - - if (func != NULL) { - memAllocCallback = func; - } else { - memAllocCallback = memAllocCallbackDefault; - } - - return old; -} - -psMemFreeCallback psMemFreeCallbackSet(psMemFreeCallback func) -{ - psMemFreeCallback old = memFreeCallback; - - if (func != NULL) { - memFreeCallback = func; - } else { - memFreeCallback = memFreeCallbackDefault; - } - - return old; -} - -/* - * Return memory ID counter for next block to be allocated - */ -psMemId psMemGetId(void) -{ - psMemId id; - - pthread_mutex_lock(&memIdMutex); - id = memid + 1; - pthread_mutex_unlock(&memIdMutex); - - return id; -} - -int psMemCheckCorruption(bool abort_on_error) -{ - psS32 nbad = 0; // number of bad blocks - psBool failure = false; - - // get exclusive access to the memBlock list to avoid it changing on us while we use it. - // pthread_mutex_lock(&memBlockListMutex); - - for (psMemBlock* iter = lastMemBlockAllocated; iter != NULL; iter = iter->nextBlock) { - pthread_mutex_unlock(&memBlockListMutex); - failure = checkMemBlock(iter, __func__); - pthread_mutex_lock(&memBlockListMutex); - if ( failure ) { - nbad++; - - memProblemCallback(iter, __func__, __LINE__); - - if (abort_on_error) { - // release the lock on the memblock list - pthread_mutex_unlock(&memBlockListMutex); - psAbort(__func__, "Detected memory corruption"); - return nbad; - } - } - } - - // release the lock on the memblock list - pthread_mutex_unlock(&memBlockListMutex); - return nbad; -} - -psPtr p_psAlloc(size_t size, const char *file, unsigned int lineno) -{ - - psMemBlock* ptr = NULL; - - size = (size < recycleBinSize[0]) ? recycleBinSize[0] : size; // set the minimum size to allocate - - // memory is of the size I want to bother recycling? - if (size < P_PS_LARGE_BLOCK_SIZE) { - // find the bin we need. - psS32 level = 0; - - while (size > recycleBinSize[level]) { - level++; - } - // Are we in one of the bins - if (level < recycleBins) { - - size = recycleBinSize[level]; // round-up size to next sized bin. - - pthread_mutex_lock(&recycleMemBlockListMutex); - - if (recycleMemBlockList[level] != NULL) { - ptr = recycleMemBlockList[level]; - recycleMemBlockList[level] = ptr->nextBlock; - if (recycleMemBlockList[level] != NULL) { - recycleMemBlockList[level]->previousBlock = NULL; - } - size = ptr->userMemorySize; - } - - pthread_mutex_unlock(&recycleMemBlockListMutex); - } - } - - if (ptr == NULL) { - ptr = malloc(sizeof(psMemBlock) + size + sizeof(psPtr )); - - if (ptr == NULL) { - ptr = memExhaustedCallback(size); - if (ptr == NULL) { - psAbort(__func__, "Failed to allocate %u bytes at %s:%d", size, file, lineno); - } - } - - *(psPtr*)&ptr->startblock = P_PS_MEMMAGIC; - *(psPtr*)&ptr->endblock = P_PS_MEMMAGIC; - ptr->userMemorySize = size; - pthread_mutex_init(&ptr->refCounterMutex, NULL); - } - // increment the memory id safely. - pthread_mutex_lock(&memBlockListMutex); - *(psMemId* ) & ptr->id = ++memid; - pthread_mutex_unlock(&memBlockListMutex); - - ptr->file = file; - ptr->freeFunc = NULL; - ptr->persistent = false; - *(psU32 *)&ptr->lineno = lineno; - *(psPtr *)((int8_t *) (ptr + 1) + size) = P_PS_MEMMAGIC; - ptr->previousBlock = NULL; - - ptr->refCounter = 1; // one user so far - - // need exclusive access of the memory block list now... - pthread_mutex_lock(&memBlockListMutex); - - // insert the new block to the front of the memBlock linked-list - ptr->nextBlock = lastMemBlockAllocated; - if (ptr->nextBlock != NULL) { - ptr->nextBlock->previousBlock = ptr; - } - lastMemBlockAllocated = ptr; - - pthread_mutex_unlock(&memBlockListMutex); - - // Did the user ask to be informed about this allocation? - if (ptr->id == p_psMemAllocID) { - p_psMemAllocID += memAllocCallback(ptr); - } - // And return the user the memory that they allocated - return ptr + 1; // user memory -} - -psPtr p_psRealloc(psPtr vptr, size_t size, const char *file, unsigned int lineno) -{ - size = (size < recycleBinSize[0]) ? recycleBinSize[0] : size; // set the minimum size to allocate - - if (vptr == NULL) { - return p_psAlloc(size, file, lineno); - } else { - psMemBlock* ptr = ((psMemBlock* ) vptr) - 1; - psBool isBlockLast = false; - - if (checkMemBlock(ptr, __func__) != 0) { - memProblemCallback(ptr, file, lineno); - psAbort(file, "Realloc detected a memory corruption (id %lld @ %s:%d).", - ptr->id, ptr->file, ptr->lineno); - } - - pthread_mutex_lock(&memBlockListMutex); - - isBlockLast = (ptr == lastMemBlockAllocated); - - ptr = (psMemBlock* ) realloc(ptr, sizeof(psMemBlock) + size + sizeof(psPtr )); - - if (ptr == NULL) { - ptr = memExhaustedCallback(size); - if(ptr == NULL) { - psAbort(__func__, "Failed to reallocate %ld bytes at %s:%d", size, file, lineno); - } - } - - ptr->userMemorySize = size; - *(psPtr *)((int8_t *) (ptr + 1) + size) = P_PS_MEMMAGIC; - - if (isBlockLast) { - lastMemBlockAllocated = ptr; - } - // the block location may have changed, so fix the linked list addresses. - if (ptr->nextBlock != NULL) { - ptr->nextBlock->previousBlock = ptr; - } - if (ptr->previousBlock != NULL) { - ptr->previousBlock->nextBlock = ptr; - } - - pthread_mutex_unlock(&memBlockListMutex); - - // Did the user ask to be informed about this allocation? - if (ptr->id == p_psMemAllocID) { - p_psMemAllocID += memAllocCallback(ptr); - } - - return ptr + 1; // usr memory - } -} - -void p_psFree(psPtr vptr, const char *file, unsigned int lineno) -{ - if (vptr == NULL) { - return; - } - psMemBlock* ptr = ((psMemBlock* ) vptr) - 1; - if (ptr->refCounter < 1) { - psMemBlock* ptr = ((psMemBlock* ) vptr) - 1; - - psAbort(__func__,PS_ERRORTEXT_psMemory_MULTIPLE_FREE, - ptr->id, ptr->file, ptr->lineno, file, lineno); - } - - if (checkMemBlock(ptr, __func__) != 0) { - memProblemCallback(ptr, file, lineno); - psAbort(__func__,"Memory Corruption Detected."); - } - - (void)p_psMemDecrRefCounter(vptr, file, lineno); // this handles the free, if required. -} - -/* - * Check for memory leaks. - */ -psS32 psMemCheckLeaks(psMemId id0, psMemBlock* ** arr, FILE * fd, psBool persistence) -{ - psS32 nleak = 0; - psS32 j = 0; - psMemBlock* topBlock = lastMemBlockAllocated; - - pthread_mutex_lock(&memBlockListMutex); - - for (psMemBlock* iter = topBlock; iter != NULL; iter = iter->nextBlock) { - if ( (iter->refCounter > 0) && - ( (persistence) || (!persistence && !iter->persistent) ) && - (iter->id >= id0)) { - - nleak++; - - if (fd != NULL) { - if (nleak == 1) { - fprintf(fd, " %20s:line ID\n", "file"); - } - - fprintf(fd, " %20s:%-4d %ld\n", iter->file, (int)iter->lineno, (long)iter->id); - } - } - } - - pthread_mutex_unlock(&memBlockListMutex); - - if (nleak == 0 || arr == NULL) { - return nleak; - } - - *arr = p_psAlloc(nleak * sizeof(psMemBlock), __FILE__, __LINE__); - pthread_mutex_lock(&memBlockListMutex); - - for (psMemBlock* iter = topBlock; iter != NULL; iter = iter->nextBlock) { - if ( (iter->refCounter > 0) && - ( (persistence) || (!persistence && !iter->persistent) ) && - (iter->id >= id0)) { - - (*arr)[j++] = iter; - if (j == nleak) { // found them all - break; - } - } - } - - pthread_mutex_unlock(&memBlockListMutex); - - return nleak; -} - -/* - * Reference counting APIs - */ - -// return refCounter -psReferenceCount psMemGetRefCounter(const psPtr ptr) -{ - psMemBlock* ptr2; - psU32 refCount; - - if (ptr == NULL) { - return 0; - } - - ptr2 = ((psMemBlock* ) ptr) - 1; - - if (checkMemBlock(ptr2, __func__) != 0) { - memProblemCallback(ptr2, __func__, __LINE__); - } - - pthread_mutex_lock(&ptr2->refCounterMutex); - refCount = ptr2->refCounter; - pthread_mutex_unlock(&ptr2->refCounterMutex); - - return refCount; -} - -// increment and return refCounter -psPtr p_psMemIncrRefCounter(psPtr vptr, const char *file, psS32 lineno) -{ - psMemBlock* ptr; - - if (vptr == NULL) { - return vptr; - } - - ptr = ((psMemBlock* ) vptr) - 1; - - if (checkMemBlock(ptr, __func__)) { - memProblemCallback(ptr, file, lineno); - } - - pthread_mutex_lock(&ptr->refCounterMutex); - ptr->refCounter++; - pthread_mutex_unlock(&ptr->refCounterMutex); - - return vptr; -} - -// decrement and return refCounter -psPtr p_psMemDecrRefCounter(psPtr vptr, const char *file, psS32 lineno) -{ - if (vptr == NULL) { - return NULL; - } - - psMemBlock* ptr = ((psMemBlock* ) vptr) - 1; - - if (checkMemBlock(ptr, __func__) != 0) { - memProblemCallback(ptr, file, lineno); - return NULL; - } - - // Did the user ask to be informed about this deallocation? - if (ptr->id == p_psMemFreeID) { - p_psMemFreeID += memFreeCallback(ptr); - } - - pthread_mutex_lock(&ptr->refCounterMutex); - - if (ptr->refCounter > 1) { - ptr->refCounter--; // multiple references, just decrement the count. - pthread_mutex_unlock(&ptr->refCounterMutex); - - } else { - pthread_mutex_unlock(&ptr->refCounterMutex); - - if (ptr->freeFunc != NULL) { - ptr->freeFunc(vptr); - } - - pthread_mutex_lock(&memBlockListMutex); - - // cut the memBlock out of the memBlock list - if (ptr->nextBlock != NULL) { - ptr->nextBlock->previousBlock = ptr->previousBlock; - } - if (ptr->previousBlock != NULL) { - ptr->previousBlock->nextBlock = ptr->nextBlock; - } - if (lastMemBlockAllocated == ptr) { - lastMemBlockAllocated = ptr->nextBlock; - } - - pthread_mutex_unlock(&memBlockListMutex); - - // do we need to recycle? - if (ptr->userMemorySize < P_PS_LARGE_BLOCK_SIZE) { - - psS32 level = 1; - - while (ptr->userMemorySize >= recycleBinSize[level]) { - level++; - } - level--; - - ptr->refCounter = 0; - ptr->previousBlock = NULL; - - pthread_mutex_lock(&recycleMemBlockListMutex); - ptr->nextBlock = recycleMemBlockList[level]; - if (recycleMemBlockList[level] != NULL) { - recycleMemBlockList[level]->previousBlock = ptr; - } - recycleMemBlockList[level] = ptr; - pthread_mutex_unlock(&recycleMemBlockListMutex); - - } else { - // memory is larger than I want to recycle. - #ifdef PS_MEM_DEBUG - (void)p_psRealloc(vptr, 0, file, lineno); - ptr->previousBlock = NULL; - ptr->nextBlock = deadBlockList; - if (deadBlockList != NULL) { - deadBlockList->previous = ptr; - } - deadBlockList = ptr; - #else // #ifdef PS_MEM_DEBUG - - pthread_mutex_destroy(&ptr->refCounterMutex); - free(ptr); - #endif // #else - #ifdef PS_MEM_DEBUG - - } - - vptr = NULL; // since we freed it, make sure we return NULL. - } - - return vptr; -} - -void psMemSetDeallocator(psPtr ptr, psFreeFunc freeFunc) -{ - if (ptr == NULL) { - return; - } - - psMemBlock* PTR = ((psMemBlock* ) ptr) - 1; - - if (checkMemBlock(PTR, __func__) != 0) { - memProblemCallback(PTR, __func__, __LINE__); - } - - PTR->freeFunc = freeFunc; - -} -psFreeFunc psMemGetDeallocator(psPtr ptr) -{ - if (ptr == NULL) { - return NULL; - } - - psMemBlock* PTR = ((psMemBlock* ) ptr) - 1; - - if (checkMemBlock(PTR, __func__) != 0) { - memProblemCallback(PTR, __func__, __LINE__); - } - - return PTR->freeFunc; -} - -bool p_psMemGetPersistent(psPtr vptr) -{ - if (vptr == NULL) { - return NULL; - } - - psMemBlock* ptr = ((psMemBlock* ) vptr) - 1; - - if (checkMemBlock(ptr, __func__) != 0) { - memProblemCallback(ptr, __func__, __LINE__); - } - - return ptr->persistent; -} - -void p_psMemSetPersistent(psPtr vptr, bool value) -{ - if (vptr == NULL) { - return; - } - - psMemBlock* ptr = ((psMemBlock* ) vptr) - 1; - - if (checkMemBlock(ptr, __func__) != 0) { - memProblemCallback(ptr, __func__, __LINE__); - } - - ptr->persistent = value; -} Index: unk/psLib/src/sysUtils/psMemory.h =================================================================== --- /trunk/psLib/src/sysUtils/psMemory.h (revision 4545) +++ (revision ) @@ -1,460 +1,0 @@ -/** @file psMemory.h - * - * @brief Contains the definitions for the memory management system - * - * This is the generic memory management system put inbetween the user's high level code and the OS-level - * memory allocation routines. This system adds such features as callback routines for memory error events, - * tracing capabilities, and reference counting. - * - * @author Robert DeSonia, MHPCC - * @author Robert Lupton, Princeton University - * - * @ingroup MemoryManagement - * - * @version $Revision: 1.46 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-01 22:01:17 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_MEMORY_H -#define PS_MEMORY_H - -#include // needed for FILE -#include // we need a mutex to make this stuff thread safe. - -#include "psType.h" - -/** @addtogroup MemoryManagement - * @{ - */ - -/** - * @addtogroup memCallback Memory Callbacks - * - * Routines dealing with the creating and setting of memory management callback functions. - */ - -/** - * @addtogroup memTracing Memory Tracing - * - * Routines dealing with memory tracing and corruption checking. - */ - -/** - * @addtogroup memRefCount Reference Count - * - * Routines dealing with the reference counting of allocated buffers. - */ - -/// typedef for memory identification numbers. Guaranteed to be some variety of integer. -typedef unsigned long psMemId; - -/// typedef for a memory block's reference count. Guaranteed to be some variety of integer. -typedef unsigned long psReferenceCount; - -/// typedef for deallocator. -typedef void (*psFreeFunc) (void* ptr); - -/** Book-keeping data for storage allocator. - * N.b. sizeof(psMemBlock) must be chosen such that if ptr is a pointer - * returned by malloc, then ((char *)ptr + sizeof(psMemBlock)) is properly - * aligned for all storage types. - */ -typedef struct psMemBlock -{ - const void* startblock; ///< initialised to p_psMEMMAGIC - struct psMemBlock* previousBlock; ///< previous block in allocation list - struct psMemBlock* nextBlock; ///< next block allocation list - psFreeFunc freeFunc; ///< deallocator. If NULL, use generic deallocation. - size_t userMemorySize; ///< the size of the user-portion of the memory block - const psMemId id; ///< a unique ID for this allocation - const char *file; ///< set from __FILE__ in e.g. p_psAlloc - const unsigned int lineno; ///< set from __LINE__ in e.g. p_psAlloc - pthread_mutex_t refCounterMutex; ///< mutex to ensure exclusive access to reference counter - psReferenceCount refCounter; ///< how many times pointer is referenced - bool persistent; ///< marks if this non-user persistent data like error stack, etc. - const void* endblock; ///< initialised to p_psMEMMAGIC -} -psMemBlock; - -/** prototype of a basic callback used by memory functions - * - * @see psMemAllocCallbackSet - * @ingroup memCallback - */ -typedef psMemId(*psMemAllocCallback) ( - const psMemBlock* ptr ///< the psMemBlock just allocated -); - -/** prototype of memory free callback used by memory functions - * - * @see psMemFreeCallbackSet - * @ingroup memCallback - */ -typedef psMemId(*psMemFreeCallback) ( - const psMemBlock* ptr ///< the psMemBlock being freed -); - -/** prototype of a callback used in error conditions - * - * This callback should not try to call psAlloc or psFree. - * - * @see psMemProblemCallbackSet - * @ingroup memCallback - */ -typedef void (*psMemProblemCallback) ( - psMemBlock* ptr, ///< the pointer to the problematic memory block. - const char *filename, ///< the file in which the problem originated - unsigned int lineno ///< the line number in which the problem originated -); - -/** prototype of a callback function used when memory runs out - * - * @return psPtr pointer to requested buffer of the size size_t, or NULL if memory could not - * be found. - * - * @see psMemExhaustedCallbackSet - * @ingroup memCallback - */ -typedef void* (*psMemExhaustedCallback) ( - size_t size ///< the size of buffer required -); - -/** Memory allocation. This operates much like malloc(), but is guaranteed to return a non-NULL value. - * - * @return psPtr pointer to the allocated buffer. This will not be NULL. - * @see psFree - */ -#ifdef DOXYGEN - -psPtr psAlloc( - size_t size ///< Size required -); - -#else // #ifdef DOXYGEN -psPtr p_psAlloc( - size_t size, ///< Size required - const char *filename, ///< File of call - unsigned int lineno ///< Line number of call -); - -/// Memory allocation. psAlloc sends file and line number to p_psAlloc. -#ifndef SWIG -#define psAlloc(size) p_psAlloc(size, __FILE__, __LINE__) -#endif // ! SWIG - -#endif // ! DOXYGEN - -/** Set the deallocator routine - * - * A deallocator routine can optionally be assigned to a memory block to - * ensure that associated memory blocks also get freed, e.g., memory buffers - * referenced within a struct. - * - */ -void psMemSetDeallocator( - psPtr ptr, ///< the memory block to operate on - psFreeFunc freeFunc ///< the function to be executed at deallocation -); - -/** Get the deallocator routine - * - * This function returns the deallocator for a memory block. A deallocator - * routine can optionally be assigned to a memory block to ensure that - * associated memory blocks also get freed, e.g., memory buffers referenced - * within a struct. - * - * @return psFreeFunc the routine to be called at deallocation. - */ -psFreeFunc psMemGetDeallocator( - psPtr ptr ///< the memory block -); - -/** Set the memory as persistent so that it is ignored when detecting memory leaks. - * - * Used to mark a memory block as persistent data within the library, - * i.e., non user-level data used to hold psLib's state or cache data. Such - * examples of this class of memory is psTrace's trace-levels and dynamic - * error codes. - * - * Memory marked as persistent is excluded from memory leak checks. - * - */ -void p_psMemSetPersistent( - psPtr ptr, ///< the memory block to operate on - bool value ///< true if memory is persistent, otherwise false -); - -/** Get the memory's persistent flag. - * - * Checks if a memory block has been marked as persistent by - * p_psMemSetPresistent. - * - * Memory marked as persistent is excluded from memory leak checks. - * - * @return bool true if memory is marked persistent, otherwise false. - */ -bool p_psMemGetPersistent( - psPtr ptr ///< the memory block to check. -); - - -/** Memory re-allocation. This operates much like realloc(), but is guaranteed to return a non-NULL value. - * - * @return psPtr pointer to resized buffer. This will not be NULL. - * @see psAlloc, psFree - */ -#ifdef DOXYGEN - -psPtr psRealloc( - psPtr ptr, ///< Pointer to re-allocate - size_t size ///< Size required -); -#else // #ifdef DOXYGEN - -psPtr p_psRealloc( - psPtr ptr, ///< Pointer to re-allocate - size_t size, ///< Size required - const char *filename, ///< File of call - unsigned int lineno ///< Line number of call -); - -/// Memory re-allocation. psRealloc sends file and line number to p_psRealloc. -#ifndef SWIG -#define psRealloc(ptr, size) p_psRealloc(ptr, size, __FILE__, __LINE__) -#endif // ! SWIG - -#endif // ! DOXYGEN - -/** Free memory. This operates much like free(). - * - * @see psAlloc, psRealloc - */ -#ifdef DOXYGEN -void psFree( - psPtr ptr ///< Pointer to free, if NULL, function returns immediately. -); -#else // #ifdef DOXYGEN -void p_psFree( - psPtr ptr, ///< Pointer to free - const char *file, ///< File of call - unsigned int lineno ///< Line number of call -); - -/// Free memory. psFree sends file and line number to p_psFree. -#ifndef SWIG -#define psFree(ptr) { p_psFree((psPtr)ptr, __FILE__, __LINE__); *(void**)&ptr = NULL; } -#endif // ! SWIG - -#endif // ! DOXYGEN - -/** Check for memory leaks. This scans for allocated memory buffers not freed with an ID not less than id0. - * This is used to check for memory leaks by: - * -# before a block of code to be checked, store the current ID count via psGetMemId - * -# after the block of code to be checked, call this function using the ID stored above. If all - * memory in the block that was allocated has been freed, this call should output nothing and - * return 0. - * - * If memory leaks are found, the Memory Problem callback will be called as well. - * - * return psS32 number of memory blocks found as 'leaks', i.e., the number of currently allocated memory - * blocks above id0 that have not been freed. - * @see psAlloc, psFree, psgetMemId, psMemProblemCallbackSet - * @ingroup memTracing - */ -psS32 psMemCheckLeaks( - psMemId id0, ///< don't list blocks with id < id0 - psMemBlock* ** arr, ///< pointer to array of pointers to leaked blocks, or NULL - FILE * fd, ///< print list of leaks to fd (or NULL) - psBool persistence ///< make check across all object even persistent ones -); - -/** Check for memory corruption. Scans all currently allocated memory buffers and checks for corruptions, - * i.e., invalid markers that signify a buffer under/overflow. - * - * @ingroup memTracing - */ -int psMemCheckCorruption( - bool abort_on_error ///< Abort on detecting corruption? -); - -/** Return reference counter - * - * @ingroup memRefCount - */ -psReferenceCount psMemGetRefCounter( - const psPtr ptr ///< Pointer to get refCounter for -); - -/** Increment reference counter and return the pointer - * - * @ingroup memRefCount - */ -#ifdef DOXYGEN -psPtr psMemIncrRefCounter( - const psPtr ptr ///< Pointer to increment refCounter, and return -); -#else -psPtr p_psMemIncrRefCounter( - psPtr vptr, ///< Pointer to increment refCounter, and return - const char *file, ///< File of call - psS32 lineno ///< Line number of call -); - -#ifndef SWIG -#define psMemIncrRefCounter(vptr) p_psMemIncrRefCounter(vptr, __FILE__, __LINE__) -#endif // !SWIG - -#endif // !DOXYGEN - -/** Decrement reference counter and return the pointer - * - * @ingroup memRefCount - * - * @return psPtr the pointer deremented in refCount, or NULL if pointer is - * fully dereferenced. - */ -#ifdef DOXYGEN -psPtr psMemDecrRefCounter( - psPtr ptr ///< Pointer to decrement refCounter, and return -); -#else // DOXYGEN -psPtr p_psMemDecrRefCounter( - psPtr vptr, ///< Pointer to decrement refCounter, and return - const char *file, ///< File of call - psS32 lineno ///< Line number of call -); - -#ifndef SWIG -#define psMemDecrRefCounter(vptr) p_psMemDecrRefCounter(vptr, __FILE__, __LINE__) -#endif // !SWIG - -#endif // !DOXYGEN - -/** Set callback for problems. - * - * At various occasions, the memory manager can check the state of the memory - * stack. If any of these checks discover that the memory stack is corrupted, - * the psMemProblemCallback is called. - - * @ingroup memCallback - * - * @return psMemProblemCallback old psMemProblemCallback function - */ -psMemProblemCallback psMemProblemCallbackSet( - psMemProblemCallback func ///< Function to run at memory problem detection -); - -/** Set callback for out-of-memory. - * - * If not enough memory is available to satisfy a request by psAlloc or - * psRealloc, these functions attempt to find an alternative solution by - * calling the psMemExhaustedCallback, a function which may be set by the - * programmer in appropriate circumstances, rather than immediately fail. - * The typical use of such a feature may be when a program needs a large - * chunk of memory to do an operation, but the exact size is not critical. - * This feature gives the programmer the opportunity to make a smaller - * request and try again, limiting the size of the operating buffer. - * - * @ingroup memCallback - * - * @return psMemExhaustedCallback old psMemExhaustedCallback function - */ -psMemExhaustedCallback psMemExhaustedCallbackSet( - psMemExhaustedCallback func ///< Function to run at memory exhaustion -); - -/** Set call back for when a particular memory block is allocated - * - * A private variable, p_psMemAllocID, can be used to trace the allocation - * and freeing of specific memory blocks. If p_psMemAllocID is set and a - * memory block with that ID is allocated, psMemAllocCallback is called - * just before memory is returned to the calling function. - * - * @ingroup memCallback - * - * @return psMemAllocCallback old psMemAllocCallback function - */ -psMemAllocCallback psMemAllocCallbackSet( - psMemAllocCallback func ///< Function to run at memory allocation of specific mem block -); - -/** Set call back for when a particular memory block is freed - * - * A private variable, p_psMemFreeID, can be used to trace the freeing of - * specific memory blocks. If p_psMemFreeID is set and the memory block with - * the ID is about to be freed, the psMemFreeCallback callback is called just - * before the memory block is freed. - * - * @ingroup memCallback - * - * @return psMemFreeCallback old psMemFreeCallback function - */ -psMemFreeCallback psMemFreeCallbackSet( - psMemFreeCallback func ///< Function to run at memory free of specific mem block -); - -/** get next memory ID - * - * @ingroup memCallback - * - * @return psMemId the next memory ID to be used - */ -psMemId psMemGetId(void); - -/** set p_psMemAllocID to specific id - * - * A private variable, p_psMemAllocID, can be used to trace the allocation - * and freeing of specific memory blocks. If p_psMemAllocID is set and a - * memory block with that ID is allocated, psMemAllocCallback is called - * just before memory is returned to the calling function. - * - * @ingroup memCallback - * - * @return psMemId - * - * @see psMemAllocCallbackSet - */ -psMemId psMemAllocCallbackSetID( - psMemId id ///< ID to set -); - -/** set p_psMemFreeID to id - * - * A private variable, p_psMemFreeID, can be used to trace the freeing of - * specific memory blocks. If p_psMemFreeID is set and the memory block with - * the ID is about to be freed, the psMemFreeCallback callback is called just - * before the memory block is freed. - * - * @ingroup memCallback - * - * @return psMemId the old p_psMemFreeID - * - * @see psMemFreeCallbackSet - */ -psMemId psMemFreeCallbackSetID( - psMemId id ///< ID to set -); - -//@} End of Memory Management Functions - -#ifndef DOXYGEN - -/* - * Ensure that any program using malloc/realloc/free will fail to compile - */ -#ifndef PS_ALLOW_MALLOC -#ifdef __GNUC__ -#pragma GCC poison malloc realloc calloc free -#else // __GNUC__ -#define malloc(S) _Pragma("error Use of malloc is not allowed. Use psAlloc instead.") -#define realloc(P,S) _Pragma("error Use of realloc is not allowed. Use psRealloc instead.") -#define calloc(S) _Pragma("error Use of calloc is not allowed. Use psAlloc instead.") -#define free(P) _Pragma("error Use of free is not allowed. Use psFree instead.") -#endif // ! __GNUC__ -#endif // #ifndef PS_ALLOW_MALLOC - -#endif // #ifndef DOXYGEN - -#endif // #ifndef PS_MEMORY_H Index: unk/psLib/src/sysUtils/psString.c =================================================================== --- /trunk/psLib/src/sysUtils/psString.c (revision 4545) +++ (revision ) @@ -1,159 +1,0 @@ - -/** @file psString.c - * - * -*- mode: C; c-basic-indent: 4; tab-width: 8; indent-tabs-mode: nil -*- - * vim: set cindent ts=8 sw=4 expandtab: - * - * @brief Contains the definition of string utility functions - * - * String utility functions defined shall provide basic string copying - * capabilities while using the preferred memory management utilities. - * - * @author Eric Van Alst, MHPCC - * - * @version $Revision: 1.19 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-30 00:33:36 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#include -#include -#include -#include "psString.h" -#include "psMemory.h" -#include "psError.h" - -#include "psSysUtilsErrors.h" - -psString psStringCopy(const char *string) -{ - // Allocate memory using psAlloc function - // Copy input string to memory just allocated - // Return the copy - return strcpy(psAlloc(strlen(string) + 1), string); -} - -psString psStringNCopy(const char *string, unsigned int nChar) -{ - char *returnValue = NULL; - - // Check the number of characters to copy is non-negative - if (nChar == UINT_MAX) { - // Log error message and return NULL - psError(PS_ERR_BAD_PARAMETER_VALUE, true, - PS_ERRORTEXT_psString_NCHAR_NEGATIVE, - nChar); - return NULL; - } - // Allocate memory using psAlloc function - nChar bytes - // Copy input string to memory allocated up to nChar characters - // Return the copy - returnValue = strncpy(psAlloc((size_t) nChar + 1), string, (size_t) nChar); - - // Ensure the last byte is NULL character - if (nChar > 0) { - returnValue[nChar] = '\0'; - } - // Return the string pointer - return returnValue; -} - -ssize_t psStringAppend(char **dest, const char *format, ...) -{ - va_list args; - size_t length; // complete string length (sans \0) - size_t oldLength; // original string length (sans \0) - ssize_t tailLength; // length of string to append - - if (!dest || !format) { - return 0; - } - - if (!*dest) { - *dest = psStringCopy(""); - oldLength = 0; - } else { - // size of existing string - oldLength = strlen(*dest); - } - - // find the size of the string to append - va_start(args, format); - // C99 guarentees vsnprintf() to work as expected with size = 0 - tailLength = vsnprintf(*dest, 0, format, args); - va_end(args); - - // if the new tail is zero length, return the length of the old string. if - // it's a format error, return the error code. - if (tailLength < 1) { - return tailLength == 0 ? oldLength : tailLength; - } - - // new string length (sans \0) - length = oldLength + tailLength; - - // realloc string to string + tail + \0 - *dest = psRealloc(*dest, length + 1); - - // append tail + \0 - va_start(args, format); - vsnprintf(*dest + oldLength, tailLength + 1, format, args); - va_end(args); - - return length; -} - -ssize_t psStringPrepend(char **dest, const char *format, ...) -{ - va_list args; - size_t length; // complete string length (sans \0) - ssize_t headLength; // length of string to prepend - char *oldDest; // copy of original string - - if (!dest || !format) { - return 0; - } - - if (!*dest) { - // makes the string backup and concatination pointless - *dest = psStringCopy(""); - length = 0; - } else { - // size of existing string - length = strlen(*dest); - } - - // find the size of the string to prepend - va_start(args, format); - // C99 guarentees vsnprintf() to work as expected with size = 0 - headLength = vsnprintf(*dest, 0, format, args); - va_end(args); - - // if the new head is zero length, return the length of the old string. if - // it's a format error, return the error code. - if (headLength < 1) { - return headLength == 0 ? length : headLength; - } - - // backup original string - oldDest = psStringCopy(*dest); - - // new string length (sans \0) - length += headLength; - - // realloc string to head + string + \0 - *dest = psRealloc(*dest, length + 1); - - // copy the new head to the beginning of string - va_start(args, format); - vsnprintf(*dest, length + 1, format, args); - va_end(args); - - // append the original string - strncat(*dest, oldDest, length + 1); - - psFree(oldDest); - - return length; -} Index: unk/psLib/src/sysUtils/psString.h =================================================================== --- /trunk/psLib/src/sysUtils/psString.h (revision 4545) +++ (revision ) @@ -1,99 +1,0 @@ -/** @file psString.h - * - * -*- mode: C; c-basic-indent: 4; tab-width: 8; indent-tabs-mode: nil -*- - * vim: set cindent ts=8 sw=4 expandtab: - * - * @brief Contains the declarations of string utility functions - * - * @ingroup SysUtils - * - * String utility functions defined shall provide basic string copying - * capabilities. - * - * @author Eric Van Alst, MHPCC - * - * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-30 00:33:36 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_STRING_H -#define PS_STRING_H - -#include -#include "psType.h" - -/** This macro will convert the argument to a quoted string */ -#define PS_STRING(S) #S - -// Doxygen group tags - -/** @addtogroup SysUtils - * @{ - */ - -/** Copies the input string - * - * This function shall allocate memory to the length of the input string - * plus one and copy the input string to the newly allocated memory. - * - * @return psString: Copy of input string - * - */ -psString psStringCopy( - const char *string ///< Input string of characters to copy -); - -/** Copies the input string up to the specified number of characters - * - * This function shall allocate memory to the length specified by nChar - * plus one and copy the input string to the newly allocated memory. - * This function will only copy nChar bytes from the input to new string, - * so if the input string is larger than nChar characters the copied - * string will be a substring of the input string. If the input string - * is smaller than nChar bytes then the remaining bytes allocated will - * be set to NULL. - * - * @return psString: Copy of input string - * - */ - -/*@null@*/ - -psString psStringNCopy( - const char *string, ///< Input string of characters to copy - unsigned int nChar ///< Number of bytes to allocate for string copy -); - -/** Appends a format onto a string - * - * This function shall allocate a new string if dest is NULL. dest shall be - * automatically extended to the size of the new string. - * - * @return The length of the new string (excluding '\0') - */ - -ssize_t psStringAppend( - char **dest, ///< existing string - const char *format, ///< format to append - ... ///< format arguments -); - -/** Prepends a format onto a string - * - * This function shall allocate a new string if dest is NULL. dest shall be - * automatically extended to the size of the new string. - * - * @return The length of the new string (excluding '\0') - */ - -ssize_t psStringPrepend( - char **dest, ///< existing string - const char *format, ///< format to append - ... ///< format arguments -); - -/** @} */// Doxygen - End of SystemGroup Functions - -#endif // #ifndef PS_STRING_H Index: unk/psLib/src/sysUtils/psSysUtilsErrors.dat =================================================================== --- /trunk/psLib/src/sysUtils/psSysUtilsErrors.dat (revision 4545) +++ (revision ) @@ -1,50 +1,0 @@ -# -# This file is used to generate psSysUtilsErrors.h content -# -# Format is: -# ERRORNAME(one word) ERROR_TEXT -# -# N.b. The ERRORNAME is exposed in the code as PS_ERR_ERRORNAME, e.g., -# if ERRORNAME=psMemory_NULL_BLOCK, then use PS_ERR_psMemory_NULL_BLOCK in -# the code. -# -#################################################################### -# -# Error Messages from psLogMsg.c: -# -psLogMsg_DESTINATION_MALFORMED The specified destination, %s, is malformed. -psLogMsg_DEST_LOCATION_INVALID The location, %s, for protocol 'dest' is invalid. -psLogMsg_OPEN_FILE_FAILED Could not open file '%s' for output. -psLogMsg_UNSUPPORTED_PROTOCOL Do not know how to handle the protocol '%s'. -psLogMsg_UNKNOWN_KEY Unknown logging keyword %c. -# -# Error Messages from psMemory.c: -# -psMemory_NULL_BLOCK NULL memory block found. -psMemory_DEREF_BLOCK_USE Memory block %lld was freed but still being used. -psMemory_UNDERFLOW Memory block %lld is corrupted; buffer underflow detected. -psMemory_OVERFLOW Memory block %lld is corrupted; buffer overflow detected. -psMemory_MULTIPLE_FREE Block %lld, allocated at %s:%d, freed multiple times at %s:%d. -# -# Error Messages from psString.c: -# -psString_NCHAR_NEGATIVE Can not copy a negative number of characters (%d). -# -# Error Messages from psTrace.c: -# -psTrace_NULL_SUBCOMPONENT Sub-component %d of node %s in trace tree is NULL. -psTrace_NULL_TRACETREE Function %s called on a NULL trace level tree. -psTrace_ADD_NULL_COMPONENT Failed to add null component to trace tree. -psTrace_MALFORMED_COMPONENT_NAME Failed to add '%s' to the root component tree; component must start with '.'. -psTrace_FAILED_TO_ADD_COMPONENT Failed to set trace level (%d) to '%s'. -# -# Error Messages from psErrorCodes.c -# -psErrorCode_NULL_ERRORDESCRIPTION Specified psErrorDescription pointer can not be NULL. -psErrorCode_ERRORCODE_REGISTER_FAILED Failed to add input psErrorDescription at array index %d. -# -# Error Messages from psConfigure.c -# -psConfigure_INITIALIZATION_FAILED Failed to initialize %s. -psConfigure_FINALIZATION_FAILED Failed to finalize %s. - Index: unk/psLib/src/sysUtils/psSysUtilsErrors.h =================================================================== --- /trunk/psLib/src/sysUtils/psSysUtilsErrors.h (revision 4545) +++ (revision ) @@ -1,52 +1,0 @@ -/** @file psSysUtilsErrors.h - * - * @brief Contains the error text for the system utility functions - * - * @ingroup ErrorHandling - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -#ifndef PS_SYSUTILS_ERRORS_H -#define PS_SYSUTILS_ERRORS_H - -/* N.B., lines between '//~Start' and '//~End' are automatic generated from - * the template following the '//~Start'. The template is used to generate - * the other lines by, for each error text in psSysUtilsErrors.dat, the following - * substitutions are made: - * $1 The error text macro name (first word in the psSysUtilsErrors.dat lines) - * $2 The error text (rest of the line in psSysUtilsErrors.dat) - * $n The order of the source line in psSysUtilsErrors.dat (comments excluded) - * - * DO NOT EDIT THE LINES BETWEEN //~Start and //~End! ANY CHANGES WILL BE OVERWRITTEN. - */ - -//~Start #define PS_ERRORTEXT_$1 "$2" -#define PS_ERRORTEXT_psLogMsg_DESTINATION_MALFORMED "The specified destination, %s, is malformed." -#define PS_ERRORTEXT_psLogMsg_DEST_LOCATION_INVALID "The location, %s, for protocol 'dest' is invalid." -#define PS_ERRORTEXT_psLogMsg_OPEN_FILE_FAILED "Could not open file '%s' for output." -#define PS_ERRORTEXT_psLogMsg_UNSUPPORTED_PROTOCOL "Do not know how to handle the protocol '%s'." -#define PS_ERRORTEXT_psLogMsg_UNKNOWN_KEY "Unknown logging keyword %c." -#define PS_ERRORTEXT_psMemory_NULL_BLOCK "NULL memory block found." -#define PS_ERRORTEXT_psMemory_DEREF_BLOCK_USE "Memory block %lld was freed but still being used." -#define PS_ERRORTEXT_psMemory_UNDERFLOW "Memory block %lld is corrupted; buffer underflow detected." -#define PS_ERRORTEXT_psMemory_OVERFLOW "Memory block %lld is corrupted; buffer overflow detected." -#define PS_ERRORTEXT_psMemory_MULTIPLE_FREE "Block %lld, allocated at %s:%d, freed multiple times at %s:%d." -#define PS_ERRORTEXT_psString_NCHAR_NEGATIVE "Can not copy a negative number of characters (%d)." -#define PS_ERRORTEXT_psTrace_NULL_SUBCOMPONENT "Sub-component %d of node %s in trace tree is NULL." -#define PS_ERRORTEXT_psTrace_NULL_TRACETREE "Function %s called on a NULL trace level tree." -#define PS_ERRORTEXT_psTrace_ADD_NULL_COMPONENT "Failed to add null component to trace tree." -#define PS_ERRORTEXT_psTrace_MALFORMED_COMPONENT_NAME "Failed to add '%s' to the root component tree; component must start with '.'." -#define PS_ERRORTEXT_psTrace_FAILED_TO_ADD_COMPONENT "Failed to set trace level (%d) to '%s'." -#define PS_ERRORTEXT_psErrorCode_NULL_ERRORDESCRIPTION "Specified psErrorDescription pointer can not be NULL." -#define PS_ERRORTEXT_psErrorCode_ERRORCODE_REGISTER_FAILED "Failed to add input psErrorDescription at array index %d." -#define PS_ERRORTEXT_psConfigure_INITIALIZATION_FAILED "Failed to initialize %s." -#define PS_ERRORTEXT_psConfigure_FINALIZATION_FAILED "Failed to finalize %s." -//~End - -#endif // #ifndef PS_SYSUTILS_ERRORS_H Index: unk/psLib/src/sysUtils/psTrace.c =================================================================== --- /trunk/psLib/src/sysUtils/psTrace.c (revision 4545) +++ (revision ) @@ -1,557 +1,0 @@ -/** @file psTrace.c - * \brief basic run-time trace facilities - * \ingroup LogTrace - * - * This file will hold the code for procedures to insert - * trace messages into the code. - * - * @author Robert Lupton, Princeton University - * @author GLG, MHPCC - * - * @version $Revision: 1.53 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-28 20:17:52 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ - -/***************************************************************************** - NOTES: - In the SRD, higher trace levels correspond to a numerically lower trace - value in the code. This is a bit confusing. For example, a high-level - message might be something like "Begin Processing". The module programmer - might give that a numerically low trace level, such as 1, so then any - non-zero trace level in that code component will display thatmessage. - - We build a tree of trace components. Every node in the tree has a - depth, which is it's distance from the root. However, this is not - not the same thing as a node's "level", which corresponds to the - trace level of that node. - -I think the following is the correct behavior, but not sure: - PS_UNKNOWN_TRACE_LEVEL: We never set the level of a component to this - value. This value is only used when psTraceGetLevel is called with - a bad component name, or if the component root is undefined, I think. - - PS_DEFAULT_TRACE_LEVEL: This should only be used when adding the - intermediate components of a psS64 name. Ie. the "B" in .A.B.C - - *****************************************************************************/ - -#ifndef PS_NO_TRACE - -#include -#include -#include -#include -#include -#include "psMemory.h" -#include "psTrace.h" -#include "psString.h" -#include "psError.h" -#include "psLogMsg.h" - -#include "psSysUtilsErrors.h" - -static p_psComponent* cRoot = NULL; // The root of the trace component -static FILE *traceFP = NULL; // File destination for messages. - -static void componentFree(p_psComponent* comp); -static p_psComponent* componentAlloc(const char *name, int level); - -/***************************************************************************** -componentAlloc(): allocate memory for a new node, and initialize members. - *****************************************************************************/ -static p_psComponent* componentAlloc(const char *name, int level) -{ - p_psComponent* comp = psAlloc(sizeof(p_psComponent)); - - p_psMemSetPersistent(comp,true); - psMemSetDeallocator(comp, (psFreeFunc) componentFree); - comp->name = psStringCopy(name); - p_psMemSetPersistent((psPtr)comp->name,true); - comp->level = level; - comp->n = 0; - comp->p_psSpecified = false; - comp->subcomp = NULL; - return comp; -} - -/***************************************************************************** -componentFree(): free the current node in the root tree, and all children -nodes as well. - *****************************************************************************/ -static void componentFree(p_psComponent* comp) -{ - if (comp == NULL) { - return; - } - - if (comp->subcomp != NULL) { - for (psS32 i = 0; i < comp->n; i++) { - p_psMemSetPersistent(comp->subcomp[i],false); - psFree(comp->subcomp[i]); - } - p_psMemSetPersistent(comp->subcomp,false); - psFree(comp->subcomp); - } - - p_psMemSetPersistent((psPtr)comp->name,false); - psFree(comp->name); -} - -/***************************************************************************** -initTrace(): simply initialize the component root tree. -*****************************************************************************/ -static void initTrace(void) -{ - if (cRoot == NULL) { - cRoot = componentAlloc(".", PS_DEFAULT_TRACE_LEVEL); - } -} - -/***************************************************************************** -Set all trace levels to zero. - -XXX: Currently, no function calls this routine. - *****************************************************************************/ -void p_psTraceReset(p_psComponent* currentNode) -{ - psS32 i = 0; - - if (NULL == currentNode) { - return; - } - - currentNode->level = 0; - for (i = 0; i < currentNode->n; i++) { - if (NULL == currentNode->subcomp[i]) { - psLogMsg("p_psTraceReset", PS_LOG_WARN, - PS_ERRORTEXT_psTrace_NULL_SUBCOMPONENT, - i, currentNode->name); - } else { - p_psTraceReset(currentNode->subcomp[i]); - } - } - return; -} - -/***************************************************************************** -Set all trace levels to zero. - *****************************************************************************/ -void psTraceReset() -{ - psFree(cRoot); - cRoot = NULL; -} - -/***************************************************************************** -componentAdd(): Adds the component named "addNodeName" to the root tree. - *****************************************************************************/ -static psBool componentAdd(const char *addNodeName, psS32 level) -{ - psS32 i = 0; // Loop index variable. - char name[strlen(addNodeName) + 1]; // buffer for writeable copy. - char *pname = name; - char *firstComponent = NULL; // first component of name - p_psComponent* currentNode = cRoot; - psS32 nodeExists = 0; - - // XXX: Verify that this is the correct behavior. - if (strcmp("", addNodeName) == 0) { - psError(PS_ERR_BAD_PARAMETER_NULL,true, - PS_ERRORTEXT_psTrace_ADD_NULL_COMPONENT); - return false; - } - - // Is this the root node? If so, simply set level and return. - if (strcmp(".", addNodeName) == 0) { - cRoot->level = level; - return true; - } - - if (addNodeName[0] != '.') { - psError(PS_ERR_BAD_PARAMETER_VALUE,true, - PS_ERRORTEXT_psTrace_MALFORMED_COMPONENT_NAME, - addNodeName); - return false; - } - - strcpy(name, addNodeName); - pname = name+1; - // Iterate through the components of addNodeName. Strip off the first - // component of the name, find that in the root tree, or add it if it - // does not exist, then move to the next component in the name. - - while (pname != NULL) { - firstComponent = pname; - pname = strchr(firstComponent, '.'); - if (pname != NULL) { - *pname = '\0'; - pname++; - } - nodeExists = 0; - for (i = 0; i < currentNode->n; i++) { - if (strcmp(currentNode->subcomp[i]->name, firstComponent) == 0) { - currentNode = currentNode->subcomp[i]; - nodeExists = 1; - if (pname == NULL) { - currentNode->level = level; - } - } - } - - if (nodeExists == 0) { - currentNode->subcomp = psRealloc(currentNode->subcomp, - (currentNode->n + 1) * sizeof(p_psComponent* )); - p_psMemSetPersistent(currentNode->subcomp,true); - - currentNode->n = (currentNode->n) + 1; - - if (pname == NULL) { - // This is the final component to add. - currentNode->subcomp[(currentNode->n) - 1] = componentAlloc(firstComponent, level); - } else { - // We are adding an intermediate component. The trace level - // is not defined. An undefined trace level inherits the - // trace level of it's parent. However, we do not set that - // specifically here since that would inheritance to be a - // static, one-time, type of behavior. - - currentNode->subcomp[(currentNode->n) - 1] = componentAlloc(firstComponent, PS_DEFAULT_TRACE_LEVEL); - } - currentNode = currentNode->subcomp[(currentNode->n) - 1]; - } - } - - return true; -} - -/***************************************************************************** - psSetTraceLevel(): add the component named "comp" to the component tree, - if it is not already there, and set it's trace level to "level". - - NOTE: We modified this so that the user may omit the leading "," in a - component name. Since the code was already implemented assuming the "." - was required, rather than change all that code, in this function, I - simply add a leading "." to the component name if there is none. - - Input: - comp - level - Output: - none - Returns: - zero -*****************************************************************************/ -psBool psTraceSetLevel(const char *comp, // component of interest - int level) // desired trace level -{ - char *compName = NULL; - - // If the root component tree does not exist, then initialize it. - if (cRoot == NULL) { - initTrace(); - } - - if (traceFP == NULL) { - traceFP = stdout; - } - - // If the component name has no leading dot, then supply it. - if (comp[0] != '.') { - compName = (char *) psAlloc(10 + strlen(comp)); - strcpy(compName, "."); - compName = strcat(compName, comp); - } else { - compName = (char *) comp; - } - - // Add the new component to the component tree. - if ( !componentAdd(compName, level) ) { - psError(PS_ERR_UNKNOWN, false, - PS_ERRORTEXT_psTrace_FAILED_TO_ADD_COMPONENT, - level, - compName); - - if (comp[0] != '.') { - psFree(compName); - } - return false; - } - - if (comp[0] != '.') { - psFree(compName); - } - - return true; -} - -/***************************************************************************** - doGetTraceLevel() - This function recursively searches the root component tree for the - component named "name", which is supplied by a parameter. If it - finds that component, it returns the level of that component. - Otherwise, it returns ???. - - NOTE: We modified this so that the user may omit the leading "," in a - component name. Since the code was already implemented assuming the "." - was required, rather than change all that code, in this function, I - simply add a leading "." to the component name if there is none. - - Inputs: - name: - Outputs: - none - Returns: - The trace level of the "name" component. - *****************************************************************************/ -static psS32 doGetTraceLevel(const char *aname) -{ - char name[strlen(aname) + 1]; // need a writeable copy: for strsep() - char *pname = name; - char *firstComponent = NULL; // first component of name - p_psComponent* currentNode = cRoot; - psS32 i = 0; - psS32 defaultLevel = 0; - - if (NULL == currentNode) { - return (PS_UNKNOWN_TRACE_LEVEL); - } - - if (strcmp(".", aname) == 0) { - return (cRoot->level); - } - - if (aname[0] != '.') { - return (PS_UNKNOWN_TRACE_LEVEL); - } - - defaultLevel = cRoot->level; - strcpy(name, aname); - pname = name+1; - while (pname != NULL) { - firstComponent = pname; - pname = strchr(firstComponent, '.'); - if (pname != NULL) { - *pname = '\0'; - pname++; - } - for (i = 0; i < currentNode->n; i++) { - if (NULL == currentNode->subcomp[i]) { - psLogMsg("p_psTraceReset", PS_LOG_WARN, - PS_ERRORTEXT_psTrace_NULL_SUBCOMPONENT, - i, currentNode->name); - } - - if (strcmp(currentNode->subcomp[i]->name, firstComponent) == 0) { - currentNode = currentNode->subcomp[i]; - // For level inheritance purpose, we save the level of this - // component if it is not DEFAULT. - if (currentNode->level != PS_DEFAULT_TRACE_LEVEL) { - defaultLevel = currentNode->level; - } - // Determine if this is the last component: - if (pname == NULL) { - if (currentNode->level != PS_DEFAULT_TRACE_LEVEL) { - return (currentNode->level); - } else { - return(defaultLevel); - } - } - } - } - } - return(defaultLevel); -} - -/***************************************************************************** - psTraceLevelGet() - Return a trace level of "name" in the root component tree. If the - exact string of components in "name" does not exist in the root - tree, we return the deepest level of the match. - Input: - name - Output: - none - Return: - The level of "name" in the root component tree. - *****************************************************************************/ -int psTraceGetLevel(const char *name) -{ - char *compName = NULL; - psS32 traceLevel; - - if (cRoot == NULL) { - return (PS_UNKNOWN_TRACE_LEVEL); - } - - // If the component name has no leading dot, then supply it. - if (name[0] != '.') { - compName = (char *) psAlloc(10 + strlen(name)); - strcpy(compName, "."); - compName = strcat(compName, name); - traceLevel = doGetTraceLevel(compName); - psFree(compName); - } else { - // Search the component root tree, determine the trace level. - traceLevel = doGetTraceLevel(name); - } - - // XXX: The default trace level is currently set at -1, which is not a - // valid trace level. This is convenient in determining whether or not - // a component should inherit the trace level from parent nodes. However, - // it's not clear that -1 should ever be returned by this function. - // The SDR is unclear on this point and we should probably request IfA - // comment. - if (traceLevel == PS_DEFAULT_TRACE_LEVEL) { - traceLevel = PS_THE_OTHER_DEFAULT_TRACE_LEVEL; - } - - return(traceLevel); -} - -/***************************************************************************** - doPrintTraceLevels() - This function recursively searches the component tree supplied by the - parameter "comp" and prints the name and level of each component. - Inputs: - comp: a node in the component tree. - level: the level of that node - Outputs: - none - Returns: - null - *****************************************************************************/ -static void doPrintTraceLevels(const p_psComponent* comp, - psS32 depth, - psS32 defLevel) -{ - psS32 i = 0; - - if (traceFP == NULL) { - traceFP = stdout; - } - - if (comp->name[0] == '\0') { - return; - } else { - if (comp->level == PS_DEFAULT_TRACE_LEVEL) { - fprintf(traceFP,"%*s%-*s %d\n", depth, "", 20 - depth, comp->name, defLevel); - } else { - fprintf(traceFP, "%*s%-*s %d\n", depth, "", 20 - depth, comp->name, comp->level); - } - } - - for (i = 0; i < comp->n; i++) { - if (comp->level == PS_DEFAULT_TRACE_LEVEL) { - doPrintTraceLevels(comp->subcomp[i], depth + 1, defLevel); - } else { - doPrintTraceLevels(comp->subcomp[i], depth + 1, comp->level); - } - } -} - - -/***************************************************************************** -psPrintTraceLevels(): Simply print all the trace levels in the trace level -component tree. -Inputs: - none -Outputs: - none -Returns: - null -*****************************************************************************/ -void psTracePrintLevels(void) -{ - if (cRoot == NULL) { - return; - } - - doPrintTraceLevels(cRoot, 0, PS_THE_OTHER_DEFAULT_TRACE_LEVEL); -} - -/***************************************************************************** -p_psTrace(): we display the trace message to standard output if the trace -level of that message, supplied by the parameter "level" is higher than the -trace level that is currently associated with the component named by the -parameter "comp". -Input: - comp - level - ... a printf-style output string. -Output: - none -Return: - null - *****************************************************************************/ -void p_psTrace(const char *comp, // component being traced - int level, // desired trace level - ...) // arguments -{ - char *fmt = NULL; - va_list ap; - psS32 i = 0; - - if (traceFP == NULL) { - traceFP = stdout; - } - - if (NULL == comp) { - psError(PS_ERR_BAD_PARAMETER_NULL, true, - PS_ERRORTEXT_psTrace_NULL_TRACETREE, - __func__); - return; - } - // Only display this message if it's trace level is less than the level - // of it's associatedcomponent. - if (level <= psTraceGetLevel(comp)) { - va_start(ap, level); - - // The following functions get the variable list of parameters with - // which this function was called, and print them to the standard - // output. - fmt = va_arg(ap, char *); - - // We indent each message one space for each level of the message. - for (i = 0; i < level; i++) { - fprintf(traceFP, " "); - } - vfprintf(traceFP, fmt, ap); - va_end(ap); - } - fflush(traceFP); -} - -// XXX EAM : I've added code to close the old traceFP (safely) -void psTraceSetDestination(FILE * fp) -{ - - bool special; - - // XXX EAM perhaps return an error? - if (fp == NULL) { - return; - } - - // cannot close traceFP if one of the special FILE ptrs - special = (traceFP == NULL); - special |= (traceFP == stdin); - special |= (traceFP == stdout); - special |= (traceFP == stderr); - - if (!special) { - fclose (traceFP); - } - traceFP = fp; -} - -FILE *psTraceGetDestination() -{ - if (traceFP == NULL) { - traceFP = stdout; - } - return traceFP; -} - -#endif // #ifndef PS_NO_TRACE Index: unk/psLib/src/sysUtils/psTrace.h =================================================================== --- /trunk/psLib/src/sysUtils/psTrace.h (revision 4545) +++ (revision ) @@ -1,112 +1,0 @@ -/** @file psTrace.h - * \brief basic run-time trace facilities - * \ingroup LogTrace - * - * This file will hold the prototypes for defining procedures to insert - * trace messages into the code. - * - * @author Robert Lupton, Princeton University - * @author GLG, MHPCC - * - * @version $Revision: 1.34 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-28 20:17:52 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ -#if !defined(PS_TRACE_H) -#define PS_TRACE_H 1 - -#define PS_UNKNOWN_TRACE_LEVEL -9999 // we don't know this name's level -#define PS_DEFAULT_TRACE_LEVEL -1 -#define PS_THE_OTHER_DEFAULT_TRACE_LEVEL 0 - -/** \addtogroup LogTrace - * \{ - */ - -/** Functions **************************************************************/ - -//#define PS_NO_TRACE 1 ///< to turn off all tracing - -// XXX EAM : the old 'empty' values of (void) 0 are dangerous -# if defined(PS_NO_TRACE) - # define psTrace(facil, level, ...) /* do nothing */ - # define p_psTrace(facil, level, ...) /* do nothing */ - # define psTraceSetLevel(facil,level) /* do nothing */ - # define psTraceGetLevel(facil) /* do nothing */ - # define psTraceReset() /* do nothing */ - # define psTraceFree() /* do nothing */ - # define psTracePrintLevels() /* do nothing */ - # define psTraceSetDestination(fp) /* do nothing */ - # define psTraceSetDestination() /* do nothing */ - # define PS_TRACE_ON 0 - - # else /* PS_NO_TRACE */ - # define PS_TRACE_ON 1 - - /** Basic structure for the component tree. A component is a string of the - form aaa.bbb.ccc, and may itself contain further subcomponents. The - Component structure doesn't in fact contain it's full name, but only the - last part. */ - typedef struct p_psComponent - { - const char *name; // last part of name of component - psS32 level; // trace level for this component - bool p_psSpecified; - psS32 n; // number of subcomponents - struct p_psComponent* *subcomp; // next level of subcomponents - } -p_psComponent; - -#ifdef DOXYGEN -void psTrace( - const char *facil, ///< facilty of interest - int level, ///< desired trace level - ... ///< trace message arguments -); - -#else -/// Send a trace message -void p_psTrace( - const char *facil, ///< facilty of interest - psS32 myLevel, ///< desired trace level - ... ///< trace message arguments -); - -#ifndef SWIG -#define psTrace(facil, level, ...) p_psTrace(facil, level, __VA_ARGS__) -#endif /* SWIG */ - -#endif /* DOXYGEN */ - -/// Set trace level -psBool psTraceSetLevel( - const char *facil, ///< facilty of interest - int level ///< desired trace level -); - -/// Get the trace level -int psTraceGetLevel( - const char *facil ///< facilty of interest -); - -/// Set all trace levels to zero (do not free nodes in the component tree). -void psTraceReset(); - -/// print trace levels -void psTracePrintLevels(void); - -/// Set the destination of future trace messages. -void psTraceSetDestination( - FILE * fp ///< -); - -/// Get the current destination for trace messages. -FILE *psTraceGetDestination(void); - -/* \} */// End of SystemGroup Functions - -#endif /* PS_NO_TRACE */ - -#endif /* PS_TRACE_H */ - Index: unk/psLib/src/sysUtils/psType.h =================================================================== --- /trunk/psLib/src/sysUtils/psType.h (revision 4545) +++ (revision ) @@ -1,307 +1,0 @@ -/** @file psType.h -* -* @brief Contains support for basic types -* -* This file defines common datatypes used throughout psLib. -* -* @ingroup DataContainer -* -* @author Robert DeSonia, MHPCC -* @author Ross Harman, MHPCC -* -* @version $Revision: 1.38 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-07-09 01:24:30 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ - -#ifndef PS_TYPE_H -#define PS_TYPE_H - -#include -#include -#include -#include - -/// @addtogroup DataContainer -/// @{ - -/******************************************************************************/ - -/* TYPE DEFINITIONS */ - -/******************************************************************************/ - -/** Basic data types used by the containers. - * - * The basic types of the primitives used by psLib are defined within this enum. This enum is in turn used by - * the psType struct. - * - */ - -typedef uint8_t psU8; ///< 8-bit unsigned int -typedef uint16_t psU16; ///< 16-bit unsigned int -typedef uint32_t psU32; ///< 32-bit unsigned int -typedef uint64_t psU64; ///< 64-bit unsigned int -typedef int8_t psS8; ///< 8-bit signed int -typedef int16_t psS16; ///< 16-bit signed int -typedef int32_t psS32; ///< 32-bit signed int -typedef int64_t psS64; ///< 64-bit signed int -typedef float psF32; ///< 32-bit floating point -typedef double psF64; ///< 64-bit floating point - -#ifdef SWIG -/** 32-bit complex value */ -typedef struct -{ - float re, im; -} -psC32; - -/** 64-bit complex value */ -typedef struct -{ - double re,im; -} -psC64; - -#else // SWIG -typedef float _Complex psC32; ///< complex with 32-bit floating point Real and Imagary numbers -typedef double _Complex psC64; ///< complex with 64-bit floating point Real and Imagary numbers -#endif // !SWIG - -typedef char* psString; ///< string value -typedef void* psPtr; ///< void pointer -typedef bool psBool; ///< boolean value - -/** Enumeration of data types for function elements. - * Contains replacements for native types. - */ -typedef enum { - PS_TYPE_S8 = 0x0101, ///< Character. - PS_TYPE_S16 = 0x0102, ///< Short integer. - PS_TYPE_S32 = 0x0104, ///< Integer. - PS_TYPE_S64 = 0x0108, ///< Long integer. - PS_TYPE_U8 = 0x0301, ///< Unsigned character. - PS_TYPE_U16 = 0x0302, ///< Unsigned psS16 integer. - PS_TYPE_U32 = 0x0304, ///< Unsigned integer. - PS_TYPE_U64 = 0x0308, ///< Unsigned psS64 integer. - PS_TYPE_F32 = 0x0404, ///< Single-precision Floating point. - PS_TYPE_F64 = 0x0408, ///< Double-precision floating point. - PS_TYPE_C32 = 0x0808, ///< Complex numbers consisting of single-precision floating point. - PS_TYPE_C64 = 0x0810, ///< Complex numbers consisting of double-precision floating point. - PS_TYPE_BOOL = 0x1301 ///< Boolean. -} psElemType; - -/** Enumeration primarily used with metadata which defines a data structure - * e.g., list, array, FITS file, etc. -*/ -typedef enum { - PS_DATA_S32 = PS_TYPE_S32, ///< psS32 - PS_DATA_F32 = PS_TYPE_F32, ///< psF32 - PS_DATA_F64 = PS_TYPE_F64, ///< psF64 - PS_DATA_BOOL = PS_TYPE_BOOL, ///< psBool - PS_DATA_STRING = 0x10000, ///< psString (char *) - PS_DATA_ARRAY, ///< psArray - PS_DATA_BITSET, ///< psBitSet - PS_DATA_CELL, ///< psCell - PS_DATA_CHIP, ///< psChip - PS_DATA_CUBE, ///< psCube - PS_DATA_FITS, ///< psFits - PS_DATA_HASH, ///< psHash - PS_DATA_HISTOGRAM, ///< psHistogram - PS_DATA_IMAGE, ///< psImage - PS_DATA_KERNEL, ///< psKernel - PS_DATA_LIST, ///< psList - PS_DATA_LOOKUPTABLE, ///< psLookupTable - PS_DATA_METADATA, ///< psMetadata - PS_DATA_METADATAITEM, ///< psMetadataItem - PS_DATA_MINIMIZATION, ///< psMinimization - PS_DATA_PIXELS, ///< psPixels - PS_DATA_PLANE, ///< psPlane - PS_DATA_PLANEDISTORT, ///< psPlaneDistort - PS_DATA_PLANETRANSFORM, ///< psPlaneTransform - PS_DATA_POLYNOMIAL1D, ///< psPolynomial1D - PS_DATA_POLYNOMIAL2D, ///< psPolynomial2D - PS_DATA_POLYNOMIAL3D, ///< psPolynomial3D - PS_DATA_POLYNOMIAL4D, ///< psPolynomial4D - PS_DATA_PROJECTION, ///< psProjection - PS_DATA_READOUT, ///< psReadout - PS_DATA_REGION, ///< psRegion - PS_DATA_SCALAR, ///< psScalar - PS_DATA_SPHERE, ///< psSphere - PS_DATA_SPHERETRANSFORM, ///< psSphereTransform - PS_DATA_SPLINE1D, ///< psSpline1D - PS_DATA_STATS, ///< psStats - PS_DATA_TIME, ///< psTime - PS_DATA_VECTOR, ///< psVector - PS_DATA_UNKNOWN, ///< Other data of an unknown type - PS_DATA_METADATA_MULTI ///< Used internally for metadata; not a 'real' type -} psDataType; - -#define PS_TYPE_MASK PS_TYPE_U8 /**< the psElemType to use for mask image */ -#define PS_TYPE_MASK_DATA U8 /**< the data member to use for mask image */ -#define PS_TYPE_MASK_NAME "psU8" /**< the data type for mask as a string */ - -typedef psU8 psMaskType; ///< the C datatype for a mask image -typedef psBool psBOOL; ///< allow psBOOL to be used instead of psBool (for macros) - -#define PS_MIN_S8 INT8_MIN /**< minimum valid psS8 value */ -#define PS_MIN_S16 INT16_MIN /**< minimum valid psS16 value */ -#define PS_MIN_S32 INT32_MIN /**< minimum valid psS32 value */ -#define PS_MIN_S64 INT64_MIN /**< minimum valid psS64 value */ -#define PS_MIN_U8 0 /**< minimum valid psU8 value */ -#define PS_MIN_U16 0 /**< minimum valid psU16 value */ -#define PS_MIN_U32 0 /**< minimum valid psU32 value */ -#define PS_MIN_U64 0 /**< minimum valid psU64 value */ -#define PS_MIN_F32 -FLT_MAX /**< minimum valid psF32 value */ -#define PS_MIN_F64 -DBL_MAX /**< minimum valid psF64 value */ -#define PS_MIN_C32 -FLT_MAX /**< minimum valid real or imaginary psC32 value */ -#define PS_MIN_C64 -DBL_MAX /**< minimum valid real or imaginary psC32 value */ - -#define PS_MAX_S8 INT8_MAX /**< maximum valid psS8 value */ -#define PS_MAX_S16 INT16_MAX /**< maximum valid psS16 value */ -#define PS_MAX_S32 INT32_MAX /**< maximum valid psS32 value */ -#define PS_MAX_S64 INT64_MAX /**< maximum valid psS64 value */ -#define PS_MAX_U8 UINT8_MAX /**< maximum valid psU8 value */ -#define PS_MAX_U16 UINT16_MAX /**< maximum valid psU16 value */ -#define PS_MAX_U32 UINT32_MAX /**< maximum valid psU32 value */ -#define PS_MAX_U64 UINT64_MAX /**< maximum valid psU64 value */ -#define PS_MAX_F32 FLT_MAX /**< maximum valid psF32 value */ -#define PS_MAX_F64 DBL_MAX /**< maximum valid psF64 value */ -#define PS_MAX_C32 FLT_MAX /**< maximum valid real or imaginary psC32 value */ -#define PS_MAX_C64 DBL_MAX /**< maximum valid real or imaginary psC32 value */ - -#define PS_TYPE_BOOL_NAME "psBool" -#define PS_TYPE_S8_NAME "psS8" -#define PS_TYPE_S16_NAME "psS16" -#define PS_TYPE_S32_NAME "psS32" -#define PS_TYPE_S64_NAME "psS64" -#define PS_TYPE_U8_NAME "psU8" -#define PS_TYPE_U16_NAME "psU16" -#define PS_TYPE_U32_NAME "psU32" -#define PS_TYPE_U64_NAME "psU64" -#define PS_TYPE_F32_NAME "psF32" -#define PS_TYPE_F64_NAME "psF64" -#define PS_TYPE_C32_NAME "psC32" -#define PS_TYPE_C64_NAME "psC64" - -#define PS_TYPE_NAME(value,type) \ -switch(type) { \ -case PS_TYPE_BOOL: \ - value = PS_TYPE_BOOL_NAME; \ - break; \ -case PS_TYPE_S8: \ - value = PS_TYPE_S8_NAME; \ - break; \ -case PS_TYPE_S16: \ - value = PS_TYPE_S16_NAME; \ - break; \ -case PS_TYPE_S32: \ - value = PS_TYPE_S32_NAME; \ - break; \ -case PS_TYPE_S64: \ - value = PS_TYPE_S64_NAME; \ - break; \ -case PS_TYPE_U8: \ - value = PS_TYPE_U8_NAME; \ - break; \ -case PS_TYPE_U16: \ - value = PS_TYPE_U16_NAME; \ - break; \ -case PS_TYPE_U32: \ - value = PS_TYPE_U32_NAME; \ - break; \ -case PS_TYPE_U64: \ - value = PS_TYPE_U64_NAME; \ - break; \ -case PS_TYPE_F32: \ - value = PS_TYPE_F32_NAME; \ - break; \ -case PS_TYPE_F64: \ - value = PS_TYPE_F64_NAME; \ - break; \ -case PS_TYPE_C32: \ - value = PS_TYPE_C32_NAME; \ - break; \ -case PS_TYPE_C64: \ - value = PS_TYPE_C64_NAME; \ - break; \ -default: \ - value = "unknown"; \ -}; - -/// Macro to get the bad pixel reason code (stored as part of mask value) -#define PS_BADPIXEL_BITMASK 0x0f -#define PS_GET_BADPIXEL(maskValue) (maskValue & PS_BADPIXEL_BITMASK) - -#define PS_IS_BADPIXEL(maskValue) (PS_GET_BADPIXEL(maskValue) != 0) - -/// Macro to apply a bad pixel reason code to mask image -#define PS_SET_BADPIXEL(maskValue, reasonCode) \ -{ \ - maskValue = (psMaskType)((reasonCode & PS_BADPIXEL_BITMASK) | (maskValue & ~PS_BADPIXEL_BITMASK)); \ -} - -/// Macro to determine if the psElemType is an integer. -#define PS_IS_PSELEMTYPE_INT(x) ((x & 0x100) == 0x100) -/// Macro to determine if the psElemType is unsigned. -#define PS_IS_PSELEMTYPE_UNSIGNED(x) ((x & 0x200) == 0x200) -/// Macro to determine if the psElemType is a real (non-complex) floating-point type. -#define PS_IS_PSELEMTYPE_REAL(x) ((x & 0x400) == 0x400) -/// Macro to determine if the psElemType is complex number type. -#define PS_IS_PSELEMTYPE_COMPLEX(x) ((x & 0x800) == 0x800) -/// Macro to determine if the psElemType is boolean type. -#define PS_IS_PSELEMTYPE_BOOL(x) ((x & 0x1000) == 0x1000) -/// Macro to determine the storage size, in bytes, of the psElemType. -#define PSELEMTYPE_SIZEOF(x) (x & 0xFF) - -/** Dimensions of a data type. - * - * The dimensions of containers used by psLib are defined within this enum. This enum is used by the psType -struct. * - */ -typedef enum { - PS_DIMEN_SCALAR, ///< Scalar. - PS_DIMEN_VECTOR, ///< Vector. - PS_DIMEN_TRANSV, ///< Transposed vector. - PS_DIMEN_IMAGE, ///< Image. - PS_DIMEN_OTHER ///< Something else that's not supported for arithmetic. -} psDimen; - -/** The type of a data type. - * - * All psLib complex types consist of primitive components. This struct provides the description of those - * primitives. - * - */ -typedef struct -{ - psElemType type; ///< Primitive type. - psDimen dimen; ///< Dimensionality. -} -psType; - -typedef struct -{ - psElemType type; ///< The type - psDimen dimen; ///< The dimensionality. - // psElemType type; ///< The type -} -psMathType; - -/** The type of a basic data type - * - * All psLib complex types consist of primitive components. This structure provides the ability to cast - * an unknown data structure to safely test the underlining data type. - * - */ -typedef struct -{ - psMathType type; ///< Data type information -} -psMath; - -/// @} - -#endif // #ifndef PS_TYPE_H Index: unk/psLib/src/sysUtils/sysUtils.i =================================================================== --- /trunk/psLib/src/sysUtils/sysUtils.i (revision 4545) +++ (revision ) @@ -1,49 +1,0 @@ -/* sysUtils */ -%include "psType.h" -%include "psAbort.h" -%include "psConfigure.h" -%include "psErrorCodes.h" -%include "psError.h" -%include "psLogMsg.h" -%include "psMemory.h" -%include "psString.h" -%include "psTrace.h" - -%inline %{ - -psErrorCode psError(psErrorCode code, psBool new, const char* msg) { - return p_psError("UNKNOWN",0,"SWIG",code,new,msg); -} - -psPtr psAlloc(size_t size) { - return p_psAlloc(size,"UNKNOWN",0); -} - -psPtr psRealloc(psPtr ptr, size_t size) { - return p_psRealloc(ptr,size,"UNKNOWN",0); -} - -void psFree(psPtr ptr) { - p_psFree(ptr,"UNKNOWN",0); -} - -psPtr psMemIncrRefCounter(psPtr vptr) { - return p_psMemIncrRefCounter(vptr,"UNKNOWN",0); -} - -psPtr psMemDecrRefCounter(psPtr vptr) { - return p_psMemDecrRefCounter(vptr,"UNKNOWN",0); -} - -void psTrace(const char* facil, psS32 myLevel, const char* msg) { - p_psTrace(facil, myLevel, msg); -} - -psS32 psMemCheckLeaksToStderr(psMemId id0, psMemBlock*** arr, psBool persistence) { - return psMemCheckLeaks(id0, arr, stderr, persistence); -} -psS32 psMemCheckLeaksToStdout(psMemId id0, psMemBlock*** arr, psBool persistence) { - return psMemCheckLeaks(id0, arr, stdout, persistence); -} - -%}