NRWaveInject.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006 S.Fairhurst, B. Krishnan, L.Santamaria
 *
 *  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
 */


/** \defgroup NRWaveInject
 * \ingroup inject 
 * \author S.Fairhurst, B. Krishnan, L.Santamaria
 * 
 * \brief Module for generating h(t) from Numrel waveforms
 *

 *
 */
 
/** \file NRWaveInject.h
 *  \ingroup NRWaveInject  
 * \date $Date: 2008/08/18 01:52:30 $
 *
 * 
 */

#ifndef _NRWAVEINJECT_H
#define _NRWAVEINJECT_H

/* includes */
#include <stdlib.h>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <lal/LALStdlib.h>
#include <lal/LALConstants.h>
#include <lal/AVFactories.h>
#include <lal/SeqFactories.h>
#include <lal/LIGOMetadataTables.h>
#include <lal/NRWaveIO.h>
#include <lal/TimeDelay.h>
#include <lal/DetResponse.h>

#ifdef  __cplusplus   /* C++ protection. */
extern "C" {
#endif

NRCSID( NRWAVEINJECTH, "$Id: NRWaveInject.h,v 1.31 2008/08/18 01:52:30 badri Exp $");


#define NRWAVEINJECT_ENULL        1
#define NRWAVEINJECT_EFILE        2
#define NRWAVEINJECT_ENONULL  3
#define NRWAVEINJECT_ENOMEM   4
#define NRWAVEINJECT_EVAL         5
#define NRWAVEINJECT_EFORMAT  6

#define NRWAVEINJECT_MSGENULL   "Null pointer"
#define NRWAVEINJECT_MSGEFILE   "Error in file-IO"
#define NRWAVEINJECT_MSGENONULL "Not a Null pointer"
#define NRWAVEINJECT_MSGENOMEM  "Memory ellocation error"
#define NRWAVEINJECT_MSGEVAL    "Invalid value"
#define NRWAVEINJECT_MSGEFORMAT "Meta data file format incorrect"


#define NINJA_MIN_MODE 2
#define NINJA_MAX_MODE 5

/* enum for list of numrel groups */
typedef enum{
  NINJA_GROUP_AEI = 0,
  NINJA_GROUP_CIT,  
  NINJA_GROUP_LSU,
  NINJA_GROUP_JENA,
  NINJA_GROUP_RIT,
  NINJA_GROUP_CORNELL,
  NINJA_GROUP_PSU,
  NINJA_GROUP_FAU,
  NINJA_GROUP_UTB,  
  NINJA_GROUP_UIUC,
  NINJA_GROUP_PRINCETON,
  NINJA_GROUP_LAST
} NumRelGroup;


REAL4TimeVectorSeries *
XLALSumStrain( 
    REAL4TimeVectorSeries *tempstrain,  
    REAL4TimeVectorSeries *strain);

REAL8TimeVectorSeries *
XLALSumStrainREAL8( 
    REAL8TimeVectorSeries *tempstrain,
    REAL8TimeVectorSeries *strain);

/* REAL4TimeVectorSeries * */
INT4
XLALOrientNRWave( 
    REAL4TimeVectorSeries *strain,
    UINT4                  modeL,
    INT4                   modeM,
    REAL4                  inclination,
    REAL4                  coa_phase);

REAL8TimeVectorSeries *
XLALOrientNRWaveREAL8( 
    REAL8TimeVectorSeries *strain,     
    UINT4                  modeL,      
    INT4                   modeM,      
    REAL4                  inclination,
    REAL4                  coa_phase);

REAL4TimeSeries *
XLALCalculateNRStrain( 
    REAL4TimeVectorSeries *strain, 
    SimInspiralTable      *thisInj,
    CHAR                  *ifo,
    INT4                   sampleRate);

REAL4TimeSeries *
XLALInterpolateNRWave( REAL4TimeSeries *in,
                       INT4      sampleRate);

INT4 
XLALFindNRFile( NRWaveMetaData *out,
                NRWaveCatalog *nrCatalog,
                const SimInspiralTable  *inj,
                INT4  modeL, 
                INT4  modeM);

REAL4TimeVectorSeries *
XLALSumStrain( 
    REAL4TimeVectorSeries *tempstrain,     /**< storing variable */ 
    REAL4TimeVectorSeries *strain          /**< variable to add  */);

void LALInjectStrainGW( LALStatus *status, 
                        REAL4TimeSeries *injData, 
                        REAL4TimeVectorSeries *strain, 
                        SimInspiralTable *thisInj, 
                        CHAR *ifo, 
                        REAL8 dynRange);

void LALInjectStrainGWREAL8( LALStatus                 *status,
                             REAL8TimeSeries           *injData,
                             REAL8TimeVectorSeries     *strain,
                             SimInspiralTable          *thisInj,
                             CHAR                      *ifo,
                             REAL8                     dynRange);


INT4
XLALFindNRCoalescenceTime(REAL8 *tc, 
                          const REAL4TimeVectorSeries *in);

INT4
XLALFindNRCoalescenceTimeFromhoft(REAL8 *tc, 
                                  const REAL4TimeSeries *in);


/** Spin weighted Spherical Harmonic  */
INT4 
XLALSphHarm ( COMPLEX16 *out, /**< [out] the value of Y2_lm(theta,phi) */
              UINT4   L,  /**< the aziuhtal quantum number */
              INT4    M,  /**< the M value */
              REAL4   theta, /**< position - azimuthal angle */
              REAL4   phi ); /**< position - polar angle */
  
/** channel name for nr data in frame file */
CHAR* XLALGetNinjaChannelName(CHAR *polarisation, /**< either plus or cross */
                              UINT4 l, /**< azimuthal mode index */
                              INT4 m );/**< polar mode index */

NumRelGroup XLALParseNumRelGroupName( CHAR *name);

#ifdef  __cplusplus
}                /* Close C++ protection */
#endif

#endif           /* Close double-include protection _NRWAVEINJECT_H */

---