FFUtils.h

Go to the documentation of this file.

/*
*  Copyright (C) 2007 Stas Babak, Bernd Machenschalk
*
*  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., 59 Temple Place, Suite 330, Boston,
*  MA  02111-1307  USA
*/

#include <stdio.h>

#include <lal/LALInspiral.h>
#include <lal/LALInspiralBank.h>
#include <lal/RealFFT.h>
#include <lal/AVFactories.h>
#include <lal/SeqFactories.h>

#include <lal/LALConfig.h>
#include <lal/LALStdio.h>
#include <lal/LALStdlib.h>
#include <lal/LALError.h>
#include <lal/LALDatatypes.h>
#include <lal/AVFactories.h>
#include <lal/Window.h>
#include <lal/TimeFreqFFT.h>
#include <lal/IIRFilter.h>
#include <lal/Date.h>
#include <lal/LIGOMetadataTables.h>

NRCSID (FFUTILSH,"$Id: FFUtils.h,v 1.3 2007/06/08 14:41:50 bema Exp $");




#define CVS_ID_STRING      "$Id: FFUtils.h,v 1.3 2007/06/08 14:41:50 bema Exp $"
#define CVS_NAME_STRING    "$Name:  $"
#define CVS_REVISION       "$Revision: 1.3 $"
#define CVS_SOURCE         "$Source: /usr/local/cvs/lscsoft/lal/packages/noisemodels/include/FFUtils.h,v $"
#define CVS_DATE           "$Date: 2007/06/08 14:41:50 $"
#define PROGRAM_NAME       "FFUtils"




/*  !!!!!  Structures to define   !!!!  */

 

RandomSignalIn




/*    !!!!      functions to define    !!!!  */ 

/* this function should compute the max length of template in the bank 
  and padd this size to the nearest power of 2 */
GetMaximumTemplateSize(&status, &bankIn , &checkLength); 

/* should compute the expected sensitivity (psd) using f-ns in the noise models */
GetNoisePSD(&status, bankIn.shf, ifo, df);

/* computes fourier trandform of the signal and template */
CreateFSignal(&status, &fwdp, signal, &fSignal);
CreateFTemplate(&status, &fwdp, bankCurrent, &fTemplate);

/** this function suppose to compute overlap */
ComputeOverlap(&status, &revp, &fSignal, &fTemplate, bankIn.shf, &match);


/**** !!!!!!!! The rest has to be modified. ********/


/* --- Some Error messages --- */
#define BANKEFFICIENCYNEW_ENORM  0
#define BANKEFFICIENCYNEW_ESUB   1
#define BANKEFFICIENCYNEW_EARG   2
#define BANKEFFICIENCYNEW_EVAL   3
#define BANKEFFICIENCYNEW_EFILE  4
#define BANKEFFICIENCYNEW_EINPUT 5
#define BANKEFFICIENCYNEW_EMEM   6

#define BANKEFFICIENCYNEW_MSGENORM  "Normal exit"
#define BANKEFFICIENCYNEW_MSGESUB   "Subroutine failed"
#define BANKEFFICIENCYNEW_MSGEARG   "Error parsing arguments"
#define BANKEFFICIENCYNEW_MSGEVAL   "Input argument out of valid range"
#define BANKEFFICIENCYNEW_MSGEFILE  "Could not open file"
#define BANKEFFICIENCYNEW_MSGEINPUT "Error reading file"
#define BANKEFFICIENCYNEW_MSGEMEM   "Out of memory"
#define BANKEFFICIENCYNEW_MSGPARSER "Missing arguments ??  "

---