FindChirpSP.h

Go to the documentation of this file.

/*
*  Copyright (C) 2007 Darren Woods, Duncan Brown, Eirini Messaritaki, Gareth Jones, Jolien Creighton
*
*  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
*/
 
/*-----------------------------------------------------------------------
 *
 * File Name: FindChirpSP.h
 *
 * Author: Brown, D. A.
 *
 *-----------------------------------------------------------------------
 */
 
#ifndef _FINDCHIRPSPH_H
#define _FINDCHIRPSPH_H
 
#include <lal/LALDatatypes.h>
#include <lal/RealFFT.h>
#include <lal/LALInspiral.h>
#include <lal/FindChirp.h>
 
#if defined(__cplusplus)
extern "C" {
#elif 0
} /* so that editors will match preceding brace */
#endif
 
/**
 * \defgroup FindChirpSP_h Header FindChirpSP.h
 * \ingroup lalinspiral_findchirp
 * \author Brown, D. A.
 *
 * \brief Provides structures and functions to condition interferometer data
 * and generate binary inspiral chirps using the stationary phase approximation.
 *
 * ### Synopsis ###
 *
 * \code
 * #include <lal/FindChirpSP.h>
 * \endcode
 *
 */
/** @{ */
 
/**\name Error Codes */
/** @{ */
#define FINDCHIRPSPH_ENULL 1    /**< Null pointer */
#define FINDCHIRPSPH_ENNUL 2    /**< Non-null pointer */
#define FINDCHIRPSPH_EALOC 3    /**< Memory allocation error */
#define FINDCHIRPSPH_ENUMZ 4    /**< Invalid number of segments */
#define FINDCHIRPSPH_ESEGZ 5    /**< Invalid number of points in segments */
#define FINDCHIRPSPH_EMISM 6    /**< Mismatch between number of points in segments */
#define FINDCHIRPSPH_EDELT 7    /**< deltaT is zero or negative */
#define FINDCHIRPSPH_EFLOW 8    /**< Low frequency cutoff is negative */
#define FINDCHIRPSPH_EDYNR 9    /**< Dynamic range scaling is zero or negative */
#define FINDCHIRPSPH_EISTN 10   /**< Truncation of inverse power spectrum is negative */
#define FINDCHIRPSPH_EDIVZ 11   /**< Attempting to divide by zero */
#define FINDCHIRPSPH_EMAPX 12   /**< Mismatch in waveform approximant */
#define FINDCHIRPSPH_EUAPX 13   /**< Unknown approximant */
#define FINDCHIRPSPH_EORDR 14   /**< Invalid post-Newtonian order */
/** @} */
 
/** \cond DONT_DOXYGEN */
#define FINDCHIRPSPH_MSGENULL "Null pointer"
#define FINDCHIRPSPH_MSGENNUL "Non-null pointer"
#define FINDCHIRPSPH_MSGEALOC "Memory allocation error"
#define FINDCHIRPSPH_MSGENUMZ "Invalid number of segments"
#define FINDCHIRPSPH_MSGESEGZ "Invalid number of points in segments"
#define FINDCHIRPSPH_MSGEMISM "Mismatch between number of points in segments"
#define FINDCHIRPSPH_MSGEDELT "deltaT is zero or negative"
#define FINDCHIRPSPH_MSGEFLOW "Low frequency cutoff is negative"
#define FINDCHIRPSPH_MSGEDYNR "Dynamic range scaling is zero or negative"
#define FINDCHIRPSPH_MSGEISTN "Truncation of inverse power spectrum is negative"
#define FINDCHIRPSPH_MSGEDIVZ "Attempting to divide by zero"
#define FINDCHIRPSPH_MSGEMAPX "Mismatch in waveform approximant"
#define FINDCHIRPSPH_MSGEUAPX "Unknown approximant"
#define FINDCHIRPSPH_MSGEORDR "Invalid post-Newtonian order"
/** \endcond */
 
void
LALFindChirpSPTemplate (
    LALStatus                  *status,
    FindChirpTemplate          *fcTmplt,
    InspiralTemplate           *tmplt,
    FindChirpTmpltParams       *params
    );
 
/** @} */
 
#if 0
{ /* so that editors will match succeeding brace */
#elif defined(__cplusplus)
}
#endif
 
#endif /* _FINDCHIRPSPH_H */