VelocityTest.c

Go to the documentation of this file.

/*
*  Copyright (C) 2007 Badri Krishnan, Jolien Creighton, Alicia Sintes Olives
*
*  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: TestVelocity.c
 *
 * Authors: Krishnan, B., Sintes, A.M.,
 *
 *
 * History:   Created by Badri Krishnan May 24, 2003
 *
 *
 *-----------------------------------------------------------------------
 */
 
/*
 * 1.  An author and Id block
 */
 
/**
 * \author Krishnan, B., Sintes, A.M.
 * \file
 * \ingroup Velocity_h
 * \brief Tests the calculation of the averaged velocity of a given detector.
 *
 * ### Program TestVelocity.c ###
 *
 *
 * ### Usage ###
 *
 * \code
 * TestVelocity  [-d debuglevel] [-a accuracy]
 * \endcode
 *
 * ### Description ###
 *
 * This program computes the averaged velocity  of the GEO600 detector
 * between the times 730000044 and 730003644 with a default accuracy of 0.01.
 * The two ephemeris files (e.g., for data taken in 2003, <tt>sun03.dat</tt> and
 * <tt>earth03.dat</tt>) are assumed to be in the  directory
 * <tt>lal/packages/pulsar/test/</tt>.
 *
 * The <b>-d</b> option sets the debug level to the specified value
 * \c debuglevel.  The <b>-a</b> flag tells the program which accuracy to use.
 *
 * ### Uses ###
 *
 * \code
 * LALAvgDetectorVel()
 * LALPrintError()
 * LALMalloc()
 * LALFree()
 * LALCheckMemoryLeaks()
 * \endcode
 *
 */
 
/* #include "./Velocity.h" */
#include <lal/Velocity.h>
 
/* Error codes and messages */
 
/**\name Error Codes */ /** @{ */
#define TESTVELOCITYC_ENORM 0
#define TESTVELOCITYC_ESUB  1
#define TESTVELOCITYC_EARG  2
#define TESTVELOCITYC_EBAD  3
#define TESTVELOCITYC_EFILE 4
 
#define TESTVELOCITYC_MSGENORM "Normal exit"
#define TESTVELOCITYC_MSGESUB  "Subroutine failed"
#define TESTVELOCITYC_MSGEARG  "Error parsing arguments"
#define TESTVELOCITYC_MSGEBAD  "Bad argument values"
#define TESTVELOCITYC_MSGEFILE "Could not create output file"
/** @} */
 
/** \cond DONT_DOXYGEN */
 
/* Default parameters. */
 
 
/* #define T0SEC 714153733 */
#define T0SEC 730000044
#define T0NSEC 0
#define TBASE 3600.0
#define ACCURACY 0.01
 
/* Locations of the earth and sun ephemeris data */
 
#define EARTHDATAFILE TEST_PKG_DATA_DIR "earth00-40-DE405.dat.gz";
#define SUNDATAFILE   TEST_PKG_DATA_DIR "sun00-40-DE405.dat.gz";
 
char EARTHDATA[] = EARTHDATAFILE;
char SUNDATA[] = SUNDATAFILE;
 
/* Usage format string.  */
#define USAGE "Usage: %s [-d debuglevel] [-a accuracy]\n"
 
/*********************************************************************/
/* Macros for printing errors & testing subroutines (from Creighton) */
/*********************************************************************/
 
#define ERROR( code, msg, statement )                                \
do {                                                                 \
  if ( lalDebugLevel & LALERROR )                                    \
    XLALPrintError( "Error[0] %d: program %s, file %s, line %d, %s\n" \
                   "        %s %s\n", (code), *argv, __FILE__,       \
              __LINE__, "$Id$", statement ? statement :  \
                   "", (msg) );                                      \
} while (0)
 
#define INFO( statement )                                            \
do {                                                                 \
  if ( lalDebugLevel & LALINFO )                                     \
    XLALPrintError( "Info[0]: program %s, file %s, line %d, %s\n"     \
                   "        %s\n", *argv, __FILE__, __LINE__,        \
              "$Id$", (statement) );                     \
} while (0)
 
