IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Aug 17, 2005, 9:36:55 AM (21 years ago)
Author:
eugene
Message:

renamed hms_to_deg hstgsc_hms_to_deg everywhere, moved into libohana

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r2413 r4810  
    22<h2> libohana API reference </h2>
    33
    4 <h3> functions in string.c </h3>
     4<h3> ohana memory management functions </h3>
     5
     6<pre> ALLOCATE (void *ptr, type, int Nalloc); </pre>
     7<pre> REALLOCATE (void *ptr, type, int Nalloc); </pre>
     8<pre> CHECK_REALLOCATE (void *ptr, type, int Nalloc, int Nused, int Ndelta); </pre>
     9<pre> free (void *ptr); </pre>
     10
     11<pre> void  ohana_memregister (void *ptr); </pre>
     12<pre> void  ohana_memdump (int mode); </pre>
     13<pre> void  ohana_memcheck (int mode); </pre>
     14
     15<h3> string manipulation functions (string.c) </h3>
     16
     17<pre> int   get_argument (int argc, char **argv, char *arg); </pre>
     18<pre> int   remove_argument (int Narg, int *argc, char **argv); </pre>
     19<pre> char *strcreate (char *string); </pre>
     20<pre> char *strncreate (char *string, int Nbytes); </pre>
     21<pre> int   strnumcmp (char *str1, char *str2); </pre>
     22<pre> int   stripwhite (char *string); </pre>
     23<pre> int   scan_line (FILE *f, char *line); </pre>
     24<pre> int   dparse (double *value, int Nentry, char *line); </pre>
     25<pre> int   fparse (double *value, int Nentry, char *line); </pre>
     26<pre> char *_parse_nextword (char *string); </pre>
    527
    628<pre> int get_argument (int argc, char **argv, char *arg); </pre>
    … …  
    1032<hr>
    1133
    12 <pre> int remove_argument (int Narg, int &argc, char **argv); </pre>
     34<pre> int remove_argument (int Narg, int *argc, char **argv); </pre>
    1335
    1436remove the given entry Narg from the argv list, adjusting argc
    … …  
    2749<hr>
    2850
    29 <pre> char *strcreate (char *string); </pre>
    30 <pre> char *strncreate (char *string, int Nbytes); </pre>
    31 <pre> int scan_line (FILE *f, char *line); </pre>
    32 <pre> int dparse (double *value, int Nentry, char *line); </pre>
    33 <pre> int fparse (double *value, int Nentry, char *line); </pre>
    34 <pre> char *_parse_nextword (char *string); </pre>
    35 
    36 <h3> functions in findexec.c </h3>
     51<h3> file system functions (findexec.c) </h3>
    3752
    3853<pre> char *pathname (char *file); </pre>
    … …  
    4156<pre> char *filebasename (char *file); </pre>
    4257<pre> char *findexec (int argc, char **argv); </pre>
    43 <pre> int mkdirhier (char *path); </pre>
     58<pre> int   mkdirhier (char *path); </pre>
    4459<pre> char *getcwd_cfht (char *path, int size); </pre>
    45 
    46 <h3> functions in glockfile.c </h3>
     60<pre> void  make_backup (char *filename); </pre>
     61<pre> int Fseek (FILE *f, long offset, int whence); </pre>
     62
     63<h3> lockfile functions (glockfile.c) </h3>
    4764
    4865<pre> FILE *fsetlockfile (char *filename, double timeout, int type, int *state); </pre>
    49 <pre> int fclearlockfile (char *filename, FILE *f, int type, int *state); </pre>
    50 <pre> int setlockfile2 (char *filename, double timeout, int type, int *state); </pre>
    51 <pre> int clearlockfile2 (char *filename, double timeout, int type, int *state); </pre>
    52 
    53 <b> deprecated functions : are they all removed?  </b>
    54 <pre> int setlockfile (char *name, double timeout, int hard); </pre>
    55 <pre> int clearlockfile (char *name, int fd, int hard); </pre>
    56 <pre> int gnfsflush (char *filename); </pre>
    57 
    58 <h3> functions in Fread.c </h3>
     66<pre> int   fclearlockfile (char *filename, FILE *f, int type, int *state); </pre>
     67
     68<h3> read/write (Fread.c) </h3>
    5969
    6070<pre> int Fread (char ptr, int size, int nitems, FILE *f, char *type); </pre>
    … …  
    6373<pre> int ConvertStruct (char *buffer, int size, int nitems, char *type); </pre>
    6474
    65 <h3> functions in LoadPhotcodes.c </h3>
    66 
    67 <pre> int LoadPhotcodes (char *filename, PhotCodeData *photcodes); </pre>
    68 <pre> int FreePhotcodes (PhotCodeData *photcodes); </pre>
    69 <pre> int GetPhotcodebyName (PhotCodeData *photcodes, char *name); </pre>
    70 <pre> int GetPhotcodeRefs (PhotCodeData *photcodes, char *name, int *code, int *ref); </pre>
    71 <pre> int GetPhotcodeEquiv (PhotCodeData *photcodes, char *name, int *code, int *ref); </pre>
    72 <pre> char *GetPhotnamebyCode (PhotCodeData *photcodes, int code); </pre>
     75Several of these functions are used to perform byte-swapping for
     76structures in the pre-autocode days.  They should be deprecated and
     77dropped, but the autocoding must superceed the hard-wired structure
     78first.
     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>
    73128
    74129<h3> functions in config.c </h3>
    … …  
    113168
    114169<pre>
    115 ALLOCATE (void *ptr, type, int Nelement)
    116 REALLOCATE (void *ptr, type, int Nelement)
    117170
    118171SIGN(X) 
Note: See TracChangeset for help on using the changeset viewer.