>  Docs Center  >  Libraries  >  JHU/APL/S1R  >  RECPOL_FUNC

RECPOL_FUNC

RECPOL_FUNC

Name


      RECPOL_FUNC

Purpose


      2-D rectangular coordinates to polar as a function.

Category


Calling Sequence


      out = recpol_func(x,y)

Inputs


      x,y = Input x and y components. in
        Scalars or arrays.

Keyword Parameters


Keywords


        /DEGREES Reurn directions in degrees, else radians.
          Directions are angle from +X axis in CCW direction.
        /MAG Return magnitude.
        /DIR Return direction.
          If only one of the above is used then the single
          requested value is returned (may be a scalar or array).
          If neither or both are given both values are returned
          in a structure (def) or hash. These keywords are used
          to make this function return a single component for each
          call.
        /STRUCTURE Return the requested values in a structure.
          The tags will be MAG and DIR.
        /HASH Return the requested values in a hash.
          The keys will be MAG and DIR.

Outputs


      out = Returned result. out
        May be a scalar, array, structure, or hash.

Common Blocks


Notes


      Notes: This function is similar to the recpol procedure
      but can be used where a function is needed, such as in an
      expression. For such calls only one of /MAG or /DIR would
      be used.

Modification History


      R. Sterner, 2012 Sep 25
  Copyright (C) 2012, Johns Hopkins University/Applied Physics Laboratory
  This software may be used, copied, or redistributed as long as it is not
  sold and this copyright notice is reproduced on each copy made. This
  routine is provided as is without any express or implied warranties
  whatsoever. Other limitations apply as described in the file disclaimer.txt.



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us