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_inelpl

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

Abstract


   CSPICE_INELPL finds the intersection of an ellipse and a plane.

I/O


   Given:

      ellips   a structure describing a SPICE ellipse. The ellipse is
               allowed to be degenerate: one or both semi-axes may
               have zero length.

               [1,1] = size(ellips); struct = class(ellips)

               The structure has the fields:

               center:    [3,1] = size(center); double = class(center)
               semiMajor: [3,1] = size(semiMajor); double = class(semiMajor)
               semiMinor: [3,1] = size(semiMinor); double = class(semiMinor)

      plane    a structure describing a SPICE plane. The intersection of
               `plane' and `ellips' is sought.

               [1,1] = size(plane); struct = class(plane)

               The structure has the fields:

                  normal:   [3,1] = size(normal); double = class(normal)
                  constant: [1,1] = size(constant); double = class(constant)

   the call:

      [nxpts, xpt1, xpt2] = cspice_inelpl( ellips, plane )

   returns:

      nxpts    the number of points of intersection of the geometric plane
               and ellipse represented by `plane' and `ellips'. `nxpts' may
               take the values 0, 1, 2 or -1. The value -1 indicates the
               ellipse lies in the plane, so the number of intersection
               points is infinite.

               -1 also signals for the degenerate case where the ellipse
               structure defines a single point and that point lies
               in the plane of interest. In this case, -1 means not an
               infinite number of intersections, rather that the
               ellipse is a subset of the plane, that subset having
               measure one.

               [1,1] = size(nxpts); int32 = class(nxpts)

      xpt1,
      xpt2     the points of intersection of the input plane and ellipse.
               If there is only one intersection point, both `xpt1' and
               `xpt2' contain that point. If the number of intersection
               points is zero or infinite, the contents of `xpt1' and
               `xpt2' are undefined.

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

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 intersection of an ellipse and a plane for three
      cases: between Saturn's limb as seen from a position in
      Saturn's body frame at one hundred equatorial radii out along
      the x axis, one hundred radii above the equatorial plane
      point and Saturn's equatorial plane; between Saturn's limb
      as seen from a position in Saturn's body frame at one hundred
      radii along the Z pole vector (positive) and Saturn's equatorial
      plane; and between Saturn's limb as seen from a position in
      Saturn's body frame at one radii along the X axis and Saturn's
      equatorial plane.

      Use the PCK kernel below to load the required triaxial
      ellipsoidal shape model and orientation data for Saturn.

         pck00008.tpc


      Example code begins here.


      function inelpl_ex1()

         %
         % Load the PCK.
         %
         cspice_furnsh( 'pck00008.tpc' )

         %
         % Retrieve the triaxial radii of Saturn (699)
         %
         radii = cspice_bodvrd( 'SATURN', 'RADII', 3 );

         %
         % Define a position in the body frame at one hundred equatorial
         % radii out along the x axis, one hundred radii above the
         % equatorial plane.
         %
         vertex = [ 100.0 * radii(1), 0.0, radii(1) *100.0 ]';

         %
         % Find the limb of the ellipsoid as seen from the
         % point `vertex'. `limb' returns as a CSPICE_ELLIPSE.
         %
         limb = cspice_edlimb( radii(1), radii(2), radii(3), vertex );

         %
         % Define the equatorial plane as a SPICE plane. The Z
         % axis is normal to the plane, the origin lies in the
         % plane.
         %
         normal = [ 0., 0., 1.]';
         point  = [ 0., 0., 0.]';
         plane  = cspice_nvp2pl( normal, point);

         %
         % Calculate the intersection of the `limb' and `plane'.
         %
         [ nxpts, xpt1, xpt2] = cspice_inelpl( limb, plane );

         fprintf(['Observer at (100, 0, 100) radii, no. ', ...
                  'intersection points: %d\n'],    nxpts )
         fprintf( '   Intersection points\n' )
         fprintf( '%.12g  %.12g  %.12g\n',   xpt1   )
         fprintf( '%.12g  %.12g  %.12g\n\n', xpt2   )

         %
         % One hundred radii along the Z pole vector (positive)
         %
         vertex = [ 0.0 * radii(1), 0.0, radii(1) *100.0 ]';

         %
         % The resulting limb ellipse should lie parallel to, but
         % not in the same plane as the equatorial plane. No
         % intersection should exist.
         %
         limb = cspice_edlimb( radii(1), radii(2), radii(3), vertex );
         [ nxpts, xpt1, xpt2] = cspice_inelpl( limb, plane );

         fprintf(['Ellipse/plane parallel case, no. ',   ...
                  'intersection points: %d\n\n'], nxpts )

         %
         % One radii along the X axis, i.e. on the surface, a very
         % degenerate case.
         %
         vertex = [ radii(1), 0.0, 0.0 ]';

         %
         % In this case the limb ellipse exists as a point at (x, 0, 0).
         %
         limb = cspice_edlimb( radii(1), radii(2), radii(3), vertex );

         %
         % Calculate the intersection of the plane and the degenerate
         % ellipse.
         %
         [ nxpts, xpt1, xpt2 ] = cspice_inelpl( limb, plane );

         %
         % As the point (x, 0, 0) exists in `plane' and that point represents
         % the complete ellipse, the routine should return -1 for infinite
         % number of intersections - though in this case the intersection
         % contains only one element.
         %
         fprintf( 'Degenerate case, no. intersection points: %d\n', nxpts )

         %
         % It's always good form to unload kernels after use,
         % particularly in Matlab due to data persistence.
         %
         cspice_kclear


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


      Observer at (100, 0, 100) radii, no. intersection points: 2
         Intersection points
      602.68  60264.9865247  3.18323145621e-12
      602.68  -60264.9865247  -9.37916411203e-12

      Ellipse/plane parallel case, no. intersection points: 0

      Degenerate case, no. intersection points: 1


Particulars


   This routine computes the intersection set of a non-degenerate
   plane with a possibly degenerate ellipse. The ellipse is allowed
   to consist of a line segment or a point.

   A plane may intersect an ellipse in 0, 1, 2, or infinitely many
   points. For there to be an infinite set of intersection points,
   the ellipse must lie in the plane and consist of more than one
   point.

Exceptions


   1)  If the input plane is invalid, the error SPICE(INVALIDPLANE)
       is signaled by a routine in the call tree of this routine. The
       input plane must be a SPICE plane: the normal vector must be
       non-zero and the constant must be non-negative.

   2)  If the input ellipse has non-orthogonal axes, the error
       SPICE(INVALIDELLIPSE) is signaled by a routine in the call
       tree of this routine.

   3)  The input ellipse is allowed to be a line segment or a point;
       these cases are not considered to be errors. If the ellipse
       consists of a single point and lies in the plane, the number
       of intersection points is set to 1 (rather than -1) and
       the output arguments `xpt1' and `xpt2' are assigned the value
       of the ellipse's center.

   4)  If any of the input arguments, `ellips' or `plane', is
       undefined, an error is signaled by the Matlab error handling
       system.

   5)  If any of the input arguments, `ellips' or `plane', 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


   MICE.REQ
   ELLIPSES.REQ
   PLANES.REQ

Literature_References


   None.

Author_and_Institution


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

Version


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

       Changed input argument name "ellipse" to "ellips".

       Edited the header to comply with NAIF standard. Added example's
       problem statement. Added -Parameters, -Exceptions, -Files,
       -Restrictions, -Literature_References and -Author_and_Institution
       sections.

       Eliminated use of "lasterror" in rethrow.

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

   -Mice Version 1.0.0, 27-AUG-2012 (EDW)

Index_Entries


   intersection of ellipse and plane


Fri Dec 31 18:44:25 2021