LUT.h File Reference

#include <stdlib.h>
#include <math.h>
#include <stdio.h>
#include <string.h>
#include <lal/LALStdlib.h>
#include <lal/LALConstants.h>
#include <lal/AVFactories.h>
#include <lal/SeqFactories.h>

Include dependency graph for LUT.h:

Go to the source code of this file.

Data Structures

struct  tagHOUGHBorder
 This structure stores the border of a circle clipped on the projected plane. More...
struct  tagHOUGHBin2Border
 This structure stores the border indexes corresponding to one frequency bin plus the corrections to be added to the first column of the patch. More...
struct  tagHOUGHptfLUT
 Patch-Time-Frequency Look Up table. More...
struct  tagHOUGHPatchGrid
 Patch-Frequency Grid information. More...
struct  tagHOUGHResolutionPar
 parameters needed for gridding the patch More...
struct  tagHOUGHSizePar
 required for constructing patch More...
struct  tagREAL8Cart3Coor
 cartesian coordinates on a plane More...
struct  tagREAL8Cart2Coor
 cartesian coordinates on a plane More...
struct  tagREAL8Polar2Coor
 polar coordinates on a plane More...
struct  tagREAL8UnitPolarCoor
 right ascension and declination More...
struct  tagHOUGHParamPLUT
 Parameters required for constructing LUT. More...
