ccdObj.h Source File

00001 /*************************************************************************
00002 * E.S.O. - VLT project
00003 *
00004 * "@(#) $Id: ccdObj.h,v 4.1 2003/10/30 15:32:47 vltsccm Exp $"
00005 *
00006 * who          when      what
00007 * -----------  --------  ----------------------------------------------
00008 * A.Longinotti 12/11/96  created
00009 * A.Longinotti 28/04/97  removed pco.h. Problems on Solaris
00010 */
00011 
00012 /*************************************************************************
00013 *  This file contains all definitions used by the library ccdObj
00014 *************************************************************************/
00015 
00016 #ifndef CCDOBJ_H
00017 #define CCDOBJ_H
00018 
00019 #ifdef __cplusplus
00020 extern "C" {
00021 #endif
00022 
00023 /*
00024  * CCS & LCC header files
00025  */
00026 #include "CCS.h"
00027 
00028 /*
00029  * CCD header files
00030  */
00031 
00032 /*
00033  * Constants
00034  */
00035 
00036 /*
00037  * Types definitions
00038  */
00039 typedef struct                 /* parameters needed to find objects        */
00040     {                     
00041     vltUINT8 procId;           /* Midas unit ID (between 0 and 99)         */
00042     vltLOGICAL threshAbs;      /* meaning of threshVal                     */
00043     vltINT32 threshVal;        /* intensity threshold                      */
00044     } ccdOBJMETHOD;
00045 
00046 typedef struct                 /* object information                       */
00047     {                     
00048     vltFLOAT xPos;             /* position along x axis (pixel coord.)     */
00049     vltFLOAT yPos;             /* position along y axis (pixel coord.)     */
00050     vltFLOAT intensity;        /* intensity                                */
00051     } ccdOBJECT;
00052 
00053 /*
00054  * function prototypes
00055  */
00056 /* Get all objects detected in an image */
00057 ccsCOMPL_STAT ccdObjAll(
00058     char *file,               /* name of FITS file containing image    */
00059     const ccdOBJMETHOD *method, /* parameters needed for the computation */
00060     vltINT32  *objectsN,      /* number of objects found               */
00061     ccdOBJECT **objects,      /* info about objects found              */
00062     ccsERROR *error);         /* error structure                       */
00063 
00064 /* Get the brightest object in an image */
00065 ccsCOMPL_STAT ccdObjBright(
00066     char *file,               /* name of FITS file containing image    */
00067     const ccdOBJMETHOD *method, /* parameters needed for the computation */
00068     ccdOBJECT *object,        /* info about object found               */
00069     ccsERROR *error);         /* error structure                       */
00070 
00071 /* Get the closest object to a reference point in an image */
00072 ccsCOMPL_STAT ccdObjClose(
00073     char *file,               /* name of FITS file containing image    */
00074     const ccdOBJMETHOD *method, /* parameters needed for the computation */
00075     ccdOBJECT *reference,     /* reference position                    */
00076     ccdOBJECT *object,        /* info about object found               */
00077     ccsERROR *error);         /* error structure                       */
00078 
00079 /* Display the image analysed with all objects detected */
00080 ccsCOMPL_STAT ccdObjDisplay(
00081     char *file,               /* name of FITS file containing image    */
00082     vltUINT8 procId,          /* Midas unit ID                         */
00083     ccsERROR *error);         /* error structure                       */
00084 
00085 #ifdef __cplusplus
00086 }
00087 #endif
00088 
00089 #endif /* ! CCDOBJ_H */