Playground.c

Go to the documentation of this file.

/*
*  Copyright (C) 2007 Duncan Brown, Jolien Creighton, Stephen Fairhurst
*
*  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
*/

/*----------------------------------------------------------------------- 
 * 
 * File Name: Playground.c
 *
 * Author: Brown, D. A.
 * 
 * Revision: $Id: Playground.c,v 1.7 2008/04/29 20:22:00 kipp Exp $
 * 
 *-----------------------------------------------------------------------
 */

#if 0
<lalVerbatim file="PlaygroundCV">
Author: Brown D. A.
$Id: Playground.c,v 1.7 2008/04/29 20:22:00 kipp Exp $
</lalVerbatim>

<lalLaTeX>
\subsection{Module \texttt{Playground.c}}
\label{ss:Playground.c}

Determines if a given time (or segment) is playground data.

\subsection*{Prototypes}
\vspace{0.1in}
\input{PlaygroundCP}
\idx{LALINT8NanoSecIsPlayground()}
\idx{XLALINT8NanoSecIsPlayground()}
\idx{LALGPSIsPlayground()}

\subsubsection*{Description}

This module contains two routines to determine if a given time is in the data 
designated as playground or not. The first routines takes input as
\texttt{INT8} nanoseconds and the second as a \texttt{LIGOTimeGPS} structure.
The third routine decides if some or all of a given time interval is
playground or not.

\subsubsection*{Algorithm}

The playground algorithm is given in LIGO techincal document T030020-01.
Briefly, $t$ is playground if 
\begin{equation}
t - 729273613 \% 6370 < 600.
\end{equation}

\subsubsection*{Uses}

\subsubsection*{Notes}

\vfill{\footnotesize\input{PlaygroundCV}}
</lalLaTeX>
#endif

#include <lal/LALStdlib.h>
#include <lal/Date.h>
#include <lal/XLALError.h>

NRCSID( PLAYGROUNDC, "$Id: Playground.c,v 1.7 2008/04/29 20:22:00 kipp Exp $" );

/* <lalVerbatim file="PlaygroundCP"> */
int
XLALINT8NanoSecIsPlayground (
    const INT8         *ns
    )
/* </lalVerbatim> */
{
  const INT8 start = 729273613 * LAL_INT8_C(1000000000);
  const INT8 interval = 6370 * LAL_INT8_C(1000000000);
  const INT8 length = 600 * LAL_INT8_C(1000000000);
  int playground;

  if ( (*ns - start) % interval < length )
  {
    playground = 1;
  }
  else
  {
    playground = 0;
  }

  return( playground );
}


/* <lalVerbatim file="PlaygroundCP"> */
void
LALINT8NanoSecIsPlayground (
    LALStatus          *status,
    INT4               *playground,
    INT8               *ns
    )
/* </lalVerbatim> */
{
  INITSTATUS( status, "LALINT8NanoSecIsPlayground", PLAYGROUNDC );

  XLALPrintDeprecationWarning("LALINT8NanoSecIsPlayground", "XLALINT8NanoSecIsPlayground");
  *playground = XLALINT8NanoSecIsPlayground ( ns );
  
  RETURN( status );
}

/* <lalVerbatim file="PlaygroundCP"> */
void
LALGPSIsPlayground (
    LALStatus          *status,
    INT4               *playground,
    LIGOTimeGPS        *gpstime
    )
/* </lalVerbatim> */
{
  INT8  ns;

  INITSTATUS( status, "LALINT8NanoSecIsPlayground", PLAYGROUNDC );
  ATTATCHSTATUSPTR( status );

  ns = XLALGPSToINT8NS(gpstime);
  *playground = XLALINT8NanoSecIsPlayground(&ns);

  DETATCHSTATUSPTR( status );
  RETURN( status );
}

---