SetupData.h

Go to the documentation of this file.

//
// Copyright (C) 2016, 2017 Karl Wette
//
// 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 _SETUP_DATA_H
#define _SETUP_DATA_H
 
///
/// \file
/// \ingroup lalpulsar_bin_Weave
/// \brief Module which handles the setup data
///
 
#include "Weave.h"
 
#include <lal/LALBarycenter.h>
#include <lal/Segments.h>
#include <lal/SuperskyMetrics.h>
#include <lal/UserInput.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
///
/// User input choices for for search type
///
extern const UserChoices WeaveMetricTypeChoices;
 
///
/// Setup data which is computed only once for a given search setup
///
struct tagWeaveSetupData {
  /// Reference time at which search is conducted
  LIGOTimeGPS ref_time;
  /// List of detector names for which metrics were computed
  LALStringVector *detectors;
  /// Segment list for which metrics were computed
  LALSegList *segments;
  /// Reduced supersky parameter-space metrics
  SuperskyMetrics *metrics;
  /// Ephemeris data over time-span of segments
  EphemerisData *ephemerides;
  /// Metric type (all-sky or directed)
  CHAR *metric_type;
};
 
void XLALWeaveSetupDataClear(
  WeaveSetupData *setup
);
int XLALWeaveSetupDataWrite(
  FITSFile *file,
  const WeaveSetupData *setup
);
int XLALWeaveSetupDataRead(
  FITSFile *file,
  WeaveSetupData *setup
);
 
#ifdef __cplusplus
}
#endif
 
#endif // _SETUP_DATA_H
 
// Local Variables:
// c-file-style: "linux"
// c-basic-offset: 2
// End: