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_pltnp

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

Abstract


   CSPICE_PLTNP finds the nearest point on a triangular plate to a
   given point.

I/O


   Given:

      point    an arbitrary point in 3-dimensional space.

               [3,1] = size(point); double = class(point)

      v1,
      v2,
      v3       3-vectors constituting the vertices of
               a triangular plate.

               The plate is allowed to be degenerate: it may
               consist of a line segment or of a single point.

               [3,1] = size(v1); double = class(v1)
               [3,1] = size(v2); double = class(v2)
               [3,1] = size(v3); double = class(v3)

   the call:

      [pnear, dist] = cspice_pltnp( point, v1, v2, v3 )

   returns:

      pnear    the closest point on the plate to `point'.
               `pnear' is unique, since the plate is convex.

               [3,1] = size(pnear); double = class(pnear)

      dist     the distance between `point' and `pnear'.

               [1,1] = size(dist); double = class(dist)

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) Find the nearest point to the point (2,2,2) on a plate having
      vertices at the unit basis vectors that lie along the positive
      X, Y, and Z coordinate axes.


      Example code begins here.


      function pltnp_ex1()

         point = [2.0, 2.0, 2.0]';
         v1    = [1.0, 0.0, 0.0]';
         v2    = [0.0, 1.0, 0.0]';
         v3    = [0.0, 0.0, 1.0]';

         [pnear, dist] = cspice_pltnp(point, v1, v2, v3);


         fprintf ( [ '\n' ...
                     'Plate vertex 1 = %14.7e %14.7e %14.7e\n' ...
                     'Plate vertex 2 = %14.7e %14.7e %14.7e\n' ...
                     'Plate vertex 3 = %14.7e %14.7e %14.7e\n' ...
                     'Input point    = %14.7e %14.7e %14.7e\n' ...
                     '\n'                                      ...
                     'Near point     = %14.7e %14.7e %14.7e\n' ...
                     'Distance       = %14.7e\n'               ...
                     '\n'],                                    ...
                     v1(1),    v1(2),    v1(3),                ...
                     v2(1),    v2(2),    v2(3),                ...
                     v3(1),    v3(2),    v3(3),                ...
                     point(1), point(2), point(3),             ...
                     pnear(1), pnear(2), pnear(3),             ...
                     dist                                    )


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


      Plate vertex 1 =  1.0000000e+00  0.0000000e+00  0.0000000e+00
      Plate vertex 2 =  0.0000000e+00  1.0000000e+00  0.0000000e+00
      Plate vertex 3 =  0.0000000e+00  0.0000000e+00  1.0000000e+00
      Input point    =  2.0000000e+00  2.0000000e+00  2.0000000e+00

      Near point     =  3.3333333e-01  3.3333333e-01  3.3333333e-01
      Distance       =  2.8867513e+00


Particulars


   None.

Exceptions


   1)  The input plate is allowed to be degenerate: it may be
       a line segment or a single point.

   2)  If any of the input arguments, `point', `v1', `v2' or `v3', is
       undefined, an error is signaled by the Matlab error handling
       system.

   3)  If any of the input arguments, `point', `v1', `v2' or `v3', is
       not of the expected type, or it does not have the expected
       dimensions and size, an error is signaled by the Mice
       interface.

Files


   None.

Restrictions


   None.

Required_Reading


   DSK.REQ
   MICE.REQ

Literature_References


   None.

Author_and_Institution


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

Version


   -Mice Version 1.1.0, 07-AUG-2020 (EDW) (JDR)

       Added -Parameters, -Exceptions, -Files, -Restrictions,
       -Literature_References and -Author_and_Institution sections. Fixed
       minor typos in header.

       Edited the header to comply with NAIF standard.

       Eliminated use of "lasterror" in rethrow.

       Removed reference to the function's corresponding CSPICE header from
       -Required_Reading section.

   -Mice Version 1.0.0, 16-MAR-2016 (EDW) (NJB)

Index_Entries


   nearest point on triangular plate


Fri Dec 31 18:44:26 2021