LALPulsar  6.1.0.1-fe68b98
SuperskyMetrics.h File Reference

Prototypes

SuperskyMetricsXLALComputeSuperskyMetrics (const SuperskyMetricType type, const size_t spindowns, const LIGOTimeGPS *ref_time, const LALSegList *segments, const double fiducial_freq, const MultiLALDetector *detectors, const MultiNoiseFloor *detector_weights, const DetectorMotionType detector_motion, const EphemerisData *ephemerides)
 Compute the supersky metrics, which are returned in a SuperskyMetrics struct. More...
 
SuperskyMetricsXLALCopySuperskyMetrics (const SuperskyMetrics *metrics)
 Copy a SuperskyMetrics struct. More...
 
void XLALDestroySuperskyMetrics (SuperskyMetrics *metrics)
 Destroy a SuperskyMetrics struct. More...
 
int XLALFITSWriteSuperskyMetrics (FITSFile *file, const SuperskyMetrics *metrics)
 Write a SuperskyMetrics struct to a FITS file. More...
 
int XLALFITSReadSuperskyMetrics (FITSFile *file, SuperskyMetrics **metrics)
 Read a SuperskyMetrics struct from a FITS file. More...
 
int XLALSuperskyMetricsDimensions (const SuperskyMetrics *metrics, size_t *spindowns)
 Return dimensions of the supersky metrics. More...
 
int XLALScaleSuperskyMetricsFiducialFreq (SuperskyMetrics *metrics, const double new_fiducial_freq)
 Scale all supersky metrics and their coordinate transform data to a new fiducial frequency. More...
 
int XLALEqualizeReducedSuperskyMetricsFreqSpacing (SuperskyMetrics *metrics, const double coh_max_mismatch, const double semi_max_mismatch)
 Project and rescale the reduced supersky metrics in the frequency dimension, such that all reduced supersky metrics have the same frequency spacing for the given maximum mismatches. More...
 
int XLALSetPhysicalPointSuperskyRefTime (PulsarDopplerParams *out_phys, const SuperskyTransformData *rssky_transf)
 Set the reference time of a physical point to that of the reduced supersky coordinates. More...
 
int XLALConvertPhysicalToSuperskyPoint (gsl_vector *out_rssky, const PulsarDopplerParams *in_phys, const SuperskyTransformData *rssky_transf)
 Convert a point from physical to supersky coordinates. More...
 
int XLALConvertSuperskyToPhysicalPoint (PulsarDopplerParams *out_phys, const gsl_vector *in_rssky, const gsl_vector *ref_rssky, const SuperskyTransformData *rssky_transf)
 Convert a point from supersky to physical coordinates. More...
 
int XLALConvertSuperskyToSuperskyPoint (gsl_vector *out_rssky, const SuperskyTransformData *out_rssky_transf, const gsl_vector *in_rssky, const gsl_vector *ref_rssky, const SuperskyTransformData *in_rssky_transf)
 Convert a point between supersky coordinates. More...
 
int XLALConvertPhysicalToSuperskyPoints (gsl_matrix **out_rssky, const gsl_matrix *in_phys, const SuperskyTransformData *rssky_transf)
 Convert a set of points from physical to supersky coordinates. More...
 
int XLALConvertSuperskyToPhysicalPoints (gsl_matrix **out_phys, const gsl_matrix *in_rssky, const SuperskyTransformData *rssky_transf)
 Convert a set of points from supersky to physical coordinates. More...
 
int XLALSetSuperskyPhysicalSkyBounds (LatticeTiling *tiling, gsl_matrix *rssky_metric, SuperskyTransformData *rssky_transf, const double alpha1, const double alpha2, const double delta1, const double delta2)
 Set parameter-space bounds on the physical sky position \( (\alpha, \delta) \) for a lattice tiling using the reduced supersky metric. More...
 
int XLALSetSuperskyEqualAreaSkyBounds (LatticeTiling *tiling, const gsl_matrix *rssky_metric, const double max_mismatch, const UINT4 patch_count, const UINT4 patch_index)
 Divide the reduced supersky parameter space into patch_count equal-area patches, and set parameter-space bounds on the reduced supersky coordinates \( (n_a,n_b) \) for the patch indexed by patch_index. More...
 
int XLALSetSuperskyPhysicalSpinBound (LatticeTiling *tiling, const SuperskyTransformData *rssky_transf, const size_t s, const double bound1, const double bound2)
 Set parameter-space bounds on the physical frequency/spindowns \( f^{(s)} \) for a lattice tiling using the reduced supersky metric. More...
 
int XLALSetSuperskyPhysicalSpinBoundPadding (LatticeTiling *tiling, const SuperskyTransformData *rssky_transf, const size_t s, const bool padding)
 Set parameter-space bound padding on the physical frequency/spindowns \( f^{(s)} \) for a lattice tiling using the reduced supersky metric. More...
 
int XLALRegisterSuperskyLatticePhysicalRangeCallback (LatticeTiling *tiling, const SuperskyTransformData *rssky_transf, const PulsarDopplerParams **min_phys, const PulsarDopplerParams **max_phys)
 Register a lattice tiling callback function which computes the physical range covered by a reduced supersky lattice tiling. More...
 
int XLALRegisterSuperskyLatticeSuperskyRangeCallback (LatticeTiling *tiling, const SuperskyTransformData *rssky_transf, const SuperskyTransformData *rssky2_transf, const gsl_vector **min_rssky2, const gsl_vector **max_rssky2)
 Register a lattice tiling callback function which computes the range covered by a reduced supersky lattice tiling in another set of reduced supersky coordinates. More...
 
int XLALSetSuperskyRangeBounds (LatticeTiling *tiling, const gsl_vector *min_rssky, const gsl_vector *max_rssky)
 Set parameter-space bounds on an entire lattice tiling given minimum and maximum ranges in reduced supersky coordinates. More...
 

Go to the source code of this file.

Data Structures

struct  SuperskyMetrics
 Computed supersky metrics, returned by XLALComputeSuperskyMetrics(). More...
 

Enumerations

enum  SuperskyMetricType { SUPERSKY_METRIC_TYPE , MAX_METRIC_TYPE }
 Type of supersky metric to compute. More...