LALInspiralAmplitude.c

Go to the documentation of this file.

/*
*  Copyright (C) 2007 Anand Sengupta, Thomas Cokelaer
*
*  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
*/

/*  <lalVerbatim file="LALInspiralAmplitudeCV">
Author: Cokelaer T.
$Id: LALInspiralAmplitude.c,v 1.5 2007/06/08 14:41:49 bema Exp $
</lalVerbatim>  */

/*  <lalLaTeX>

\subsection{Module \texttt{LALInspiralAmplitude.c}}
Given an inspiral template structure containing the binary distance 
and a set of mass parameters, that module provides functions to compute 
the related amplitude.

\subsubsection*{Prototypes}
\vspace{0.1in}
\input{LALInspiralRestrictedAmplitudeCP}
\idx{LALInspiralRestrictedAmplitude()}

\subsubsection*{Description}
The inspiral template structure can stored (1) the distance of the binary (2)
a set of binary masses such as the two masses or the total mass and eta and (3) 
an amplitude which is arbitrary fixed to unity when templates are computed. 

\noindent However we might need to have a template with the physical amplitude (for instance 
to deal with injections). The function \texttt{LALInspiralRestrictedAmplitude}
takes anInspiralTemplate structure as input/output to return the restricted 
Newtonian amplitude by using the following formula. 

\begin{equation}
A = \frac{4c}{d \eta} M^{-5./3.}
\end{equation}

\noindent where $d$ is in Mpc and $M$ in solar mass. The result is stored in the signalAmplitude
variable of the inspiral template structure.



\subsubsection*{Uses}
When appropriate this function calls:\\
\texttt{LALInspiralParameterCalc}

\subsubsection*{Notes}

\vfill{\footnotesize\input{LALInspiralAmplitudeCV}}
</lalLaTeX>  */



#include <lal/LALInspiral.h>


NRCSID (LALINSPIRALAMPLITUDEC, "$Id: LALInspiralAmplitude.c,v 1.5 2007/06/08 14:41:49 bema Exp $");

/*  <lalVerbatim file="LALInspiralRestrictedAmplitudeCP"> */
void 
LALInspiralRestrictedAmplitude (LALStatus        *status, 
                                InspiralTemplate *params )
{ /* </lalVerbatim> */
  
  
  INITSTATUS (status, "LALInspiralAmplitude", LALINSPIRALAMPLITUDEC );
  ATTATCHSTATUSPTR(status);
  
  ASSERT(params, status, LALINSPIRALH_ENULL, LALINSPIRALH_MSGENULL);
  ASSERT((INT4)params->massChoice >= 0, status, LALINSPIRALH_ESIZE, LALINSPIRALH_MSGESIZE);
  ASSERT((INT4)params->massChoice <= 14, status, LALINSPIRALH_ESIZE, LALINSPIRALH_MSGESIZE); 
  
  if (params->massChoice != totalMassAndEta) 
    {
      LALInspiralParameterCalc(status->statusPtr, params );
      CHECKSTATUSPTR(status);
    }
  

  params->signalAmplitude = 4. * params->totalMass  * params->eta   /  (LAL_PC_SI * 1e6 *params->distance / LAL_MRSUN_SI); 
    
  DETATCHSTATUSPTR(status);
  RETURN(status);
}

---