struct  tagHOUGHDemodPar
 Demodulation parameters needed for the Hough transform (all in same coordinate system. More...

Defines

#define LUTH_ENULL   1
#define LUTH_ESIZE   2
#define LUTH_ESZMM   4
#define LUTH_EINT   6
#define LUTH_ESAME   8
#define LUTH_EFREQ   10
#define LUTH_EVAL   12
#define LUTH_MSGENULL   "Null pointer"
#define LUTH_MSGESIZE   "Invalid input size"
#define LUTH_MSGESZMM   "Size mismatch"
#define LUTH_MSGEINT   "Invalid interval"
#define LUTH_MSGESAME   "Input/Output data vectors are the same"
#define LUTH_MSGEFREQ   "Invalid frequency"
#define LUTH_MSGEVAL   "Invalid value"
#define MAX(A, B)   (((A) < (B)) ? (B) : (A))
#define MIN(A, B)   (((A) < (B)) ? (A) : (B))
#define cot(A)   (1./tan(A))
#define LINERR   0.001
 Maximum ``error'' (as a fraction of the width of the thinnest annulus) which allows to represent a circle by a line.
#define PIXERR   0.5
 Maximum ``error'' (as a fraction of the width of the thinnest annulus) which allows to consider two border equivalents! It is relevant for determining the LUT frequency range validity.
#define VEPI   LAL_TWOPI * LAL_REARTH_SI / ( LAL_DAYSID_SI * LAL_C_SI )
 Earth v_epicycle/c TO BE CHANGED DEPENDING ON DETECTOR.
#define VTOT   LAL_TWOPI * LAL_AU_SI / ( LAL_YRSID_SI * LAL_C_SI )
 Total detector velocity/c TO BE CHANGED DEPENDING ON DETECTOR.

Typedefs

typedef INT2 COORType
typedef tagHOUGHBorder HOUGHBorder
 This structure stores the border of a circle clipped on the projected plane.
typedef tagHOUGHBin2Border HOUGHBin2Border
 This structure stores the border indexes corresponding to one frequency bin plus the corrections to be added to the first column of the patch.
typedef tagHOUGHptfLUT HOUGHptfLUT
 Patch-Time-Frequency Look Up table.
typedef tagHOUGHPatchGrid HOUGHPatchGrid
 Patch-Frequency Grid information.
typedef tagHOUGHResolutionPar HOUGHResolutionPar
 parameters needed for gridding the patch
typedef tagHOUGHSizePar HOUGHSizePar
 required for constructing patch
typedef tagREAL8Cart3Coor REAL8Cart3Coor
 cartesian coordinates on a plane
typedef tagREAL8Cart2Coor REAL8Cart2Coor
 cartesian coordinates on a plane
typedef tagREAL8Polar2Coor REAL8Polar2Coor
 polar coordinates on a plane
typedef tagREAL8UnitPolarCoor REAL8UnitPolarCoor
 right ascension and declination
typedef tagHOUGHParamPLUT HOUGHParamPLUT
 Parameters required for constructing LUT.
typedef tagHOUGHDemodPar HOUGHDemodPar
 Demodulation parameters needed for the Hough transform (all in same coordinate system.

Functions

 NRCSID (LUTH,"$Id: LUT.h,v 1.11 2007/02/26 13:16:26 badri Exp $")
void LALHOUGHComputeSizePar (LALStatus *status, HOUGHSizePar *out, HOUGHResolutionPar *in)
void LALHOUGHComputeNDSizePar (LALStatus *status, HOUGHSizePar *out, HOUGHResolutionPar *in)
void LALHOUGHFillPatchGrid (LALStatus *status, HOUGHPatchGrid *out, HOUGHSizePar *par)
void LALHOUGHParamPLUT (LALStatus *status, HOUGHParamPLUT *out, HOUGHSizePar *sizePar, HOUGHDemodPar *par)
void LALNDHOUGHParamPLUT (LALStatus *status, HOUGHParamPLUT *out, HOUGHSizePar *sizePar, HOUGHDemodPar *par)
void LALRotatePolarU (LALStatus *status, REAL8UnitPolarCoor *out, REAL8UnitPolarCoor *in, REAL8UnitPolarCoor *par)
void LALInvRotatePolarU (LALStatus *status, REAL8UnitPolarCoor *out, REAL8UnitPolarCoor *in, REAL8UnitPolarCoor *par)
void LALStereoProjectPolar (LALStatus *status, REAL8Polar2Coor *out, REAL8UnitPolarCoor *in)
void LALStereoProjectCart (LALStatus *status, REAL8Cart2Coor *out, REAL8UnitPolarCoor *in)
void LALStereoInvProjectPolar (LALStatus *status, REAL8UnitPolarCoor *out, REAL8Polar2Coor *in)
void LALStereoInvProjectCart (LALStatus *status, REAL8UnitPolarCoor *out, REAL8Cart2Coor *in)
void LALHOUGHConstructPLUT (LALStatus *status, HOUGHptfLUT *lut, HOUGHPatchGrid *patch, HOUGHParamPLUT *par)


Detailed Description

Definition in file LUT.h.


Define Documentation

#define LUTH_ENULL   1

Definition at line 612 of file LUT.h.

#define LUTH_ESIZE   2

Definition at line 613 of file LUT.h.

#define LUTH_ESZMM   4

Definition at line 614 of file LUT.h.

#define LUTH_EINT   6

Definition at line 615 of file LUT.h.

#define LUTH_ESAME   8

Definition at line 616 of file LUT.h.

#define LUTH_EFREQ   10

Definition at line 617 of file LUT.h.

#define LUTH_EVAL   12

Definition at line 618 of file LUT.h.

#define LUTH_MSGENULL   "Null pointer"

Definition at line 620 of file LUT.h.

#define LUTH_MSGESIZE   "Invalid input size"

Definition at line 621 of file LUT.h.

#define LUTH_MSGESZMM   "Size mismatch"

Definition at line 622 of file LUT.h.

#define LUTH_MSGEINT   "Invalid interval"

Definition at line 623 of file LUT.h.

#define LUTH_MSGESAME   "Input/Output data vectors are the same"

Definition at line 624 of file LUT.h.

#define LUTH_MSGEFREQ   "Invalid frequency"

Definition at line 625 of file LUT.h.

#define LUTH_MSGEVAL   "Invalid value"

Definition at line 626 of file LUT.h.

#define MAX ( A,
B   )     (((A) < (B)) ? (B) : (A))

Definition at line 637 of file LUT.h.

#define MIN ( A,
B   )     (((A) < (B)) ? (A) : (B))

Definition at line 638 of file LUT.h.

#define cot ( A   )     (1./tan(A))

Definition at line 639 of file LUT.h.

#define LINERR   0.001

Maximum ``error'' (as a fraction of the width of the thinnest annulus) which allows to represent a circle by a line.

Definition at line 649 of file LUT.h.

#define PIXERR   0.5

Maximum ``error'' (as a fraction of the width of the thinnest annulus) which allows to consider two border equivalents! It is relevant for determining the LUT frequency range validity.

Definition at line 654 of file LUT.h.

#define VEPI   LAL_TWOPI * LAL_REARTH_SI / ( LAL_DAYSID_SI * LAL_C_SI )

Earth v_epicycle/c TO BE CHANGED DEPENDING ON DETECTOR.

Definition at line 663 of file LUT.h.

