TwoSpectTypes.h

Go to the documentation of this file.

/*
*  Copyright (C) 2010, 2011, 2014 Evan Goetz
*
*  This program is free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  This program is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with with program; see the file COPYING. If not, write to the
*  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
*  MA  02110-1301  USA
*/
 
#ifndef __TWOSPECTTYPES_H__
#define __TWOSPECTTYPES_H__
 
#include <lal/LALStdlib.h>
#include <lal/AVFactories.h>
#include <lal/DetectorStates.h>
#include <lal/PulsarDataTypes.h>
#include <lal/VectorMath.h>
 
#include <gsl/gsl_rng.h>
 
extern FILE *LOG;
 
typedef struct {
  BOOLEAN help;
  REAL8 Tobs;
  REAL8 Tsft;
  REAL8 SFToverlap;
  REAL8 t0;
  REAL8 fmin;
  REAL8 fspan;
  LALStringVector *IFO;
  LALStringVector *avesqrtSh;
  INT4 blksize;
  CHAR *outdirectory;
  CHAR *outfilename;
  CHAR *configCopy;
  CHAR *ULfilename;
  CHAR *candidatesFilename;
  CHAR *inputSFTs;
  CHAR *ephemEarth;
  CHAR *ephemSun;
  BOOLEAN gaussNoiseWithSFTgaps;
  CHAR *templatebankfile;
  REAL8 Pmin;
  REAL8 Pmax;
  REAL8 dfmin;
  REAL8 dfmax;
  CHAR *skyRegion;
  CHAR *skyRegionFile;
  REAL8 linPolAngle;
  INT4 harmonicNumToSearch;
  INT4 periodHarmToCheck;
  INT4 periodFracToCheck;
  BOOLEAN templateSearch;
  BOOLEAN templateSearchFixedDf;
  LALStringVector *templateSearchDf;
  REAL8 templateSearchP;
  REAL8 templateSearchAsini;
  REAL8 templateSearchAsiniSigma;
  REAL8 assumeNScosi;
  REAL8 assumeNSpsi;
  REAL8 assumeNSGWfreq;
  REAL8 assumeNSorbitP;
  REAL8 assumeNSasini;
  LIGOTimeGPS assumeNSorbitTp;
  LIGOTimeGPS assumeNSrefTime;
  INT4 cosiSignCoherent;
  INT4 ihsfactor;
  REAL8 ihsfar;
  REAL8 ihsfom;
  REAL8 ihsfomfar;
  INT4 keepOnlyTopNumIHS;
  REAL8 tmplfar;
  INT4 minTemplateLength;
  INT4 maxTemplateLength;
  REAL8 ULfmin;
  REAL8 ULfspan;
  REAL8 ULminimumDeltaf;
  REAL8 ULmaximumDeltaf;
  BOOLEAN allULvalsPerSkyLoc;
  BOOLEAN markBadSFTs;
  REAL8 lineDetection;
  INT4 FFTplanFlag;
  BOOLEAN fastchisqinv;
  INT4 vectorMath;
  BOOLEAN followUpOutsideULrange;
  LALStringVector *timestampsFile;
  LALStringVector *segmentFile;
  LALStringVector *injectionSources;
  REAL8 injFmin;
  REAL8 injBand;
  INT4 injRandSeed;
  BOOLEAN weightedIHS;
  BOOLEAN signalOnly;
  BOOLEAN templateTest;
  REAL8 templateTestF;
  REAL8 templateTestP;
  REAL8 templateTestDf;
  BOOLEAN bruteForceTemplateTest;
  INT4 ULsolver;
  REAL8 dopplerMultiplier;
  BOOLEAN IHSonly;
  BOOLEAN noNotchHarmonics;
  BOOLEAN calcRthreshold;
  BOOLEAN antennaOff;
  BOOLEAN noiseWeightOff;
  BOOLEAN gaussTemplatesOnly;
  BOOLEAN ULoff;
  BOOLEAN printSFTtimes;
  BOOLEAN printData;
  BOOLEAN BrentsMethod;
  CHAR *saveRvalues;
  CHAR *printSignalData;
  CHAR *printMarginalizedSignalData;
  INT4 randSeed;
  BOOLEAN chooseSeed;
} UserInput_t;
 
