:orphan:

.. ****************************************************************************
.. CUI
..
.. The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
..
.. The use, dissemination or disclosure of data in this file is subject to
.. limitation or restriction. See accompanying README and LICENSE for details.
.. ****************************************************************************

WSF_OPTICAL_SENSOR
------------------

.. model:: sensor WSF_OPTICAL_SENSOR

.. parsed-literal::

   sensor <name> :model:`WSF_OPTICAL_SENSOR`
      :ref:`Platform_Part_Commands` ...
      ... :command:`sensor` Commands ...
      mode <name>
         ... :ref:`Antenna_Commands` ...
         :command:`_.receiver` Commands ...
         ... WSF_OPTICAL_SENSOR `Mode Commands`_ ...
      end_mode
   end_sensor

Overview
========

WSF_OPTICAL_SENSOR implements a simple optical sensor.  The sensor model computes the target contrast assuming a
constant background contrast and linear atmospheric attenuation for target detection chances.

The model's contrast threshold is based upon "*A Model for Visual Detection by Ground Observers*," Arthur C. Poe III,
US Army Missile Command, Oct 1974 (AD-A017-599, Report RD-75-30).

.. block:: WSF_OPTICAL_SENSOR

Mode Commands
=============

.. command:: atmospheric_attenuation <value> per <length-units>
   
   The fraction of the signal (in the closed range 0 to 1) that is attenuated per unit of distance traveled at sea level.
   The attenuation is adjusted to account for the density of air with the change in an altitude.
   
   Default: 0.0 per meter (no attenuation)

.. command:: background_radiance <value> <power-units>/<solid-angle-units>/<area-units>
   
   Specifies the radiance of the background.
   
   Default: 0.0

.. command:: path_radiance <value> <power-units>/<angle-units>/<area-units>
   
   Specifies the path radiance.
   
   Default: 0.0

.. command:: reacquisition_time <value> <time-units>
   
   Specifies the sensor reacquisition time when a track is dropped.
   
   Default: 3.0 sec

.. command:: search_glimpse_data ... end_search_glimpse_data

.. command:: reacquire_glimpse_data ... end_reacquire_glimpse_data

.. command:: track_glimpse_data ... end_track_glimpse_data
   
   Specifies the data necessary to compute a glimpse probability table for each optical detection sequence.
   
   .. parsed-literal::
   
      search_glimpse_data
         azimuth_fov_ ...
         minimum_elevation_ ...
         maximum_elevation_ ...
         number_of_iterations_ ...
         magnification_ ...
         apparent_half_angle_FOV ...
         minimum_resolution_ ...
         contrast_gain_ ...
         ocular_integration_interval ...
      end_search_glimpse_data

   .. command:: azimuth_fov <value> <angle-units>
   
   Specifies the sensor's azimuth field-of-view for the given glimpse probability.
   
   Default: 5.0 deg

   .. command:: minimum_elevation <value> <angle-units>
      
      Specifies the sensor's lowest elevation look-angle for the given glimpse probability.
      
      Default: 0.0 deg

   .. command:: maximum_elevation <value> <angle-units>
      
      Specifies the sensor's maximum elevation look-angle for the given glimpse probability.
      
      Default: 5.0 deg

   .. command:: number_of_iterations <value>
      
      Specifies the number of Monte-Carlo iterations that will be performed to create the probability table.
      
      Default: 1000

   .. command:: magnification <value>
      
      Specifies the sensor's magnification.
      
      Default: 1.0

   .. command:: apparent_half_angle_FOV <value> <angle-units>
      
      Specifies the sensor's apparent half-angle FOV.
      
      Default: 45.0 deg

   .. command:: minimum_resolution <value> <angle-units>
      
      Specifies the sensor's minimum resolution.
      
      Default: 0.001 sr

   .. command:: contrast_gain <value>
      
      Specifies the sensor's contrast gain.
      
      Default: 1.0

   .. command:: ocular_integration_level <value> <angle-units>
      
      Specifies the sensor's ocular integration level.
      
      Default: 0.05 deg