IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Aug 19, 2005, 5:13:28 PM (21 years ago)
Author:
eugene
Message:

added dvo phottable conversion types

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/Ohana/src/libohana/doc/libohana.html

    r4810 r4832  
    11
    2 <h2> libohana API reference </h2>
     2<h1> libohana API reference </h1>
     3
     4<h2> generic ohana functions </h2>
     5
     6<h3> basic macros </h3>
     7
     8<pre>
     9TRUE
     10FALSE
     11SIGN(X) 
     12ROUND(X)
     13SQR(X)   
     14SQ(X)   
     15MIN(X,Y)
     16MAX(X,Y)
     17SWAP(X,Y)
     18whitespace (char c)
     19</pre>
    320
    421<h3> ohana memory management functions </h3>
    … …  
    6683<pre> int   fclearlockfile (char *filename, FILE *f, int type, int *state); </pre>
    6784
    68 <h3> read/write (Fread.c) </h3>
    69 
    70 <pre> int Fread (char ptr, int size, int nitems, FILE *f, char *type); </pre>
    71 <pre> int Fwrite (char ptr, int size, int nitems, FILE *f, char *type); </pre>
    72 <pre> int ByteSwap (char *ptr, int size, int nitems, char *type); </pre>
    73 <pre> int ConvertStruct (char *buffer, int size, int nitems, char *type); </pre>
    74 
    75 Several of these functions are used to perform byte-swapping for
    76 structures in the pre-autocode days.  They should be deprecated and
    77 dropped, but the autocoding must superceed the hard-wired structure
    78 first.
    79 
    80 <h3> miscellaneous functions </h3>
    81 
    82 <pre> char *ohana_version (); </pre>
    83 
    84 <h3> photcode manipulations (LoadPhotcodes.c) </h3>
    85 
    86 <pre> int       LoadPhotcodes (char *filename, PhotCodeData *photcodes); </pre>
    87 <pre> int       FreePhotcodes (PhotCodeData *photcodes); </pre>
    88 
    89 <pre> PhotCode *GetPhotcodebyName (char *name); </pre>
    90 <pre> PhotCode *GetPhotcodeEquivbyName (char *name); </pre>
    91 <pre> PhotCode *GetPhotcodebyCode (int code); </pre>
    92 <pre> PhotCode *GetPhotcodeEquivbyCode (int code); </pre>
    93 <pre> PhotCode *GetPhotcodebyNsec (int Nsec); </pre>
    94 <pre> char     *GetPhotcodeNamebyCode (int code); </pre>
    95 
    96 <pre> int       GetPhotcodeCodebyName (char *name); </pre>
    97 <pre> int       GetPhotcodeEquivCodebyName (char *name); </pre>
    98 <pre> int       GetPhotcodeEquivCodebyCode (int code); </pre>
    99 <pre> int       GetPhotcodeNsec (int code); </pre>
    100 <pre> int       GetPhotcodeNsecfilt (); </pre>
    101 <pre> int      *GetPhotcodeEquivList (int code, int *nlist); </pre>
    102 
    103 <pre> void      SetZeroPoint (double ZP); </pre>
    104 <pre> void      ParseColorTerms (char *terms, float *X, int *N); </pre>
    105 
    106 <pre> int       PhotColor (Average *average, SecFilt *secfilt, Measure *measure, int c1, int c2, double *color); </pre>
    107 <pre> short     iPhotColor (Average *average, SecFilt *secfilt, Measure *measure, PhotCode *code); </pre>
    108 
    109 <pre> double    PhotInst (Measure *measure); </pre>
    110 <pre> double    PhotCat (Measure *measure); </pre>
    111 <pre> double    PhotSys (Measure *measure, Average *average, SecFilt *secfilt); </pre>
    112 <pre> double    PhotRel (Measure *measure, Average *average, SecFilt *secfilt); </pre>
    113 <pre> double    PhotCal (Measure *thisone, Average *average, SecFilt *secfilt, Measure *measure, PhotCode *code); </pre>
    114 <pre> double    PhotAve (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
    115 <pre> double    PhotRef (PhotCode *code, Average *average, SecFilt *secfilt, Measure *measure); </pre>
    116 <pre> double    PhotdM (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
    117 <pre> double    PhotXm (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
    118 
    119 <pre> short     iPhotInst (Measure *measure); </pre>
    120 <pre> short     iPhotCat (Measure *measure); </pre>
    121 <pre> short     iPhotSys (Measure *measure, Average *average, SecFilt *secfilt); </pre>
    122 <pre> short     iPhotRel (Measure *measure, Average *average, SecFilt *secfilt); </pre>
    123 <pre> short     iPhotCal (Measure *thisone, Average *average, SecFilt *secfilt, Measure *measure, PhotCode *code); </pre>
    124 <pre> short     iPhotAve (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
    125 <pre> short     iPhotRef (PhotCode *code, Average *average, SecFilt *secfilt, Measure *measure); </pre>
    126 <pre> short     iPhotdM (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
    127 <pre> short     iPhotXm (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
    128 
    129 <h3> functions in config.c </h3>
    130 
    131 <pre> char *SelectConfigFile (int *argc, char **argv, char *progname); </pre>
    132 <pre> char *LoadConfigFile (char *filename); </pre>
    133 <pre> char *ScanConfig (char *config, char *field, char *mode, int Nentry, ...); </pre>
    134 <pre> char *expandline (char *line, char *config); </pre>
    135 <pre> char *LoadRawConfigFile (char *filename, int options); </pre>
    136 
    137 <h3> functions in coordops.c </h3>
    138 
    139 <pre> int XY_to_RD (double *ra, double *dec, double x,  double y,   Coords *coords); </pre>
    140 <pre> int RD_to_XY (double *x,  double *y,   double ra, double dec, Coords *coords); </pre>
    141 <pre> int fXY_to_RD (float *ra, float *dec, float x,  float y,   Coords *coords); </pre>
    142 <pre> int fRD_to_XY (float *x,  float *y,   float ra, float dec, Coords *coords); </pre>
    143 <pre> int GetCoords (Coords *coords, Header *header); </pre>
    144 <pre> int coords_precess (double *ra, double *dec, double in_epoch, double out_epoch); </pre>
    145 
    146 <h3> functions in phot_catalog.c </h3>
    147 
    148 <pre> int lock_catalog (Catalog *catalog, int lockmode); </pre>
    149 <pre> int unlock_catalog (Catalog *catalog); </pre>
    150 <pre> int load_catalog (Catalog *catalog, char mode, int VERBOSE); </pre>
    151 <pre> int save_catalog (Catalog *catalog, char VERBOSE); </pre>
    152 <pre> Measure *FixOldMeasure (OldMeasure *in, int Nvalues); </pre>
    153 <pre> Average *FixOldAverage (OldAverage *in, int Nvalues); </pre>
    154 <pre> SecFilt *FixOldSecFilt (OldSecFilt *in, int Nvalues); </pre>
    155 
    156 <h3> functions in photfits.c </h3>
    157 
    158 <pre> short int putMi (double value); </pre>
    159 <pre> double getMi (short int value); </pre>
    160 <pre> void returnMcal (Image *image, double *c); </pre>
    161 <pre> void assignMcal (Image *image, double *c, int order); </pre>
    162 <pre> double applyMcal (Image *image, double x, double y); </pre>
    163 <pre> double findscatter (double *X, double *Y, double *M, double *dM, int N, double *c, int order); </pre>
    164 
    165 <h3> defined macros </h3>
    166 
    167 the ohana library includes the following macros:
     85associated constants:
    16886
    16987<pre>
    170 
    171 SIGN(X) 
    172 ROUND(X)
    173 SQR(X)   
    174 SQ(X)   
    175 MIN(X,Y)
    176 MAX(X,Y)
    177 SWAP(X,Y)
    178 
    179 whitespace (char c)
    180 </pre>
    181 
    182 <h3> defined constants </h3>
    183 
    184 <pre>
    185 TRUE
    186 FALSE
    187 
    18888LCK_SOFT - block writing
    18989LCK_XCLD - block reading and writing
    … …  
    200100LCK_UNKNOWN  - can't stat file to get size
    201101</pre>
     102
     103<h3> time / radec manipulation functions (time.c) </h3>
     104
     105<pre> int dms_to_ddd (double *Value, char *string); </pre>
     106<pre> int str_to_radec (double *ra, double *dec, char *str1, char *str2); </pre>
     107<pre> int chk_time (char *line); </pre>
     108<pre> int str_to_time (char *line, time_t *second); </pre>
     109<pre> int str_to_dtime (char *line, double *second); </pre>
     110<pre> double sec_to_jd (time_t second); </pre>
     111<pre> time_t jd_to_sec (double jd); </pre>
     112<pre> double sec_to_mjd (time_t second); </pre>
     113<pre> time_t mjd_to_sec (double mjd); </pre>
     114<pre> char *sec_to_date (time_t second); </pre>
     115<pre> time_t date_to_sec (char *date); </pre>
     116<pre> time_t short_date_to_sec (char *date); </pre>
     117<pre> int hstgsc_hms_to_deg (double *h0, double *h1, double *d0, double *d1, char *string); </pre>
     118
     119<h3> functions in config.c </h3>
     120
     121<pre> char *SelectConfigFile (int *argc, char **argv, char *progname); </pre>
     122<pre> char *LoadConfigFile (char *filename); </pre>
     123<pre> char *ScanConfig (char *config, char *field, char *mode, int Nentry, ...); </pre>
     124<pre> char *expandline (char *line, char *config); </pre>
     125<pre> char *LoadRawConfigFile (char *filename, int options); </pre>
     126
     127<h3> miscellaneous functions </h3>
     128
     129<pre> char *ohana_version (); </pre>
     130
     131<h2> DVO data structures and catalog I/O functions </h2>
     132
     133<h3> read/write (Fread.c) </h3>
     134
     135<pre> int Fread (char ptr, int size, int nitems, FILE *f, char *type); </pre>
     136<pre> int Fwrite (char ptr, int size, int nitems, FILE *f, char *type); </pre>
     137<pre> int ByteSwap (char *ptr, int size, int nitems, char *type); </pre>
     138<pre> int ConvertStruct (char *buffer, int size, int nitems, char *type); </pre>
     139
     140Several of these functions are used to perform byte-swapping for
     141structures in the pre-autocode days.  They should be deprecated and
     142dropped, but the autocoding must superceed the hard-wired structure
     143first.
     144
     145<h3> coordinate structure manipulations (coordops.c) </h3>
     146
     147<pre> int XY_to_RD (double *ra, double *dec, double x,  double y,   Coords *coords); </pre>
     148<pre> int RD_to_XY (double *x,  double *y,   double ra, double dec, Coords *coords); </pre>
     149<pre> int fXY_to_RD (float *ra, float *dec, float x,  float y,   Coords *coords); </pre>
     150<pre> int fRD_to_XY (float *x,  float *y,   float ra, float dec, Coords *coords); </pre>
     151<pre> int GetCoords (Coords *coords, Header *header); </pre>
     152<pre> int coords_precess (double *ra, double *dec, double in_epoch, double out_epoch); </pre>
     153
     154<h3> photcode manipulations (LoadPhotcodes.c) </h3>
     155
     156<pre> int       LoadPhotcodes (char *filename, PhotCodeData *photcodes); </pre>
     157<pre> int       FreePhotcodes (PhotCodeData *photcodes); </pre>
     158
     159<pre> PhotCode *GetPhotcodebyName (char *name); </pre>
     160<pre> PhotCode *GetPhotcodeEquivbyName (char *name); </pre>
     161<pre> PhotCode *GetPhotcodebyCode (int code); </pre>
     162<pre> PhotCode *GetPhotcodeEquivbyCode (int code); </pre>
     163<pre> PhotCode *GetPhotcodebyNsec (int Nsec); </pre>
     164<pre> char     *GetPhotcodeNamebyCode (int code); </pre>
     165
     166<pre> int       GetPhotcodeCodebyName (char *name); </pre>
     167<pre> int       GetPhotcodeEquivCodebyName (char *name); </pre>
     168<pre> int       GetPhotcodeEquivCodebyCode (int code); </pre>
     169<pre> int       GetPhotcodeNsec (int code); </pre>
     170<pre> int       GetPhotcodeNsecfilt (); </pre>
     171<pre> int      *GetPhotcodeEquivList (int code, int *nlist); </pre>
     172
     173<pre> void      SetZeroPoint (double ZP); </pre>
     174<pre> void      ParseColorTerms (char *terms, float *X, int *N); </pre>
     175
     176<pre> int       PhotColor (Average *average, SecFilt *secfilt, Measure *measure, int c1, int c2, double *color); </pre>
     177<pre> short     iPhotColor (Average *average, SecFilt *secfilt, Measure *measure, PhotCode *code); </pre>
     178
     179<pre> double    PhotInst (Measure *measure); </pre>
     180<pre> double    PhotCat (Measure *measure); </pre>
     181<pre> double    PhotSys (Measure *measure, Average *average, SecFilt *secfilt); </pre>
     182<pre> double    PhotRel (Measure *measure, Average *average, SecFilt *secfilt); </pre>
     183<pre> double    PhotCal (Measure *thisone, Average *average, SecFilt *secfilt, Measure *measure, PhotCode *code); </pre>
     184<pre> double    PhotAve (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
     185<pre> double    PhotRef (PhotCode *code, Average *average, SecFilt *secfilt, Measure *measure); </pre>
     186<pre> double    PhotdM (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
     187<pre> double    PhotXm (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
     188
     189<pre> short     iPhotInst (Measure *measure); </pre>
     190<pre> short     iPhotCat (Measure *measure); </pre>
     191<pre> short     iPhotSys (Measure *measure, Average *average, SecFilt *secfilt); </pre>
     192<pre> short     iPhotRel (Measure *measure, Average *average, SecFilt *secfilt); </pre>
     193<pre> short     iPhotCal (Measure *thisone, Average *average, SecFilt *secfilt, Measure *measure, PhotCode *code); </pre>
     194<pre> short     iPhotAve (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
     195<pre> short     iPhotRef (PhotCode *code, Average *average, SecFilt *secfilt, Measure *measure); </pre>
     196<pre> short     iPhotdM (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
     197<pre> short     iPhotXm (PhotCode *code, Average *average, SecFilt *secfilt); </pre>
     198
     199<h3> photometry catalog I/O functions (phot_catalog.c) </h3>
     200
     201<pre> int lock_catalog (Catalog *catalog, int lockmode); </pre>
     202<pre> int unlock_catalog (Catalog *catalog); </pre>
     203<pre> int load_catalog (Catalog *catalog, char mode, int VERBOSE); </pre>
     204<pre> int save_catalog (Catalog *catalog, char VERBOSE); </pre>
     205
     206<h3> DVO format conversions (dvo_convert.c) </h3>
     207
     208<pre> Measure *FixOldMeasure (OldMeasure *in, int Nvalues); </pre>
     209<pre> Average *FixOldAverage (OldAverage *in, int Nvalues); </pre>
     210<pre> SecFilt *FixOldSecFilt (OldSecFilt *in, int Nvalues); </pre>
     211
     212<h3> image type / mode lookups (imreg_datatypes.c) </h3>
     213<pre> int   get_image_type (char *name); </pre>
     214<pre> char *get_type_name (int type); </pre>
     215<pre> int   get_image_mode (char *name); </pre>
     216<pre> char *get_mode_name (int mode); </pre>
     217
     218<h3> mosaic astrometry functions (mosaic_astrom.c) </h3>
     219
     220<pre> int FindMosaicForImage (Image *images, int Nimages, int entry); </pre>
     221<pre> int FindMosaicForImage_TableSearch (Image *images, int Nimages, int entry); </pre>
     222<pre> int FindMosaicForImage_MatchSearch (Image *images, int Nimages, int entry); </pre>
     223<pre> int BuildChipMatch (Image *images, int Nimages); </pre>
     224
     225<h3> FITS DB I/O functions (fits_db.c) </h3>
     226
     227<pre> int fits_db_init (FITS_DB *db); </pre>
     228<pre> int fits_db_create (FITS_DB *db); </pre>
     229<pre> int fits_db_lock (FITS_DB *db, char *filename); </pre>
     230<pre> int fits_db_load (FITS_DB *db); </pre>
     231<pre> int fits_db_save (FITS_DB *db); </pre>
     232<pre> int fits_db_update (FITS_DB *db, VTable *vtable); </pre>
     233<pre> int fits_db_free (FITS_DB *db); </pre>
     234<pre> int fits_db_close (FITS_DB *db); </pre>
     235
     236<h3> functions in photfits.c </h3>
     237
     238<pre> short int putMi (double value); </pre>
     239<pre> double getMi (short int value); </pre>
     240<pre> void returnMcal (Image *image, double *c); </pre>
     241<pre> void assignMcal (Image *image, double *c, int order); </pre>
     242<pre> double applyMcal (Image *image, double x, double y); </pre>
     243<pre> double findscatter (double *X, double *Y, double *M, double *dM, int N, double *c, int order); </pre>
     244
     245These functions manipulate the high-order polynomial fit of magnitude
     246offset as a function of image position for the Image structure.
     247
Note: See TracChangeset for help on using the changeset viewer.