GenerateBurst.h

Go to the documentation of this file.

/*
*  Copyright (C) 2007 Jolien Creighton, Patrick Brady, Saikat Ray-Majumder
*
*  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 _GENERATEBURST_H
#define _GENERATEBURST_H
 
 
/*
 * ============================================================================
 *
 *                                  Preamble
 *
 * ============================================================================
 */
 
 
#include <lal/LALDatatypes.h>
#include <lal/LIGOMetadataTables.h>
 
 
#if defined(__cplusplus)
extern "C" {
#elif 0
} /* so that editors will match preceding brace */
#endif
 
/**
 * \addtogroup lalburst_general
 * \brief UNDOCUMENTED
 */
/** @{ */
 
/*
 * ============================================================================
 *
 *                            Function Prototypes
 *
 * ============================================================================
 */
 
 
int XLALGenerateSimBurst(
        REAL8TimeSeries **hplus,
        REAL8TimeSeries **hcross,
        const SimBurst *sim_burst,
        double delta_t
);
 
 
int XLALBurstInjectSignals(
        REAL8TimeSeries *h,
        const SimBurst *sim_burst,
        const TimeSlide *time_slide_table_head,
        const COMPLEX16FrequencySeries *response
);
 
/** @} */
 
#if 0
{ /* so that editors will match succeeding brace */
#elif defined(__cplusplus)
}
#endif
 
 
#endif /* _GENERATEBURST_H */