#define SUB( func, statusptr )                                       \
do {                                                                 \
  if ( (func), (statusptr)->statusCode ) {                           \
    ERROR( TESTVELOCITYC_ESUB, TESTVELOCITYC_MSGESUB,      \
           "Function call \"" #func "\" failed:" );                  \
    return TESTVELOCITYC_ESUB;                                  \
  }                                                                  \
} while (0)
/******************************************************************/
 
/* >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< */
/* vvvvvvvvvvvvvvvvvvvvvvvvvvvvvv------------------------------------ */
int main( int argc, char *argv[] )
{
 
  static LALStatus       status;
  static VelocityPar     velPar;
  static REAL8           vel[3];
  static REAL8           pos[3];
  static EphemerisData  *edat = NULL;
  LIGOTimeGPS   tGPS;
  INT4   arg;                         /* Argument counter */
  REAL8  vTol = 0.01 ;
  /* INT4   c, errflg=0;*/
  /*  LALoptarg = NULL; */
  /* ------------------------------------------------------- */
 
 
  /* default values */
  velPar.detector = lalCachedDetectors[LALDetectorIndexGEO600DIFF];
  velPar.startTime.gpsSeconds = T0SEC;
  velPar.startTime.gpsNanoSeconds = T0NSEC;
  velPar.tBase = TBASE;
  velPar.vTol = ACCURACY;
 
  /********************************************************/
  /* Parse argument list.  i stores the current position. */
  /********************************************************/
  arg = 1;
  while ( arg < argc ) {
    /* Parse debuglevel option. */
    if ( !strcmp( argv[arg], "-d" ) ) {
      if ( argc > arg + 1 ) {
        arg++;
      } else {
        ERROR( TESTVELOCITYC_EARG, TESTVELOCITYC_MSGEARG, 0 );
        XLALPrintError( USAGE, *argv );
        return TESTVELOCITYC_EARG;
      }
    }
    /* Parse accuracy option. */
    else if ( !strcmp( argv[arg], "-a" ) ) {
      if ( argc > arg + 1 ) {
        arg++;
        vTol = atof( argv[arg++] );
        velPar.vTol = vTol;
      } else {
        ERROR( TESTVELOCITYC_EARG, TESTVELOCITYC_MSGEARG, 0 );
        XLALPrintError( USAGE, *argv );
        return TESTVELOCITYC_EARG;
      }
    }
    /* Unrecognized option. */
    else {
      ERROR( TESTVELOCITYC_EARG, TESTVELOCITYC_MSGEARG, 0 );
      XLALPrintError( USAGE, *argv );
      return TESTVELOCITYC_EARG;
    }
  } /* End of argument parsing loop. */
  /******************************************************************/
 
  /* read in ephemeris data */
  XLAL_CHECK_MAIN( ( edat = XLALInitBarycenter( EARTHDATA, SUNDATA ) ) != NULL, XLAL_EFUNC );
 
  /* fill in ephemeris data in velPar */
  velPar.edat = edat;
 
 
  tGPS.gpsSeconds = T0SEC;
  tGPS.gpsNanoSeconds = T0NSEC;
 
 
  SUB( LALDetectorVel( &status,  vel,  &tGPS, velPar.detector, velPar.edat ), &status );
 
  printf( "Detector velocity at %d = %g, %g, %g \n", T0SEC, vel[0], vel[1], vel[2] );
 
  SUB( LALDetectorPos( &status,  vel,  &tGPS, velPar.detector, velPar.edat ), &status );
 
  printf( "Detector position at %d = %g, %g, %g \n", T0SEC, vel[0], vel[1], vel[2] );
 
  SUB( LALAvgDetectorVel( &status, vel, &velPar ), &status );
 
  printf( "Avg. detector velocity in a interval of %g from %d = %g, %g, %g \n", TBASE, T0SEC, vel[0], vel[1], vel[2] );
 
  SUB( LALAvgDetectorPos( &status, pos, &velPar ), &status );
 
  printf( "Avg. detector position in a interval of %g from %d = %g, %g, %g \n", TBASE, T0SEC, pos[0], pos[1], pos[2] );
 
  XLALDestroyEphemerisData( edat );
  LALCheckMemoryLeaks();
 
  //INFO(TESTVELOCITYC_MSGENORM);
  return TESTVELOCITYC_ENORM;
}
 
/* >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< */
 
/** \endcond */