#define VTOT   LAL_TWOPI * LAL_AU_SI / ( LAL_YRSID_SI * LAL_C_SI )

Total detector velocity/c TO BE CHANGED DEPENDING ON DETECTOR.

Definition at line 668 of file LUT.h.


Typedef Documentation

typedef INT2 COORType

Definition at line 675 of file LUT.h.

typedef struct tagHOUGHBorder HOUGHBorder

This structure stores the border of a circle clipped on the projected plane.

typedef struct tagHOUGHBin2Border HOUGHBin2Border

This structure stores the border indexes corresponding to one frequency bin plus the corrections to be added to the first column of the patch.

typedef struct tagHOUGHptfLUT HOUGHptfLUT

Patch-Time-Frequency Look Up table.

typedef struct tagHOUGHPatchGrid HOUGHPatchGrid

Patch-Frequency Grid information.

typedef struct tagHOUGHResolutionPar HOUGHResolutionPar

parameters needed for gridding the patch

typedef struct tagHOUGHSizePar HOUGHSizePar

required for constructing patch

typedef struct tagREAL8Cart3Coor REAL8Cart3Coor

cartesian coordinates on a plane

typedef struct tagREAL8Cart2Coor REAL8Cart2Coor

cartesian coordinates on a plane

typedef struct tagREAL8Polar2Coor REAL8Polar2Coor

polar coordinates on a plane

typedef struct tagREAL8UnitPolarCoor REAL8UnitPolarCoor

right ascension and declination

typedef struct tagHOUGHParamPLUT HOUGHParamPLUT

Parameters required for constructing LUT.

typedef struct tagHOUGHDemodPar HOUGHDemodPar

Demodulation parameters needed for the Hough transform (all in same coordinate system.


Function Documentation

NRCSID ( LUTH  ,
"$Id: LUT.  h,
v 1.11 2007/02/26 13:16:26 badri Exp $"   
)

void LALHOUGHComputeSizePar ( LALStatus status,
HOUGHSizePar out,
HOUGHResolutionPar in 
)

Definition at line 161 of file PatchGrid.c.

void LALHOUGHComputeNDSizePar ( LALStatus status,
HOUGHSizePar out,
HOUGHResolutionPar in 
)

Definition at line 273 of file PatchGrid.c.

void LALHOUGHFillPatchGrid ( LALStatus status,
HOUGHPatchGrid out,
HOUGHSizePar par 
)

Definition at line 401 of file PatchGrid.c.

void LALHOUGHParamPLUT ( LALStatus status,
HOUGHParamPLUT out,
HOUGHSizePar sizePar,
HOUGHDemodPar par 
)

Definition at line 141 of file ParamPLUT.c.

void LALNDHOUGHParamPLUT ( LALStatus status,
HOUGHParamPLUT out,
HOUGHSizePar sizePar,
HOUGHDemodPar par 
)

Definition at line 146 of file NDParamPLUT.c.

void LALRotatePolarU ( LALStatus status,
REAL8UnitPolarCoor out,
REAL8UnitPolarCoor in,
REAL8UnitPolarCoor par 
)

Definition at line 137 of file Stereographic.c.

void LALInvRotatePolarU ( LALStatus status,
REAL8UnitPolarCoor out,
REAL8UnitPolarCoor in,
REAL8UnitPolarCoor par 
)

Definition at line 217 of file Stereographic.c.

void LALStereoProjectPolar ( LALStatus status,
REAL8Polar2Coor out,
REAL8UnitPolarCoor in 
)

Definition at line 297 of file Stereographic.c.

void LALStereoProjectCart ( LALStatus status,
REAL8Cart2Coor out,
REAL8UnitPolarCoor in 
)

Definition at line 330 of file Stereographic.c.

void LALStereoInvProjectPolar ( LALStatus status,
REAL8UnitPolarCoor out,
REAL8Polar2Coor in 
)

Definition at line 365 of file Stereographic.c.

void LALStereoInvProjectCart ( LALStatus status,
REAL8UnitPolarCoor out,
REAL8Cart2Coor in 
)

Definition at line 397 of file Stereographic.c.

void LALHOUGHConstructPLUT ( LALStatus status,
HOUGHptfLUT lut,
HOUGHPatchGrid patch,
HOUGHParamPLUT par 
)

Definition at line 337 of file ConstructPLUT.c.


Generated on Mon Sep 8 03:08:04 2008 for LAL by  doxygen 1.5.2