CoincInspiralEllipsoid.h

Go to the documentation of this file.

/*
*  Copyright (C) 2007 Alexander Dietz, Drew Keppel, Craig Robinson
*
*  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
*/
#ifndef _COINCINSPIRALELLIPSOID_H
#define _COINCINSPIRALELLIPSOID_H
 
#ifdef  __cplusplus
extern "C" {
#endif
 
/*-----------------------------------------------------------------------
 *
 * File Name: CoincInspiralEllipsoid.h
 *
 * Author: Robinson, C. A.
 *
 *-----------------------------------------------------------------------
 */
 
/**
 * \defgroup CoincInspiralEllipsoid_h Header CoincInspiralEllipsoid.h
 * \ingroup lalinspiral_UNCLASSIFIED
 * \author Robinson, C. A.
 *
 * \brief Provides function definitions for performing inspiral coincidence analysis
 * using error ellipsoids.
 *
 * ### Synopsis ###
 *
 * \code
 * #include <lal/CoincInspiralEllipsoid.h>
 * \endcode
 *
 */
/** @{ */
 
#include    <lal/LALAtomicDatatypes.h>
#include    <lal/LIGOMetadataTables.h>
 
 
#include    <gsl/gsl_vector.h>
#include    <gsl/gsl_matrix.h>
 
 
/* Functions for generating the error matrix and position vectors for triggers */
gsl_matrix * XLALGetErrorMatrixFromSnglInspiral(
     SnglInspiralTable *event,
     REAL8              eMatch
     );
 
int XLALSetErrorMatrixFromSnglInspiral(gsl_matrix        *shape,
                                       SnglInspiralTable *event,
                                       REAL8              eMatch
                                       );
 
gsl_vector * XLALGetPositionFromSnglInspiral( SnglInspiralTable *table );
 
int XLALSetTimeInPositionVector( gsl_vector *position,
                                 REAL8       timeShift
                               );
 
/** @} */ /* end:CoincInspiralEllipsoid_h */
 
#ifdef  __cplusplus
}
#endif
 
#endif   /* _COINCINSPIRALELLIPSOID_H */