Skymap.h

Go to the documentation of this file.

/*
 *
 * Copyright (C) 2008-9 Antony Searle
 *
 * 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
 
#ifndef SKYMAP_H
#define SKYMAP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <lal/LALDetectors.h>
 
/* Manipulate log-represented values without overflowing */
 
double XLALSkymapLogSumExp(double a, double b);
double XLALSkymapLogTotalExp(double* begin, double* end);
 
/* Lightweight coordinate transformations */
 
void XLALSkymapCartesianFromSpherical(double a[3], double b[2]);
void XLALSkymapSphericalFromCartesian(double a[2], double b[3]);
 
/* Cubic interpolation */
 
double XLALSkymapInterpolate(double t, double* x);
 
/* Largest network of interest (needed to allocate storage) */
 
#define XLALSKYMAP_N 5
 
/* Use detector names from LALDetectors.h : */
/*      LAL_TAMA_300_DETECTOR   =       0 */
/*      LAL_VIRGO_DETECTOR      =       1 */
/*      LAL_GEO_600_DETECTOR    =       2 */
/*      LAL_LHO_2K_DETECTOR     =       3 */
/*      LAL_LHO_4K_DETECTOR     =       4 */
/*      LAL_LLO_4K_DETECTOR     =       5 */
 
/* Struct to store basic properties of the analysis: the sample rate, and */
/* the detectors involved (described by their LAL ID numbers) */
 
typedef struct tagXLALSkymapPlanType
{
    int sampleFrequency;
    int n;
    LALDetector site[XLALSKYMAP_N];
} XLALSkymapPlanType;
 
void XLALSkymapPlanConstruct(
    int sampleFrequency,
    int n,
    int* detectors,
    XLALSkymapPlanType* plan
    );
 
/* Struct to store reuseable pre-computed quantities for a specific */
/* direction, set of detectors, and sample rate */
 
typedef struct tagXLALSkymapDirectionPropertiesType
{
    double f[XLALSKYMAP_N][2];
    double delay[XLALSKYMAP_N];
} XLALSkymapDirectionPropertiesType;
 
void XLALSkymapDirectionPropertiesConstruct(
    XLALSkymapPlanType* plan,
    double direction[2],
    XLALSkymapDirectionPropertiesType* properties
    );
 
/* Struct to store reuseable pre-computed kernel for a specific direction, */
/* power spectra, and sample rate */
 
typedef struct tagXLALSkymapKernelType
{
    double k[XLALSKYMAP_N][XLALSKYMAP_N];
    double logNormalization;
} XLALSkymapKernelType;
 
void XLALSkymapKernelConstruct(
    XLALSkymapPlanType* plan,
    XLALSkymapDirectionPropertiesType* properties,
    double* wSw,
    XLALSkymapKernelType* kernel
    );
 
void XLALSkymapUncertainKernelConstruct(
    XLALSkymapPlanType* plan,
    XLALSkymapDirectionPropertiesType* properties,
    double* wSw,
    double* error,
    XLALSkymapKernelType* kernel
    );
 
/* Compute the Bayesian marginalization integral for the specified system */
 
void XLALSkymapApply(
    XLALSkymapPlanType* plan,
    XLALSkymapDirectionPropertiesType* properties,
    XLALSkymapKernelType* kernel,
    double** xSw,
    double tau,
    double* logPosterior
    );
 
#ifdef __cplusplus
}
#endif
 
#endif /* SKYMAP_H */