: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_PULSE_SUPPRESS_EFFECT
-------------------------

.. model:: effect WSF_PULSE_SUPPRESS_EFFECT

EW Effects: :ref:`Predefined_Electronic_Warfare_Effect_Types`

.. parsed-literal::

   ...
     effect <effect-name> WSF_PULSE_SUPPRESS_EFFECT_
        :command:`electronic_warfare_effect` Commands
        :model:`WSF_PULSE_EFFECT` Commands

        reject_ <suppression-type-value> <suppression-type> <lower-suppression-value>
        allow_  <suppression-type-value> <suppression-type> <lower-suppression-value>
        <upper-suppression-value>
     end_effect
   ...

Overview
========

This base effect type can be included in the :command:`electronic_protect` or
:command:`electronic_attack` technique block as one of the many available effects for a given
technique. The commands listed below are the base-type commands that can be specified in the effect block for this
effect type.

.. block:: WSF_PULSE_SUPPRESS_EFFECT

Commands
========

.. command:: reject  <suppression-type> <lower-suppression-value> <upper-suppression-value> 
.. command:: allow   <suppression-type> <lower-suppression-value> <upper-suppression-value> 
   
   Specifies the rejected or allowed suppression-type and required input variables that are dependent upon the
   suppression-type specified.
   
   **<suppression-type>**
      Specifies the suppression type to be used. Available suppression types are given in the following table.
   
   **<lower-suppression-value>**
      Specifies the lower suppression value of the specified suppression type. Value types are given in the following table.
   
   **<upper-suppression-value>**
      Specifies the upper suppression value of the specified suppression type. Value types are given in the following table.
   
   +----------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------+---------------------------------------------+
   | <suppression-type>                           | Description                                                             | <lower-suppression-value>                   | <upper-suppression-value>                   |
   +==============================================+=========================================================================+=============================================+=============================================+
   | '**frequency**'                              | Apply pulse frequency suppression, allows                               | Lower frequency limit **<frequency-value>** | Upper frequency limit **<frequency-value>** |
   |                                              | or rejects the frequency inside the limits.                             |                                             |                                             |
   +----------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------+---------------------------------------------+
   | '**pulse_width**'                            | Apply Pulse-Width (PW) suppression, allows                              | Lower PW limit **<time-value>**             | Upper PW limit **<time-value>**             |
   |                                              | or rejects the PW inside the limits.                                    |                                             |                                             |
   +----------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------+---------------------------------------------+
   | '**pulse_repetition_frequency**'             | Apply Pulse-Repetition-Frequency (PRF) suppression,                     | Lower PRF limit **<frequency-value>**       | Upper PRF limit **<frequency-value>**       |
   |                                              | allows or                                                               |                                             |                                             |
   |                                              | rejects the PRF inside the limits.                                      |                                             |                                             |
   +----------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------+---------------------------------------------+
   | '**modulation**' (Currently not implemented) | Apply pulse modulation suppression, allows                              | Modulation type **<modulation-type>**       | Rejection ratio **<value>** **[0,1]**       |
   |                                              | or rejects the specified modulation type                                | (see below for modulation types)            |                                             |
   |                                              | with the specified ratio applied to the power.                          |                                             |                                             |
   +----------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------+---------------------------------------------+
   | '**coherent**'                               | Apply coherent pulse suppression, allows                                | Power rejection ratio **<value>** **[0,1]** | N/A                                         |
   |                                              | or rejects the specified ratio of coherent                              |                                             |                                             |
   |                                              | pulse power.                                                            |                                             |                                             |
   +----------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------+---------------------------------------------+
   | '**noncoherent**'                            | Apply noncoherent pulse suppression, allows                             | Power rejection ratio **<value>** **[0,1]** | N/A                                         |
   |                                              | or rejects the specified ratio of                                       |                                             |                                             |
   |                                              | noncoherent pulse power.                                                |                                             |                                             |
   +----------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------+---------------------------------------------+
   | '**percent_of_pulses**'                      | Apply percent of pulses suppression, allows                             | Pulse rejection ratio **<value>** **[0,1]** | N/A                                         |
   |                                              | or rejects the specified ratio of pulses,                               |                                             |                                             |
   |                                              | for :model:`WSF_FALSE_TARGET_EFFECT` this is a ratio of false-targets   |                                             |                                             |
   |                                              | instead of pulses.                                                      |                                             |                                             |
   +----------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------+---------------------------------------------+
   
      **<modulation-type>**
         Specifies the modulation type. Available modulation types are as follows::
   
            continuous_wave / cw - Continuous Wave
            coherent_pulse       - Coherent Pulse
            non_coherent_pulse   - Noncoherent Pulse
            linear_fm            - Linear Frequency
            non_linear_fm        - Nonlinear Frequency
            phase_key            - Phase Key (generic key)
            phase_modulation     - Phase Modulation (generic modulation)
            phase_coding         - Phase code (generic code)
            ask                  - Amplitude Shift Keying
            fsk                  - Frequency Shift Keying
            psk                  - Phase Shift Keying
            bpsk                 - Binary Phase Shift Keying
            dpsk                 - Differential Phase Shift Keying
            qpsk                 - Quadrature Phase Shift Keying
            qam                  - Quadrature Amplitude Modulation