OpticalTelControl.idl

#ifndef _OPTICALTELIDL
#define _OPTICALTELIDL

#include "carma/antenna/common/SwitchState.idl"
#include "carma/util/UserException.idl"

module carma
{
  module antenna
  {
    module common
    {
      const string OPTICAL_TEL_NAME = "OpticalTel";

      enum Resolution {
          HIGH_RES,
          MEDIUM_RES,
          LOW_RES
      };

      struct flattenedOpticalImage
      {
          short xRes;     
          short x;        
          short yRes;     
          short y;        
          short xMax;     
          short yMax;     
          float fovWidth; 
          float rotationInDegrees; 
          short numImages;
          sequence<octet> opticalData; 
          short pixelDepth; 
      };

      struct CentroidResult {
          boolean valid;             
          string errorString;        
          float xOffsetInArcminutes; 
          float yOffsetInArcminutes; 
          float peakPixelSNR;        
          float sizeInArcminutes;    
          unsigned long aperturePixelCount;         };

      typedef sequence<CentroidResult> CentroidResults;

      interface OpticalTelControl
      {

          void turn( in SwitchState state )
              raises (carma::util::UserException);

          void setFrameDimensions( in short x,
                                   in short y,
                                   in short x0,
                                   in short y0 )
              raises (carma::util::UserException);

          void setBrightness( in float brightness )
              raises (carma::util::UserException);

          void setContrast( in float contrast )
              raises (carma::util::UserException);

          void setFramegrabberResolution( in Resolution res )
              raises (carma::util::UserException);

          void setRotationAndFieldsOfView( in float rotationInDegrees,
                                           in float azFOVInArcminutes,
                                           in float elFOVInArcminutes )
              raises (carma::util::UserException);

          flattenedOpticalImage grabFrame()
              raises (carma::util::UserException);

          flattenedOpticalImage getImage( in unsigned short numFrames,
                                          in boolean subBackground,
                                          in boolean normalizeMedian,
                                          in boolean normalizeImage )
              raises (carma::util::UserException);

          void takeBackgroundImage( in unsigned short numFrames,
                                    in unsigned long seq )
              raises (carma::util::UserException);

          flattenedOpticalImage getStoredBackgroundImage( )
              raises ( carma::util::UserException );

          void findCentroid(
                  in unsigned short numFramesPerImage,
                  in unsigned short minValidCentroids,
                  in unsigned short maxCentroidAttempts,
                  in unsigned short numEdgePixels,
                  in unsigned short apertureRadiusPixels,
                  in float pixelThresholdSigma,
                  in boolean subBackground,
                  in boolean normalizeMedian,
                  in unsigned long seq )
              raises ( carma::util::UserException );

          CentroidResults getCentroidResults( )
              raises ( carma::util::UserException );

          void applyTestOffset( in double azInArcmin, in double elInArcmin )
            raises ( carma::util::UserException );

          void zeroTestOffset( )
            raises ( carma::util::UserException );

      }; // End OpticalTelControl interface

    }; // End common module

  }; // End antenna module

}; // End carma module

#endif  // _OPTICALTELIDL