iSDSUAutoguider.idl

Go to the documentation of this file.

/*
=====================================================================
File : AutoguiderInterface.idl
Description
-----------
IDL CORBA description for the SDSU Autoguider
=====================================================================
@Author R.Bassom
Control Software Group
Isaac Newton Group of Telescopes
La Palma
Canary Islands
Spain
=====================================================================
Modification Log
Vers         Date        Author       Reason
----         ----        ------       ------
1
Commissioning Notes
-------------------
None
=====================================================================
Identifier : $Id: iSDSUAutoguider.idl,v 1.1 2008/02/11 08:23:26 cb Exp $
RO         : $Author: cb $
Header     : $Header: /opt/INGsrc/src/CVS/softproj/IDL/src/iSDSUAutoguider/iSDSUAutoguider.idl,v 1.1 2008/02/11 08:23:26 cb Exp $
Log        : $Log: iSDSUAutoguider.idl,v $
Log        : Revision 1.1  2008/02/11 08:23:26  cb
Log        : First version
Log        :
Log        : Revision 1.14  2005/02/24 09:59:25  rab
Log        : Added centroid and centroidInWindow methods to IDL interface.
Log        :
Log        : Revision 1.13  2004/06/02 13:36:52  rab
Log        : Added hasNewImage method to IDL.
Log        :
Log        : Revision 1.12  2004/03/12 09:08:21  rab
Log        : Removed moveGuideWindow method, and changed setGuideWindow to accept only centre coordinates.
Log        :
Log        : Revision 1.11  2004/03/02 15:31:43  rab
Log        : Added open and close guide loop methods. Added resetReferenceStar method for relative transparency reset.
Log        :
Log        : Revision 1.10  2004/02/27 10:02:21  rab
Log        : Added GuideStarTracking methods. Removed getAutoguiderStatus method.
Log        :
Log        : Revision 1.9  2004/02/24 11:12:20  rab
Log        : Added moveGuideWindow and offsetGuideWindow methods.
Log        :
Log        : Revision 1.8  2004/02/13 09:26:23  rab
Log        : Added setGuideWindowSize method. Added autoguider status parameter getters which deprecate the getAutoguiderStatus method: State, IntegrationTime, AcquisitionWindow, GuideWindow, AutoguiderCycle, GuideTargetPosition, SNRThreshold.
Log        :
Log        : Revision 1.7  2004/02/11 09:59:45  rab
Log        : Added RelativeTransparency to Star structure. Added IntegrationTime to autoguider status structure.
Log        :
Log        : Revision 1.6  2004/02/03 15:28:43  rab
Log        : Corrected some comments.
Log        :
Log        : Revision 1.5  2004/01/30 12:05:52  rab
Log        : Added moveObject method, header and comments.
Log        :


module iSDSUAutoguider {

   typedef sequence <unsigned short> Image;

   struct ImageData {
      Image AutoguiderImage;
      float integration_time;
      unsigned short x;
      unsigned short y;
   };

   struct Star {
      double Centroidx;
      double Centroidy;
      double IsophotalIntensity;
      double PeakIntensity;
      double IsophotalSize;
      double Ellipticity;
      double FWHMx;
      double FWHMy;
      double SkyNoise;
      double SkyLevel;
      double PeakSNR;
      double Seeing;
      double Magnitude;
      double RelativeTransparency;
   };

   typedef sequence <Star> StarList;

   struct Window {
      long x1;
      long y1;
      long x2;
      long y2;
   };

   struct Pixel {
      double x;
      double y;
   };

   struct CameraStatus {
      string CCDClocks;
      string ReadoutSpeed;
      long   Xbinning;
      long   Ybinning;
      double CCDDemandTemperature;
      double CCDActualTemperature;
      double CCDSinkTemperature;
      boolean PeltierStatus;
   };

   typedef sequence <Star, 20> Stars;

   interface AutoguiderInterface {
      void guide ();
      
      void guideOnObject (
         in double x,
         in double y
      );
      
      void guideOnPixel (
         in double x,
         in double y
         );
   
      void stop ();
   
      void suspendGuiding ();
      
      void continueGuiding ();
      
      void openGuideLoop ();
      
      void closeGuideLoop ();
      
      void field ();
      
      void centroid ();
      
      void centroidInWindow (in Window theWindow);
      
      void startTV ();
      
      void moveObject (
         in double xoffset,
         in double yoffset
         );      
      
      void setCameraName (
         in string CameraName
         );
      
      void setInstrumentPlatform (
         in string InstrumentName
         );
      
      void setIntegrationTime (
         in double IntegrationTime
         );
      
      void setSNRThreshold (
         in double SNRThreshold
         );
      
      void setAcquisitionWindow (
         in long x1,
         in long y1,
         in long x2,
         in long y2
         );
      
      void setGuideWindow (
         in long x,
         in long y
         );
      
      void offsetGuideWindow (
         in long xoffset,
         in long yoffset
         );
      
      void setGuideWindowSize (
         in long size
         );
      
      void setGuideObject (
         in long GuideObject
         );
         
      void setGuideStarTrackingOn (
         );
                 
      void setGuideStarTrackingOff (
         );
                 
      void resetReferenceGuideStar (
         );
                 
      
      boolean hasNewImage();

      ImageData getImage();

      Star getGuideStar();

      Star getStar(
         in long StarIndex
         );


      long NumberOfStars();
      
      string State();

      double IntegrationTime();

      Window AcquisitionWindow();

      Window GuideWindow();

      long   AutoguiderCycle();

      Pixel  GuideTargetPosition();

      double SNRThreshold();

      double Centroidx(
         in long StarIndex
         );

      double Centroidy(
         in long StarIndex
         );

      double IsophotalIntensity(
         in long StarIndex
         );

      double PeakIntensity(
         in long StarIndex
         );

      double IsophotalSize(
         in long StarIndex
         );

      double Ellipticity(
         in long StarIndex
         );

      double FWHMx(
         in long StarIndex
         );

      double FWHMy(
         in long StarIndex
         );

      double SkyNoise(
         in long StarIndex
         );

      double SkyLevel(
         in long StarIndex
         );

      double PeakSNR(
         in long StarIndex
         );

      double Seeing(
         in long StarIndex
         );

      double Magnitude(
         in long StarIndex
         );
 
      CameraStatus getCameraStatus();
      
   };
   
};