/*++++++++++++++
.IDENTIFICATION nomad1.h
.LANGUAGE       C
.AUTHOR         Francois Ochsenbein [CDS]
.ENVIRONMENT    NOMAD Catalogue
.KEYWORDS       CDS Catalogue Server
.VERSION  1.0   09-Nov-2005
.COMMENTS       Structures & Definitions concerning the NOMAD Catalog
---------------*/

#ifndef NOMAD1_DEF
#define NOMAD1_DEF	0
#ifndef _ARG
#ifdef __STDC__
#define _ARG(A)	A    /* ANSI */
#else
#define _ARG(A)	()  /* non-ANSI */
#define const
#endif
#endif

/* Verify 64-bit machine */
#ifndef int4
#define int4 int
#endif  /* int4 */

/*===========================================================================
		Structures 
 *===========================================================================*/

typedef struct {
    short zone, Uzone;		/* Zones: NOMAD, and USNO-B	*/
    int4 id, Uid ;		/* Identifications: NOMAD USNO  */
    int4 flags;			/* Flags as defined in readme   */
    int4 ra, sd ;		/* RA and S. Polar Dist. mas	*/
    short e_ra, e_sd;		/* sd Position RA/Dec, mas	*/
    int4 epra, epsd;		/* The 2 epochs, in 0.1yr	*/
    int4 pmra, pmsd;		/* Proper Motions in 0.1mas/yr	*/
    short e_pmra, e_pmsd;	/* sd Proper Motions 0.1mas/yr	*/
    short mag[6];		/* Magnitudes B V R J H K	*/
    unsigned char  abvr[4];	/* Refs. Astrometry B V R 	*/
    		/* 1..9 = USNO,2MASS,YB6,UCAC2,Tycho2,Hip,.,O,E */
    int4  UCAC2;		/* UCAC2 Identifier		*/
    short TYC1, TYC2, TYC3;	/* Identifiers			*/
    short TYCfar;		/* Flag r>0.3(1), 1"(2), 3"(3)	*/
    int4  HIP;			/* Hipparcos number 		*/
    int4  pmtot;		/* Total Proper Motion 0.1mas/y */
    int4 rho, theta ;		/* Distance from center (mas)	*/
    int4 xy[2] ;		/* Values of proj. x,y  (mas) 	*/
				/* ----------------------------	*/
} NOMADrec ;

static char NOMADmag[] = "BVRJHK";	/* Letters of mag array	*/

#define NULLxy	(-999999999)	/* Non-computed values for xy	*/

/* ---------------
Table 2:
--------
 hex code  number stars flag name and explanation
 ----------------------------------------------------------------------- */
#define NOMAD_UBBIT    0x00001  /* Fails Blaise's test for USNO-B1.0 star */
#define NOMAD_TMBIT    0x00002  /* Fails Roc's test for clean 2MASS star  */
/*efine NOMAD_YBBIT    0x00004  -- (unused) */
#define NOMAD_YB6      0x00004	/* YB6 sequential number not reported     */
/*efine NOMAD_UCBIT    0x00008  -- (unused) */
#define NOMAD_2MASS    0x00008	/* 2MASS sequential number not reported   */
#define NOMAD_TYBIT    0x00010  /* Astrometry comes from Tycho2 catalog   */
#define NOMAD_XRBIT    0x00020  /* Alt correlations for same (RA,Dec)     */
#define NOMAD_ITMBIT   0x00040  /* Alt correlations for same 2MASS ID     */
#define NOMAD_IUCBIT   0x00080  /* Alt correlations for same UCAC-2 ID    */
#define NOMAD_ITYBIT   0x00100  /* Alt correlations for same Tycho2 ID    */
#define NOMAD_OMAGBIT  0x00200  /* Blue magnitude from O (not J) plate    */
#define NOMAD_EMAGBIT  0x00400  /* Red magnitude from E (not F) plate     */
#define NOMAD_TMONLY   0x00800  /* Object found only in 2MASS catalog     */
#define NOMAD_HIPAST   0x01000  /* Ast from Hipparcos (not Tycho2) catal  */
#define NOMAD_SPIKE    0x02000  /* USNO-B1.0 diffraction spike bit set    */
#define NOMAD_TYCONF   0x04000  /* Tycho2 confusion flag                  */
#define NOMAD_BSCONF   0x08000  /* Bright star has nearby faint source    */
#define NOMAD_BSART    0x10000  /* Faint source is bright star artifact   */
#define NOMAD_USEME    0x20000  /* Recommended astrometric standard       */
/* ---- NOMAD_EXCAT    0x40000  -- External, non-astrometric object       */

/* Counts of bits set: */
/*      NOMAD_BSART   0x10000  =    161579  */
/*      NOMAD_USEME   0x20000  =  16117123  */
/*      NOMAD_EXCAT   0x40000  =         0  */
/*      NOMAD_UBBIT   0x00001  = 469314198  */
/*      NOMAD_TMBIT   0x00002  = 123508070  */
/*      NOMAD_YBBIT   0x00004  =         0  */
/*      NOMAD_UCBIT   0x00008  =         0  */
/*      NOMAD_TYBIT   0x00010  =    484333  */
/*      NOMAD_XRBIT   0x00020  =      2289  */
/*      NOMAD_ITMBIT  0x00040  =         0  */
/*      NOMAD_IUCBIT  0x00080  =        19  */
/*      NOMAD_ITYBIT  0x00100  =        45  */
/*      NOMAD_OMAGBIT 0x00200  =  45066488  */
/*      NOMAD_EMAGBIT 0x00400  =  87873547  */
/*      NOMAD_TMONLY  0x00800  =  61787163  */
/*      NOMAD_HIPAST  0x01000  =    120242  */
/*      NOMAD_SPIKE   0x02000  =  18031305  */
/*      NOMAD_TYCONF  0x04000  =      4468  */
/*      NOMAD_BSCONF  0x08000  =   1076296  */
/*      NOMAD_BSART   0x10000  =    161579  */
/*      NOMAD_USEME   0x20000  =  16117123  */
/*      NOMAD_EXCAT   0x40000  =         0  */

/*===========================================================================
		Prototypes Declarations
 *===========================================================================*/
 
int   nomad1_init   _ARG((char *NOMAD1root)) ;
char *nomad2a       _ARG((NOMADrec *pr, int opt)) ;
		/* Option: 1 in sexa, 2=ID, 4=Epoch */
char *nomad_head   _ARG((int opt)) ;
int4  nomad_seek   _ARG((int4 ra, int4 sd)) ; 	/* Position in mas */
int4  nomad_search _ARG((int4 ra[2], int4 sd[2], int (*digest_routine)())) ;
int   nomad_set    _ARG((int zone, int4 id)) ;
int   nomad_get    _ARG((int zone, int4 id, NOMADrec *rec)) ;
int   nomad_read   _ARG((NOMADrec *rec)) ;
int   nomad_stop   _ARG((int flag));
int   nomad_zopen  _ARG((int zone));
int   nomad_close  _ARG((void));
#endif