typedef struct {
  UINT4 length;
  REAL8 *data;
  REAL8 *data0;
} alignedREAL8Vector;
typedef struct {
  UINT4 length;
  alignedREAL8Vector **data;
} alignedREAL8VectorArray;
typedef struct {
  UINT4 length;
  REAL4VectorAligned **data;
} REAL4VectorAlignedArray;
typedef struct {
  UINT4 length;
  UINT4 vectorLength;
  REAL4 *data;
  REAL4 *data0;
} alignedREAL4VectorSequence;
 
typedef struct {
  REAL4VectorAligned *ffdata;    //Doubly Fourier transformed data
  REAL8 tfnormalization;
  REAL8 ffnormalization;
  INT4 numffts;
  INT4 numfbins;
  INT4 numfprbins;
} ffdataStruct;
 
typedef struct {
  REAL8 fsig; /* 0 value means candidate not valid */
  REAL8 period;
  REAL8 moddepth;
  REAL4 ra;
  REAL4 dec;
  REAL8 stat;
  REAL8 h0;
  REAL8 prob;
  INT4 proberrcode;
  REAL8 normalization;
  INT4 templateVectorIndex;
  BOOLEAN lineContamination;
} candidate;
 
typedef struct {
  candidate *data;
  UINT4 length;
  UINT4 numofcandidates;
} candidateVector;
 
typedef struct {
  REAL8 fminimum;
  REAL8 fmaximum;
  UINT4 numfsteps;
  UINT4 numperiodslonger;
  UINT4 numperiodsshorter;
  REAL4 periodSpacingFactor;
  REAL8 dfmin;
  REAL8 dfmax;
  UINT4 numdfsteps;
} TwoSpectParamSpaceSearchVals;
 
typedef struct {
  REAL4 alpha;
  REAL4 delta;
  REAL8Vector *fsig;
  REAL8Vector *period;
  REAL8Vector *moddepth;
  REAL8Vector *ULval;
  REAL8Vector *effSNRval;
  REAL8 normalization;
} UpperLimit;
 
typedef struct {
  UpperLimit *data;
  UINT4 length;
} UpperLimitVector;
 
typedef struct {
  REAL4VectorAligned *maxima;
  INT4Vector *locations;
  REAL4VectorAligned *foms;
  REAL4VectorAligned *maximaForEachFbin;
  INT4Vector *locationsForEachFbin;
  INT4 rows;
} ihsMaximaStruct;
 
typedef struct {
  REAL4 ihs;
  INT4 loc;
} ihsVals;
 
typedef struct {
  REAL4VectorAligned *ihsfar;
  REAL4VectorAligned *ihsdistMean;
  REAL4VectorAligned *ihsdistSigma;
  REAL4VectorAligned *fomfarthresh;
  REAL4VectorAligned *ihsfomdistMean;
  REAL4VectorAligned *ihsfomdistSigma;
  REAL4VectorAligned *expectedIHSVector;
} ihsfarStruct;
 
typedef struct {
  REAL4 far;
  REAL4 distMean;
  REAL4 distSigma;
  REAL4VectorAligned *topRvalues;
  INT4 farerrcode;
} farStruct;
 
typedef struct {
  REAL4VectorAligned *templatedata;       //weights
  INT4Vector *pixellocations;      //pixel locations
  REAL8 f0;
  REAL8 period;
  REAL8 moddepth;
} TwoSpectTemplate;
 
typedef struct {
  TwoSpectTemplate **data;
  UINT4 length;
  REAL8 Tsft;
  REAL8 SFToverlap;
  REAL8 Tobs;
} TwoSpectTemplateVector;
 
#endif