Index of Functions: A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 
Index Page
cspice_wnfltd

Table of contents
Abstract
I/O
Parameters
Examples
Particulars
Exceptions
Files
Restrictions
Required_Reading
Literature_References
Author_and_Institution
Version
Index_Entries


Abstract


   CSPICE_WNFLTD filters (removes) small intervals from
   a double precision window.

I/O


   Given:

      smlint   the scalar double precision limiting measure of the small
               intervals to filter.

               help, smlint
                  DOUBLE = Scalar

               Intervals of measure less than or equal to `smlint' are removed
               from the window.

      window   a scalar, double precision window containing zero or more
               intervals.

               help, window
                  STRUCT = cspice_celld(2*N)

               `window' must be created as a window structure via a
               cspice_celld call.

   the call:

      cspice_wnfltd, smlint, window

   returns:

      window   on output, is the original window, after `smlint' intervals have
               been removed.

               help, window
                  STRUCT = cspice_celld(2*N)

Parameters


   None.

Examples


   Any numerical results shown for this example may differ between
   platforms as the results depend on the SPICE kernels used as input
   and the machine specific arithmetic implementation.

   1) Given a double precision window, containing the following four
      intervals:

         [ 1.0, 3.0 ], [ 7.0, 11.0 ], [ 23.0, 27.0 ], [ 29.0, 29.0 ]

      remove any intervals equal to or less than 3.0.

      Example code begins here.


      PRO wnfltd_ex1
         ;;
         ;; Create a cell containing a double
         ;; precision 8-vector.
         ;;
         win1 = cspice_celld( 8 )

         ;;
         ;; Define a window with four intervals.
         ;;
         darray = [ [ 1.d, 3.0], [ 7.0, 11.0], [23.0, 27.0], [29.d, 29.d] ]

         ;;
         ;; Add the window data to the cell.
         ;;
         for i=0, 3 do begin

            cspice_wninsd, darray[0,i], darray[1,i], win1

         endfor

         ;;
         ;; Filter the gaps:
         ;;
         cspice_wnfltd, 3.d0, win1

         ;;
         ;; Calculate the number of intervals in the
         ;; return window 'win1'.
         ;;
         no_intervals = cspice_wncard(win1)

         ;;
         ;; Output the intervals.
         ;;
         for i= 0, (no_intervals -1 ) do begin

            cspice_wnfetd, win1, i, left, right
            print, left, right

         endfor

      END


      When this program was executed on a Mac/Intel/IDL8.x/64-bit
      platform, the output was:


             7.0000000       11.000000
             23.000000       27.000000


Particulars


   The user must create any needed window structures with
   cspice_celld prior to use regardless of whether the routine
   uses the window as input or returns it as output.

   This routine removes from the input window every interval with
   measure less than or equal to the limiting measure `smlint'.

Exceptions


   1)  The cardinality of the input `window' must be even. Left
       endpoints of stored intervals must be strictly greater than
       preceding right endpoints. Right endpoints must be greater
       than or equal to corresponding left endpoints. Invalid window
       data are not diagnosed by this routine and may lead to
       unpredictable results.

   2)  If `smlint' is less than or equal to zero, this routine has
       no effect on the window.

   3)  If any of the input arguments, `smlint' or `window', is
       undefined, an error is signaled by the IDL error handling
       system.

   4)  If any of the input arguments, `smlint' or `window', is not of
       the expected type, or it does not have the expected dimensions
       and size, an error is signaled by the Icy interface.

Files


   None.

Restrictions


   None.

Required_Reading


   ICY.REQ
   CELLS.REQ
   WINDOWS.REQ

Literature_References


   None.

Author_and_Institution


   J. Diaz del Rio     (ODC Space)
   E.D. Wright         (JPL)

Version


   -Icy Version 1.1.0, 10-AUG-2021 (JDR)

       Changed the input argument name "small" to "smlint" for
       consistency with other routines.

       Edited the header to comply with NAIF standard. Added
       example's problem statement.

       Extended -Particulars section.

       Added -Parameters, -Exceptions, -Files, -Restrictions,
       -Literature_References and -Author_and_Institution sections.

       Removed reference to the routine's corresponding CSPICE header from
       -Abstract section.

       Added arguments' type and size information in the -I/O section.

   -Icy Version 1.0.2, 26-NOV-2007 (EDW)

       Implemented use of cspice_wncard function to return
       window cardinality.

   -Icy Version 1.0.1, 12-SEP-2006 (EDW)

       Correct Required Reading citation cell.req to cells.req.

   -Icy Version 1.0.0, 08-AUG-2004 (EDW)

Index_Entries


   filter small intervals from a d.p. window



Fri Dec 31 18:43:09 2021