diff --git a/dev/api/index.html b/dev/api/index.html index 23c7db9..d10e1c3 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,15 +1,15 @@ -API · SPICE.jl
Edit on GitHub

API

SPICE.SpiceCharCell — Type
SpiceCharCell(size, length)

Create a SpiceCharCell that can contain up to size strings with length characters.

source
Base.append! — Method
append!(cell, collection)

Append all items from collection to the char/double/integer SpiceCell cell.

source
Base.copy — Method
copy(cell::SpiceCell)

Duplicate the SpiceCell cell.

source
Base.diff — Method
diff(a::T, b::T) where T <: SpiceCell

Compute the difference of two sets of any data type to form a third set.

Arguments

  • a: First input set
  • b: Second input set

Output

Returns a cell containing the difference of a and b.

References

source
Base.length — Method
length(cell)

Returns the cardinality (number of elements) of cell.

source
Base.push! — Method
push!(cell, items...)

Insert one or more items at the end of the char/double/integer SpiceCell cell.

source
Base.union — Method
union(a::T, b::T) where T <: SpiceCell

Compute the union of two sets of any data type to form a third set.

Arguments

  • a: First input set
  • b: Second input set

Output

Returns a cell containing the union of a and b.

References

source
SPICE.axisar — Method
axisar(axis, angle)

Construct a rotation matrix that rotates vectors by a specified angle about a specified axis.

Arguments

  • axis: Rotation axis
  • angle: Rotation angle in radians

Output

Rotation matrix corresponding to axis and angle

References

source
SPICE.badkpv — Method
badkpv(caller, name, comp, size, divby, typ)

Determine if a kernel pool variable is present and if so that it has the correct size and type.

Arguments

  • caller: Name of the routine calling this routine
  • name: Name of a kernel pool variable
  • comp: Comparison operator
  • size: Expected size of the kernel pool variable
  • divby: A divisor of the size of the kernel pool variable
  • type: Expected type of the kernel pool variable

Output

The function returns false if the kernel pool variable is OK otherwise an exception is thrown.

References

source
SPICE.bltfrm — Method
bltfrm(frmcls)

Return a SPICE set containing the frame IDs of all built-in frames of a specified class.

Arguments

  • frmcls: Frame class

Output

  • idset: Set of ID codes of frames of the specified class

References

source
SPICE.bodc2n — Method
bodc2n(code)

Translate the SPICE integer code of a body into a common name for that body.

Arguments

  • code: Integer ID code to be translated into a name

Output

A common name for the body identified by code or nothing if none was found.

References

source
SPICE.bodc2s — Method
bodc2s(code)

Translate a body ID code to either the corresponding name or if no name to ID code mapping exists, the string representation of the body ID value.

Arguments

  • code: Integer ID code to translate to a string

Output

Returns a string corresponding to code

References

source
SPICE.bodfnd — Method
bodfnd(body, item)

Determine whether values exist for some item for any body in the kernel pool.

Arguments

  • body: ID code of body
  • item: Item to find ("RADII", "NUTAMPRA", etc.)

Output

Returns true if the item is in the kernel pool and false if it is not.

References

source
SPICE.bodn2c — Method
bodn2c(name)

Translate the name of a body or object to the corresponding SPICE integer ID code.

Arguments

  • name: Body name to be translated into a SPICE ID code

Output

Return the SPICE integer ID code for the named body or nothing if none was found.

References

source
SPICE.bods2c — Method
bods2c(name)

Translate a string containing a body name or ID code to an integer code.

Arguments

  • name: String to be translated to an ID code

Output

Retunrs the integer ID code corresponding to name or nothing if none as found.

References

source
SPICE.bodvcd — Function
bodvcd(bodyid, item)

Fetch from the kernel pool the double precision values of an item associated with a body, where the body is specified by an integer ID code.

Arguments

  • bodyid: Body ID code
  • item: Item for which values are desired. ("RADII", "NUT_PREC_ANGLES", etc.)
  • maxn: Maximum number of values that may be returned (default: 100)

Output

Returns the requested values.

References

source
SPICE.bodvrd — Function
bodvrd(bodynm, item)

Fetch from the kernel pool the double precision values of an item associated with a body.

Arguments

  • bodynm: Body name
  • item: Item for which values are desired. ("RADII", "NUT_PREC_ANGLES", etc.)
  • maxn: Maximum number of values that may be returned (default: 100)

Output

  • values: Values

References

source
SPICE.brcktd — Function
brcktd(number, e1, e2)
Deprecated

Use clamp from Julia's standard library instead.

source
SPICE.brckti — Function
brckti(number, e1, e2)
Deprecated

Use clamp from Julia's standard library instead.

source
SPICE.bschoc — Function
bschoc(value, array, order)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.bschoi — Function
bschoi(value, array, order)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.bsrchc — Function
bsrchc(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.bsrchd — Function
bsrchd(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.bsrchi — Function
bsrchi(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.card — Method
card(cell)

Returns the cardinality (number of elements) of cell.

source
SPICE.ccifrm — Method
ccifrm(frclss, clssid)

Return the frame name, frame ID, and center associated with a given frame class and class ID.

Arguments

  • frclss: Class of frame
  • clssid: Class ID of frame

Output

Returns nothing if no frame was found or

  • frcode: ID code of the frame
  • frname: Name of the frame
  • center: ID code of the center of the frame

References

source
SPICE.cgv2el — Method
cgv2el(center, vec1, vec2)

Form an ellipse from a center vector and two generating vectors.

Arguments

  • center: Center vector
  • vec1: Generating vector
  • vec2: Generating vector

Output

Returns the ellipse defined by the input vectors.

References

source
SPICE.chbder — Method
chbder(cp, x2s, x, nderiv)

Given the coefficients for the Chebyshev expansion of a polynomial, this returns the value of the polynomial and its first nderiv derivatives evaluated at the input x.

Arguments

  • cp: Chebyshev polynomial coefficients
  • x2s: Transformation parameters of polynomial
  • x: Value for which the polynomial is to be evaluated
  • nderiv: The number of derivatives to compute

Output

Returns the derivatives of the polynomial.

References

source
SPICE.cidfrm — Method
cidfrm(cent)

Retrieve frame ID code and name to associate with a frame center.

Arguments

  • cent: ID code for an object for which there is a preferred reference frame

Output

Returns nothing if no frame was found or

  • frcode: The ID code of the frame associated with cent
  • frname: The name of the frame with ID frcode

References

source
SPICE.ckcov! — Method
ckcov!(ck, idcode, needav, level, tol, timsys, cover)

Find the coverage window for a specified object in a specified CK file.

Arguments

  • ck: Name of CK file
  • idcode: ID code of object
  • needav: Flag indicating whether angular velocity is needed
  • level: Coverage level: "SEGMENT" OR "INTERVAL"
  • tol: Tolerance in ticks
  • timsys: Time system used to represent coverage
  • cover: Window giving coverage for idcode. Data already present in cover will be combined with coverage found for the object designated by idcode in the file ck.

References

source
SPICE.ckcov — Method
ckcov(ck, idcode, needav, level, tol, timsys)

Find the coverage window for a specified object in a specified CK file.

Arguments

  • ck: Name of CK file
  • idcode: ID code of object
  • needav: Flag indicating whether angular velocity is needed
  • level: Coverage level: "SEGMENT" OR "INTERVAL"
  • tol: Tolerance in ticks
  • timsys: Time system used to represent coverage

Output

Window giving coverage for idcode

References

source
SPICE.ckgp — Method
ckgp(inst, sclkdp, tol, ref)

Get pointing (attitude) for a specified spacecraft clock time.

Arguments

  • inst: NAIF ID of instrument, spacecraft, or structure
  • sclkdp: Encoded spacecraft clock time
  • tol: Time tolerance
  • ref: Reference frame

Outputs

Returns nothing if the requested pointing is not available or

  • cmat: C-matrix pointing data
  • clkout: Output encoded spacecraft clock time

References

source
SPICE.ckgpav — Method
ckgpav(inst, sclkdp, tol, ref)

Get pointing (attitude) and angular velocity for a specified spacecraft clock time.

Arguments

  • inst: NAIF ID of instrument, spacecraft, or structure
  • sclkdp: Encoded spacecraft clock time
  • tol: Time tolerance
  • ref: Reference frame

Outputs

Returns nothing if the requested pointing is not available or

  • cmat: C-matrix pointing data
  • av: Angular velocity vector
  • clkout: Output encoded spacecraft clock time

References

source
SPICE.cklpf — Method
cklpf(filename)

Load a CK pointing file for use by the CK readers. Return that file's handle, to be used by other CK routines to refer to the file.

Arguments

  • filename: Name of the CK file to be loaded

Output

Loaded file's handle

References

source
SPICE.ckobj! — Method
ckobj!(ck, ids)

Find the set of ID codes of all objects in a specified CK file.

Arguments

  • ck: Name of CK file
  • ids: Set of ID codes of objects in CK file. Data already present in ids will be combined with ID code set found for the file ck.

References

source
SPICE.ckobj — Method
ckobj(ck)

Find the set of ID codes of all objects in a specified CK file.

Arguments

  • ck: Name of CK file

Output

Set of ID codes of objects in CK file.

References

source
SPICE.ckopn — Function
ckopn(fname, ifname="CK_file", ncomch=0)

Open a new CK file, returning the handle of the opened file.

Arguments

  • fname: The name of the CK file to be opened
  • ifname: The internal filename for the CK (default: "CK_file")
  • ncomch: The number of characters to reserve for comments (default: 0)

Output

  • handle: The handle of the opened CK file

References

source
SPICE.ckupf — Method
ckupf(handle)

Unload a CK pointing file so that it will no longer be searched by the readers.

Arguments

  • handle: Handle of CK file to be unloaded

References

source
SPICE.ckw01 — Function
ckw01(handle, begtim, endtim, inst, ref, segid, sclkdp, quats, avvs=[zeros(3)])

Add a type 1 segment to a C-kernel.

Arguments

  • handle: Handle of an open CK file
  • begtim: The beginning encoded SCLK of the segment
  • endtim: The ending encoded SCLK of the segment
  • inst: The NAIF instrument ID code
  • ref: The reference frame of the segment
  • segid: Segment identifier
  • sclkdp: Encoded SCLK times
  • quats: Quaternions representing instrument pointing
  • avvs: Angular velocity vectors (optional)

References

source
SPICE.ckw02 — Method
ckw02(handle, begtim, endtim, inst, ref, segid, start, stop, quats, avvs, rates)

Write a type 2 segment to a C-kernel.

Arguments

  • handle: Handle of an open CK file
  • begtim: The beginning encoded SCLK of the segment
  • endtim: The ending encoded SCLK of the segment
  • inst: The NAIF instrument ID code
  • ref: The reference frame of the segment
  • segid: Segment identifier
  • start: Encoded SCLK interval start times
  • stop: Encoded SCLK interval stop times
  • quats: Quaternions representing instrument pointing
  • avvs: Angular velocity vectors
  • rates: Number of seconds per tick for each interval

References

source
SPICE.ckw03 — Function
ckw03(handle, begtim, endtim, inst, ref, segid, sclkdp, quats, starts, avvs=[zeros(3)])

Add a type 3 segment to a C-kernel.

Arguments

  • handle: Handle of an open CK file
  • begtim: The beginning encoded SCLK of the segment
  • endtim: The ending encoded SCLK of the segment
  • inst: The NAIF instrument ID code
  • ref: The reference frame of the segment
  • segid: Segment identifier
  • sclkdp: Encoded SCLK times
  • quats: Quaternions representing instrument pointing
  • starts: Encoded SCLK interval start times
  • avvs: Angular velocity vectors (optional)

References

source
SPICE.ckw05 — Method
ckw05(handle, subtyp, degree, begtim, endtim, inst, ref, avflag, segid, sclkdp, packts,
-      rate, nints, starts)

Write a type 5 segment to a CK file.

Arguments

  • handle: Handle of an open CK file
  • subtyp: CK type 5 subtype code
  • degree: Degree of interpolating polynomials
  • begtim: The beginning encoded SCLK of the segment
  • endtim: The ending encoded SCLK of the segment
  • inst: The NAIF instrument ID code
  • ref: The reference frame of the segment
  • avflag: True if the segment will contain angular velocity
  • segid: Segment identifier
  • sclkdp: Encoded SCLK times
  • packts: Array of packets
  • rate: Nominal SCLK rate in seconds per tick
  • nints: Number of intervals
  • starts: Encoded SCLK interval start times

References

source
SPICE.cmprss — Method
cmprss(delim, n, input)

Compress a character string by removing occurrences of more than n consecutive occurrences of a specified character.

Arguments

  • delim: Delimiter to be compressed
  • n: Maximum consecutive occurrences of delim
  • input: Input string

Output

Returns the compressed string.

References

source
SPICE.cnmfrm — Function
cnmfrm(cname)

Retrieve frame ID code and name to associate with an object.

Arguments

  • cname: Name of the object to find a frame for

Output

Returns a tuple of the ID code and the name of the frame associated with cname or nothing if no frame is found.

References

source
SPICE.conics — Method
conics(elts, et)

Determine the state (position, velocity) of an orbiting body from a set of elliptic, hyperbolic, or parabolic orbital elements.

Arguments

  • elts: Conic elements
  • et: Input time

Output

Returns the state of orbiting body at et.

References

source
SPICE.convrt — Method
convrt(x, in, out)

Take a measurement x, the units associated with x, and units to which x should be converted; return y - the value of the measurement in the output units.

Arguments

  • x: Number representing a measurement in some units
  • in: The units in which x is measured
  • out: Desired units for the measurement

Output

Returns the measurement in the desired units.

References

source
SPICE.cpos — Method
cpos(str, chars, start)

Find the first occurrence in a string of a character belonging to a collection of characters, starting at a specified location, searching forward.

Arguments

  • str: Any character string
  • chars: A collection of characters
  • start: Position to begin looking for one of chars

Output

Returns the index of the first character of str that is one of the characters in string chars. Returns -1 if none of the characters was found.

References

source
SPICE.cposr — Method
cposr(str, chars, start)

Find the first occurrence in a string of a character belonging to a collection of characters, starting at a specified location, searching in reverse.

Arguments

  • str: Any character string
  • chars: A collection of characters
  • start: Position to begin looking for one of chars

Output

Returns the index of the last character of str that is one of the characters in string chars. Returns -1 if none of the characters was found.

References

source
SPICE.cvpool — Method
cvpool(agent)

Indicate whether or not any watched kernel variables that have a specified agent on their notification list have been updated.

Arguments

  • agent: Name of the agent to check for notices

Output

Returns true if variables for agent have been updated.

References

source
SPICE.cyllat — Method
cyllat(r, lonc, z)

Convert from cylindrical to latitudinal coordinates.

Arguments

  • r: Distance of point from z axis
  • lonc: Cylindrical angle of point from XZ plane (radians)
  • z: Height of point above XY plane

Output

  • radius: Radius
  • lon: Longitude (radians)
  • lat: Latitude (radians)

References

source
SPICE.cylrec — Method
cylrec(r, lon, z)

Convert from cylindrical to rectangular coordinates.

Arguments

  • r: Distance of the point of interest from z axis
  • lon: Cylindrical angle (in radians) of the point of interest from XZ plane
  • z: Height of the point above XY plane

Output

Returns rectangular coordinates of the point of interest.

References

source
SPICE.cylsph — Method
cylsph(r, lonc, z)

Convert from cylindrical to spherical coordinates.

Arguments

  • r: Distance of point from z axis
  • lonc: Angle (radians) of point from XZ plane
  • z: Height of point above XY plane

Output

  • radius: Distance of the point from the origin
  • colat: Polar angle (co-latitude in radians)
  • lon: Azimuthal angle (longitude)

References

source
SPICE.dafac — Method
dafac(handle, buffer)

Add comments from a buffer of character strings to the comment area of a binary DAF file, appending them to any comments which are already present in the file's comment area.

Arguments

  • handle: Handle of a DAF opened with write access
  • buffer: Buffer of comments to put into the comment area

References

source
SPICE.dafcls — Method
dafcls(handle)

Close the DAF associated with a given handle.

Arguments

  • handle: Handle of DAF to be closed

Output

Returns the handle of the closed file.

References

source
SPICE.dafcs — Method
dafcs(handle)

Select a DAF that already has a search in progress as the one to continue searching.

Arguments

  • handle: Handle of DAF to continue searching

References

source
SPICE.dafdc — Method
dafdc(handle)

Delete the entire comment area of a specified DAF file.

Arguments

  • handle: The handle of a binary DAF opened for writing

References

source
SPICE.dafec — Method
dafec(handle; bufsiz=256, lenout=1024)

Extract comments from the comment area of a binary DAF.

Arguments

  • handle: Handle of binary DAF opened with read access
  • bufsiz: Maximum size, in lines, of buffer (default: 256)
  • lenout: Length of strings in output buffer (default: 1024)

Output

Returns a buffer where extracted comment lines are placed.

References

source
SPICE.dafgda — Method
dafgda(handle, start, stop)

Read the double precision data bounded by two addresses within a DAF.

Arguments

  • handle: Handle of a DAF
  • start, stop: Initial, final address within file

Output

Returns the data contained between start and stop.

References

source
SPICE.dafgn — Function
dafgn(lenout=128)

Return (get) the name for the current array in the current DAF.

Arguments

  • lenout: Length of array name string (default: 128)

Output

Returns the name of the current array.

References

source
SPICE.dafgs — Function
dafgs(lenout=128)

Return (get) the summary for the current array in the current DAF.

Arguments

  • lenout: The maximum length of the summary array

Output

Returns the summary for the current array.

References

source
SPICE.dafgsr — Method

Read a portion of the contents of a summary record in a DAF file.

Arguments

  • handle: Handle of DAF
  • recno: Record number
  • start: First word to read from record
  • stop: Last word to read from record

Output

Returns the contents of the record or nothing if none was found.

References

source
SPICE.dafopr — Method
dafopr(fname)

Open a DAF for subsequent read requests.

Arguments

  • fname: Name of DAF to be opened

Output

Returns the handle assigned to DAF.

References

source
SPICE.dafopw — Method
dafopw(fname)

Open a DAF for subsequent write requests.

Arguments

  • fname: Name of DAF to be opened

Output

Returns the handle assigned to DAF.

References

source
SPICE.dafps — Method
dafps(dc, ic)

Pack (assemble) an array summary from its double precision and integer components.

Arguments

  • dc: Double precision components
  • ic: Integer components

Output

Returns the array summary.

References

source
SPICE.dafrfr — Function
dafrfr(handle, lenout=128)

Read the contents of the file record of a DAF.

Arguments

  • handle: Handle of an open DAF file
  • lenout: Available room in the output string `ifname' (default: 128)

Output

  • nd: Number of double precision components in summaries
  • ni: Number of integer components in summaries
  • ifname: Internal file name
  • fward: Forward list pointer
  • bward: Backward list pointer
  • free: Free address pointer

References

source
SPICE.dafus — Method
dafus(sum, nd, ni)

Unpack an array summary into its double precision and integer components.

Arguments

  • sum: Array summary
  • nd: Number of double precision components
  • ni: Number of integer components

Output

  • dc: Double precision components
  • ic: Integer components

References

source
SPICE.dasac — Method
dasac(handle, buffer)

Add comments from a buffer of character strings to the comment area of a binary DAS file, appending them to any comments which are already present in the file's comment area.

Arguments

  • handle: Handle of a DAS opened with write access
  • buffer: Buffer of comments to put into the comment area

References

source
SPICE.dascls — Method
dascls(handle)

Close the DAS associated with a given handle.

Arguments

  • handle: Handle of DAS to be closed

Output

Returns the handle of the closed file.

References

source
SPICE.dasdc — Method
dasdc(handle)

Delete the entire comment area of a specified DAS file.

Arguments

  • handle: The handle of a binary DAS opened for writing

References

source
SPICE.dasec — Method
dasec(handle; bufsiz=256, lenout=1024)

Extract comments from the comment area of a binary DAS.

Arguments

  • handle: Handle of binary DAS opened with read access
  • bufsiz: Maximum size, in lines, of buffer (default: 256)
  • lenout: Length of strings in output buffer (default: 1024)

Output

Returns a buffer where extracted comment lines are placed.

References

source
SPICE.dashfn — Function
dashfn(handle, namelen=256)

Return the name of the DAS file associated with a handle.

Arguments

  • handle: Handle of a DAS file
  • namlen: Length of output file name string (default: 256)

Output

Returns the corresponding file name.

References

source
SPICE.dasopr — Method
dasopr(fname)

Open a DAS for subsequent read requests.

Arguments

  • fname: Name of DAS to be opened

Output

Returns the handle assigned to DAS.

References

source
SPICE.dasopw — Method
dasopw(fname)

Open a DAS for subsequent write requests.

Arguments

  • fname: Name of DAS to be opened

Output

Returns the handle assigned to DAS.

References

source
SPICE.dasrfr — Function
dasrfr(handle, idwlen=128, ifnlen=256)

Read the contents of the file record of a DAS.

Arguments

  • handle: DAS file handle
  • idwlen: Length of ID word string (default: 128)
  • ifnlen: Length of internal file name string (default: 256)

Output

  • idword: ID word
  • ifname: DAS internal file name
  • nresvr: Number of reserved records in file
  • nresvc: Number of characters in use in reserved records area
  • ncomr: Number of comment records in file
  • ncomc: Number of characters in use in comment area

References

source
SPICE.dcyldr — Method
dcyldr(x, y, z)

Compute the Jacobian of the transformation from rectangular to cylindrical coordinates.

Arguments

  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point

Output

Returns the matrix of partial derivatives.

References

source
SPICE.deltet — Method
deltet(epoch, eptype)

Return the value of ΔET (ET-UTC) for an input epoch.

Arguments

  • epoch: Input epoch (seconds past J2000)
  • eptype: Type of input epoch ("UTC" or "ET")

Output

Returns ΔET (ET-UTC) at input epoch.

References

source
SPICE.dgeodr — Method
dgeodr(x, y, z, re, f)

Compute the Jacobian of the transformation from rectangular to geodetic coordinates.

Arguments

  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

Returns the matrix of partial derivatives.

References

source
SPICE.diags2 — Method
diags2(symmat)

Diagonalize a symmetric 2x2 matrix.

Arguments

  • symmat: A symmetric 2x2 matrix

Output

  • diag: A diagonal matrix similar to symmat
  • rotate: A rotation used as the similarity transformation

References

source
SPICE.dlabbs — Method
dlabbs(handle)

Begin a backward segment search in a DLA file.

Arguments

  • handle: Handle of open DLA file

Output

Returns the descriptor of the last segment in the DLA file or nothing if none was found.

References

source
SPICE.dlabfs — Method
dlabfs(handle)

Begin a forward segment search in a DLA file.

Arguments

  • handle: Handle of open DLA file

Output

Returns the descriptor of the first segment in the DLA file or nothing if none was found.

References

source
SPICE.dlafns — Method
dlafns(handle, descr)

Find the segment following a specified segment in a DLA file.

Arguments

  • handle: Handle of open DLA file
  • descr: Descriptor of a DLA segment

Output

Returns the descriptor of the next segment in the DLA file or nothing if none was found.

References

source
SPICE.dlafps — Method
dlafps(handle, descr)

Find the segment preceding a specified segment in a DLA file.

Arguments

  • handle: Handle of open DLA file
  • descr: Descriptor of a DLA segment

Output

Returns the descriptor of the previous segment in the DLA file or nothing if none was found.

References

source
SPICE.dlatdr — Method
dlatdr(x, y, z)

Compute the Jacobian of the transformation from rectangular to latitudinal coordinates.

Arguments

  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point

Output

Returns the matrix of partial derivatives.

References

source
SPICE.dp2hx — Function
dp2hx(number, lenout=128)

Convert a double precision number to an equivalent character string using base 16 "scientific notation."

Arguments

  • number: Number to be converted
  • lenout: Available space for output string

Output

Returns the equivalent character string, left justified.

References

source
SPICE.dpgrdr — Method
dpgrdr(x, y, z, re, f)

Compute the Jacobian of the transformation from rectangular to planetographic coordinates.

Arguments

  • body: Body with which coordinate system is associated
  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

Returns the matrix of partial derivatives.

References

source
SPICE.dpmax — Function
dpmax()
Deprecated

Use prevfloat(typemax(Float64)) instead.

source
SPICE.dpmin — Function
dpmin()
Deprecated

Use nextfloat(typemin(Float64)) instead.

source
SPICE.drdcyl — Method
drdcyl(r, lon, z)

Compute the Jacobian of the transformation from cylindrical to rectangular coordinates.

Arguments

  • r: Distance of a point from the origin
  • lon: Angle of the point from the xz plane in radians
  • z: Height of the point above the xy plane

Output

Returns the matrix of partial derivatives.

References

source
SPICE.drdgeo — Method
drdgeo(lon, lat, alt, re, f)

Compute the Jacobian of the transformation from geodetic to rectangular coordinates.

Arguments

  • lon: Geodetic longitude of point (radians)
  • lat: Geodetic latitude of point (radians)
  • alt: Altitude of point above the reference spheroid
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

Returns the matrix of partial derivatives.

References

source
SPICE.drdlat — Method
drdlat(radius, lon, lat)

Compute the Jacobian of the transformation from latitudinal to rectangular coordinates.

Arguments

  • radius: Distance of a point from the origin
  • lon: Angle of the point from the XZ plane in radians
  • lat: Angle of the point from the XY plane in radians

Output

Returns the matrix of partial derivatives.

References

source
SPICE.drdpgr — Method
drdpgr(body, lon, lat, alt, re, f)

Compute the Jacobian matrix of the transformation from planetographic to rectangular coordinates.

Arguments

  • body: Name of body with which coordinates are associated
  • lon: Planetographic longitude of a point (radians)
  • lat: Planetographic latitude of a point (radians)
  • alt: Altitude of a point above reference spheroid
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

Returns the matrix of partial derivatives.

References

source
SPICE.drdsph — Method
drdsph(r, colat, lon)

Compute the Jacobian of the transformation from latitudinal to rectangular coordinates.

Arguments

  • r: Distance of a point from the origin
  • colat: Angle of the point from the positive z-axis
  • lon: Angle of the point from the xy plane

Output

Returns the matrix of partial derivatives.

References

source
SPICE.dskb02 — Method
dskb02(handle, dladsc)

Return bookkeeping data from a DSK type 2 segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor

Output

  • nv: Number of vertices in model
  • np: Number of plates in model
  • nvxtot: Number of voxels in fine grid
  • vtxbds: Vertex bounds
  • voxsiz: Fine voxel edge length
  • voxori: Fine voxel grid origin
  • vgrext: Fine voxel grid exent
  • cgscal: Coarse voxel grid scale
  • vtxnpl: Size of vertex-plate correspondence list
  • voxnpt: Size of voxel-plate pointer list
  • voxnpl: Size of voxel-plate correspondence list

References

source
SPICE.dskcls — Function
dskcls(handle, optmiz=true)

Close a DSK file.

Arguments

  • handle: Handle assigned to the opened DSK file
  • optmiz: Flag indicating whether to segregate the DSK (default: true)

References

source
SPICE.dskd02 — Method
dskd02(handle, dladsc, item, start, room)

Fetch double precision data from a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor
  • item: Keyword identifying item to fetch
  • start: Start index
  • room: Amount of room in output array

Output

Returns an array containing the requested item.

References

source
SPICE.dskgd — Method
dskgd(handle, dladsc)

Return the DSK descriptor from a DSK segment identified by a DAS handle and DLA descriptor.

Arguments

  • handle: Handle of a DSK file
  • dladsc: DLA segment descriptor

Output

Returns the DSK segment descriptor.

References

source
SPICE.dskgtl — Method
dskgtl(keywrd)

Retrieve the value of a specified DSK tolerance or margin parameter.

Arguments

  • keywrd: Code specifying parameter to retrieve

Output

Returns the value of the parameter.

References

source
SPICE.dski02 — Method
dski02(handle, dladsc, item, start, room)

Fetch integer data from a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor
  • item: Keyword identifying item to fetch
  • start: Start index
  • room: Amount of room in output array

Output

Returns an array containing the requested item.

References

source
SPICE.dskmi2 — Method
dskmi2(vrtces, plates, finscl, corscl, worksz, voxpsz, voxlsz, makvtl, spaisz)

Make spatial index for a DSK type 2 segment.

Arguments

  • vrtces: Vertices
  • plates: Plates
  • finscl: Fine voxel scale
  • corscl: Coarse voxel scale
  • worksz: Workspace size
  • voxpsz: Voxel-plate pointer array size
  • voxlsz: Voxel-plate list array size
  • makvtl: Vertex-plate list flag
  • spxisz: Spatial index integer component size

Output

  • spaixd: Double precision component of spatial index.
  • spaixi: Integer component of spatial index.

References

source
SPICE.dskn02 — Method
dskn02(handle, dladsc, plid)

Compute the unit normal vector for a specified plate from a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor
  • plid: Plate ID

Output

Return the plate's unit normal vector.

References

source
SPICE.dskobj! — Method
dskobj!(set, dsk)

Find the set of body ID codes of all objects for which topographic data are provided in a specified DSK file.

Arguments

  • dsk: Name of DSK file
  • set or len: Either a preallocated SpiceIntCell or the size of the output set.

Output

Returns the set of ID codes of objects in the DSK file.

References

source
SPICE.dskopn — Method
dskopn(fname, ifname, ncomch)

Open a new DSK file for subsequent write operations.

Arguments

  • fname: Name of a DSK file to be opened
  • ifname: Internal file name
  • ncomch: Number of comment characters to allocate

Output

Returns the handle assigned to the opened DSK file.

References

source
SPICE.dskp02 — Method
dskp02(handle, dladsc, start, room)

Fetch triangular plates from a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor
  • start: Start index
  • room: Amount of room in output array

Output

Returns an array of plates.

References

source
SPICE.dskrb2 — Method
dskrb2(vrtces, plates, corsys, corpar)

Determine range bounds for a set of triangular plates to be stored in a type 2 DSK segment.

Arguments

  • vrtces: Vertices
  • plates: Plates
  • corsys: DSK coordinate system code
  • corpar: DSK coordinate system parameters

Output

  • mncor3: Lower bound on range of third coordinate
  • mxcor3: Upper bound on range of third coordinate

References

source
SPICE.dsksrf! — Method
dsksrf!(set, dsk)

Find the set of surface ID codes of all objects for which topographic data are provided in a specified DSK file.

Arguments

  • dsk: Name of DSK file
  • set or len: Either a preallocated SpiceIntCell or the size of the output set.

Output

Returns the set of ID codes of surfaces in the DSK file.

References

source
SPICE.dskstl — Method
dskstl(keywrd)

Set the value of a specified DSK tolerance or margin parameter.

Arguments

  • keywrd: Code specifying parameter to retrieve
  • dpval: Value of parameter

References

source
SPICE.dskv02 — Method
dskv02(handle, dladsc, start, room)

Fetch vertices from a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor
  • start: Start index
  • room: Amount of room in output array

Output

Returns an array of vertices.

References

source
SPICE.dskw02 — Method
dskw02(handle, center, surfid, dclass, frame, corsys, corpar, mncor1, mxcor1,
-       mncor2, mxcor2, mncor3, mxcor3, first, last, vrtces, plates, spaixd, spaixi)

Write a type 2 segment to a DSK file.

Arguments

  • handle: Handle assigned to the opened DSK file
  • center: Central body ID code
  • surfid: Surface ID code
  • dclass: Data class
  • frame: Reference frame
  • corsys: Coordinate system code
  • corpar: Coordinate system parameters
  • mncor1: Minimum value of first coordinate
  • mxcor1: Maximum value of first coordinate
  • mncor2: Minimum value of second coordinate
  • mxcor2: Maximum value of second coordinate
  • mncor3: Minimum value of third coordinate
  • mxcor3: Maximum value of third coordinate
  • first: Coverage start time
  • last: Coverage stop time
  • nv: Number of vertices
  • vrtces: Vertices
  • np: Number of plates
  • plates: Plates
  • spaixd: Double precision component of spatial index
  • spaixi: Integer component of spatial index

References

source
SPICE.dskx02 — Method
dskx02(handle, dladsc, vertex, raydir)

Determine the plate ID and body-fixed coordinates of the intersection of a specified ray with the surface defined by a type 2 DSK plate model.

Arguments

  • handle: Handle of DSK kernel containing plate model
  • dladsc: DLA descriptor of plate model segment
  • vertex: Ray vertex in the body fixed frame
  • raydir: Ray direction in the body fixed frame

Output

Returns nothing if no intercept exists or

  • plid: ID code of the plate intersected by the ray
  • xpt: Intercept

References

source
SPICE.dskxsi — Function
dskxsi(pri, target, nsurf, srflst, et, fixref, vertex, raydir, maxd=1, maxi=1)

Compute a ray-surface intercept using data provided by multiple loaded DSK segments. Return information about the source of the data defining the surface on which the intercept was found: DSK handle, DLA and DSK descriptors, and DSK data type-dependent parameters.

Arguments

  • pri: Data prioritization flag
  • target: Target body name
  • srflst: Surface ID list
  • et: Epoch, expressed as seconds past J2000 TDB
  • fixref: Name of target body-fixed reference frame
  • vertex: Vertex of ray
  • raydir: Direction vector of ray
  • maxd: Size of DC array (default: 1)
  • maxi: Size of IC array (default: 1)

Output

Returns nothing if no intercept exists or

  • xpt: Intercept point
  • handle: Handle of segment contributing surface data
  • dladsc: DLA descriptor of segment
  • dskdsc: DSK descriptor of segment
  • dc: Double precision component of source info
  • ic: Integer component of source info

References

source
SPICE.dskxv — Method
dskxv(pri, target, srflst, et, fixref, nrays, vtxarr, dirarr)

Compute ray-surface intercepts for a set of rays, using data provided by multiple loaded DSK segments.

Arguments

  • pri: Data prioritization flag
  • target: Target body name
  • srflst: Surface ID list
  • et: Epoch, expressed as seconds past J2000 TDB
  • fixref: Name of target body-fixed reference frame
  • nrays: Number of rays
  • vtxarr: Array of vertices of rays
  • dirarr: Array of direction vectors of rays

Output

  • xptarr: Intercept point array
  • fndarr: Found flag array

References

source
SPICE.dskz02 — Method
dskz02(handle, dladsc)

Return plate model size parameters - plate count and vertex count - for a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor

Output

  • nv: Number of vertices
  • np: Number of plates

References

source
SPICE.dsphdr — Method
dsphdr(x, y, z)

Compute the Jacobian of the transformation from rectangular to spherical coordinates.

Arguments

  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point

Output

Returns the matrix of partial derivatives.

References

source
SPICE.dtpool — Method
dtpool(name)

Return the data about a kernel pool variable.

Arguments

  • name: Name of the variable whose value is to be returned

Output

Returns the tuple (n ,vartype).

  • n: Number of values returned for name
  • vartype: Type of the variable
    • :C if the data is character data
    • :N if the data is numeric
    • :X if there is no variable name in the pool

References

source
SPICE.ducrss — Method
ducrss(s1, s2)

Compute the unit vector parallel to the cross product of two 3-dimensional vectors and the derivative of this unit vector.

Arguments

  • s1: Left hand state for cross product and derivative
  • s2: Right hand state for cross product and derivative

Output

Returns the unit vector and derivative of the cross product.

References

source
SPICE.dvcrss — Method
dvcrss(s1, s2)

Compute the cross product of two 3-dimensional vectors and the derivative of this cross product.

Arguments

  • s1: Left hand state for cross product and derivative
  • s2: Right hand state for cross product and derivative

Output

Returns the cross product and its derivative.

References

source
SPICE.dvdot — Method
dvdot(s1, s2)

Compute the derivative of the dot product of two double precision position vectors.

Arguments

  • s1: First state vector in the dot product
  • s2: Second state vector in the dot product

Output

Returns the derivative of the dot product s1 ⋅ s2.

References

source
SPICE.dvhat — Method
dvhat(s1)

Find the unit vector corresponding to a state vector and the derivative of the unit vector.

Arguments

  • s1: State to be normalized

Output

Returns the unit vector s1 / |s1|, and its time derivative.

References

source
SPICE.dvnorm — Method
dvnorm(state)

Function to calculate the derivative of the norm of a 3-vector.

Arguments

  • state: A 6-vector composed of three coordinates and their derivatives.

Output

Returns the derivative of the norm of state.

References

source
SPICE.dvsep — Method
dvsep(s1, s2)

Calculate the time derivative of the separation angle between two input states, s1 and s2.

Arguments

  • s1: State vector of the first body
  • s2: State vector of the second body

Output

Returns the value of the time derivative of the angular separation between s1 and s2.

References

source
SPICE.edlimb — Method
edlimb(a, b, c, viewpt)

Find the limb of a triaxial ellipsoid, viewed from a specified point.

Arguments

  • a: Length of ellipsoid semi-axis lying on the x-axis
  • b: Length of ellipsoid semi-axis lying on the y-axis
  • c: Length of ellipsoid semi-axis lying on the z-axis
  • viewpt: Location of viewing point

Output

Returns the limb of the ellipsoid as seen from the viewing point.

References

source
SPICE.edterm — Method
edterm(trmtyp, source, target, et, fixref, abcorr, obsrvr, npts)

Compute a set of points on the umbral or penumbral terminator of a specified target body, where the target shape is modeled as an ellipsoid.

Arguments

  • trmtyp: Terminator type
  • source: Light source
  • target: Target body
  • et: Observation epoch
  • fixref: Body-fixed frame associated with target
  • abcorr: Aberration correction
  • obsrvr: Observer
  • npts: Number of points in terminator set

Output

  • trgepc: Epoch associated with target center
  • obspos: Position of observer in body-fixed frame
  • trmpts: Terminator point set

References

source
SPICE.ekacec — Method
ekacec(handle, segno, recno, column, cvals, isnull)

Add data to a character column in a specified EK record.

Arguments

  • handle: EK file handle
  • segno: Index of segment containing record
  • recno: Record to which data is to be added
  • column: Column name
  • cvals: Character values to add to column
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekaced — Method
ekaced(handle, segno, recno, column, dvals, isnull)

Add data to an double precision column in a specified EK record.

Arguments

  • handle: EK file handle
  • segno: Index of segment containing record
  • recno: Record to which data is to be added
  • column: Column name
  • dvals: Double precision values to add to column
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekacei — Method
ekacei(handle, segno, recno, column, ivals, isnull)

Add data to an integer column in a specified EK record.

Arguments

  • handle: EK file handle
  • segno: Index of segment containing record
  • recno: Record to which data is to be added
  • column: Column name
  • ivals: Integer values to add to column
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekaclc — Method
ekaclc(handle, segno, column, cvals, nlflgs, rcptrs)

Add an entire character column to an EK segment.

Arguments

  • handle: EK file handle.
  • segno: Number of segment to add column to.
  • column: Column name.
  • cvals: Character values to add to column.
  • nlflgs: Array of null flags for column entries.
  • rcptrs: Record pointers for segment.

References

source
SPICE.ekacld — Method
ekacld(handle, segno, column, dvals, nlflgs, rcptrs)

Add an entire double precision column to an EK segment.

Arguments

  • handle: EK file handle
  • segno: Number of segment to add column to
  • column: Column name
  • dvals: Double precision values to add to column
  • nlflgs: Array of null flags for column entries
  • rcptrs: Record pointers for segment

References

source
SPICE.ekacli — Method
ekacli(handle, segno, column, ivals, nlflgs, rcptrs)

Add an entire integer column to an EK segment.

Arguments

  • handle: EK file handle
  • segno: Number of segment to add column to
  • column: Column name
  • ivals: Integer values to add to column
  • nlflgs: Array of null flags for column entries
  • rcptrs: Record pointers for segment

References

source
SPICE.ekappr — Method
ekappr(handle, segno)

Append a new, empty record at the end of a specified E-kernel segment.

Arguments

  • handle: File handle
  • segno: Segment number

Output

Returns the number of appended record.

References

source
SPICE.ekbseg — Method
ekbseg(handle, tabnam, cnames, decls)

Start a new segment in an E-kernel.

Arguments

  • handle: File handle
  • tabnam: Table name
  • cnames: Names of columns
  • decls: Declarations of columns

Output

Returns the segment number.

References

source
SPICE.ekccnt — Method
ekccnt(table)

Return the number of distinct columns in a specified, currently loaded table

Arguments

  • table: Name of table

Output

Returns the count of distinct, currently loaded columns.

References

source
SPICE.ekcii — Function
ekcii(table, cindex, lenout=256)

Return attribute information about a column belonging to a loaded EK table, specifying the column by table and index.

Arguments

  • table: Name of table containing column
  • cindex: Index of column whose attributes are to be found
  • lenout: Maximum allowed length of column name (default: 256)

Output

  • column: Name of column
  • attdsc: Column attribute descriptor

References

source
SPICE.ekdelr — Method
ekdelr(handle, segno, recno)

Delete a specified record from a specified E-kernel segment.

Arguments

  • handle: File handle
  • segno: Segment number
  • recno: Record number

References

source
SPICE.ekffld — Method
ekffld(handle, segno, rcptrs)

Complete a fast write operation on a new E-kernel segment.

Arguments

  • handle: File handle
  • segno: Segment number
  • rcptrs: Record pointers

References

source
SPICE.ekfind — Function
ekfind(query, lenout=256)

Find E-kernel data that satisfy a set of constraints.

Arguments

  • query: Query specifying data to be found.
  • lenout: Declared length of output error message string (default: 256)

Output

Returns the number of matching rows.

References

source
SPICE.ekgc — Function
ekgc(selidx, row, elment, lenout=256)

Return an element of an entry in a column of character type in a specified row.

Arguments

  • selidx: Index of parent column in SELECT clause
  • row: Row to fetch from
  • elment: Index of element, within column entry, to fetch
  • lenout: Maximum length of column element (default: 256)

Output

Returns the character string element of column entry or missing if it was null or nothing if the column was not found.

References

source
SPICE.ekgd — Method
ekgd(selidx, row, element)

Return an element of an entry in a column of double precision type in a specified row.

Arguments

  • selidx: Index of parent column in SELECT clause
  • row: Row to fetch from
  • elment: Index of element, within column entry, to fetch

Output

Returns the double precision element of column entry or missing if it was null or nothing if the column was not found.

References

source
SPICE.ekgi — Method
ekgi(selidx, row, element)

Return an element of an entry in a column of integer type in a specified row.

Arguments

  • selidx: Index of parent column in SELECT clause
  • row: Row to fetch from
  • elment: Index of element, within column entry, to fetch

Output

Returns the integer element of column entry or missing if it was null or nothing if the column was not found.

References

source
SPICE.ekifld — Method
ekifld(handle, tabnam, nrows, cnames, decls)

Initialize a new E-kernel segment to allow fast writing.

Arguments

  • handle: File handle
  • tabnam: Table name
  • nrows: Number of rows in the segment
  • cnames: Names of columns
  • decls: Declarations of columns

Output

  • segno: Segment number
  • rcptrs: Array of record pointers

References

source
SPICE.ekinsr — Method
ekinsr(handle, segno, recno)

Add a new, empty record to a specified E-kernel segment at a specified index.

Arguments

  • handle: File handle
  • segno: Segment number
  • recno: Record number

References

source
SPICE.eklef — Method
eklef(fname)

Load an EK file, making it accessible to the EK readers.

Arguments

  • fname: Name of EK file to load

Output

Returns the file handle of loaded EK file.

References

source
SPICE.eknelt — Method
eknelt(selidx, row)

Return the number of elements in a specified column entry in the current row.

Arguments

  • selidx: Index of parent column in SELECT clause
  • row: Row containing element

Output

Returns the number of elements in entry in current row.

References

source
SPICE.eknseg — Method
eknseg(handle)

Return the number of segments in a specified EK.

Arguments

  • handle: EK file handle

Output

Returns the number of segments in the specified E-kernel.

References

source
SPICE.ekopn — Method
ekopn(fname, ifname, ncomch)

Open a new E-kernel file and prepare the file for writing.

Arguments

  • fname: Name of EK file
  • ifname: Internal file name
  • ncomch: The number of characters to reserve for comments

Output

Return the handle attached to the new EK file.

References

source
SPICE.ekopr — Method
ekopr(fname)

Open an existing E-kernel file for reading.

Arguments

  • fname: Name of EK file

Output

Returns the handle attached to the EK file.

References

source
SPICE.ekops — Method
ekops()

Open a scratch (temporary) E-kernel file and prepare the file for writing.

Output

Returns the handle attached to the EK file.

References

source
SPICE.ekopw — Method
ekopw(fname)

Open an existing E-kernel file for writing.

Arguments

  • fname: Name of EK file

Output

Returns the handle attached to the EK file.

References

source
SPICE.ekpsel — Function
ekpsel(query, msglen=256, tablen=256, collen=256)

Parse the SELECT clause of an EK query, returning full particulars concerning each selected item.

Arguments

  • query: EK query
  • msglen: Available space in the output error message string (default: 256)
  • tablen: Length of strings in `tabs' output array (default: 256)
  • collen: Length of strings in `cols' output array (default: 256)

Output

  • xbegs: Begin positions of expressions in SELECT clause
  • xends: End positions of expressions in SELECT clause
  • xtypes: Data types of expressions
  • xclass: Classes of expressions
  • tabs: Names of tables qualifying SELECT columns
  • cols: Names of columns in SELECT clause of query

References

source
SPICE.ekrcec — Function
ekrcec(handle, segno, recno, column, lenout=256, nelts=100)

Read data from a character column in a specified EK record.

Arguments

  • handle: Handle attached to EK file
  • segno: Index of segment containing record
  • recno: Record from which data is to be read
  • column: Column name
  • lenout: Maximum length of output strings
  • nelts: Maximum number of elements to return (default: 100)

Output

Returns the character values in column entry or missing if they are null.

References

source
SPICE.ekrced — Function
ekrced(handle, segno, recno, column, nelts=100)

Read data from a double precision column in a specified EK record.

Arguments

  • handle: Handle attached to EK file
  • segno: Index of segment containing record
  • recno: Record from which data is to be read
  • column: Column name
  • nelts: Maximum number of elements to return (default: 100)

Output

Returns the values in column entry.

References

source
SPICE.ekrcei — Function
ekrcei(handle, segno, recno, column, nelts=100)

Read data from an integer column in a specified EK record.

Arguments

  • handle: Handle attached to EK file
  • segno: Index of segment containing record
  • recno: Record from which data is to be read
  • column: Column name
  • nelts: Maximum number of elements to return (default: 100)

Output

Returns the values in column entry.

References

source
SPICE.ekssum — Method
ekssum(handle, segno)

Return summary information for a specified segment in a specified EK.

Arguments

  • handle: Handle of EK
  • segno: Number of segment to be summarized

Output

Returns the EK segment summary.

References

source
SPICE.ektnam — Function
ektnam(n, lenout=256)

Return the name of a specified, loaded table.

Arguments

  • n: Index of table
  • lenout: Maximum table name length (default: 256)

Output

Returns the name of table.

References

source
SPICE.ekucec — Method
ekucec(handle, segno, recno, column, cvals, isnull)

Update a character column entry in a specified EK record.

Arguments

  • handle: EK file handle
  • segno: Index of segment containing record
  • recno: Record to which data is to be updated
  • column: Column name
  • cvals: Character values comprising new column entry
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekuced — Method
ekuced(handle, segno, recno, column, dvals, isnull)

Update a double precision column entry in a specified EK record.

Arguments

  • handle: Handle attached to EK file
  • segno: Index of segment containing record
  • recno: Record in which entry is to be updated
  • column: Column name
  • dvals: Double precision values comprising new column entry
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekucei — Method
ekucei(handle, segno, recno, column, dvals, isnull)

Update an integer column entry in a specified EK record.

Arguments

  • handle: Handle attached to EK file
  • segno: Index of segment containing record
  • recno: Record in which entry is to be updated
  • column: Column name
  • ivals: Integer values comprising new column entry
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekuef — Method
ekuef(handle)

Unload an EK file, making its contents inaccessible to the EK reader routines, and clearing space in order to allow other EK files to be loaded.

Arguments

  • handle: Handle of EK file

References

source
SPICE.el2cgv — Method

Convert an ellipse to a center vector and two generating vectors. The selected generating vectors are semi-axes of the ellipse.

Arguments

  • ellipse: An ellipse

Output

Returns the center and semi-axes of ellipse.

References

source
SPICE.elemc — Function
elem[c/d/i](item, cell)
Deprecated

Use item in cell instead.

source
SPICE.eqncpv — Method
eqncpv(et, epoch, eqel, rapol, decpol)

Compute the state (position and velocity of an object whose trajectory is described via equinoctial elements relative to some fixed plane (usually the equatorial plane of some planet).

Arguments

  • et: Epoch in seconds past J2000 to find state
  • epoch: Epoch of elements in seconds past J2000
  • eqel: Array of equinoctial elements
  • rapol: Right Ascension of the pole of the reference plane
  • decpol: Declination of the pole of the reference plane

Output

Returns the state of the object described by eqel.

References

source
SPICE.eqstr — Method
eqstr(a, b)

Determine whether two strings are equivalent.

Arguments

  • a, b: Arbitrary character strings

Output

Returns true if a and b are equivalent.

References

source
SPICE.esrchc — Method
esrchc(value, array)

Search for a given value within a character string array.

Arguments

  • value: Key value to be found in array
  • array: Character string array to search

Output

Returns the index of the first equivalent array entry, or -1 if no equivalent element is found.

References

source
SPICE.et2lst — Function
et2lst(et, body, lon, typ, timlen=128, ampmlen=128)

Given an ephemeris epoch, compute the local solar time for an object on the surface of a body at a specified longitude.

Arguments

  • et: Epoch in seconds past J2000 epoch
  • body: ID-code of the body of interest
  • lon: Longitude of surface point (radians)
  • typ: Type of longitude "PLANETOCENTRIC", etc
  • timlen: Available room in output time string (default: 128)
  • ampmlen: Available room in output `ampm' string (default: 128)

Output

  • hr: Local hour on a "24 hour" clock
  • mn: Minutes past the hour
  • sc: Seconds past the minute
  • time: String giving local time on 24 hour clock
  • ampm: String giving time on A.M./ P.M. scale

References

source
SPICE.et2utc — Method
et2utc(et, format, prec)

Convert an input time from ephemeris seconds past J2000 to Calendar, Day-of-Year, or Julian Date format, UTC.

Arguments

  • et: Input epoch, given in ephemeris seconds past J2000
  • format: Format of output epoch. It may be any of the following:
    • :C: Calendar format, UTC
    • :D: Day-of-Year format, UTC
    • :J: Julian Date format, UTC
    • :ISOC: ISO Calendar format, UTC
    • :ISOD: ISO Day-of-Year format, UTC
  • prec: Digits of precision in fractional seconds or days

Output

Returns an output time string equivalent to the input epoch, in the specified format.

References

source
SPICE.etcal — Function
etcal(et, lenout=128)

Convert from an ephemeris epoch measured in seconds past the epoch of J2000 to a calendar string format using a formal calendar free of leapseconds.

Arguments

  • et: Ephemeris time measured in seconds past J2000
  • lenout: Length of output string (default: 128)

Output

Returns a standard calendar representation of et.

References

source
SPICE.eul2m — Method
eul2m(angle3, angle2, angle1, axis3, axis2, axis1)

Construct a rotation matrix from a set of Euler angles.

Arguments

  • angle3, angle2, angle1: Rotation angles about third, second, and first rotation axes (radians)
  • axis3, axis2, axis1: Axis numbers of third, second, and first rotation axes

Output

A rotation matrix corresponding to the product of the 3 rotations.

References

source
SPICE.eul2xf — Method
eul2xf(eulang, axisa, axisb, axisc)

Compute a state transformation from an Euler angle factorization of a rotation and the derivatives of those Euler angles.

Arguments

  • eulang: An array of Euler angles and their derivatives
  • axisa: Axis A of the Euler angle factorization
  • axisb: Axis B of the Euler angle factorization
  • axisc: Axis C of the Euler angle factorization

Output

Returns a state transformation matrix.

References

source
SPICE.expool — Method
expool(name)

Confirm the existence of a kernel variable in the kernel pool.

Arguments

  • name: Name of the variable whose value is to be returned

Output

Returns true when the variable is in the pool.

References

source
SPICE.fovray — Method
fovray(inst, raydir, rframe, abcorr, observer, et)

Determine if a specified ray is within the field-of-view (FOV) of a specified instrument at a given time.

Arguments

  • inst: Name or ID code string of the instrument
  • raydir: Ray's direction vector
  • rframe: Body-fixed, body-centered frame for target body
  • abcorr: Aberration correction flag
  • observer: Name or ID code string of the observer
  • et: Time of the observation (seconds past J2000)

Output

Returns true if the ray is visible.

References

source
SPICE.fovtrg — Method
fovtrg(inst, target, tshape, tframe, abcorr, obsrvr, et)

Determine if a specified ephemeris object is within the field-of-view (FOV) of a specified instrument at a given time.

Arguments

  • inst: Name or ID code string of the instrument.
  • target: Name or ID code string of the target.
  • tshape: Type of shape model used for the target.
  • tframe: Body-fixed, body-centered frame for target body.
  • abcorr: Aberration correction flag.
  • obsrvr: Name or ID code string of the observer.
  • et: Time of the observation (seconds past J2000).

Output

Returns true if the object is visible.

References

source
SPICE.frame — Method
frame(x)

Given a vector x, this routine builds a right handed orthonormal frame x, y, z where the output x is parallel to the input x.

Arguments

  • x: Input vector

Output

  • x: Unit vector parallel to x on output
  • y: Unit vector in the plane orthogonal to x
  • z: Unit vector given by x × y

References

source
SPICE.frinfo — Method
frinfo(frcode)

Retrieve the minimal attributes associated with a frame needed for converting transformations to and from it.

Arguments

  • frcode: The id code for a reference frame

Output

  • cent: The center of the frame
  • frclss: The class (type) of the frame
  • clssid: The idcode for the frame within its class

Returns nothing if no frame with id frcode could be found.

References

source
SPICE.frmnam — Method
frmnam(frcode)

Retrieve the name of a reference frame associated with an id code.

Arguments

  • frcode: The id code for a reference frame

Output

Returns the name associated with the reference frame.

References

source
SPICE.gcpool — Method
gcpool(name; start=1, room=100, lenout=128)

Return the value of a kernel variable from the kernel pool.

Arguments

  • name: Name of the variable whose value is to be returned
  • start: Which component to start retrieving for name (default: 1)
  • room: The largest number of values to return (default: 100)
  • lenout: The length of the longest string to return (default: 128)

Output

Returns an array of values if the variable exists or nothing if not.

References

source
SPICE.gdpool — Method
gdpool(name; start=1, room=100)

Return the value of a kernel variable from the kernel pool.

Arguments

  • name: Name of the variable whose value is to be returned
  • start: Which component to start retrieving for name (default: 1)
  • room: The largest number of values to return (default: 100)

Output

Returns an array of values if the variable exists or nothing if not.

References

source
SPICE.georec — Method
georec(lon, lat, alt, re, f)

Convert geodetic coordinates to rectangular coordinates.

Arguments

  • lon: Geodetic longitude of point (radians)
  • lat: Geodetic latitude of point (radians)
  • alt: Altitude of point above the reference spheroid
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

Returns the rectangular coordinates of point.

References

source
SPICE.getelm — Method
getelm(frstyr, lines)

Given the "lines" of a two-line element set, parse the lines and return the elements in units suitable for use in SPICE software.

Arguments

  • frstyr: Year of earliest representable two-line elements
  • lines: A pair of "lines" containing two-line elements

Output

  • epoch: The epoch of the elements in seconds past J2000
  • elems: The elements converted to SPICE units

References

source
SPICE.getfat — Function
getfat(file, arclen=10, typlen=10)

Determine the file architecture and file type of most SPICE kernel files.

Arguments

  • file: The name of a file to be examined
  • arclen: Maximum length of output architecture string (default: 10)
  • typlen: Maximum length of output type string (default: 10)

Output

  • arch: The architecture of the kernel file
  • typ: The type of the kernel file

References

source
SPICE.getfov — Function
getfov(instid, room=10, shapelen=128, framelen=128)

Return the field-of-view (FOV) parameters for a specified instrument. The instrument is specified by its NAIF ID code.

Arguments

  • instid: NAIF ID of an instrument
  • room: Maximum number of vectors that can be returned (default: 10)
  • shapelen: Space available in the string shape (default: 128)
  • framelen: Space available in the string frame (default: 128)

Output

Returns a tuple consisting of

  • shape: Instrument FOV shape
  • frame: Name of the frame in which FOV vectors are defined
  • bsight: Boresight vector
  • bounds: FOV boundary vectors

References

source
SPICE.gfdist — Method
gfdist(target, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)

Return the time window over which a specified constraint on observer-target distance is met.

Arguments

  • target: Name of the target body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • relate: Relational operator
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is confined

Output

Returns a window containing the results.

References

source
SPICE.gfevnt — Method
gfevnt(udstep, udrefn, gquant, qnpars, lenvals, qpnams, qcpars, qdpars, qipars, qlpars,
-       op, refval, tol, adjust, rpt, udrepi, udrepu, udrepf, nintvls, bail, udbail, cnfine)

Determine time intervals when a specified geometric quantity satisfies a specified mathematical condition.

Arguments

  • udstep: Name of the routine that computes and returns a time step
  • udrefn: Name of the routine that computes a refined time
  • gquant: Type of geometric quantity
  • qpnams: Names of quantity definition parameters
  • qcpars: Array of character quantity definition parameters
  • qdpars: Array of double precision quantity definition parameters
  • qipars: Array of integer quantity definition parameters
  • qlpars: Array of logical quantity definition parameters
  • op: Operator that either looks for an extreme value (max, min, local, absolute) or compares the geometric quantity value and a number
  • refval: Reference value
  • tol: Convergence tolerance in second
  • adjust: Absolute extremum adjustment value
  • rpt: Progress reporter on (true) or off (false)
  • udrepi: Function that initializes progress reporting
  • udrepu: Function that updates the progress report
  • udrepf: Function that finalizes progress reporting
  • nintvls: Workspace window interval coun
  • cnfine: SPICE window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gffove! — Method
gffove!(inst, tshape, raydir, target, tframe, abcorr, obsrvr, tol, udstep, udrefn,
-            rpt, udrepi, udrepu, udrepf, cnfine, result)

Determine time intervals when a specified target body or ray intersects the space bounded by the field-of-view (FOV) of a specified instrument.

Arguments

  • inst: Name of the instrument
  • tshape: Type of shape model used for target body
  • raydir: Ray's direction vector
  • target: Name of the target body
  • tframe: Body-fixed, body-centered frame for target body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • tol: Convergence tolerance in seconds
  • udstep: Name of the routine returns a time step
  • udrefn: Name of the routine that computes a refined time
  • rpt: Progress report flag
  • udrepi: Function that initializes progress reporting
  • udrepu: Function that updates the progress report
  • udrepf: Function that finalizes progress reporting
  • cnfine: SPICE window to which the search is restricted
  • result: Window containing the results

Output

Returns result.

References

source
SPICE.gfilum — Method
gfilum(method, angtyp, target, illmn, fixref, abcorr, obsrvr, spoint, relate, refval,
-       adjust, step, nintvls, cnfine)

Return the time window over which a specified constraint on the observed phase, solar incidence, or emission angle at a specifed target body surface point is met.

Arguments

  • method: Computation method
  • angtyp: Type of illumination angle
  • target: Name of the target body
  • illmn: Name of the illumination source
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • spoint: Body-fixed coordinates of a target surface point
  • relate: Relational operator
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is confined

Output

Returns a window containing the results.

References

source
SPICE.gfocce! — Method
function gfocce!(occtyp, front, fshape, fframe, back, bshape, bframe, abcorr, obsrvr, tol,
-    udstep, udrefn, rpt, udrepi, udrepu, udrepf, cnfine, result)

Determine time intervals when an observer sees one target occulted by another.

Arguments

  • occtyp: Type of occultation
  • front: Name of body occulting the other
  • fshape: Type of shape model used for front body
  • fframe: Body-fixed, body-centered frame for front body
  • back: Name of body occulted by the other
  • bshape: Type of shape model used for back body
  • bframe: Body-fixed, body-centered frame for back body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • tol: Convergence tolerance in seconds
  • udstep: Name of the routine that returns a time step
  • udrefn: Name of the routine that computes a refined time
  • rpt: Progress report flag
  • udrepi: Function that initializes progress reporting
  • udrepu: Function that updates the progress report
  • udrepf: Function that finalizes progress reporting
  • cnfine: SPICE window to which the search is restricted
  • result: SPICE window containing results

Output

Returns result.

References

source
SPICE.gfoclt — Function
gfoclt(occtyp, front, fshape, fframe, back, bshape, bframe, abcorr, obsrvr, step, cnfine,
-       maxwin=100)

Determine time intervals when an observer sees one target occulted by, or in transit across, another.

The surfaces of the target bodies may be represented by triaxial ellipsoids or by topographic data provided by DSK files.

Arguments

  • occtyp: Type of occultation
  • front: Name of body occulting the other
  • fshape: Type of shape model used for front body
  • fframe: Body-fixed, body-centered frame for front body
  • back: Name of body occulted by the other
  • bshape: Type of shape model used for back body
  • bframe: Body-fixed, body-centered frame for back body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • step: Step size in seconds for finding occultation events
  • cnfine: Window to which the search is restricted
  • maxwin: Maximum size of the output window (default: 100)

Output

Returns a window containing the results.

References

source
SPICE.gfpa — Method
gfpa(result, target, illmn, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)

Determine time intervals for which a specified constraint on the phase angle between an illumination source, a target, and observer body centers is met.

Arguments

  • target: Name of the target body
  • illmn: Name of the illuminating body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • relate: Relational operator
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is confined

Output

Returns a window containing the results.

References

source
SPICE.gfposc — Method
gfposc(target, frame, abcorr, obsrvr, crdsys, coord, relate, refval, adjust, step,
-       nintvls, cnfine)

Determine time intervals for which a coordinate of an observer-target position vector satisfies a numerical constraint.

Arguments

  • target: Name of the target body
  • frame: Name of the reference frame for coordinate calculations
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • crdsys: Name of the coordinate system containing coord
  • coord: Name of the coordinate of interest
  • relate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gfrefn — Method
gfrefn(t1, t2, s1, s2)

For those times when we can't do better, we use a bisection method to find the next time at which to test for state change.

Arguments

  • t1: One of two values bracketing a state change
  • t2: The other value that brackets a state change
  • s1: State at t1
  • s2: State at t2

Output

Returns the new value at which to check for transition.

References

source
SPICE.gfrepi — Method
gfrepi(window, begmss, endmss)

Initialize a search progress report.

Arguments

  • window: A window over which a job is to be performed
  • begmss: Beginning of the text portion of the output message
  • endmss: End of the text portion of the output message

References

source
SPICE.gfrepu — Method
gfrepu(ivbeg, ivend, time)

Tell the progress reporting system how far a search has progressed.

Arguments

  • ivbeg: Start time of work interval
  • ivend: End time of work interval
  • time: Current time being examined in the search process

References

source
SPICE.gfrfov — Function
gfrfov(inst, raydir, rframe, abcorr, obsrvr, step, cnfine, maxwin=10000)

Determine time intervals when a specified ray intersects the space bounded by the field-of-view (FOV) of a specified instrument.

Arguments

  • inst: Name of the instrument
  • raydir: Ray's direction vector
  • rframe: Reference frame of ray's direction vector
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • step: Step size in seconds for finding FOV events
  • cnfine: SPICE window to which the search is restricted
  • maxwin: Maximum length of the output window (default: 10000)

Output

Returns a window containing the results.

References

source
SPICE.gfrr — Method
gfrr(target, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)

Determine time intervals for which a specified constraint on the observer-target range rate is met.

Arguments

  • target: Name of the target body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • relate: Relational operator
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is confined

Output

Returns a window containing the results.

References

source
SPICE.gfsep — Method

Determine time intervals when the angular separation between the position vectors of two target bodies relative to an observer satisfies a numerical relationship.

Arguments

  • targ1: Name of first body
  • shape1: Name of shape model describing the first body
  • frame1: The body-fixed reference frame of the first body
  • targ2: Name of second body
  • shape2: Name of the shape model describing the second body
  • frame2: The body-fixed reference frame of the second body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • relate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the angular separation value and refval
  • refval: Reference value
  • adjust: Absolute extremum adjustment value
  • step: Step size in seconds for finding angular separation events
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gfsntc — Method
gfsntc(target, fixref, method, abcorr, obsrvr, dref, dvec, crdsys, coord, relate, refval,
-       adjust, step, nintvls, cnfine)

Determine time intervals for which a coordinate of an surface intercept position vector satisfies a numerical constraint.

Arguments

  • target: Name of the target body
  • fixref: Body fixed frame associated with target
  • method: Name of method type for surface intercept calculation
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • dref: Reference frame of direction vector dvec
  • dvec: Pointing direction vector from obsrvr
  • crdsys: Name of the coordinate system containing COORD
  • coord: Name of the coordinate of interest
  • relate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gfstol — Method
gfstol(value)

Override the default GF convergence value used in the high level GF routines.

Arguments

  • value: Double precision value returned or to store

References

source
SPICE.gfsubc — Method
gfsubc(target, fixref, method, abcorr, obsrvr, crdsys, coord, relate, refval, adjust, step,
-       nintvls, cnfine)

Determine time intervals for which a coordinate of an subpoint position vector satisfies a numerical constraint.

Arguments

  • target: Name of the target body
  • fixref: Body fixed frame associated with target
  • method: Name of method type for subpoint calculation
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • crdsys: Name of the coordinate system containing coord
  • coord: Name of the coordinate of interest
  • relate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gftfov — Method
gftfov(inst, target, tshape, tframe, abcorr, obsrvr, step, nintvls, cnfine)

Determine time intervals when a specified ephemeris object intersects the space bounded by the field-of-view (FOV) of a specified instrument.

Arguments

  • inst: Name of the instrument
  • target: Name of the target body
  • tshape: Type of shape model used for target body
  • tframe: Body-fixed, body-centered frame for target body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • step: Step size in seconds for finding FOV events
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gfudb! — Method
gfudb!(udfuns, udfunb, step, cnfine, result)

Perform a GF search on a user defined boolean quantity.

Arguments

  • udfuns: Name of the routine that computes a scalar quantity of interest corresponding to an et, e.g. f(et) = ...
  • udfunb: Name of the routine returning the boolean value corresponding to an et, e.g. g(f, et) = ...
  • step: Step size used for locating extrema and roots
  • cnfine: Window to which the search is restricted
  • result: Window containing results

Output

Returns result.

References

source
SPICE.gfuds! — Method
gfuds!(udfuns, udqdec, relate, refval, adjust, step, nintvls, cnfine, result)

Perform a GF search on a user defined scalar quantity.

Arguments

  • udfuns: Name of the routine that computes the scalar quantity of interest at some time, e.g. f(et) = ...
  • udqdec: Name of the routine that computes whether the scalar quantity is decreasing, e.g. g(f, et) = ...
  • relate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the geometric quantity value and a number
  • refval: Value used as reference for scalar quantity condition
  • adjust: Allowed variation for absolute extremal geometric conditions
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: SPICE window to which the search is restricted
  • result: SPICE window containing results

Output

Returns result.

References

source
SPICE.gipool — Method
gipool(name; start=1, room=100)

Return the value of a kernel variable from the kernel pool.

Arguments

  • name: Name of the variable whose value is to be returned
  • start: Which component to start retrieving for name (default: 1)
  • room: The largest number of values to return (default: 100)

Output

Returns an array of values if the variable exists or nothing if not.

References

source
SPICE.gnpool — Function
gnpool(name, start, room, lenout=128)

Return names of kernel variables matching a specified template.

Arguments

  • name: Template that names should match
  • start: Index of first matching name to retrieve
  • room: The largest number of values to return
  • lenout: Length of strings in output array kvars (default: 128)

Output

Returns lernel pool variables whose names match name.

References

source
SPICE.hrmint — Method
hrmint(xvals, yvals, x)

Evaluate a Hermite interpolating polynomial at a specified abscissa value.

Arguments

  • xvals: Abscissa values
  • yvals: Ordinate and derivative values
  • x: Point at which to interpolate the polynomial

Output

  • f: Interpolated function value at x
  • df: Interpolated function's derivative at x

References

source
SPICE.hx2dp — Method
hx2dp(str)

Convert a string representing a double precision number in a base 16 "scientific notation" into its equivalent double precision number.

Arguments

  • str: Hex form string to convert to double precision

Output

  • dp: Double precision value to be returned

References

source
SPICE.illumf — Method
illumf(method, target, ilusrc, et, fixref, abcorr, obsrvr, spoint)

Compute the illumination angles - phase, incidence, and emission - at a specified point on a target body. Return logical flags indicating whether the surface point is visible from the observer's position and whether the surface point is illuminated.

The target body's surface is represented using topographic data provided by DSK files, or by a reference ellipsoid.

The illumination source is a specified ephemeris object.

Arguments

  • method: Computation method
  • target: Name of target body
  • ilusrc: Name of illumination source
  • et: Epoch in TDB seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction flag
  • obsrvr: Name of observing body
  • spoint: Body-fixed coordinates of a target surface point

Output

  • trgepc: Target surface point epoch
  • srfvec: Vector from observer to target surface point
  • phase: Phase angle at the surface point
  • incdnc: Source incidence angle at the surface point
  • emissn: Emission angle at the surface point
  • visibl: Visibility flag (true if visible)
  • lit: Illumination flag (true if illuminated)

References

source
SPICE.illumg — Method
illumg(method, target, ilusrc, et, fixref, obsrvr, spoint, abcorr)

Find the illumination angles (phase, incidence, and emission) at a specified surface point of a target body.

The surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.

The illumination source is a specified ephemeris object.

Arguments

  • method: Computation method.
  • target: Name of target body.
  • ilusrc: Name of illumination source.
  • et: Epoch in ephemeris seconds past J2000 TDB.
  • fixref: Body-fixed, body-centered target body frame.
  • obsrvr: Name of observing body.
  • spoint: Body-fixed coordinates of a target surface point.
  • abcorr: Aberration correction.

Output

  • trgepc: Sub-solar point epoch.
  • srfvec: Vector from observer to sub-solar point.
  • phase: Phase angle at the surface point.
  • incdnc: Solar incidence angle at the surface point.
  • emissn: Emission angle at the surface point.

References

source
SPICE.ilumin — Method
ilumin(method, target, et, fixref, obsrvr, spoint, abcorr)

Find the illumination angles (phase, solar incidence, and emission) at a specified surface point of a target body.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in ephemeris seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • obsrvr: Name of observing body
  • spoint: Body-fixed coordinates of a target surface point
  • abcorr: Aberration correction

Output

  • trgepc: Sub-solar point epoch
  • srfvec: Vector from observer to sub-solar point
  • phase: Phase angle at the surface point
  • incdnc: Solar incidence angle at the surface point
  • emissn: Emission angle at the surface point

References

source
SPICE.inedpl — Method
inedpl(a, b, c, plane)

Find the intersection of a triaxial ellipsoid and a plane.

Arguments

  • a: Length of ellipsoid semi-axis lying on the x-axis
  • b: Length of ellipsoid semi-axis lying on the y-axis
  • c: Length of ellipsoid semi-axis lying on the z-axis
  • plane: Plane that intersects ellipsoid

Output

  • ellipse: Intersection ellipse

Returns nothing if no ellipse could be found.

References

source
SPICE.inelpl — Method
inelpl(ellips, plane)

Find the intersection of an ellipse and a plane.

Arguments

  • ellips: An ellipse
  • plane: A plane

Output

  • nxpts: Number of intersection points of ellipse and plane
  • xpt1, xpt2: Intersection points

References

source
SPICE.inrypl — Method
inrypl(vertex, dir, plane)

Find the intersection of a ray and a plane.

Arguments

  • vertex, dir: Vertex and direction vector of ray
  • plane: A plane

Output

  • nxpts: Number of intersection points of ray and plane
  • xpt1, xpt2: Intersection points

References

source
SPICE.insrtc! — Method
insrtc!(set, item)

Insert an item into a character set.

Arguments

  • set: Insertion set
  • item: Item to be inserted

Output

Returns the updated set.

References

source
SPICE.insrtd! — Method
insrtd!(set, item)

Insert an item into a double set.

Arguments

  • set: Insertion set
  • item: Item to be inserted

Output

Returns the updated set.

References

source
SPICE.insrti! — Method
insrti!(set, item)

Insert an item into an integer set.

Arguments

  • set: Insertion set
  • item: Item to be inserted

Output

Returns the updated set.

References

source
SPICE.inter — Method
inter(a, b)

Intersect two sets of any data type to form a third set.

Arguments

  • a: First input set
  • b: Second input set

Output

Returns intersection of a and b.

References

source
SPICE.isrchc — Function
isrchc(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.isrchd — Function
isrchd(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.isrchi — Function
isrchi(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.isrot — Method
isrot(m, ntol, dtol)

Indicate whether a 3x3 matrix is a rotation matrix.

Arguments

  • m: A matrix to be tested
  • ntol: Tolerance for the norms of the columns of m
  • dtol: Tolerance for the determinant of a matrix whose columns are the unitized columns of m

Output

Returns true if m is a rotation matrix.

References

source
SPICE.kclear — Method
kclear()

Clear the KEEPER subsystem: unload all kernels, clear the kernel pool, and re-initialize the subsystem. Existing watches on kernel variables are retained.

References

source
SPICE.kdata — Function
kdata(which, kind, fillen=1024, srclen=256)

Return data for the n-th kernel that is among a list of specified kernel types.

Arguments

  • which: Index of kernel to fetch from the list of kernels
  • kind: The kind of kernel to which fetches are limited
  • fillen: Available space in output file string
  • srclen: Available space in output source string

Output

Returns nothing if no kernel was found or a tuple consisting of

  • file: The name of the kernel file
  • filtyp: The type of the kernel
  • source: Name of the source file used to load file
  • handle: The handle attached to file

References

source
SPICE.kinfo — Function
kinfo(file, srclen=256)

Arguments

  • file: Name of a kernel to fetch information for
  • srclen: Available space in output source string

Output

Returns nothing if no kernel was found or a tuple consisting of

  • filtyp: The type of the kernel
  • source: Name of the source file used to load file
  • handle: The handle attached to file

References

source
SPICE.kplfrm — Function
kplfrm(frmcls)

Return a SPICE set containing the frame IDs of all reference frames of a given class having specifications in the kernel pool.

Arguments

  • frmcls: Frame class
  • size: Size of the output set

Output

Returns the set of ID codes of frames of the specified class.

References

source
SPICE.ktotal — Method
ktotal(kind)

Return the current number of kernels that have been loaded via the KEEPER interface that are of a specified type.

References

source
SPICE.kxtrct — Function
kxtrct(keywd, terms, string)

Locate a keyword in a string and extract the substring from the beginning of the first word following the keyword to the beginning of the first subsequent recognized terminator of a list.

Arguments

  • keywd: Word that marks the beginning of text of interest
  • terms: Set of words, any of which marks the end of text
  • string: String containing a sequence of words

Output

Returns nothing if keywd was found or a tuple consisting of

  • string: The input string with the text of interest removed
  • substr: String from end of keywd to beginning of first terms item found

References

source
SPICE.lastnb — Function
lastnb(str)
Deprecated

Use findprev(!isspace, str, length(str)) instead.

source
SPICE.latcyl — Method
latcyl(radius, lon, lat)

Convert from latitudinal coordinates to cylindrical coordinates.

Arguments

  • radius: Distance of a point from the origin
  • lon: Angle of the point from the XZ plane in radians
  • lat: Angle of the point from the XY plane in radians

Output

Return the tuple (r, lonc, z).

  • r: Distance of the point from the z axis
  • lonc: Angle of the point from the XZ plane in radians. 'lonc' is set equal to 'lon'
  • z: Height of the point above the XY plane

References

source
SPICE.latrec — Method
latrec(radius, lon, lat)

Convert from latitudinal coordinates to rectangular coordinates.

Arguments

  • radius: Distance of a point from the origin
  • lon: Angle of the point from the XZ plane in radians
  • lat: Angle of the point from the XY plane in radians

Output

Return the rectangular coordinates vector of the point.

References

source
SPICE.latsph — Method
latsph(radius, lon, lat)

Convert from latitudinal coordinates to spherical coordinates.

Arguments

  • radius: Distance of a point from the origin
  • lon: Angle of the point from the XZ plane in radians
  • lat: Angle of the point from the XY plane in radians

Output

Return the tuple (rho, colat, lons).

  • rho: Distance of the point from the origin
  • colat: Angle of the point from positive z axis (radians)
  • lons: Angle of the point from the XZ plane (radians)

References

source
SPICE.latsrf — Method
latsrf(method, target, et, fixref, npts, lonlat)

Map array of planetocentric longitude/latitude coordinate pairs to surface points on a specified target body.

The surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in TDB seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • lonlat: Array of longitude/latitude coordinate pairs

Output

Returns an array of surface points.

References

source
SPICE.ldpool — Method

ldpool(kernel)

Load the variables contained in a NAIF ASCII kernel file into the kernel pool.

Arguments

  • kernel: Name of the kernel file

Output

None

References

source
SPICE.lgrind — Method
lgrind(xvals, yvals, x)

Evaluate a Lagrange interpolating polynomial for a specified set of coordinate pairs, at a specified abscissa value. Return the value of both polynomial and derivative.

Arguments

  • xvals: Abscissa values of coordinate pairs
  • yvals: Ordinate values of coordinate pairs
  • x: Point at which to interpolate the polynomial

Output

  • p: The value at x of the unique polynomial of degree n-1 that fits the points in the plane defined by xvals and yvals
  • dp: The derivative at x of the interpolating polynomial described above

References

source
SPICE.limbpt — Method
limbpt(method, target, et, fixref, abcorr, corloc, obsrvr, refvec, rolstp, ncuts, schstp,
-       soltol, maxn)

Find limb points on a target body. The limb is the set of points of tangency on the target of rays emanating from the observer. The caller specifies half-planes bounded by the observer-target center vector in which to search for limb points.

The surface of the target body may be represented either by a triaxial ellipsoid or by topographic data.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in ephemeris seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction
  • corloc: Aberration correction locus
  • obsrvr: Name of observing body
  • refvec: Reference vector for cutting half-planes
  • rolstp: Roll angular step for cutting half-planes
  • ncuts: Number of cutting half-planes
  • schstp: Angular step size for searching
  • soltol: Solution convergence tolerance
  • maxn: Maximum number of entries in output arrays

Output

Returns the tuple (npts, points, epochs, tangts).

  • npts: Counts of limb points corresponding to cuts
  • points: Limb points
  • epochs: Times associated with limb points
  • tangts: Tangent vectors emanating from the observer

References

source
SPICE.lmpool — Method

lmpool(cvals)

Load the variables contained in an internal buffer into the kernel pool.

Arguments

  • cvals: An array that contains a SPICE text kernel

References

source
SPICE.lparse — Function

lparse(list, delim, nmax)

Deprecated

Use split(list, delim, limit=nmax) instead.

source
SPICE.lparsm — Function

lparsm(list, delims, nmax)

Deprecated

Use split(list, delim, limit=nmax, keepempty=false) instead.

source
SPICE.lparss — Function

lparss(list, delims)

Deprecated

Use Set(split(list, collect(delim))) instead.

source
SPICE.lspcn — Method

lspcn(body, et, abcorr)

Compute L_s, the planetocentric longitude of the sun, as seen from a specified body.

Arguments

  • body: Name of the central body
  • et: Epoch in seconds past J2000 TDB
  • abcorr: Aberration correction

Output

Returns the planetocentric longitude of the sun for the specified body at the specified time in radians.

References

source
SPICE.lstlec — Function
lstlecd(x, array)
Deprecated

Use findfirst(item .<= array) instead.

source
SPICE.lstled — Function
lstle[di](x, array)
Deprecated

Use searchsortedlast(array, x) instead.

source
SPICE.lstltc — Function
lstltcd(x, array)
Deprecated

Use findfirst(item .< array) instead.

source
SPICE.lstltd — Function
lstlt[di](x, array)
Deprecated

Use searchsortedlast(array, x, lt=<=) instead.

source
SPICE.ltime — Method
ltime(etobs, obs, dir, targ)

This routine computes the transmit (or receive) time of a signal at a specified target, given the receive (or transmit) time at a specified observer. The elapsed time between transmit and receive is also returned.

Arguments

  • etobs: Epoch of a signal at some observer
  • obs: NAIF ID of some observer
  • dir: Direction the signal travels ( "->" or "<-" )
  • targ: Time between transmit and receipt of the signal

Output

  • ettarg: Epoch of the signal at the target
  • obs: NAIF ID of some observer

References

source
SPICE.lx4dec — Method
lx4dec(string, first)

Scan a string from a specified starting position for the end of a decimal number.

Arguments

  • string: Any character string
  • first: First character to scan from in string

Output

  • last: Last character that is part of a decimal number. If there is no such character, last will be returned with the value first-1.
  • nchar: Number of characters in the decimal number

References

source
SPICE.lx4num — Method
lx4num(string, first)

Scan a string from a specified starting position for the end of a number.

Arguments

  • string: Any character string
  • first: First character to scan from in string

Output

  • last: Last character that is part of a number. If there is no such character, last will be returned with the value first-1.
  • nchar: Number of characters in the number

References

source
SPICE.lx4sgn — Method
lx4sgn(string, first)

Scan a string from a specified starting position for the end of a signed integer.

Arguments

  • string: Any character string
  • first: First character to scan from in string

Output

  • last: Last character that is part of a signed integer. If there is no such character, last will be returned with the value first-1.
  • nchar: Number of characters in the signed integer

References

source
SPICE.lx4uns — Method
lx4uns(string, first)

Scan a string from a specified starting position for the end of a unsigned integer.

Arguments

  • string: Any character string
  • first: First character to scan from in string

Output

  • last: Last character that is part of an unsigned integer. If there is no such character, last will be returned with the value first-1.
  • nchar: Number of characters in the unsigned integer

References

source
SPICE.lxqstr — Method
lxqstr(string, qchar, first)

Lex (scan) a quoted string.

Arguments

  • string: String to be scanned
  • qchar: Quote delimiter character
  • first: Character position at which to start scanning

Output

  • last: Character position of end of token
  • nchar: Number of characters in token

References

source
SPICE.m2eul — Method
m2eul(r, axis3, axis2, axis1)

Factor a rotation matrix as a product of three rotations about specified coordinate axes.

Arguments

  • r: A rotation matrix to be factored
  • axis3: Number of the third rotation axis
  • axis2: Number of the second rotation axis
  • axis1: Number of the first rotation axis

Output

A tuple consisting of the third, second, and first Euler angles in radians.

References

source
SPICE.m2q — Method
m2q(r)

Find a unit quaternion corresponding to a specified rotation matrix.

Arguments

  • r: A rotation matrix

Output

A unit quaternion representing `r'

References

source
SPICE.matchi — Method
matchi(string, templ, wstr, wchar)

Determine whether a string is matched by a template containing wild cards. The pattern comparison is case-insensitive.

Arguments

  • string: String to be tested
  • templ: Template (with wild cards) to test against string
  • wstr: Wild string token
  • wchr: Wild character token

Output

Returns true if the string matches.

References

source
SPICE.matchw — Method
matchw(string, templ, wstr, wchar)

Determine whether a string is matched by a template containing wild cards.

Arguments

  • string: String to be tested
  • templ: Template (with wild cards) to test against string
  • wstr: Wild string token
  • wchr: Wild character token

Output

Returns true if the string matches.

References

source
SPICE.namfrm — Method
namfrm(frname)

Look up the frame ID code associated with a string.

Arguments

  • frname: The name of some reference frame

Output

The SPICE ID code of the frame.

References

source
SPICE.ncpos — Method
ncpos(str, chars, start)

Find the first occurrence in a string of a character NOT belonging to a collection of characters, starting at a specified location, searching forward.

Arguments

  • str: A string
  • chars: A collection of characters
  • start: Position to begin looking for a character not in chars

Output

Returns the index of the first character of str at or following index start that is not in the collection chars.

References

source
SPICE.ncposr — Method
ncposr(str, chars, start)

Find the first occurrence in a string of a character NOT belonging to a collection of characters, starting at a specified location, searching in reverse.

Arguments

  • str: A string
  • chars: A collection of characters
  • start: Position to begin looking for a character not in chars

Output

Returns the index of the last character of str at or before index start that is not in the collection chars.

References

source
SPICE.nearpt — Method
nearpt(positn, a, b, c)

This routine locates the point on the surface of an ellipsoid that is nearest to a specified position. It also returns the altitude of the position above the ellipsoid.

Arguments

  • positn: Position of a point in the bodyfixed frame
  • a: Length of semi-axis parallel to x-axis
  • b: Length of semi-axis parallel to y-axis
  • c: Length on semi-axis parallel to z-axis

Output

Returns a tuple consisting of npoint and alt.

  • npoint: Point on the ellipsoid closest to positn
  • alt: Altitude of positn above the ellipsoid

References

source
SPICE.npedln — Method
npedln(a, b, c, linept, linedr)

Find nearest point on a triaxial ellipsoid to a specified line, and the distance from the ellipsoid to the line.

Arguments

  • a: Length of semi-axis in the x direction
  • b: Length of semi-axis in the y direction
  • c: Length of semi-axis in the z direction
  • linept: Point on line
  • linedr: Direction vector of line

Output

Returns a tuple consisting of pnear and dist.

  • pnear: Nearest point on ellipsoid to line
  • dist: Distance of ellipsoid from line

References

source
SPICE.npelpt — Method
npelpt(point, ellips)

Find the nearest point on an ellipse to a specified point, both in three-dimensional space, and find the distance between the ellipse and the point.

Arguments

  • point: Point whose distance to an ellipse is to be found
  • ellips: A SPICE ellipse

Output

Returns a tuple consisting of pnear and dist.

  • pnear: Nearest point on ellipse to input point
  • dist: Distance of input point to ellipse

References

source
SPICE.nplnpt — Method
nplnpt(linept, linedr, point)

Find the nearest point on a line to a specified point, and find the distance between the two points.

Arguments

  • linept: Point on line
  • linedr: Direction vector of line
  • point: A second point

Output

Returns a tuple consisting of pnear and dist.

  • pnear: Nearest point on the line to point
  • dist: Distance between point and pnear

References

source
SPICE.nvc2pl — Method
nvc2pl(norm, point)

Make a SPICE plane from a normal vector and a point.

Arguments

  • norm: A normal vector...
  • constant: ...and a constant defining a plane

Output

Returns a struct representing the plane.

References

source
SPICE.nvp2pl — Method
nvp2pl(norm, point)

Make a SPICE plane from a normal vector and a point.

Arguments

  • norm: A normal vector...
  • point: ...and a point defining a plane

Output

Returns a struct representing the plane.

References

source
SPICE.occult — Method
occult(targ1, shape1, frame1, targ2, shape2, frame2, abcorr, obsrvr, et)

Determines the occultation condition (not occulted, partially, etc.) of one target relative to another target as seen by an observer at a given time.

The surfaces of the target bodies may be represented by triaxial ellipsoids or by topographic data provided by DSK files.

Arguments

  • targ1: Name or ID of first target.
  • shape1: Type of shape model used for first target.
  • frame1: Body-fixed, body-centered frame for first body.
  • targ2: Name or ID of second target.
  • shape2: Type of shape model used for second target.
  • frame2: Body-fixed, body-centered frame for second body.
  • abcorr: Aberration correction flag.
  • obsrvr: Name or ID of the observer.
  • et: Time of the observation (seconds past J2000).

Output

Returns the occultation identification code.

References

source
SPICE.ordc — Method
ordc(set, item)

The function returns the ordinal position of any given item in a character set.

Arguments

  • set: A set to search for a given item
  • item: An item to locate within a set

Output

Returns the ordinal position or nothing if the items does not appear in the set.

References

source
SPICE.ordd — Method
ordd(set, item)

The function returns the ordinal position of any given item in a character set.

Arguments

  • set: A set to search for a given item
  • item: An item to locate within a set

Output

Returns the ordinal position or nothing if the items does not appear in the set.

References

source
SPICE.ordi — Method
ordi(set, item)

The function returns the ordinal position of any given item in a character set.

Arguments

  • set: A set to search for a given item
  • item: An item to locate within a set

Output

Returns the ordinal position or nothing if the items does not appear in the set.

References

source
SPICE.oscelt — Method
oscelt(state, et, mu)

Determine the set of osculating conic orbital elements that corresponds to the state (position, velocity) of a body at some epoch.

Arguments

  • state: State of body at epoch of elements
  • et: Epoch of elements
  • mu: Gravitational parameter (GM) of primary body

Output

Returns the equivalent conic elements:

  • rp: Perifocal distance
  • ecc: Eccentricity
  • inc: Inclination
  • lnode: Longitude of the ascending node
  • argp: Argument of periapsis
  • m0: Mean anomaly at epoch
  • t0: Epoch
  • mu: Gravitational parameter

References

source
SPICE.oscltx — Method
oscltx(state, et, mu)

Determine the set of osculating conic orbital elements that corresponds to the state (position, velocity) of a body at some epoch. In addition to the classical elements, return the true anomaly, semi-major axis, and period, if applicable.

Arguments

  • state: State of body at epoch of elements
  • et: Epoch of elements
  • mu: Gravitational parameter (GM) of primary body

Output

Returns the extended set of classical conic elements:

  • rp: Perifocal distance.
  • ecc: Eccentricity.
  • inc: Inclination.
  • lnode: Longitude of the ascending node.
  • argp: Argument of periapsis.
  • m0: Mean anomaly at epoch.
  • t0: Epoch.
  • mu: Gravitational parameter.
  • nu: True anomaly at epoch.
  • a: Semi-major axis. A is set to zero if it is not computable.
  • tau: Orbital period. Applicable only for elliptical orbits. Set to zero otherwise.

References

source
SPICE.pckcov! — Method
pckcov!(cover, pck, idcode)

Find the coverage window for a specified reference frame in a specified binary PCK file.

Arguments

  • cover: An initalized window SpiceDoubleCell
  • pck: Path of PCK file
  • idcode: Class ID code of PCK reference frame

Output

Returns cover containing coverage in pck for idcode

References

source
SPICE.pckfrm! — Method
pckfrm!(ids, pck)

Find the set of reference frame class ID codes of all frames in a specified binary PCK file.

Arguments

  • ids: An initalized SpiceIntCell
  • pck: Path of PCK file

Output

Returns ids containing a set of frame class ID codes of frames in PCK file.

References

source
SPICE.pcklof — Method
pcklof(filename)

Load a binary PCK file for use by the readers. Return the handle of the loaded file which is used by other PCK routines to refer to the file.

Arguments

  • filename: Path of the PCK file

Output

Returns an integer handle.

References

source
SPICE.pckopn — Method
pckopn(name, ifname, ncomch)

Create a new PCK file, returning the handle of the opened file.

Arguments

  • name: The name of the PCK file to be opened
  • ifname: The internal filename for the PCK
  • ncomch: The number of characters to reserve for comments

Output

Returns the handle of the opened PCK file.

References

source
SPICE.pckuof — Method
pckuof(handle)

Unload a binary PCK file so that it will no longer be searched by the readers.

Arguments

  • handle: Integer handle of a PCK file

References

source
SPICE.pckw02 — Method
pckw02(handle, clssid, frame, first, last, segid, intlen, cdata, btime)

Write a type 2 segment to a PCK binary file given the file handle, frame class ID, base frame, time range covered by the segment, and the Chebyshev polynomial coefficients.

Arguments

  • handle: Handle of binary PCK file open for writing.
  • clssid: Frame class ID of body-fixed frame.
  • frame: Name of base reference frame.
  • first: Start time of interval covered by segment.
  • last: End time of interval covered by segment.
  • segid: Segment identifier.
  • intlen: Length of time covered by logical record.
  • cdata: Array of Chebyshev coefficients.
  • btime: Begin time of first logical record.

References

source
SPICE.pcpool — Method
pcpool(name, vals)

Insert character data into the kernel pool.

Arguments

  • name: The kernel pool name to associate with vals
  • vals: An array of values to insert into the kernel pool

References

source
SPICE.pdpool — Method
pdpool(name, vals)

Insert double precision data into the kernel pool.

Arguments

  • name: The kernel pool name to associate with vals
  • vals: An array of values to insert into the kernel pool

References

source
SPICE.pgrrec — Method
pgrrec(body, lon, lat, alt, re, f)

Convert planetographic coordinates to rectangular coordinates.

Arguments

  • body: Body with which coordinate system is associated.
  • lon: Planetographic longitude of a point (radians).
  • lat: Planetographic latitude of a point (radians).
  • alt: Altitude of a point above reference spheroid.
  • re: Equatorial radius of the reference spheroid.
  • f: Flattening coefficient.

Output

Returns the rectangular coordinates of the point.

References

source
SPICE.phaseq — Method
phaseq(et, target, illmn, obsrvr, abcorr)

Compute the apparent phase angle for a target, observer, illuminator set of ephemeris objects.

Arguments

  • et: Ephemeris seconds past J2000 TDB
  • target: Target body name
  • illmn: Illuminating body name
  • obsrvr: Observer body
  • abcorr: Aberration correction flag

Output

Returns the value of the phase angle.

References

source
SPICE.pipool — Method
pipool(name, ivals)

Insert integer data into the kernel pool.

Arguments

  • name: The kernel pool name to associate with the values
  • ivals: An array of integers to insert into the pool

References

source
SPICE.pjelpl — Method
pjelpl(elin, plane)

Project an ellipse onto a plane, orthogonally.

Arguments

  • elin: An ellipse to be projected
  • plane: A plane onto which elin is to be projected

Output

Returns the ellipse resulting from the projection.

References

source
SPICE.pl2nvc — Method
pl2nvc(plane)

Return a unit normal vector and constant that define a specified plane.

Arguments

  • plane: A plane

Output

Returns a tuple consisting of

  • normal: A normal vector and...
  • constant: ... constant defining the geometric plane represented by plane

References

source
SPICE.pl2nvp — Method
pl2nvp(plane)

Return a unit normal vector and point that define a specified plane.

Arguments

  • plane: A plane

Output

Returns a tuple consisting of

  • normal: A normal vector and...
  • point: ... point defining the geometric plane represented by plane

References

source
SPICE.pl2psv — Method
pl2psv(plane)

Return a point and two orthogonal spanning vectors that define a specified plane.

Arguments

  • plane: A plane

Output

Returns a tuple consisting of a point in the plane and two vectors spanning the input plane.

References

source
SPICE.pltar — Method
pltar(vrtces, plates)

Compute the total area of a collection of triangular plates.

Arguments

  • vrtces: Array of vertices
  • plates: Array of plates

Output

Returns the area.

References

source
SPICE.pltexp — Method
pltexp(iverts, delta)

Expand a triangular plate by a specified amount. The expanded plate is co-planar with, and has the same orientation as, the original. The centroids of the two plates coincide.

Arguments

  • iverts: Vertices of the plate to be expanded
  • delta: Fraction by which the plate is to be expanded

Output

Returns the vertices of the expanded plate.

References

source
SPICE.pltnp — Method
pltnp(point, v1, v2, v3)

Find the nearest point on a triangular plate to a given point.

Arguments

  • point: A point in 3-dimensional space.
  • v1, v2, v3: Vertices of a triangular plate

Output

Returns a tuple consisting of

  • pnear: Nearest point on the plate to point
  • dist: Distance between pnear and point

References

source
SPICE.pltnrm — Method
pltnrm(v1, v2, v3)

Compute an outward normal vector of a triangular plate. The vector does not necessarily have unit length.

Arguments

  • v1, v2, v3: Vertices of a plate

Output

Returns the plate's outward normal vector.

References

source
SPICE.pltvol — Method
pltvol(vrtces, plates)

Compute the volume of a three-dimensional region bounded by a collection of triangular plates.

Arguments

  • vrtces: Array of vertices
  • plates: Array of plates

Output

Returns the volume of the spatial region bounded by the plates.

References

source
SPICE.polyds — Method
polyds(coeffs, nderiv, t)

Compute the value of a polynomial and it's first nderiv derivatives at the value t.

Arguments

  • coeffs: Coefficients of the polynomial to be evaluated
  • nderiv: Number of derivatives to compute
  • t: Point to evaluate the polynomial and derivatives

Output

Returns the value of the polynomial and the derivatives as an array.

References

source
SPICE.pos — Function
pos(str, substr, start)
Deprecated

Use first(findnext(substr, str, start)) instead.

source
SPICE.posr — Function
posr(str, substr, start)
Deprecated

Use first(findprev(substr, str, start)) instead.

source
SPICE.prop2b — Method
prop2b(gm, pvinit, dt)

Given a central mass and the state of massless body at time t_0, this routine determines the state as predicted by a two-body force model at time t_0 + dt.

Arguments

  • gm: Gravity of the central mass.
  • pvinit: Initial state from which to propagate a state.
  • dt: Time offset from initial state to propagate to.

Output

Returns the propagated state.

References

source
SPICE.psv2pl — Method
psv2pl(point, span1, span2)

Make a plane from a point and two spanning vectors.

Arguments

  • point, span1, span2: A point and two spanning vectors defining a plane

Output

Returns the plane.

References

source
SPICE.pxform — Method
pxform(from, to, et)

Return the matrix that transforms position vectors from one specified frame to another at a specified epoch.

Arguments

  • from: Name of the frame to transform from
  • to: Name of the frame to transform to
  • et: Epoch of the rotation matrix

Output

Returns the rotation matrix.

References

source
SPICE.pxfrm2 — Method
pxfrm2(from, to, etfrom, etto)

Return the 3x3 matrix that transforms position vectors from one specified frame at a specified epoch to another specified frame at another specified epoch.

Arguments

  • from: Name of the frame to transform from
  • to: Name of the frame to transform to
  • etfrom: Evaluation time of from frame
  • etto: Evaluation time of to frame

Output

Returns a position transformation matrix from frame from to frame to.

References

source
SPICE.q2m — Method
q2m(q)

Find the rotation matrix corresponding to a specified unit quaternion.

Arguments

  • q: A unit quaternion

Output

A rotation matrix corresponding to q.

References

source
SPICE.qdq2av — Method
qdq2av(q, dq)

Derive angular velocity from a unit quaternion and its derivative with respect to time.

Arguments

  • q: Unit SPICE quaternion (as any kind of iterable with four elements)
  • dq: Derivative of `q' with respect to time

Output

Angular velocity vector defined by q' anddq'

References

source
SPICE.qxq — Method
qxq(q1, q2)

Multiply two quaternions.

Arguments

  • q1: First SPICE quaternion factor (as any kind of iterable with four elements)
  • q2: Second SPICE quaternion factor (as any kind of iterable with four elements)

Output

A quaternion corresponding to the product of q1' andq2'

References

source
SPICE.radrec — Method
radrec(range, ra, dec)

Convert from range, right ascension, and declination to rectangular coordinates.

Arguments

  • range: Distance of a point from the origin
  • ra: Right ascension of point in radians
  • dec: Declination of point in radians

Output

Returns the rectangular coordinates of the point.

References

source
SPICE.rav2xf — Method
rav2xf(rot, av)

Determine a state transformation matrix from a rotation matrix and the angular velocity of the rotation.

Arguments

  • rot: Rotation matrix
  • av: Angular velocity vector

Output

Returns state transformation matrix associated with rot and av.

References

source
SPICE.raxisa — Method
raxisa(matrix)

Compute the axis of the rotation given by an input matrix and the angle of the rotation about that axis.

Arguments

  • matrix: A 3x3 rotation matrix

Output

  • axis: Axis of the rotation
  • angle: Angle through which the rotation is performed

References

source
SPICE.reccyl — Method
reccyl(rectan)

Convert from rectangular to cylindrical coordinates.

Arguments

  • rectan: Rectangular coordinates of a point

Output

  • r: Distance of the point from the Z axis
  • lon: Angle (radians) of the point from the XZ plane
  • z: Height of the point above the XY plane

References

source
SPICE.recgeo — Method
recgeo(rectan, re, f)

Convert from rectangular coordinates to geodetic coordinates.

Arguments

  • rectan: Rectangular coordinates of a point
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

  • lon: Geodetic longitude of the point (radians)
  • lat: Geodetic latitude of the point (radians)
  • alt: Altitude of the point above reference spheroid

References

source
SPICE.reclat — Method
reclat(rectan)

Convert from rectangular coordinates to latitudinal coordinates.

Arguments

  • rectan: Rectangular coordinates of a point

Output

Returns a tuple consisting of:

  • rad: Distance of the point from the origin
  • lon: Planetographic longitude of the point (radians)
  • lat: Planetographic latitude of the point (radians)

References

source
SPICE.recpgr — Method
recpgr(body, rectan, re, f)

Convert rectangular coordinates to planetographic coordinates.

Arguments

  • body: Body with which coordinate system is associated
  • rectan: Rectangular coordinates of a point
  • re: Equatorial radius of the reference spheroid
  • f: flattening coefficient

Output

  • lon: Planetographic longitude of the point (radians).
  • lat: Planetographic latitude of the point (radians).
  • alt: Altitude of the point above reference spheroid.

References

source
SPICE.recrad — Method
recrad(rectan)

Convert rectangular coordinates to range, right ascension, and declination.

Arguments

  • rectan: Rectangular coordinates of a point

Output

Return the tuple (range, ra, dec).

  • range: Distance of the point from the origin
  • ra: Right ascension in radians
  • dec: Declination in radians

References

source
SPICE.recsph — Method
recsph(rectan)

Convert from rectangular coordinates to spherical coordinates.

Arguments

  • rectan: Rectangular coordinates of a point

Output

  • r: Distance of the point from the origin
  • colat: Angle of the point from the Z-axis in radian
  • lon: Longitude of the point in radians

References

source
SPICE.removc! — Method
removc!(set, item)

Remove an item from a character set.

Arguments

  • set: A set
  • item: Item to be removed

Output

Returns the updated set.

References

source
SPICE.removi! — Method
removi!(set, item)

Remove an item from a character set.

Arguments

  • set: A set
  • item: Item to be removed

Output

Returns the updated set.

References

source
SPICE.repmc — Function
repmc(input, marker, value)
Deprecated

Use replace(input, marker=>value) instead.

source
SPICE.rotate — Method
rotate(angle, iaxis)

Calculate the 3x3 rotation matrix generated by a rotation of a specified angle about a specified axis. This rotation is thought of as rotating the coordinate system.

Arguments

  • angle: Angle of rotation (radians)
  • iaxis: Axis of rotation (X=1, Y=2, Z=3)

Output

Returns rotation matrix associated with angle and iaxis.

References

source
SPICE.rotmat — Method
rotmat(m1, angle, iaxis)

Applies a rotation of angle radians about axis iaxis to a matrix m1. This rotation is thought of as rotating the coordinate system.

Arguments

  • m1: Matrix to be rotated
  • angle: Angle of rotation (radians)
  • iaxis: Axis of rotation (X=1, Y=2, Z=3)

Output

Returns the resulting rotated matrix.

References

source
SPICE.rotvec — Method
rotvec(v1, angle, iaxis)

Transform a vector to a new coordinate system rotated by angle radians about axis iaxis. This transformation rotates v1 by -angle radians about the specified axis.

Arguments

  • v1: Vector whose coordinate system is to be rotated
  • angle: Angle of rotation in radians
  • iaxis: Axis of rotation (X=1, Y=2, Z=3)

Output

Returns the resulting vector expressed in the new coordinate system.

References

source
SPICE.rquad — Method
rquad(a, b, c)

Find the roots of a quadratic equation.

Arguments

  • a: Coefficient of quadratic term
  • b: Coefficient of linear term
  • c: Constant

Output

  • root1: Root built from positive discriminant term
  • root2: Root built from negative discriminant term

References

source
SPICE.saelgv — Method
saelgv(vec1, vec2)

Find semi-axis vectors of an ellipse generated by two arbitrary three-dimensional vectors.

Arguments

  • vec1, vec2: Two vectors used to generate an ellipse

Output

  • smajor: Semi-major axis of ellipse
  • sminor: Semi-minor axis of ellipse

References

source
SPICE.scard! — Method
scard!(cell::SpiceCell{T}, card) where T

Set the cardinality of a cell.

Arguments

  • cell: The cell
  • card: Cardinality of (number of elements in) the cell

Output

Returns cell with its cardinality set to card.

References

source
SPICE.scdecd — Function
scdecd(sc, sclkdp, lenout=128)

Convert double precision encoding of spacecraft clock time into a character representation.

Arguments

  • sc: NAIF spacecraft identification code
  • sclkdp: Encoded representation of a spacecraft clock count
  • lenout: Maximum allowed length of output SCLK string

Output

Returns the character representation of a clock count.

References

source
SPICE.sce2c — Method
sce2c(sc, et)

Convert ephemeris seconds past J2000 (ET) to continuous encoded spacecraft clock ("ticks"). Non-integral tick values may be returned.

Arguments

  • sc: NAIF spacecraft ID code
  • et: Ephemeris time, seconds past J2000

Output

Returns SCLK, encoded as ticks since spacecraft clock start.

References

source
SPICE.sce2s — Function
sce2s(sc, et, lenout=128)

Convert an epoch specified as ephemeris seconds past J2000 (ET) to a character string representation of a spacecraft clock value (SCLK).

Arguments

  • sc: NAIF spacecraft identification code
  • et: Ephemeris time, specified as seconds past J2000
  • lenout: Maximum allowed length of output SCLK string

Output

Returns an SCLK string.

References

source
SPICE.sce2t — Method
sce2t(sc, et)

Convert ephemeris seconds past J2000 (ET) to integral encoded spacecraft clock ("ticks"). For conversion to fractional ticks, (required for C-kernel production), see the routine sce2c.

Arguments

  • sc: NAIF spacecraft ID code
  • et: Ephemeris time, seconds past J2000

Output

Returns SCLK, encoded as ticks since spacecraft clock start.

References

source
SPICE.scencd — Method
scencd(sc, sclkch)

Encode character representation of spacecraft clock time into a double precision number.

Arguments

  • sc: NAIF spacecraft identification code
  • sclkch: Character representation of a spacecraft clock

Output

Returns the encoded representation of the clock count.

References

source
SPICE.scfmt — Function
scfmt(sc, ticks, lenout=128)

Convert encoded spacecraft clock ticks to character clock format.

Arguments

  • sc: NAIF spacecraft identification code
  • ticks: Encoded representation of a spacecraft clock count
  • lenout: Maximum allowed length of output string

Output

Returns a character representation of a clock count.

References

source
SPICE.scpart — Method
scpart(sc)

Get spacecraft clock partition information from a spacecraft clock kernel file.

Arguments

  • sc: NAIF spacecraft identification code

Output

  • pstart: Array of partition start times
  • pstop: Array of partition stop times

References

source
SPICE.scs2e — Method
scs2e(sc, sclkch)

Convert a spacecraft clock string to ephemeris seconds past J2000 (ET).

Arguments

  • sc: NAIF integer code for a spacecraft
  • sclkch: An SCLK string

Output

Returns ephemeris time seconds past J2000.

References

source
SPICE.sct2e — Method
sct2e(sc, sclkdp)

Convert encoded spacecraft clock ("ticks") to ephemeris seconds past J2000 (ET).

Arguments

  • sc: NAIF integer code for a spacecraft
  • sclkdp: SCLK, encoded as ticks since spacecraft clock start.

Output

Returns ephemeris time seconds past J2000.

References

source
SPICE.sctiks — Method
sctiks(sc, clkstr)

Convert a spacecraft clock format string to number of "ticks".

Arguments

  • sc: NAIF spacecraft identification code
  • clkstr: Character representation of a spacecraft clock

Output

Returns the number of ticks represented by the clock string.

References

source
SPICE.sdiff — Method
sdiff(a::T, b::T) where T <: SpiceCell

Compute the symmetric difference of two sets of any data type to form a third set.

Arguments

  • a: First input set
  • b: Second input set

Output

Returns a cell containing the symmetric difference of a and b.

References

source
SPICE.set — Method
set(a::T, b::T) where T <: SpiceCell

Given a relational operator, compare two sets of any data type.

Arguments

  • a: First set
  • op: Comparison operator
  • b: Second set

Output

Returns the result of the comparison: a (op) b.

References

source
SPICE.sincpt — Method
sincpt(method, target, et, fixref, abcorr, obsrvr, dref, dvec)

Given an observer and a direction vector defining a ray, compute the surface intercept of the ray on a target body at a specified epoch, optionally corrected for light time and stellar aberration.

The surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in TDB seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction flag
  • obsrvr: Name of observing body
  • dref: Reference frame of ray's direction vector
  • dvec: Ray's direction vector

Output

Returns a tuple consisting of the following data or nothing if no intercept was found.

  • spoint: Surface intercept point on the target body
  • trgepc: Intercept epoch
  • srfvec: Vector from observer to intercept point

References

source
SPICE.size_c — Method
size_c(cell::SpiceCell)

Returns the maximum number of elements that cell can hold.

source
SPICE.sphcyl — Method
sphcyl(radius, colat, slon)

Converts from spherical coordinates to cylindrical coordinates.

Arguments

  • radius: Distance of point from origin
  • colat: Polar angle (co-latitude in radians) of point
  • slon: Azimuthal angle (longitude) of point (radians)

Output

  • r: Distance of point from Z axis
  • lon: Angle (radians) of point from XZ plane
  • z: Height of point above XY plane

References

source
SPICE.sphlat — Method
sphlat(r, colat, lons)

Convert from spherical coordinates to latitudinal coordinates.

Arguments

  • r: Distance of the point from the origin
  • colat: Angle of the point from positive z axis (radians)
  • lons: Angle of the point from the XZ plane (radians)

Output

  • radius: Distance of a point from the origin
  • lon: Angle of the point from the XZ plane in radians
  • lat: Angle of the point from the XY plane in radians

References

source
SPICE.sphrec — Method
sphrec(r, colat, lon)

Convert from spherical coordinates to rectangular coordinates.

Arguments

  • r: Distance of a point from the origin
  • colat: Angle of the point from the Z-axis in radians
  • lon: Angle of the point from the XZ plane in radians

Output

Returns the rectangular coordinates of the point.

References

source
SPICE.spk14a — Method
spk14a(handle, ncsets, coeffs, epochs)

Add data to a type 14 SPK segment associated with handle. See also spk14b and spk14e.

Arguments

  • handle: The handle of an SPK file open for writing
  • ncsets: The number of coefficient sets and epochs
  • coeffs: The collection of coefficient sets
  • epochs: The epochs associated with the coefficient sets

References

source
SPICE.spk14b — Method
spk14b(handle, segid, body, center, frame, first, last, chbdeg)

Begin a type 14 SPK segment in the SPK file associated with handle. See also spk14a and spk14e.

Arguments

  • handle: The handle of an SPK file open for writing
  • segid: The string to use for segment identifier
  • body: The NAIF ID code for the body of the segment
  • center: The center of motion for body
  • frame: The reference frame for this segment
  • first: The first epoch for which the segment is valid
  • last: The last epoch for which the segment is valid
  • chbdeg: The degree of the Chebyshev Polynomial used

References

source
SPICE.spk14e — Method
spk14e(handle)

End the type 14 SPK segment currently being written to the SPK file associated with handle. See also spk14a and spk14b.

Arguments

  • handle: The handle of an SPK file open for writing

Output

Returns the handle of the SPK file.

References

source
SPICE.spkacs — Method
spkacs(targ, et, ref, abcorr, obs, starg, lt, dlt)

Return the state (position and velocity) of a target body relative to an observer, optionally corrected for light time and stellar aberration, expressed relative to an inertial reference frame.

Arguments

  • targ: Target body
  • et: Observer epoch
  • ref: Inertial reference frame of output state
  • abcorr: Aberration correction flag
  • obs: Observer

Output

  • starg: State of target
  • lt: One way light time between observer and target
  • dlt: Derivative of light time with respect to time

References

source
SPICE.spkapo — Method
spkapo(targ, et, ref, sobs, abcorr)

Return the position of a target body relative to an observer, optionally corrected for light time and stellar aberration.

Arguments

  • targ: Target body
  • et: Observer epoch
  • ref: Inertial reference frame of observer's state
  • sobs: State of observer wrt. solar system barycenter
  • abcorr: Aberration correction flag

Output

  • ptarg: Position of target
  • lt: One way light time between observer and target

References

source
SPICE.spkaps — Method
spkaps(targ, et, ref, abcorr, stobs, accobs)

Given the state and acceleration of an observer relative to the solar system barycenter, return the state (position and velocity) of a target body relative to the observer, optionally corrected for light time and stellar aberration. All input and output vectors are expressed relative to an inertial reference frame.

Users normally should call the high-level API routines spkezr or spkez rather than this routine.

Arguments

  • targ: Target body.
  • et: Observer epoch.
  • ref: Inertial reference frame of output state.
  • abcorr: Aberration correction flag.
  • stobs: State of the observer relative to the SSB.
  • accobs: Acceleration of the observer relative to the SSB.

Output

  • starg: State of target.
  • lt: One way light time between observer and target.
  • dlt: Derivative of light time with respect to time.

References

source
SPICE.spkcls — Method
spkcls(handle)

Close an open SPK file.

Arguments

  • handle: Handle of the SPK file to be closed

Output

Returns the handle of the closed file.

References

source
SPICE.spkcov! — Method
spkcov!(cover, spk, idcode)

Find the coverage window for a specified ephemeris object in a specified SPK file.

Arguments

  • cover: Window giving coverage in spk for idcode
  • spk: Name of the SPK file
  • idcode: ID code of ephemeris object

Output

Returns the extended coverage window.

References

source
SPICE.spkcpo — Method
spkcpo(target, et, outref, refloc, abcorr, obspos, obsctr, obsref)

Return the state of a specified target relative to an "observer," where the observer has constant position in a specified reference frame. The observer's position is provided by the calling program rather than by loaded SPK files.

Arguments

  • target: Name of target ephemeris object
  • et: Observation epoch
  • outref: Reference frame of output state
  • refloc: Output reference frame evaluation locus
  • abcorr: Aberration correction
  • obspos: Observer position relative to center of motion
  • obsctr: Center of motion of observer
  • obsref: Frame of observer position

Output

  • state: State of target with respect to observer
  • lt: One way light time between target and observer

References

source
SPICE.spkcpt — Method
spkcpt(trgpos, trgctr, trgref, et, outref, refloc, abcorr, obsrvr)

Return the state, relative to a specified observer, of a target having constant position in a specified reference frame. The target's position is provided by the calling program rather than by loaded SPK files.

Arguments

  • trgpos: Target position relative to center of motion
  • trgctr: Center of motion of target
  • trgref: Frame of target position
  • et: Observation epoch
  • outref: Reference frame of output state
  • refloc: Output reference frame evaluation locus
  • abcorr: Aberration correction
  • obsrvr: Name of observing ephemeris object

Output

  • state: State of target with respect to observer
  • lt: One way light time between target and observer

References

source
SPICE.spkcvo — Method
spkcvo(target, et, outref, refloc, abcorr, obssta, obsepc, obsctr, obsref)

Return the state of a specified target relative to an "observer," where the observer has constant velocity in a specified reference frame. The observer's state is provided by the calling program rather than by loaded SPK files.

Arguments

  • target: Name of target ephemeris object
  • et: Observation epoch
  • outref: Reference frame of output state
  • refloc: Output reference frame evaluation locus
  • abcorr: Aberration correction
  • obssta: Observer state relative to center of motion
  • obsepc: Epoch of observer state
  • obsctr: Center of motion of observer
  • obsref: Frame of observer state

Output

  • state: State of target with respect to observer
  • lt: One way light time between target and observer

References

source
SPICE.spkcvt — Method
spkcvt(trgsta, trgepc, trgctr, trgref, et, outref, refloc, abcorr, obsrvr)

Return the state, relative to a specified observer, of a target having constant velocity in a specified reference frame. The target's state is provided by the calling program rather than by loaded SPK files.

Arguments

  • trgsta: Target state relative to center of motion
  • trgepc: Epoch of target state
  • trgctr: Center of motion of target
  • trgref: Frame of target state
  • et: Observation epoch
  • outref: Reference frame of output state
  • refloc: Output reference frame evaluation locus
  • abcorr: Aberration correction
  • obsrvr: Name of observing ephemeris object

Output

  • state: State of target with respect to observer
  • lt: One way light time between target and observer

References

source
SPICE.spkez — Method
spkez(targ, et, ref, abcorr, obs)

Return the state (position and velocity) of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.

Arguments

  • targ: Target body
  • et: Observer epoch
  • ref: Reference frame of output state vector
  • abcorr: Aberration correction flag
  • obs: Observing body

Output

  • starg: State of target
  • lt: One way light time between observer and target

References

source
SPICE.spkezp — Method
spkezp(targ, et, ref, abcorr, obs)

Return the position of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.

Arguments

  • targ: Target body
  • et: Observer epoch
  • ref: Reference frame of output state vector
  • abcorr: Aberration correction flag
  • obs: Observing body

Output

  • ptarg: Position of target
  • lt: One way light time between observer and target

References

source
SPICE.spkezr — Method
spkezr(targ, et, ref, abcorr, obs)

Return the state (position and velocity) of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.

Arguments

  • targ: Target body name
  • et: Observer epoch
  • ref: Reference frame of output state vector
  • abcorr: Aberration correction flag
  • obs: Observing body name

Output

  • starg: State of target
  • lt: One way light time between observer and target

References

source
SPICE.spkgeo — Method
spkgeo(targ, et, ref, obs)

Compute the geometric state (position and velocity) of a target body relative to an observing body.

Arguments

  • targ: Target body.
  • et: Target epoch.
  • ref: Target reference frame.
  • obs: Observing body.

Output

  • state: State of target.
  • lt: Light time.

References

source
SPICE.spkgps — Method
spkgps(targ, et, ref, obs)

Compute the geometric position of a target body relative to an observing body.

Arguments

  • targ: Target body
  • et: Target epoch
  • ref: Target reference frame
  • obs: Observing body

Output

  • pos: Position of target
  • lt: Light time

References

source
SPICE.spklef — Method
spklef(fname)

Load an ephemeris file for use by the readers. Return that file's handle, to be used by other SPK routines to refer to the file.

Arguments

  • fname: Name of the file to be loaded

Output

  • handle: Loaded file's handle

References

source
SPICE.spkltc — Method
spkltc(targ, et, ref, abcorr, stobs)

Return the state (position and velocity) of a target body relative to an observer, optionally corrected for light time, expressed relative to an inertial reference frame.

Arguments

  • targ: Target body
  • et: Observer epoch
  • ref: Inertial reference frame of output state
  • abcorr: Aberration correction flag
  • stobs: State of the observer relative to the SSB

Output

  • starg: State of target
  • lt: One way light time between observer and target
  • dlt: Derivative of light time with respect to time

References

source
SPICE.spkobj! — Method
spkobj!(ids, spk)

Find the set of ID codes of all objects in a specified SPK file.

Arguments

  • ids: A preallocated set of ID codes of objects in SPK file
  • spk: Name of the SPK file

Output

Returns the set of id codes.

References

source
SPICE.spkopa — Method
spkopa(file)

Open an existing SPK file for subsequent write.

Arguments

  • file: The name of an existing SPK file

Output

Returns a handle attached to the SPK file opened to append.

References

source
SPICE.spkopn — Function
spkopn(name, ifname="", ncomch=0)

Create a new SPK file, returning the handle of the opened file.

Arguments

  • name: The name of the new SPK file to be created
  • ifname: The internal filename for the SPK file (default: "")
  • ncomch: The number of characters to reserve for comments (default: 0)

Output

Returns the handle of the opened SPK file.

References

source
SPICE.spkpds — Method
spkpds(body, center, frame, typ, first, last)

Perform routine error checks and if all checks pass, pack the descriptor for an SPK segment.

Arguments

  • body: The NAIF ID code for the body of the segment
  • center: The center of motion for body
  • frame: The frame for this segment
  • type: The type of SPK segment to create
  • first: The first epoch for which the segment is valid
  • last: The last epoch for which the segment is valid

Output

Returns an SPK segment descriptor.

References

source
SPICE.spkpos — Method
spkpos(targ, et, ref, abcorr, obs)

Return the position of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.

Arguments

  • targ: Target body name
  • et: Observer epoch
  • ref: Reference frame of output position vector
  • abcorr: Aberration correction flag
  • obs: Observing body name

Output

  • ptarg: Position of target
  • lt: One way light time between observer and target

References

source
SPICE.spkpvn — Method
spkpvn(handle, descr, et)

For a specified SPK segment and time, return the state (position and velocity) of the segment's target body relative to its center of motion.

Arguments

  • handle: File handle
  • descr: Segment descriptor
  • et: Evaluation epoch

Output

  • ref: Segment reference frame ID code
  • state: Output state vector
  • center: Center of state

References

source
SPICE.spksfs — Method
spksfs(body, et)

Search through loaded SPK files to find the highest-priority segment applicable to the body and time specified.

Arguments

  • body: Body ID
  • et: Ephemeris time

Output

Returns nothing if no segment was found or a tuple consisting of:

  • handle: Handle of file containing the applicable segment
  • descr: Descriptor of the applicable segment
  • ident: Identifier of the applicable segment

References

source
SPICE.spkssb — Method
spkssb(targ, et, ref)

Return the state (position and velocity) of a target body relative to the solar system barycenter.

Arguments

  • targ: Target body
  • et: Target epoch
  • ref: Target reference frame

Output

Returns the state of target.

References

source
SPICE.spksub! — Method
spksub!(newh, handle, descr, ident, start, stop)

Extract a subset of the data in an SPK segment into a separate segment.

Arguments

  • newh: Handle of new segment
  • handle: Handle of source segment
  • descr: Descriptor of source segment
  • ident: Identifier of source segment
  • start: Beginning (initial epoch) of subset
  • stop: End (final epoch) of subset

References

source
SPICE.spkuds — Method
spkuds(descr)

Unpack the contents of an SPK segment descriptor.

Arguments

  • descr: An SPK segment descriptor

Output

  • body: The NAIF ID code for the body of the segment
  • center: The center of motion for body
  • frame: The ID code for the frame of this segment
  • type: The type of SPK segment
  • first: The first epoch for which the segment is valid
  • last: The last epoch for which the segment is valid
  • start: Beginning DAF address of the segment
  • stop: Ending DAF address of the segment

References

source
SPICE.spkuef — Method
spkuef(handle)

Unload an ephemeris file so that it will no longer be searched by the readers.

Arguments

  • handle: Handle of file to be unloaded

References

source
SPICE.spkw02 — Method
spkw02(handle, body, center, frame, first, last, segid, intlen, cdata, btime)

Write a type 2 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • intlen: Length of time covered by logical record
  • cdata: Array of Chebyshev coefficients
  • btime: Begin time of first logical record

References

source
SPICE.spkw03 — Method
spkw03(handle, body, center, frame, first, last, segid, intlen, cdata, btime)

Write a type 3 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • intlen: Length of time covered by logical record
  • cdata: Array of Chebyshev coefficients
  • btime: Begin time of first logical record

References

source
SPICE.spkw05 — Method
spkw05(handle, body, center, frame, first, last, segid, gm, states, epochs)

Write an SPK segment of type 5 given a time-ordered set of discrete states and epochs, and the gravitational parameter of a central body.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • gm: Gravitational parameter of central body
  • states: States
  • epochs: Epochs

References

source
SPICE.spkw08 — Method
spkw08(handle, body, center, frame, first, last, segid, degree, states, epoch1, step)

Write a type 8 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • degree: Degree of interpolating polynomials
  • states: States
  • epoch1: Epoch of first state in states array
  • step: Time step separating epochs of states

References

source
SPICE.spkw09 — Method
spkw09(handle, body, center, frame, first, last, segid, degree, states, epochs)

Write a type 9 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • degree: Degree of interpolating polynomials
  • states: States
  • epochs: Epochs

References

source
SPICE.spkw10 — Method
spkw10(handle, body, center, frame, first, last, segid, consts, elems, epochs)

Write a type 10 segment to an SPK file.

Arguments

  • handle: The handle of a DAF file open for writing
  • body: The NAIF ID code for the body of the segment
  • center: The center of motion for body
  • frame: The reference frame for this segment
  • first: The first epoch for which the segment is valid
  • last: The last epoch for which the segment is valid
  • segid: The string to use for segment identifier
  • consts: The array of geophysical constants for the segmen
  • elems: The collection of "two-line" element sets
  • epochs: The epochs associated with the element sets

References

source
SPICE.spkw12 — Method
spkw12(handle, body, center, frame, first, last, segid, degree, states, epoch1, step)

Write a type 12 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • degree: Degree of interpolating polynomials
  • states: States
  • epoch1: Epoch of first state in states array
  • step: Time step separating epochs of states

References

source
SPICE.spkw13 — Method
spkw13(handle, body, center, frame, first, last, segid, degree, states, epochs)

Write a type 13 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • degree: Degree of interpolating polynomials
  • states: States
  • epochs: Epochs

References

source
SPICE.spkw15 — Method
spkw15(handle, body, center, frame, first, last, segid,
-       epoch, tp, pa, p, ecc, j2flg, pv, gm, j2, radius)

Write a type 15 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • epoch: Epoch of the periapse
  • tp: Trajectory pole vector
  • pa: Periapsis vector
  • p: Semi-latus rectum
  • ecc: Eccentricity
  • j2flg: J2 processing flag
  • pv: Central body pole vector
  • gm: Central body GM
  • j2: Central body J2
  • radius: Equatorial radius of central body

References

source
SPICE.spkw17 — Method
spkw17(handle, body, center, frame, first, last, segid, epoch, eqel, rapol, decpol)

Write a type 17 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • epoch: Epoch of elements in seconds past J2000
  • eqel: Array of equinoctial elements
  • rapol: Right Ascension of the pole of the reference plane
  • decpol: Declination of the pole of the reference plane

References

source
SPICE.spkw18 — Method
spkw18(handle, subtyp, body, center, frame, first, last, segid, degree, packts, epochs)

Write a type 18 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • subtyp: SPK type 18 subtype code, either :S18TP0 or :S18TP1
  • body: NAIF code for an ephemeris object
  • center: NAIF code for center of motion of body
  • frame: Reference frame name
  • first: Start time of interval covered by segment
  • last: End time of interval covered by segment
  • segid: Segment identifier
  • degree: Degree of interpolating polynomials
  • packts: Time-ordered array of data packets representing geometric states of body
    • For :S18TP0: [x, y, z, dx/dt, dy/dt, dz/dt, vx, vy, vz, dvx/dt, dvy/dt, dvz/dt]
    • For :S18TP1: [x, y, z, dx/dt, dy/dt, dz/dt]
  • epochs: Array of epochs corresponding to states.

References

source
SPICE.spkw20 — Method
spkw20(handle, body, center, frame, first, last, segid, intlen, n, polydg, cdata, dscale,
-       tscale, initjd, initfr)

Write a type 20 segment to an SPK file.

Arguments

  • handle: Handle of SPK file open for writing
  • body: NAIF code for ephemeris object
  • center: NAIF code for the center of motion of the body
  • frame: Reference frame name
  • first: Start time of interval covered by segment
  • last: End time of interval covered by segment
  • segid: Segment identifier
  • intlen: Length of time covered by logical record (days)
  • cdata: Array of Chebyshev coefficients and positions
  • dscale: Distance scale of data
  • tscale: Time scale of data
  • initjd: Integer part of begin time (TDB Julian date) of first record
  • initfr: Fractional part of begin time (TDB Julian date) of first record

References

source
SPICE.srfc2s — Method
srfc2s(code, bodyid)

Translate a surface ID code, together with a body ID code, to the corresponding surface name. If no such name exists, return a string representation of the surface ID code.

Arguments

  • code: Integer surface ID code to translate to a string
  • bodyid: ID code of body associated with surface

Output

  • srfstr: String corresponding to surface ID code
  • isname: Logical flag indicating output is a surface name

References

source
SPICE.srfcss — Method
srfcss(code, bodstr)

Translate a surface ID code, together with a body string, to the corresponding surface name. If no such surface name exists, return a string representation of the surface ID code.

Arguments

  • code: Integer surface ID code to translate to a string
  • bodstr: Name or ID of body associated with surface

Output

  • srfstr: String corresponding to surface ID code
  • isname: Logical flag indicating output is a surface name

References

source
SPICE.srfnrm — Method
srfnrm(method, target, et, fixref, npts, srfpts)

Map array of surface points on a specified target body to the corresponding unit length outward surface normal vectors.

The surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in TDB seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • srfpts: Array of surface points

Output

Returns an array of outward, unit length normal vectors.

References

source
SPICE.srfrec — Method
srfrec(body, longitude, latitude)

Convert planetocentric latitude and longitude of a surface point on a specified body to rectangular coordinates.

Arguments

  • body: NAIF integer code of an extended body.
  • longitude: Longitude of point in radians.
  • latitude: Latitude of point in radians.

Output

Returns the rectangular coordinates of the point.

References

source
SPICE.srfs2c — Method
srfs2c(srfstr, bodstr)

Translate a surface string, together with a body string, to the corresponding surface ID code. The input strings may contain names or integer ID codes.

Arguments

  • srfstr: Surface name or ID string
  • bodstr: Body name or ID string

Output

Returns the surface ID code if it was found or nothing otherwise.

References

source
SPICE.srfscc — Method
srfscc(srfstr, bodyid)

Translate a surface string, together with a body ID code, to the corresponding surface ID code. The input surface string may contain a name or an integer ID code.

Arguments

  • srfstr: Surface name or ID string
  • bodyid: Body ID code.

Output

Returns the surface ID code if it was found or nothing otherwise.

References

source
SPICE.ssize! — Method
ssize!(cell, size)

Set the size (maximum cardinality) of a cell of any data type.

Arguments

  • cell: The cell
  • size: Size (maximum cardinality) of the cell

Output

Returns the updated cell.

References

source
SPICE.stelab — Method
stelab(pobj, vobs)

Correct the apparent position of an object for stellar aberration.

Arguments

  • pobj: Position of an object with respect to the observer
  • vobs: Velocity of the observer with respect to the Solar System barycenter

Output

Returns the apparent position of the object with respect to the observer, corrected for stellar aberration.

References

source
SPICE.stpool — Function
stpool(item, nth, contin, lenout=1024)

Retrieve the nth string from the kernel pool variable, where the string may be continued across several components of the kernel pool variable.

Arguments

  • item: Name of the kernel pool variable
  • nth: Index of the full string to retrieve
  • contin: Character sequence used to indicate continuation
  • lenout: Available space in output string (default: 1024)

Output

Returns the full string concatenated across continuations if the kernel variable was found or nothing otherwise.

References

source
SPICE.str2et — Method
str2et(str)

Convert a string representing an epoch to a double precision value representing the number of TDB seconds past the J2000 epoch corresponding to the input epoch.

Arguments

  • str: A string representing an epoch

Output

Returns the equivalent value in seconds past J2000, TDB.

References

source
SPICE.subpnt — Method
subpnt(method, target, et, fixref, obsrvr, abcorr)

Compute the rectangular coordinates of the sub-observer point on a target body at a specified epoch, optionally corrected for light time and stellar aberration.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in ephemeris seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction
  • obsrvr: Name of observing body

Output

  • spoint: Sub-solar point on the target body
  • trgepc: Sub-solar point epoch
  • srfvec: Vector from observer to sub-solar point

References

source
SPICE.subslr — Method
subslr(method, target, et, fixref, abcorr, obsrvr)

Compute the rectangular coordinates of the sub-solar point on a target body at a specified epoch, optionally corrected for light time and stellar aberration.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in ephemeris seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction
  • obsrvr: Name of observing body

Output

  • spoint: Sub-solar point on the target body
  • trgepc: Sub-solar point epoch
  • srfvec: Vector from observer to sub-solar point

References

source
SPICE.surfnm — Method
surfnm(a, b, c, point)

Computes the outward-pointing, unit normal vector from a point on the surface of an ellipsoid.

Arguments

  • a: Length of the ellisoid semi-axis along the x-axis
  • b: Length of the ellisoid semi-axis along the y-axis
  • c: Length of the ellisoid semi-axis along the z-axis
  • point: Body-fixed coordinates of a point on the ellipsoid

Output

Return the outward pointing unit normal to ellipsoid at point

References

source
SPICE.surfpt — Method
surfpt(positn, u, a, b, c)

Determine the intersection of a line-of-sight vector with the surface of an ellipsoid.

Arguments

  • positn: Position of the observer in body-fixed frame
  • u: Vector from the observer in some direction
  • a: Length of the ellipsoid semi-axis along the x-axis
  • b: Length of the ellipsoid semi-axis along the y-axis
  • c: Length of the ellipsoid semi-axis along the z-axis

Output

Returns the point on the ellipsoid pointed to by u or nothing if none was found.

References

source
SPICE.surfpv — Method
surfpv(stvrtx, stdir, a, b, c)

Find the state (position and velocity) of the surface intercept defined by a specified ray, ray velocity, and ellipsoid.

Arguments

  • stvrtx: State of ray's vertex
  • stdir: State of ray's direction vector
  • a: Length of ellipsoid semi-axis along the x-axis
  • b: Length of ellipsoid semi-axis along the y-axis
  • c: Length of ellipsoid semi-axis along the z-axis

Output

Return the state of surface intercept or nothing if none was found.

References

source
SPICE.swpool — Method
swpool(agent, names)

Add a name to the list of agents to notify whenever a member of a list of kernel variables is updated.

Arguments

  • agent: The name of an agent to be notified after updates
  • names: Variable names whose update causes the notice

References

source
SPICE.sxform — Method
sxform(from, to, et)

Return the state transformation matrix from one frame to another at a specified epoch.

Arguments

  • from: Name of the frame to transform from
  • to: Name of the frame to transform to
  • et: Epoch of the state transformation matrix

Output

Returns the state transformation matrix.

References

source
SPICE.szpool — Method
szpool(name)

Return the kernel pool size limitations.

Arguments

  • name: Name of the parameter to be returned

Output

Returns the value of the parameter specified by name or nothing if none was found.

References

source
SPICE.termpt — Method

Find terminator points on a target body. The caller specifies half-planes, bounded by the illumination source center-target center vector, in which to search for terminator points.

The terminator can be either umbral or penumbral. The umbral terminator is the boundary of the region on the target surface where no light from the source is visible. The penumbral terminator is the boundary of the region on the target surface where none of the light from the source is blocked by the target itself.

The surface of the target body may be represented either by a triaxial ellipsoid or by topographic data.

Arguments

  • method: Computation method
  • ilusrc: Illumination source
  • target: Name of target body
  • et: Epoch in ephemeris seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction
  • corloc: Aberration correction locus
  • obsrvr: Name of observing body
  • refvec: Reference vector for cutting half-planes
  • rolstp: Roll angular step for cutting half-planes
  • ncuts: Number of cutting planes
  • schstp: Angular step size for searching
  • soltol: Solution convergence tolerance
  • maxn: Maximum number of entries in output arrays

Output

  • npts: Counts of terminator points corresponding to cuts
  • points: Terminator points
  • epochs: Times associated with terminator points
  • trmvcs: Terminator vectors emanating from the observer

References

source
SPICE.timdef — Function
timdef(action, item, value="")

Set and retrieve the defaults associated with calendar input strings.

Arguments

  • action: The kind of action to take, either :SET or :GET
  • item: The default item of interest. The items that may be requested are:
    • :CALENDAR with allowed values:
      • "GREGORIAN"
      • "JULIAN"
      • "MIXED"
    • :SYSTEM with allowed values:
      • "TDB"
      • "TDT"
      • "UTC"
    • :ZONE with allowed values (0 <= HR < 13 and 0 <= MN < 60):
      • "EST"
      • "EDT"
      • "CST"
      • "CDT"
      • "MST"
      • "MDT"
      • "PST"
      • "PDT"
      • "UTC+$HR"
      • "UTC-$HR"
      • "UTC+$HR:$MN"
      • "UTC-$HR:$MN"

Output

Returns the value associated with the default item.

References

source
SPICE.timout — Function
timout(et, pictur, lenout=128)

This routine converts an input epoch represented in TDB seconds past the TDB epoch of J2000 to a character string formatted to the specifications of a user's format picture.

Arguments

  • et: An epoch in seconds past the ephemeris epoch J2000
  • pictur: A format specification for the output string
  • lenout: The length of the output string plus 1 (default: 128)

Output

Returns a string representation of the input epoch.

References

source
SPICE.tipbod — Method
tipbod(ref, body, et)

Return a 3x3 matrix that transforms positions in inertial coordinates to positions in body-equator-and-prime-meridian coordinates.

Arguments

  • ref: Name of inertial reference frame to transform from
  • body: ID code of body
  • et: Epoch of transformation

Output

Returns transformation matrix from intertial position to prime meridian.

References

source
SPICE.tisbod — Method
tisbod(ref, body, et)

Return a 6x6 matrix that transforms states in inertial coordinates to states in body-equator-and-prime-meridian coordinates.

Arguments

  • ref: Name of inertial reference frame to transform from
  • body: ID code of body
  • et: Epoch of transformation

Output

Returns transformation matrix from intertial state to prime meridian.

References

source
SPICE.tparse — Method
tparse(string)

Parse a time string and return seconds past the J2000 epoch on a formal calendar.

Arguments

  • string: Input time string in UTC

Output

Returns UTC expressed in seconds since J2000.

References

source
SPICE.tpictr — Function
tpictr(sample, lenout=80)

Given a sample time string, create a time format picture suitable for use by the routine timout.

Arguments

  • sample: A sample time string
  • lenout: The length for the output picture string (default: 80)

Output

Returns a format picture that describes sample.

References

source
SPICE.trace — Function
trace(matrix)
Deprecated

Use LinearAlgebra.tr(matrix) instead.

source
SPICE.twovec — Method
twovec(axdef, indexa, plndef, indexp)

Find the transformation to the right-handed frame having a given vector as a specified axis and having a second given vector lying in a specified coordinate plane.

Arguments

  • axdef: Vector defining a principal axis
  • indexa: Principal axis number of axdef (X=1, Y=2, Z=3)
  • plndef: Vector defining (with axdef) a principal plane
  • indexp: Second axis number (with indexa) of principal plane

Output

Returns output rotation matrix.

References

source
SPICE.ucrss — Function
ucrss(v1, v2)
Deprecated

Use LinearAlgebra.normalize(LinearAlgebra.cross(v1, v2)) instead.

source
SPICE.uddf — Method
uddf(udfunc, x, dx)

Routine to calculate the first derivative of a caller-specified function using a three-point estimation.

Arguments

  • udfunc: A callable that computes the scalar value of interest, e.g. f(x::Float64) -> Float64
  • x: Independent variable of udfunc
  • dx: Interval from x for derivative calculation

Output

Returns the approximate derivative of udfunc at x.

References

source
SPICE.unitim — Method
unitim(epoch, insys, outsys)

Transform time from one uniform scale to another.

Arguments

  • epoch: An epoch to be converted
  • insys: The time scale associated with the input epoch
  • outsys: The time scale associated with the function value

The uniform time scales are:

  • :TAI
  • :TDT
  • :TDB
  • :ET
  • :JED
  • :JDTDB
  • :JDTDT

Output

Returns the time in the system specified by outsys that is equivalent to the epoch in the insys time scale.

References

source
SPICE.unorm — Function
unorm(v1)
Deprecated

Use (LinearAlgebra.normalize(v1), LinearAlgebra.norm(v1)) instead.

source
SPICE.unormg — Function
unormg(v1)
Deprecated

Use (LinearAlgebra.normalize(v1), LinearAlgebra.norm(v1)) instead.

source
SPICE.utc2et — Method
utc2et(utcstr)

Convert an input time from Calendar or Julian Date format, UTC, to ephemeris seconds past J2000.

Arguments

  • utcstr: Input time string, UTC

Output

Returns the equivalent of utcstr, expressed in ephemeris seconds past J2000.

References

source
SPICE.valid! — Method
valid!(set::SpiceCell{T}) where T

Create a valid SPICE set from a SPICE Cell of any data type.

Arguments

  • set: Set to be validated

Output

Returns the validated set with ordered elements and duplicates removed.

References

source
SPICE.vcrss — Function
vcrss(v1, v2)
Deprecated

Use LinearAlgebra.cross(v1, v2) instead.

source
SPICE.vdist — Function
vdist(v1, v2)
Deprecated

Use LinearAlgebra.norm(v1 .- v2) instead.

source
SPICE.vdistg — Function
vdistg(v1, v2)
Deprecated

Use LinearAlgebra.norm(v1 .- v2) instead.

source
SPICE.vdot — Function
vdot(v1, v2)
Deprecated

Use LinearAlgebra.dot(v1, v2) instead.

source
SPICE.vdotg — Function
vdotg(v1, v2)
Deprecated

Use LinearAlgebra.dot(v1, v2) instead.

source
SPICE.vhat — Function
vhat(v1)
Deprecated

Use LinearAlgebra.normalize(v1) instead.

source
SPICE.vhatg — Function
vhatg(v1)
Deprecated

Use LinearAlgebra.normalize(v1) instead.

source
SPICE.vlcom — Function
vlcom(a, v1, b, v2)
Deprecated

Use a .* v1 .+ b .* v2 instead.

source
SPICE.vlcom3 — Function
vlcom3(a, v1, b, v2, c, v3)
Deprecated

Use a .* v1 .+ b .* v2 .+ c .* v3 instead.

source
SPICE.vlcomg — Function
vlcomg(a, v1, b, v2)
Deprecated

Use a .* v1 .+ b .* v2 instead.

source
SPICE.vnormg — Function
vnormg(v1, v2)
Deprecated

Use LinearAlgebra.norm(v1) instead.

source
SPICE.vperp — Method
vperp(a, b)

Find the component of a vector that is perpendicular to a second vector.

Arguments

  • a: The vector whose orthogonal component is sought
  • b: The vector used as the orthogonal reference

Output

Returns the component a orthogonal to b.

References

source
SPICE.vprjp — Method
vprjp(vin, plane)

Project a vector onto a specified plane, orthogonally.

Arguments

  • vin: Vector to be projected
  • plane: Plane onto which vin is projected

Output

Returns the vector resulting from the projection.

References

source
SPICE.vprjpi — Method
vprjpi(vin, projpl, invpl)

Find the vector in a specified plane that maps to a specified vector in another plane under orthogonal projection.

Arguments

  • vin: The projected vector
  • projpl: Plane containing vin
  • invpl: Plane containing inverse image of vin

Output

Returns the inverse projection of vin or nothing if vin could not be calculated.

References

source
SPICE.vproj — Method
vproj(a, b)

Finds the projection of one vector onto another vector. All vectors are 3-dimensional.

Arguments

  • a: The vector to be projected
  • b: The vector onto which a is to be projected

Output

Returns the projection of a onto b.

References

source
SPICE.vrel — Method
vrel(v1, v2)

Return the relative difference between two 3-dimensional vectors.

Arguments

  • v1, v2: Two three-dimensional input vectors

Output

Returns the relative differences between v1 and v2.

References

source
SPICE.vrelg — Method
vrelg(v1, v2)

Return the relative difference between two vectors.

Arguments

  • v1, v2: Input vectors

Output

Returns the relative differences between v1 and v2.

References

source
SPICE.vrotv — Method
vrotv(v, axis, theta)

Rotate a vector about a specified axis vector by a specified angle and return the rotated vector.

Arguments

  • v: Vector to be rotated
  • axis: Axis of the rotation
  • theta: Angle of rotation (radians)

Output

Result of rotating v about axis by theta.

References

source
SPICE.vsep — Method
vsep(v1, v2)

Return the sepative difference between two 3-dimensional vectors.

Arguments

  • v1, v2: Two three-dimensional input vectors

Output

Returns the angle between v1 and v2 in radians.

References

source
SPICE.vsepg — Method
vsepg(v1, v2)

Return the sepative difference between two vectors.

Arguments

  • v1, v2: Input vectors

Output

Returns the angle between v1 and v2 in radians.

References

source
SPICE.vtmv — Function
vtmv(v1, matrix, v2)
Deprecated

Use v1' * matrix * v2 instead.

source
SPICE.vtmvg — Function
vtmvg(v1, matrix, v2)
Deprecated

Use v1' * matrix * v2 instead.

source
SPICE.wncomd — Method
wncomd(window, left, right)

Determine the complement of a double precision window with respect to a specified interval.

Arguments

  • window: Input window
  • left: Left endpoint of the complement interval
  • right: Right endpoint of the complement interval

Output

Returns the complement of window with respect to [left,right].

References

source
SPICE.wncond! — Method
wncond!(window, left, right)

Contract each of the intervals of a double precision window.

Arguments

  • window: Window to be contracted
  • left: Amount added to each left endpoint
  • right: Amount subtracted from each right endpoint

Output

Returns the contracted window.

References

source
SPICE.wndifd — Method
wndifd(a, b)

Place the difference of two double precision windows into a third window.

Arguments

  • a: Input window
  • b: Input window

Output

Returns a window containing the difference of a and b.

References

source
SPICE.wnelmd — Method
wnelmd(window, point)

Determine whether a point is an element of a double precision window.

Arguments

  • window: Input window
  • point: Input point

Output

Returns true if point is an element of window.

References

source
SPICE.wnexpd! — Method
wnexpd(window, left, right)

Expand each of the intervals of a double precision window.

Arguments

  • left: Amount subtracted from each left endpoint
  • right: Amount added to each right endpoint

Output

Returns the expanded window.

References

source
SPICE.wnextd! — Method
wnextd!(window, side)

Extract the left or right endpoints from a double precision window.

Arguments

  • window: Window to be extracted
  • side: Extract left (:L) or right (:R) endpoints

Output

Returns the extracted window.

References

source
SPICE.wnfetd — Method
wnfetd(window, n)

Fetch a particular interval from a double precision window.

Arguments

  • window: Input window
  • n: Index of interval to be fetched

Output

Returns a tuple consisting of the left and right endpoints of the n-th interval in the input window.

References

source
SPICE.wnfild! — Method
wnfild!(window, small)

Fill small gaps between adjacent intervals of a double precision window.

Arguments

  • window: Window to be filled
  • small: Limiting measure of small gaps

Output

Returns the updated window.

References

source
SPICE.wnfltd! — Method
wnfild!(window, small)

Filter (remove) small intervals from a double precision window.

Arguments

  • window: Window to be filtered
  • small: Limiting measure of small intervals

Output

Returns the updated window.

References

source
SPICE.wnincd — Method
wnincd(window, left, right)

Determine whether an interval is included in a double precision window.

Arguments

  • window: Input window
  • left: Left endpoint of the input interval
  • right: Right endpoint of the input interval

Output

Returns true when (left, right) is contained in window.

References

source
SPICE.wninsd! — Method
wninsd!(window, left, right)

Insert an interval into a double precision window.

Arguments

  • window: Input window
  • left: Left endpoint of the new interval
  • right: Right endpoint of the new interval

Output

Returns the updated windows.

References

source
SPICE.wnintd — Method
wnintd(a, b)

Place the intersection of two double precision windows into a third window.

Arguments

  • a: Input window
  • b: Input window

Output

Returns a window containing the intersection of a and b.

References

source
SPICE.wnreld — Method
wnreld(a, op, b)

Compare two double precision windows.

Note

Consider using overloaded operators instead, i.e. a == b, a ⊆ b, and a ⊊ b.

Arguments

  • a: First window
  • op: Comparison operator
  • b: Second window

Output

Returns the result of comparison a (op) b.

References

source
SPICE.wnsumd — Method
wnsumd(window)

Summarize the contents of a double precision window.

Arguments

  • window: Window to be summarized

Output

Returns a tuple consisting of:

  • meas: Total measure of intervals in window
  • avg: Average measure
  • stddev: Standard deviation
  • shortest: Location of shortest interval
  • longest: Location of longest interval

References

source
SPICE.wnunid — Method
wnunid(a, b)

Place the union of two double precision windows into a third window.

Arguments

  • a: Input window
  • b: Input window

Output

Returns a window containing the union of a and b.

References

source
SPICE.wnvald! — Method
wnvald!(window)

Form a valid double precision window from the contents of a window array.

Arguments

  • window: A (possibly uninitialized) SpiceDoubleCell containing endpoints of (possibly unordered and non-disjoint) intervals.

Output

Returns the validated window.

References

source
SPICE.xf2eul — Method
xf2eul(xform, axisa, axisb, axisc)

Convert a state transformation matrix to Euler angles and their derivatives with respect to a specified set of axes.

Arguments

  • xform: A state transformation matrix
  • axisa: Axis A of the Euler angle factorization
  • axisb: Axis B of the Euler angle factorization
  • axisc: Axis C of the Euler angle factorization

Output

Returns a tuple of an array of Euler angles and their derivatives and a boolean that indicates whether these are a unique representation.

References

source
SPICE.xf2rav — Method
xf2rav(xform)

Determines the rotation matrix and angular velocity of the rotation from a state transformation matrix.

Arguments

  • xform: State transformation matrix

Output

Returns a tuple of the rotation matrix and the angular velocity vector associated with xform.

References

source
SPICE.xfmsta — Method
xfmsta(input_state, input_coord_sys, output_coord_sys, body)

Transform a state between coordinate systems.

Arguments

  • input_state: Input state
  • input_coord_sys: Current (input) coordinate system
  • output_coord_sys: Desired (output) coordinate system
  • body: Name or NAIF ID of body with which coordinates are associated (if applicable)

Output

Returns the converted output state.

References

source
+API · SPICE.jl
Edit on GitHub

API

SPICE.SpiceCharCell — Type
SpiceCharCell(size, length)

Create a SpiceCharCell that can contain up to size strings with length characters.

source
Base.append! — Method
append!(cell, collection)

Append all items from collection to the char/double/integer SpiceCell cell.

source
Base.copy — Method
copy(cell::SpiceCell)

Duplicate the SpiceCell cell.

source
Base.diff — Method
diff(a::T, b::T) where T <: SpiceCell

Compute the difference of two sets of any data type to form a third set.

Arguments

  • a: First input set
  • b: Second input set

Output

Returns a cell containing the difference of a and b.

References

source
Base.length — Method
length(cell)

Returns the cardinality (number of elements) of cell.

source
Base.push! — Method
push!(cell, items...)

Insert one or more items at the end of the char/double/integer SpiceCell cell.

source
Base.union — Method
union(a::T, b::T) where T <: SpiceCell

Compute the union of two sets of any data type to form a third set.

Arguments

  • a: First input set
  • b: Second input set

Output

Returns a cell containing the union of a and b.

References

source
SPICE.axisar — Method
axisar(axis, angle)

Construct a rotation matrix that rotates vectors by a specified angle about a specified axis.

Arguments

  • axis: Rotation axis
  • angle: Rotation angle in radians

Output

Rotation matrix corresponding to axis and angle

References

source
SPICE.azlrec — Method
azlrec(range, az, el, azccw, elplsz)

Convert from range, azimuth and elevation of a point to rectangular coordinates.

Arguments

  • range: Distance of the point from the origin
  • az: Azimuth in radians
  • el: Elevation in radians
  • azccw: Flag indicating how azimuth is measured. If true, the azimuth increases in the counterclockwise direction; otherwise it increases in the clockwise direction
  • elplsz: Flag indicating how elevation is measured. If true, the elevation increases from the XY plane toward +Z; otherwise toward -Z

Output

  • rectan: Rectangular coordinates of the point

References

source
SPICE.badkpv — Method
badkpv(caller, name, comp, size, divby, typ)

Determine if a kernel pool variable is present and if so that it has the correct size and type.

Arguments

  • caller: Name of the routine calling this routine
  • name: Name of a kernel pool variable
  • comp: Comparison operator
  • size: Expected size of the kernel pool variable
  • divby: A divisor of the size of the kernel pool variable
  • type: Expected type of the kernel pool variable

Output

The function returns false if the kernel pool variable is OK otherwise an exception is thrown.

References

source
SPICE.bltfrm — Method
bltfrm(frmcls)

Return a SPICE set containing the frame IDs of all built-in frames of a specified class.

Arguments

  • frmcls: Frame class

Output

  • idset: Set of ID codes of frames of the specified class

References

source
SPICE.bodc2n — Method
bodc2n(code)

Translate the SPICE integer code of a body into a common name for that body.

Arguments

  • code: Integer ID code to be translated into a name

Output

A common name for the body identified by code or nothing if none was found.

References

source
SPICE.bodc2s — Method
bodc2s(code)

Translate a body ID code to either the corresponding name or if no name to ID code mapping exists, the string representation of the body ID value.

Arguments

  • code: Integer ID code to translate to a string

Output

Returns a string corresponding to code

References

source
SPICE.bodfnd — Method
bodfnd(body, item)

Determine whether values exist for some item for any body in the kernel pool.

Arguments

  • body: ID code of body
  • item: Item to find ("RADII", "NUTAMPRA", etc.)

Output

Returns true if the item is in the kernel pool and false if it is not.

References

source
SPICE.bodn2c — Method
bodn2c(name)

Translate the name of a body or object to the corresponding SPICE integer ID code.

Arguments

  • name: Body name to be translated into a SPICE ID code

Output

Return the SPICE integer ID code for the named body or nothing if none was found.

References

source
SPICE.bods2c — Method
bods2c(name)

Translate a string containing a body name or ID code to an integer code.

Arguments

  • name: String to be translated to an ID code

Output

Retunrs the integer ID code corresponding to name or nothing if none as found.

References

source
SPICE.bodvcd — Function
bodvcd(bodyid, item)

Fetch from the kernel pool the double precision values of an item associated with a body, where the body is specified by an integer ID code.

Arguments

  • bodyid: Body ID code
  • item: Item for which values are desired. ("RADII", "NUT_PREC_ANGLES", etc.)
  • maxn: Maximum number of values that may be returned (default: 100)

Output

Returns the requested values.

References

source
SPICE.bodvrd — Function
bodvrd(bodynm, item)

Fetch from the kernel pool the double precision values of an item associated with a body.

Arguments

  • bodynm: Body name
  • item: Item for which values are desired. ("RADII", "NUT_PREC_ANGLES", etc.)
  • maxn: Maximum number of values that may be returned (default: 100)

Output

  • values: Values

References

source
SPICE.brcktd — Function
brcktd(number, e1, e2)
Deprecated

Use clamp from Julia's standard library instead.

source
SPICE.brckti — Function
brckti(number, e1, e2)
Deprecated

Use clamp from Julia's standard library instead.

source
SPICE.bschoc — Function
bschoc(value, array, order)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.bschoi — Function
bschoi(value, array, order)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.bsrchc — Function
bsrchc(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.bsrchd — Function
bsrchd(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.bsrchi — Function
bsrchi(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.card — Method
card(cell)

Returns the cardinality (number of elements) of cell.

source
SPICE.ccifrm — Method
ccifrm(frclss, clssid)

Return the frame name, frame ID, and center associated with a given frame class and class ID.

Arguments

  • frclss: Class of frame
  • clssid: Class ID of frame

Output

Returns nothing if no frame was found or

  • frcode: ID code of the frame
  • frname: Name of the frame
  • center: ID code of the center of the frame

References

source
SPICE.cgv2el — Method
cgv2el(center, vec1, vec2)

Form an ellipse from a center vector and two generating vectors.

Arguments

  • center: Center vector
  • vec1: Generating vector
  • vec2: Generating vector

Output

Returns the ellipse defined by the input vectors.

References

source
SPICE.chbder — Method
chbder(cp, x2s, x, nderiv)

Given the coefficients for the Chebyshev expansion of a polynomial, this returns the value of the polynomial and its first nderiv derivatives evaluated at the input x.

Arguments

  • cp: Chebyshev polynomial coefficients
  • x2s: Transformation parameters of polynomial
  • x: Value for which the polynomial is to be evaluated
  • nderiv: The number of derivatives to compute

Output

Returns the derivatives of the polynomial.

References

source
SPICE.cidfrm — Method
cidfrm(cent)

Retrieve frame ID code and name to associate with a frame center.

Arguments

  • cent: ID code for an object for which there is a preferred reference frame

Output

Returns nothing if no frame was found or

  • frcode: The ID code of the frame associated with cent
  • frname: The name of the frame with ID frcode

References

source
SPICE.ckcov! — Method
ckcov!(ck, idcode, needav, level, tol, timsys, cover)

Find the coverage window for a specified object in a specified CK file.

Arguments

  • ck: Name of CK file
  • idcode: ID code of object
  • needav: Flag indicating whether angular velocity is needed
  • level: Coverage level: "SEGMENT" OR "INTERVAL"
  • tol: Tolerance in ticks
  • timsys: Time system used to represent coverage
  • cover: Window giving coverage for idcode. Data already present in cover will be combined with coverage found for the object designated by idcode in the file ck.

References

source
SPICE.ckcov — Method
ckcov(ck, idcode, needav, level, tol, timsys)

Find the coverage window for a specified object in a specified CK file.

Arguments

  • ck: Name of CK file
  • idcode: ID code of object
  • needav: Flag indicating whether angular velocity is needed
  • level: Coverage level: "SEGMENT" OR "INTERVAL"
  • tol: Tolerance in ticks
  • timsys: Time system used to represent coverage

Output

Window giving coverage for idcode

References

source
SPICE.ckgp — Method
ckgp(inst, sclkdp, tol, ref)

Get pointing (attitude) for a specified spacecraft clock time.

Arguments

  • inst: NAIF ID of instrument, spacecraft, or structure
  • sclkdp: Encoded spacecraft clock time
  • tol: Time tolerance
  • ref: Reference frame

Outputs

Returns nothing if the requested pointing is not available or

  • cmat: C-matrix pointing data
  • clkout: Output encoded spacecraft clock time

References

source
SPICE.ckgpav — Method
ckgpav(inst, sclkdp, tol, ref)

Get pointing (attitude) and angular velocity for a specified spacecraft clock time.

Arguments

  • inst: NAIF ID of instrument, spacecraft, or structure
  • sclkdp: Encoded spacecraft clock time
  • tol: Time tolerance
  • ref: Reference frame

Outputs

Returns nothing if the requested pointing is not available or

  • cmat: C-matrix pointing data
  • av: Angular velocity vector
  • clkout: Output encoded spacecraft clock time

References

source
SPICE.cklpf — Method
cklpf(filename)

Load a CK pointing file for use by the CK readers. Return that file's handle, to be used by other CK routines to refer to the file.

Arguments

  • filename: Name of the CK file to be loaded

Output

Loaded file's handle

References

source
SPICE.ckobj! — Method
ckobj!(ck, ids)

Find the set of ID codes of all objects in a specified CK file.

Arguments

  • ck: Name of CK file
  • ids: Set of ID codes of objects in CK file. Data already present in ids will be combined with ID code set found for the file ck.

References

source
SPICE.ckobj — Method
ckobj(ck)

Find the set of ID codes of all objects in a specified CK file.

Arguments

  • ck: Name of CK file

Output

Set of ID codes of objects in CK file.

References

source
SPICE.ckopn — Function
ckopn(fname, ifname="CK_file", ncomch=0)

Open a new CK file, returning the handle of the opened file.

Arguments

  • fname: The name of the CK file to be opened
  • ifname: The internal filename for the CK (default: "CK_file")
  • ncomch: The number of characters to reserve for comments (default: 0)

Output

  • handle: The handle of the opened CK file

References

source
SPICE.ckupf — Method
ckupf(handle)

Unload a CK pointing file so that it will no longer be searched by the readers.

Arguments

  • handle: Handle of CK file to be unloaded

References

source
SPICE.ckw01 — Function
ckw01(handle, begtim, endtim, inst, ref, segid, sclkdp, quats, avvs=[zeros(3)])

Add a type 1 segment to a C-kernel.

Arguments

  • handle: Handle of an open CK file
  • begtim: The beginning encoded SCLK of the segment
  • endtim: The ending encoded SCLK of the segment
  • inst: The NAIF instrument ID code
  • ref: The reference frame of the segment
  • segid: Segment identifier
  • sclkdp: Encoded SCLK times
  • quats: Quaternions representing instrument pointing
  • avvs: Angular velocity vectors (optional)

References

source
SPICE.ckw02 — Method
ckw02(handle, begtim, endtim, inst, ref, segid, start, stop, quats, avvs, rates)

Write a type 2 segment to a C-kernel.

Arguments

  • handle: Handle of an open CK file
  • begtim: The beginning encoded SCLK of the segment
  • endtim: The ending encoded SCLK of the segment
  • inst: The NAIF instrument ID code
  • ref: The reference frame of the segment
  • segid: Segment identifier
  • start: Encoded SCLK interval start times
  • stop: Encoded SCLK interval stop times
  • quats: Quaternions representing instrument pointing
  • avvs: Angular velocity vectors
  • rates: Number of seconds per tick for each interval

References

source
SPICE.ckw03 — Function
ckw03(handle, begtim, endtim, inst, ref, segid, sclkdp, quats, starts, avvs=[zeros(3)])

Add a type 3 segment to a C-kernel.

Arguments

  • handle: Handle of an open CK file
  • begtim: The beginning encoded SCLK of the segment
  • endtim: The ending encoded SCLK of the segment
  • inst: The NAIF instrument ID code
  • ref: The reference frame of the segment
  • segid: Segment identifier
  • sclkdp: Encoded SCLK times
  • quats: Quaternions representing instrument pointing
  • starts: Encoded SCLK interval start times
  • avvs: Angular velocity vectors (optional)

References

source
SPICE.ckw05 — Method
ckw05(handle, subtyp, degree, begtim, endtim, inst, ref, avflag, segid, sclkdp, packts,
+      rate, nints, starts)

Write a type 5 segment to a CK file.

Arguments

  • handle: Handle of an open CK file
  • subtyp: CK type 5 subtype code
  • degree: Degree of interpolating polynomials
  • begtim: The beginning encoded SCLK of the segment
  • endtim: The ending encoded SCLK of the segment
  • inst: The NAIF instrument ID code
  • ref: The reference frame of the segment
  • avflag: True if the segment will contain angular velocity
  • segid: Segment identifier
  • sclkdp: Encoded SCLK times
  • packts: Array of packets
  • rate: Nominal SCLK rate in seconds per tick
  • nints: Number of intervals
  • starts: Encoded SCLK interval start times

References

source
SPICE.cmprss — Method
cmprss(delim, n, input)

Compress a character string by removing occurrences of more than n consecutive occurrences of a specified character.

Arguments

  • delim: Delimiter to be compressed
  • n: Maximum consecutive occurrences of delim
  • input: Input string

Output

Returns the compressed string.

References

source
SPICE.cnmfrm — Function
cnmfrm(cname)

Retrieve frame ID code and name to associate with an object.

Arguments

  • cname: Name of the object to find a frame for

Output

Returns a tuple of the ID code and the name of the frame associated with cname or nothing if no frame is found.

References

source
SPICE.conics — Method
conics(elts, et)

Determine the state (position, velocity) of an orbiting body from a set of elliptic, hyperbolic, or parabolic orbital elements.

Arguments

  • elts: Conic elements
  • et: Input time

Output

Returns the state of orbiting body at et.

References

source
SPICE.convrt — Method
convrt(x, in, out)

Take a measurement x, the units associated with x, and units to which x should be converted; return y - the value of the measurement in the output units.

Arguments

  • x: Number representing a measurement in some units
  • in: The units in which x is measured
  • out: Desired units for the measurement

Output

Returns the measurement in the desired units.

References

source
SPICE.cpos — Method
cpos(str, chars, start)

Find the first occurrence in a string of a character belonging to a collection of characters, starting at a specified location, searching forward.

Arguments

  • str: Any character string
  • chars: A collection of characters
  • start: Position to begin looking for one of chars

Output

Returns the index of the first character of str that is one of the characters in string chars. Returns -1 if none of the characters was found.

References

source
SPICE.cposr — Method
cposr(str, chars, start)

Find the first occurrence in a string of a character belonging to a collection of characters, starting at a specified location, searching in reverse.

Arguments

  • str: Any character string
  • chars: A collection of characters
  • start: Position to begin looking for one of chars

Output

Returns the index of the last character of str that is one of the characters in string chars. Returns -1 if none of the characters was found.

References

source
SPICE.cvpool — Method
cvpool(agent)

Indicate whether or not any watched kernel variables that have a specified agent on their notification list have been updated.

Arguments

  • agent: Name of the agent to check for notices

Output

Returns true if variables for agent have been updated.

References

source
SPICE.cyllat — Method
cyllat(r, lonc, z)

Convert from cylindrical to latitudinal coordinates.

Arguments

  • r: Distance of point from z axis
  • lonc: Cylindrical angle of point from XZ plane (radians)
  • z: Height of point above XY plane

Output

  • radius: Radius
  • lon: Longitude (radians)
  • lat: Latitude (radians)

References

source
SPICE.cylrec — Method
cylrec(r, lon, z)

Convert from cylindrical to rectangular coordinates.

Arguments

  • r: Distance of the point of interest from z axis
  • lon: Cylindrical angle (in radians) of the point of interest from XZ plane
  • z: Height of the point above XY plane

Output

Returns rectangular coordinates of the point of interest.

References

source
SPICE.cylsph — Method
cylsph(r, lonc, z)

Convert from cylindrical to spherical coordinates.

Arguments

  • r: Distance of point from z axis
  • lonc: Angle (radians) of point from XZ plane
  • z: Height of point above XY plane

Output

  • radius: Distance of the point from the origin
  • colat: Polar angle (co-latitude in radians)
  • lon: Azimuthal angle (longitude)

References

source
SPICE.dafac — Method
dafac(handle, buffer)

Add comments from a buffer of character strings to the comment area of a binary DAF file, appending them to any comments which are already present in the file's comment area.

Arguments

  • handle: Handle of a DAF opened with write access
  • buffer: Buffer of comments to put into the comment area

References

source
SPICE.dafcls — Method
dafcls(handle)

Close the DAF associated with a given handle.

Arguments

  • handle: Handle of DAF to be closed

Output

Returns the handle of the closed file.

References

source
SPICE.dafcs — Method
dafcs(handle)

Select a DAF that already has a search in progress as the one to continue searching.

Arguments

  • handle: Handle of DAF to continue searching

References

source
SPICE.dafdc — Method
dafdc(handle)

Delete the entire comment area of a specified DAF file.

Arguments

  • handle: The handle of a binary DAF opened for writing

References

source
SPICE.dafec — Method
dafec(handle; bufsiz=256, lenout=1024)

Extract comments from the comment area of a binary DAF.

Arguments

  • handle: Handle of binary DAF opened with read access
  • bufsiz: Maximum size, in lines, of buffer (default: 256)
  • lenout: Length of strings in output buffer (default: 1024)

Output

Returns a buffer where extracted comment lines are placed.

References

source
SPICE.dafgda — Method
dafgda(handle, start, stop)

Read the double precision data bounded by two addresses within a DAF.

Arguments

  • handle: Handle of a DAF
  • start, stop: Initial, final address within file

Output

Returns the data contained between start and stop.

References

source
SPICE.dafgn — Function
dafgn(lenout=128)

Return (get) the name for the current array in the current DAF.

Arguments

  • lenout: Length of array name string (default: 128)

Output

Returns the name of the current array.

References

source
SPICE.dafgs — Function
dafgs(lenout=128)

Return (get) the summary for the current array in the current DAF.

Arguments

  • lenout: The maximum length of the summary array

Output

Returns the summary for the current array.

References

source
SPICE.dafgsr — Method

Read a portion of the contents of a summary record in a DAF file.

Arguments

  • handle: Handle of DAF
  • recno: Record number
  • start: First word to read from record
  • stop: Last word to read from record

Output

Returns the contents of the record or nothing if none was found.

References

source
SPICE.dafopr — Method
dafopr(fname)

Open a DAF for subsequent read requests.

Arguments

  • fname: Name of DAF to be opened

Output

Returns the handle assigned to DAF.

References

source
SPICE.dafopw — Method
dafopw(fname)

Open a DAF for subsequent write requests.

Arguments

  • fname: Name of DAF to be opened

Output

Returns the handle assigned to DAF.

References

source
SPICE.dafps — Method
dafps(dc, ic)

Pack (assemble) an array summary from its double precision and integer components.

Arguments

  • dc: Double precision components
  • ic: Integer components

Output

Returns the array summary.

References

source
SPICE.dafrfr — Function
dafrfr(handle, lenout=128)

Read the contents of the file record of a DAF.

Arguments

  • handle: Handle of an open DAF file
  • lenout: Available room in the output string `ifname' (default: 128)

Output

  • nd: Number of double precision components in summaries
  • ni: Number of integer components in summaries
  • ifname: Internal file name
  • fward: Forward list pointer
  • bward: Backward list pointer
  • free: Free address pointer

References

source
SPICE.dafus — Method
dafus(sum, nd, ni)

Unpack an array summary into its double precision and integer components.

Arguments

  • sum: Array summary
  • nd: Number of double precision components
  • ni: Number of integer components

Output

  • dc: Double precision components
  • ic: Integer components

References

source
SPICE.dasac — Method
dasac(handle, buffer)

Add comments from a buffer of character strings to the comment area of a binary DAS file, appending them to any comments which are already present in the file's comment area.

Arguments

  • handle: Handle of a DAS opened with write access
  • buffer: Buffer of comments to put into the comment area

References

source
SPICE.dascls — Method
dascls(handle)

Close the DAS associated with a given handle.

Arguments

  • handle: Handle of DAS to be closed

Output

Returns the handle of the closed file.

References

source
SPICE.dasdc — Method
dasdc(handle)

Delete the entire comment area of a specified DAS file.

Arguments

  • handle: The handle of a binary DAS opened for writing

References

source
SPICE.dasec — Method
dasec(handle; bufsiz=256, lenout=1024)

Extract comments from the comment area of a binary DAS.

Arguments

  • handle: Handle of binary DAS opened with read access
  • bufsiz: Maximum size, in lines, of buffer (default: 256)
  • lenout: Length of strings in output buffer (default: 1024)

Output

Returns a buffer where extracted comment lines are placed.

References

source
SPICE.dashfn — Function
dashfn(handle, namelen=256)

Return the name of the DAS file associated with a handle.

Arguments

  • handle: Handle of a DAS file
  • namlen: Length of output file name string (default: 256)

Output

Returns the corresponding file name.

References

source
SPICE.dasopr — Method
dasopr(fname)

Open a DAS for subsequent read requests.

Arguments

  • fname: Name of DAS to be opened

Output

Returns the handle assigned to DAS.

References

source
SPICE.dasopw — Method
dasopw(fname)

Open a DAS for subsequent write requests.

Arguments

  • fname: Name of DAS to be opened

Output

Returns the handle assigned to DAS.

References

source
SPICE.dasrfr — Function
dasrfr(handle, idwlen=128, ifnlen=256)

Read the contents of the file record of a DAS.

Arguments

  • handle: DAS file handle
  • idwlen: Length of ID word string (default: 128)
  • ifnlen: Length of internal file name string (default: 256)

Output

  • idword: ID word
  • ifname: DAS internal file name
  • nresvr: Number of reserved records in file
  • nresvc: Number of characters in use in reserved records area
  • ncomr: Number of comment records in file
  • ncomc: Number of characters in use in comment area

References

source
SPICE.dazldr — Method
dazldr(x, y, z, azccw, elplsz)

Compute the Jacobian matrix of the transformation from rectangular to azimuth/elevation coordinates.

Arguments

  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point
  • azccw: Flag indicating how azimuth is measured. If true, the azimuth increases in the counterclockwise direction; otherwise it increases in the clockwise direction
  • elplsz: Flag indicating how elevation is measured. If true, the elevation increases from the XY plane toward +Z; otherwise toward -Z

Output

Returns the matrix of partial derivatives.

References

source
SPICE.dcyldr — Method
dcyldr(x, y, z)

Compute the Jacobian of the transformation from rectangular to cylindrical coordinates.

Arguments

  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point

Output

Returns the matrix of partial derivatives.

References

source
SPICE.deltet — Method
deltet(epoch, eptype)

Return the value of ΔET (ET-UTC) for an input epoch.

Arguments

  • epoch: Input epoch (seconds past J2000)
  • eptype: Type of input epoch ("UTC" or "ET")

Output

Returns ΔET (ET-UTC) at input epoch.

References

source
SPICE.dgeodr — Method
dgeodr(x, y, z, re, f)

Compute the Jacobian of the transformation from rectangular to geodetic coordinates.

Arguments

  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

Returns the matrix of partial derivatives.

References

source
SPICE.diags2 — Method
diags2(symmat)

Diagonalize a symmetric 2x2 matrix.

Arguments

  • symmat: A symmetric 2x2 matrix

Output

  • diag: A diagonal matrix similar to symmat
  • rotate: A rotation used as the similarity transformation

References

source
SPICE.dlabbs — Method
dlabbs(handle)

Begin a backward segment search in a DLA file.

Arguments

  • handle: Handle of open DLA file

Output

Returns the descriptor of the last segment in the DLA file or nothing if none was found.

References

source
SPICE.dlabfs — Method
dlabfs(handle)

Begin a forward segment search in a DLA file.

Arguments

  • handle: Handle of open DLA file

Output

Returns the descriptor of the first segment in the DLA file or nothing if none was found.

References

source
SPICE.dlafns — Method
dlafns(handle, descr)

Find the segment following a specified segment in a DLA file.

Arguments

  • handle: Handle of open DLA file
  • descr: Descriptor of a DLA segment

Output

Returns the descriptor of the next segment in the DLA file or nothing if none was found.

References

source
SPICE.dlafps — Method
dlafps(handle, descr)

Find the segment preceding a specified segment in a DLA file.

Arguments

  • handle: Handle of open DLA file
  • descr: Descriptor of a DLA segment

Output

Returns the descriptor of the previous segment in the DLA file or nothing if none was found.

References

source
SPICE.dlatdr — Method
dlatdr(x, y, z)

Compute the Jacobian of the transformation from rectangular to latitudinal coordinates.

Arguments

  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point

Output

Returns the matrix of partial derivatives.

References

source
SPICE.dp2hx — Function
dp2hx(number, lenout=128)

Convert a double precision number to an equivalent character string using base 16 "scientific notation."

Arguments

  • number: Number to be converted
  • lenout: Available space for output string

Output

Returns the equivalent character string, left justified.

References

source
SPICE.dpgrdr — Method
dpgrdr(x, y, z, re, f)

Compute the Jacobian of the transformation from rectangular to planetographic coordinates.

Arguments

  • body: Body with which coordinate system is associated
  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

Returns the matrix of partial derivatives.

References

source
SPICE.dpmax — Function
dpmax()
Deprecated

Use prevfloat(typemax(Float64)) instead.

source
SPICE.dpmin — Function
dpmin()
Deprecated

Use nextfloat(typemin(Float64)) instead.

source
SPICE.drdazl — Method
drdazl(range, az, el, azccw, elplsz)

Compute the Jacobian matrix of the transformation from azimuth/elevation to rectangular coordinates.

Arguments

  • range: Distance of a point from the origin
  • az: Azimuth of input point in radians
  • el: Elevation of input point in radians
  • azccw: Flag indicating how azimuth is measured. If true, the azimuth increases in the counterclockwise direction; otherwise it increases in the clockwise direction
  • elplsz: Flag indicating how elevation is measured. If true, the elevation increases from the XY plane toward +Z; otherwise toward -Z

Output

Returns the matrix of partial derivatives.

References

source
SPICE.drdcyl — Method
drdcyl(r, lon, z)

Compute the Jacobian of the transformation from cylindrical to rectangular coordinates.

Arguments

  • r: Distance of a point from the origin
  • lon: Angle of the point from the xz plane in radians
  • z: Height of the point above the xy plane

Output

Returns the matrix of partial derivatives.

References

source
SPICE.drdgeo — Method
drdgeo(lon, lat, alt, re, f)

Compute the Jacobian of the transformation from geodetic to rectangular coordinates.

Arguments

  • lon: Geodetic longitude of point (radians)
  • lat: Geodetic latitude of point (radians)
  • alt: Altitude of point above the reference spheroid
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

Returns the matrix of partial derivatives.

References

source
SPICE.drdlat — Method
drdlat(radius, lon, lat)

Compute the Jacobian of the transformation from latitudinal to rectangular coordinates.

Arguments

  • radius: Distance of a point from the origin
  • lon: Angle of the point from the XZ plane in radians
  • lat: Angle of the point from the XY plane in radians

Output

Returns the matrix of partial derivatives.

References

source
SPICE.drdpgr — Method
drdpgr(body, lon, lat, alt, re, f)

Compute the Jacobian matrix of the transformation from planetographic to rectangular coordinates.

Arguments

  • body: Name of body with which coordinates are associated
  • lon: Planetographic longitude of a point (radians)
  • lat: Planetographic latitude of a point (radians)
  • alt: Altitude of a point above reference spheroid
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

Returns the matrix of partial derivatives.

References

source
SPICE.drdsph — Method
drdsph(r, colat, lon)

Compute the Jacobian of the transformation from latitudinal to rectangular coordinates.

Arguments

  • r: Distance of a point from the origin
  • colat: Angle of the point from the positive z-axis
  • lon: Angle of the point from the xy plane

Output

Returns the matrix of partial derivatives.

References

source
SPICE.dskb02 — Method
dskb02(handle, dladsc)

Return bookkeeping data from a DSK type 2 segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor

Output

  • nv: Number of vertices in model
  • np: Number of plates in model
  • nvxtot: Number of voxels in fine grid
  • vtxbds: Vertex bounds
  • voxsiz: Fine voxel edge length
  • voxori: Fine voxel grid origin
  • vgrext: Fine voxel grid exent
  • cgscal: Coarse voxel grid scale
  • vtxnpl: Size of vertex-plate correspondence list
  • voxnpt: Size of voxel-plate pointer list
  • voxnpl: Size of voxel-plate correspondence list

References

source
SPICE.dskcls — Function
dskcls(handle, optmiz=true)

Close a DSK file.

Arguments

  • handle: Handle assigned to the opened DSK file
  • optmiz: Flag indicating whether to segregate the DSK (default: true)

References

source
SPICE.dskd02 — Method
dskd02(handle, dladsc, item, start, room)

Fetch double precision data from a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor
  • item: Keyword identifying item to fetch
  • start: Start index
  • room: Amount of room in output array

Output

Returns an array containing the requested item.

References

source
SPICE.dskgd — Method
dskgd(handle, dladsc)

Return the DSK descriptor from a DSK segment identified by a DAS handle and DLA descriptor.

Arguments

  • handle: Handle of a DSK file
  • dladsc: DLA segment descriptor

Output

Returns the DSK segment descriptor.

References

source
SPICE.dskgtl — Method
dskgtl(keywrd)

Retrieve the value of a specified DSK tolerance or margin parameter.

Arguments

  • keywrd: Code specifying parameter to retrieve

Output

Returns the value of the parameter.

References

source
SPICE.dski02 — Method
dski02(handle, dladsc, item, start, room)

Fetch integer data from a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor
  • item: Keyword identifying item to fetch
  • start: Start index
  • room: Amount of room in output array

Output

Returns an array containing the requested item.

References

source
SPICE.dskmi2 — Method
dskmi2(vrtces, plates, finscl, corscl, worksz, voxpsz, voxlsz, makvtl, spaisz)

Make spatial index for a DSK type 2 segment.

Arguments

  • vrtces: Vertices
  • plates: Plates
  • finscl: Fine voxel scale
  • corscl: Coarse voxel scale
  • worksz: Workspace size
  • voxpsz: Voxel-plate pointer array size
  • voxlsz: Voxel-plate list array size
  • makvtl: Vertex-plate list flag
  • spxisz: Spatial index integer component size

Output

  • spaixd: Double precision component of spatial index.
  • spaixi: Integer component of spatial index.

References

source
SPICE.dskn02 — Method
dskn02(handle, dladsc, plid)

Compute the unit normal vector for a specified plate from a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor
  • plid: Plate ID

Output

Return the plate's unit normal vector.

References

source
SPICE.dskobj! — Method
dskobj!(set, dsk)

Find the set of body ID codes of all objects for which topographic data are provided in a specified DSK file.

Arguments

  • dsk: Name of DSK file
  • set or len: Either a preallocated SpiceIntCell or the size of the output set.

Output

Returns the set of ID codes of objects in the DSK file.

References

source
SPICE.dskopn — Method
dskopn(fname, ifname, ncomch)

Open a new DSK file for subsequent write operations.

Arguments

  • fname: Name of a DSK file to be opened
  • ifname: Internal file name
  • ncomch: Number of comment characters to allocate

Output

Returns the handle assigned to the opened DSK file.

References

source
SPICE.dskp02 — Method
dskp02(handle, dladsc, start, room)

Fetch triangular plates from a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor
  • start: Start index
  • room: Amount of room in output array

Output

Returns an array of plates.

References

source
SPICE.dskrb2 — Method
dskrb2(vrtces, plates, corsys, corpar)

Determine range bounds for a set of triangular plates to be stored in a type 2 DSK segment.

Arguments

  • vrtces: Vertices
  • plates: Plates
  • corsys: DSK coordinate system code
  • corpar: DSK coordinate system parameters

Output

  • mncor3: Lower bound on range of third coordinate
  • mxcor3: Upper bound on range of third coordinate

References

source
SPICE.dsksrf! — Method
dsksrf!(set, dsk)

Find the set of surface ID codes of all objects for which topographic data are provided in a specified DSK file.

Arguments

  • dsk: Name of DSK file
  • set or len: Either a preallocated SpiceIntCell or the size of the output set.

Output

Returns the set of ID codes of surfaces in the DSK file.

References

source
SPICE.dskstl — Method
dskstl(keywrd)

Set the value of a specified DSK tolerance or margin parameter.

Arguments

  • keywrd: Code specifying parameter to retrieve
  • dpval: Value of parameter

References

source
SPICE.dskv02 — Method
dskv02(handle, dladsc, start, room)

Fetch vertices from a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor
  • start: Start index
  • room: Amount of room in output array

Output

Returns an array of vertices.

References

source
SPICE.dskw02 — Method
dskw02(handle, center, surfid, dclass, frame, corsys, corpar, mncor1, mxcor1,
+       mncor2, mxcor2, mncor3, mxcor3, first, last, vrtces, plates, spaixd, spaixi)

Write a type 2 segment to a DSK file.

Arguments

  • handle: Handle assigned to the opened DSK file
  • center: Central body ID code
  • surfid: Surface ID code
  • dclass: Data class
  • frame: Reference frame
  • corsys: Coordinate system code
  • corpar: Coordinate system parameters
  • mncor1: Minimum value of first coordinate
  • mxcor1: Maximum value of first coordinate
  • mncor2: Minimum value of second coordinate
  • mxcor2: Maximum value of second coordinate
  • mncor3: Minimum value of third coordinate
  • mxcor3: Maximum value of third coordinate
  • first: Coverage start time
  • last: Coverage stop time
  • nv: Number of vertices
  • vrtces: Vertices
  • np: Number of plates
  • plates: Plates
  • spaixd: Double precision component of spatial index
  • spaixi: Integer component of spatial index

References

source
SPICE.dskx02 — Method
dskx02(handle, dladsc, vertex, raydir)

Determine the plate ID and body-fixed coordinates of the intersection of a specified ray with the surface defined by a type 2 DSK plate model.

Arguments

  • handle: Handle of DSK kernel containing plate model
  • dladsc: DLA descriptor of plate model segment
  • vertex: Ray vertex in the body fixed frame
  • raydir: Ray direction in the body fixed frame

Output

Returns nothing if no intercept exists or

  • plid: ID code of the plate intersected by the ray
  • xpt: Intercept

References

source
SPICE.dskxsi — Function
dskxsi(pri, target, nsurf, srflst, et, fixref, vertex, raydir, maxd=1, maxi=1)

Compute a ray-surface intercept using data provided by multiple loaded DSK segments. Return information about the source of the data defining the surface on which the intercept was found: DSK handle, DLA and DSK descriptors, and DSK data type-dependent parameters.

Arguments

  • pri: Data prioritization flag
  • target: Target body name
  • srflst: Surface ID list
  • et: Epoch, expressed as seconds past J2000 TDB
  • fixref: Name of target body-fixed reference frame
  • vertex: Vertex of ray
  • raydir: Direction vector of ray
  • maxd: Size of DC array (default: 1)
  • maxi: Size of IC array (default: 1)

Output

Returns nothing if no intercept exists or

  • xpt: Intercept point
  • handle: Handle of segment contributing surface data
  • dladsc: DLA descriptor of segment
  • dskdsc: DSK descriptor of segment
  • dc: Double precision component of source info
  • ic: Integer component of source info

References

source
SPICE.dskxv — Method
dskxv(pri, target, srflst, et, fixref, nrays, vtxarr, dirarr)

Compute ray-surface intercepts for a set of rays, using data provided by multiple loaded DSK segments.

Arguments

  • pri: Data prioritization flag
  • target: Target body name
  • srflst: Surface ID list
  • et: Epoch, expressed as seconds past J2000 TDB
  • fixref: Name of target body-fixed reference frame
  • nrays: Number of rays
  • vtxarr: Array of vertices of rays
  • dirarr: Array of direction vectors of rays

Output

  • xptarr: Intercept point array
  • fndarr: Found flag array

References

source
SPICE.dskz02 — Method
dskz02(handle, dladsc)

Return plate model size parameters - plate count and vertex count - for a type 2 DSK segment.

Arguments

  • handle: DSK file handle
  • dladsc: DLA descriptor

Output

  • nv: Number of vertices
  • np: Number of plates

References

source
SPICE.dsphdr — Method
dsphdr(x, y, z)

Compute the Jacobian of the transformation from rectangular to spherical coordinates.

Arguments

  • x: X-coordinate of point
  • y: Y-coordinate of point
  • z: Z-coordinate of point

Output

Returns the matrix of partial derivatives.

References

source
SPICE.dtpool — Method
dtpool(name)

Return the data about a kernel pool variable.

Arguments

  • name: Name of the variable whose value is to be returned

Output

Returns the tuple (n ,vartype).

  • n: Number of values returned for name
  • vartype: Type of the variable
    • :C if the data is character data
    • :N if the data is numeric
    • :X if there is no variable name in the pool

References

source
SPICE.ducrss — Method
ducrss(s1, s2)

Compute the unit vector parallel to the cross product of two 3-dimensional vectors and the derivative of this unit vector.

Arguments

  • s1: Left hand state for cross product and derivative
  • s2: Right hand state for cross product and derivative

Output

Returns the unit vector and derivative of the cross product.

References

source
SPICE.dvcrss — Method
dvcrss(s1, s2)

Compute the cross product of two 3-dimensional vectors and the derivative of this cross product.

Arguments

  • s1: Left hand state for cross product and derivative
  • s2: Right hand state for cross product and derivative

Output

Returns the cross product and its derivative.

References

source
SPICE.dvdot — Method
dvdot(s1, s2)

Compute the derivative of the dot product of two double precision position vectors.

Arguments

  • s1: First state vector in the dot product
  • s2: Second state vector in the dot product

Output

Returns the derivative of the dot product s1 ⋅ s2.

References

source
SPICE.dvhat — Method
dvhat(s1)

Find the unit vector corresponding to a state vector and the derivative of the unit vector.

Arguments

  • s1: State to be normalized

Output

Returns the unit vector s1 / |s1|, and its time derivative.

References

source
SPICE.dvnorm — Method
dvnorm(state)

Function to calculate the derivative of the norm of a 3-vector.

Arguments

  • state: A 6-vector composed of three coordinates and their derivatives.

Output

Returns the derivative of the norm of state.

References

source
SPICE.dvsep — Method
dvsep(s1, s2)

Calculate the time derivative of the separation angle between two input states, s1 and s2.

Arguments

  • s1: State vector of the first body
  • s2: State vector of the second body

Output

Returns the value of the time derivative of the angular separation between s1 and s2.

References

source
SPICE.edlimb — Method
edlimb(a, b, c, viewpt)

Find the limb of a triaxial ellipsoid, viewed from a specified point.

Arguments

  • a: Length of ellipsoid semi-axis lying on the x-axis
  • b: Length of ellipsoid semi-axis lying on the y-axis
  • c: Length of ellipsoid semi-axis lying on the z-axis
  • viewpt: Location of viewing point

Output

Returns the limb of the ellipsoid as seen from the viewing point.

References

source
SPICE.edterm — Method
edterm(trmtyp, source, target, et, fixref, abcorr, obsrvr, npts)

Compute a set of points on the umbral or penumbral terminator of a specified target body, where the target shape is modeled as an ellipsoid.

Arguments

  • trmtyp: Terminator type
  • source: Light source
  • target: Target body
  • et: Observation epoch
  • fixref: Body-fixed frame associated with target
  • abcorr: Aberration correction
  • obsrvr: Observer
  • npts: Number of points in terminator set

Output

  • trgepc: Epoch associated with target center
  • obspos: Position of observer in body-fixed frame
  • trmpts: Terminator point set

References

source
SPICE.ekacec — Method
ekacec(handle, segno, recno, column, cvals, isnull)

Add data to a character column in a specified EK record.

Arguments

  • handle: EK file handle
  • segno: Index of segment containing record
  • recno: Record to which data is to be added
  • column: Column name
  • cvals: Character values to add to column
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekaced — Method
ekaced(handle, segno, recno, column, dvals, isnull)

Add data to an double precision column in a specified EK record.

Arguments

  • handle: EK file handle
  • segno: Index of segment containing record
  • recno: Record to which data is to be added
  • column: Column name
  • dvals: Double precision values to add to column
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekacei — Method
ekacei(handle, segno, recno, column, ivals, isnull)

Add data to an integer column in a specified EK record.

Arguments

  • handle: EK file handle
  • segno: Index of segment containing record
  • recno: Record to which data is to be added
  • column: Column name
  • ivals: Integer values to add to column
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekaclc — Method
ekaclc(handle, segno, column, cvals, nlflgs, rcptrs)

Add an entire character column to an EK segment.

Arguments

  • handle: EK file handle.
  • segno: Number of segment to add column to.
  • column: Column name.
  • cvals: Character values to add to column.
  • nlflgs: Array of null flags for column entries.
  • rcptrs: Record pointers for segment.

References

source
SPICE.ekacld — Method
ekacld(handle, segno, column, dvals, nlflgs, rcptrs)

Add an entire double precision column to an EK segment.

Arguments

  • handle: EK file handle
  • segno: Number of segment to add column to
  • column: Column name
  • dvals: Double precision values to add to column
  • nlflgs: Array of null flags for column entries
  • rcptrs: Record pointers for segment

References

source
SPICE.ekacli — Method
ekacli(handle, segno, column, ivals, nlflgs, rcptrs)

Add an entire integer column to an EK segment.

Arguments

  • handle: EK file handle
  • segno: Number of segment to add column to
  • column: Column name
  • ivals: Integer values to add to column
  • nlflgs: Array of null flags for column entries
  • rcptrs: Record pointers for segment

References

source
SPICE.ekappr — Method
ekappr(handle, segno)

Append a new, empty record at the end of a specified E-kernel segment.

Arguments

  • handle: File handle
  • segno: Segment number

Output

Returns the number of appended record.

References

source
SPICE.ekbseg — Method
ekbseg(handle, tabnam, cnames, decls)

Start a new segment in an E-kernel.

Arguments

  • handle: File handle
  • tabnam: Table name
  • cnames: Names of columns
  • decls: Declarations of columns

Output

Returns the segment number.

References

source
SPICE.ekccnt — Method
ekccnt(table)

Return the number of distinct columns in a specified, currently loaded table

Arguments

  • table: Name of table

Output

Returns the count of distinct, currently loaded columns.

References

source
SPICE.ekcii — Function
ekcii(table, cindex, lenout=256)

Return attribute information about a column belonging to a loaded EK table, specifying the column by table and index.

Arguments

  • table: Name of table containing column
  • cindex: Index of column whose attributes are to be found
  • lenout: Maximum allowed length of column name (default: 256)

Output

  • column: Name of column
  • attdsc: Column attribute descriptor

References

source
SPICE.ekdelr — Method
ekdelr(handle, segno, recno)

Delete a specified record from a specified E-kernel segment.

Arguments

  • handle: File handle
  • segno: Segment number
  • recno: Record number

References

source
SPICE.ekffld — Method
ekffld(handle, segno, rcptrs)

Complete a fast write operation on a new E-kernel segment.

Arguments

  • handle: File handle
  • segno: Segment number
  • rcptrs: Record pointers

References

source
SPICE.ekfind — Function
ekfind(query, lenout=256)

Find E-kernel data that satisfy a set of constraints.

Arguments

  • query: Query specifying data to be found.
  • lenout: Declared length of output error message string (default: 256)

Output

Returns the number of matching rows.

References

source
SPICE.ekgc — Function
ekgc(selidx, row, elment, lenout=256)

Return an element of an entry in a column of character type in a specified row.

Arguments

  • selidx: Index of parent column in SELECT clause
  • row: Row to fetch from
  • elment: Index of element, within column entry, to fetch
  • lenout: Maximum length of column element (default: 256)

Output

Returns the character string element of column entry or missing if it was null or nothing if the column was not found.

References

source
SPICE.ekgd — Method
ekgd(selidx, row, element)

Return an element of an entry in a column of double precision type in a specified row.

Arguments

  • selidx: Index of parent column in SELECT clause
  • row: Row to fetch from
  • elment: Index of element, within column entry, to fetch

Output

Returns the double precision element of column entry or missing if it was null or nothing if the column was not found.

References

source
SPICE.ekgi — Method
ekgi(selidx, row, element)

Return an element of an entry in a column of integer type in a specified row.

Arguments

  • selidx: Index of parent column in SELECT clause
  • row: Row to fetch from
  • elment: Index of element, within column entry, to fetch

Output

Returns the integer element of column entry or missing if it was null or nothing if the column was not found.

References

source
SPICE.ekifld — Method
ekifld(handle, tabnam, nrows, cnames, decls)

Initialize a new E-kernel segment to allow fast writing.

Arguments

  • handle: File handle
  • tabnam: Table name
  • nrows: Number of rows in the segment
  • cnames: Names of columns
  • decls: Declarations of columns

Output

  • segno: Segment number
  • rcptrs: Array of record pointers

References

source
SPICE.ekinsr — Method
ekinsr(handle, segno, recno)

Add a new, empty record to a specified E-kernel segment at a specified index.

Arguments

  • handle: File handle
  • segno: Segment number
  • recno: Record number

References

source
SPICE.eklef — Method
eklef(fname)

Load an EK file, making it accessible to the EK readers.

Arguments

  • fname: Name of EK file to load

Output

Returns the file handle of loaded EK file.

References

source
SPICE.eknelt — Method
eknelt(selidx, row)

Return the number of elements in a specified column entry in the current row.

Arguments

  • selidx: Index of parent column in SELECT clause
  • row: Row containing element

Output

Returns the number of elements in entry in current row.

References

source
SPICE.eknseg — Method
eknseg(handle)

Return the number of segments in a specified EK.

Arguments

  • handle: EK file handle

Output

Returns the number of segments in the specified E-kernel.

References

source
SPICE.ekopn — Method
ekopn(fname, ifname, ncomch)

Open a new E-kernel file and prepare the file for writing.

Arguments

  • fname: Name of EK file
  • ifname: Internal file name
  • ncomch: The number of characters to reserve for comments

Output

Return the handle attached to the new EK file.

References

source
SPICE.ekopr — Method
ekopr(fname)

Open an existing E-kernel file for reading.

Arguments

  • fname: Name of EK file

Output

Returns the handle attached to the EK file.

References

source
SPICE.ekops — Method
ekops()

Open a scratch (temporary) E-kernel file and prepare the file for writing.

Output

Returns the handle attached to the EK file.

References

source
SPICE.ekopw — Method
ekopw(fname)

Open an existing E-kernel file for writing.

Arguments

  • fname: Name of EK file

Output

Returns the handle attached to the EK file.

References

source
SPICE.ekpsel — Function
ekpsel(query, msglen=256, tablen=256, collen=256)

Parse the SELECT clause of an EK query, returning full particulars concerning each selected item.

Arguments

  • query: EK query
  • msglen: Available space in the output error message string (default: 256)
  • tablen: Length of strings in `tabs' output array (default: 256)
  • collen: Length of strings in `cols' output array (default: 256)

Output

  • xbegs: Begin positions of expressions in SELECT clause
  • xends: End positions of expressions in SELECT clause
  • xtypes: Data types of expressions
  • xclass: Classes of expressions
  • tabs: Names of tables qualifying SELECT columns
  • cols: Names of columns in SELECT clause of query

References

source
SPICE.ekrcec — Function
ekrcec(handle, segno, recno, column, lenout=256, nelts=100)

Read data from a character column in a specified EK record.

Arguments

  • handle: Handle attached to EK file
  • segno: Index of segment containing record
  • recno: Record from which data is to be read
  • column: Column name
  • lenout: Maximum length of output strings
  • nelts: Maximum number of elements to return (default: 100)

Output

Returns the character values in column entry or missing if they are null.

References

source
SPICE.ekrced — Function
ekrced(handle, segno, recno, column, nelts=100)

Read data from a double precision column in a specified EK record.

Arguments

  • handle: Handle attached to EK file
  • segno: Index of segment containing record
  • recno: Record from which data is to be read
  • column: Column name
  • nelts: Maximum number of elements to return (default: 100)

Output

Returns the values in column entry.

References

source
SPICE.ekrcei — Function
ekrcei(handle, segno, recno, column, nelts=100)

Read data from an integer column in a specified EK record.

Arguments

  • handle: Handle attached to EK file
  • segno: Index of segment containing record
  • recno: Record from which data is to be read
  • column: Column name
  • nelts: Maximum number of elements to return (default: 100)

Output

Returns the values in column entry.

References

source
SPICE.ekssum — Method
ekssum(handle, segno)

Return summary information for a specified segment in a specified EK.

Arguments

  • handle: Handle of EK
  • segno: Number of segment to be summarized

Output

Returns the EK segment summary.

References

source
SPICE.ektnam — Function
ektnam(n, lenout=256)

Return the name of a specified, loaded table.

Arguments

  • n: Index of table
  • lenout: Maximum table name length (default: 256)

Output

Returns the name of table.

References

source
SPICE.ekucec — Method
ekucec(handle, segno, recno, column, cvals, isnull)

Update a character column entry in a specified EK record.

Arguments

  • handle: EK file handle
  • segno: Index of segment containing record
  • recno: Record to which data is to be updated
  • column: Column name
  • cvals: Character values comprising new column entry
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekuced — Method
ekuced(handle, segno, recno, column, dvals, isnull)

Update a double precision column entry in a specified EK record.

Arguments

  • handle: Handle attached to EK file
  • segno: Index of segment containing record
  • recno: Record in which entry is to be updated
  • column: Column name
  • dvals: Double precision values comprising new column entry
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekucei — Method
ekucei(handle, segno, recno, column, dvals, isnull)

Update an integer column entry in a specified EK record.

Arguments

  • handle: Handle attached to EK file
  • segno: Index of segment containing record
  • recno: Record in which entry is to be updated
  • column: Column name
  • ivals: Integer values comprising new column entry
  • isnull: Flag indicating whether column entry is null

References

source
SPICE.ekuef — Method
ekuef(handle)

Unload an EK file, making its contents inaccessible to the EK reader routines, and clearing space in order to allow other EK files to be loaded.

Arguments

  • handle: Handle of EK file

References

source
SPICE.el2cgv — Method

Convert an ellipse to a center vector and two generating vectors. The selected generating vectors are semi-axes of the ellipse.

Arguments

  • ellipse: An ellipse

Output

Returns the center and semi-axes of ellipse.

References

source
SPICE.elemc — Function
elem[c/d/i](item, cell)
Deprecated

Use item in cell instead.

source
SPICE.eqncpv — Method
eqncpv(et, epoch, eqel, rapol, decpol)

Compute the state (position and velocity of an object whose trajectory is described via equinoctial elements relative to some fixed plane (usually the equatorial plane of some planet).

Arguments

  • et: Epoch in seconds past J2000 to find state
  • epoch: Epoch of elements in seconds past J2000
  • eqel: Array of equinoctial elements
  • rapol: Right Ascension of the pole of the reference plane
  • decpol: Declination of the pole of the reference plane

Output

Returns the state of the object described by eqel.

References

source
SPICE.eqstr — Method
eqstr(a, b)

Determine whether two strings are equivalent.

Arguments

  • a, b: Arbitrary character strings

Output

Returns true if a and b are equivalent.

References

source
SPICE.esrchc — Method
esrchc(value, array)

Search for a given value within a character string array.

Arguments

  • value: Key value to be found in array
  • array: Character string array to search

Output

Returns the index of the first equivalent array entry, or -1 if no equivalent element is found.

References

source
SPICE.et2lst — Function
et2lst(et, body, lon, typ, timlen=128, ampmlen=128)

Given an ephemeris epoch, compute the local solar time for an object on the surface of a body at a specified longitude.

Arguments

  • et: Epoch in seconds past J2000 epoch
  • body: ID-code of the body of interest
  • lon: Longitude of surface point (radians)
  • typ: Type of longitude "PLANETOCENTRIC", etc
  • timlen: Available room in output time string (default: 128)
  • ampmlen: Available room in output `ampm' string (default: 128)

Output

  • hr: Local hour on a "24 hour" clock
  • mn: Minutes past the hour
  • sc: Seconds past the minute
  • time: String giving local time on 24 hour clock
  • ampm: String giving time on A.M./ P.M. scale

References

source
SPICE.et2utc — Method
et2utc(et, format, prec)

Convert an input time from ephemeris seconds past J2000 to Calendar, Day-of-Year, or Julian Date format, UTC.

Arguments

  • et: Input epoch, given in ephemeris seconds past J2000
  • format: Format of output epoch. It may be any of the following:
    • :C: Calendar format, UTC
    • :D: Day-of-Year format, UTC
    • :J: Julian Date format, UTC
    • :ISOC: ISO Calendar format, UTC
    • :ISOD: ISO Day-of-Year format, UTC
  • prec: Digits of precision in fractional seconds or days

Output

Returns an output time string equivalent to the input epoch, in the specified format.

References

source
SPICE.etcal — Function
etcal(et, lenout=128)

Convert from an ephemeris epoch measured in seconds past the epoch of J2000 to a calendar string format using a formal calendar free of leapseconds.

Arguments

  • et: Ephemeris time measured in seconds past J2000
  • lenout: Length of output string (default: 128)

Output

Returns a standard calendar representation of et.

References

source
SPICE.eul2m — Method
eul2m(angle3, angle2, angle1, axis3, axis2, axis1)

Construct a rotation matrix from a set of Euler angles.

Arguments

  • angle3, angle2, angle1: Rotation angles about third, second, and first rotation axes (radians)
  • axis3, axis2, axis1: Axis numbers of third, second, and first rotation axes

Output

A rotation matrix corresponding to the product of the 3 rotations.

References

source
SPICE.eul2xf — Method
eul2xf(eulang, axisa, axisb, axisc)

Compute a state transformation from an Euler angle factorization of a rotation and the derivatives of those Euler angles.

Arguments

  • eulang: An array of Euler angles and their derivatives
  • axisa: Axis A of the Euler angle factorization
  • axisb: Axis B of the Euler angle factorization
  • axisc: Axis C of the Euler angle factorization

Output

Returns a state transformation matrix.

References

source
SPICE.expool — Method
expool(name)

Confirm the existence of a kernel variable in the kernel pool.

Arguments

  • name: Name of the variable whose value is to be returned

Output

Returns true when the variable is in the pool.

References

source
SPICE.fovray — Method
fovray(inst, raydir, rframe, abcorr, observer, et)

Determine if a specified ray is within the field-of-view (FOV) of a specified instrument at a given time.

Arguments

  • inst: Name or ID code string of the instrument
  • raydir: Ray's direction vector
  • rframe: Body-fixed, body-centered frame for target body
  • abcorr: Aberration correction flag
  • observer: Name or ID code string of the observer
  • et: Time of the observation (seconds past J2000)

Output

Returns true if the ray is visible.

References

source
SPICE.fovtrg — Method
fovtrg(inst, target, tshape, tframe, abcorr, obsrvr, et)

Determine if a specified ephemeris object is within the field-of-view (FOV) of a specified instrument at a given time.

Arguments

  • inst: Name or ID code string of the instrument.
  • target: Name or ID code string of the target.
  • tshape: Type of shape model used for the target.
  • tframe: Body-fixed, body-centered frame for target body.
  • abcorr: Aberration correction flag.
  • obsrvr: Name or ID code string of the observer.
  • et: Time of the observation (seconds past J2000).

Output

Returns true if the object is visible.

References

source
SPICE.frame — Method
frame(x)

Given a vector x, this routine builds a right handed orthonormal frame x, y, z where the output x is parallel to the input x.

Arguments

  • x: Input vector

Output

  • x: Unit vector parallel to x on output
  • y: Unit vector in the plane orthogonal to x
  • z: Unit vector given by x × y

References

source
SPICE.frinfo — Method
frinfo(frcode)

Retrieve the minimal attributes associated with a frame needed for converting transformations to and from it.

Arguments

  • frcode: The id code for a reference frame

Output

  • cent: The center of the frame
  • frclss: The class (type) of the frame
  • clssid: The idcode for the frame within its class

Returns nothing if no frame with id frcode could be found.

References

source
SPICE.frmnam — Method
frmnam(frcode)

Retrieve the name of a reference frame associated with an id code.

Arguments

  • frcode: The id code for a reference frame

Output

Returns the name associated with the reference frame.

References

source
SPICE.gcpool — Method
gcpool(name; start=1, room=100, lenout=128)

Return the value of a kernel variable from the kernel pool.

Arguments

  • name: Name of the variable whose value is to be returned
  • start: Which component to start retrieving for name (default: 1)
  • room: The largest number of values to return (default: 100)
  • lenout: The length of the longest string to return (default: 128)

Output

Returns an array of values if the variable exists or nothing if not.

References

source
SPICE.gdpool — Method
gdpool(name; start=1, room=100)

Return the value of a kernel variable from the kernel pool.

Arguments

  • name: Name of the variable whose value is to be returned
  • start: Which component to start retrieving for name (default: 1)
  • room: The largest number of values to return (default: 100)

Output

Returns an array of values if the variable exists or nothing if not.

References

source
SPICE.georec — Method
georec(lon, lat, alt, re, f)

Convert geodetic coordinates to rectangular coordinates.

Arguments

  • lon: Geodetic longitude of point (radians)
  • lat: Geodetic latitude of point (radians)
  • alt: Altitude of point above the reference spheroid
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

Returns the rectangular coordinates of point.

References

source
SPICE.getelm — Method
getelm(frstyr, lines)

Given the "lines" of a two-line element set, parse the lines and return the elements in units suitable for use in SPICE software.

Arguments

  • frstyr: Year of earliest representable two-line elements
  • lines: A pair of "lines" containing two-line elements

Output

  • epoch: The epoch of the elements in seconds past J2000
  • elems: The elements converted to SPICE units

References

source
SPICE.getfat — Function
getfat(file, arclen=10, typlen=10)

Determine the file architecture and file type of most SPICE kernel files.

Arguments

  • file: The name of a file to be examined
  • arclen: Maximum length of output architecture string (default: 10)
  • typlen: Maximum length of output type string (default: 10)

Output

  • arch: The architecture of the kernel file
  • typ: The type of the kernel file

References

source
SPICE.getfov — Function
getfov(instid, room=10, shapelen=128, framelen=128)

Return the field-of-view (FOV) parameters for a specified instrument. The instrument is specified by its NAIF ID code.

Arguments

  • instid: NAIF ID of an instrument
  • room: Maximum number of vectors that can be returned (default: 10)
  • shapelen: Space available in the string shape (default: 128)
  • framelen: Space available in the string frame (default: 128)

Output

Returns a tuple consisting of

  • shape: Instrument FOV shape
  • frame: Name of the frame in which FOV vectors are defined
  • bsight: Boresight vector
  • bounds: FOV boundary vectors

References

source
SPICE.gfdist — Method
gfdist(target, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)

Return the time window over which a specified constraint on observer-target distance is met.

Arguments

  • target: Name of the target body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • relate: Relational operator
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is confined

Output

Returns a window containing the results.

References

source
SPICE.gfevnt — Method
gfevnt(udstep, udrefn, gquant, qnpars, lenvals, qpnams, qcpars, qdpars, qipars, qlpars,
+       op, refval, tol, adjust, rpt, udrepi, udrepu, udrepf, nintvls, bail, udbail, cnfine)

Determine time intervals when a specified geometric quantity satisfies a specified mathematical condition.

Arguments

  • udstep: Name of the routine that computes and returns a time step
  • udrefn: Name of the routine that computes a refined time
  • gquant: Type of geometric quantity
  • qpnams: Names of quantity definition parameters
  • qcpars: Array of character quantity definition parameters
  • qdpars: Array of double precision quantity definition parameters
  • qipars: Array of integer quantity definition parameters
  • qlpars: Array of logical quantity definition parameters
  • op: Operator that either looks for an extreme value (max, min, local, absolute) or compares the geometric quantity value and a number
  • refval: Reference value
  • tol: Convergence tolerance in second
  • adjust: Absolute extremum adjustment value
  • rpt: Progress reporter on (true) or off (false)
  • udrepi: Function that initializes progress reporting
  • udrepu: Function that updates the progress report
  • udrepf: Function that finalizes progress reporting
  • nintvls: Workspace window interval coun
  • cnfine: SPICE window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gffove! — Method
gffove!(inst, tshape, raydir, target, tframe, abcorr, obsrvr, tol, udstep, udrefn,
+            rpt, udrepi, udrepu, udrepf, cnfine, result)

Determine time intervals when a specified target body or ray intersects the space bounded by the field-of-view (FOV) of a specified instrument.

Arguments

  • inst: Name of the instrument
  • tshape: Type of shape model used for target body
  • raydir: Ray's direction vector
  • target: Name of the target body
  • tframe: Body-fixed, body-centered frame for target body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • tol: Convergence tolerance in seconds
  • udstep: Name of the routine returns a time step
  • udrefn: Name of the routine that computes a refined time
  • rpt: Progress report flag
  • udrepi: Function that initializes progress reporting
  • udrepu: Function that updates the progress report
  • udrepf: Function that finalizes progress reporting
  • cnfine: SPICE window to which the search is restricted
  • result: Window containing the results

Output

Returns result.

References

source
SPICE.gfilum — Method
gfilum(method, angtyp, target, illmn, fixref, abcorr, obsrvr, spoint, relate, refval,
+       adjust, step, nintvls, cnfine)

Return the time window over which a specified constraint on the observed phase, solar incidence, or emission angle at a specifed target body surface point is met.

Arguments

  • method: Computation method
  • angtyp: Type of illumination angle
  • target: Name of the target body
  • illmn: Name of the illumination source
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • spoint: Body-fixed coordinates of a target surface point
  • relate: Relational operator
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is confined

Output

Returns a window containing the results.

References

source
SPICE.gfocce! — Method
function gfocce!(occtyp, front, fshape, fframe, back, bshape, bframe, abcorr, obsrvr, tol,
+    udstep, udrefn, rpt, udrepi, udrepu, udrepf, cnfine, result)

Determine time intervals when an observer sees one target occulted by another.

Arguments

  • occtyp: Type of occultation
  • front: Name of body occulting the other
  • fshape: Type of shape model used for front body
  • fframe: Body-fixed, body-centered frame for front body
  • back: Name of body occulted by the other
  • bshape: Type of shape model used for back body
  • bframe: Body-fixed, body-centered frame for back body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • tol: Convergence tolerance in seconds
  • udstep: Name of the routine that returns a time step
  • udrefn: Name of the routine that computes a refined time
  • rpt: Progress report flag
  • udrepi: Function that initializes progress reporting
  • udrepu: Function that updates the progress report
  • udrepf: Function that finalizes progress reporting
  • cnfine: SPICE window to which the search is restricted
  • result: SPICE window containing results

Output

Returns result.

References

source
SPICE.gfoclt — Function
gfoclt(occtyp, front, fshape, fframe, back, bshape, bframe, abcorr, obsrvr, step, cnfine,
+       maxwin=100)

Determine time intervals when an observer sees one target occulted by, or in transit across, another.

The surfaces of the target bodies may be represented by triaxial ellipsoids or by topographic data provided by DSK files.

Arguments

  • occtyp: Type of occultation
  • front: Name of body occulting the other
  • fshape: Type of shape model used for front body
  • fframe: Body-fixed, body-centered frame for front body
  • back: Name of body occulted by the other
  • bshape: Type of shape model used for back body
  • bframe: Body-fixed, body-centered frame for back body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • step: Step size in seconds for finding occultation events
  • cnfine: Window to which the search is restricted
  • maxwin: Maximum size of the output window (default: 100)

Output

Returns a window containing the results.

References

source
SPICE.gfpa — Method
gfpa(result, target, illmn, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)

Determine time intervals for which a specified constraint on the phase angle between an illumination source, a target, and observer body centers is met.

Arguments

  • target: Name of the target body
  • illmn: Name of the illuminating body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • relate: Relational operator
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is confined

Output

Returns a window containing the results.

References

source
SPICE.gfposc — Method
gfposc(target, frame, abcorr, obsrvr, crdsys, coord, relate, refval, adjust, step,
+       nintvls, cnfine)

Determine time intervals for which a coordinate of an observer-target position vector satisfies a numerical constraint.

Arguments

  • target: Name of the target body
  • frame: Name of the reference frame for coordinate calculations
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • crdsys: Name of the coordinate system containing coord
  • coord: Name of the coordinate of interest
  • relate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gfrefn — Method
gfrefn(t1, t2, s1, s2)

For those times when we can't do better, we use a bisection method to find the next time at which to test for state change.

Arguments

  • t1: One of two values bracketing a state change
  • t2: The other value that brackets a state change
  • s1: State at t1
  • s2: State at t2

Output

Returns the new value at which to check for transition.

References

source
SPICE.gfrepi — Method
gfrepi(window, begmss, endmss)

Initialize a search progress report.

Arguments

  • window: A window over which a job is to be performed
  • begmss: Beginning of the text portion of the output message
  • endmss: End of the text portion of the output message

References

source
SPICE.gfrepu — Method
gfrepu(ivbeg, ivend, time)

Tell the progress reporting system how far a search has progressed.

Arguments

  • ivbeg: Start time of work interval
  • ivend: End time of work interval
  • time: Current time being examined in the search process

References

source
SPICE.gfrfov — Function
gfrfov(inst, raydir, rframe, abcorr, obsrvr, step, cnfine, maxwin=10000)

Determine time intervals when a specified ray intersects the space bounded by the field-of-view (FOV) of a specified instrument.

Arguments

  • inst: Name of the instrument
  • raydir: Ray's direction vector
  • rframe: Reference frame of ray's direction vector
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • step: Step size in seconds for finding FOV events
  • cnfine: SPICE window to which the search is restricted
  • maxwin: Maximum length of the output window (default: 10000)

Output

Returns a window containing the results.

References

source
SPICE.gfrr — Method
gfrr(target, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)

Determine time intervals for which a specified constraint on the observer-target range rate is met.

Arguments

  • target: Name of the target body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • relate: Relational operator
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is confined

Output

Returns a window containing the results.

References

source
SPICE.gfsep — Method

Determine time intervals when the angular separation between the position vectors of two target bodies relative to an observer satisfies a numerical relationship.

Arguments

  • targ1: Name of first body
  • shape1: Name of shape model describing the first body
  • frame1: The body-fixed reference frame of the first body
  • targ2: Name of second body
  • shape2: Name of the shape model describing the second body
  • frame2: The body-fixed reference frame of the second body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • relate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the angular separation value and refval
  • refval: Reference value
  • adjust: Absolute extremum adjustment value
  • step: Step size in seconds for finding angular separation events
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gfsntc — Method
gfsntc(target, fixref, method, abcorr, obsrvr, dref, dvec, crdsys, coord, relate, refval,
+       adjust, step, nintvls, cnfine)

Determine time intervals for which a coordinate of an surface intercept position vector satisfies a numerical constraint.

Arguments

  • target: Name of the target body
  • fixref: Body fixed frame associated with target
  • method: Name of method type for surface intercept calculation
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • dref: Reference frame of direction vector dvec
  • dvec: Pointing direction vector from obsrvr
  • crdsys: Name of the coordinate system containing COORD
  • coord: Name of the coordinate of interest
  • relate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gfstol — Method
gfstol(value)

Override the default GF convergence value used in the high level GF routines.

Arguments

  • value: Double precision value returned or to store

References

source
SPICE.gfsubc — Method
gfsubc(target, fixref, method, abcorr, obsrvr, crdsys, coord, relate, refval, adjust, step,
+       nintvls, cnfine)

Determine time intervals for which a coordinate of an subpoint position vector satisfies a numerical constraint.

Arguments

  • target: Name of the target body
  • fixref: Body fixed frame associated with target
  • method: Name of method type for subpoint calculation
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • crdsys: Name of the coordinate system containing coord
  • coord: Name of the coordinate of interest
  • relate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval
  • refval: Reference value
  • adjust: Adjustment value for absolute extrema searches
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gftfov — Method
gftfov(inst, target, tshape, tframe, abcorr, obsrvr, step, nintvls, cnfine)

Determine time intervals when a specified ephemeris object intersects the space bounded by the field-of-view (FOV) of a specified instrument.

Arguments

  • inst: Name of the instrument
  • target: Name of the target body
  • tshape: Type of shape model used for target body
  • tframe: Body-fixed, body-centered frame for target body
  • abcorr: Aberration correction flag
  • obsrvr: Name of the observing body
  • step: Step size in seconds for finding FOV events
  • nintvls: Workspace window interval count
  • cnfine: Window to which the search is restricted

Output

Returns a window containing the results.

References

source
SPICE.gfudb! — Method
gfudb!(udfuns, udfunb, step, cnfine, result)

Perform a GF search on a user defined boolean quantity.

Arguments

  • udfuns: Name of the routine that computes a scalar quantity of interest corresponding to an et, e.g. f(et) = ...
  • udfunb: Name of the routine returning the boolean value corresponding to an et, e.g. g(f, et) = ...
  • step: Step size used for locating extrema and roots
  • cnfine: Window to which the search is restricted
  • result: Window containing results

Output

Returns result.

References

source
SPICE.gfuds! — Method
gfuds!(udfuns, udqdec, relate, refval, adjust, step, nintvls, cnfine, result)

Perform a GF search on a user defined scalar quantity.

Arguments

  • udfuns: Name of the routine that computes the scalar quantity of interest at some time, e.g. f(et) = ...
  • udqdec: Name of the routine that computes whether the scalar quantity is decreasing, e.g. g(f, et) = ...
  • relate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the geometric quantity value and a number
  • refval: Value used as reference for scalar quantity condition
  • adjust: Allowed variation for absolute extremal geometric conditions
  • step: Step size used for locating extrema and roots
  • nintvls: Workspace window interval count
  • cnfine: SPICE window to which the search is restricted
  • result: SPICE window containing results

Output

Returns result.

References

source
SPICE.gipool — Method
gipool(name; start=1, room=100)

Return the value of a kernel variable from the kernel pool.

Arguments

  • name: Name of the variable whose value is to be returned
  • start: Which component to start retrieving for name (default: 1)
  • room: The largest number of values to return (default: 100)

Output

Returns an array of values if the variable exists or nothing if not.

References

source
SPICE.gnpool — Function
gnpool(name, start, room, lenout=128)

Return names of kernel variables matching a specified template.

Arguments

  • name: Template that names should match
  • start: Index of first matching name to retrieve
  • room: The largest number of values to return
  • lenout: Length of strings in output array kvars (default: 128)

Output

Returns lernel pool variables whose names match name.

References

source
SPICE.hrmint — Method
hrmint(xvals, yvals, x)

Evaluate a Hermite interpolating polynomial at a specified abscissa value.

Arguments

  • xvals: Abscissa values
  • yvals: Ordinate and derivative values
  • x: Point at which to interpolate the polynomial

Output

  • f: Interpolated function value at x
  • df: Interpolated function's derivative at x

References

source
SPICE.hx2dp — Method
hx2dp(str)

Convert a string representing a double precision number in a base 16 "scientific notation" into its equivalent double precision number.

Arguments

  • str: Hex form string to convert to double precision

Output

  • dp: Double precision value to be returned

References

source
SPICE.illumf — Method
illumf(method, target, ilusrc, et, fixref, abcorr, obsrvr, spoint)

Compute the illumination angles - phase, incidence, and emission - at a specified point on a target body. Return logical flags indicating whether the surface point is visible from the observer's position and whether the surface point is illuminated.

The target body's surface is represented using topographic data provided by DSK files, or by a reference ellipsoid.

The illumination source is a specified ephemeris object.

Arguments

  • method: Computation method
  • target: Name of target body
  • ilusrc: Name of illumination source
  • et: Epoch in TDB seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction flag
  • obsrvr: Name of observing body
  • spoint: Body-fixed coordinates of a target surface point

Output

  • trgepc: Target surface point epoch
  • srfvec: Vector from observer to target surface point
  • phase: Phase angle at the surface point
  • incdnc: Source incidence angle at the surface point
  • emissn: Emission angle at the surface point
  • visibl: Visibility flag (true if visible)
  • lit: Illumination flag (true if illuminated)

References

source
SPICE.illumg — Method
illumg(method, target, ilusrc, et, fixref, obsrvr, spoint, abcorr)

Find the illumination angles (phase, incidence, and emission) at a specified surface point of a target body.

The surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.

The illumination source is a specified ephemeris object.

Arguments

  • method: Computation method.
  • target: Name of target body.
  • ilusrc: Name of illumination source.
  • et: Epoch in ephemeris seconds past J2000 TDB.
  • fixref: Body-fixed, body-centered target body frame.
  • obsrvr: Name of observing body.
  • spoint: Body-fixed coordinates of a target surface point.
  • abcorr: Aberration correction.

Output

  • trgepc: Sub-solar point epoch.
  • srfvec: Vector from observer to sub-solar point.
  • phase: Phase angle at the surface point.
  • incdnc: Solar incidence angle at the surface point.
  • emissn: Emission angle at the surface point.

References

source
SPICE.ilumin — Method
ilumin(method, target, et, fixref, obsrvr, spoint, abcorr)

Find the illumination angles (phase, solar incidence, and emission) at a specified surface point of a target body.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in ephemeris seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • obsrvr: Name of observing body
  • spoint: Body-fixed coordinates of a target surface point
  • abcorr: Aberration correction

Output

  • trgepc: Sub-solar point epoch
  • srfvec: Vector from observer to sub-solar point
  • phase: Phase angle at the surface point
  • incdnc: Solar incidence angle at the surface point
  • emissn: Emission angle at the surface point

References

source
SPICE.inedpl — Method
inedpl(a, b, c, plane)

Find the intersection of a triaxial ellipsoid and a plane.

Arguments

  • a: Length of ellipsoid semi-axis lying on the x-axis
  • b: Length of ellipsoid semi-axis lying on the y-axis
  • c: Length of ellipsoid semi-axis lying on the z-axis
  • plane: Plane that intersects ellipsoid

Output

  • ellipse: Intersection ellipse

Returns nothing if no ellipse could be found.

References

source
SPICE.inelpl — Method
inelpl(ellips, plane)

Find the intersection of an ellipse and a plane.

Arguments

  • ellips: An ellipse
  • plane: A plane

Output

  • nxpts: Number of intersection points of ellipse and plane
  • xpt1, xpt2: Intersection points

References

source
SPICE.inrypl — Method
inrypl(vertex, dir, plane)

Find the intersection of a ray and a plane.

Arguments

  • vertex, dir: Vertex and direction vector of ray
  • plane: A plane

Output

  • nxpts: Number of intersection points of ray and plane
  • xpt1, xpt2: Intersection points

References

source
SPICE.insrtc! — Method
insrtc!(set, item)

Insert an item into a character set.

Arguments

  • set: Insertion set
  • item: Item to be inserted

Output

Returns the updated set.

References

source
SPICE.insrtd! — Method
insrtd!(set, item)

Insert an item into a double set.

Arguments

  • set: Insertion set
  • item: Item to be inserted

Output

Returns the updated set.

References

source
SPICE.insrti! — Method
insrti!(set, item)

Insert an item into an integer set.

Arguments

  • set: Insertion set
  • item: Item to be inserted

Output

Returns the updated set.

References

source
SPICE.inter — Method
inter(a, b)

Intersect two sets of any data type to form a third set.

Arguments

  • a: First input set
  • b: Second input set

Output

Returns intersection of a and b.

References

source
SPICE.isrchc — Function
isrchc(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.isrchd — Function
isrchd(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.isrchi — Function
isrchi(value, array)
Deprecated

Use findfirst(array .== value) instead.

source
SPICE.isrot — Method
isrot(m, ntol, dtol)

Indicate whether a 3x3 matrix is a rotation matrix.

Arguments

  • m: A matrix to be tested
  • ntol: Tolerance for the norms of the columns of m
  • dtol: Tolerance for the determinant of a matrix whose columns are the unitized columns of m

Output

Returns true if m is a rotation matrix.

References

source
SPICE.kclear — Method
kclear()

Clear the KEEPER subsystem: unload all kernels, clear the kernel pool, and re-initialize the subsystem. Existing watches on kernel variables are retained.

References

source
SPICE.kdata — Function
kdata(which, kind, fillen=1024, srclen=256)

Return data for the n-th kernel that is among a list of specified kernel types.

Arguments

  • which: Index of kernel to fetch from the list of kernels
  • kind: The kind of kernel to which fetches are limited
  • fillen: Available space in output file string
  • srclen: Available space in output source string

Output

Returns nothing if no kernel was found or a tuple consisting of

  • file: The name of the kernel file
  • filtyp: The type of the kernel
  • source: Name of the source file used to load file
  • handle: The handle attached to file

References

source
SPICE.kinfo — Function
kinfo(file, srclen=256)

Arguments

  • file: Name of a kernel to fetch information for
  • srclen: Available space in output source string

Output

Returns nothing if no kernel was found or a tuple consisting of

  • filtyp: The type of the kernel
  • source: Name of the source file used to load file
  • handle: The handle attached to file

References

source
SPICE.kplfrm — Function
kplfrm(frmcls)

Return a SPICE set containing the frame IDs of all reference frames of a given class having specifications in the kernel pool.

Arguments

  • frmcls: Frame class
  • size: Size of the output set

Output

Returns the set of ID codes of frames of the specified class.

References

source
SPICE.ktotal — Method
ktotal(kind)

Return the current number of kernels that have been loaded via the KEEPER interface that are of a specified type.

References

source
SPICE.kxtrct — Function
kxtrct(keywd, terms, string)

Locate a keyword in a string and extract the substring from the beginning of the first word following the keyword to the beginning of the first subsequent recognized terminator of a list.

Arguments

  • keywd: Word that marks the beginning of text of interest
  • terms: Set of words, any of which marks the end of text
  • string: String containing a sequence of words

Output

Returns nothing if keywd was found or a tuple consisting of

  • string: The input string with the text of interest removed
  • substr: String from end of keywd to beginning of first terms item found

References

source
SPICE.lastnb — Function
lastnb(str)
Deprecated

Use findprev(!isspace, str, length(str)) instead.

source
SPICE.latcyl — Method
latcyl(radius, lon, lat)

Convert from latitudinal coordinates to cylindrical coordinates.

Arguments

  • radius: Distance of a point from the origin
  • lon: Angle of the point from the XZ plane in radians
  • lat: Angle of the point from the XY plane in radians

Output

Return the tuple (r, lonc, z).

  • r: Distance of the point from the z axis
  • lonc: Angle of the point from the XZ plane in radians. 'lonc' is set equal to 'lon'
  • z: Height of the point above the XY plane

References

source
SPICE.latrec — Method
latrec(radius, lon, lat)

Convert from latitudinal coordinates to rectangular coordinates.

Arguments

  • radius: Distance of a point from the origin
  • lon: Angle of the point from the XZ plane in radians
  • lat: Angle of the point from the XY plane in radians

Output

Return the rectangular coordinates vector of the point.

References

source
SPICE.latsph — Method
latsph(radius, lon, lat)

Convert from latitudinal coordinates to spherical coordinates.

Arguments

  • radius: Distance of a point from the origin
  • lon: Angle of the point from the XZ plane in radians
  • lat: Angle of the point from the XY plane in radians

Output

Return the tuple (rho, colat, lons).

  • rho: Distance of the point from the origin
  • colat: Angle of the point from positive z axis (radians)
  • lons: Angle of the point from the XZ plane (radians)

References

source
SPICE.latsrf — Method
latsrf(method, target, et, fixref, npts, lonlat)

Map array of planetocentric longitude/latitude coordinate pairs to surface points on a specified target body.

The surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in TDB seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • lonlat: Array of longitude/latitude coordinate pairs

Output

Returns an array of surface points.

References

source
SPICE.ldpool — Method

ldpool(kernel)

Load the variables contained in a NAIF ASCII kernel file into the kernel pool.

Arguments

  • kernel: Name of the kernel file

Output

None

References

source
SPICE.lgrind — Method
lgrind(xvals, yvals, x)

Evaluate a Lagrange interpolating polynomial for a specified set of coordinate pairs, at a specified abscissa value. Return the value of both polynomial and derivative.

Arguments

  • xvals: Abscissa values of coordinate pairs
  • yvals: Ordinate values of coordinate pairs
  • x: Point at which to interpolate the polynomial

Output

  • p: The value at x of the unique polynomial of degree n-1 that fits the points in the plane defined by xvals and yvals
  • dp: The derivative at x of the interpolating polynomial described above

References

source
SPICE.limbpt — Method
limbpt(method, target, et, fixref, abcorr, corloc, obsrvr, refvec, rolstp, ncuts, schstp,
+       soltol, maxn)

Find limb points on a target body. The limb is the set of points of tangency on the target of rays emanating from the observer. The caller specifies half-planes bounded by the observer-target center vector in which to search for limb points.

The surface of the target body may be represented either by a triaxial ellipsoid or by topographic data.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in ephemeris seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction
  • corloc: Aberration correction locus
  • obsrvr: Name of observing body
  • refvec: Reference vector for cutting half-planes
  • rolstp: Roll angular step for cutting half-planes
  • ncuts: Number of cutting half-planes
  • schstp: Angular step size for searching
  • soltol: Solution convergence tolerance
  • maxn: Maximum number of entries in output arrays

Output

Returns the tuple (npts, points, epochs, tangts).

  • npts: Counts of limb points corresponding to cuts
  • points: Limb points
  • epochs: Times associated with limb points
  • tangts: Tangent vectors emanating from the observer

References

source
SPICE.lmpool — Method

lmpool(cvals)

Load the variables contained in an internal buffer into the kernel pool.

Arguments

  • cvals: An array that contains a SPICE text kernel

References

source
SPICE.lparse — Function

lparse(list, delim, nmax)

Deprecated

Use split(list, delim, limit=nmax) instead.

source
SPICE.lparsm — Function

lparsm(list, delims, nmax)

Deprecated

Use split(list, delim, limit=nmax, keepempty=false) instead.

source
SPICE.lparss — Function

lparss(list, delims)

Deprecated

Use Set(split(list, collect(delim))) instead.

source
SPICE.lspcn — Method

lspcn(body, et, abcorr)

Compute L_s, the planetocentric longitude of the sun, as seen from a specified body.

Arguments

  • body: Name of the central body
  • et: Epoch in seconds past J2000 TDB
  • abcorr: Aberration correction

Output

Returns the planetocentric longitude of the sun for the specified body at the specified time in radians.

References

source
SPICE.lstlec — Function
lstlecd(x, array)
Deprecated

Use findfirst(item .<= array) instead.

source
SPICE.lstled — Function
lstle[di](x, array)
Deprecated

Use searchsortedlast(array, x) instead.

source
SPICE.lstltc — Function
lstltcd(x, array)
Deprecated

Use findfirst(item .< array) instead.

source
SPICE.lstltd — Function
lstlt[di](x, array)
Deprecated

Use searchsortedlast(array, x, lt=<=) instead.

source
SPICE.ltime — Method
ltime(etobs, obs, dir, targ)

This routine computes the transmit (or receive) time of a signal at a specified target, given the receive (or transmit) time at a specified observer. The elapsed time between transmit and receive is also returned.

Arguments

  • etobs: Epoch of a signal at some observer
  • obs: NAIF ID of some observer
  • dir: Direction the signal travels ( "->" or "<-" )
  • targ: Time between transmit and receipt of the signal

Output

  • ettarg: Epoch of the signal at the target
  • obs: NAIF ID of some observer

References

source
SPICE.lx4dec — Method
lx4dec(string, first)

Scan a string from a specified starting position for the end of a decimal number.

Arguments

  • string: Any character string
  • first: First character to scan from in string

Output

  • last: Last character that is part of a decimal number. If there is no such character, last will be returned with the value first-1.
  • nchar: Number of characters in the decimal number

References

source
SPICE.lx4num — Method
lx4num(string, first)

Scan a string from a specified starting position for the end of a number.

Arguments

  • string: Any character string
  • first: First character to scan from in string

Output

  • last: Last character that is part of a number. If there is no such character, last will be returned with the value first-1.
  • nchar: Number of characters in the number

References

source
SPICE.lx4sgn — Method
lx4sgn(string, first)

Scan a string from a specified starting position for the end of a signed integer.

Arguments

  • string: Any character string
  • first: First character to scan from in string

Output

  • last: Last character that is part of a signed integer. If there is no such character, last will be returned with the value first-1.
  • nchar: Number of characters in the signed integer

References

source
SPICE.lx4uns — Method
lx4uns(string, first)

Scan a string from a specified starting position for the end of a unsigned integer.

Arguments

  • string: Any character string
  • first: First character to scan from in string

Output

  • last: Last character that is part of an unsigned integer. If there is no such character, last will be returned with the value first-1.
  • nchar: Number of characters in the unsigned integer

References

source
SPICE.lxqstr — Method
lxqstr(string, qchar, first)

Lex (scan) a quoted string.

Arguments

  • string: String to be scanned
  • qchar: Quote delimiter character
  • first: Character position at which to start scanning

Output

  • last: Character position of end of token
  • nchar: Number of characters in token

References

source
SPICE.m2eul — Method
m2eul(r, axis3, axis2, axis1)

Factor a rotation matrix as a product of three rotations about specified coordinate axes.

Arguments

  • r: A rotation matrix to be factored
  • axis3: Number of the third rotation axis
  • axis2: Number of the second rotation axis
  • axis1: Number of the first rotation axis

Output

A tuple consisting of the third, second, and first Euler angles in radians.

References

source
SPICE.m2q — Method
m2q(r)

Find a unit quaternion corresponding to a specified rotation matrix.

Arguments

  • r: A rotation matrix

Output

A unit quaternion representing `r'

References

source
SPICE.matchi — Method
matchi(string, templ, wstr, wchar)

Determine whether a string is matched by a template containing wild cards. The pattern comparison is case-insensitive.

Arguments

  • string: String to be tested
  • templ: Template (with wild cards) to test against string
  • wstr: Wild string token
  • wchr: Wild character token

Output

Returns true if the string matches.

References

source
SPICE.matchw — Method
matchw(string, templ, wstr, wchar)

Determine whether a string is matched by a template containing wild cards.

Arguments

  • string: String to be tested
  • templ: Template (with wild cards) to test against string
  • wstr: Wild string token
  • wchr: Wild character token

Output

Returns true if the string matches.

References

source
SPICE.namfrm — Method
namfrm(frname)

Look up the frame ID code associated with a string.

Arguments

  • frname: The name of some reference frame

Output

The SPICE ID code of the frame.

References

source
SPICE.ncpos — Method
ncpos(str, chars, start)

Find the first occurrence in a string of a character NOT belonging to a collection of characters, starting at a specified location, searching forward.

Arguments

  • str: A string
  • chars: A collection of characters
  • start: Position to begin looking for a character not in chars

Output

Returns the index of the first character of str at or following index start that is not in the collection chars.

References

source
SPICE.ncposr — Method
ncposr(str, chars, start)

Find the first occurrence in a string of a character NOT belonging to a collection of characters, starting at a specified location, searching in reverse.

Arguments

  • str: A string
  • chars: A collection of characters
  • start: Position to begin looking for a character not in chars

Output

Returns the index of the last character of str at or before index start that is not in the collection chars.

References

source
SPICE.nearpt — Method
nearpt(positn, a, b, c)

This routine locates the point on the surface of an ellipsoid that is nearest to a specified position. It also returns the altitude of the position above the ellipsoid.

Arguments

  • positn: Position of a point in the bodyfixed frame
  • a: Length of semi-axis parallel to x-axis
  • b: Length of semi-axis parallel to y-axis
  • c: Length on semi-axis parallel to z-axis

Output

Returns a tuple consisting of npoint and alt.

  • npoint: Point on the ellipsoid closest to positn
  • alt: Altitude of positn above the ellipsoid

References

source
SPICE.npedln — Method
npedln(a, b, c, linept, linedr)

Find nearest point on a triaxial ellipsoid to a specified line, and the distance from the ellipsoid to the line.

Arguments

  • a: Length of semi-axis in the x direction
  • b: Length of semi-axis in the y direction
  • c: Length of semi-axis in the z direction
  • linept: Point on line
  • linedr: Direction vector of line

Output

Returns a tuple consisting of pnear and dist.

  • pnear: Nearest point on ellipsoid to line
  • dist: Distance of ellipsoid from line

References

source
SPICE.npelpt — Method
npelpt(point, ellips)

Find the nearest point on an ellipse to a specified point, both in three-dimensional space, and find the distance between the ellipse and the point.

Arguments

  • point: Point whose distance to an ellipse is to be found
  • ellips: A SPICE ellipse

Output

Returns a tuple consisting of pnear and dist.

  • pnear: Nearest point on ellipse to input point
  • dist: Distance of input point to ellipse

References

source
SPICE.nplnpt — Method
nplnpt(linept, linedr, point)

Find the nearest point on a line to a specified point, and find the distance between the two points.

Arguments

  • linept: Point on line
  • linedr: Direction vector of line
  • point: A second point

Output

Returns a tuple consisting of pnear and dist.

  • pnear: Nearest point on the line to point
  • dist: Distance between point and pnear

References

source
SPICE.nvc2pl — Method
nvc2pl(norm, point)

Make a SPICE plane from a normal vector and a point.

Arguments

  • norm: A normal vector...
  • constant: ...and a constant defining a plane

Output

Returns a struct representing the plane.

References

source
SPICE.nvp2pl — Method
nvp2pl(norm, point)

Make a SPICE plane from a normal vector and a point.

Arguments

  • norm: A normal vector...
  • point: ...and a point defining a plane

Output

Returns a struct representing the plane.

References

source
SPICE.occult — Method
occult(targ1, shape1, frame1, targ2, shape2, frame2, abcorr, obsrvr, et)

Determines the occultation condition (not occulted, partially, etc.) of one target relative to another target as seen by an observer at a given time.

The surfaces of the target bodies may be represented by triaxial ellipsoids or by topographic data provided by DSK files.

Arguments

  • targ1: Name or ID of first target.
  • shape1: Type of shape model used for first target.
  • frame1: Body-fixed, body-centered frame for first body.
  • targ2: Name or ID of second target.
  • shape2: Type of shape model used for second target.
  • frame2: Body-fixed, body-centered frame for second body.
  • abcorr: Aberration correction flag.
  • obsrvr: Name or ID of the observer.
  • et: Time of the observation (seconds past J2000).

Output

Returns the occultation identification code.

References

source
SPICE.ordc — Method
ordc(set, item)

The function returns the ordinal position of any given item in a character set.

Arguments

  • set: A set to search for a given item
  • item: An item to locate within a set

Output

Returns the ordinal position or nothing if the items does not appear in the set.

References

source
SPICE.ordd — Method
ordd(set, item)

The function returns the ordinal position of any given item in a character set.

Arguments

  • set: A set to search for a given item
  • item: An item to locate within a set

Output

Returns the ordinal position or nothing if the items does not appear in the set.

References

source
SPICE.ordi — Method
ordi(set, item)

The function returns the ordinal position of any given item in a character set.

Arguments

  • set: A set to search for a given item
  • item: An item to locate within a set

Output

Returns the ordinal position or nothing if the items does not appear in the set.

References

source
SPICE.oscelt — Method
oscelt(state, et, mu)

Determine the set of osculating conic orbital elements that corresponds to the state (position, velocity) of a body at some epoch.

Arguments

  • state: State of body at epoch of elements
  • et: Epoch of elements
  • mu: Gravitational parameter (GM) of primary body

Output

Returns the equivalent conic elements:

  • rp: Perifocal distance
  • ecc: Eccentricity
  • inc: Inclination
  • lnode: Longitude of the ascending node
  • argp: Argument of periapsis
  • m0: Mean anomaly at epoch
  • t0: Epoch
  • mu: Gravitational parameter

References

source
SPICE.oscltx — Method
oscltx(state, et, mu)

Determine the set of osculating conic orbital elements that corresponds to the state (position, velocity) of a body at some epoch. In addition to the classical elements, return the true anomaly, semi-major axis, and period, if applicable.

Arguments

  • state: State of body at epoch of elements
  • et: Epoch of elements
  • mu: Gravitational parameter (GM) of primary body

Output

Returns the extended set of classical conic elements:

  • rp: Perifocal distance.
  • ecc: Eccentricity.
  • inc: Inclination.
  • lnode: Longitude of the ascending node.
  • argp: Argument of periapsis.
  • m0: Mean anomaly at epoch.
  • t0: Epoch.
  • mu: Gravitational parameter.
  • nu: True anomaly at epoch.
  • a: Semi-major axis. A is set to zero if it is not computable.
  • tau: Orbital period. Applicable only for elliptical orbits. Set to zero otherwise.

References

source
SPICE.pckcov! — Method
pckcov!(cover, pck, idcode)

Find the coverage window for a specified reference frame in a specified binary PCK file.

Arguments

  • cover: An initalized window SpiceDoubleCell
  • pck: Path of PCK file
  • idcode: Class ID code of PCK reference frame

Output

Returns cover containing coverage in pck for idcode

References

source
SPICE.pckfrm! — Method
pckfrm!(ids, pck)

Find the set of reference frame class ID codes of all frames in a specified binary PCK file.

Arguments

  • ids: An initalized SpiceIntCell
  • pck: Path of PCK file

Output

Returns ids containing a set of frame class ID codes of frames in PCK file.

References

source
SPICE.pcklof — Method
pcklof(filename)

Load a binary PCK file for use by the readers. Return the handle of the loaded file which is used by other PCK routines to refer to the file.

Arguments

  • filename: Path of the PCK file

Output

Returns an integer handle.

References

source
SPICE.pckopn — Method
pckopn(name, ifname, ncomch)

Create a new PCK file, returning the handle of the opened file.

Arguments

  • name: The name of the PCK file to be opened
  • ifname: The internal filename for the PCK
  • ncomch: The number of characters to reserve for comments

Output

Returns the handle of the opened PCK file.

References

source
SPICE.pckuof — Method
pckuof(handle)

Unload a binary PCK file so that it will no longer be searched by the readers.

Arguments

  • handle: Integer handle of a PCK file

References

source
SPICE.pckw02 — Method
pckw02(handle, clssid, frame, first, last, segid, intlen, cdata, btime)

Write a type 2 segment to a PCK binary file given the file handle, frame class ID, base frame, time range covered by the segment, and the Chebyshev polynomial coefficients.

Arguments

  • handle: Handle of binary PCK file open for writing.
  • clssid: Frame class ID of body-fixed frame.
  • frame: Name of base reference frame.
  • first: Start time of interval covered by segment.
  • last: End time of interval covered by segment.
  • segid: Segment identifier.
  • intlen: Length of time covered by logical record.
  • cdata: Array of Chebyshev coefficients.
  • btime: Begin time of first logical record.

References

source
SPICE.pcpool — Method
pcpool(name, vals)

Insert character data into the kernel pool.

Arguments

  • name: The kernel pool name to associate with vals
  • vals: An array of values to insert into the kernel pool

References

source
SPICE.pdpool — Method
pdpool(name, vals)

Insert double precision data into the kernel pool.

Arguments

  • name: The kernel pool name to associate with vals
  • vals: An array of values to insert into the kernel pool

References

source
SPICE.pgrrec — Method
pgrrec(body, lon, lat, alt, re, f)

Convert planetographic coordinates to rectangular coordinates.

Arguments

  • body: Body with which coordinate system is associated.
  • lon: Planetographic longitude of a point (radians).
  • lat: Planetographic latitude of a point (radians).
  • alt: Altitude of a point above reference spheroid.
  • re: Equatorial radius of the reference spheroid.
  • f: Flattening coefficient.

Output

Returns the rectangular coordinates of the point.

References

source
SPICE.phaseq — Method
phaseq(et, target, illmn, obsrvr, abcorr)

Compute the apparent phase angle for a target, observer, illuminator set of ephemeris objects.

Arguments

  • et: Ephemeris seconds past J2000 TDB
  • target: Target body name
  • illmn: Illuminating body name
  • obsrvr: Observer body
  • abcorr: Aberration correction flag

Output

Returns the value of the phase angle.

References

source
SPICE.pipool — Method
pipool(name, ivals)

Insert integer data into the kernel pool.

Arguments

  • name: The kernel pool name to associate with the values
  • ivals: An array of integers to insert into the pool

References

source
SPICE.pjelpl — Method
pjelpl(elin, plane)

Project an ellipse onto a plane, orthogonally.

Arguments

  • elin: An ellipse to be projected
  • plane: A plane onto which elin is to be projected

Output

Returns the ellipse resulting from the projection.

References

source
SPICE.pl2nvc — Method
pl2nvc(plane)

Return a unit normal vector and constant that define a specified plane.

Arguments

  • plane: A plane

Output

Returns a tuple consisting of

  • normal: A normal vector and...
  • constant: ... constant defining the geometric plane represented by plane

References

source
SPICE.pl2nvp — Method
pl2nvp(plane)

Return a unit normal vector and point that define a specified plane.

Arguments

  • plane: A plane

Output

Returns a tuple consisting of

  • normal: A normal vector and...
  • point: ... point defining the geometric plane represented by plane

References

source
SPICE.pl2psv — Method
pl2psv(plane)

Return a point and two orthogonal spanning vectors that define a specified plane.

Arguments

  • plane: A plane

Output

Returns a tuple consisting of a point in the plane and two vectors spanning the input plane.

References

source
SPICE.pltar — Method
pltar(vrtces, plates)

Compute the total area of a collection of triangular plates.

Arguments

  • vrtces: Array of vertices
  • plates: Array of plates

Output

Returns the area.

References

source
SPICE.pltexp — Method
pltexp(iverts, delta)

Expand a triangular plate by a specified amount. The expanded plate is co-planar with, and has the same orientation as, the original. The centroids of the two plates coincide.

Arguments

  • iverts: Vertices of the plate to be expanded
  • delta: Fraction by which the plate is to be expanded

Output

Returns the vertices of the expanded plate.

References

source
SPICE.pltnp — Method
pltnp(point, v1, v2, v3)

Find the nearest point on a triangular plate to a given point.

Arguments

  • point: A point in 3-dimensional space.
  • v1, v2, v3: Vertices of a triangular plate

Output

Returns a tuple consisting of

  • pnear: Nearest point on the plate to point
  • dist: Distance between pnear and point

References

source
SPICE.pltnrm — Method
pltnrm(v1, v2, v3)

Compute an outward normal vector of a triangular plate. The vector does not necessarily have unit length.

Arguments

  • v1, v2, v3: Vertices of a plate

Output

Returns the plate's outward normal vector.

References

source
SPICE.pltvol — Method
pltvol(vrtces, plates)

Compute the volume of a three-dimensional region bounded by a collection of triangular plates.

Arguments

  • vrtces: Array of vertices
  • plates: Array of plates

Output

Returns the volume of the spatial region bounded by the plates.

References

source
SPICE.polyds — Method
polyds(coeffs, nderiv, t)

Compute the value of a polynomial and it's first nderiv derivatives at the value t.

Arguments

  • coeffs: Coefficients of the polynomial to be evaluated
  • nderiv: Number of derivatives to compute
  • t: Point to evaluate the polynomial and derivatives

Output

Returns the value of the polynomial and the derivatives as an array.

References

source
SPICE.pos — Function
pos(str, substr, start)
Deprecated

Use first(findnext(substr, str, start)) instead.

source
SPICE.posr — Function
posr(str, substr, start)
Deprecated

Use first(findprev(substr, str, start)) instead.

source
SPICE.prop2b — Method
prop2b(gm, pvinit, dt)

Given a central mass and the state of massless body at time t_0, this routine determines the state as predicted by a two-body force model at time t_0 + dt.

Arguments

  • gm: Gravity of the central mass.
  • pvinit: Initial state from which to propagate a state.
  • dt: Time offset from initial state to propagate to.

Output

Returns the propagated state.

References

source
SPICE.psv2pl — Method
psv2pl(point, span1, span2)

Make a plane from a point and two spanning vectors.

Arguments

  • point, span1, span2: A point and two spanning vectors defining a plane

Output

Returns the plane.

References

source
SPICE.pxform — Method
pxform(from, to, et)

Return the matrix that transforms position vectors from one specified frame to another at a specified epoch.

Arguments

  • from: Name of the frame to transform from
  • to: Name of the frame to transform to
  • et: Epoch of the rotation matrix

Output

Returns the rotation matrix.

References

source
SPICE.pxfrm2 — Method
pxfrm2(from, to, etfrom, etto)

Return the 3x3 matrix that transforms position vectors from one specified frame at a specified epoch to another specified frame at another specified epoch.

Arguments

  • from: Name of the frame to transform from
  • to: Name of the frame to transform to
  • etfrom: Evaluation time of from frame
  • etto: Evaluation time of to frame

Output

Returns a position transformation matrix from frame from to frame to.

References

source
SPICE.q2m — Method
q2m(q)

Find the rotation matrix corresponding to a specified unit quaternion.

Arguments

  • q: A unit quaternion

Output

A rotation matrix corresponding to q.

References

source
SPICE.qdq2av — Method
qdq2av(q, dq)

Derive angular velocity from a unit quaternion and its derivative with respect to time.

Arguments

  • q: Unit SPICE quaternion (as any kind of iterable with four elements)
  • dq: Derivative of `q' with respect to time

Output

Angular velocity vector defined by q' anddq'

References

source
SPICE.qxq — Method
qxq(q1, q2)

Multiply two quaternions.

Arguments

  • q1: First SPICE quaternion factor (as any kind of iterable with four elements)
  • q2: Second SPICE quaternion factor (as any kind of iterable with four elements)

Output

A quaternion corresponding to the product of q1' andq2'

References

source
SPICE.radrec — Method
radrec(range, ra, dec)

Convert from range, right ascension, and declination to rectangular coordinates.

Arguments

  • range: Distance of a point from the origin
  • ra: Right ascension of point in radians
  • dec: Declination of point in radians

Output

Returns the rectangular coordinates of the point.

References

source
SPICE.rav2xf — Method
rav2xf(rot, av)

Determine a state transformation matrix from a rotation matrix and the angular velocity of the rotation.

Arguments

  • rot: Rotation matrix
  • av: Angular velocity vector

Output

Returns state transformation matrix associated with rot and av.

References

source
SPICE.raxisa — Method
raxisa(matrix)

Compute the axis of the rotation given by an input matrix and the angle of the rotation about that axis.

Arguments

  • matrix: A 3x3 rotation matrix

Output

  • axis: Axis of the rotation
  • angle: Angle through which the rotation is performed

References

source
SPICE.recazl — Method
recazl(rectan, azccw, elplsz)

Convert rectangular coordinates of a point to range, azimuth and elevation.

Arguments

  • rectan: Rectangular coordinates of a point
  • azccw: Flag indicating how azimuth is measured. If true, the azimuth increases in the counterclockwise direction; otherwise it increases in the clockwise direction
  • elplsz: Flag indicating how elevation is measured. If true, the elevation increases from the XY plane toward +Z; otherwise toward -Z

Output

Returns a tuple consisting of:

  • range: Distance of the point from the origin
  • az: Azimuth in radians
  • el: Elevation in radians

References

source
SPICE.reccyl — Method
reccyl(rectan)

Convert from rectangular to cylindrical coordinates.

Arguments

  • rectan: Rectangular coordinates of a point

Output

  • r: Distance of the point from the Z axis
  • lon: Angle (radians) of the point from the XZ plane
  • z: Height of the point above the XY plane

References

source
SPICE.recgeo — Method
recgeo(rectan, re, f)

Convert from rectangular coordinates to geodetic coordinates.

Arguments

  • rectan: Rectangular coordinates of a point
  • re: Equatorial radius of the reference spheroid
  • f: Flattening coefficient

Output

  • lon: Geodetic longitude of the point (radians)
  • lat: Geodetic latitude of the point (radians)
  • alt: Altitude of the point above reference spheroid

References

source
SPICE.reclat — Method
reclat(rectan)

Convert from rectangular coordinates to latitudinal coordinates.

Arguments

  • rectan: Rectangular coordinates of a point

Output

Returns a tuple consisting of:

  • rad: Distance of the point from the origin
  • lon: Longitude of the point (radians)
  • lat: Latitude of the point (radians)

References

source
SPICE.recpgr — Method
recpgr(body, rectan, re, f)

Convert rectangular coordinates to planetographic coordinates.

Arguments

  • body: Body with which coordinate system is associated
  • rectan: Rectangular coordinates of a point
  • re: Equatorial radius of the reference spheroid
  • f: flattening coefficient

Output

  • lon: Planetographic longitude of the point (radians).
  • lat: Planetographic latitude of the point (radians).
  • alt: Altitude of the point above reference spheroid.

References

source
SPICE.recrad — Method
recrad(rectan)

Convert rectangular coordinates to range, right ascension, and declination.

Arguments

  • rectan: Rectangular coordinates of a point

Output

Return the tuple (range, ra, dec).

  • range: Distance of the point from the origin
  • ra: Right ascension in radians
  • dec: Declination in radians

References

source
SPICE.recsph — Method
recsph(rectan)

Convert from rectangular coordinates to spherical coordinates.

Arguments

  • rectan: Rectangular coordinates of a point

Output

  • r: Distance of the point from the origin
  • colat: Angle of the point from the Z-axis in radian
  • lon: Longitude of the point in radians

References

source
SPICE.removc! — Method
removc!(set, item)

Remove an item from a character set.

Arguments

  • set: A set
  • item: Item to be removed

Output

Returns the updated set.

References

source
SPICE.removi! — Method
removi!(set, item)

Remove an item from a character set.

Arguments

  • set: A set
  • item: Item to be removed

Output

Returns the updated set.

References

source
SPICE.repmc — Function
repmc(input, marker, value)
Deprecated

Use replace(input, marker=>value) instead.

source
SPICE.rotate — Method
rotate(angle, iaxis)

Calculate the 3x3 rotation matrix generated by a rotation of a specified angle about a specified axis. This rotation is thought of as rotating the coordinate system.

Arguments

  • angle: Angle of rotation (radians)
  • iaxis: Axis of rotation (X=1, Y=2, Z=3)

Output

Returns rotation matrix associated with angle and iaxis.

References

source
SPICE.rotmat — Method
rotmat(m1, angle, iaxis)

Applies a rotation of angle radians about axis iaxis to a matrix m1. This rotation is thought of as rotating the coordinate system.

Arguments

  • m1: Matrix to be rotated
  • angle: Angle of rotation (radians)
  • iaxis: Axis of rotation (X=1, Y=2, Z=3)

Output

Returns the resulting rotated matrix.

References

source
SPICE.rotvec — Method
rotvec(v1, angle, iaxis)

Transform a vector to a new coordinate system rotated by angle radians about axis iaxis. This transformation rotates v1 by -angle radians about the specified axis.

Arguments

  • v1: Vector whose coordinate system is to be rotated
  • angle: Angle of rotation in radians
  • iaxis: Axis of rotation (X=1, Y=2, Z=3)

Output

Returns the resulting vector expressed in the new coordinate system.

References

source
SPICE.rquad — Method
rquad(a, b, c)

Find the roots of a quadratic equation.

Arguments

  • a: Coefficient of quadratic term
  • b: Coefficient of linear term
  • c: Constant

Output

  • root1: Root built from positive discriminant term
  • root2: Root built from negative discriminant term

References

source
SPICE.saelgv — Method
saelgv(vec1, vec2)

Find semi-axis vectors of an ellipse generated by two arbitrary three-dimensional vectors.

Arguments

  • vec1, vec2: Two vectors used to generate an ellipse

Output

  • smajor: Semi-major axis of ellipse
  • sminor: Semi-minor axis of ellipse

References

source
SPICE.scard! — Method
scard!(cell::SpiceCell{T}, card) where T

Set the cardinality of a cell.

Arguments

  • cell: The cell
  • card: Cardinality of (number of elements in) the cell

Output

Returns cell with its cardinality set to card.

References

source
SPICE.scdecd — Function
scdecd(sc, sclkdp, lenout=128)

Convert double precision encoding of spacecraft clock time into a character representation.

Arguments

  • sc: NAIF spacecraft identification code
  • sclkdp: Encoded representation of a spacecraft clock count
  • lenout: Maximum allowed length of output SCLK string

Output

Returns the character representation of a clock count.

References

source
SPICE.sce2c — Method
sce2c(sc, et)

Convert ephemeris seconds past J2000 (ET) to continuous encoded spacecraft clock ("ticks"). Non-integral tick values may be returned.

Arguments

  • sc: NAIF spacecraft ID code
  • et: Ephemeris time, seconds past J2000

Output

Returns SCLK, encoded as ticks since spacecraft clock start.

References

source
SPICE.sce2s — Function
sce2s(sc, et, lenout=128)

Convert an epoch specified as ephemeris seconds past J2000 (ET) to a character string representation of a spacecraft clock value (SCLK).

Arguments

  • sc: NAIF spacecraft identification code
  • et: Ephemeris time, specified as seconds past J2000
  • lenout: Maximum allowed length of output SCLK string

Output

Returns an SCLK string.

References

source
SPICE.sce2t — Method
sce2t(sc, et)

Convert ephemeris seconds past J2000 (ET) to integral encoded spacecraft clock ("ticks"). For conversion to fractional ticks, (required for C-kernel production), see the routine sce2c.

Arguments

  • sc: NAIF spacecraft ID code
  • et: Ephemeris time, seconds past J2000

Output

Returns SCLK, encoded as ticks since spacecraft clock start.

References

source
SPICE.scencd — Method
scencd(sc, sclkch)

Encode character representation of spacecraft clock time into a double precision number.

Arguments

  • sc: NAIF spacecraft identification code
  • sclkch: Character representation of a spacecraft clock

Output

Returns the encoded representation of the clock count.

References

source
SPICE.scfmt — Function
scfmt(sc, ticks, lenout=128)

Convert encoded spacecraft clock ticks to character clock format.

Arguments

  • sc: NAIF spacecraft identification code
  • ticks: Encoded representation of a spacecraft clock count
  • lenout: Maximum allowed length of output string

Output

Returns a character representation of a clock count.

References

source
SPICE.scpart — Method
scpart(sc)

Get spacecraft clock partition information from a spacecraft clock kernel file.

Arguments

  • sc: NAIF spacecraft identification code

Output

  • pstart: Array of partition start times
  • pstop: Array of partition stop times

References

source
SPICE.scs2e — Method
scs2e(sc, sclkch)

Convert a spacecraft clock string to ephemeris seconds past J2000 (ET).

Arguments

  • sc: NAIF integer code for a spacecraft
  • sclkch: An SCLK string

Output

Returns ephemeris time seconds past J2000.

References

source
SPICE.sct2e — Method
sct2e(sc, sclkdp)

Convert encoded spacecraft clock ("ticks") to ephemeris seconds past J2000 (ET).

Arguments

  • sc: NAIF integer code for a spacecraft
  • sclkdp: SCLK, encoded as ticks since spacecraft clock start.

Output

Returns ephemeris time seconds past J2000.

References

source
SPICE.sctiks — Method
sctiks(sc, clkstr)

Convert a spacecraft clock format string to number of "ticks".

Arguments

  • sc: NAIF spacecraft identification code
  • clkstr: Character representation of a spacecraft clock

Output

Returns the number of ticks represented by the clock string.

References

source
SPICE.sdiff — Method
sdiff(a::T, b::T) where T <: SpiceCell

Compute the symmetric difference of two sets of any data type to form a third set.

Arguments

  • a: First input set
  • b: Second input set

Output

Returns a cell containing the symmetric difference of a and b.

References

source
SPICE.set — Method
set(a::T, b::T) where T <: SpiceCell

Given a relational operator, compare two sets of any data type.

Arguments

  • a: First set
  • op: Comparison operator
  • b: Second set

Output

Returns the result of the comparison: a (op) b.

References

source
SPICE.sincpt — Method
sincpt(method, target, et, fixref, abcorr, obsrvr, dref, dvec)

Given an observer and a direction vector defining a ray, compute the surface intercept of the ray on a target body at a specified epoch, optionally corrected for light time and stellar aberration.

The surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in TDB seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction flag
  • obsrvr: Name of observing body
  • dref: Reference frame of ray's direction vector
  • dvec: Ray's direction vector

Output

Returns a tuple consisting of the following data or nothing if no intercept was found.

  • spoint: Surface intercept point on the target body
  • trgepc: Intercept epoch
  • srfvec: Vector from observer to intercept point

References

source
SPICE.size_c — Method
size_c(cell::SpiceCell)

Returns the maximum number of elements that cell can hold.

source
SPICE.sphcyl — Method
sphcyl(radius, colat, slon)

Converts from spherical coordinates to cylindrical coordinates.

Arguments

  • radius: Distance of point from origin
  • colat: Polar angle (co-latitude in radians) of point
  • slon: Azimuthal angle (longitude) of point (radians)

Output

  • r: Distance of point from Z axis
  • lon: Angle (radians) of point from XZ plane
  • z: Height of point above XY plane

References

source
SPICE.sphlat — Method
sphlat(r, colat, lons)

Convert from spherical coordinates to latitudinal coordinates.

Arguments

  • r: Distance of the point from the origin
  • colat: Angle of the point from positive z axis (radians)
  • lons: Angle of the point from the XZ plane (radians)

Output

  • radius: Distance of a point from the origin
  • lon: Angle of the point from the XZ plane in radians
  • lat: Angle of the point from the XY plane in radians

References

source
SPICE.sphrec — Method
sphrec(r, colat, lon)

Convert from spherical coordinates to rectangular coordinates.

Arguments

  • r: Distance of a point from the origin
  • colat: Angle of the point from the Z-axis in radians
  • lon: Angle of the point from the XZ plane in radians

Output

Returns the rectangular coordinates of the point.

References

source
SPICE.spk14a — Method
spk14a(handle, ncsets, coeffs, epochs)

Add data to a type 14 SPK segment associated with handle. See also spk14b and spk14e.

Arguments

  • handle: The handle of an SPK file open for writing
  • ncsets: The number of coefficient sets and epochs
  • coeffs: The collection of coefficient sets
  • epochs: The epochs associated with the coefficient sets

References

source
SPICE.spk14b — Method
spk14b(handle, segid, body, center, frame, first, last, chbdeg)

Begin a type 14 SPK segment in the SPK file associated with handle. See also spk14a and spk14e.

Arguments

  • handle: The handle of an SPK file open for writing
  • segid: The string to use for segment identifier
  • body: The NAIF ID code for the body of the segment
  • center: The center of motion for body
  • frame: The reference frame for this segment
  • first: The first epoch for which the segment is valid
  • last: The last epoch for which the segment is valid
  • chbdeg: The degree of the Chebyshev Polynomial used

References

source
SPICE.spk14e — Method
spk14e(handle)

End the type 14 SPK segment currently being written to the SPK file associated with handle. See also spk14a and spk14b.

Arguments

  • handle: The handle of an SPK file open for writing

Output

Returns the handle of the SPK file.

References

source
SPICE.spkacs — Method
spkacs(targ, et, ref, abcorr, obs, starg, lt, dlt)

Return the state (position and velocity) of a target body relative to an observer, optionally corrected for light time and stellar aberration, expressed relative to an inertial reference frame.

Arguments

  • targ: Target body
  • et: Observer epoch
  • ref: Inertial reference frame of output state
  • abcorr: Aberration correction flag
  • obs: Observer

Output

  • starg: State of target
  • lt: One way light time between observer and target
  • dlt: Derivative of light time with respect to time

References

source
SPICE.spkapo — Method
spkapo(targ, et, ref, sobs, abcorr)

Return the position of a target body relative to an observer, optionally corrected for light time and stellar aberration.

Arguments

  • targ: Target body
  • et: Observer epoch
  • ref: Inertial reference frame of observer's state
  • sobs: State of observer wrt. solar system barycenter
  • abcorr: Aberration correction flag

Output

  • ptarg: Position of target
  • lt: One way light time between observer and target

References

source
SPICE.spkaps — Method
spkaps(targ, et, ref, abcorr, stobs, accobs)

Given the state and acceleration of an observer relative to the solar system barycenter, return the state (position and velocity) of a target body relative to the observer, optionally corrected for light time and stellar aberration. All input and output vectors are expressed relative to an inertial reference frame.

Users normally should call the high-level API routines spkezr or spkez rather than this routine.

Arguments

  • targ: Target body.
  • et: Observer epoch.
  • ref: Inertial reference frame of output state.
  • abcorr: Aberration correction flag.
  • stobs: State of the observer relative to the SSB.
  • accobs: Acceleration of the observer relative to the SSB.

Output

  • starg: State of target.
  • lt: One way light time between observer and target.
  • dlt: Derivative of light time with respect to time.

References

source
SPICE.spkcls — Method
spkcls(handle)

Close an open SPK file.

Arguments

  • handle: Handle of the SPK file to be closed

Output

Returns the handle of the closed file.

References

source
SPICE.spkcov! — Method
spkcov!(cover, spk, idcode)

Find the coverage window for a specified ephemeris object in a specified SPK file.

Arguments

  • cover: Window giving coverage in spk for idcode
  • spk: Name of the SPK file
  • idcode: ID code of ephemeris object

Output

Returns the extended coverage window.

References

source
SPICE.spkcpo — Method
spkcpo(target, et, outref, refloc, abcorr, obspos, obsctr, obsref)

Return the state of a specified target relative to an "observer," where the observer has constant position in a specified reference frame. The observer's position is provided by the calling program rather than by loaded SPK files.

Arguments

  • target: Name of target ephemeris object
  • et: Observation epoch
  • outref: Reference frame of output state
  • refloc: Output reference frame evaluation locus
  • abcorr: Aberration correction
  • obspos: Observer position relative to center of motion
  • obsctr: Center of motion of observer
  • obsref: Frame of observer position

Output

  • state: State of target with respect to observer
  • lt: One way light time between target and observer

References

source
SPICE.spkcpt — Method
spkcpt(trgpos, trgctr, trgref, et, outref, refloc, abcorr, obsrvr)

Return the state, relative to a specified observer, of a target having constant position in a specified reference frame. The target's position is provided by the calling program rather than by loaded SPK files.

Arguments

  • trgpos: Target position relative to center of motion
  • trgctr: Center of motion of target
  • trgref: Frame of target position
  • et: Observation epoch
  • outref: Reference frame of output state
  • refloc: Output reference frame evaluation locus
  • abcorr: Aberration correction
  • obsrvr: Name of observing ephemeris object

Output

  • state: State of target with respect to observer
  • lt: One way light time between target and observer

References

source
SPICE.spkcvo — Method
spkcvo(target, et, outref, refloc, abcorr, obssta, obsepc, obsctr, obsref)

Return the state of a specified target relative to an "observer," where the observer has constant velocity in a specified reference frame. The observer's state is provided by the calling program rather than by loaded SPK files.

Arguments

  • target: Name of target ephemeris object
  • et: Observation epoch
  • outref: Reference frame of output state
  • refloc: Output reference frame evaluation locus
  • abcorr: Aberration correction
  • obssta: Observer state relative to center of motion
  • obsepc: Epoch of observer state
  • obsctr: Center of motion of observer
  • obsref: Frame of observer state

Output

  • state: State of target with respect to observer
  • lt: One way light time between target and observer

References

source
SPICE.spkcvt — Method
spkcvt(trgsta, trgepc, trgctr, trgref, et, outref, refloc, abcorr, obsrvr)

Return the state, relative to a specified observer, of a target having constant velocity in a specified reference frame. The target's state is provided by the calling program rather than by loaded SPK files.

Arguments

  • trgsta: Target state relative to center of motion
  • trgepc: Epoch of target state
  • trgctr: Center of motion of target
  • trgref: Frame of target state
  • et: Observation epoch
  • outref: Reference frame of output state
  • refloc: Output reference frame evaluation locus
  • abcorr: Aberration correction
  • obsrvr: Name of observing ephemeris object

Output

  • state: State of target with respect to observer
  • lt: One way light time between target and observer

References

source
SPICE.spkez — Method
spkez(targ, et, ref, abcorr, obs)

Return the state (position and velocity) of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.

Arguments

  • targ: Target body
  • et: Observer epoch
  • ref: Reference frame of output state vector
  • abcorr: Aberration correction flag
  • obs: Observing body

Output

  • starg: State of target
  • lt: One way light time between observer and target

References

source
SPICE.spkezp — Method
spkezp(targ, et, ref, abcorr, obs)

Return the position of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.

Arguments

  • targ: Target body
  • et: Observer epoch
  • ref: Reference frame of output state vector
  • abcorr: Aberration correction flag
  • obs: Observing body

Output

  • ptarg: Position of target
  • lt: One way light time between observer and target

References

source
SPICE.spkezr — Method
spkezr(targ, et, ref, abcorr, obs)

Return the state (position and velocity) of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.

Arguments

  • targ: Target body name
  • et: Observer epoch
  • ref: Reference frame of output state vector
  • abcorr: Aberration correction flag
  • obs: Observing body name

Output

  • starg: State of target
  • lt: One way light time between observer and target

References

source
SPICE.spkgeo — Method
spkgeo(targ, et, ref, obs)

Compute the geometric state (position and velocity) of a target body relative to an observing body.

Arguments

  • targ: Target body.
  • et: Target epoch.
  • ref: Target reference frame.
  • obs: Observing body.

Output

  • state: State of target.
  • lt: Light time.

References

source
SPICE.spkgps — Method
spkgps(targ, et, ref, obs)

Compute the geometric position of a target body relative to an observing body.

Arguments

  • targ: Target body
  • et: Target epoch
  • ref: Target reference frame
  • obs: Observing body

Output

  • pos: Position of target
  • lt: Light time

References

source
SPICE.spklef — Method
spklef(fname)

Load an ephemeris file for use by the readers. Return that file's handle, to be used by other SPK routines to refer to the file.

Arguments

  • fname: Name of the file to be loaded

Output

  • handle: Loaded file's handle

References

source
SPICE.spkltc — Method
spkltc(targ, et, ref, abcorr, stobs)

Return the state (position and velocity) of a target body relative to an observer, optionally corrected for light time, expressed relative to an inertial reference frame.

Arguments

  • targ: Target body
  • et: Observer epoch
  • ref: Inertial reference frame of output state
  • abcorr: Aberration correction flag
  • stobs: State of the observer relative to the SSB

Output

  • starg: State of target
  • lt: One way light time between observer and target
  • dlt: Derivative of light time with respect to time

References

source
SPICE.spkobj! — Method
spkobj!(ids, spk)

Find the set of ID codes of all objects in a specified SPK file.

Arguments

  • ids: A preallocated set of ID codes of objects in SPK file
  • spk: Name of the SPK file

Output

Returns the set of id codes.

References

source
SPICE.spkopa — Method
spkopa(file)

Open an existing SPK file for subsequent write.

Arguments

  • file: The name of an existing SPK file

Output

Returns a handle attached to the SPK file opened to append.

References

source
SPICE.spkopn — Function
spkopn(name, ifname="", ncomch=0)

Create a new SPK file, returning the handle of the opened file.

Arguments

  • name: The name of the new SPK file to be created
  • ifname: The internal filename for the SPK file (default: "")
  • ncomch: The number of characters to reserve for comments (default: 0)

Output

Returns the handle of the opened SPK file.

References

source
SPICE.spkpds — Method
spkpds(body, center, frame, typ, first, last)

Perform routine error checks and if all checks pass, pack the descriptor for an SPK segment.

Arguments

  • body: The NAIF ID code for the body of the segment
  • center: The center of motion for body
  • frame: The frame for this segment
  • type: The type of SPK segment to create
  • first: The first epoch for which the segment is valid
  • last: The last epoch for which the segment is valid

Output

Returns an SPK segment descriptor.

References

source
SPICE.spkpos — Method
spkpos(targ, et, ref, abcorr, obs)

Return the position of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.

Arguments

  • targ: Target body name
  • et: Observer epoch
  • ref: Reference frame of output position vector
  • abcorr: Aberration correction flag
  • obs: Observing body name

Output

  • ptarg: Position of target
  • lt: One way light time between observer and target

References

source
SPICE.spkpvn — Method
spkpvn(handle, descr, et)

For a specified SPK segment and time, return the state (position and velocity) of the segment's target body relative to its center of motion.

Arguments

  • handle: File handle
  • descr: Segment descriptor
  • et: Evaluation epoch

Output

  • ref: Segment reference frame ID code
  • state: Output state vector
  • center: Center of state

References

source
SPICE.spksfs — Method
spksfs(body, et)

Search through loaded SPK files to find the highest-priority segment applicable to the body and time specified.

Arguments

  • body: Body ID
  • et: Ephemeris time

Output

Returns nothing if no segment was found or a tuple consisting of:

  • handle: Handle of file containing the applicable segment
  • descr: Descriptor of the applicable segment
  • ident: Identifier of the applicable segment

References

source
SPICE.spkssb — Method
spkssb(targ, et, ref)

Return the state (position and velocity) of a target body relative to the solar system barycenter.

Arguments

  • targ: Target body
  • et: Target epoch
  • ref: Target reference frame

Output

Returns the state of target.

References

source
SPICE.spksub! — Method
spksub!(newh, handle, descr, ident, start, stop)

Extract a subset of the data in an SPK segment into a separate segment.

Arguments

  • newh: Handle of new segment
  • handle: Handle of source segment
  • descr: Descriptor of source segment
  • ident: Identifier of source segment
  • start: Beginning (initial epoch) of subset
  • stop: End (final epoch) of subset

References

source
SPICE.spkuds — Method
spkuds(descr)

Unpack the contents of an SPK segment descriptor.

Arguments

  • descr: An SPK segment descriptor

Output

  • body: The NAIF ID code for the body of the segment
  • center: The center of motion for body
  • frame: The ID code for the frame of this segment
  • type: The type of SPK segment
  • first: The first epoch for which the segment is valid
  • last: The last epoch for which the segment is valid
  • start: Beginning DAF address of the segment
  • stop: Ending DAF address of the segment

References

source
SPICE.spkuef — Method
spkuef(handle)

Unload an ephemeris file so that it will no longer be searched by the readers.

Arguments

  • handle: Handle of file to be unloaded

References

source
SPICE.spkw02 — Method
spkw02(handle, body, center, frame, first, last, segid, intlen, cdata, btime)

Write a type 2 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • intlen: Length of time covered by logical record
  • cdata: Array of Chebyshev coefficients
  • btime: Begin time of first logical record

References

source
SPICE.spkw03 — Method
spkw03(handle, body, center, frame, first, last, segid, intlen, cdata, btime)

Write a type 3 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • intlen: Length of time covered by logical record
  • cdata: Array of Chebyshev coefficients
  • btime: Begin time of first logical record

References

source
SPICE.spkw05 — Method
spkw05(handle, body, center, frame, first, last, segid, gm, states, epochs)

Write an SPK segment of type 5 given a time-ordered set of discrete states and epochs, and the gravitational parameter of a central body.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • gm: Gravitational parameter of central body
  • states: States
  • epochs: Epochs

References

source
SPICE.spkw08 — Method
spkw08(handle, body, center, frame, first, last, segid, degree, states, epoch1, step)

Write a type 8 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • degree: Degree of interpolating polynomials
  • states: States
  • epoch1: Epoch of first state in states array
  • step: Time step separating epochs of states

References

source
SPICE.spkw09 — Method
spkw09(handle, body, center, frame, first, last, segid, degree, states, epochs)

Write a type 9 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • degree: Degree of interpolating polynomials
  • states: States
  • epochs: Epochs

References

source
SPICE.spkw10 — Method
spkw10(handle, body, center, frame, first, last, segid, consts, elems, epochs)

Write a type 10 segment to an SPK file.

Arguments

  • handle: The handle of a DAF file open for writing
  • body: The NAIF ID code for the body of the segment
  • center: The center of motion for body
  • frame: The reference frame for this segment
  • first: The first epoch for which the segment is valid
  • last: The last epoch for which the segment is valid
  • segid: The string to use for segment identifier
  • consts: The array of geophysical constants for the segmen
  • elems: The collection of "two-line" element sets
  • epochs: The epochs associated with the element sets

References

source
SPICE.spkw12 — Method
spkw12(handle, body, center, frame, first, last, segid, degree, states, epoch1, step)

Write a type 12 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • degree: Degree of interpolating polynomials
  • states: States
  • epoch1: Epoch of first state in states array
  • step: Time step separating epochs of states

References

source
SPICE.spkw13 — Method
spkw13(handle, body, center, frame, first, last, segid, degree, states, epochs)

Write a type 13 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • degree: Degree of interpolating polynomials
  • states: States
  • epochs: Epochs

References

source
SPICE.spkw15 — Method
spkw15(handle, body, center, frame, first, last, segid,
+       epoch, tp, pa, p, ecc, j2flg, pv, gm, j2, radius)

Write a type 15 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • epoch: Epoch of the periapse
  • tp: Trajectory pole vector
  • pa: Periapsis vector
  • p: Semi-latus rectum
  • ecc: Eccentricity
  • j2flg: J2 processing flag
  • pv: Central body pole vector
  • gm: Central body GM
  • j2: Central body J2
  • radius: Equatorial radius of central body

References

source
SPICE.spkw17 — Method
spkw17(handle, body, center, frame, first, last, segid, epoch, eqel, rapol, decpol)

Write a type 17 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • body: Body code for ephemeris object
  • center: Body code for the center of motion of the body
  • frame: The reference frame of the states
  • first: First valid time for which states can be computed
  • last: Last valid time for which states can be computed
  • segid: Segment identifier
  • epoch: Epoch of elements in seconds past J2000
  • eqel: Array of equinoctial elements
  • rapol: Right Ascension of the pole of the reference plane
  • decpol: Declination of the pole of the reference plane

References

source
SPICE.spkw18 — Method
spkw18(handle, subtyp, body, center, frame, first, last, segid, degree, packts, epochs)

Write a type 18 segment to an SPK file.

Arguments

  • handle: Handle of an SPK file open for writing
  • subtyp: SPK type 18 subtype code, either :S18TP0 or :S18TP1
  • body: NAIF code for an ephemeris object
  • center: NAIF code for center of motion of body
  • frame: Reference frame name
  • first: Start time of interval covered by segment
  • last: End time of interval covered by segment
  • segid: Segment identifier
  • degree: Degree of interpolating polynomials
  • packts: Time-ordered array of data packets representing geometric states of body
    • For :S18TP0: [x, y, z, dx/dt, dy/dt, dz/dt, vx, vy, vz, dvx/dt, dvy/dt, dvz/dt]
    • For :S18TP1: [x, y, z, dx/dt, dy/dt, dz/dt]
  • epochs: Array of epochs corresponding to states.

References

source
SPICE.spkw20 — Method
spkw20(handle, body, center, frame, first, last, segid, intlen, n, polydg, cdata, dscale,
+       tscale, initjd, initfr)

Write a type 20 segment to an SPK file.

Arguments

  • handle: Handle of SPK file open for writing
  • body: NAIF code for ephemeris object
  • center: NAIF code for the center of motion of the body
  • frame: Reference frame name
  • first: Start time of interval covered by segment
  • last: End time of interval covered by segment
  • segid: Segment identifier
  • intlen: Length of time covered by logical record (days)
  • cdata: Array of Chebyshev coefficients and positions
  • dscale: Distance scale of data
  • tscale: Time scale of data
  • initjd: Integer part of begin time (TDB Julian date) of first record
  • initfr: Fractional part of begin time (TDB Julian date) of first record

References

source
SPICE.srfc2s — Method
srfc2s(code, bodyid)

Translate a surface ID code, together with a body ID code, to the corresponding surface name. If no such name exists, return a string representation of the surface ID code.

Arguments

  • code: Integer surface ID code to translate to a string
  • bodyid: ID code of body associated with surface

Output

  • srfstr: String corresponding to surface ID code
  • isname: Logical flag indicating output is a surface name

References

source
SPICE.srfcss — Method
srfcss(code, bodstr)

Translate a surface ID code, together with a body string, to the corresponding surface name. If no such surface name exists, return a string representation of the surface ID code.

Arguments

  • code: Integer surface ID code to translate to a string
  • bodstr: Name or ID of body associated with surface

Output

  • srfstr: String corresponding to surface ID code
  • isname: Logical flag indicating output is a surface name

References

source
SPICE.srfnrm — Method
srfnrm(method, target, et, fixref, npts, srfpts)

Map array of surface points on a specified target body to the corresponding unit length outward surface normal vectors.

The surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in TDB seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • srfpts: Array of surface points

Output

Returns an array of outward, unit length normal vectors.

References

source
SPICE.srfrec — Method
srfrec(body, longitude, latitude)

Convert planetocentric latitude and longitude of a surface point on a specified body to rectangular coordinates.

Arguments

  • body: NAIF integer code of an extended body.
  • longitude: Longitude of point in radians.
  • latitude: Latitude of point in radians.

Output

Returns the rectangular coordinates of the point.

References

source
SPICE.srfs2c — Method
srfs2c(srfstr, bodstr)

Translate a surface string, together with a body string, to the corresponding surface ID code. The input strings may contain names or integer ID codes.

Arguments

  • srfstr: Surface name or ID string
  • bodstr: Body name or ID string

Output

Returns the surface ID code if it was found or nothing otherwise.

References

source
SPICE.srfscc — Method
srfscc(srfstr, bodyid)

Translate a surface string, together with a body ID code, to the corresponding surface ID code. The input surface string may contain a name or an integer ID code.

Arguments

  • srfstr: Surface name or ID string
  • bodyid: Body ID code.

Output

Returns the surface ID code if it was found or nothing otherwise.

References

source
SPICE.ssize! — Method
ssize!(cell, size)

Set the size (maximum cardinality) of a cell of any data type.

Arguments

  • cell: The cell
  • size: Size (maximum cardinality) of the cell

Output

Returns the updated cell.

References

source
SPICE.stelab — Method
stelab(pobj, vobs)

Correct the apparent position of an object for stellar aberration.

Arguments

  • pobj: Position of an object with respect to the observer
  • vobs: Velocity of the observer with respect to the Solar System barycenter

Output

Returns the apparent position of the object with respect to the observer, corrected for stellar aberration.

References

source
SPICE.stpool — Function
stpool(item, nth, contin, lenout=1024)

Retrieve the nth string from the kernel pool variable, where the string may be continued across several components of the kernel pool variable.

Arguments

  • item: Name of the kernel pool variable
  • nth: Index of the full string to retrieve
  • contin: Character sequence used to indicate continuation
  • lenout: Available space in output string (default: 1024)

Output

Returns the full string concatenated across continuations if the kernel variable was found or nothing otherwise.

References

source
SPICE.str2et — Method
str2et(str)

Convert a string representing an epoch to a double precision value representing the number of TDB seconds past the J2000 epoch corresponding to the input epoch.

Arguments

  • str: A string representing an epoch

Output

Returns the equivalent value in seconds past J2000, TDB.

References

source
SPICE.subpnt — Method
subpnt(method, target, et, fixref, obsrvr, abcorr)

Compute the rectangular coordinates of the sub-observer point on a target body at a specified epoch, optionally corrected for light time and stellar aberration.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in ephemeris seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction
  • obsrvr: Name of observing body

Output

  • spoint: Sub-solar point on the target body
  • trgepc: Sub-solar point epoch
  • srfvec: Vector from observer to sub-solar point

References

source
SPICE.subslr — Method
subslr(method, target, et, fixref, abcorr, obsrvr)

Compute the rectangular coordinates of the sub-solar point on a target body at a specified epoch, optionally corrected for light time and stellar aberration.

Arguments

  • method: Computation method
  • target: Name of target body
  • et: Epoch in ephemeris seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction
  • obsrvr: Name of observing body

Output

  • spoint: Sub-solar point on the target body
  • trgepc: Sub-solar point epoch
  • srfvec: Vector from observer to sub-solar point

References

source
SPICE.surfnm — Method
surfnm(a, b, c, point)

Computes the outward-pointing, unit normal vector from a point on the surface of an ellipsoid.

Arguments

  • a: Length of the ellisoid semi-axis along the x-axis
  • b: Length of the ellisoid semi-axis along the y-axis
  • c: Length of the ellisoid semi-axis along the z-axis
  • point: Body-fixed coordinates of a point on the ellipsoid

Output

Return the outward pointing unit normal to ellipsoid at point

References

source
SPICE.surfpt — Method
surfpt(positn, u, a, b, c)

Determine the intersection of a line-of-sight vector with the surface of an ellipsoid.

Arguments

  • positn: Position of the observer in body-fixed frame
  • u: Vector from the observer in some direction
  • a: Length of the ellipsoid semi-axis along the x-axis
  • b: Length of the ellipsoid semi-axis along the y-axis
  • c: Length of the ellipsoid semi-axis along the z-axis

Output

Returns the point on the ellipsoid pointed to by u or nothing if none was found.

References

source
SPICE.surfpv — Method
surfpv(stvrtx, stdir, a, b, c)

Find the state (position and velocity) of the surface intercept defined by a specified ray, ray velocity, and ellipsoid.

Arguments

  • stvrtx: State of ray's vertex
  • stdir: State of ray's direction vector
  • a: Length of ellipsoid semi-axis along the x-axis
  • b: Length of ellipsoid semi-axis along the y-axis
  • c: Length of ellipsoid semi-axis along the z-axis

Output

Return the state of surface intercept or nothing if none was found.

References

source
SPICE.swpool — Method
swpool(agent, names)

Add a name to the list of agents to notify whenever a member of a list of kernel variables is updated.

Arguments

  • agent: The name of an agent to be notified after updates
  • names: Variable names whose update causes the notice

References

source
SPICE.sxform — Method
sxform(from, to, et)

Return the state transformation matrix from one frame to another at a specified epoch.

Arguments

  • from: Name of the frame to transform from
  • to: Name of the frame to transform to
  • et: Epoch of the state transformation matrix

Output

Returns the state transformation matrix.

References

source
SPICE.szpool — Method
szpool(name)

Return the kernel pool size limitations.

Arguments

  • name: Name of the parameter to be returned

Output

Returns the value of the parameter specified by name or nothing if none was found.

References

source
SPICE.termpt — Method

Find terminator points on a target body. The caller specifies half-planes, bounded by the illumination source center-target center vector, in which to search for terminator points.

The terminator can be either umbral or penumbral. The umbral terminator is the boundary of the region on the target surface where no light from the source is visible. The penumbral terminator is the boundary of the region on the target surface where none of the light from the source is blocked by the target itself.

The surface of the target body may be represented either by a triaxial ellipsoid or by topographic data.

Arguments

  • method: Computation method
  • ilusrc: Illumination source
  • target: Name of target body
  • et: Epoch in ephemeris seconds past J2000 TDB
  • fixref: Body-fixed, body-centered target body frame
  • abcorr: Aberration correction
  • corloc: Aberration correction locus
  • obsrvr: Name of observing body
  • refvec: Reference vector for cutting half-planes
  • rolstp: Roll angular step for cutting half-planes
  • ncuts: Number of cutting planes
  • schstp: Angular step size for searching
  • soltol: Solution convergence tolerance
  • maxn: Maximum number of entries in output arrays

Output

  • npts: Counts of terminator points corresponding to cuts
  • points: Terminator points
  • epochs: Times associated with terminator points
  • trmvcs: Terminator vectors emanating from the observer

References

source
SPICE.timdef — Function
timdef(action, item, value="")

Set and retrieve the defaults associated with calendar input strings.

Arguments

  • action: The kind of action to take, either :SET or :GET
  • item: The default item of interest. The items that may be requested are:
    • :CALENDAR with allowed values:
      • "GREGORIAN"
      • "JULIAN"
      • "MIXED"
    • :SYSTEM with allowed values:
      • "TDB"
      • "TDT"
      • "UTC"
    • :ZONE with allowed values (0 <= HR < 13 and 0 <= MN < 60):
      • "EST"
      • "EDT"
      • "CST"
      • "CDT"
      • "MST"
      • "MDT"
      • "PST"
      • "PDT"
      • "UTC+$HR"
      • "UTC-$HR"
      • "UTC+$HR:$MN"
      • "UTC-$HR:$MN"

Output

Returns the value associated with the default item.

References

source
SPICE.timout — Function
timout(et, pictur, lenout=128)

This routine converts an input epoch represented in TDB seconds past the TDB epoch of J2000 to a character string formatted to the specifications of a user's format picture.

Arguments

  • et: An epoch in seconds past the ephemeris epoch J2000
  • pictur: A format specification for the output string
  • lenout: The length of the output string plus 1 (default: 128)

Output

Returns a string representation of the input epoch.

References

source
SPICE.tipbod — Method
tipbod(ref, body, et)

Return a 3x3 matrix that transforms positions in inertial coordinates to positions in body-equator-and-prime-meridian coordinates.

Arguments

  • ref: Name of inertial reference frame to transform from
  • body: ID code of body
  • et: Epoch of transformation

Output

Returns transformation matrix from intertial position to prime meridian.

References

source
SPICE.tisbod — Method
tisbod(ref, body, et)

Return a 6x6 matrix that transforms states in inertial coordinates to states in body-equator-and-prime-meridian coordinates.

Arguments

  • ref: Name of inertial reference frame to transform from
  • body: ID code of body
  • et: Epoch of transformation

Output

Returns transformation matrix from intertial state to prime meridian.

References

source
SPICE.tparse — Method
tparse(string)

Parse a time string and return seconds past the J2000 epoch on a formal calendar.

Arguments

  • string: Input time string in UTC

Output

Returns UTC expressed in seconds since J2000.

References

source
SPICE.tpictr — Function
tpictr(sample, lenout=80)

Given a sample time string, create a time format picture suitable for use by the routine timout.

Arguments

  • sample: A sample time string
  • lenout: The length for the output picture string (default: 80)

Output

Returns a format picture that describes sample.

References

source
SPICE.trace — Function
trace(matrix)
Deprecated

Use LinearAlgebra.tr(matrix) instead.

source
SPICE.twovec — Method
twovec(axdef, indexa, plndef, indexp)

Find the transformation to the right-handed frame having a given vector as a specified axis and having a second given vector lying in a specified coordinate plane.

Arguments

  • axdef: Vector defining a principal axis
  • indexa: Principal axis number of axdef (X=1, Y=2, Z=3)
  • plndef: Vector defining (with axdef) a principal plane
  • indexp: Second axis number (with indexa) of principal plane

Output

Returns output rotation matrix.

References

source
SPICE.ucrss — Function
ucrss(v1, v2)
Deprecated

Use LinearAlgebra.normalize(LinearAlgebra.cross(v1, v2)) instead.

source
SPICE.uddf — Method
uddf(udfunc, x, dx)

Routine to calculate the first derivative of a caller-specified function using a three-point estimation.

Arguments

  • udfunc: A callable that computes the scalar value of interest, e.g. f(x::Float64) -> Float64
  • x: Independent variable of udfunc
  • dx: Interval from x for derivative calculation

Output

Returns the approximate derivative of udfunc at x.

References

source
SPICE.unitim — Method
unitim(epoch, insys, outsys)

Transform time from one uniform scale to another.

Arguments

  • epoch: An epoch to be converted
  • insys: The time scale associated with the input epoch
  • outsys: The time scale associated with the function value

The uniform time scales are:

  • :TAI
  • :TDT
  • :TDB
  • :ET
  • :JED
  • :JDTDB
  • :JDTDT

Output

Returns the time in the system specified by outsys that is equivalent to the epoch in the insys time scale.

References

source
SPICE.unorm — Function
unorm(v1)
Deprecated

Use (LinearAlgebra.normalize(v1), LinearAlgebra.norm(v1)) instead.

source
SPICE.unormg — Function
unormg(v1)
Deprecated

Use (LinearAlgebra.normalize(v1), LinearAlgebra.norm(v1)) instead.

source
SPICE.utc2et — Method
utc2et(utcstr)

Convert an input time from Calendar or Julian Date format, UTC, to ephemeris seconds past J2000.

Arguments

  • utcstr: Input time string, UTC

Output

Returns the equivalent of utcstr, expressed in ephemeris seconds past J2000.

References

source
SPICE.valid! — Method
valid!(set::SpiceCell{T}) where T

Create a valid SPICE set from a SPICE Cell of any data type.

Arguments

  • set: Set to be validated

Output

Returns the validated set with ordered elements and duplicates removed.

References

source
SPICE.vcrss — Function
vcrss(v1, v2)
Deprecated

Use LinearAlgebra.cross(v1, v2) instead.

source
SPICE.vdist — Function
vdist(v1, v2)
Deprecated

Use LinearAlgebra.norm(v1 .- v2) instead.

source
SPICE.vdistg — Function
vdistg(v1, v2)
Deprecated

Use LinearAlgebra.norm(v1 .- v2) instead.

source
SPICE.vdot — Function
vdot(v1, v2)
Deprecated

Use LinearAlgebra.dot(v1, v2) instead.

source
SPICE.vdotg — Function
vdotg(v1, v2)
Deprecated

Use LinearAlgebra.dot(v1, v2) instead.

source
SPICE.vhat — Function
vhat(v1)
Deprecated

Use LinearAlgebra.normalize(v1) instead.

source
SPICE.vhatg — Function
vhatg(v1)
Deprecated

Use LinearAlgebra.normalize(v1) instead.

source
SPICE.vlcom — Function
vlcom(a, v1, b, v2)
Deprecated

Use a .* v1 .+ b .* v2 instead.

source
SPICE.vlcom3 — Function
vlcom3(a, v1, b, v2, c, v3)
Deprecated

Use a .* v1 .+ b .* v2 .+ c .* v3 instead.

source
SPICE.vlcomg — Function
vlcomg(a, v1, b, v2)
Deprecated

Use a .* v1 .+ b .* v2 instead.

source
SPICE.vnormg — Function
vnormg(v1, v2)
Deprecated

Use LinearAlgebra.norm(v1) instead.

source
SPICE.vperp — Method
vperp(a, b)

Find the component of a vector that is perpendicular to a second vector.

Arguments

  • a: The vector whose orthogonal component is sought
  • b: The vector used as the orthogonal reference

Output

Returns the component a orthogonal to b.

References

source
SPICE.vprjp — Method
vprjp(vin, plane)

Project a vector onto a specified plane, orthogonally.

Arguments

  • vin: Vector to be projected
  • plane: Plane onto which vin is projected

Output

Returns the vector resulting from the projection.

References

source
SPICE.vprjpi — Method
vprjpi(vin, projpl, invpl)

Find the vector in a specified plane that maps to a specified vector in another plane under orthogonal projection.

Arguments

  • vin: The projected vector
  • projpl: Plane containing vin
  • invpl: Plane containing inverse image of vin

Output

Returns the inverse projection of vin or nothing if vin could not be calculated.

References

source
SPICE.vproj — Method
vproj(a, b)

Finds the projection of one vector onto another vector. All vectors are 3-dimensional.

Arguments

  • a: The vector to be projected
  • b: The vector onto which a is to be projected

Output

Returns the projection of a onto b.

References

source
SPICE.vrel — Method
vrel(v1, v2)

Return the relative difference between two 3-dimensional vectors.

Arguments

  • v1, v2: Two three-dimensional input vectors

Output

Returns the relative differences between v1 and v2.

References

source
SPICE.vrelg — Method
vrelg(v1, v2)

Return the relative difference between two vectors.

Arguments

  • v1, v2: Input vectors

Output

Returns the relative differences between v1 and v2.

References

source
SPICE.vrotv — Method
vrotv(v, axis, theta)

Rotate a vector about a specified axis vector by a specified angle and return the rotated vector.

Arguments

  • v: Vector to be rotated
  • axis: Axis of the rotation
  • theta: Angle of rotation (radians)

Output

Result of rotating v about axis by theta.

References

source
SPICE.vsep — Method
vsep(v1, v2)

Return the sepative difference between two 3-dimensional vectors.

Arguments

  • v1, v2: Two three-dimensional input vectors

Output

Returns the angle between v1 and v2 in radians.

References

source
SPICE.vsepg — Method
vsepg(v1, v2)

Return the sepative difference between two vectors.

Arguments

  • v1, v2: Input vectors

Output

Returns the angle between v1 and v2 in radians.

References

source
SPICE.vtmv — Function
vtmv(v1, matrix, v2)
Deprecated

Use v1' * matrix * v2 instead.

source
SPICE.vtmvg — Function
vtmvg(v1, matrix, v2)
Deprecated

Use v1' * matrix * v2 instead.

source
SPICE.wncomd — Method
wncomd(window, left, right)

Determine the complement of a double precision window with respect to a specified interval.

Arguments

  • window: Input window
  • left: Left endpoint of the complement interval
  • right: Right endpoint of the complement interval

Output

Returns the complement of window with respect to [left,right].

References

source
SPICE.wncond! — Method
wncond!(window, left, right)

Contract each of the intervals of a double precision window.

Arguments

  • window: Window to be contracted
  • left: Amount added to each left endpoint
  • right: Amount subtracted from each right endpoint

Output

Returns the contracted window.

References

source
SPICE.wndifd — Method
wndifd(a, b)

Place the difference of two double precision windows into a third window.

Arguments

  • a: Input window
  • b: Input window

Output

Returns a window containing the difference of a and b.

References

source
SPICE.wnelmd — Method
wnelmd(window, point)

Determine whether a point is an element of a double precision window.

Arguments

  • window: Input window
  • point: Input point

Output

Returns true if point is an element of window.

References

source
SPICE.wnexpd! — Method
wnexpd(window, left, right)

Expand each of the intervals of a double precision window.

Arguments

  • left: Amount subtracted from each left endpoint
  • right: Amount added to each right endpoint

Output

Returns the expanded window.

References

source
SPICE.wnextd! — Method
wnextd!(window, side)

Extract the left or right endpoints from a double precision window.

Arguments

  • window: Window to be extracted
  • side: Extract left (:L) or right (:R) endpoints

Output

Returns the extracted window.

References

source
SPICE.wnfetd — Method
wnfetd(window, n)

Fetch a particular interval from a double precision window.

Arguments

  • window: Input window
  • n: Index of interval to be fetched

Output

Returns a tuple consisting of the left and right endpoints of the n-th interval in the input window.

References

source
SPICE.wnfild! — Method
wnfild!(window, small)

Fill small gaps between adjacent intervals of a double precision window.

Arguments

  • window: Window to be filled
  • small: Limiting measure of small gaps

Output

Returns the updated window.

References

source
SPICE.wnfltd! — Method
wnfild!(window, small)

Filter (remove) small intervals from a double precision window.

Arguments

  • window: Window to be filtered
  • small: Limiting measure of small intervals

Output

Returns the updated window.

References

source
SPICE.wnincd — Method
wnincd(window, left, right)

Determine whether an interval is included in a double precision window.

Arguments

  • window: Input window
  • left: Left endpoint of the input interval
  • right: Right endpoint of the input interval

Output

Returns true when (left, right) is contained in window.

References

source
SPICE.wninsd! — Method
wninsd!(window, left, right)

Insert an interval into a double precision window.

Arguments

  • window: Input window
  • left: Left endpoint of the new interval
  • right: Right endpoint of the new interval

Output

Returns the updated windows.

References

source
SPICE.wnintd — Method
wnintd(a, b)

Place the intersection of two double precision windows into a third window.

Arguments

  • a: Input window
  • b: Input window

Output

Returns a window containing the intersection of a and b.

References

source
SPICE.wnreld — Method
wnreld(a, op, b)

Compare two double precision windows.

Note

Consider using overloaded operators instead, i.e. a == b, a ⊆ b, and a ⊊ b.

Arguments

  • a: First window
  • op: Comparison operator
  • b: Second window

Output

Returns the result of comparison a (op) b.

References

source
SPICE.wnsumd — Method
wnsumd(window)

Summarize the contents of a double precision window.

Arguments

  • window: Window to be summarized

Output

Returns a tuple consisting of:

  • meas: Total measure of intervals in window
  • avg: Average measure
  • stddev: Standard deviation
  • shortest: Location of shortest interval
  • longest: Location of longest interval

References

source
SPICE.wnunid — Method
wnunid(a, b)

Place the union of two double precision windows into a third window.

Arguments

  • a: Input window
  • b: Input window

Output

Returns a window containing the union of a and b.

References

source
SPICE.wnvald! — Method
wnvald!(window)

Form a valid double precision window from the contents of a window array.

Arguments

  • window: A (possibly uninitialized) SpiceDoubleCell containing endpoints of (possibly unordered and non-disjoint) intervals.

Output

Returns the validated window.

References

source
SPICE.xf2eul — Method
xf2eul(xform, axisa, axisb, axisc)

Convert a state transformation matrix to Euler angles and their derivatives with respect to a specified set of axes.

Arguments

  • xform: A state transformation matrix
  • axisa: Axis A of the Euler angle factorization
  • axisb: Axis B of the Euler angle factorization
  • axisc: Axis C of the Euler angle factorization

Output

Returns a tuple of an array of Euler angles and their derivatives and a boolean that indicates whether these are a unique representation.

References

source
SPICE.xf2rav — Method
xf2rav(xform)

Determines the rotation matrix and angular velocity of the rotation from a state transformation matrix.

Arguments

  • xform: State transformation matrix

Output

Returns a tuple of the rotation matrix and the angular velocity vector associated with xform.

References

source
SPICE.xfmsta — Method
xfmsta(input_state, input_coord_sys, output_coord_sys, body)

Transform a state between coordinate systems.

Arguments

  • input_state: Input state
  • input_coord_sys: Current (input) coordinate system
  • output_coord_sys: Desired (output) coordinate system
  • body: Name or NAIF ID of body with which coordinates are associated (if applicable)

Output

Returns the converted output state.

References

source
diff --git a/dev/executables/index.html b/dev/executables/index.html new file mode 100644 index 0000000..64d14ef --- /dev/null +++ b/dev/executables/index.html @@ -0,0 +1,234 @@ + +Executables · SPICE.jl
Edit on GitHub

SPICEApplications.jl

Note

The SPICEApplications module is not included within SPICE. To access the functions documented on this page, install SPICEApplications using Julia's package manager: Pkg.install("SPICEApplications").

The JPL SPICE Toolkit provides executables for interacting with SPICE kernels, such as mkspk, brief, and others. SPICEApplications.jl provides idiomatic Julia interfaces to these executables, which themselves are packaged by CSPICE_jll.jl.

Usage

Each executable can be called through its corresponding function without arguments, or programatically using function arguments. For example, the SPICE Toolkit's BRIEF program prints the description of a provided kernel. When the brief executable is called without arguments, it prints its "help" text; this can be replicated by calling SPICEApplications.brief() without arguments. Alternatively, you can pass the kernel that you want to inspect as a positional argument: brief(kernel_file).

All SPICE Toolkit executables are documented within the SPICE Toolkit Documentation.

julia> using SPICEApplications
julia> kernel = download("https://naif.jpl.nasa.gov/pub/naif/CASSINI/kernels/spk/000202R_SK_V1P32_V2P12.bsp")"/tmp/jl_PWHmby1uXY"
julia> brief(kernel); 
+BRIEF -- Version 4.1.0, September 17, 2021 -- Toolkit Version N0067
+ 
+ 
+Summary for: /tmp/jl_PWHmby1uXY
+ 
+Body: CASSINI (-82)
+      Start of Interval (ET)              End of Interval (ET)
+      -----------------------------       -----------------------------
+      1998 MAY 28 21:23:03.184            1999 JUL 06 16:01:04.183

Example

For a concrete usage example, see how SPICEApplications is used to generate docstrings for SPICEKernels.jl.

Reference

SPICEApplications.SPICEApplications — Module

Call all SPICE Utilities from within Julia!

Warning

This package is not affiliated with or endorsed by NASA, JPL, Caltech, or any other organization! This is an independently written package by an astrodynamics hobbyist.

Extended help

README

Tests Docs SciML Code Style

SPICEApplications

Generate ephemeris kernel files using NASA JPL's SPICEApplications program, all from within Julia!

Please consider all minor changes breaking until v1.0!

Warning

This package is not affiliated with or endorsed by NASA, JPL, Caltech, or any other organization! This is an independently written package by an astrodynamics hobbyist.

Installation

Choose one of the following two lines!

import Pkg; Pkg.add("SPICEApplications");
]add SPICEApplications # in Julia's REPL

Credits

NASA JPL developed and maintains the NAIF SPICE Toolkit, including SPICEApplications. Helge Eichhorn developed and maintains SPICE.jl, as well as the Julia wrappers around the SPICE Toolkit.

License

MIT License

Copyright (c) 2023 Joe Carpinelli

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Exports

Imports

  • Base
  • Core
  • DocStringExtensions
SPICEApplications.brief — Method
brief(
+    file;
+    tabular,
+    single,
+    centers,
+    utc,
+    utcdoy,
+    etsec,
+    sec,
+    min,
+    hour,
+    day,
+    bytime,
+    bycoverage,
+    byid,
+    byname,
+    body,
+    center,
+    at,
+    from,
+    to,
+    listfile,
+    help,
+    version,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

BRIEF is a command-line utility program that displays a contents and time coverage summary for one or more binary SPK or binary PCK files.

Extended Help

Warning

All descriptions below were manually parsed from the commandline program's help/usage output.

ArgumentEquivalentDescription
tabular-tDisplay summary in a tabular format
single-aTreat all files as a single file
centers-cDisplays centers of motion/relative-to frames
utc-utcDisplay times in UTC calendar date format (needs LSK)
utcdoy-utcdoyDisplay times in UTC day-of-year format (needs LSK)
etsec-etsecDisplay times as ET seconds past J2000
sec-secDisplay times "rounded inward" to second
min-minDisplay times "rounded inward" to minute
hour-hourDisplay times "rounded inward" to hour
day-dayDisplay times "rounded inward" to day
bytime-sDisplay summary sorted by start time for each body/frame
bycoverage-gDisplay summary grouped by coverage
byid-nDisplay bodies/frames using numeric id-codes
byname-oDisplay summary ordered by body/frame name
body-sb[bod]Display summary for body [bod]
center-sc[cen]Display summary for center of motion/relative-to frame [cen]
at-at [time]Display summary if coverage contains epoch [time]
from-from [beg]Display summary if coverage contains interval [beg]:[end]
to-to [end]Display summary if coverage contains interval [beg]:[end]
listfile-f [list]Summarize kernels listed in the [list] file
help-hDisplay help
version-vDisplay version
SPICEApplications.chronos — Method
chronos(
+    file;
+    from,
+    fromtype,
+    to,
+    totype,
+    format,
+    time,
+    sc,
+    center,
+    landingtime,
+    sol1index,
+    nolabel,
+    trace,
+    help,
+    usage,
+    template,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

CHRONOS is a command-line program that converts between several time systems and time formats.

Extended Help

Warning

All descriptions below were manually parsed from the commandline program's help/usage output.

ArgumentEquivalentDescription
from-FROM <"from" time system>"from" time system
fromtype-FROMTYPE <"from" time system type>"from" time system type
to-TO <"to" time system>"to" time system
totype-TOTYPE <"to" time system type>"to" time system type
format-FORMAT <output time format picture>output time format picture
time-TIME <input time>intput time
sc-SC <sc ID>sc ID
center-CENTER <cental body ID>cental body ID
landingtime-LANDINGTIME <UTC time of the landing>UTC time of the landing
sol1index-SOL1INDEX <index of the first SOL>index of the first SOL
nolabel-NOLABEL
trace-TRACE
help-HELPdisplay help
usage-USAGEdisplay usage
template-TEMPLATEdisplay setup file template
SPICEApplications.ckbrief — Method
ckbrief(
+    file;
+    dump,
+    boundaries,
+    relframes,
+    idframes,
+    tabular,
+    single,
+    bycoverage,
+    utc,
+    utcdoy,
+    sclk,
+    dpsclk,
+    id,
+    summarize,
+    help,
+    version,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

CKBRIEF is a command-line utility program that displays a contents and time coverage summary for one or more binary CK files.

Extended Help

Warning

All descriptions below were manually parsed from the commandline program's help/usage output.

ArgumentEquivalentDescription
dump-dumpdisplay interpolation intervals boundaries
boundaries-nmdisplay segment boundaries
relframes-reldisplay relative-to frames
idframes-ndisplay frames associated with structure IDs
tabular-tdisplay summary in a tabular format
single-atreat all files as a single file
bycoverage-gdisplay summary grouped by coverage
utc-utcdisplay times in UTC calendar date format
utcdoy-utcdoydisplay times in UTC day-of-year format
sclk-sclkdisplay times as SCLK strings
dpsclk-dpsclkdisplay times as SCLK ticks
id[ID]display summmary for structure with [ID]
summarize-fsummarize kernels listed in the [list] file
help-hdisplay help
version-vdisplay version
SPICEApplications.commnt — Function
commnt(; ...)
+commnt(kernelfile; ...)
+commnt(
+    kernelfile,
+    commentfile;
+    add,
+    extract,
+    read,
+    delete,
+    help,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

COMMNT is a command-line program that reads, adds, extracts, or deletes comments from SPICE binary kernel files.

Extended Help

Warning

All descriptions below were manually parsed from the commandline program's help/usage output.

ArgumentEquivalentDescription
add-aadd comments to binary kernel
extract-eextract comments from a binary kernel
read-rread the comments in a binary kernel
delete-ddelete the comments from the binary kernel
help-hdisplay the help message
SPICEApplications.dskbrief — Method
dskbrief(
+    file;
+    single,
+    gaps,
+    extended,
+    timebounds,
+    bysegment,
+    full,
+    sigdigs,
+    version,
+    help,
+    usage,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

DSKBRIEF is a command-line utility program that displays a summary of the spatial coverage and additional attributes of one or more binary Digital Shape Kernel (DSK) files.

Extended Help

Warning

All descriptions below were manually parsed from the commandline program's help/usage output.

ArgumentEquivalentDescription
single-atreat all DSK files as a single file
gaps-gapsdisplay coverage gaps (aplies only when -a is used)
extended-extdisplay extended summaries: these include data type, data class, and time bounds
timebounds-tgrequire segment time bounds to match when grouping segments
full-fulldisplay a detailed summary for each segment, including data-type-specific parameters
sigdigs-d <n>display n significant digits of floating point values
version-vdisplay the version of the program
help-hdisplay help text
usage-udisplay usage text
SPICEApplications.dskexp — Method
dskexp(
+;
+    dsk,
+    text,
+    format,
+    precision,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

DSKEXP is a command-line program that exports data from DSK files to text files.

Extended Help

Warning

All descriptions below were manually parsed from the commandline program's help/usage output.

ArgumentEquivalentDescription
dsk-dsk <dsk>DSK kernel
text-text <output name>output name
format-format <MKDSK format code/name>MKSDK format code/name
precision-prec <# of vertex mantissa digits (1:17)number of vertex mantissa digits
SPICEApplications.frmdiff — Method
frmdiff(
+;
+    kernels,
+    from1,
+    to1,
+    frame1,
+    supporting_kernels1,
+    from2,
+    to2,
+    frame2,
+    supporting_kernels2,
+    angular,
+    angularframe,
+    start,
+    stop,
+    numpoints,
+    timestep,
+    timeformat,
+    report,
+    rotation,
+    units,
+    sigdigs,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

FRMDIFF is a program that samples orientation of a reference frame known to SPICE or computes differences between orientations of two reference frames known to SPICE, and either displays this orientation or these differences, or shows statistics about it or them.

Extended Help

Warning

All descriptions below were manually parsed from the commandline program's help/usage output.

ArgumentEquivalentDescription
kernels-k <supporting kernel(s) name(s)>supporting kernel(s) name(s)>
from1-f1 <firstfrom'' frame, name or ID>first "from" frame, name or ID
to1-t1 <firstto'' frame, name or ID>first "to" frame, name or ID
frame1-c1 <first frame for coverage look up, name or ID>first frame for coverage look up, name or ID
supporting_kernels1-k1 <additional supporting kernel(s) for first file>additional supporting kernel(s) for first file
from2-f2 <secondfrom'' frame, name or ID>second "from" frame, name or ID
to2-t2 <secondto'' frame, name or ID>second "to" frame, name or ID
frame2-c2 <second frame for coverage look up, name or ID>second frame for coverage look up, name or ID
supporting_kernels2-k2 <additional supporting kernel(s) for second file>additional supporting kernel(s) for second file
angular-a <compare angular velocities: yes│no (default: no)>compare angular velocities
angularframe-m <frame for angular velocities: from│to (default: from)>frame for angular velocities
start-b <interval start time>interval start time
stop-e <interval stop time>interval stop time
numpoints-n <number of points: 1 to 1000000 (default: 1000)>number of points
timestep-s <time step in seconds>time step in seconds
timeformat-f <time format: et│sclk│sclkd│ticks│picture_for_TIMOUT (default: et)>time format
report-t <report: basic│stats│dumpaa│dumpm│dumpqs│dumpqo│dumpea│dumpc│dumpg>report
rotation-o <rotation axes order (default: z y x)>rotation axes order
units-x <units for output angles> (only for -t dumpaa and -t dumpea)units for output angles
sigdigs-d <number of significant digits: 6 to 17 (default: 14)>number of significant digits
SPICEApplications.inspekt — Method
inspekt(; stdout, stderr, stdin, append, wait)
+

INSPEKT is an interactive program that examines the contents of an events component (ESQ) of an E-kernel.

SPICEApplications.mkdsk — Method
mkdsk(
+;
+    setup,
+    input,
+    output,
+    help,
+    template,
+    usage,
+    version,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

MKDSK is a utility program that creates a SPICE Digital Shape Kernel (DSK) file from a text file containing shape data for an extended object.

Extended Help

Warning

All descriptions below were manually parsed from the commandline program's help/usage output.

ArgumentEquivalentDescription
setup-setup <setup file name>setup file name
input-input <input shape data file name>input shape data file name
output-output <output DSK file name>output DSK file name
help-h│-helpdisplay help
template-t│-templatedisplay template
usage-u│-usagedisplay usage
version-v│-versiondisplay version
SPICEApplications.mkspk — Method
mkspk(
+;
+    setup,
+    input,
+    output,
+    add,
+    usage,
+    help,
+    template,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

MKSPK is a program that creates an SPK file from a text file containing trajectory information.

Extended Help

Warning

All descriptions below were manually parsed from the commandline program's help/usage output.

ArgumentEquivalentDescription
setup-setup <setup file name>setup file name
input-input <input shape data file name>input shape data file name
output-output <output DSK file name>output DSK file name
add-appendappend; output file must be new
help-h│-helpdisplay help
template-t│-templatedisplay template
usage-u│-usagedisplay usage
SPICEApplications.msopck — Method
msopck(
+;
+    setup,
+    input,
+    output,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

MSOPCK is a command-line program that converts attitude data provided in a text file as UTC, SCLK, or ET-tagged quaternions, Euler angles, or matrices, optionally accompanied by angular velocities, into a type 1, 2, or 3 SPICE C-kernel.

SPICEApplications.spacit — Method
spacit(; stdout, stderr, stdin, append, wait)
+

SPACIT is an interactive program that converts kernels in transfer format to binary format, converts binary kernels to transfer format, and summarizes the contents of binary kernels.

SPICEApplications.spkdiff — Method
spkdiff(
+;
+    kernels,
+    body1,
+    center1,
+    frame1,
+    supporting_kernels1,
+    body2,
+    center2,
+    frame2,
+    supporting_kernels2,
+    start,
+    stop,
+    timestep,
+    numstates,
+    timeformat,
+    sigdigs,
+    report,
+    stdout,
+    stderr,
+    stdin,
+    append,
+    wait
+)
+

SPKDIFF provides means for comparing the trajectories of two bodies or sampling the trajectory of a single body using data from SPICE kernels.

Extended Help

Warning

All descriptions below were manually parsed from the commandline program's help/usage output.

ArgumentEquivalentDescription
kernels-k <supporting kernel(s) name(s)>-k <supporting kernel(s) name(s)>
body1-b1 <first body name or ID>-b1 <first body name or ID>
center1-c1 <first center name or ID>-c1 <first center name or ID>
frame1-r1 <first reference frame name>-r1 <first reference frame name>
supporting_kernels1-k1 <additional supporting kernel(s) for first SPK>-k1 <additional supporting kernel(s) for first SPK>
body2-b2 <second body name or ID>-b2 <second body name or ID>
center2-c2 <second center name or ID>-c2 <second center name or ID>
frame2-r2 <second reference frame name>-r2 <second reference frame name>
supporting_kernels2-k2 <additional supporting kernel(s) for second SPK>-k2 <additional supporting kernel(s) for second SPK>
start-b <interval start time>-b <interval start time>
stop-e <interval stop time>-e <interval stop time>
timestep-s <time step in seconds>-s <time step in seconds>
numstates-n <number of states: 2 to 1000000 (default: 1000)>-n <number of states: 2 to 1000000 (default: 1000)>
timeformat-f <output time format (default: TDB seconds past J2000)>-f <output time format (default: TDB seconds past J2000)>
`sigdigs1-d <number of significant digits: 6 to 17 (default: 14)>-d <number of significant digits: 6 to 17 (default: 14)>
report-t <report type: basic│stats│dump│dumpvf│dumpc│dumpg (def.: basic│dump)>-t <report type: basic│stats│dump│dumpvf│dumpc│dumpg (def.: basic│dump)>
SPICEApplications.spkmerge — Function
spkmerge(; ...)
+spkmerge(commandfile; stdout, stderr, stdin, append, wait)
+

SPKMERGE is a program that subsets or merges one or more SPK files into a single SPK file.

SPICEApplications.tobin — Function
tobin(; ...)
+tobin(kernelfile; stdout, stderr, stdin, append, wait)
+

TOBIN is a command-line program that converts transfer format SPK, CK, PCK, DSK and EK files to binary format.

SPICEApplications.toxfr — Function
toxfr(; ...)
+toxfr(kernelfile; stdout, stderr, stdin, append, wait)
+

TOXFR is a command-line program that converts binary format SPK, CK, PCK, DSK and EK files to transfer format.

diff --git a/dev/index.html b/dev/index.html index 2270947..ff5f002 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,5 +1,5 @@ -Home · SPICE.jl
Edit on GitHub

SPICE.jl

SPICE.jl is a Julia wrapper for the SPICE toolkit which is provided by NASA's Navigation and Ancillary Information Facility (NAIF). It provides functionality to read SPICE data files and compute derived observation geometry such as altitude, latitude/longitude and lighting angles. Please refer to its comprehensive documentation if you are not yet familiar with SPICE.

Note: This project is not affiliated with NASA, NAIF or JPL in any way.

Installation

julia> import Pkg; Pkg.add("SPICE")

Quickstart

using SPICE
+Home · SPICE.jl
Edit on GitHub
SPICE.jl
SPICE.jl is a Julia wrapper for the SPICE toolkit which is provided by NASA's Navigation and Ancillary Information Facility (NAIF). It provides functionality to read SPICE data files and compute derived observation geometry such as altitude, latitude/longitude and lighting angles. Please refer to its comprehensive documentation if you are not yet familiar with SPICE.
Note: This project is not affiliated with NASA, NAIF or JPL in any way.
Installation
julia> import Pkg; Pkg.add("SPICE")
Quickstart
using SPICE
 using Downloads: download
 
 const LSK = "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/lsk/naif0012.tls"
@@ -19,4 +19,4 @@
 furnsh("de440.bsp")
 
 # Get the position of Mars at `et` w.r.t. Earth
-spkpos("mars_barycenter", et, "J2000", "none", "earth")
Notable differences to CSPICE
SPICE.jl follows the Julia language's style and conventions which introduces the following differences to CSPICE.
  • SPICE.jl does not wrap all CSPICE functions since many general purpose utilities already exist in Julia's standard library or can be approximated with a Julia one-liner.  If you try to call an unwrapped function, SPICE.jl will return a deprecation warning that shows the equivalent Julia code.
  • Functions that mutate one of their input arguments are suffixed with ! and the to-be-mutated argument will be the first parameter, e.g. wninsd!(window, left, right) instead of wninsd(left, right, window).
Next Steps
Please refer to the API reference.

+spkpos("mars_barycenter", et, "J2000", "none", "earth")

Notable differences to CSPICE

SPICE.jl follows the Julia language's style and conventions which introduces the following differences to CSPICE.

  • SPICE.jl does not wrap all CSPICE functions since many general purpose utilities already exist in Julia's standard library or can be approximated with a Julia one-liner. If you try to call an unwrapped function, SPICE.jl will return a deprecation warning that shows the equivalent Julia code.
  • Functions that mutate one of their input arguments are suffixed with ! and the to-be-mutated argument will be the first parameter, e.g. wninsd!(window, left, right) instead of wninsd(left, right, window).

Next Steps

Please refer to the API reference.

diff --git a/dev/search/index.html b/dev/search/index.html index 29b1363..37ee88a 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · SPICE.jl

Loading search...

    +Search · SPICE.jl

    Loading search...

      diff --git a/dev/search_index.js b/dev/search_index.js index 97586e5..f164cb9 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"api/#API","page":"API","title":"API","text":"","category":"section"},{"location":"api/","page":"API","title":"API","text":"DocTestSetup = quote\n using SPICE\nend","category":"page"},{"location":"api/","page":"API","title":"API","text":"Modules = [SPICE]\nPrivate = false","category":"page"},{"location":"api/#SPICE.SpiceCharCell","page":"API","title":"SPICE.SpiceCharCell","text":"SpiceCharCell(size, length)\n\nCreate a SpiceCharCell that can contain up to size strings with length characters.\n\n\n\n\n\n","category":"type"},{"location":"api/#SPICE.SpiceDoubleCell","page":"API","title":"SPICE.SpiceDoubleCell","text":"SpiceDoubleCell(size)\n\nCreate a SpiceDoubleCell that can contain up to size elements.\n\n\n\n\n\n","category":"type"},{"location":"api/#SPICE.SpiceIntCell","page":"API","title":"SPICE.SpiceIntCell","text":"SpiceIntCell(size)\n\nCreate a SpiceIntCell that can contain up to size elements.\n\n\n\n\n\n","category":"type"},{"location":"api/#Base.append!-Tuple{SPICE.SpiceCell, Any}","page":"API","title":"Base.append!","text":"append!(cell, collection)\n\nAppend all items from collection to the char/double/integer SpiceCell cell.\n\n\n\n\n\n","category":"method"},{"location":"api/#Base.copy-Union{Tuple{SPICE.SpiceCell{T}}, Tuple{T}} where T","page":"API","title":"Base.copy","text":"copy(cell::SpiceCell)\n\nDuplicate the SpiceCell cell.\n\n\n\n\n\n","category":"method"},{"location":"api/#Base.diff-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, SPICE.SpiceCell{T}}} where T","page":"API","title":"Base.diff","text":"diff(a::T, b::T) where T <: SpiceCell\n\nCompute the difference of two sets of any data type to form a third set.\n\nArguments\n\na: First input set\nb: Second input set\n\nOutput\n\nReturns a cell containing the difference of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#Base.length-Tuple{SPICE.SpiceCell}","page":"API","title":"Base.length","text":"length(cell)\n\nReturns the cardinality (number of elements) of cell.\n\n\n\n\n\n","category":"method"},{"location":"api/#Base.push!-Tuple{SPICE.SpiceCell, Vararg{Any}}","page":"API","title":"Base.push!","text":"push!(cell, items...)\n\nInsert one or more items at the end of the char/double/integer SpiceCell cell.\n\n\n\n\n\n","category":"method"},{"location":"api/#Base.union-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, SPICE.SpiceCell{T}}} where T","page":"API","title":"Base.union","text":"union(a::T, b::T) where T <: SpiceCell\n\nCompute the union of two sets of any data type to form a third set.\n\nArguments\n\na: First input set\nb: Second input set\n\nOutput\n\nReturns a cell containing the union of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.appnd-Tuple{Any, SpiceCharCell}","page":"API","title":"SPICE.appnd","text":"appnd(item, cell)\n\nAppend an item to the char/double/integer SpiceCell cell.\n\nReferences\n\nappndc - NAIF Documentation\nappndd - NAIF Documentation\nappndi - NAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.axisar-Tuple{Any, Any}","page":"API","title":"SPICE.axisar","text":"axisar(axis, angle)\n\nConstruct a rotation matrix that rotates vectors by a specified angle about a specified axis.\n\nArguments\n\naxis: Rotation axis\nangle: Rotation angle in radians\n\nOutput\n\nRotation matrix corresponding to axis and angle\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.b1900-Tuple{}","page":"API","title":"SPICE.b1900","text":"b1900()\n\nReturns the Julian Date corresponding to Besselian date 1900.0.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.b1950-Tuple{}","page":"API","title":"SPICE.b1950","text":"b1950()\n\nReturns the Julian Date corresponding to Besselian date 1950.0.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.badkpv-NTuple{6, Any}","page":"API","title":"SPICE.badkpv","text":"badkpv(caller, name, comp, size, divby, typ)\n\nDetermine if a kernel pool variable is present and if so that it has the correct size and type.\n\nArguments\n\ncaller: Name of the routine calling this routine\nname: Name of a kernel pool variable\ncomp: Comparison operator\nsize: Expected size of the kernel pool variable\ndivby: A divisor of the size of the kernel pool variable\ntype: Expected type of the kernel pool variable\n\nOutput\n\nThe function returns false if the kernel pool variable is OK otherwise an exception is thrown.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bltfrm-Tuple{Any}","page":"API","title":"SPICE.bltfrm","text":"bltfrm(frmcls)\n\nReturn a SPICE set containing the frame IDs of all built-in frames of a specified class.\n\nArguments\n\nfrmcls: Frame class\n\nOutput\n\nidset: Set of ID codes of frames of the specified class\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bodc2n-Tuple{Any}","page":"API","title":"SPICE.bodc2n","text":"bodc2n(code)\n\nTranslate the SPICE integer code of a body into a common name for that body.\n\nArguments\n\ncode: Integer ID code to be translated into a name\n\nOutput\n\nA common name for the body identified by code or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bodc2s-Tuple{Any}","page":"API","title":"SPICE.bodc2s","text":"bodc2s(code)\n\nTranslate a body ID code to either the corresponding name or if no name to ID code mapping exists, the string representation of the body ID value.\n\nArguments\n\ncode: Integer ID code to translate to a string\n\nOutput\n\nReturns a string corresponding to code\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.boddef-Tuple{Any, Any}","page":"API","title":"SPICE.boddef","text":"boddef(name, code)\n\nDefine a body name/ID code pair for later translation via bodn2c or bodc2n.\n\nArguments\n\nname: Common name of some body\ncode: Integer code for that body\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bodfnd-Tuple{Any, Any}","page":"API","title":"SPICE.bodfnd","text":"bodfnd(body, item)\n\nDetermine whether values exist for some item for any body in the kernel pool.\n\nArguments\n\nbody: ID code of body\nitem: Item to find (\"RADII\", \"NUTAMPRA\", etc.)\n\nOutput\n\nReturns true if the item is in the kernel pool and false if it is not.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bodn2c-Tuple{Any}","page":"API","title":"SPICE.bodn2c","text":"bodn2c(name)\n\nTranslate the name of a body or object to the corresponding SPICE integer ID code.\n\nArguments\n\nname: Body name to be translated into a SPICE ID code\n\nOutput\n\nReturn the SPICE integer ID code for the named body or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bods2c-Tuple{Any}","page":"API","title":"SPICE.bods2c","text":"bods2c(name)\n\nTranslate a string containing a body name or ID code to an integer code.\n\nArguments\n\nname: String to be translated to an ID code\n\nOutput\n\nRetunrs the integer ID code corresponding to name or nothing if none as found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bodvcd","page":"API","title":"SPICE.bodvcd","text":"bodvcd(bodyid, item)\n\nFetch from the kernel pool the double precision values of an item associated with a body, where the body is specified by an integer ID code.\n\nArguments\n\nbodyid: Body ID code\nitem: Item for which values are desired. (\"RADII\", \"NUT_PREC_ANGLES\", etc.)\nmaxn: Maximum number of values that may be returned (default: 100)\n\nOutput\n\nReturns the requested values.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bodvrd","page":"API","title":"SPICE.bodvrd","text":"bodvrd(bodynm, item)\n\nFetch from the kernel pool the double precision values of an item associated with a body.\n\nArguments\n\nbodynm: Body name\nitem: Item for which values are desired. (\"RADII\", \"NUT_PREC_ANGLES\", etc.)\nmaxn: Maximum number of values that may be returned (default: 100)\n\nOutput\n\nvalues: Values\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.brcktd","page":"API","title":"SPICE.brcktd","text":"brcktd(number, e1, e2)\n\nwarning: Deprecated\nUse clamp from Julia's standard library instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.brckti","page":"API","title":"SPICE.brckti","text":"brckti(number, e1, e2)\n\nwarning: Deprecated\nUse clamp from Julia's standard library instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bschoc","page":"API","title":"SPICE.bschoc","text":"bschoc(value, array, order)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bschoi","page":"API","title":"SPICE.bschoi","text":"bschoi(value, array, order)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bsrchc","page":"API","title":"SPICE.bsrchc","text":"bsrchc(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bsrchd","page":"API","title":"SPICE.bsrchd","text":"bsrchd(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bsrchi","page":"API","title":"SPICE.bsrchi","text":"bsrchi(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.card-Tuple{SPICE.SpiceCell}","page":"API","title":"SPICE.card","text":"card(cell)\n\nReturns the cardinality (number of elements) of cell.\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ccifrm-Tuple{Any, Any}","page":"API","title":"SPICE.ccifrm","text":"ccifrm(frclss, clssid)\n\nReturn the frame name, frame ID, and center associated with a given frame class and class ID.\n\nArguments\n\nfrclss: Class of frame\nclssid: Class ID of frame\n\nOutput\n\nReturns nothing if no frame was found or\n\nfrcode: ID code of the frame\nfrname: Name of the frame\ncenter: ID code of the center of the frame\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cgv2el-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cgv2el","text":"cgv2el(center, vec1, vec2)\n\nForm an ellipse from a center vector and two generating vectors.\n\nArguments\n\ncenter: Center vector\nvec1: Generating vector\nvec2: Generating vector\n\nOutput\n\nReturns the ellipse defined by the input vectors.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.chbder-NTuple{4, Any}","page":"API","title":"SPICE.chbder","text":"chbder(cp, x2s, x, nderiv)\n\nGiven the coefficients for the Chebyshev expansion of a polynomial, this returns the value of the polynomial and its first nderiv derivatives evaluated at the input x.\n\nArguments\n\ncp: Chebyshev polynomial coefficients\nx2s: Transformation parameters of polynomial\nx: Value for which the polynomial is to be evaluated\nnderiv: The number of derivatives to compute\n\nOutput\n\nReturns the derivatives of the polynomial.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cidfrm-Tuple{Any}","page":"API","title":"SPICE.cidfrm","text":"cidfrm(cent)\n\nRetrieve frame ID code and name to associate with a frame center.\n\nArguments\n\ncent: ID code for an object for which there is a preferred reference frame\n\nOutput\n\nReturns nothing if no frame was found or\n\nfrcode: The ID code of the frame associated with cent\nfrname: The name of the frame with ID frcode\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckcls-Tuple{Any}","page":"API","title":"SPICE.ckcls","text":"ckcls(handle)\n\nClose an open CK file.\n\nArguments\n\nhandle: Handle of the CK file to be closed\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckcov!-NTuple{7, Any}","page":"API","title":"SPICE.ckcov!","text":"ckcov!(ck, idcode, needav, level, tol, timsys, cover)\n\nFind the coverage window for a specified object in a specified CK file.\n\nArguments\n\nck: Name of CK file\nidcode: ID code of object\nneedav: Flag indicating whether angular velocity is needed\nlevel: Coverage level: \"SEGMENT\" OR \"INTERVAL\"\ntol: Tolerance in ticks\ntimsys: Time system used to represent coverage\ncover: Window giving coverage for idcode. Data already present in cover will be combined with coverage found for the object designated by idcode in the file ck.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckcov-NTuple{6, Any}","page":"API","title":"SPICE.ckcov","text":"ckcov(ck, idcode, needav, level, tol, timsys)\n\nFind the coverage window for a specified object in a specified CK file.\n\nArguments\n\nck: Name of CK file\nidcode: ID code of object\nneedav: Flag indicating whether angular velocity is needed\nlevel: Coverage level: \"SEGMENT\" OR \"INTERVAL\"\ntol: Tolerance in ticks\ntimsys: Time system used to represent coverage\n\nOutput\n\nWindow giving coverage for idcode\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckgp-NTuple{4, Any}","page":"API","title":"SPICE.ckgp","text":"ckgp(inst, sclkdp, tol, ref)\n\nGet pointing (attitude) for a specified spacecraft clock time.\n\nArguments\n\ninst: NAIF ID of instrument, spacecraft, or structure\nsclkdp: Encoded spacecraft clock time\ntol: Time tolerance\nref: Reference frame\n\nOutputs\n\nReturns nothing if the requested pointing is not available or\n\ncmat: C-matrix pointing data\nclkout: Output encoded spacecraft clock time\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckgpav-NTuple{4, Any}","page":"API","title":"SPICE.ckgpav","text":"ckgpav(inst, sclkdp, tol, ref)\n\nGet pointing (attitude) and angular velocity for a specified spacecraft clock time.\n\nArguments\n\ninst: NAIF ID of instrument, spacecraft, or structure\nsclkdp: Encoded spacecraft clock time\ntol: Time tolerance\nref: Reference frame\n\nOutputs\n\nReturns nothing if the requested pointing is not available or\n\ncmat: C-matrix pointing data\nav: Angular velocity vector\nclkout: Output encoded spacecraft clock time\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cklpf-Tuple{Any}","page":"API","title":"SPICE.cklpf","text":"cklpf(filename)\n\nLoad a CK pointing file for use by the CK readers. Return that file's handle, to be used by other CK routines to refer to the file.\n\nArguments\n\nfilename: Name of the CK file to be loaded\n\nOutput\n\nLoaded file's handle\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckobj!-Tuple{Any, Any}","page":"API","title":"SPICE.ckobj!","text":"ckobj!(ck, ids)\n\nFind the set of ID codes of all objects in a specified CK file.\n\nArguments\n\nck: Name of CK file\nids: Set of ID codes of objects in CK file. Data already present in ids will be combined with ID code set found for the file ck.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckobj-Tuple{Any}","page":"API","title":"SPICE.ckobj","text":"ckobj(ck)\n\nFind the set of ID codes of all objects in a specified CK file.\n\nArguments\n\nck: Name of CK file\n\nOutput\n\nSet of ID codes of objects in CK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckopn","page":"API","title":"SPICE.ckopn","text":"ckopn(fname, ifname=\"CK_file\", ncomch=0)\n\nOpen a new CK file, returning the handle of the opened file.\n\nArguments\n\nfname: The name of the CK file to be opened\nifname: The internal filename for the CK (default: \"CK_file\")\nncomch: The number of characters to reserve for comments (default: 0)\n\nOutput\n\nhandle: The handle of the opened CK file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ckupf-Tuple{Any}","page":"API","title":"SPICE.ckupf","text":"ckupf(handle)\n\nUnload a CK pointing file so that it will no longer be searched by the readers.\n\nArguments\n\nhandle: Handle of CK file to be unloaded\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckw01","page":"API","title":"SPICE.ckw01","text":"ckw01(handle, begtim, endtim, inst, ref, segid, sclkdp, quats, avvs=[zeros(3)])\n\nAdd a type 1 segment to a C-kernel.\n\nArguments\n\nhandle: Handle of an open CK file\nbegtim: The beginning encoded SCLK of the segment\nendtim: The ending encoded SCLK of the segment\ninst: The NAIF instrument ID code\nref: The reference frame of the segment\nsegid: Segment identifier\nsclkdp: Encoded SCLK times\nquats: Quaternions representing instrument pointing\navvs: Angular velocity vectors (optional)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ckw02-NTuple{11, Any}","page":"API","title":"SPICE.ckw02","text":"ckw02(handle, begtim, endtim, inst, ref, segid, start, stop, quats, avvs, rates)\n\nWrite a type 2 segment to a C-kernel.\n\nArguments\n\nhandle: Handle of an open CK file\nbegtim: The beginning encoded SCLK of the segment\nendtim: The ending encoded SCLK of the segment\ninst: The NAIF instrument ID code\nref: The reference frame of the segment\nsegid: Segment identifier\nstart: Encoded SCLK interval start times\nstop: Encoded SCLK interval stop times\nquats: Quaternions representing instrument pointing\navvs: Angular velocity vectors\nrates: Number of seconds per tick for each interval\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckw03","page":"API","title":"SPICE.ckw03","text":"ckw03(handle, begtim, endtim, inst, ref, segid, sclkdp, quats, starts, avvs=[zeros(3)])\n\nAdd a type 3 segment to a C-kernel.\n\nArguments\n\nhandle: Handle of an open CK file\nbegtim: The beginning encoded SCLK of the segment\nendtim: The ending encoded SCLK of the segment\ninst: The NAIF instrument ID code\nref: The reference frame of the segment\nsegid: Segment identifier\nsclkdp: Encoded SCLK times\nquats: Quaternions representing instrument pointing\nstarts: Encoded SCLK interval start times\navvs: Angular velocity vectors (optional)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ckw05-NTuple{14, Any}","page":"API","title":"SPICE.ckw05","text":"ckw05(handle, subtyp, degree, begtim, endtim, inst, ref, avflag, segid, sclkdp, packts,\n rate, nints, starts)\n\nWrite a type 5 segment to a CK file.\n\nArguments\n\nhandle: Handle of an open CK file\nsubtyp: CK type 5 subtype code\ndegree: Degree of interpolating polynomials\nbegtim: The beginning encoded SCLK of the segment\nendtim: The ending encoded SCLK of the segment\ninst: The NAIF instrument ID code\nref: The reference frame of the segment\navflag: True if the segment will contain angular velocity\nsegid: Segment identifier\nsclkdp: Encoded SCLK times\npackts: Array of packets\nrate: Nominal SCLK rate in seconds per tick\nnints: Number of intervals\nstarts: Encoded SCLK interval start times\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cleard","page":"API","title":"SPICE.cleard","text":"cleard(array)\n\nwarning: Deprecated\nUse empty!(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.clight-Tuple{}","page":"API","title":"SPICE.clight","text":"clight()\n\nReturns the speed of light in vacuo (km/sec).\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.clpool-Tuple{}","page":"API","title":"SPICE.clpool","text":"clpool()\n\nRemove all variables from the kernel pool. Watches on kernel variables are retained.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cmprss-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cmprss","text":"cmprss(delim, n, input)\n\nCompress a character string by removing occurrences of more than n consecutive occurrences of a specified character.\n\nArguments\n\ndelim: Delimiter to be compressed\nn: Maximum consecutive occurrences of delim\ninput: Input string\n\nOutput\n\nReturns the compressed string.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cnmfrm","page":"API","title":"SPICE.cnmfrm","text":"cnmfrm(cname)\n\nRetrieve frame ID code and name to associate with an object.\n\nArguments\n\ncname: Name of the object to find a frame for\n\nOutput\n\nReturns a tuple of the ID code and the name of the frame associated with cname or nothing if no frame is found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.conics-Tuple{Any, Any}","page":"API","title":"SPICE.conics","text":"conics(elts, et)\n\nDetermine the state (position, velocity) of an orbiting body from a set of elliptic, hyperbolic, or parabolic orbital elements.\n\nArguments\n\nelts: Conic elements\net: Input time\n\nOutput\n\nReturns the state of orbiting body at et.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.convrt-Tuple{Any, Any, Any}","page":"API","title":"SPICE.convrt","text":"convrt(x, in, out)\n\nTake a measurement x, the units associated with x, and units to which x should be converted; return y - the value of the measurement in the output units.\n\nArguments\n\nx: Number representing a measurement in some units\nin: The units in which x is measured\nout: Desired units for the measurement\n\nOutput\n\nReturns the measurement in the desired units.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cpos-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cpos","text":"cpos(str, chars, start)\n\nFind the first occurrence in a string of a character belonging to a collection of characters, starting at a specified location, searching forward.\n\nArguments\n\nstr: Any character string\nchars: A collection of characters\nstart: Position to begin looking for one of chars\n\nOutput\n\nReturns the index of the first character of str that is one of the characters in string chars. Returns -1 if none of the characters was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cposr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cposr","text":"cposr(str, chars, start)\n\nFind the first occurrence in a string of a character belonging to a collection of characters, starting at a specified location, searching in reverse.\n\nArguments\n\nstr: Any character string\nchars: A collection of characters\nstart: Position to begin looking for one of chars\n\nOutput\n\nReturns the index of the last character of str that is one of the characters in string chars. Returns -1 if none of the characters was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cvpool-Tuple{Any}","page":"API","title":"SPICE.cvpool","text":"cvpool(agent)\n\nIndicate whether or not any watched kernel variables that have a specified agent on their notification list have been updated.\n\nArguments\n\nagent: Name of the agent to check for notices\n\nOutput\n\nReturns true if variables for agent have been updated.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cyllat-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cyllat","text":"cyllat(r, lonc, z)\n\nConvert from cylindrical to latitudinal coordinates.\n\nArguments\n\nr: Distance of point from z axis\nlonc: Cylindrical angle of point from XZ plane (radians)\nz: Height of point above XY plane\n\nOutput\n\nradius: Radius\nlon: Longitude (radians)\nlat: Latitude (radians)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cylrec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cylrec","text":"cylrec(r, lon, z)\n\nConvert from cylindrical to rectangular coordinates.\n\nArguments\n\nr: Distance of the point of interest from z axis\nlon: Cylindrical angle (in radians) of the point of interest from XZ plane\nz: Height of the point above XY plane\n\nOutput\n\nReturns rectangular coordinates of the point of interest.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cylsph-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cylsph","text":"cylsph(r, lonc, z)\n\nConvert from cylindrical to spherical coordinates.\n\nArguments\n\nr: Distance of point from z axis\nlonc: Angle (radians) of point from XZ plane\nz: Height of point above XY plane\n\nOutput\n\nradius: Distance of the point from the origin\ncolat: Polar angle (co-latitude in radians)\nlon: Azimuthal angle (longitude)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafac-Tuple{Any, Any}","page":"API","title":"SPICE.dafac","text":"dafac(handle, buffer)\n\nAdd comments from a buffer of character strings to the comment area of a binary DAF file, appending them to any comments which are already present in the file's comment area.\n\nArguments\n\nhandle: Handle of a DAF opened with write access\nbuffer: Buffer of comments to put into the comment area\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafbbs-Tuple{Any}","page":"API","title":"SPICE.dafbbs","text":"dafbbs(handle)\n\nBegin a backward search for arrays in a DAF.\n\nArguments\n\nhandle: Handle of DAF to be searched\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafbfs-Tuple{Any}","page":"API","title":"SPICE.dafbfs","text":"dafbfs(handle)\n\nBegin a forward search for arrays in a DAF.\n\nArguments\n\nhandle: Handle of DAF to be searched\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafcls-Tuple{Any}","page":"API","title":"SPICE.dafcls","text":"dafcls(handle)\n\nClose the DAF associated with a given handle.\n\nArguments\n\nhandle: Handle of DAF to be closed\n\nOutput\n\nReturns the handle of the closed file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafcs-Tuple{Any}","page":"API","title":"SPICE.dafcs","text":"dafcs(handle)\n\nSelect a DAF that already has a search in progress as the one to continue searching.\n\nArguments\n\nhandle: Handle of DAF to continue searching\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafdc-Tuple{Any}","page":"API","title":"SPICE.dafdc","text":"dafdc(handle)\n\nDelete the entire comment area of a specified DAF file.\n\nArguments\n\nhandle: The handle of a binary DAF opened for writing\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafec-Tuple{Any}","page":"API","title":"SPICE.dafec","text":"dafec(handle; bufsiz=256, lenout=1024)\n\nExtract comments from the comment area of a binary DAF.\n\nArguments\n\nhandle: Handle of binary DAF opened with read access\nbufsiz: Maximum size, in lines, of buffer (default: 256)\nlenout: Length of strings in output buffer (default: 1024)\n\nOutput\n\nReturns a buffer where extracted comment lines are placed.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.daffna-Tuple{}","page":"API","title":"SPICE.daffna","text":"daffna()\n\nFind the next (forward) array in the current DAF.\n\nOutput\n\nReturns true if an array was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.daffpa-Tuple{}","page":"API","title":"SPICE.daffpa","text":"daffpa()\n\nFind the previous (backward) array in the current DAF.\n\nOutput\n\nReturns true if an array was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafgda-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dafgda","text":"dafgda(handle, start, stop)\n\nRead the double precision data bounded by two addresses within a DAF.\n\nArguments\n\nhandle: Handle of a DAF\nstart, stop: Initial, final address within file\n\nOutput\n\nReturns the data contained between start and stop.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafgh-Tuple{}","page":"API","title":"SPICE.dafgh","text":"dafgh()\n\nReturn (get) the handle of the DAF currently being searched.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafgn","page":"API","title":"SPICE.dafgn","text":"dafgn(lenout=128)\n\nReturn (get) the name for the current array in the current DAF.\n\nArguments\n\nlenout: Length of array name string (default: 128)\n\nOutput\n\nReturns the name of the current array.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dafgs","page":"API","title":"SPICE.dafgs","text":"dafgs(lenout=128)\n\nReturn (get) the summary for the current array in the current DAF.\n\nArguments\n\nlenout: The maximum length of the summary array\n\nOutput\n\nReturns the summary for the current array.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dafgsr-NTuple{4, Any}","page":"API","title":"SPICE.dafgsr","text":"Read a portion of the contents of a summary record in a DAF file.\n\nArguments\n\nhandle: Handle of DAF\nrecno: Record number\nstart: First word to read from record\nstop: Last word to read from record\n\nOutput\n\nReturns the contents of the record or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafopr-Tuple{Any}","page":"API","title":"SPICE.dafopr","text":"dafopr(fname)\n\nOpen a DAF for subsequent read requests.\n\nArguments\n\nfname: Name of DAF to be opened\n\nOutput\n\nReturns the handle assigned to DAF.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafopw-Tuple{Any}","page":"API","title":"SPICE.dafopw","text":"dafopw(fname)\n\nOpen a DAF for subsequent write requests.\n\nArguments\n\nfname: Name of DAF to be opened\n\nOutput\n\nReturns the handle assigned to DAF.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafps-Tuple{Any, Any}","page":"API","title":"SPICE.dafps","text":"dafps(dc, ic)\n\nPack (assemble) an array summary from its double precision and integer components.\n\nArguments\n\ndc: Double precision components\nic: Integer components\n\nOutput\n\nReturns the array summary.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafrfr","page":"API","title":"SPICE.dafrfr","text":"dafrfr(handle, lenout=128)\n\nRead the contents of the file record of a DAF.\n\nArguments\n\nhandle: Handle of an open DAF file\nlenout: Available room in the output string `ifname' (default: 128)\n\nOutput\n\nnd: Number of double precision components in summaries\nni: Number of integer components in summaries\nifname: Internal file name\nfward: Forward list pointer\nbward: Backward list pointer\nfree: Free address pointer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dafrs-Tuple{Any}","page":"API","title":"SPICE.dafrs","text":"dafrs(sum)\n\nChange the summary for the current array in the current DAF.\n\nArguments\n\nsum: New summary for current array\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafus-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dafus","text":"dafus(sum, nd, ni)\n\nUnpack an array summary into its double precision and integer components.\n\nArguments\n\nsum: Array summary\nnd: Number of double precision components\nni: Number of integer components\n\nOutput\n\ndc: Double precision components\nic: Integer components\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dasac-Tuple{Any, Any}","page":"API","title":"SPICE.dasac","text":"dasac(handle, buffer)\n\nAdd comments from a buffer of character strings to the comment area of a binary DAS file, appending them to any comments which are already present in the file's comment area.\n\nArguments\n\nhandle: Handle of a DAS opened with write access\nbuffer: Buffer of comments to put into the comment area\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dascls-Tuple{Any}","page":"API","title":"SPICE.dascls","text":"dascls(handle)\n\nClose the DAS associated with a given handle.\n\nArguments\n\nhandle: Handle of DAS to be closed\n\nOutput\n\nReturns the handle of the closed file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dasdc-Tuple{Any}","page":"API","title":"SPICE.dasdc","text":"dasdc(handle)\n\nDelete the entire comment area of a specified DAS file.\n\nArguments\n\nhandle: The handle of a binary DAS opened for writing\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dasec-Tuple{Any}","page":"API","title":"SPICE.dasec","text":"dasec(handle; bufsiz=256, lenout=1024)\n\nExtract comments from the comment area of a binary DAS.\n\nArguments\n\nhandle: Handle of binary DAS opened with read access\nbufsiz: Maximum size, in lines, of buffer (default: 256)\nlenout: Length of strings in output buffer (default: 1024)\n\nOutput\n\nReturns a buffer where extracted comment lines are placed.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dashfn","page":"API","title":"SPICE.dashfn","text":"dashfn(handle, namelen=256)\n\nReturn the name of the DAS file associated with a handle.\n\nArguments\n\nhandle: Handle of a DAS file\nnamlen: Length of output file name string (default: 256)\n\nOutput\n\nReturns the corresponding file name.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dasopr-Tuple{Any}","page":"API","title":"SPICE.dasopr","text":"dasopr(fname)\n\nOpen a DAS for subsequent read requests.\n\nArguments\n\nfname: Name of DAS to be opened\n\nOutput\n\nReturns the handle assigned to DAS.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dasopw-Tuple{Any}","page":"API","title":"SPICE.dasopw","text":"dasopw(fname)\n\nOpen a DAS for subsequent write requests.\n\nArguments\n\nfname: Name of DAS to be opened\n\nOutput\n\nReturns the handle assigned to DAS.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dasrfr","page":"API","title":"SPICE.dasrfr","text":"dasrfr(handle, idwlen=128, ifnlen=256)\n\nRead the contents of the file record of a DAS.\n\nArguments\n\nhandle: DAS file handle\nidwlen: Length of ID word string (default: 128)\nifnlen: Length of internal file name string (default: 256)\n\nOutput\n\nidword: ID word\nifname: DAS internal file name\nnresvr: Number of reserved records in file\nnresvc: Number of characters in use in reserved records area\nncomr: Number of comment records in file\nncomc: Number of characters in use in comment area\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dcyldr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dcyldr","text":"dcyldr(x, y, z)\n\nCompute the Jacobian of the transformation from rectangular to cylindrical coordinates.\n\nArguments\n\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.deltet-Tuple{Any, Any}","page":"API","title":"SPICE.deltet","text":"deltet(epoch, eptype)\n\nReturn the value of ΔET (ET-UTC) for an input epoch.\n\nArguments\n\nepoch: Input epoch (seconds past J2000)\neptype: Type of input epoch (\"UTC\" or \"ET\")\n\nOutput\n\nReturns ΔET (ET-UTC) at input epoch.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dgeodr-NTuple{5, Any}","page":"API","title":"SPICE.dgeodr","text":"dgeodr(x, y, z, re, f)\n\nCompute the Jacobian of the transformation from rectangular to geodetic coordinates.\n\nArguments\n\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.diags2-Tuple{Any}","page":"API","title":"SPICE.diags2","text":"diags2(symmat)\n\nDiagonalize a symmetric 2x2 matrix.\n\nArguments\n\nsymmat: A symmetric 2x2 matrix\n\nOutput\n\ndiag: A diagonal matrix similar to symmat\nrotate: A rotation used as the similarity transformation\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dlabbs-Tuple{Any}","page":"API","title":"SPICE.dlabbs","text":"dlabbs(handle)\n\nBegin a backward segment search in a DLA file.\n\nArguments\n\nhandle: Handle of open DLA file\n\nOutput\n\nReturns the descriptor of the last segment in the DLA file or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dlabfs-Tuple{Any}","page":"API","title":"SPICE.dlabfs","text":"dlabfs(handle)\n\nBegin a forward segment search in a DLA file.\n\nArguments\n\nhandle: Handle of open DLA file\n\nOutput\n\nReturns the descriptor of the first segment in the DLA file or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dlafns-Tuple{Any, Any}","page":"API","title":"SPICE.dlafns","text":"dlafns(handle, descr)\n\nFind the segment following a specified segment in a DLA file.\n\nArguments\n\nhandle: Handle of open DLA file\ndescr: Descriptor of a DLA segment\n\nOutput\n\nReturns the descriptor of the next segment in the DLA file or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dlafps-Tuple{Any, Any}","page":"API","title":"SPICE.dlafps","text":"dlafps(handle, descr)\n\nFind the segment preceding a specified segment in a DLA file.\n\nArguments\n\nhandle: Handle of open DLA file\ndescr: Descriptor of a DLA segment\n\nOutput\n\nReturns the descriptor of the previous segment in the DLA file or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dlatdr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dlatdr","text":"dlatdr(x, y, z)\n\nCompute the Jacobian of the transformation from rectangular to latitudinal coordinates.\n\nArguments\n\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dp2hx","page":"API","title":"SPICE.dp2hx","text":"dp2hx(number, lenout=128)\n\nConvert a double precision number to an equivalent character string using base 16 \"scientific notation.\"\n\nArguments\n\nnumber: Number to be converted\nlenout: Available space for output string\n\nOutput\n\nReturns the equivalent character string, left justified.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dpgrdr-NTuple{6, Any}","page":"API","title":"SPICE.dpgrdr","text":"dpgrdr(x, y, z, re, f)\n\nCompute the Jacobian of the transformation from rectangular to planetographic coordinates.\n\nArguments\n\nbody: Body with which coordinate system is associated\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dpmax","page":"API","title":"SPICE.dpmax","text":"dpmax()\n\nwarning: Deprecated\nUse prevfloat(typemax(Float64)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dpmin","page":"API","title":"SPICE.dpmin","text":"dpmin()\n\nwarning: Deprecated\nUse nextfloat(typemin(Float64)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dpr","page":"API","title":"SPICE.dpr","text":"dpr()\n\nwarning: Deprecated\nUse rad2deg(1.0) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.drdcyl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.drdcyl","text":"drdcyl(r, lon, z)\n\nCompute the Jacobian of the transformation from cylindrical to rectangular coordinates.\n\nArguments\n\nr: Distance of a point from the origin\nlon: Angle of the point from the xz plane in radians\nz: Height of the point above the xy plane\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.drdgeo-NTuple{5, Any}","page":"API","title":"SPICE.drdgeo","text":"drdgeo(lon, lat, alt, re, f)\n\nCompute the Jacobian of the transformation from geodetic to rectangular coordinates.\n\nArguments\n\nlon: Geodetic longitude of point (radians)\nlat: Geodetic latitude of point (radians)\nalt: Altitude of point above the reference spheroid\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.drdlat-Tuple{Any, Any, Any}","page":"API","title":"SPICE.drdlat","text":"drdlat(radius, lon, lat)\n\nCompute the Jacobian of the transformation from latitudinal to rectangular coordinates.\n\nArguments\n\nradius: Distance of a point from the origin\nlon: Angle of the point from the XZ plane in radians\nlat: Angle of the point from the XY plane in radians\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.drdpgr-NTuple{6, Any}","page":"API","title":"SPICE.drdpgr","text":"drdpgr(body, lon, lat, alt, re, f)\n\nCompute the Jacobian matrix of the transformation from planetographic to rectangular coordinates.\n\nArguments\n\nbody: Name of body with which coordinates are associated\nlon: Planetographic longitude of a point (radians)\nlat: Planetographic latitude of a point (radians)\nalt: Altitude of a point above reference spheroid\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.drdsph-Tuple{Any, Any, Any}","page":"API","title":"SPICE.drdsph","text":"drdsph(r, colat, lon)\n\nCompute the Jacobian of the transformation from latitudinal to rectangular coordinates.\n\nArguments\n\nr: Distance of a point from the origin\ncolat: Angle of the point from the positive z-axis\nlon: Angle of the point from the xy plane\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskb02-Tuple{Any, Any}","page":"API","title":"SPICE.dskb02","text":"dskb02(handle, dladsc)\n\nReturn bookkeeping data from a DSK type 2 segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\n\nOutput\n\nnv: Number of vertices in model\nnp: Number of plates in model\nnvxtot: Number of voxels in fine grid\nvtxbds: Vertex bounds\nvoxsiz: Fine voxel edge length\nvoxori: Fine voxel grid origin\nvgrext: Fine voxel grid exent\ncgscal: Coarse voxel grid scale\nvtxnpl: Size of vertex-plate correspondence list\nvoxnpt: Size of voxel-plate pointer list\nvoxnpl: Size of voxel-plate correspondence list\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskcls","page":"API","title":"SPICE.dskcls","text":"dskcls(handle, optmiz=true)\n\nClose a DSK file.\n\nArguments\n\nhandle: Handle assigned to the opened DSK file\noptmiz: Flag indicating whether to segregate the DSK (default: true)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dskd02-NTuple{5, Any}","page":"API","title":"SPICE.dskd02","text":"dskd02(handle, dladsc, item, start, room)\n\nFetch double precision data from a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\nitem: Keyword identifying item to fetch\nstart: Start index\nroom: Amount of room in output array\n\nOutput\n\nReturns an array containing the requested item.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskgd-Tuple{Any, Any}","page":"API","title":"SPICE.dskgd","text":"dskgd(handle, dladsc)\n\nReturn the DSK descriptor from a DSK segment identified by a DAS handle and DLA descriptor.\n\nArguments\n\nhandle: Handle of a DSK file\ndladsc: DLA segment descriptor\n\nOutput\n\nReturns the DSK segment descriptor.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskgtl-Tuple{Any}","page":"API","title":"SPICE.dskgtl","text":"dskgtl(keywrd)\n\nRetrieve the value of a specified DSK tolerance or margin parameter.\n\nArguments\n\nkeywrd: Code specifying parameter to retrieve\n\nOutput\n\nReturns the value of the parameter.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dski02-NTuple{5, Any}","page":"API","title":"SPICE.dski02","text":"dski02(handle, dladsc, item, start, room)\n\nFetch integer data from a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\nitem: Keyword identifying item to fetch\nstart: Start index\nroom: Amount of room in output array\n\nOutput\n\nReturns an array containing the requested item.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskmi2-NTuple{9, Any}","page":"API","title":"SPICE.dskmi2","text":"dskmi2(vrtces, plates, finscl, corscl, worksz, voxpsz, voxlsz, makvtl, spaisz)\n\nMake spatial index for a DSK type 2 segment.\n\nArguments\n\nvrtces: Vertices\nplates: Plates\nfinscl: Fine voxel scale\ncorscl: Coarse voxel scale\nworksz: Workspace size\nvoxpsz: Voxel-plate pointer array size\nvoxlsz: Voxel-plate list array size\nmakvtl: Vertex-plate list flag\nspxisz: Spatial index integer component size\n\nOutput\n\nspaixd: Double precision component of spatial index.\nspaixi: Integer component of spatial index.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskn02-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dskn02","text":"dskn02(handle, dladsc, plid)\n\nCompute the unit normal vector for a specified plate from a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\nplid: Plate ID\n\nOutput\n\nReturn the plate's unit normal vector.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskobj!-Tuple{Any, Any}","page":"API","title":"SPICE.dskobj!","text":"dskobj!(set, dsk)\n\nFind the set of body ID codes of all objects for which topographic data are provided in a specified DSK file.\n\nArguments\n\ndsk: Name of DSK file\nset or len: Either a preallocated SpiceIntCell or the size of the output set.\n\nOutput\n\nReturns the set of ID codes of objects in the DSK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskopn-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dskopn","text":"dskopn(fname, ifname, ncomch)\n\nOpen a new DSK file for subsequent write operations.\n\nArguments\n\nfname: Name of a DSK file to be opened\nifname: Internal file name\nncomch: Number of comment characters to allocate\n\nOutput\n\nReturns the handle assigned to the opened DSK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskp02-NTuple{4, Any}","page":"API","title":"SPICE.dskp02","text":"dskp02(handle, dladsc, start, room)\n\nFetch triangular plates from a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\nstart: Start index\nroom: Amount of room in output array\n\nOutput\n\nReturns an array of plates.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskrb2-NTuple{4, Any}","page":"API","title":"SPICE.dskrb2","text":"dskrb2(vrtces, plates, corsys, corpar)\n\nDetermine range bounds for a set of triangular plates to be stored in a type 2 DSK segment.\n\nArguments\n\nvrtces: Vertices\nplates: Plates\ncorsys: DSK coordinate system code\ncorpar: DSK coordinate system parameters\n\nOutput\n\nmncor3: Lower bound on range of third coordinate\nmxcor3: Upper bound on range of third coordinate\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dsksrf!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dsksrf!","text":"dsksrf!(set, dsk)\n\nFind the set of surface ID codes of all objects for which topographic data are provided in a specified DSK file.\n\nArguments\n\ndsk: Name of DSK file\nset or len: Either a preallocated SpiceIntCell or the size of the output set.\n\nOutput\n\nReturns the set of ID codes of surfaces in the DSK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskstl-Tuple{Any, Any}","page":"API","title":"SPICE.dskstl","text":"dskstl(keywrd)\n\nSet the value of a specified DSK tolerance or margin parameter.\n\nArguments\n\nkeywrd: Code specifying parameter to retrieve\ndpval: Value of parameter\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskv02-NTuple{4, Any}","page":"API","title":"SPICE.dskv02","text":"dskv02(handle, dladsc, start, room)\n\nFetch vertices from a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\nstart: Start index\nroom: Amount of room in output array\n\nOutput\n\nReturns an array of vertices.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskw02-NTuple{19, Any}","page":"API","title":"SPICE.dskw02","text":"dskw02(handle, center, surfid, dclass, frame, corsys, corpar, mncor1, mxcor1,\n mncor2, mxcor2, mncor3, mxcor3, first, last, vrtces, plates, spaixd, spaixi)\n\nWrite a type 2 segment to a DSK file.\n\nArguments\n\nhandle: Handle assigned to the opened DSK file\ncenter: Central body ID code\nsurfid: Surface ID code\ndclass: Data class\nframe: Reference frame\ncorsys: Coordinate system code\ncorpar: Coordinate system parameters\nmncor1: Minimum value of first coordinate\nmxcor1: Maximum value of first coordinate\nmncor2: Minimum value of second coordinate\nmxcor2: Maximum value of second coordinate\nmncor3: Minimum value of third coordinate\nmxcor3: Maximum value of third coordinate\nfirst: Coverage start time\nlast: Coverage stop time\nnv: Number of vertices\nvrtces: Vertices\nnp: Number of plates\nplates: Plates\nspaixd: Double precision component of spatial index\nspaixi: Integer component of spatial index\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskx02-NTuple{4, Any}","page":"API","title":"SPICE.dskx02","text":"dskx02(handle, dladsc, vertex, raydir)\n\nDetermine the plate ID and body-fixed coordinates of the intersection of a specified ray with the surface defined by a type 2 DSK plate model.\n\nArguments\n\nhandle: Handle of DSK kernel containing plate model\ndladsc: DLA descriptor of plate model segment\nvertex: Ray vertex in the body fixed frame\nraydir: Ray direction in the body fixed frame\n\nOutput\n\nReturns nothing if no intercept exists or\n\nplid: ID code of the plate intersected by the ray\nxpt: Intercept\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskxsi","page":"API","title":"SPICE.dskxsi","text":"dskxsi(pri, target, nsurf, srflst, et, fixref, vertex, raydir, maxd=1, maxi=1)\n\nCompute a ray-surface intercept using data provided by multiple loaded DSK segments. Return information about the source of the data defining the surface on which the intercept was found: DSK handle, DLA and DSK descriptors, and DSK data type-dependent parameters.\n\nArguments\n\npri: Data prioritization flag\ntarget: Target body name\nsrflst: Surface ID list\net: Epoch, expressed as seconds past J2000 TDB\nfixref: Name of target body-fixed reference frame\nvertex: Vertex of ray\nraydir: Direction vector of ray\nmaxd: Size of DC array (default: 1)\nmaxi: Size of IC array (default: 1)\n\nOutput\n\nReturns nothing if no intercept exists or\n\nxpt: Intercept point\nhandle: Handle of segment contributing surface data\ndladsc: DLA descriptor of segment\ndskdsc: DSK descriptor of segment\ndc: Double precision component of source info\nic: Integer component of source info\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dskxv-NTuple{7, Any}","page":"API","title":"SPICE.dskxv","text":"dskxv(pri, target, srflst, et, fixref, nrays, vtxarr, dirarr)\n\nCompute ray-surface intercepts for a set of rays, using data provided by multiple loaded DSK segments.\n\nArguments\n\npri: Data prioritization flag\ntarget: Target body name\nsrflst: Surface ID list\net: Epoch, expressed as seconds past J2000 TDB\nfixref: Name of target body-fixed reference frame\nnrays: Number of rays\nvtxarr: Array of vertices of rays\ndirarr: Array of direction vectors of rays\n\nOutput\n\nxptarr: Intercept point array\nfndarr: Found flag array\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskz02-Tuple{Any, Any}","page":"API","title":"SPICE.dskz02","text":"dskz02(handle, dladsc)\n\nReturn plate model size parameters - plate count and vertex count - for a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\n\nOutput\n\nnv: Number of vertices\nnp: Number of plates\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dsphdr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dsphdr","text":"dsphdr(x, y, z)\n\nCompute the Jacobian of the transformation from rectangular to spherical coordinates.\n\nArguments\n\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dtpool-Tuple{Any}","page":"API","title":"SPICE.dtpool","text":"dtpool(name)\n\nReturn the data about a kernel pool variable.\n\nArguments\n\nname: Name of the variable whose value is to be returned\n\nOutput\n\nReturns the tuple (n ,vartype).\n\nn: Number of values returned for name\nvartype: Type of the variable\n:C if the data is character data\n:N if the data is numeric\n:X if there is no variable name in the pool\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ducrss-Tuple{Any, Any}","page":"API","title":"SPICE.ducrss","text":"ducrss(s1, s2)\n\nCompute the unit vector parallel to the cross product of two 3-dimensional vectors and the derivative of this unit vector.\n\nArguments\n\ns1: Left hand state for cross product and derivative\ns2: Right hand state for cross product and derivative\n\nOutput\n\nReturns the unit vector and derivative of the cross product.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvcrss-Tuple{Any, Any}","page":"API","title":"SPICE.dvcrss","text":"dvcrss(s1, s2)\n\nCompute the cross product of two 3-dimensional vectors and the derivative of this cross product.\n\nArguments\n\ns1: Left hand state for cross product and derivative\ns2: Right hand state for cross product and derivative\n\nOutput\n\nReturns the cross product and its derivative.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvdot-Tuple{Any, Any}","page":"API","title":"SPICE.dvdot","text":"dvdot(s1, s2)\n\nCompute the derivative of the dot product of two double precision position vectors.\n\nArguments\n\ns1: First state vector in the dot product\ns2: Second state vector in the dot product\n\nOutput\n\nReturns the derivative of the dot product s1 ⋅ s2.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvhat-Tuple{Any}","page":"API","title":"SPICE.dvhat","text":"dvhat(s1)\n\nFind the unit vector corresponding to a state vector and the derivative of the unit vector.\n\nArguments\n\ns1: State to be normalized\n\nOutput\n\nReturns the unit vector s1 / |s1|, and its time derivative.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvnorm-Tuple{Any}","page":"API","title":"SPICE.dvnorm","text":"dvnorm(state)\n\nFunction to calculate the derivative of the norm of a 3-vector.\n\nArguments\n\nstate: A 6-vector composed of three coordinates and their derivatives.\n\nOutput\n\nReturns the derivative of the norm of state.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvpool-Tuple{Any}","page":"API","title":"SPICE.dvpool","text":"dvpool(name)\n\nDelete a variable from the kernel pool.\n\nArguments\n\nname: Name of the kernel variable to be deleted\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvsep-Tuple{Any, Any}","page":"API","title":"SPICE.dvsep","text":"dvsep(s1, s2)\n\nCalculate the time derivative of the separation angle between two input states, s1 and s2.\n\nArguments\n\ns1: State vector of the first body\ns2: State vector of the second body\n\nOutput\n\nReturns the value of the time derivative of the angular separation between s1 and s2.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.edlimb-NTuple{4, Any}","page":"API","title":"SPICE.edlimb","text":"edlimb(a, b, c, viewpt)\n\nFind the limb of a triaxial ellipsoid, viewed from a specified point.\n\nArguments\n\na: Length of ellipsoid semi-axis lying on the x-axis\nb: Length of ellipsoid semi-axis lying on the y-axis\nc: Length of ellipsoid semi-axis lying on the z-axis\nviewpt: Location of viewing point\n\nOutput\n\nReturns the limb of the ellipsoid as seen from the viewing point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.edterm-NTuple{8, Any}","page":"API","title":"SPICE.edterm","text":"edterm(trmtyp, source, target, et, fixref, abcorr, obsrvr, npts)\n\nCompute a set of points on the umbral or penumbral terminator of a specified target body, where the target shape is modeled as an ellipsoid.\n\nArguments\n\ntrmtyp: Terminator type\nsource: Light source\ntarget: Target body\net: Observation epoch\nfixref: Body-fixed frame associated with target\nabcorr: Aberration correction\nobsrvr: Observer\nnpts: Number of points in terminator set\n\nOutput\n\ntrgepc: Epoch associated with target center\nobspos: Position of observer in body-fixed frame\ntrmpts: Terminator point set\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekacec-NTuple{6, Any}","page":"API","title":"SPICE.ekacec","text":"ekacec(handle, segno, recno, column, cvals, isnull)\n\nAdd data to a character column in a specified EK record.\n\nArguments\n\nhandle: EK file handle\nsegno: Index of segment containing record\nrecno: Record to which data is to be added\ncolumn: Column name\ncvals: Character values to add to column\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekaced-NTuple{6, Any}","page":"API","title":"SPICE.ekaced","text":"ekaced(handle, segno, recno, column, dvals, isnull)\n\nAdd data to an double precision column in a specified EK record.\n\nArguments\n\nhandle: EK file handle\nsegno: Index of segment containing record\nrecno: Record to which data is to be added\ncolumn: Column name\ndvals: Double precision values to add to column\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekacei-NTuple{6, Any}","page":"API","title":"SPICE.ekacei","text":"ekacei(handle, segno, recno, column, ivals, isnull)\n\nAdd data to an integer column in a specified EK record.\n\nArguments\n\nhandle: EK file handle\nsegno: Index of segment containing record\nrecno: Record to which data is to be added\ncolumn: Column name\nivals: Integer values to add to column\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekaclc-NTuple{6, Any}","page":"API","title":"SPICE.ekaclc","text":"ekaclc(handle, segno, column, cvals, nlflgs, rcptrs)\n\nAdd an entire character column to an EK segment.\n\nArguments\n\nhandle: EK file handle.\nsegno: Number of segment to add column to.\ncolumn: Column name.\ncvals: Character values to add to column.\nnlflgs: Array of null flags for column entries.\nrcptrs: Record pointers for segment.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekacld-NTuple{6, Any}","page":"API","title":"SPICE.ekacld","text":"ekacld(handle, segno, column, dvals, nlflgs, rcptrs)\n\nAdd an entire double precision column to an EK segment.\n\nArguments\n\nhandle: EK file handle\nsegno: Number of segment to add column to\ncolumn: Column name\ndvals: Double precision values to add to column\nnlflgs: Array of null flags for column entries\nrcptrs: Record pointers for segment\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekacli-NTuple{6, Any}","page":"API","title":"SPICE.ekacli","text":"ekacli(handle, segno, column, ivals, nlflgs, rcptrs)\n\nAdd an entire integer column to an EK segment.\n\nArguments\n\nhandle: EK file handle\nsegno: Number of segment to add column to\ncolumn: Column name\nivals: Integer values to add to column\nnlflgs: Array of null flags for column entries\nrcptrs: Record pointers for segment\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekappr-Tuple{Any, Any}","page":"API","title":"SPICE.ekappr","text":"ekappr(handle, segno)\n\nAppend a new, empty record at the end of a specified E-kernel segment.\n\nArguments\n\nhandle: File handle\nsegno: Segment number\n\nOutput\n\nReturns the number of appended record.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekbseg-NTuple{4, Any}","page":"API","title":"SPICE.ekbseg","text":"ekbseg(handle, tabnam, cnames, decls)\n\nStart a new segment in an E-kernel.\n\nArguments\n\nhandle: File handle\ntabnam: Table name\ncnames: Names of columns\ndecls: Declarations of columns\n\nOutput\n\nReturns the segment number.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekccnt-Tuple{Any}","page":"API","title":"SPICE.ekccnt","text":"ekccnt(table)\n\nReturn the number of distinct columns in a specified, currently loaded table\n\nArguments\n\ntable: Name of table\n\nOutput\n\nReturns the count of distinct, currently loaded columns.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekcii","page":"API","title":"SPICE.ekcii","text":"ekcii(table, cindex, lenout=256)\n\nReturn attribute information about a column belonging to a loaded EK table, specifying the column by table and index.\n\nArguments\n\ntable: Name of table containing column\ncindex: Index of column whose attributes are to be found\nlenout: Maximum allowed length of column name (default: 256)\n\nOutput\n\ncolumn: Name of column\nattdsc: Column attribute descriptor\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekcls-Tuple{Any}","page":"API","title":"SPICE.ekcls","text":"ekcls(handle)\n\nClose an E-kernel.\n\nArguments\n\nhandle: EK file handle\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekdelr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekdelr","text":"ekdelr(handle, segno, recno)\n\nDelete a specified record from a specified E-kernel segment.\n\nArguments\n\nhandle: File handle\nsegno: Segment number\nrecno: Record number\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekffld-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekffld","text":"ekffld(handle, segno, rcptrs)\n\nComplete a fast write operation on a new E-kernel segment.\n\nArguments\n\nhandle: File handle\nsegno: Segment number\nrcptrs: Record pointers\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekfind","page":"API","title":"SPICE.ekfind","text":"ekfind(query, lenout=256)\n\nFind E-kernel data that satisfy a set of constraints.\n\nArguments\n\nquery: Query specifying data to be found.\nlenout: Declared length of output error message string (default: 256)\n\nOutput\n\nReturns the number of matching rows.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekgc","page":"API","title":"SPICE.ekgc","text":"ekgc(selidx, row, elment, lenout=256)\n\nReturn an element of an entry in a column of character type in a specified row.\n\nArguments\n\nselidx: Index of parent column in SELECT clause\nrow: Row to fetch from\nelment: Index of element, within column entry, to fetch\nlenout: Maximum length of column element (default: 256)\n\nOutput\n\nReturns the character string element of column entry or missing if it was null or nothing if the column was not found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekgd-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekgd","text":"ekgd(selidx, row, element)\n\nReturn an element of an entry in a column of double precision type in a specified row.\n\nArguments\n\nselidx: Index of parent column in SELECT clause\nrow: Row to fetch from\nelment: Index of element, within column entry, to fetch\n\nOutput\n\nReturns the double precision element of column entry or missing if it was null or nothing if the column was not found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekgi-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekgi","text":"ekgi(selidx, row, element)\n\nReturn an element of an entry in a column of integer type in a specified row.\n\nArguments\n\nselidx: Index of parent column in SELECT clause\nrow: Row to fetch from\nelment: Index of element, within column entry, to fetch\n\nOutput\n\nReturns the integer element of column entry or missing if it was null or nothing if the column was not found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekifld-NTuple{5, Any}","page":"API","title":"SPICE.ekifld","text":"ekifld(handle, tabnam, nrows, cnames, decls)\n\nInitialize a new E-kernel segment to allow fast writing.\n\nArguments\n\nhandle: File handle\ntabnam: Table name\nnrows: Number of rows in the segment\ncnames: Names of columns\ndecls: Declarations of columns\n\nOutput\n\nsegno: Segment number\nrcptrs: Array of record pointers\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekinsr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekinsr","text":"ekinsr(handle, segno, recno)\n\nAdd a new, empty record to a specified E-kernel segment at a specified index.\n\nArguments\n\nhandle: File handle\nsegno: Segment number\nrecno: Record number\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.eklef-Tuple{Any}","page":"API","title":"SPICE.eklef","text":"eklef(fname)\n\nLoad an EK file, making it accessible to the EK readers.\n\nArguments\n\nfname: Name of EK file to load\n\nOutput\n\nReturns the file handle of loaded EK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.eknelt-Tuple{Any, Any}","page":"API","title":"SPICE.eknelt","text":"eknelt(selidx, row)\n\nReturn the number of elements in a specified column entry in the current row.\n\nArguments\n\nselidx: Index of parent column in SELECT clause\nrow: Row containing element\n\nOutput\n\nReturns the number of elements in entry in current row.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.eknseg-Tuple{Any}","page":"API","title":"SPICE.eknseg","text":"eknseg(handle)\n\nReturn the number of segments in a specified EK.\n\nArguments\n\nhandle: EK file handle\n\nOutput\n\nReturns the number of segments in the specified E-kernel.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekntab-Tuple{}","page":"API","title":"SPICE.ekntab","text":"ekntab()\n\nReturn the number of loaded EK tables.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekopn-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekopn","text":"ekopn(fname, ifname, ncomch)\n\nOpen a new E-kernel file and prepare the file for writing.\n\nArguments\n\nfname: Name of EK file\nifname: Internal file name\nncomch: The number of characters to reserve for comments\n\nOutput\n\nReturn the handle attached to the new EK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekopr-Tuple{Any}","page":"API","title":"SPICE.ekopr","text":"ekopr(fname)\n\nOpen an existing E-kernel file for reading.\n\nArguments\n\nfname: Name of EK file\n\nOutput\n\nReturns the handle attached to the EK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekops-Tuple{}","page":"API","title":"SPICE.ekops","text":"ekops()\n\nOpen a scratch (temporary) E-kernel file and prepare the file for writing.\n\nOutput\n\nReturns the handle attached to the EK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekopw-Tuple{Any}","page":"API","title":"SPICE.ekopw","text":"ekopw(fname)\n\nOpen an existing E-kernel file for writing.\n\nArguments\n\nfname: Name of EK file\n\nOutput\n\nReturns the handle attached to the EK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekpsel","page":"API","title":"SPICE.ekpsel","text":"ekpsel(query, msglen=256, tablen=256, collen=256)\n\nParse the SELECT clause of an EK query, returning full particulars concerning each selected item.\n\nArguments\n\nquery: EK query\nmsglen: Available space in the output error message string (default: 256)\ntablen: Length of strings in `tabs' output array (default: 256)\ncollen: Length of strings in `cols' output array (default: 256)\n\nOutput\n\nxbegs: Begin positions of expressions in SELECT clause\nxends: End positions of expressions in SELECT clause\nxtypes: Data types of expressions\nxclass: Classes of expressions\ntabs: Names of tables qualifying SELECT columns\ncols: Names of columns in SELECT clause of query\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekrcec","page":"API","title":"SPICE.ekrcec","text":"ekrcec(handle, segno, recno, column, lenout=256, nelts=100)\n\nRead data from a character column in a specified EK record.\n\nArguments\n\nhandle: Handle attached to EK file\nsegno: Index of segment containing record\nrecno: Record from which data is to be read\ncolumn: Column name\nlenout: Maximum length of output strings\nnelts: Maximum number of elements to return (default: 100)\n\nOutput\n\nReturns the character values in column entry or missing if they are null.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekrced","page":"API","title":"SPICE.ekrced","text":"ekrced(handle, segno, recno, column, nelts=100)\n\nRead data from a double precision column in a specified EK record.\n\nArguments\n\nhandle: Handle attached to EK file\nsegno: Index of segment containing record\nrecno: Record from which data is to be read\ncolumn: Column name\nnelts: Maximum number of elements to return (default: 100)\n\nOutput\n\nReturns the values in column entry.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekrcei","page":"API","title":"SPICE.ekrcei","text":"ekrcei(handle, segno, recno, column, nelts=100)\n\nRead data from an integer column in a specified EK record.\n\nArguments\n\nhandle: Handle attached to EK file\nsegno: Index of segment containing record\nrecno: Record from which data is to be read\ncolumn: Column name\nnelts: Maximum number of elements to return (default: 100)\n\nOutput\n\nReturns the values in column entry.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekssum-Tuple{Any, Any}","page":"API","title":"SPICE.ekssum","text":"ekssum(handle, segno)\n\nReturn summary information for a specified segment in a specified EK.\n\nArguments\n\nhandle: Handle of EK\nsegno: Number of segment to be summarized\n\nOutput\n\nReturns the EK segment summary.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ektnam","page":"API","title":"SPICE.ektnam","text":"ektnam(n, lenout=256)\n\nReturn the name of a specified, loaded table.\n\nArguments\n\nn: Index of table\nlenout: Maximum table name length (default: 256)\n\nOutput\n\nReturns the name of table.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekucec-NTuple{6, Any}","page":"API","title":"SPICE.ekucec","text":"ekucec(handle, segno, recno, column, cvals, isnull)\n\nUpdate a character column entry in a specified EK record.\n\nArguments\n\nhandle: EK file handle\nsegno: Index of segment containing record\nrecno: Record to which data is to be updated\ncolumn: Column name\ncvals: Character values comprising new column entry\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekuced-NTuple{6, Any}","page":"API","title":"SPICE.ekuced","text":"ekuced(handle, segno, recno, column, dvals, isnull)\n\nUpdate a double precision column entry in a specified EK record.\n\nArguments\n\nhandle: Handle attached to EK file\nsegno: Index of segment containing record\nrecno: Record in which entry is to be updated\ncolumn: Column name\ndvals: Double precision values comprising new column entry\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekucei-NTuple{6, Any}","page":"API","title":"SPICE.ekucei","text":"ekucei(handle, segno, recno, column, dvals, isnull)\n\nUpdate an integer column entry in a specified EK record.\n\nArguments\n\nhandle: Handle attached to EK file\nsegno: Index of segment containing record\nrecno: Record in which entry is to be updated\ncolumn: Column name\nivals: Integer values comprising new column entry\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekuef-Tuple{Any}","page":"API","title":"SPICE.ekuef","text":"ekuef(handle)\n\nUnload an EK file, making its contents inaccessible to the EK reader routines, and clearing space in order to allow other EK files to be loaded.\n\nArguments\n\nhandle: Handle of EK file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.el2cgv-Tuple{Any}","page":"API","title":"SPICE.el2cgv","text":"Convert an ellipse to a center vector and two generating vectors. The selected generating vectors are semi-axes of the ellipse.\n\nArguments\n\nellipse: An ellipse\n\nOutput\n\nReturns the center and semi-axes of ellipse.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.elemc","page":"API","title":"SPICE.elemc","text":"elem[c/d/i](item, cell)\n\nwarning: Deprecated\nUse item in cell instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.eqncpv-NTuple{5, Any}","page":"API","title":"SPICE.eqncpv","text":"eqncpv(et, epoch, eqel, rapol, decpol)\n\nCompute the state (position and velocity of an object whose trajectory is described via equinoctial elements relative to some fixed plane (usually the equatorial plane of some planet).\n\nArguments\n\net: Epoch in seconds past J2000 to find state\nepoch: Epoch of elements in seconds past J2000\neqel: Array of equinoctial elements\nrapol: Right Ascension of the pole of the reference plane\ndecpol: Declination of the pole of the reference plane\n\nOutput\n\nReturns the state of the object described by eqel.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.eqstr-Tuple{Any, Any}","page":"API","title":"SPICE.eqstr","text":"eqstr(a, b)\n\nDetermine whether two strings are equivalent.\n\nArguments\n\na, b: Arbitrary character strings\n\nOutput\n\nReturns true if a and b are equivalent.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.esrchc-Tuple{Any, Any}","page":"API","title":"SPICE.esrchc","text":"esrchc(value, array)\n\nSearch for a given value within a character string array.\n\nArguments\n\nvalue: Key value to be found in array\narray: Character string array to search\n\nOutput\n\nReturns the index of the first equivalent array entry, or -1 if no equivalent element is found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.et2lst","page":"API","title":"SPICE.et2lst","text":"et2lst(et, body, lon, typ, timlen=128, ampmlen=128)\n\nGiven an ephemeris epoch, compute the local solar time for an object on the surface of a body at a specified longitude.\n\nArguments\n\net: Epoch in seconds past J2000 epoch\nbody: ID-code of the body of interest\nlon: Longitude of surface point (radians)\ntyp: Type of longitude \"PLANETOCENTRIC\", etc\ntimlen: Available room in output time string (default: 128)\nampmlen: Available room in output `ampm' string (default: 128)\n\nOutput\n\nhr: Local hour on a \"24 hour\" clock\nmn: Minutes past the hour\nsc: Seconds past the minute\ntime: String giving local time on 24 hour clock\nampm: String giving time on A.M./ P.M. scale\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.et2utc-Tuple{Any, Any, Any}","page":"API","title":"SPICE.et2utc","text":"et2utc(et, format, prec)\n\nConvert an input time from ephemeris seconds past J2000 to Calendar, Day-of-Year, or Julian Date format, UTC.\n\nArguments\n\net: Input epoch, given in ephemeris seconds past J2000\nformat: Format of output epoch. It may be any of the following:\n:C: Calendar format, UTC\n:D: Day-of-Year format, UTC\n:J: Julian Date format, UTC\n:ISOC: ISO Calendar format, UTC\n:ISOD: ISO Day-of-Year format, UTC\nprec: Digits of precision in fractional seconds or days\n\nOutput\n\nReturns an output time string equivalent to the input epoch, in the specified format.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.etcal","page":"API","title":"SPICE.etcal","text":"etcal(et, lenout=128)\n\nConvert from an ephemeris epoch measured in seconds past the epoch of J2000 to a calendar string format using a formal calendar free of leapseconds.\n\nArguments\n\net: Ephemeris time measured in seconds past J2000\nlenout: Length of output string (default: 128)\n\nOutput\n\nReturns a standard calendar representation of et.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.eul2m-NTuple{6, Any}","page":"API","title":"SPICE.eul2m","text":"eul2m(angle3, angle2, angle1, axis3, axis2, axis1)\n\nConstruct a rotation matrix from a set of Euler angles.\n\nArguments\n\nangle3, angle2, angle1: Rotation angles about third, second, and first rotation axes (radians)\naxis3, axis2, axis1: Axis numbers of third, second, and first rotation axes\n\nOutput\n\nA rotation matrix corresponding to the product of the 3 rotations.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.eul2xf-NTuple{4, Any}","page":"API","title":"SPICE.eul2xf","text":"eul2xf(eulang, axisa, axisb, axisc)\n\nCompute a state transformation from an Euler angle factorization of a rotation and the derivatives of those Euler angles.\n\nArguments\n\neulang: An array of Euler angles and their derivatives\naxisa: Axis A of the Euler angle factorization\naxisb: Axis B of the Euler angle factorization\naxisc: Axis C of the Euler angle factorization\n\nOutput\n\nReturns a state transformation matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.expool-Tuple{Any}","page":"API","title":"SPICE.expool","text":"expool(name)\n\nConfirm the existence of a kernel variable in the kernel pool.\n\nArguments\n\nname: Name of the variable whose value is to be returned\n\nOutput\n\nReturns true when the variable is in the pool.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.fovray-NTuple{6, Any}","page":"API","title":"SPICE.fovray","text":"fovray(inst, raydir, rframe, abcorr, observer, et)\n\nDetermine if a specified ray is within the field-of-view (FOV) of a specified instrument at a given time.\n\nArguments\n\ninst: Name or ID code string of the instrument\nraydir: Ray's direction vector\nrframe: Body-fixed, body-centered frame for target body\nabcorr: Aberration correction flag\nobserver: Name or ID code string of the observer\net: Time of the observation (seconds past J2000)\n\nOutput\n\nReturns true if the ray is visible.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.fovtrg-NTuple{7, Any}","page":"API","title":"SPICE.fovtrg","text":"fovtrg(inst, target, tshape, tframe, abcorr, obsrvr, et)\n\nDetermine if a specified ephemeris object is within the field-of-view (FOV) of a specified instrument at a given time.\n\nArguments\n\ninst: Name or ID code string of the instrument.\ntarget: Name or ID code string of the target.\ntshape: Type of shape model used for the target.\ntframe: Body-fixed, body-centered frame for target body.\nabcorr: Aberration correction flag.\nobsrvr: Name or ID code string of the observer.\net: Time of the observation (seconds past J2000).\n\nOutput\n\nReturns true if the object is visible.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.frame-Tuple{Any}","page":"API","title":"SPICE.frame","text":"frame(x)\n\nGiven a vector x, this routine builds a right handed orthonormal frame x, y, z where the output x is parallel to the input x.\n\nArguments\n\nx: Input vector\n\nOutput\n\nx: Unit vector parallel to x on output\ny: Unit vector in the plane orthogonal to x\nz: Unit vector given by x × y\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.frinfo-Tuple{Any}","page":"API","title":"SPICE.frinfo","text":"frinfo(frcode)\n\nRetrieve the minimal attributes associated with a frame needed for converting transformations to and from it.\n\nArguments\n\nfrcode: The id code for a reference frame\n\nOutput\n\ncent: The center of the frame\nfrclss: The class (type) of the frame\nclssid: The idcode for the frame within its class\n\nReturns nothing if no frame with id frcode could be found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.frmnam-Tuple{Any}","page":"API","title":"SPICE.frmnam","text":"frmnam(frcode)\n\nRetrieve the name of a reference frame associated with an id code.\n\nArguments\n\nfrcode: The id code for a reference frame\n\nOutput\n\nReturns the name associated with the reference frame.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.furnsh-Tuple","page":"API","title":"SPICE.furnsh","text":"furnsh(kernels...)\n\nLoad one or more SPICE kernels into a program.\n\nArguments\n\nkernels: Path(s) of SPICE kernels to load\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gcpool-Tuple{Any}","page":"API","title":"SPICE.gcpool","text":"gcpool(name; start=1, room=100, lenout=128)\n\nReturn the value of a kernel variable from the kernel pool.\n\nArguments\n\nname: Name of the variable whose value is to be returned\nstart: Which component to start retrieving for name (default: 1)\nroom: The largest number of values to return (default: 100)\nlenout: The length of the longest string to return (default: 128)\n\nOutput\n\nReturns an array of values if the variable exists or nothing if not.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gdpool-Tuple{Any}","page":"API","title":"SPICE.gdpool","text":"gdpool(name; start=1, room=100)\n\nReturn the value of a kernel variable from the kernel pool.\n\nArguments\n\nname: Name of the variable whose value is to be returned\nstart: Which component to start retrieving for name (default: 1)\nroom: The largest number of values to return (default: 100)\n\nOutput\n\nReturns an array of values if the variable exists or nothing if not.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.georec-NTuple{5, Any}","page":"API","title":"SPICE.georec","text":"georec(lon, lat, alt, re, f)\n\nConvert geodetic coordinates to rectangular coordinates.\n\nArguments\n\nlon: Geodetic longitude of point (radians)\nlat: Geodetic latitude of point (radians)\nalt: Altitude of point above the reference spheroid\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nReturns the rectangular coordinates of point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.getelm-Tuple{Any, Any}","page":"API","title":"SPICE.getelm","text":"getelm(frstyr, lines)\n\nGiven the \"lines\" of a two-line element set, parse the lines and return the elements in units suitable for use in SPICE software.\n\nArguments\n\nfrstyr: Year of earliest representable two-line elements\nlines: A pair of \"lines\" containing two-line elements\n\nOutput\n\nepoch: The epoch of the elements in seconds past J2000\nelems: The elements converted to SPICE units\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.getfat","page":"API","title":"SPICE.getfat","text":"getfat(file, arclen=10, typlen=10)\n\nDetermine the file architecture and file type of most SPICE kernel files.\n\nArguments\n\nfile: The name of a file to be examined\narclen: Maximum length of output architecture string (default: 10)\ntyplen: Maximum length of output type string (default: 10)\n\nOutput\n\narch: The architecture of the kernel file\ntyp: The type of the kernel file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.getfov","page":"API","title":"SPICE.getfov","text":"getfov(instid, room=10, shapelen=128, framelen=128)\n\nReturn the field-of-view (FOV) parameters for a specified instrument. The instrument is specified by its NAIF ID code.\n\nArguments\n\ninstid: NAIF ID of an instrument\nroom: Maximum number of vectors that can be returned (default: 10)\nshapelen: Space available in the string shape (default: 128)\nframelen: Space available in the string frame (default: 128)\n\nOutput\n\nReturns a tuple consisting of\n\nshape: Instrument FOV shape\nframe: Name of the frame in which FOV vectors are defined\nbsight: Boresight vector\nbounds: FOV boundary vectors\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.gfdist-NTuple{9, Any}","page":"API","title":"SPICE.gfdist","text":"gfdist(target, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)\n\nReturn the time window over which a specified constraint on observer-target distance is met.\n\nArguments\n\ntarget: Name of the target body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nrelate: Relational operator\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is confined\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfevnt-NTuple{18, Any}","page":"API","title":"SPICE.gfevnt","text":"gfevnt(udstep, udrefn, gquant, qnpars, lenvals, qpnams, qcpars, qdpars, qipars, qlpars,\n op, refval, tol, adjust, rpt, udrepi, udrepu, udrepf, nintvls, bail, udbail, cnfine)\n\nDetermine time intervals when a specified geometric quantity satisfies a specified mathematical condition.\n\nArguments\n\nudstep: Name of the routine that computes and returns a time step\nudrefn: Name of the routine that computes a refined time\ngquant: Type of geometric quantity\nqpnams: Names of quantity definition parameters\nqcpars: Array of character quantity definition parameters\nqdpars: Array of double precision quantity definition parameters\nqipars: Array of integer quantity definition parameters\nqlpars: Array of logical quantity definition parameters\nop: Operator that either looks for an extreme value (max, min, local, absolute) or compares the geometric quantity value and a number\nrefval: Reference value\ntol: Convergence tolerance in second\nadjust: Absolute extremum adjustment value\nrpt: Progress reporter on (true) or off (false)\nudrepi: Function that initializes progress reporting\nudrepu: Function that updates the progress report\nudrepf: Function that finalizes progress reporting\nnintvls: Workspace window interval coun\ncnfine: SPICE window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gffove!-NTuple{16, Any}","page":"API","title":"SPICE.gffove!","text":"gffove!(inst, tshape, raydir, target, tframe, abcorr, obsrvr, tol, udstep, udrefn,\n rpt, udrepi, udrepu, udrepf, cnfine, result)\n\nDetermine time intervals when a specified target body or ray intersects the space bounded by the field-of-view (FOV) of a specified instrument.\n\nArguments\n\ninst: Name of the instrument\ntshape: Type of shape model used for target body\nraydir: Ray's direction vector\ntarget: Name of the target body\ntframe: Body-fixed, body-centered frame for target body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\ntol: Convergence tolerance in seconds\nudstep: Name of the routine returns a time step\nudrefn: Name of the routine that computes a refined time\nrpt: Progress report flag\nudrepi: Function that initializes progress reporting\nudrepu: Function that updates the progress report\nudrepf: Function that finalizes progress reporting\ncnfine: SPICE window to which the search is restricted\nresult: Window containing the results\n\nOutput\n\nReturns result.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfilum-NTuple{14, Any}","page":"API","title":"SPICE.gfilum","text":"gfilum(method, angtyp, target, illmn, fixref, abcorr, obsrvr, spoint, relate, refval,\n adjust, step, nintvls, cnfine)\n\nReturn the time window over which a specified constraint on the observed phase, solar incidence, or emission angle at a specifed target body surface point is met.\n\nArguments\n\nmethod: Computation method\nangtyp: Type of illumination angle\ntarget: Name of the target body\nillmn: Name of the illumination source\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nspoint: Body-fixed coordinates of a target surface point\nrelate: Relational operator\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is confined\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfocce!-NTuple{18, Any}","page":"API","title":"SPICE.gfocce!","text":"function gfocce!(occtyp, front, fshape, fframe, back, bshape, bframe, abcorr, obsrvr, tol,\n udstep, udrefn, rpt, udrepi, udrepu, udrepf, cnfine, result)\n\nDetermine time intervals when an observer sees one target occulted by another.\n\nArguments\n\nocctyp: Type of occultation\nfront: Name of body occulting the other\nfshape: Type of shape model used for front body\nfframe: Body-fixed, body-centered frame for front body\nback: Name of body occulted by the other\nbshape: Type of shape model used for back body\nbframe: Body-fixed, body-centered frame for back body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\ntol: Convergence tolerance in seconds\nudstep: Name of the routine that returns a time step\nudrefn: Name of the routine that computes a refined time\nrpt: Progress report flag\nudrepi: Function that initializes progress reporting\nudrepu: Function that updates the progress report\nudrepf: Function that finalizes progress reporting\ncnfine: SPICE window to which the search is restricted\nresult: SPICE window containing results\n\nOutput\n\nReturns result.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfoclt","page":"API","title":"SPICE.gfoclt","text":"gfoclt(occtyp, front, fshape, fframe, back, bshape, bframe, abcorr, obsrvr, step, cnfine,\n maxwin=100)\n\nDetermine time intervals when an observer sees one target occulted by, or in transit across, another.\n\nThe surfaces of the target bodies may be represented by triaxial ellipsoids or by topographic data provided by DSK files.\n\nArguments\n\nocctyp: Type of occultation\nfront: Name of body occulting the other\nfshape: Type of shape model used for front body\nfframe: Body-fixed, body-centered frame for front body\nback: Name of body occulted by the other\nbshape: Type of shape model used for back body\nbframe: Body-fixed, body-centered frame for back body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nstep: Step size in seconds for finding occultation events\ncnfine: Window to which the search is restricted\nmaxwin: Maximum size of the output window (default: 100)\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.gfpa-NTuple{10, Any}","page":"API","title":"SPICE.gfpa","text":"gfpa(result, target, illmn, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)\n\nDetermine time intervals for which a specified constraint on the phase angle between an illumination source, a target, and observer body centers is met.\n\nArguments\n\ntarget: Name of the target body\nillmn: Name of the illuminating body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nrelate: Relational operator\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is confined\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfposc-NTuple{12, Any}","page":"API","title":"SPICE.gfposc","text":"gfposc(target, frame, abcorr, obsrvr, crdsys, coord, relate, refval, adjust, step,\n nintvls, cnfine)\n\nDetermine time intervals for which a coordinate of an observer-target position vector satisfies a numerical constraint.\n\nArguments\n\ntarget: Name of the target body\nframe: Name of the reference frame for coordinate calculations\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\ncrdsys: Name of the coordinate system containing coord\ncoord: Name of the coordinate of interest\nrelate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfrefn-NTuple{4, Any}","page":"API","title":"SPICE.gfrefn","text":"gfrefn(t1, t2, s1, s2)\n\nFor those times when we can't do better, we use a bisection method to find the next time at which to test for state change.\n\nArguments\n\nt1: One of two values bracketing a state change\nt2: The other value that brackets a state change\ns1: State at t1\ns2: State at t2\n\nOutput\n\nReturns the new value at which to check for transition.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfrepf-Tuple{}","page":"API","title":"SPICE.gfrepf","text":"gfrepf()\n\nFinish a GF progress report.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfrepi-Tuple{SpiceDoubleCell, Any, Any}","page":"API","title":"SPICE.gfrepi","text":"gfrepi(window, begmss, endmss)\n\nInitialize a search progress report.\n\nArguments\n\nwindow: A window over which a job is to be performed\nbegmss: Beginning of the text portion of the output message\nendmss: End of the text portion of the output message\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfrepu-Tuple{Any, Any, Any}","page":"API","title":"SPICE.gfrepu","text":"gfrepu(ivbeg, ivend, time)\n\nTell the progress reporting system how far a search has progressed.\n\nArguments\n\nivbeg: Start time of work interval\nivend: End time of work interval\ntime: Current time being examined in the search process\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfrfov","page":"API","title":"SPICE.gfrfov","text":"gfrfov(inst, raydir, rframe, abcorr, obsrvr, step, cnfine, maxwin=10000)\n\nDetermine time intervals when a specified ray intersects the space bounded by the field-of-view (FOV) of a specified instrument.\n\nArguments\n\ninst: Name of the instrument\nraydir: Ray's direction vector\nrframe: Reference frame of ray's direction vector\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nstep: Step size in seconds for finding FOV events\ncnfine: SPICE window to which the search is restricted\nmaxwin: Maximum length of the output window (default: 10000)\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.gfrr-NTuple{9, Any}","page":"API","title":"SPICE.gfrr","text":"gfrr(target, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)\n\nDetermine time intervals for which a specified constraint on the observer-target range rate is met.\n\nArguments\n\ntarget: Name of the target body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nrelate: Relational operator\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is confined\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfsep-NTuple{14, Any}","page":"API","title":"SPICE.gfsep","text":"Determine time intervals when the angular separation between the position vectors of two target bodies relative to an observer satisfies a numerical relationship.\n\nArguments\n\ntarg1: Name of first body\nshape1: Name of shape model describing the first body\nframe1: The body-fixed reference frame of the first body\ntarg2: Name of second body\nshape2: Name of the shape model describing the second body\nframe2: The body-fixed reference frame of the second body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nrelate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the angular separation value and refval\nrefval: Reference value\nadjust: Absolute extremum adjustment value\nstep: Step size in seconds for finding angular separation events\nnintvls: Workspace window interval count\ncnfine: Window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfsntc-NTuple{15, Any}","page":"API","title":"SPICE.gfsntc","text":"gfsntc(target, fixref, method, abcorr, obsrvr, dref, dvec, crdsys, coord, relate, refval,\n adjust, step, nintvls, cnfine)\n\nDetermine time intervals for which a coordinate of an surface intercept position vector satisfies a numerical constraint.\n\nArguments\n\ntarget: Name of the target body\nfixref: Body fixed frame associated with target\nmethod: Name of method type for surface intercept calculation\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\ndref: Reference frame of direction vector dvec\ndvec: Pointing direction vector from obsrvr\ncrdsys: Name of the coordinate system containing COORD\ncoord: Name of the coordinate of interest\nrelate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfsstp-Tuple{Any}","page":"API","title":"SPICE.gfsstp","text":"gfsstp(step)\n\nSet the step size to be returned by gfstep.\n\nArguments\n\nstep: Time step to take\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfstep-Tuple{}","page":"API","title":"SPICE.gfstep","text":"gfstep()\n\nReturn the time step set by the most recent call to gfsstp.\n\nArguments\n\nstep: Time step to take\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfstol-Tuple{Any}","page":"API","title":"SPICE.gfstol","text":"gfstol(value)\n\nOverride the default GF convergence value used in the high level GF routines.\n\nArguments\n\nvalue: Double precision value returned or to store\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfsubc-NTuple{13, Any}","page":"API","title":"SPICE.gfsubc","text":"gfsubc(target, fixref, method, abcorr, obsrvr, crdsys, coord, relate, refval, adjust, step,\n nintvls, cnfine)\n\nDetermine time intervals for which a coordinate of an subpoint position vector satisfies a numerical constraint.\n\nArguments\n\ntarget: Name of the target body\nfixref: Body fixed frame associated with target\nmethod: Name of method type for subpoint calculation\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\ncrdsys: Name of the coordinate system containing coord\ncoord: Name of the coordinate of interest\nrelate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gftfov-NTuple{9, Any}","page":"API","title":"SPICE.gftfov","text":"gftfov(inst, target, tshape, tframe, abcorr, obsrvr, step, nintvls, cnfine)\n\nDetermine time intervals when a specified ephemeris object intersects the space bounded by the field-of-view (FOV) of a specified instrument.\n\nArguments\n\ninst: Name of the instrument\ntarget: Name of the target body\ntshape: Type of shape model used for target body\ntframe: Body-fixed, body-centered frame for target body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nstep: Step size in seconds for finding FOV events\nnintvls: Workspace window interval count\ncnfine: Window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfudb!-NTuple{5, Any}","page":"API","title":"SPICE.gfudb!","text":"gfudb!(udfuns, udfunb, step, cnfine, result)\n\nPerform a GF search on a user defined boolean quantity.\n\nArguments\n\nudfuns: Name of the routine that computes a scalar quantity of interest corresponding to an et, e.g. f(et) = ...\nudfunb: Name of the routine returning the boolean value corresponding to an et, e.g. g(f, et) = ...\nstep: Step size used for locating extrema and roots\ncnfine: Window to which the search is restricted\nresult: Window containing results\n\nOutput\n\nReturns result.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfuds!-NTuple{9, Any}","page":"API","title":"SPICE.gfuds!","text":"gfuds!(udfuns, udqdec, relate, refval, adjust, step, nintvls, cnfine, result)\n\nPerform a GF search on a user defined scalar quantity.\n\nArguments\n\nudfuns: Name of the routine that computes the scalar quantity of interest at some time, e.g. f(et) = ...\nudqdec: Name of the routine that computes whether the scalar quantity is decreasing, e.g. g(f, et) = ...\nrelate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the geometric quantity value and a number\nrefval: Value used as reference for scalar quantity condition\nadjust: Allowed variation for absolute extremal geometric conditions\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: SPICE window to which the search is restricted\nresult: SPICE window containing results\n\nOutput\n\nReturns result.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gipool-Tuple{Any}","page":"API","title":"SPICE.gipool","text":"gipool(name; start=1, room=100)\n\nReturn the value of a kernel variable from the kernel pool.\n\nArguments\n\nname: Name of the variable whose value is to be returned\nstart: Which component to start retrieving for name (default: 1)\nroom: The largest number of values to return (default: 100)\n\nOutput\n\nReturns an array of values if the variable exists or nothing if not.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gnpool","page":"API","title":"SPICE.gnpool","text":"gnpool(name, start, room, lenout=128)\n\nReturn names of kernel variables matching a specified template.\n\nArguments\n\nname: Template that names should match\nstart: Index of first matching name to retrieve\nroom: The largest number of values to return\nlenout: Length of strings in output array kvars (default: 128)\n\nOutput\n\nReturns lernel pool variables whose names match name.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.halfpi","page":"API","title":"SPICE.halfpi","text":"halfpi()\n\nwarning: Deprecated\nUse π/2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.hrmint-Tuple{Any, Any, Any}","page":"API","title":"SPICE.hrmint","text":"hrmint(xvals, yvals, x)\n\nEvaluate a Hermite interpolating polynomial at a specified abscissa value.\n\nArguments\n\nxvals: Abscissa values\nyvals: Ordinate and derivative values\nx: Point at which to interpolate the polynomial\n\nOutput\n\nf: Interpolated function value at x\ndf: Interpolated function's derivative at x\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.hx2dp-Tuple{Any}","page":"API","title":"SPICE.hx2dp","text":"hx2dp(str)\n\nConvert a string representing a double precision number in a base 16 \"scientific notation\" into its equivalent double precision number.\n\nArguments\n\nstr: Hex form string to convert to double precision\n\nOutput\n\ndp: Double precision value to be returned\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.illumf-NTuple{8, Any}","page":"API","title":"SPICE.illumf","text":"illumf(method, target, ilusrc, et, fixref, abcorr, obsrvr, spoint)\n\nCompute the illumination angles - phase, incidence, and emission - at a specified point on a target body. Return logical flags indicating whether the surface point is visible from the observer's position and whether the surface point is illuminated.\n\nThe target body's surface is represented using topographic data provided by DSK files, or by a reference ellipsoid.\n\nThe illumination source is a specified ephemeris object.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\nilusrc: Name of illumination source\net: Epoch in TDB seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction flag\nobsrvr: Name of observing body\nspoint: Body-fixed coordinates of a target surface point\n\nOutput\n\ntrgepc: Target surface point epoch\nsrfvec: Vector from observer to target surface point\nphase: Phase angle at the surface point\nincdnc: Source incidence angle at the surface point\nemissn: Emission angle at the surface point\nvisibl: Visibility flag (true if visible)\nlit: Illumination flag (true if illuminated)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.illumg-NTuple{7, Any}","page":"API","title":"SPICE.illumg","text":"illumg(method, target, ilusrc, et, fixref, obsrvr, spoint, abcorr)\n\nFind the illumination angles (phase, incidence, and emission) at a specified surface point of a target body.\n\nThe surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.\n\nThe illumination source is a specified ephemeris object.\n\nArguments\n\nmethod: Computation method.\ntarget: Name of target body.\nilusrc: Name of illumination source.\net: Epoch in ephemeris seconds past J2000 TDB.\nfixref: Body-fixed, body-centered target body frame.\nobsrvr: Name of observing body.\nspoint: Body-fixed coordinates of a target surface point.\nabcorr: Aberration correction.\n\nOutput\n\ntrgepc: Sub-solar point epoch.\nsrfvec: Vector from observer to sub-solar point.\nphase: Phase angle at the surface point.\nincdnc: Solar incidence angle at the surface point.\nemissn: Emission angle at the surface point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ilumin-NTuple{6, Any}","page":"API","title":"SPICE.ilumin","text":"ilumin(method, target, et, fixref, obsrvr, spoint, abcorr)\n\nFind the illumination angles (phase, solar incidence, and emission) at a specified surface point of a target body.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in ephemeris seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nobsrvr: Name of observing body\nspoint: Body-fixed coordinates of a target surface point\nabcorr: Aberration correction\n\nOutput\n\ntrgepc: Sub-solar point epoch\nsrfvec: Vector from observer to sub-solar point\nphase: Phase angle at the surface point\nincdnc: Solar incidence angle at the surface point\nemissn: Emission angle at the surface point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.inedpl-NTuple{4, Any}","page":"API","title":"SPICE.inedpl","text":"inedpl(a, b, c, plane)\n\nFind the intersection of a triaxial ellipsoid and a plane.\n\nArguments\n\na: Length of ellipsoid semi-axis lying on the x-axis\nb: Length of ellipsoid semi-axis lying on the y-axis\nc: Length of ellipsoid semi-axis lying on the z-axis\nplane: Plane that intersects ellipsoid\n\nOutput\n\nellipse: Intersection ellipse\n\nReturns nothing if no ellipse could be found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.inelpl-Tuple{Any, Any}","page":"API","title":"SPICE.inelpl","text":"inelpl(ellips, plane)\n\nFind the intersection of an ellipse and a plane.\n\nArguments\n\nellips: An ellipse\nplane: A plane\n\nOutput\n\nnxpts: Number of intersection points of ellipse and plane\nxpt1, xpt2: Intersection points\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.inrypl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.inrypl","text":"inrypl(vertex, dir, plane)\n\nFind the intersection of a ray and a plane.\n\nArguments\n\nvertex, dir: Vertex and direction vector of ray\nplane: A plane\n\nOutput\n\nnxpts: Number of intersection points of ray and plane\nxpt1, xpt2: Intersection points\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.insrtc!-Tuple{Any, Any}","page":"API","title":"SPICE.insrtc!","text":"insrtc!(set, item)\n\nInsert an item into a character set.\n\nArguments\n\nset: Insertion set\nitem: Item to be inserted\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.insrtd!-Tuple{Any, Any}","page":"API","title":"SPICE.insrtd!","text":"insrtd!(set, item)\n\nInsert an item into a double set.\n\nArguments\n\nset: Insertion set\nitem: Item to be inserted\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.insrti!-Tuple{Any, Any}","page":"API","title":"SPICE.insrti!","text":"insrti!(set, item)\n\nInsert an item into an integer set.\n\nArguments\n\nset: Insertion set\nitem: Item to be inserted\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.inter-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, SPICE.SpiceCell{T}}} where T","page":"API","title":"SPICE.inter","text":"inter(a, b)\n\nIntersect two sets of any data type to form a third set.\n\nArguments\n\na: First input set\nb: Second input set\n\nOutput\n\nReturns intersection of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.intmax","page":"API","title":"SPICE.intmax","text":"intmax()\n\nwarning: Deprecated\nUse typemax(Cint) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.intmin","page":"API","title":"SPICE.intmin","text":"intmin()\n\nwarning: Deprecated\nUse typemin(Cint) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.invert","page":"API","title":"SPICE.invert","text":"invert(matrix)\n\nwarning: Deprecated\nUse inv(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.invort","page":"API","title":"SPICE.invort","text":"invort(matrix)\n\nwarning: Deprecated\nUse inv(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.isordv","page":"API","title":"SPICE.isordv","text":"isordv(vec)\n\nwarning: Deprecated\nUse isperm(vec) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.isrchc","page":"API","title":"SPICE.isrchc","text":"isrchc(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.isrchd","page":"API","title":"SPICE.isrchd","text":"isrchd(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.isrchi","page":"API","title":"SPICE.isrchi","text":"isrchi(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.isrot-Tuple{Any, Any, Any}","page":"API","title":"SPICE.isrot","text":"isrot(m, ntol, dtol)\n\nIndicate whether a 3x3 matrix is a rotation matrix.\n\nArguments\n\nm: A matrix to be tested\nntol: Tolerance for the norms of the columns of m\ndtol: Tolerance for the determinant of a matrix whose columns are the unitized columns of m\n\nOutput\n\nReturns true if m is a rotation matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.iswhsp","page":"API","title":"SPICE.iswhsp","text":"iswhsp(str)\n\nwarning: Deprecated\nUse isempty(strip(str)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.j1900-Tuple{}","page":"API","title":"SPICE.j1900","text":"j1900()\n\nReturns the Julian Date of 1899 DEC 31 12:00:00 (1900 JAN 0.5).\n\nhttps://naif.jpl.nasa.gov/pub/naif/toolkitdocs/C/cspice/j1900c.html\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.j1950-Tuple{}","page":"API","title":"SPICE.j1950","text":"j1950()\n\nReturns the Julian Date of 1950 JAN 01 00:00:00 (1950 JAN 1.0).\n\nhttps://naif.jpl.nasa.gov/pub/naif/toolkitdocs/C/cspice/j1950c.html\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.j2000-Tuple{}","page":"API","title":"SPICE.j2000","text":"j2000()\n\nReturns the Julian Date of 2000 JAN 01 12:00:00 (2000 JAN 1.5).\n\nhttps://naif.jpl.nasa.gov/pub/naif/toolkitdocs/C/cspice/j2000c.html\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.j2100-Tuple{}","page":"API","title":"SPICE.j2100","text":"j2100()\n\nReturns the Julian Date of 2100 JAN 01 12:00:00 (2100 JAN 1.5).\n\nhttps://naif.jpl.nasa.gov/pub/naif/toolkitdocs/C/cspice/j2100c.html\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.jyear-Tuple{}","page":"API","title":"SPICE.jyear","text":"jyear()\n\nReturns the number of seconds per Julian year.\n\nhttps://naif.jpl.nasa.gov/pub/naif/toolkitdocs/C/cspice/jyearc.html\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.kclear-Tuple{}","page":"API","title":"SPICE.kclear","text":"kclear()\n\nClear the KEEPER subsystem: unload all kernels, clear the kernel pool, and re-initialize the subsystem. Existing watches on kernel variables are retained.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.kdata","page":"API","title":"SPICE.kdata","text":"kdata(which, kind, fillen=1024, srclen=256)\n\nReturn data for the n-th kernel that is among a list of specified kernel types.\n\nArguments\n\nwhich: Index of kernel to fetch from the list of kernels\nkind: The kind of kernel to which fetches are limited\nfillen: Available space in output file string\nsrclen: Available space in output source string\n\nOutput\n\nReturns nothing if no kernel was found or a tuple consisting of\n\nfile: The name of the kernel file\nfiltyp: The type of the kernel\nsource: Name of the source file used to load file\nhandle: The handle attached to file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.kinfo","page":"API","title":"SPICE.kinfo","text":"kinfo(file, srclen=256)\n\nArguments\n\nfile: Name of a kernel to fetch information for\nsrclen: Available space in output source string\n\nOutput\n\nReturns nothing if no kernel was found or a tuple consisting of\n\nfiltyp: The type of the kernel\nsource: Name of the source file used to load file\nhandle: The handle attached to file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.kplfrm","page":"API","title":"SPICE.kplfrm","text":"kplfrm(frmcls)\n\nReturn a SPICE set containing the frame IDs of all reference frames of a given class having specifications in the kernel pool.\n\nArguments\n\nfrmcls: Frame class\nsize: Size of the output set\n\nOutput\n\nReturns the set of ID codes of frames of the specified class.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ktotal-Tuple{Any}","page":"API","title":"SPICE.ktotal","text":"ktotal(kind)\n\nReturn the current number of kernels that have been loaded via the KEEPER interface that are of a specified type.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.kxtrct","page":"API","title":"SPICE.kxtrct","text":"kxtrct(keywd, terms, string)\n\nLocate a keyword in a string and extract the substring from the beginning of the first word following the keyword to the beginning of the first subsequent recognized terminator of a list.\n\nArguments\n\nkeywd: Word that marks the beginning of text of interest\nterms: Set of words, any of which marks the end of text\nstring: String containing a sequence of words\n\nOutput\n\nReturns nothing if keywd was found or a tuple consisting of\n\nstring: The input string with the text of interest removed\nsubstr: String from end of keywd to beginning of first terms item found\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lastnb","page":"API","title":"SPICE.lastnb","text":"lastnb(str)\n\nwarning: Deprecated\nUse findprev(!isspace, str, length(str)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.latcyl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.latcyl","text":"latcyl(radius, lon, lat)\n\nConvert from latitudinal coordinates to cylindrical coordinates.\n\nArguments\n\nradius: Distance of a point from the origin\nlon: Angle of the point from the XZ plane in radians\nlat: Angle of the point from the XY plane in radians\n\nOutput\n\nReturn the tuple (r, lonc, z).\n\nr: Distance of the point from the z axis\nlonc: Angle of the point from the XZ plane in radians. 'lonc' is set equal to 'lon'\nz: Height of the point above the XY plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.latrec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.latrec","text":"latrec(radius, lon, lat)\n\nConvert from latitudinal coordinates to rectangular coordinates.\n\nArguments\n\nradius: Distance of a point from the origin\nlon: Angle of the point from the XZ plane in radians\nlat: Angle of the point from the XY plane in radians\n\nOutput\n\nReturn the rectangular coordinates vector of the point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.latsph-Tuple{Any, Any, Any}","page":"API","title":"SPICE.latsph","text":"latsph(radius, lon, lat)\n\nConvert from latitudinal coordinates to spherical coordinates.\n\nArguments\n\nradius: Distance of a point from the origin\nlon: Angle of the point from the XZ plane in radians\nlat: Angle of the point from the XY plane in radians\n\nOutput\n\nReturn the tuple (rho, colat, lons).\n\nrho: Distance of the point from the origin\ncolat: Angle of the point from positive z axis (radians)\nlons: Angle of the point from the XZ plane (radians)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.latsrf-NTuple{5, Any}","page":"API","title":"SPICE.latsrf","text":"latsrf(method, target, et, fixref, npts, lonlat)\n\nMap array of planetocentric longitude/latitude coordinate pairs to surface points on a specified target body.\n\nThe surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in TDB seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nlonlat: Array of longitude/latitude coordinate pairs\n\nOutput\n\nReturns an array of surface points.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lcase","page":"API","title":"SPICE.lcase","text":"lcase(in)\n\nwarning: Deprecated\nUse lowercase(in) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ldpool-Tuple{Any}","page":"API","title":"SPICE.ldpool","text":"ldpool(kernel)\n\nLoad the variables contained in a NAIF ASCII kernel file into the kernel pool.\n\nArguments\n\nkernel: Name of the kernel file\n\nOutput\n\nNone\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lgrind-Tuple{Any, Any, Any}","page":"API","title":"SPICE.lgrind","text":"lgrind(xvals, yvals, x)\n\nEvaluate a Lagrange interpolating polynomial for a specified set of coordinate pairs, at a specified abscissa value. Return the value of both polynomial and derivative.\n\nArguments\n\nxvals: Abscissa values of coordinate pairs\nyvals: Ordinate values of coordinate pairs\nx: Point at which to interpolate the polynomial\n\nOutput\n\np: The value at x of the unique polynomial of degree n-1 that fits the points in the plane defined by xvals and yvals\ndp: The derivative at x of the interpolating polynomial described above\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.limbpt-NTuple{13, Any}","page":"API","title":"SPICE.limbpt","text":"limbpt(method, target, et, fixref, abcorr, corloc, obsrvr, refvec, rolstp, ncuts, schstp,\n soltol, maxn)\n\nFind limb points on a target body. The limb is the set of points of tangency on the target of rays emanating from the observer. The caller specifies half-planes bounded by the observer-target center vector in which to search for limb points.\n\nThe surface of the target body may be represented either by a triaxial ellipsoid or by topographic data.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in ephemeris seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction\ncorloc: Aberration correction locus\nobsrvr: Name of observing body\nrefvec: Reference vector for cutting half-planes\nrolstp: Roll angular step for cutting half-planes\nncuts: Number of cutting half-planes\nschstp: Angular step size for searching\nsoltol: Solution convergence tolerance\nmaxn: Maximum number of entries in output arrays\n\nOutput\n\nReturns the tuple (npts, points, epochs, tangts).\n\nnpts: Counts of limb points corresponding to cuts\npoints: Limb points\nepochs: Times associated with limb points\ntangts: Tangent vectors emanating from the observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lmpool-Tuple{Any}","page":"API","title":"SPICE.lmpool","text":"lmpool(cvals)\n\nLoad the variables contained in an internal buffer into the kernel pool.\n\nArguments\n\ncvals: An array that contains a SPICE text kernel\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lparse","page":"API","title":"SPICE.lparse","text":"lparse(list, delim, nmax)\n\nwarning: Deprecated\nUse split(list, delim, limit=nmax) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lparsm","page":"API","title":"SPICE.lparsm","text":"lparsm(list, delims, nmax)\n\nwarning: Deprecated\nUse split(list, delim, limit=nmax, keepempty=false) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lparss","page":"API","title":"SPICE.lparss","text":"lparss(list, delims)\n\nwarning: Deprecated\nUse Set(split(list, collect(delim))) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lspcn-Tuple{Any, Any, Any}","page":"API","title":"SPICE.lspcn","text":"lspcn(body, et, abcorr)\n\nCompute L_s, the planetocentric longitude of the sun, as seen from a specified body.\n\nArguments\n\nbody: Name of the central body\net: Epoch in seconds past J2000 TDB\nabcorr: Aberration correction\n\nOutput\n\nReturns the planetocentric longitude of the sun for the specified body at the specified time in radians.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lstlec","page":"API","title":"SPICE.lstlec","text":"lstlecd(x, array)\n\nwarning: Deprecated\nUse findfirst(item .<= array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lstled","page":"API","title":"SPICE.lstled","text":"lstle[di](x, array)\n\nwarning: Deprecated\nUse searchsortedlast(array, x) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lstltc","page":"API","title":"SPICE.lstltc","text":"lstltcd(x, array)\n\nwarning: Deprecated\nUse findfirst(item .< array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lstltd","page":"API","title":"SPICE.lstltd","text":"lstlt[di](x, array)\n\nwarning: Deprecated\nUse searchsortedlast(array, x, lt=<=) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ltime-NTuple{4, Any}","page":"API","title":"SPICE.ltime","text":"ltime(etobs, obs, dir, targ)\n\nThis routine computes the transmit (or receive) time of a signal at a specified target, given the receive (or transmit) time at a specified observer. The elapsed time between transmit and receive is also returned.\n\nArguments\n\netobs: Epoch of a signal at some observer\nobs: NAIF ID of some observer\ndir: Direction the signal travels ( \"->\" or \"<-\" )\ntarg: Time between transmit and receipt of the signal\n\nOutput\n\nettarg: Epoch of the signal at the target\nobs: NAIF ID of some observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lx4dec-Tuple{Any, Any}","page":"API","title":"SPICE.lx4dec","text":"lx4dec(string, first)\n\nScan a string from a specified starting position for the end of a decimal number.\n\nArguments\n\nstring: Any character string\nfirst: First character to scan from in string\n\nOutput\n\nlast: Last character that is part of a decimal number. If there is no such character, last will be returned with the value first-1.\nnchar: Number of characters in the decimal number\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lx4num-Tuple{Any, Any}","page":"API","title":"SPICE.lx4num","text":"lx4num(string, first)\n\nScan a string from a specified starting position for the end of a number.\n\nArguments\n\nstring: Any character string\nfirst: First character to scan from in string\n\nOutput\n\nlast: Last character that is part of a number. If there is no such character, last will be returned with the value first-1.\nnchar: Number of characters in the number\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lx4sgn-Tuple{Any, Any}","page":"API","title":"SPICE.lx4sgn","text":"lx4sgn(string, first)\n\nScan a string from a specified starting position for the end of a signed integer.\n\nArguments\n\nstring: Any character string\nfirst: First character to scan from in string\n\nOutput\n\nlast: Last character that is part of a signed integer. If there is no such character, last will be returned with the value first-1.\nnchar: Number of characters in the signed integer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lx4uns-Tuple{Any, Any}","page":"API","title":"SPICE.lx4uns","text":"lx4uns(string, first)\n\nScan a string from a specified starting position for the end of a unsigned integer.\n\nArguments\n\nstring: Any character string\nfirst: First character to scan from in string\n\nOutput\n\nlast: Last character that is part of an unsigned integer. If there is no such character, last will be returned with the value first-1.\nnchar: Number of characters in the unsigned integer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lxqstr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.lxqstr","text":"lxqstr(string, qchar, first)\n\nLex (scan) a quoted string.\n\nArguments\n\nstring: String to be scanned\nqchar: Quote delimiter character\nfirst: Character position at which to start scanning\n\nOutput\n\nlast: Character position of end of token\nnchar: Number of characters in token\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.m2eul-NTuple{4, Any}","page":"API","title":"SPICE.m2eul","text":"m2eul(r, axis3, axis2, axis1)\n\nFactor a rotation matrix as a product of three rotations about specified coordinate axes.\n\nArguments\n\nr: A rotation matrix to be factored\naxis3: Number of the third rotation axis\naxis2: Number of the second rotation axis\naxis1: Number of the first rotation axis\n\nOutput\n\nA tuple consisting of the third, second, and first Euler angles in radians.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.m2q-Tuple{Any}","page":"API","title":"SPICE.m2q","text":"m2q(r)\n\nFind a unit quaternion corresponding to a specified rotation matrix.\n\nArguments\n\nr: A rotation matrix\n\nOutput\n\nA unit quaternion representing `r'\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.matchi-NTuple{4, Any}","page":"API","title":"SPICE.matchi","text":"matchi(string, templ, wstr, wchar)\n\nDetermine whether a string is matched by a template containing wild cards. The pattern comparison is case-insensitive.\n\nArguments\n\nstring: String to be tested\ntempl: Template (with wild cards) to test against string\nwstr: Wild string token\nwchr: Wild character token\n\nOutput\n\nReturns true if the string matches.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.matchw-NTuple{4, Any}","page":"API","title":"SPICE.matchw","text":"matchw(string, templ, wstr, wchar)\n\nDetermine whether a string is matched by a template containing wild cards.\n\nArguments\n\nstring: String to be tested\ntempl: Template (with wild cards) to test against string\nwstr: Wild string token\nwchr: Wild character token\n\nOutput\n\nReturns true if the string matches.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.maxd","page":"API","title":"SPICE.maxd","text":"maxd(args...)\n\nwarning: Deprecated\nUse max(args...) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.maxi","page":"API","title":"SPICE.maxi","text":"maxi(args...)\n\nwarning: Deprecated\nUse max(args...) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mequ","page":"API","title":"SPICE.mequ","text":"mequ(m1, mout)\n\nwarning: Deprecated\nUse mout .= m1 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mequg","page":"API","title":"SPICE.mequg","text":"mequg(m1, mout)\n\nwarning: Deprecated\nUse mout .= m1 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mind","page":"API","title":"SPICE.mind","text":"mind(args...)\n\nwarning: Deprecated\nUse min(args...) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mini","page":"API","title":"SPICE.mini","text":"mini(args...)\n\nwarning: Deprecated\nUse min(args...) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mtxm","page":"API","title":"SPICE.mtxm","text":"mtxm(m1, m2)\n\nwarning: Deprecated\nUse m1' * m2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mtxmg","page":"API","title":"SPICE.mtxmg","text":"mtxmg(m1, m2)\n\nwarning: Deprecated\nUse m1' * m2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mtxv","page":"API","title":"SPICE.mtxv","text":"mtxv(m1,v2)\n\nwarning: Deprecated\nUse m1' * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mtxvg","page":"API","title":"SPICE.mtxvg","text":"mtxvg(m1,v2)\n\nwarning: Deprecated\nUse m1' * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxm","page":"API","title":"SPICE.mxm","text":"mxm(m1, m2)\n\nwarning: Deprecated\nUse m1 * m2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxmg","page":"API","title":"SPICE.mxmg","text":"mxmg(m1, m2)\n\nwarning: Deprecated\nUse m1 * m2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxmt","page":"API","title":"SPICE.mxmt","text":"mxmt(m1, m2)\n\nwarning: Deprecated\nUse m1 * m2' instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxmtg","page":"API","title":"SPICE.mxmtg","text":"mxmtg(m1, m2)\n\nwarning: Deprecated\nUse m1 * m2' instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxv","page":"API","title":"SPICE.mxv","text":"mxv(m1,v2)\n\nwarning: Deprecated\nUse m1 * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxvg","page":"API","title":"SPICE.mxvg","text":"mxvg(m1,v2)\n\nwarning: Deprecated\nUse m1 * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.namfrm-Tuple{Any}","page":"API","title":"SPICE.namfrm","text":"namfrm(frname)\n\nLook up the frame ID code associated with a string.\n\nArguments\n\nfrname: The name of some reference frame\n\nOutput\n\nThe SPICE ID code of the frame.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ncpos-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ncpos","text":"ncpos(str, chars, start)\n\nFind the first occurrence in a string of a character NOT belonging to a collection of characters, starting at a specified location, searching forward.\n\nArguments\n\nstr: A string\nchars: A collection of characters\nstart: Position to begin looking for a character not in chars\n\nOutput\n\nReturns the index of the first character of str at or following index start that is not in the collection chars.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ncposr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ncposr","text":"ncposr(str, chars, start)\n\nFind the first occurrence in a string of a character NOT belonging to a collection of characters, starting at a specified location, searching in reverse.\n\nArguments\n\nstr: A string\nchars: A collection of characters\nstart: Position to begin looking for a character not in chars\n\nOutput\n\nReturns the index of the last character of str at or before index start that is not in the collection chars.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.nearpt-NTuple{4, Any}","page":"API","title":"SPICE.nearpt","text":"nearpt(positn, a, b, c)\n\nThis routine locates the point on the surface of an ellipsoid that is nearest to a specified position. It also returns the altitude of the position above the ellipsoid.\n\nArguments\n\npositn: Position of a point in the bodyfixed frame\na: Length of semi-axis parallel to x-axis\nb: Length of semi-axis parallel to y-axis\nc: Length on semi-axis parallel to z-axis\n\nOutput\n\nReturns a tuple consisting of npoint and alt.\n\nnpoint: Point on the ellipsoid closest to positn\nalt: Altitude of positn above the ellipsoid\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.npedln-NTuple{5, Any}","page":"API","title":"SPICE.npedln","text":"npedln(a, b, c, linept, linedr)\n\nFind nearest point on a triaxial ellipsoid to a specified line, and the distance from the ellipsoid to the line.\n\nArguments\n\na: Length of semi-axis in the x direction\nb: Length of semi-axis in the y direction\nc: Length of semi-axis in the z direction\nlinept: Point on line\nlinedr: Direction vector of line\n\nOutput\n\nReturns a tuple consisting of pnear and dist.\n\npnear: Nearest point on ellipsoid to line\ndist: Distance of ellipsoid from line\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.npelpt-Tuple{Any, Any}","page":"API","title":"SPICE.npelpt","text":"npelpt(point, ellips)\n\nFind the nearest point on an ellipse to a specified point, both in three-dimensional space, and find the distance between the ellipse and the point.\n\nArguments\n\npoint: Point whose distance to an ellipse is to be found\nellips: A SPICE ellipse\n\nOutput\n\nReturns a tuple consisting of pnear and dist.\n\npnear: Nearest point on ellipse to input point\ndist: Distance of input point to ellipse\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.nplnpt-Tuple{Any, Any, Any}","page":"API","title":"SPICE.nplnpt","text":"nplnpt(linept, linedr, point)\n\nFind the nearest point on a line to a specified point, and find the distance between the two points.\n\nArguments\n\nlinept: Point on line\nlinedr: Direction vector of line\npoint: A second point\n\nOutput\n\nReturns a tuple consisting of pnear and dist.\n\npnear: Nearest point on the line to point\ndist: Distance between point and pnear\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.nvc2pl-Tuple{Any, Any}","page":"API","title":"SPICE.nvc2pl","text":"nvc2pl(norm, point)\n\nMake a SPICE plane from a normal vector and a point.\n\nArguments\n\nnorm: A normal vector...\nconstant: ...and a constant defining a plane\n\nOutput\n\nReturns a struct representing the plane.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.nvp2pl-Tuple{Any, Any}","page":"API","title":"SPICE.nvp2pl","text":"nvp2pl(norm, point)\n\nMake a SPICE plane from a normal vector and a point.\n\nArguments\n\nnorm: A normal vector...\npoint: ...and a point defining a plane\n\nOutput\n\nReturns a struct representing the plane.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.occult-NTuple{9, Any}","page":"API","title":"SPICE.occult","text":"occult(targ1, shape1, frame1, targ2, shape2, frame2, abcorr, obsrvr, et)\n\nDetermines the occultation condition (not occulted, partially, etc.) of one target relative to another target as seen by an observer at a given time.\n\nThe surfaces of the target bodies may be represented by triaxial ellipsoids or by topographic data provided by DSK files.\n\nArguments\n\ntarg1: Name or ID of first target.\nshape1: Type of shape model used for first target.\nframe1: Body-fixed, body-centered frame for first body.\ntarg2: Name or ID of second target.\nshape2: Type of shape model used for second target.\nframe2: Body-fixed, body-centered frame for second body.\nabcorr: Aberration correction flag.\nobsrvr: Name or ID of the observer.\net: Time of the observation (seconds past J2000).\n\nOutput\n\nReturns the occultation identification code.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ordc-Tuple{Any, Any}","page":"API","title":"SPICE.ordc","text":"ordc(set, item)\n\nThe function returns the ordinal position of any given item in a character set.\n\nArguments\n\nset: A set to search for a given item\nitem: An item to locate within a set\n\nOutput\n\nReturns the ordinal position or nothing if the items does not appear in the set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ordd-Tuple{Any, Any}","page":"API","title":"SPICE.ordd","text":"ordd(set, item)\n\nThe function returns the ordinal position of any given item in a character set.\n\nArguments\n\nset: A set to search for a given item\nitem: An item to locate within a set\n\nOutput\n\nReturns the ordinal position or nothing if the items does not appear in the set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.orderc","page":"API","title":"SPICE.orderc","text":"orderc(array)\n\nwarning: Deprecated\nUse sortperm instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.orderd","page":"API","title":"SPICE.orderd","text":"orderd(array)\n\nwarning: Deprecated\nUse sortperm instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.orderi","page":"API","title":"SPICE.orderi","text":"orderi(array)\n\nwarning: Deprecated\nUse sortperm instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ordi-Tuple{Any, Any}","page":"API","title":"SPICE.ordi","text":"ordi(set, item)\n\nThe function returns the ordinal position of any given item in a character set.\n\nArguments\n\nset: A set to search for a given item\nitem: An item to locate within a set\n\nOutput\n\nReturns the ordinal position or nothing if the items does not appear in the set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.oscelt-Tuple{Any, Any, Any}","page":"API","title":"SPICE.oscelt","text":"oscelt(state, et, mu)\n\nDetermine the set of osculating conic orbital elements that corresponds to the state (position, velocity) of a body at some epoch.\n\nArguments\n\nstate: State of body at epoch of elements\net: Epoch of elements\nmu: Gravitational parameter (GM) of primary body\n\nOutput\n\nReturns the equivalent conic elements:\n\nrp: Perifocal distance\necc: Eccentricity\ninc: Inclination\nlnode: Longitude of the ascending node\nargp: Argument of periapsis\nm0: Mean anomaly at epoch\nt0: Epoch\nmu: Gravitational parameter\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.oscltx-Tuple{Any, Any, Any}","page":"API","title":"SPICE.oscltx","text":"oscltx(state, et, mu)\n\nDetermine the set of osculating conic orbital elements that corresponds to the state (position, velocity) of a body at some epoch. In addition to the classical elements, return the true anomaly, semi-major axis, and period, if applicable.\n\nArguments\n\nstate: State of body at epoch of elements\net: Epoch of elements\nmu: Gravitational parameter (GM) of primary body\n\nOutput\n\nReturns the extended set of classical conic elements:\n\nrp: Perifocal distance.\necc: Eccentricity.\ninc: Inclination.\nlnode: Longitude of the ascending node.\nargp: Argument of periapsis.\nm0: Mean anomaly at epoch.\nt0: Epoch.\nmu: Gravitational parameter.\nnu: True anomaly at epoch.\na: Semi-major axis. A is set to zero if it is not computable.\ntau: Orbital period. Applicable only for elliptical orbits. Set to zero otherwise.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckcls-Tuple{Any}","page":"API","title":"SPICE.pckcls","text":"pckcls(handle)\n\nClose an open PCK file.\n\nArguments\n\nhandle: Handle of the PCK file to be closed\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckcov!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.pckcov!","text":"pckcov!(cover, pck, idcode)\n\nFind the coverage window for a specified reference frame in a specified binary PCK file.\n\nArguments\n\ncover: An initalized window SpiceDoubleCell\npck: Path of PCK file\nidcode: Class ID code of PCK reference frame\n\nOutput\n\nReturns cover containing coverage in pck for idcode\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckfrm!-Tuple{Any, Any}","page":"API","title":"SPICE.pckfrm!","text":"pckfrm!(ids, pck)\n\nFind the set of reference frame class ID codes of all frames in a specified binary PCK file.\n\nArguments\n\nids: An initalized SpiceIntCell\npck: Path of PCK file\n\nOutput\n\nReturns ids containing a set of frame class ID codes of frames in PCK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pcklof-Tuple{Any}","page":"API","title":"SPICE.pcklof","text":"pcklof(filename)\n\nLoad a binary PCK file for use by the readers. Return the handle of the loaded file which is used by other PCK routines to refer to the file.\n\nArguments\n\nfilename: Path of the PCK file\n\nOutput\n\nReturns an integer handle.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckopn-Tuple{Any, Any, Any}","page":"API","title":"SPICE.pckopn","text":"pckopn(name, ifname, ncomch)\n\nCreate a new PCK file, returning the handle of the opened file.\n\nArguments\n\nname: The name of the PCK file to be opened\nifname: The internal filename for the PCK\nncomch: The number of characters to reserve for comments\n\nOutput\n\nReturns the handle of the opened PCK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckuof-Tuple{Any}","page":"API","title":"SPICE.pckuof","text":"pckuof(handle)\n\nUnload a binary PCK file so that it will no longer be searched by the readers.\n\nArguments\n\nhandle: Integer handle of a PCK file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckw02-NTuple{9, Any}","page":"API","title":"SPICE.pckw02","text":"pckw02(handle, clssid, frame, first, last, segid, intlen, cdata, btime)\n\nWrite a type 2 segment to a PCK binary file given the file handle, frame class ID, base frame, time range covered by the segment, and the Chebyshev polynomial coefficients.\n\nArguments\n\nhandle: Handle of binary PCK file open for writing.\nclssid: Frame class ID of body-fixed frame.\nframe: Name of base reference frame.\nfirst: Start time of interval covered by segment.\nlast: End time of interval covered by segment.\nsegid: Segment identifier.\nintlen: Length of time covered by logical record.\ncdata: Array of Chebyshev coefficients.\nbtime: Begin time of first logical record.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pcpool-Tuple{Any, Any}","page":"API","title":"SPICE.pcpool","text":"pcpool(name, vals)\n\nInsert character data into the kernel pool.\n\nArguments\n\nname: The kernel pool name to associate with vals\nvals: An array of values to insert into the kernel pool\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pdpool-Tuple{Any, Any}","page":"API","title":"SPICE.pdpool","text":"pdpool(name, vals)\n\nInsert double precision data into the kernel pool.\n\nArguments\n\nname: The kernel pool name to associate with vals\nvals: An array of values to insert into the kernel pool\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pgrrec-NTuple{6, Any}","page":"API","title":"SPICE.pgrrec","text":"pgrrec(body, lon, lat, alt, re, f)\n\nConvert planetographic coordinates to rectangular coordinates.\n\nArguments\n\nbody: Body with which coordinate system is associated.\nlon: Planetographic longitude of a point (radians).\nlat: Planetographic latitude of a point (radians).\nalt: Altitude of a point above reference spheroid.\nre: Equatorial radius of the reference spheroid.\nf: Flattening coefficient.\n\nOutput\n\nReturns the rectangular coordinates of the point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.phaseq-NTuple{5, Any}","page":"API","title":"SPICE.phaseq","text":"phaseq(et, target, illmn, obsrvr, abcorr)\n\nCompute the apparent phase angle for a target, observer, illuminator set of ephemeris objects.\n\nArguments\n\net: Ephemeris seconds past J2000 TDB\ntarget: Target body name\nillmn: Illuminating body name\nobsrvr: Observer body\nabcorr: Aberration correction flag\n\nOutput\n\nReturns the value of the phase angle.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pipool-Tuple{Any, Any}","page":"API","title":"SPICE.pipool","text":"pipool(name, ivals)\n\nInsert integer data into the kernel pool.\n\nArguments\n\nname: The kernel pool name to associate with the values\nivals: An array of integers to insert into the pool\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pjelpl-Tuple{Any, Any}","page":"API","title":"SPICE.pjelpl","text":"pjelpl(elin, plane)\n\nProject an ellipse onto a plane, orthogonally.\n\nArguments\n\nelin: An ellipse to be projected\nplane: A plane onto which elin is to be projected\n\nOutput\n\nReturns the ellipse resulting from the projection.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pl2nvc-Tuple{Any}","page":"API","title":"SPICE.pl2nvc","text":"pl2nvc(plane)\n\nReturn a unit normal vector and constant that define a specified plane.\n\nArguments\n\nplane: A plane\n\nOutput\n\nReturns a tuple consisting of\n\nnormal: A normal vector and...\nconstant: ... constant defining the geometric plane represented by plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pl2nvp-Tuple{Any}","page":"API","title":"SPICE.pl2nvp","text":"pl2nvp(plane)\n\nReturn a unit normal vector and point that define a specified plane.\n\nArguments\n\nplane: A plane\n\nOutput\n\nReturns a tuple consisting of\n\nnormal: A normal vector and...\npoint: ... point defining the geometric plane represented by plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pl2psv-Tuple{Any}","page":"API","title":"SPICE.pl2psv","text":"pl2psv(plane)\n\nReturn a point and two orthogonal spanning vectors that define a specified plane.\n\nArguments\n\nplane: A plane\n\nOutput\n\nReturns a tuple consisting of a point in the plane and two vectors spanning the input plane.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pltar-Tuple{Any, Any}","page":"API","title":"SPICE.pltar","text":"pltar(vrtces, plates)\n\nCompute the total area of a collection of triangular plates.\n\nArguments\n\nvrtces: Array of vertices\nplates: Array of plates\n\nOutput\n\nReturns the area.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pltexp-Tuple{Any, Any}","page":"API","title":"SPICE.pltexp","text":"pltexp(iverts, delta)\n\nExpand a triangular plate by a specified amount. The expanded plate is co-planar with, and has the same orientation as, the original. The centroids of the two plates coincide.\n\nArguments\n\niverts: Vertices of the plate to be expanded\ndelta: Fraction by which the plate is to be expanded\n\nOutput\n\nReturns the vertices of the expanded plate.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pltnp-NTuple{4, Any}","page":"API","title":"SPICE.pltnp","text":"pltnp(point, v1, v2, v3)\n\nFind the nearest point on a triangular plate to a given point.\n\nArguments\n\npoint: A point in 3-dimensional space.\nv1, v2, v3: Vertices of a triangular plate\n\nOutput\n\nReturns a tuple consisting of\n\npnear: Nearest point on the plate to point\ndist: Distance between pnear and point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pltnrm-Tuple{Any, Any, Any}","page":"API","title":"SPICE.pltnrm","text":"pltnrm(v1, v2, v3)\n\nCompute an outward normal vector of a triangular plate. The vector does not necessarily have unit length.\n\nArguments\n\nv1, v2, v3: Vertices of a plate\n\nOutput\n\nReturns the plate's outward normal vector.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pltvol-Tuple{Any, Any}","page":"API","title":"SPICE.pltvol","text":"pltvol(vrtces, plates)\n\nCompute the volume of a three-dimensional region bounded by a collection of triangular plates.\n\nArguments\n\nvrtces: Array of vertices\nplates: Array of plates\n\nOutput\n\nReturns the volume of the spatial region bounded by the plates.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.polyds-Tuple{Any, Any, Any}","page":"API","title":"SPICE.polyds","text":"polyds(coeffs, nderiv, t)\n\nCompute the value of a polynomial and it's first nderiv derivatives at the value t.\n\nArguments\n\ncoeffs: Coefficients of the polynomial to be evaluated\nnderiv: Number of derivatives to compute\nt: Point to evaluate the polynomial and derivatives\n\nOutput\n\nReturns the value of the polynomial and the derivatives as an array.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pos","page":"API","title":"SPICE.pos","text":"pos(str, substr, start)\n\nwarning: Deprecated\nUse first(findnext(substr, str, start)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.posr","page":"API","title":"SPICE.posr","text":"posr(str, substr, start)\n\nwarning: Deprecated\nUse first(findprev(substr, str, start)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.prop2b-Tuple{Any, Any, Any}","page":"API","title":"SPICE.prop2b","text":"prop2b(gm, pvinit, dt)\n\nGiven a central mass and the state of massless body at time t_0, this routine determines the state as predicted by a two-body force model at time t_0 + dt.\n\nArguments\n\ngm: Gravity of the central mass.\npvinit: Initial state from which to propagate a state.\ndt: Time offset from initial state to propagate to.\n\nOutput\n\nReturns the propagated state.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.prsdp","page":"API","title":"SPICE.prsdp","text":"prsdp(str)\n\nwarning: Deprecated\nUse parse(Float64, str) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.prsint","page":"API","title":"SPICE.prsint","text":"prsint(str)\n\nwarning: Deprecated\nUse parse(Int, str) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.psv2pl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.psv2pl","text":"psv2pl(point, span1, span2)\n\nMake a plane from a point and two spanning vectors.\n\nArguments\n\npoint, span1, span2: A point and two spanning vectors defining a plane\n\nOutput\n\nReturns the plane.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pxform-Tuple{Any, Any, Any}","page":"API","title":"SPICE.pxform","text":"pxform(from, to, et)\n\nReturn the matrix that transforms position vectors from one specified frame to another at a specified epoch.\n\nArguments\n\nfrom: Name of the frame to transform from\nto: Name of the frame to transform to\net: Epoch of the rotation matrix\n\nOutput\n\nReturns the rotation matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pxfrm2-NTuple{4, Any}","page":"API","title":"SPICE.pxfrm2","text":"pxfrm2(from, to, etfrom, etto)\n\nReturn the 3x3 matrix that transforms position vectors from one specified frame at a specified epoch to another specified frame at another specified epoch.\n\nArguments\n\nfrom: Name of the frame to transform from\nto: Name of the frame to transform to\netfrom: Evaluation time of from frame\netto: Evaluation time of to frame\n\nOutput\n\nReturns a position transformation matrix from frame from to frame to.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.q2m-Tuple{Any}","page":"API","title":"SPICE.q2m","text":"q2m(q)\n\nFind the rotation matrix corresponding to a specified unit quaternion.\n\nArguments\n\nq: A unit quaternion\n\nOutput\n\nA rotation matrix corresponding to q.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.qdq2av-Tuple{Any, Any}","page":"API","title":"SPICE.qdq2av","text":"qdq2av(q, dq)\n\nDerive angular velocity from a unit quaternion and its derivative with respect to time.\n\nArguments\n\nq: Unit SPICE quaternion (as any kind of iterable with four elements)\ndq: Derivative of `q' with respect to time\n\nOutput\n\nAngular velocity vector defined by q' anddq'\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.qxq-Tuple{Any, Any}","page":"API","title":"SPICE.qxq","text":"qxq(q1, q2)\n\nMultiply two quaternions.\n\nArguments\n\nq1: First SPICE quaternion factor (as any kind of iterable with four elements)\nq2: Second SPICE quaternion factor (as any kind of iterable with four elements)\n\nOutput\n\nA quaternion corresponding to the product of q1' andq2'\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.radrec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.radrec","text":"radrec(range, ra, dec)\n\nConvert from range, right ascension, and declination to rectangular coordinates.\n\nArguments\n\nrange: Distance of a point from the origin\nra: Right ascension of point in radians\ndec: Declination of point in radians\n\nOutput\n\nReturns the rectangular coordinates of the point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.rav2xf-Tuple{Any, Any}","page":"API","title":"SPICE.rav2xf","text":"rav2xf(rot, av)\n\nDetermine a state transformation matrix from a rotation matrix and the angular velocity of the rotation.\n\nArguments\n\nrot: Rotation matrix\nav: Angular velocity vector\n\nOutput\n\nReturns state transformation matrix associated with rot and av.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.raxisa-Tuple{Any}","page":"API","title":"SPICE.raxisa","text":"raxisa(matrix)\n\nCompute the axis of the rotation given by an input matrix and the angle of the rotation about that axis.\n\nArguments\n\nmatrix: A 3x3 rotation matrix\n\nOutput\n\naxis: Axis of the rotation\nangle: Angle through which the rotation is performed\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.reccyl-Tuple{Any}","page":"API","title":"SPICE.reccyl","text":"reccyl(rectan)\n\nConvert from rectangular to cylindrical coordinates.\n\nArguments\n\nrectan: Rectangular coordinates of a point\n\nOutput\n\nr: Distance of the point from the Z axis\nlon: Angle (radians) of the point from the XZ plane\nz: Height of the point above the XY plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.recgeo-Tuple{Any, Any, Any}","page":"API","title":"SPICE.recgeo","text":"recgeo(rectan, re, f)\n\nConvert from rectangular coordinates to geodetic coordinates.\n\nArguments\n\nrectan: Rectangular coordinates of a point\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nlon: Geodetic longitude of the point (radians)\nlat: Geodetic latitude of the point (radians)\nalt: Altitude of the point above reference spheroid\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.reclat-Tuple{Any}","page":"API","title":"SPICE.reclat","text":"reclat(rectan)\n\nConvert from rectangular coordinates to latitudinal coordinates.\n\nArguments\n\nrectan: Rectangular coordinates of a point\n\nOutput\n\nReturns a tuple consisting of:\n\nrad: Distance of the point from the origin\nlon: Planetographic longitude of the point (radians)\nlat: Planetographic latitude of the point (radians)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.recpgr-NTuple{4, Any}","page":"API","title":"SPICE.recpgr","text":"recpgr(body, rectan, re, f)\n\nConvert rectangular coordinates to planetographic coordinates.\n\nArguments\n\nbody: Body with which coordinate system is associated\nrectan: Rectangular coordinates of a point\nre: Equatorial radius of the reference spheroid\nf: flattening coefficient\n\nOutput\n\nlon: Planetographic longitude of the point (radians).\nlat: Planetographic latitude of the point (radians).\nalt: Altitude of the point above reference spheroid.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.recrad-Tuple{Any}","page":"API","title":"SPICE.recrad","text":"recrad(rectan)\n\nConvert rectangular coordinates to range, right ascension, and declination.\n\nArguments\n\nrectan: Rectangular coordinates of a point\n\nOutput\n\nReturn the tuple (range, ra, dec).\n\nrange: Distance of the point from the origin\nra: Right ascension in radians\ndec: Declination in radians\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.recsph-Tuple{Any}","page":"API","title":"SPICE.recsph","text":"recsph(rectan)\n\nConvert from rectangular coordinates to spherical coordinates.\n\nArguments\n\nrectan: Rectangular coordinates of a point\n\nOutput\n\nr: Distance of the point from the origin\ncolat: Angle of the point from the Z-axis in radian\nlon: Longitude of the point in radians\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.removc!-Tuple{Any, Any}","page":"API","title":"SPICE.removc!","text":"removc!(set, item)\n\nRemove an item from a character set.\n\nArguments\n\nset: A set\nitem: Item to be removed\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.removd!-Tuple{Any, Any}","page":"API","title":"SPICE.removd!","text":"removd!(set, item)\n\nRemove an item from a double set.\n\nArguments\n\nset: A set\nitem: Item to be removed\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.removi!-Tuple{Any, Any}","page":"API","title":"SPICE.removi!","text":"removi!(set, item)\n\nRemove an item from a character set.\n\nArguments\n\nset: A set\nitem: Item to be removed\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.reordc","page":"API","title":"SPICE.reordc","text":"reordc(iorder, array)\n\nwarning: Deprecated\nUse array[iorder] instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.reordd","page":"API","title":"SPICE.reordd","text":"reordd(iorder, array)\n\nwarning: Deprecated\nUse array[iorder] instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.reordi","page":"API","title":"SPICE.reordi","text":"reordi(iorder, array)\n\nwarning: Deprecated\nUse array[iorder] instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.reordl","page":"API","title":"SPICE.reordl","text":"reordl(iorder, array)\n\nwarning: Deprecated\nUse array[iorder] instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmc","page":"API","title":"SPICE.repmc","text":"repmc(input, marker, value)\n\nwarning: Deprecated\nUse replace(input, marker=>value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmct","page":"API","title":"SPICE.repmct","text":"repmct\n\nwarning: Deprecated\nUse replace instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmd","page":"API","title":"SPICE.repmd","text":"repmd\n\nwarning: Deprecated\nUse replace instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmf","page":"API","title":"SPICE.repmf","text":"repmf\n\nwarning: Deprecated\nUse replace instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmi","page":"API","title":"SPICE.repmi","text":"repmi\n\nwarning: Deprecated\nUse replace instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmot","page":"API","title":"SPICE.repmot","text":"repmot\n\nwarning: Deprecated\nUse replace instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.rotate-Tuple{Any, Any}","page":"API","title":"SPICE.rotate","text":"rotate(angle, iaxis)\n\nCalculate the 3x3 rotation matrix generated by a rotation of a specified angle about a specified axis. This rotation is thought of as rotating the coordinate system.\n\nArguments\n\nangle: Angle of rotation (radians)\niaxis: Axis of rotation (X=1, Y=2, Z=3)\n\nOutput\n\nReturns rotation matrix associated with angle and iaxis.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.rotmat-Tuple{Any, Any, Any}","page":"API","title":"SPICE.rotmat","text":"rotmat(m1, angle, iaxis)\n\nApplies a rotation of angle radians about axis iaxis to a matrix m1. This rotation is thought of as rotating the coordinate system.\n\nArguments\n\nm1: Matrix to be rotated\nangle: Angle of rotation (radians)\niaxis: Axis of rotation (X=1, Y=2, Z=3)\n\nOutput\n\nReturns the resulting rotated matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.rotvec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.rotvec","text":"rotvec(v1, angle, iaxis)\n\nTransform a vector to a new coordinate system rotated by angle radians about axis iaxis. This transformation rotates v1 by -angle radians about the specified axis.\n\nArguments\n\nv1: Vector whose coordinate system is to be rotated\nangle: Angle of rotation in radians\niaxis: Axis of rotation (X=1, Y=2, Z=3)\n\nOutput\n\nReturns the resulting vector expressed in the new coordinate system.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.rpd","page":"API","title":"SPICE.rpd","text":"rpd()\n\nwarning: Deprecated\nUse deg2rad instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.rquad-Tuple{Any, Any, Any}","page":"API","title":"SPICE.rquad","text":"rquad(a, b, c)\n\nFind the roots of a quadratic equation.\n\nArguments\n\na: Coefficient of quadratic term\nb: Coefficient of linear term\nc: Constant\n\nOutput\n\nroot1: Root built from positive discriminant term\nroot2: Root built from negative discriminant term\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.saelgv-Tuple{Any, Any}","page":"API","title":"SPICE.saelgv","text":"saelgv(vec1, vec2)\n\nFind semi-axis vectors of an ellipse generated by two arbitrary three-dimensional vectors.\n\nArguments\n\nvec1, vec2: Two vectors used to generate an ellipse\n\nOutput\n\nsmajor: Semi-major axis of ellipse\nsminor: Semi-minor axis of ellipse\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.scard!-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, Any}} where T","page":"API","title":"SPICE.scard!","text":"scard!(cell::SpiceCell{T}, card) where T\n\nSet the cardinality of a cell.\n\nArguments\n\ncell: The cell\ncard: Cardinality of (number of elements in) the cell\n\nOutput\n\nReturns cell with its cardinality set to card.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.scdecd","page":"API","title":"SPICE.scdecd","text":"scdecd(sc, sclkdp, lenout=128)\n\nConvert double precision encoding of spacecraft clock time into a character representation.\n\nArguments\n\nsc: NAIF spacecraft identification code\nsclkdp: Encoded representation of a spacecraft clock count\nlenout: Maximum allowed length of output SCLK string\n\nOutput\n\nReturns the character representation of a clock count.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.sce2c-Tuple{Any, Any}","page":"API","title":"SPICE.sce2c","text":"sce2c(sc, et)\n\nConvert ephemeris seconds past J2000 (ET) to continuous encoded spacecraft clock (\"ticks\"). Non-integral tick values may be returned.\n\nArguments\n\nsc: NAIF spacecraft ID code\net: Ephemeris time, seconds past J2000\n\nOutput\n\nReturns SCLK, encoded as ticks since spacecraft clock start.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sce2s","page":"API","title":"SPICE.sce2s","text":"sce2s(sc, et, lenout=128)\n\nConvert an epoch specified as ephemeris seconds past J2000 (ET) to a character string representation of a spacecraft clock value (SCLK).\n\nArguments\n\nsc: NAIF spacecraft identification code\net: Ephemeris time, specified as seconds past J2000\nlenout: Maximum allowed length of output SCLK string\n\nOutput\n\nReturns an SCLK string.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.sce2t-Tuple{Any, Any}","page":"API","title":"SPICE.sce2t","text":"sce2t(sc, et)\n\nConvert ephemeris seconds past J2000 (ET) to integral encoded spacecraft clock (\"ticks\"). For conversion to fractional ticks, (required for C-kernel production), see the routine sce2c.\n\nArguments\n\nsc: NAIF spacecraft ID code\net: Ephemeris time, seconds past J2000\n\nOutput\n\nReturns SCLK, encoded as ticks since spacecraft clock start.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.scencd-Tuple{Any, Any}","page":"API","title":"SPICE.scencd","text":"scencd(sc, sclkch)\n\nEncode character representation of spacecraft clock time into a double precision number.\n\nArguments\n\nsc: NAIF spacecraft identification code\nsclkch: Character representation of a spacecraft clock\n\nOutput\n\nReturns the encoded representation of the clock count.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.scfmt","page":"API","title":"SPICE.scfmt","text":"scfmt(sc, ticks, lenout=128)\n\nConvert encoded spacecraft clock ticks to character clock format.\n\nArguments\n\nsc: NAIF spacecraft identification code\nticks: Encoded representation of a spacecraft clock count\nlenout: Maximum allowed length of output string\n\nOutput\n\nReturns a character representation of a clock count.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.scpart-Tuple{Any}","page":"API","title":"SPICE.scpart","text":"scpart(sc)\n\nGet spacecraft clock partition information from a spacecraft clock kernel file.\n\nArguments\n\nsc: NAIF spacecraft identification code\n\nOutput\n\npstart: Array of partition start times\npstop: Array of partition stop times\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.scs2e-Tuple{Any, Any}","page":"API","title":"SPICE.scs2e","text":"scs2e(sc, sclkch)\n\nConvert a spacecraft clock string to ephemeris seconds past J2000 (ET).\n\nArguments\n\nsc: NAIF integer code for a spacecraft\nsclkch: An SCLK string\n\nOutput\n\nReturns ephemeris time seconds past J2000.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sct2e-Tuple{Any, Any}","page":"API","title":"SPICE.sct2e","text":"sct2e(sc, sclkdp)\n\nConvert encoded spacecraft clock (\"ticks\") to ephemeris seconds past J2000 (ET).\n\nArguments\n\nsc: NAIF integer code for a spacecraft\nsclkdp: SCLK, encoded as ticks since spacecraft clock start.\n\nOutput\n\nReturns ephemeris time seconds past J2000.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sctiks-Tuple{Any, Any}","page":"API","title":"SPICE.sctiks","text":"sctiks(sc, clkstr)\n\nConvert a spacecraft clock format string to number of \"ticks\".\n\nArguments\n\nsc: NAIF spacecraft identification code\nclkstr: Character representation of a spacecraft clock\n\nOutput\n\nReturns the number of ticks represented by the clock string.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sdiff-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, SPICE.SpiceCell{T}}} where T","page":"API","title":"SPICE.sdiff","text":"sdiff(a::T, b::T) where T <: SpiceCell\n\nCompute the symmetric difference of two sets of any data type to form a third set.\n\nArguments\n\na: First input set\nb: Second input set\n\nOutput\n\nReturns a cell containing the symmetric difference of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.set-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, Any, SPICE.SpiceCell{T}}} where T","page":"API","title":"SPICE.set","text":"set(a::T, b::T) where T <: SpiceCell\n\nGiven a relational operator, compare two sets of any data type.\n\nArguments\n\na: First set\nop: Comparison operator\nb: Second set\n\nOutput\n\nReturns the result of the comparison: a (op) b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.shellc","page":"API","title":"SPICE.shellc","text":"shellc(array)\n\nwarning: Deprecated\nUse sort!(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.shelld","page":"API","title":"SPICE.shelld","text":"shelld(array)\n\nwarning: Deprecated\nUse sort!(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.shelli","page":"API","title":"SPICE.shelli","text":"shelli(array)\n\nwarning: Deprecated\nUse sort!(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.sincpt-NTuple{8, Any}","page":"API","title":"SPICE.sincpt","text":"sincpt(method, target, et, fixref, abcorr, obsrvr, dref, dvec)\n\nGiven an observer and a direction vector defining a ray, compute the surface intercept of the ray on a target body at a specified epoch, optionally corrected for light time and stellar aberration.\n\nThe surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in TDB seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction flag\nobsrvr: Name of observing body\ndref: Reference frame of ray's direction vector\ndvec: Ray's direction vector\n\nOutput\n\nReturns a tuple consisting of the following data or nothing if no intercept was found.\n\nspoint: Surface intercept point on the target body\ntrgepc: Intercept epoch\nsrfvec: Vector from observer to intercept point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.size_c-Tuple{Any}","page":"API","title":"SPICE.size_c","text":"size_c(cell::SpiceCell)\n\nReturns the maximum number of elements that cell can hold.\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spd-Tuple{}","page":"API","title":"SPICE.spd","text":"spd()\n\nReturns the number of seconds in a day.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sphcyl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.sphcyl","text":"sphcyl(radius, colat, slon)\n\nConverts from spherical coordinates to cylindrical coordinates.\n\nArguments\n\nradius: Distance of point from origin\ncolat: Polar angle (co-latitude in radians) of point\nslon: Azimuthal angle (longitude) of point (radians)\n\nOutput\n\nr: Distance of point from Z axis\nlon: Angle (radians) of point from XZ plane\nz: Height of point above XY plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sphlat-Tuple{Any, Any, Any}","page":"API","title":"SPICE.sphlat","text":"sphlat(r, colat, lons)\n\nConvert from spherical coordinates to latitudinal coordinates.\n\nArguments\n\nr: Distance of the point from the origin\ncolat: Angle of the point from positive z axis (radians)\nlons: Angle of the point from the XZ plane (radians)\n\nOutput\n\nradius: Distance of a point from the origin\nlon: Angle of the point from the XZ plane in radians\nlat: Angle of the point from the XY plane in radians\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sphrec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.sphrec","text":"sphrec(r, colat, lon)\n\nConvert from spherical coordinates to rectangular coordinates.\n\nArguments\n\nr: Distance of a point from the origin\ncolat: Angle of the point from the Z-axis in radians\nlon: Angle of the point from the XZ plane in radians\n\nOutput\n\nReturns the rectangular coordinates of the point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spk14a-NTuple{4, Any}","page":"API","title":"SPICE.spk14a","text":"spk14a(handle, ncsets, coeffs, epochs)\n\nAdd data to a type 14 SPK segment associated with handle. See also spk14b and spk14e.\n\nArguments\n\nhandle: The handle of an SPK file open for writing\nncsets: The number of coefficient sets and epochs\ncoeffs: The collection of coefficient sets\nepochs: The epochs associated with the coefficient sets\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spk14b-NTuple{8, Any}","page":"API","title":"SPICE.spk14b","text":"spk14b(handle, segid, body, center, frame, first, last, chbdeg)\n\nBegin a type 14 SPK segment in the SPK file associated with handle. See also spk14a and spk14e.\n\nArguments\n\nhandle: The handle of an SPK file open for writing\nsegid: The string to use for segment identifier\nbody: The NAIF ID code for the body of the segment\ncenter: The center of motion for body\nframe: The reference frame for this segment\nfirst: The first epoch for which the segment is valid\nlast: The last epoch for which the segment is valid\nchbdeg: The degree of the Chebyshev Polynomial used\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spk14e-Tuple{Any}","page":"API","title":"SPICE.spk14e","text":"spk14e(handle)\n\nEnd the type 14 SPK segment currently being written to the SPK file associated with handle. See also spk14a and spk14b.\n\nArguments\n\nhandle: The handle of an SPK file open for writing\n\nOutput\n\nReturns the handle of the SPK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkacs-NTuple{5, Any}","page":"API","title":"SPICE.spkacs","text":"spkacs(targ, et, ref, abcorr, obs, starg, lt, dlt)\n\nReturn the state (position and velocity) of a target body relative to an observer, optionally corrected for light time and stellar aberration, expressed relative to an inertial reference frame.\n\nArguments\n\ntarg: Target body\net: Observer epoch\nref: Inertial reference frame of output state\nabcorr: Aberration correction flag\nobs: Observer\n\nOutput\n\nstarg: State of target\nlt: One way light time between observer and target\ndlt: Derivative of light time with respect to time\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkapo-NTuple{5, Any}","page":"API","title":"SPICE.spkapo","text":"spkapo(targ, et, ref, sobs, abcorr)\n\nReturn the position of a target body relative to an observer, optionally corrected for light time and stellar aberration.\n\nArguments\n\ntarg: Target body\net: Observer epoch\nref: Inertial reference frame of observer's state\nsobs: State of observer wrt. solar system barycenter\nabcorr: Aberration correction flag\n\nOutput\n\nptarg: Position of target\nlt: One way light time between observer and target\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkaps-NTuple{6, Any}","page":"API","title":"SPICE.spkaps","text":"spkaps(targ, et, ref, abcorr, stobs, accobs)\n\nGiven the state and acceleration of an observer relative to the solar system barycenter, return the state (position and velocity) of a target body relative to the observer, optionally corrected for light time and stellar aberration. All input and output vectors are expressed relative to an inertial reference frame.\n\nUsers normally should call the high-level API routines spkezr or spkez rather than this routine.\n\nArguments\n\ntarg: Target body.\net: Observer epoch.\nref: Inertial reference frame of output state.\nabcorr: Aberration correction flag.\nstobs: State of the observer relative to the SSB.\naccobs: Acceleration of the observer relative to the SSB.\n\nOutput\n\nstarg: State of target.\nlt: One way light time between observer and target.\ndlt: Derivative of light time with respect to time.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcls-Tuple{Any}","page":"API","title":"SPICE.spkcls","text":"spkcls(handle)\n\nClose an open SPK file.\n\nArguments\n\nhandle: Handle of the SPK file to be closed\n\nOutput\n\nReturns the handle of the closed file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcov!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.spkcov!","text":"spkcov!(cover, spk, idcode)\n\nFind the coverage window for a specified ephemeris object in a specified SPK file.\n\nArguments\n\ncover: Window giving coverage in spk for idcode\nspk: Name of the SPK file\nidcode: ID code of ephemeris object\n\nOutput\n\nReturns the extended coverage window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcpo-NTuple{8, Any}","page":"API","title":"SPICE.spkcpo","text":"spkcpo(target, et, outref, refloc, abcorr, obspos, obsctr, obsref)\n\nReturn the state of a specified target relative to an \"observer,\" where the observer has constant position in a specified reference frame. The observer's position is provided by the calling program rather than by loaded SPK files.\n\nArguments\n\ntarget: Name of target ephemeris object\net: Observation epoch\noutref: Reference frame of output state\nrefloc: Output reference frame evaluation locus\nabcorr: Aberration correction\nobspos: Observer position relative to center of motion\nobsctr: Center of motion of observer\nobsref: Frame of observer position\n\nOutput\n\nstate: State of target with respect to observer\nlt: One way light time between target and observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcpt-NTuple{8, Any}","page":"API","title":"SPICE.spkcpt","text":"spkcpt(trgpos, trgctr, trgref, et, outref, refloc, abcorr, obsrvr)\n\nReturn the state, relative to a specified observer, of a target having constant position in a specified reference frame. The target's position is provided by the calling program rather than by loaded SPK files.\n\nArguments\n\ntrgpos: Target position relative to center of motion\ntrgctr: Center of motion of target\ntrgref: Frame of target position\net: Observation epoch\noutref: Reference frame of output state\nrefloc: Output reference frame evaluation locus\nabcorr: Aberration correction\nobsrvr: Name of observing ephemeris object\n\nOutput\n\nstate: State of target with respect to observer\nlt: One way light time between target and observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcvo-NTuple{9, Any}","page":"API","title":"SPICE.spkcvo","text":"spkcvo(target, et, outref, refloc, abcorr, obssta, obsepc, obsctr, obsref)\n\nReturn the state of a specified target relative to an \"observer,\" where the observer has constant velocity in a specified reference frame. The observer's state is provided by the calling program rather than by loaded SPK files.\n\nArguments\n\ntarget: Name of target ephemeris object\net: Observation epoch\noutref: Reference frame of output state\nrefloc: Output reference frame evaluation locus\nabcorr: Aberration correction\nobssta: Observer state relative to center of motion\nobsepc: Epoch of observer state\nobsctr: Center of motion of observer\nobsref: Frame of observer state\n\nOutput\n\nstate: State of target with respect to observer\nlt: One way light time between target and observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcvt-NTuple{9, Any}","page":"API","title":"SPICE.spkcvt","text":"spkcvt(trgsta, trgepc, trgctr, trgref, et, outref, refloc, abcorr, obsrvr)\n\nReturn the state, relative to a specified observer, of a target having constant velocity in a specified reference frame. The target's state is provided by the calling program rather than by loaded SPK files.\n\nArguments\n\ntrgsta: Target state relative to center of motion\ntrgepc: Epoch of target state\ntrgctr: Center of motion of target\ntrgref: Frame of target state\net: Observation epoch\noutref: Reference frame of output state\nrefloc: Output reference frame evaluation locus\nabcorr: Aberration correction\nobsrvr: Name of observing ephemeris object\n\nOutput\n\nstate: State of target with respect to observer\nlt: One way light time between target and observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkez-NTuple{5, Any}","page":"API","title":"SPICE.spkez","text":"spkez(targ, et, ref, abcorr, obs)\n\nReturn the state (position and velocity) of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.\n\nArguments\n\ntarg: Target body\net: Observer epoch\nref: Reference frame of output state vector\nabcorr: Aberration correction flag\nobs: Observing body\n\nOutput\n\nstarg: State of target\nlt: One way light time between observer and target\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkezp-NTuple{5, Any}","page":"API","title":"SPICE.spkezp","text":"spkezp(targ, et, ref, abcorr, obs)\n\nReturn the position of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.\n\nArguments\n\ntarg: Target body\net: Observer epoch\nref: Reference frame of output state vector\nabcorr: Aberration correction flag\nobs: Observing body\n\nOutput\n\nptarg: Position of target\nlt: One way light time between observer and target\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkezr-NTuple{5, Any}","page":"API","title":"SPICE.spkezr","text":"spkezr(targ, et, ref, abcorr, obs)\n\nReturn the state (position and velocity) of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.\n\nArguments\n\ntarg: Target body name\net: Observer epoch\nref: Reference frame of output state vector\nabcorr: Aberration correction flag\nobs: Observing body name\n\nOutput\n\nstarg: State of target\nlt: One way light time between observer and target\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkgeo-NTuple{4, Any}","page":"API","title":"SPICE.spkgeo","text":"spkgeo(targ, et, ref, obs)\n\nCompute the geometric state (position and velocity) of a target body relative to an observing body.\n\nArguments\n\ntarg: Target body.\net: Target epoch.\nref: Target reference frame.\nobs: Observing body.\n\nOutput\n\nstate: State of target.\nlt: Light time.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkgps-NTuple{4, Any}","page":"API","title":"SPICE.spkgps","text":"spkgps(targ, et, ref, obs)\n\nCompute the geometric position of a target body relative to an observing body.\n\nArguments\n\ntarg: Target body\net: Target epoch\nref: Target reference frame\nobs: Observing body\n\nOutput\n\npos: Position of target\nlt: Light time\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spklef-Tuple{Any}","page":"API","title":"SPICE.spklef","text":"spklef(fname)\n\nLoad an ephemeris file for use by the readers. Return that file's handle, to be used by other SPK routines to refer to the file.\n\nArguments\n\nfname: Name of the file to be loaded\n\nOutput\n\nhandle: Loaded file's handle\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkltc-NTuple{5, Any}","page":"API","title":"SPICE.spkltc","text":"spkltc(targ, et, ref, abcorr, stobs)\n\nReturn the state (position and velocity) of a target body relative to an observer, optionally corrected for light time, expressed relative to an inertial reference frame.\n\nArguments\n\ntarg: Target body\net: Observer epoch\nref: Inertial reference frame of output state\nabcorr: Aberration correction flag\nstobs: State of the observer relative to the SSB\n\nOutput\n\nstarg: State of target\nlt: One way light time between observer and target\ndlt: Derivative of light time with respect to time\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkobj!-Tuple{Any, Any}","page":"API","title":"SPICE.spkobj!","text":"spkobj!(ids, spk)\n\nFind the set of ID codes of all objects in a specified SPK file.\n\nArguments\n\nids: A preallocated set of ID codes of objects in SPK file\nspk: Name of the SPK file\n\nOutput\n\nReturns the set of id codes.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkopa-Tuple{Any}","page":"API","title":"SPICE.spkopa","text":"spkopa(file)\n\nOpen an existing SPK file for subsequent write.\n\nArguments\n\nfile: The name of an existing SPK file\n\nOutput\n\nReturns a handle attached to the SPK file opened to append.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkopn","page":"API","title":"SPICE.spkopn","text":"spkopn(name, ifname=\"\", ncomch=0)\n\nCreate a new SPK file, returning the handle of the opened file.\n\nArguments\n\nname: The name of the new SPK file to be created\nifname: The internal filename for the SPK file (default: \"\")\nncomch: The number of characters to reserve for comments (default: 0)\n\nOutput\n\nReturns the handle of the opened SPK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.spkpds-NTuple{6, Any}","page":"API","title":"SPICE.spkpds","text":"spkpds(body, center, frame, typ, first, last)\n\nPerform routine error checks and if all checks pass, pack the descriptor for an SPK segment.\n\nArguments\n\nbody: The NAIF ID code for the body of the segment\ncenter: The center of motion for body\nframe: The frame for this segment\ntype: The type of SPK segment to create\nfirst: The first epoch for which the segment is valid\nlast: The last epoch for which the segment is valid\n\nOutput\n\nReturns an SPK segment descriptor.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkpos-NTuple{5, Any}","page":"API","title":"SPICE.spkpos","text":"spkpos(targ, et, ref, abcorr, obs)\n\nReturn the position of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.\n\nArguments\n\ntarg: Target body name\net: Observer epoch\nref: Reference frame of output position vector\nabcorr: Aberration correction flag\nobs: Observing body name\n\nOutput\n\nptarg: Position of target\nlt: One way light time between observer and target\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkpvn-Tuple{Any, Any, Any}","page":"API","title":"SPICE.spkpvn","text":"spkpvn(handle, descr, et)\n\nFor a specified SPK segment and time, return the state (position and velocity) of the segment's target body relative to its center of motion.\n\nArguments\n\nhandle: File handle\ndescr: Segment descriptor\net: Evaluation epoch\n\nOutput\n\nref: Segment reference frame ID code\nstate: Output state vector\ncenter: Center of state\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spksfs-Tuple{Any, Any}","page":"API","title":"SPICE.spksfs","text":"spksfs(body, et)\n\nSearch through loaded SPK files to find the highest-priority segment applicable to the body and time specified.\n\nArguments\n\nbody: Body ID\net: Ephemeris time\n\nOutput\n\nReturns nothing if no segment was found or a tuple consisting of:\n\nhandle: Handle of file containing the applicable segment\ndescr: Descriptor of the applicable segment\nident: Identifier of the applicable segment\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkssb-Tuple{Any, Any, Any}","page":"API","title":"SPICE.spkssb","text":"spkssb(targ, et, ref)\n\nReturn the state (position and velocity) of a target body relative to the solar system barycenter.\n\nArguments\n\ntarg: Target body\net: Target epoch\nref: Target reference frame\n\nOutput\n\nReturns the state of target.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spksub!-NTuple{6, Any}","page":"API","title":"SPICE.spksub!","text":"spksub!(newh, handle, descr, ident, start, stop)\n\nExtract a subset of the data in an SPK segment into a separate segment.\n\nArguments\n\nnewh: Handle of new segment\nhandle: Handle of source segment\ndescr: Descriptor of source segment\nident: Identifier of source segment\nstart: Beginning (initial epoch) of subset\nstop: End (final epoch) of subset\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkuds-Tuple{Any}","page":"API","title":"SPICE.spkuds","text":"spkuds(descr)\n\nUnpack the contents of an SPK segment descriptor.\n\nArguments\n\ndescr: An SPK segment descriptor\n\nOutput\n\nbody: The NAIF ID code for the body of the segment\ncenter: The center of motion for body\nframe: The ID code for the frame of this segment\ntype: The type of SPK segment\nfirst: The first epoch for which the segment is valid\nlast: The last epoch for which the segment is valid\nstart: Beginning DAF address of the segment\nstop: Ending DAF address of the segment\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkuef-Tuple{Any}","page":"API","title":"SPICE.spkuef","text":"spkuef(handle)\n\nUnload an ephemeris file so that it will no longer be searched by the readers.\n\nArguments\n\nhandle: Handle of file to be unloaded\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw02-NTuple{10, Any}","page":"API","title":"SPICE.spkw02","text":"spkw02(handle, body, center, frame, first, last, segid, intlen, cdata, btime)\n\nWrite a type 2 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\nintlen: Length of time covered by logical record\ncdata: Array of Chebyshev coefficients\nbtime: Begin time of first logical record\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw03-NTuple{10, Any}","page":"API","title":"SPICE.spkw03","text":"spkw03(handle, body, center, frame, first, last, segid, intlen, cdata, btime)\n\nWrite a type 3 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\nintlen: Length of time covered by logical record\ncdata: Array of Chebyshev coefficients\nbtime: Begin time of first logical record\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw05-NTuple{10, Any}","page":"API","title":"SPICE.spkw05","text":"spkw05(handle, body, center, frame, first, last, segid, gm, states, epochs)\n\nWrite an SPK segment of type 5 given a time-ordered set of discrete states and epochs, and the gravitational parameter of a central body.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\ngm: Gravitational parameter of central body\nstates: States\nepochs: Epochs\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw08-NTuple{11, Any}","page":"API","title":"SPICE.spkw08","text":"spkw08(handle, body, center, frame, first, last, segid, degree, states, epoch1, step)\n\nWrite a type 8 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\ndegree: Degree of interpolating polynomials\nstates: States\nepoch1: Epoch of first state in states array\nstep: Time step separating epochs of states\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw09-NTuple{10, Any}","page":"API","title":"SPICE.spkw09","text":"spkw09(handle, body, center, frame, first, last, segid, degree, states, epochs)\n\nWrite a type 9 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\ndegree: Degree of interpolating polynomials\nstates: States\nepochs: Epochs\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw10-NTuple{10, Any}","page":"API","title":"SPICE.spkw10","text":"spkw10(handle, body, center, frame, first, last, segid, consts, elems, epochs)\n\nWrite a type 10 segment to an SPK file.\n\nArguments\n\nhandle: The handle of a DAF file open for writing\nbody: The NAIF ID code for the body of the segment\ncenter: The center of motion for body\nframe: The reference frame for this segment\nfirst: The first epoch for which the segment is valid\nlast: The last epoch for which the segment is valid\nsegid: The string to use for segment identifier\nconsts: The array of geophysical constants for the segmen\nelems: The collection of \"two-line\" element sets\nepochs: The epochs associated with the element sets\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw12-NTuple{11, Any}","page":"API","title":"SPICE.spkw12","text":"spkw12(handle, body, center, frame, first, last, segid, degree, states, epoch1, step)\n\nWrite a type 12 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\ndegree: Degree of interpolating polynomials\nstates: States\nepoch1: Epoch of first state in states array\nstep: Time step separating epochs of states\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw13-NTuple{10, Any}","page":"API","title":"SPICE.spkw13","text":"spkw13(handle, body, center, frame, first, last, segid, degree, states, epochs)\n\nWrite a type 13 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\ndegree: Degree of interpolating polynomials\nstates: States\nepochs: Epochs\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw15-NTuple{17, Any}","page":"API","title":"SPICE.spkw15","text":"spkw15(handle, body, center, frame, first, last, segid,\n epoch, tp, pa, p, ecc, j2flg, pv, gm, j2, radius)\n\nWrite a type 15 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\nepoch: Epoch of the periapse\ntp: Trajectory pole vector\npa: Periapsis vector\np: Semi-latus rectum\necc: Eccentricity\nj2flg: J2 processing flag\npv: Central body pole vector\ngm: Central body GM\nj2: Central body J2\nradius: Equatorial radius of central body\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw17-NTuple{11, Any}","page":"API","title":"SPICE.spkw17","text":"spkw17(handle, body, center, frame, first, last, segid, epoch, eqel, rapol, decpol)\n\nWrite a type 17 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\nepoch: Epoch of elements in seconds past J2000\neqel: Array of equinoctial elements\nrapol: Right Ascension of the pole of the reference plane\ndecpol: Declination of the pole of the reference plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw18-NTuple{11, Any}","page":"API","title":"SPICE.spkw18","text":"spkw18(handle, subtyp, body, center, frame, first, last, segid, degree, packts, epochs)\n\nWrite a type 18 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nsubtyp: SPK type 18 subtype code, either :S18TP0 or :S18TP1\nbody: NAIF code for an ephemeris object\ncenter: NAIF code for center of motion of body\nframe: Reference frame name\nfirst: Start time of interval covered by segment\nlast: End time of interval covered by segment\nsegid: Segment identifier\ndegree: Degree of interpolating polynomials\npackts: Time-ordered array of data packets representing geometric states of body\nFor :S18TP0: [x, y, z, dx/dt, dy/dt, dz/dt, vx, vy, vz, dvx/dt, dvy/dt, dvz/dt]\nFor :S18TP1: [x, y, z, dx/dt, dy/dt, dz/dt]\nepochs: Array of epochs corresponding to states.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw20-NTuple{13, Any}","page":"API","title":"SPICE.spkw20","text":"spkw20(handle, body, center, frame, first, last, segid, intlen, n, polydg, cdata, dscale,\n tscale, initjd, initfr)\n\nWrite a type 20 segment to an SPK file.\n\nArguments\n\nhandle: Handle of SPK file open for writing\nbody: NAIF code for ephemeris object\ncenter: NAIF code for the center of motion of the body\nframe: Reference frame name\nfirst: Start time of interval covered by segment\nlast: End time of interval covered by segment\nsegid: Segment identifier\nintlen: Length of time covered by logical record (days)\ncdata: Array of Chebyshev coefficients and positions\ndscale: Distance scale of data\ntscale: Time scale of data\ninitjd: Integer part of begin time (TDB Julian date) of first record\ninitfr: Fractional part of begin time (TDB Julian date) of first record\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfc2s-Tuple{Any, Any}","page":"API","title":"SPICE.srfc2s","text":"srfc2s(code, bodyid)\n\nTranslate a surface ID code, together with a body ID code, to the corresponding surface name. If no such name exists, return a string representation of the surface ID code.\n\nArguments\n\ncode: Integer surface ID code to translate to a string\nbodyid: ID code of body associated with surface\n\nOutput\n\nsrfstr: String corresponding to surface ID code\nisname: Logical flag indicating output is a surface name\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfcss-Tuple{Any, Any}","page":"API","title":"SPICE.srfcss","text":"srfcss(code, bodstr)\n\nTranslate a surface ID code, together with a body string, to the corresponding surface name. If no such surface name exists, return a string representation of the surface ID code.\n\nArguments\n\ncode: Integer surface ID code to translate to a string\nbodstr: Name or ID of body associated with surface\n\nOutput\n\nsrfstr: String corresponding to surface ID code\nisname: Logical flag indicating output is a surface name\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfnrm-NTuple{5, Any}","page":"API","title":"SPICE.srfnrm","text":"srfnrm(method, target, et, fixref, npts, srfpts)\n\nMap array of surface points on a specified target body to the corresponding unit length outward surface normal vectors.\n\nThe surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in TDB seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nsrfpts: Array of surface points\n\nOutput\n\nReturns an array of outward, unit length normal vectors.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfrec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.srfrec","text":"srfrec(body, longitude, latitude)\n\nConvert planetocentric latitude and longitude of a surface point on a specified body to rectangular coordinates.\n\nArguments\n\nbody: NAIF integer code of an extended body.\nlongitude: Longitude of point in radians.\nlatitude: Latitude of point in radians.\n\nOutput\n\nReturns the rectangular coordinates of the point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfs2c-Tuple{Any, Any}","page":"API","title":"SPICE.srfs2c","text":"srfs2c(srfstr, bodstr)\n\nTranslate a surface string, together with a body string, to the corresponding surface ID code. The input strings may contain names or integer ID codes.\n\nArguments\n\nsrfstr: Surface name or ID string\nbodstr: Body name or ID string\n\nOutput\n\nReturns the surface ID code if it was found or nothing otherwise.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfscc-Tuple{Any, Any}","page":"API","title":"SPICE.srfscc","text":"srfscc(srfstr, bodyid)\n\nTranslate a surface string, together with a body ID code, to the corresponding surface ID code. The input surface string may contain a name or an integer ID code.\n\nArguments\n\nsrfstr: Surface name or ID string\nbodyid: Body ID code.\n\nOutput\n\nReturns the surface ID code if it was found or nothing otherwise.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfxpt","page":"API","title":"SPICE.srfxpt","text":"srfxpt\n\nwarning: Deprecated\nUse sincpt instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ssize!-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, Any}} where T","page":"API","title":"SPICE.ssize!","text":"ssize!(cell, size)\n\nSet the size (maximum cardinality) of a cell of any data type.\n\nArguments\n\ncell: The cell\nsize: Size (maximum cardinality) of the cell\n\nOutput\n\nReturns the updated cell.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.stelab-Tuple{Any, Any}","page":"API","title":"SPICE.stelab","text":"stelab(pobj, vobs)\n\nCorrect the apparent position of an object for stellar aberration.\n\nArguments\n\npobj: Position of an object with respect to the observer\nvobs: Velocity of the observer with respect to the Solar System barycenter\n\nOutput\n\nReturns the apparent position of the object with respect to the observer, corrected for stellar aberration.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.stpool","page":"API","title":"SPICE.stpool","text":"stpool(item, nth, contin, lenout=1024)\n\nRetrieve the nth string from the kernel pool variable, where the string may be continued across several components of the kernel pool variable.\n\nArguments\n\nitem: Name of the kernel pool variable\nnth: Index of the full string to retrieve\ncontin: Character sequence used to indicate continuation\nlenout: Available space in output string (default: 1024)\n\nOutput\n\nReturns the full string concatenated across continuations if the kernel variable was found or nothing otherwise.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.str2et-Tuple{Any}","page":"API","title":"SPICE.str2et","text":"str2et(str)\n\nConvert a string representing an epoch to a double precision value representing the number of TDB seconds past the J2000 epoch corresponding to the input epoch.\n\nArguments\n\nstr: A string representing an epoch\n\nOutput\n\nReturns the equivalent value in seconds past J2000, TDB.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.subpnt-NTuple{6, Any}","page":"API","title":"SPICE.subpnt","text":"subpnt(method, target, et, fixref, obsrvr, abcorr)\n\nCompute the rectangular coordinates of the sub-observer point on a target body at a specified epoch, optionally corrected for light time and stellar aberration.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in ephemeris seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction\nobsrvr: Name of observing body\n\nOutput\n\nspoint: Sub-solar point on the target body\ntrgepc: Sub-solar point epoch\nsrfvec: Vector from observer to sub-solar point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.subpt","page":"API","title":"SPICE.subpt","text":"subpt\n\nwarning: Deprecated\nUse subpnt instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.subpt_pl02","page":"API","title":"SPICE.subpt_pl02","text":"subpt_pl02\n\nwarning: Deprecated\nUse subpnt instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.subslr-NTuple{6, Any}","page":"API","title":"SPICE.subslr","text":"subslr(method, target, et, fixref, abcorr, obsrvr)\n\nCompute the rectangular coordinates of the sub-solar point on a target body at a specified epoch, optionally corrected for light time and stellar aberration.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in ephemeris seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction\nobsrvr: Name of observing body\n\nOutput\n\nspoint: Sub-solar point on the target body\ntrgepc: Sub-solar point epoch\nsrfvec: Vector from observer to sub-solar point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.subsol","page":"API","title":"SPICE.subsol","text":"subsol\n\nwarning: Deprecated\nUse subslr instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.subsol_pl02","page":"API","title":"SPICE.subsol_pl02","text":"subsol_pl02\n\nwarning: Deprecated\nUse subslr instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.sumad","page":"API","title":"SPICE.sumad","text":"sumad(array)\n\nwarning: Deprecated\nUse sum(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.sumai","page":"API","title":"SPICE.sumai","text":"sumai(array)\n\nwarning: Deprecated\nUse sum(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.surfnm-NTuple{4, Any}","page":"API","title":"SPICE.surfnm","text":"surfnm(a, b, c, point)\n\nComputes the outward-pointing, unit normal vector from a point on the surface of an ellipsoid.\n\nArguments\n\na: Length of the ellisoid semi-axis along the x-axis\nb: Length of the ellisoid semi-axis along the y-axis\nc: Length of the ellisoid semi-axis along the z-axis\npoint: Body-fixed coordinates of a point on the ellipsoid\n\nOutput\n\nReturn the outward pointing unit normal to ellipsoid at point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.surfpt-NTuple{5, Any}","page":"API","title":"SPICE.surfpt","text":"surfpt(positn, u, a, b, c)\n\nDetermine the intersection of a line-of-sight vector with the surface of an ellipsoid.\n\nArguments\n\npositn: Position of the observer in body-fixed frame\nu: Vector from the observer in some direction\na: Length of the ellipsoid semi-axis along the x-axis\nb: Length of the ellipsoid semi-axis along the y-axis\nc: Length of the ellipsoid semi-axis along the z-axis\n\nOutput\n\nReturns the point on the ellipsoid pointed to by u or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.surfpv-NTuple{5, Any}","page":"API","title":"SPICE.surfpv","text":"surfpv(stvrtx, stdir, a, b, c)\n\nFind the state (position and velocity) of the surface intercept defined by a specified ray, ray velocity, and ellipsoid.\n\nArguments\n\nstvrtx: State of ray's vertex\nstdir: State of ray's direction vector\na: Length of ellipsoid semi-axis along the x-axis\nb: Length of ellipsoid semi-axis along the y-axis\nc: Length of ellipsoid semi-axis along the z-axis\n\nOutput\n\nReturn the state of surface intercept or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.swpool-Tuple{Any, Any}","page":"API","title":"SPICE.swpool","text":"swpool(agent, names)\n\nAdd a name to the list of agents to notify whenever a member of a list of kernel variables is updated.\n\nArguments\n\nagent: The name of an agent to be notified after updates\nnames: Variable names whose update causes the notice\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sxform-Tuple{Any, Any, Any}","page":"API","title":"SPICE.sxform","text":"sxform(from, to, et)\n\nReturn the state transformation matrix from one frame to another at a specified epoch.\n\nArguments\n\nfrom: Name of the frame to transform from\nto: Name of the frame to transform to\net: Epoch of the state transformation matrix\n\nOutput\n\nReturns the state transformation matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.szpool-Tuple{Any}","page":"API","title":"SPICE.szpool","text":"szpool(name)\n\nReturn the kernel pool size limitations.\n\nArguments\n\nname: Name of the parameter to be returned\n\nOutput\n\nReturns the value of the parameter specified by name or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.termpt-NTuple{14, Any}","page":"API","title":"SPICE.termpt","text":"Find terminator points on a target body. The caller specifies half-planes, bounded by the illumination source center-target center vector, in which to search for terminator points.\n\nThe terminator can be either umbral or penumbral. The umbral terminator is the boundary of the region on the target surface where no light from the source is visible. The penumbral terminator is the boundary of the region on the target surface where none of the light from the source is blocked by the target itself.\n\nThe surface of the target body may be represented either by a triaxial ellipsoid or by topographic data.\n\nArguments\n\nmethod: Computation method\nilusrc: Illumination source\ntarget: Name of target body\net: Epoch in ephemeris seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction\ncorloc: Aberration correction locus\nobsrvr: Name of observing body\nrefvec: Reference vector for cutting half-planes\nrolstp: Roll angular step for cutting half-planes\nncuts: Number of cutting planes\nschstp: Angular step size for searching\nsoltol: Solution convergence tolerance\nmaxn: Maximum number of entries in output arrays\n\nOutput\n\nnpts: Counts of terminator points corresponding to cuts\npoints: Terminator points\nepochs: Times associated with terminator points\ntrmvcs: Terminator vectors emanating from the observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.timdef","page":"API","title":"SPICE.timdef","text":"timdef(action, item, value=\"\")\n\nSet and retrieve the defaults associated with calendar input strings.\n\nArguments\n\naction: The kind of action to take, either :SET or :GET\nitem: The default item of interest. The items that may be requested are:\n:CALENDAR with allowed values:\n\"GREGORIAN\"\n\"JULIAN\"\n\"MIXED\"\n:SYSTEM with allowed values:\n\"TDB\"\n\"TDT\"\n\"UTC\"\n:ZONE with allowed values (0 <= HR < 13 and 0 <= MN < 60):\n\"EST\"\n\"EDT\"\n\"CST\"\n\"CDT\"\n\"MST\"\n\"MDT\"\n\"PST\"\n\"PDT\"\n\"UTC+$HR\"\n\"UTC-$HR\"\n\"UTC+$HR:$MN\"\n\"UTC-$HR:$MN\"\n\nOutput\n\nReturns the value associated with the default item.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.timout","page":"API","title":"SPICE.timout","text":"timout(et, pictur, lenout=128)\n\nThis routine converts an input epoch represented in TDB seconds past the TDB epoch of J2000 to a character string formatted to the specifications of a user's format picture.\n\nArguments\n\net: An epoch in seconds past the ephemeris epoch J2000\npictur: A format specification for the output string\nlenout: The length of the output string plus 1 (default: 128)\n\nOutput\n\nReturns a string representation of the input epoch.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.tipbod-Tuple{Any, Any, Any}","page":"API","title":"SPICE.tipbod","text":"tipbod(ref, body, et)\n\nReturn a 3x3 matrix that transforms positions in inertial coordinates to positions in body-equator-and-prime-meridian coordinates.\n\nArguments\n\nref: Name of inertial reference frame to transform from\nbody: ID code of body\net: Epoch of transformation\n\nOutput\n\nReturns transformation matrix from intertial position to prime meridian.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.tisbod-Tuple{Any, Any, Any}","page":"API","title":"SPICE.tisbod","text":"tisbod(ref, body, et)\n\nReturn a 6x6 matrix that transforms states in inertial coordinates to states in body-equator-and-prime-meridian coordinates.\n\nArguments\n\nref: Name of inertial reference frame to transform from\nbody: ID code of body\net: Epoch of transformation\n\nOutput\n\nReturns transformation matrix from intertial state to prime meridian.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.tkvrsn","page":"API","title":"SPICE.tkvrsn","text":"tkvrsn(item=:TOOLKIT)\n\nGiven an item such as the Toolkit or an entry point name, return the latest version string.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.tparse-Tuple{Any}","page":"API","title":"SPICE.tparse","text":"tparse(string)\n\nParse a time string and return seconds past the J2000 epoch on a formal calendar.\n\nArguments\n\nstring: Input time string in UTC\n\nOutput\n\nReturns UTC expressed in seconds since J2000.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.tpictr","page":"API","title":"SPICE.tpictr","text":"tpictr(sample, lenout=80)\n\nGiven a sample time string, create a time format picture suitable for use by the routine timout.\n\nArguments\n\nsample: A sample time string\nlenout: The length for the output picture string (default: 80)\n\nOutput\n\nReturns a format picture that describes sample.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.trace","page":"API","title":"SPICE.trace","text":"trace(matrix)\n\nwarning: Deprecated\nUse LinearAlgebra.tr(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.tsetyr-Tuple{Any}","page":"API","title":"SPICE.tsetyr","text":"tsetyr(year)\n\nSet the lower bound on the 100 year range.\n\nArguments\n\n-year: Lower bound on the 100 year interval of expansion\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.twopi","page":"API","title":"SPICE.twopi","text":"twopi()\n\nwarning: Deprecated\nUse 2π instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.twovec-NTuple{4, Any}","page":"API","title":"SPICE.twovec","text":"twovec(axdef, indexa, plndef, indexp)\n\nFind the transformation to the right-handed frame having a given vector as a specified axis and having a second given vector lying in a specified coordinate plane.\n\nArguments\n\naxdef: Vector defining a principal axis\nindexa: Principal axis number of axdef (X=1, Y=2, Z=3)\nplndef: Vector defining (with axdef) a principal plane\nindexp: Second axis number (with indexa) of principal plane\n\nOutput\n\nReturns output rotation matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.tyear-Tuple{}","page":"API","title":"SPICE.tyear","text":"tyear()\n\nReturns the number of seconds per tropical year.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ucase","page":"API","title":"SPICE.ucase","text":"ucase(in)\n\nwarning: Deprecated\nUse uppercase(in) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ucrss","page":"API","title":"SPICE.ucrss","text":"ucrss(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.normalize(LinearAlgebra.cross(v1, v2)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.uddf-Tuple{Any, Any, Any}","page":"API","title":"SPICE.uddf","text":"uddf(udfunc, x, dx)\n\nRoutine to calculate the first derivative of a caller-specified function using a three-point estimation.\n\nArguments\n\nudfunc: A callable that computes the scalar value of interest, e.g. f(x::Float64) -> Float64\nx: Independent variable of udfunc\ndx: Interval from x for derivative calculation\n\nOutput\n\nReturns the approximate derivative of udfunc at x.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.unitim-Tuple{Any, Any, Any}","page":"API","title":"SPICE.unitim","text":"unitim(epoch, insys, outsys)\n\nTransform time from one uniform scale to another.\n\nArguments\n\nepoch: An epoch to be converted\ninsys: The time scale associated with the input epoch\noutsys: The time scale associated with the function value\n\nThe uniform time scales are:\n\n:TAI\n:TDT\n:TDB\n:ET\n:JED\n:JDTDB\n:JDTDT\n\nOutput\n\nReturns the time in the system specified by outsys that is equivalent to the epoch in the insys time scale.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.unload-Tuple{Any}","page":"API","title":"SPICE.unload","text":"unload(file)\n\nUnload a SPICE kernel.\n\nArguments\n\nfile: The file name of a kernel to unload\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.unorm","page":"API","title":"SPICE.unorm","text":"unorm(v1)\n\nwarning: Deprecated\nUse (LinearAlgebra.normalize(v1), LinearAlgebra.norm(v1)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.unormg","page":"API","title":"SPICE.unormg","text":"unormg(v1)\n\nwarning: Deprecated\nUse (LinearAlgebra.normalize(v1), LinearAlgebra.norm(v1)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.utc2et-Tuple{Any}","page":"API","title":"SPICE.utc2et","text":"utc2et(utcstr)\n\nConvert an input time from Calendar or Julian Date format, UTC, to ephemeris seconds past J2000.\n\nArguments\n\nutcstr: Input time string, UTC\n\nOutput\n\nReturns the equivalent of utcstr, expressed in ephemeris seconds past J2000.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vadd","page":"API","title":"SPICE.vadd","text":"vadd(v1, v2)\n\nwarning: Deprecated\nUse v1 .+ v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vaddg","page":"API","title":"SPICE.vaddg","text":"vaddg(v1, v2)\n\nwarning: Deprecated\nUse v1 .+ v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.valid!-Union{Tuple{SPICE.SpiceCell{T}}, Tuple{T}} where T","page":"API","title":"SPICE.valid!","text":"valid!(set::SpiceCell{T}) where T\n\nCreate a valid SPICE set from a SPICE Cell of any data type.\n\nArguments\n\nset: Set to be validated\n\nOutput\n\nReturns the validated set with ordered elements and duplicates removed.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vcrss","page":"API","title":"SPICE.vcrss","text":"vcrss(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.cross(v1, v2) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vdist","page":"API","title":"SPICE.vdist","text":"vdist(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.norm(v1 .- v2) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vdistg","page":"API","title":"SPICE.vdistg","text":"vdistg(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.norm(v1 .- v2) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vdot","page":"API","title":"SPICE.vdot","text":"vdot(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.dot(v1, v2) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vdotg","page":"API","title":"SPICE.vdotg","text":"vdotg(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.dot(v1, v2) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vequ","page":"API","title":"SPICE.vequ","text":"vequ(v1, v2)\n\nwarning: Deprecated\nUse v1 .= v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vequg","page":"API","title":"SPICE.vequg","text":"vequg(v1, v2)\n\nwarning: Deprecated\nUse v1 .= v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vhat","page":"API","title":"SPICE.vhat","text":"vhat(v1)\n\nwarning: Deprecated\nUse LinearAlgebra.normalize(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vhatg","page":"API","title":"SPICE.vhatg","text":"vhatg(v1)\n\nwarning: Deprecated\nUse LinearAlgebra.normalize(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vlcom","page":"API","title":"SPICE.vlcom","text":"vlcom(a, v1, b, v2)\n\nwarning: Deprecated\nUse a .* v1 .+ b .* v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vlcom3","page":"API","title":"SPICE.vlcom3","text":"vlcom3(a, v1, b, v2, c, v3)\n\nwarning: Deprecated\nUse a .* v1 .+ b .* v2 .+ c .* v3 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vlcomg","page":"API","title":"SPICE.vlcomg","text":"vlcomg(a, v1, b, v2)\n\nwarning: Deprecated\nUse a .* v1 .+ b .* v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vminug","page":"API","title":"SPICE.vminug","text":"vminug(vin)\n\nwarning: Deprecated\nUse -vin instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vminus","page":"API","title":"SPICE.vminus","text":"vminus(vin)\n\nwarning: Deprecated\nUse -vin instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vnorm","page":"API","title":"SPICE.vnorm","text":"vnorm(v1)\n\nwarning: Deprecated\nUse LinearAlgebra.norm(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vnormg","page":"API","title":"SPICE.vnormg","text":"vnormg(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.norm(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vpack","page":"API","title":"SPICE.vpack","text":"vpack(x, y, z)\n\nwarning: Deprecated\nUse [x, y, z] instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vperp-Tuple{Any, Any}","page":"API","title":"SPICE.vperp","text":"vperp(a, b)\n\nFind the component of a vector that is perpendicular to a second vector.\n\nArguments\n\na: The vector whose orthogonal component is sought\nb: The vector used as the orthogonal reference\n\nOutput\n\nReturns the component a orthogonal to b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vprjp-Tuple{Any, Any}","page":"API","title":"SPICE.vprjp","text":"vprjp(vin, plane)\n\nProject a vector onto a specified plane, orthogonally.\n\nArguments\n\nvin: Vector to be projected\nplane: Plane onto which vin is projected\n\nOutput\n\nReturns the vector resulting from the projection.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vprjpi-Tuple{Any, Any, Any}","page":"API","title":"SPICE.vprjpi","text":"vprjpi(vin, projpl, invpl)\n\nFind the vector in a specified plane that maps to a specified vector in another plane under orthogonal projection.\n\nArguments\n\nvin: The projected vector\nprojpl: Plane containing vin\ninvpl: Plane containing inverse image of vin\n\nOutput\n\nReturns the inverse projection of vin or nothing if vin could not be calculated.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vproj-Tuple{Any, Any}","page":"API","title":"SPICE.vproj","text":"vproj(a, b)\n\nFinds the projection of one vector onto another vector. All vectors are 3-dimensional.\n\nArguments\n\na: The vector to be projected\nb: The vector onto which a is to be projected\n\nOutput\n\nReturns the projection of a onto b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vrel-Tuple{Any, Any}","page":"API","title":"SPICE.vrel","text":"vrel(v1, v2)\n\nReturn the relative difference between two 3-dimensional vectors.\n\nArguments\n\nv1, v2: Two three-dimensional input vectors\n\nOutput\n\nReturns the relative differences between v1 and v2.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vrelg-Tuple{Any, Any}","page":"API","title":"SPICE.vrelg","text":"vrelg(v1, v2)\n\nReturn the relative difference between two vectors.\n\nArguments\n\nv1, v2: Input vectors\n\nOutput\n\nReturns the relative differences between v1 and v2.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vrotv-Tuple{Any, Any, Any}","page":"API","title":"SPICE.vrotv","text":"vrotv(v, axis, theta)\n\nRotate a vector about a specified axis vector by a specified angle and return the rotated vector.\n\nArguments\n\nv: Vector to be rotated\naxis: Axis of the rotation\ntheta: Angle of rotation (radians)\n\nOutput\n\nResult of rotating v about axis by theta.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vscl","page":"API","title":"SPICE.vscl","text":"vscl(s, v1)\n\nwarning: Deprecated\nUse s .* v1 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vsclg","page":"API","title":"SPICE.vsclg","text":"vsclg(s, v1)\n\nwarning: Deprecated\nUse s .* v1 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vsep-Tuple{Any, Any}","page":"API","title":"SPICE.vsep","text":"vsep(v1, v2)\n\nReturn the sepative difference between two 3-dimensional vectors.\n\nArguments\n\nv1, v2: Two three-dimensional input vectors\n\nOutput\n\nReturns the angle between v1 and v2 in radians.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vsepg-Tuple{Any, Any}","page":"API","title":"SPICE.vsepg","text":"vsepg(v1, v2)\n\nReturn the sepative difference between two vectors.\n\nArguments\n\nv1, v2: Input vectors\n\nOutput\n\nReturns the angle between v1 and v2 in radians.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vsub","page":"API","title":"SPICE.vsub","text":"vsub(v1, v2)\n\nwarning: Deprecated\nUse v1 .- v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vsubg","page":"API","title":"SPICE.vsubg","text":"vsubg(v1, v2)\n\nwarning: Deprecated\nUse v1 .- v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vtmv","page":"API","title":"SPICE.vtmv","text":"vtmv(v1, matrix, v2)\n\nwarning: Deprecated\nUse v1' * matrix * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vtmvg","page":"API","title":"SPICE.vtmvg","text":"vtmvg(v1, matrix, v2)\n\nwarning: Deprecated\nUse v1' * matrix * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vupack","page":"API","title":"SPICE.vupack","text":"vupack(v)\n\nwarning: Deprecated\nUse x, y, z = v instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vzero","page":"API","title":"SPICE.vzero","text":"vzero(v1)\n\nwarning: Deprecated\nUse iszero(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vzerog","page":"API","title":"SPICE.vzerog","text":"vzerog(v1, v2)\n\nwarning: Deprecated\nUse iszero(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.wncard-Tuple{Any}","page":"API","title":"SPICE.wncard","text":"wncard(window)\n\nReturn the cardinality (number of intervals) of a double precision window.\n\nArguments\n\nwindow: Input window\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wncomd-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wncomd","text":"wncomd(window, left, right)\n\nDetermine the complement of a double precision window with respect to a specified interval.\n\nArguments\n\nwindow: Input window\nleft: Left endpoint of the complement interval\nright: Right endpoint of the complement interval\n\nOutput\n\nReturns the complement of window with respect to [left,right].\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wncond!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wncond!","text":"wncond!(window, left, right)\n\nContract each of the intervals of a double precision window.\n\nArguments\n\nwindow: Window to be contracted\nleft: Amount added to each left endpoint\nright: Amount subtracted from each right endpoint\n\nOutput\n\nReturns the contracted window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wndifd-Tuple{Any, Any}","page":"API","title":"SPICE.wndifd","text":"wndifd(a, b)\n\nPlace the difference of two double precision windows into a third window.\n\nArguments\n\na: Input window\nb: Input window\n\nOutput\n\nReturns a window containing the difference of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnelmd-Tuple{Any, Any}","page":"API","title":"SPICE.wnelmd","text":"wnelmd(window, point)\n\nDetermine whether a point is an element of a double precision window.\n\nArguments\n\nwindow: Input window\npoint: Input point\n\nOutput\n\nReturns true if point is an element of window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnexpd!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wnexpd!","text":"wnexpd(window, left, right)\n\nExpand each of the intervals of a double precision window.\n\nArguments\n\nleft: Amount subtracted from each left endpoint\nright: Amount added to each right endpoint\n\nOutput\n\nReturns the expanded window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnextd!-Tuple{Any, Any}","page":"API","title":"SPICE.wnextd!","text":"wnextd!(window, side)\n\nExtract the left or right endpoints from a double precision window.\n\nArguments\n\nwindow: Window to be extracted\nside: Extract left (:L) or right (:R) endpoints\n\nOutput\n\nReturns the extracted window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnfetd-Tuple{Any, Any}","page":"API","title":"SPICE.wnfetd","text":"wnfetd(window, n)\n\nFetch a particular interval from a double precision window.\n\nArguments\n\nwindow: Input window\nn: Index of interval to be fetched\n\nOutput\n\nReturns a tuple consisting of the left and right endpoints of the n-th interval in the input window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnfild!-Tuple{Any, Any}","page":"API","title":"SPICE.wnfild!","text":"wnfild!(window, small)\n\nFill small gaps between adjacent intervals of a double precision window.\n\nArguments\n\nwindow: Window to be filled\nsmall: Limiting measure of small gaps\n\nOutput\n\nReturns the updated window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnfltd!-Tuple{Any, Any}","page":"API","title":"SPICE.wnfltd!","text":"wnfild!(window, small)\n\nFilter (remove) small intervals from a double precision window.\n\nArguments\n\nwindow: Window to be filtered\nsmall: Limiting measure of small intervals\n\nOutput\n\nReturns the updated window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnincd-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wnincd","text":"wnincd(window, left, right)\n\nDetermine whether an interval is included in a double precision window.\n\nArguments\n\nwindow: Input window\nleft: Left endpoint of the input interval\nright: Right endpoint of the input interval\n\nOutput\n\nReturns true when (left, right) is contained in window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wninsd!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wninsd!","text":"wninsd!(window, left, right)\n\nInsert an interval into a double precision window.\n\nArguments\n\nwindow: Input window\nleft: Left endpoint of the new interval\nright: Right endpoint of the new interval\n\nOutput\n\nReturns the updated windows.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnintd-Tuple{Any, Any}","page":"API","title":"SPICE.wnintd","text":"wnintd(a, b)\n\nPlace the intersection of two double precision windows into a third window.\n\nArguments\n\na: Input window\nb: Input window\n\nOutput\n\nReturns a window containing the intersection of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnreld-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wnreld","text":"wnreld(a, op, b)\n\nCompare two double precision windows.\n\nnote: Note\nConsider using overloaded operators instead, i.e. a == b, a ⊆ b, and a ⊊ b.\n\nArguments\n\na: First window\nop: Comparison operator\nb: Second window\n\nOutput\n\nReturns the result of comparison a (op) b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnsumd-Tuple{Any}","page":"API","title":"SPICE.wnsumd","text":"wnsumd(window)\n\nSummarize the contents of a double precision window.\n\nArguments\n\nwindow: Window to be summarized\n\nOutput\n\nReturns a tuple consisting of:\n\nmeas: Total measure of intervals in window\navg: Average measure\nstddev: Standard deviation\nshortest: Location of shortest interval\nlongest: Location of longest interval\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnunid-Tuple{Any, Any}","page":"API","title":"SPICE.wnunid","text":"wnunid(a, b)\n\nPlace the union of two double precision windows into a third window.\n\nArguments\n\na: Input window\nb: Input window\n\nOutput\n\nReturns a window containing the union of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnvald!-Tuple{Any}","page":"API","title":"SPICE.wnvald!","text":"wnvald!(window)\n\nForm a valid double precision window from the contents of a window array.\n\nArguments\n\nwindow: A (possibly uninitialized) SpiceDoubleCell containing endpoints of (possibly unordered and non-disjoint) intervals.\n\nOutput\n\nReturns the validated window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.xf2eul-NTuple{4, Any}","page":"API","title":"SPICE.xf2eul","text":"xf2eul(xform, axisa, axisb, axisc)\n\nConvert a state transformation matrix to Euler angles and their derivatives with respect to a specified set of axes.\n\nArguments\n\nxform: A state transformation matrix\naxisa: Axis A of the Euler angle factorization\naxisb: Axis B of the Euler angle factorization\naxisc: Axis C of the Euler angle factorization\n\nOutput\n\nReturns a tuple of an array of Euler angles and their derivatives and a boolean that indicates whether these are a unique representation.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.xf2rav-Tuple{Any}","page":"API","title":"SPICE.xf2rav","text":"xf2rav(xform)\n\nDetermines the rotation matrix and angular velocity of the rotation from a state transformation matrix.\n\nArguments\n\nxform: State transformation matrix\n\nOutput\n\nReturns a tuple of the rotation matrix and the angular velocity vector associated with xform.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.xfmsta-NTuple{4, Any}","page":"API","title":"SPICE.xfmsta","text":"xfmsta(input_state, input_coord_sys, output_coord_sys, body)\n\nTransform a state between coordinate systems.\n\nArguments\n\ninput_state: Input state\ninput_coord_sys: Current (input) coordinate system\noutput_coord_sys: Desired (output) coordinate system\nbody: Name or NAIF ID of body with which coordinates are associated (if applicable)\n\nOutput\n\nReturns the converted output state.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.xpose","page":"API","title":"SPICE.xpose","text":"xpose(matrix)\n\nwarning: Deprecated\nUse transpose(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.xpose6","page":"API","title":"SPICE.xpose6","text":"xpose6(matrix)\n\nwarning: Deprecated\nUse transpose(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.xposeg","page":"API","title":"SPICE.xposeg","text":"xposeg(matrix)\n\nwarning: Deprecated\nUse transpose(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"#SPICE.jl","page":"Home","title":"SPICE.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"SPICE.jl is a Julia wrapper for the SPICE toolkit which is provided by NASA's Navigation and Ancillary Information Facility (NAIF). It provides functionality to read SPICE data files and compute derived observation geometry such as altitude, latitude/longitude and lighting angles. Please refer to its comprehensive documentation if you are not yet familiar with SPICE.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note: This project is not affiliated with NASA, NAIF or JPL in any way.","category":"page"},{"location":"#Installation","page":"Home","title":"Installation","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"julia> import Pkg; Pkg.add(\"SPICE\")","category":"page"},{"location":"#Quickstart","page":"Home","title":"Quickstart","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"using SPICE\nusing Downloads: download\n\nconst LSK = \"https://naif.jpl.nasa.gov/pub/naif/generic_kernels/lsk/naif0012.tls\"\nconst SPK = \"https://naif.jpl.nasa.gov/pub/naif/generic_kernels/spk/planets/de440.bsp\"\n\n# Download kernels\ndownload(LSK, \"naif0012.tls\")\ndownload(SPK, \"de440.bsp\")\n\n# Load leap seconds kernel\nfurnsh(\"naif0012.tls\")\n\n# Convert the calendar date to ephemeris seconds past J2000\net = utc2et(\"2018-02-06T20:45:00\")\n\n# Load a planetary ephemeris kernel\nfurnsh(\"de440.bsp\")\n\n# Get the position of Mars at `et` w.r.t. Earth\nspkpos(\"mars_barycenter\", et, \"J2000\", \"none\", \"earth\")","category":"page"},{"location":"#Notable-differences-to-CSPICE","page":"Home","title":"Notable differences to CSPICE","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"SPICE.jl follows the Julia language's style and conventions which introduces the following differences to CSPICE.","category":"page"},{"location":"","page":"Home","title":"Home","text":"SPICE.jl does not wrap all CSPICE functions since many general purpose utilities already exist in Julia's standard library or can be approximated with a Julia one-liner. If you try to call an unwrapped function, SPICE.jl will return a deprecation warning that shows the equivalent Julia code.\nFunctions that mutate one of their input arguments are suffixed with ! and the to-be-mutated argument will be the first parameter, e.g. wninsd!(window, left, right) instead of wninsd(left, right, window).","category":"page"},{"location":"#Next-Steps","page":"Home","title":"Next Steps","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Please refer to the API reference.","category":"page"}] +[{"location":"api/#API","page":"API","title":"API","text":"","category":"section"},{"location":"api/","page":"API","title":"API","text":"DocTestSetup = quote\n using SPICE\nend","category":"page"},{"location":"api/","page":"API","title":"API","text":"Modules = [SPICE]\nPrivate = false","category":"page"},{"location":"api/#SPICE.SpiceCharCell","page":"API","title":"SPICE.SpiceCharCell","text":"SpiceCharCell(size, length)\n\nCreate a SpiceCharCell that can contain up to size strings with length characters.\n\n\n\n\n\n","category":"type"},{"location":"api/#SPICE.SpiceDoubleCell","page":"API","title":"SPICE.SpiceDoubleCell","text":"SpiceDoubleCell(size)\n\nCreate a SpiceDoubleCell that can contain up to size elements.\n\n\n\n\n\n","category":"type"},{"location":"api/#SPICE.SpiceIntCell","page":"API","title":"SPICE.SpiceIntCell","text":"SpiceIntCell(size)\n\nCreate a SpiceIntCell that can contain up to size elements.\n\n\n\n\n\n","category":"type"},{"location":"api/#Base.append!-Tuple{SPICE.SpiceCell, Any}","page":"API","title":"Base.append!","text":"append!(cell, collection)\n\nAppend all items from collection to the char/double/integer SpiceCell cell.\n\n\n\n\n\n","category":"method"},{"location":"api/#Base.copy-Union{Tuple{SPICE.SpiceCell{T}}, Tuple{T}} where T","page":"API","title":"Base.copy","text":"copy(cell::SpiceCell)\n\nDuplicate the SpiceCell cell.\n\n\n\n\n\n","category":"method"},{"location":"api/#Base.diff-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, SPICE.SpiceCell{T}}} where T","page":"API","title":"Base.diff","text":"diff(a::T, b::T) where T <: SpiceCell\n\nCompute the difference of two sets of any data type to form a third set.\n\nArguments\n\na: First input set\nb: Second input set\n\nOutput\n\nReturns a cell containing the difference of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#Base.length-Tuple{SPICE.SpiceCell}","page":"API","title":"Base.length","text":"length(cell)\n\nReturns the cardinality (number of elements) of cell.\n\n\n\n\n\n","category":"method"},{"location":"api/#Base.push!-Tuple{SPICE.SpiceCell, Vararg{Any}}","page":"API","title":"Base.push!","text":"push!(cell, items...)\n\nInsert one or more items at the end of the char/double/integer SpiceCell cell.\n\n\n\n\n\n","category":"method"},{"location":"api/#Base.union-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, SPICE.SpiceCell{T}}} where T","page":"API","title":"Base.union","text":"union(a::T, b::T) where T <: SpiceCell\n\nCompute the union of two sets of any data type to form a third set.\n\nArguments\n\na: First input set\nb: Second input set\n\nOutput\n\nReturns a cell containing the union of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.appnd-Tuple{Any, SpiceCharCell}","page":"API","title":"SPICE.appnd","text":"appnd(item, cell)\n\nAppend an item to the char/double/integer SpiceCell cell.\n\nReferences\n\nappndc - NAIF Documentation\nappndd - NAIF Documentation\nappndi - NAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.axisar-Tuple{Any, Any}","page":"API","title":"SPICE.axisar","text":"axisar(axis, angle)\n\nConstruct a rotation matrix that rotates vectors by a specified angle about a specified axis.\n\nArguments\n\naxis: Rotation axis\nangle: Rotation angle in radians\n\nOutput\n\nRotation matrix corresponding to axis and angle\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.azlrec-NTuple{5, Any}","page":"API","title":"SPICE.azlrec","text":"azlrec(range, az, el, azccw, elplsz)\n\nConvert from range, azimuth and elevation of a point to rectangular coordinates.\n\nArguments\n\nrange: Distance of the point from the origin\naz: Azimuth in radians\nel: Elevation in radians\nazccw: Flag indicating how azimuth is measured. If true, the azimuth increases in the counterclockwise direction; otherwise it increases in the clockwise direction\nelplsz: Flag indicating how elevation is measured. If true, the elevation increases from the XY plane toward +Z; otherwise toward -Z\n\nOutput\n\nrectan: Rectangular coordinates of the point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.b1900-Tuple{}","page":"API","title":"SPICE.b1900","text":"b1900()\n\nReturns the Julian Date corresponding to Besselian date 1900.0.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.b1950-Tuple{}","page":"API","title":"SPICE.b1950","text":"b1950()\n\nReturns the Julian Date corresponding to Besselian date 1950.0.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.badkpv-NTuple{6, Any}","page":"API","title":"SPICE.badkpv","text":"badkpv(caller, name, comp, size, divby, typ)\n\nDetermine if a kernel pool variable is present and if so that it has the correct size and type.\n\nArguments\n\ncaller: Name of the routine calling this routine\nname: Name of a kernel pool variable\ncomp: Comparison operator\nsize: Expected size of the kernel pool variable\ndivby: A divisor of the size of the kernel pool variable\ntype: Expected type of the kernel pool variable\n\nOutput\n\nThe function returns false if the kernel pool variable is OK otherwise an exception is thrown.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bltfrm-Tuple{Any}","page":"API","title":"SPICE.bltfrm","text":"bltfrm(frmcls)\n\nReturn a SPICE set containing the frame IDs of all built-in frames of a specified class.\n\nArguments\n\nfrmcls: Frame class\n\nOutput\n\nidset: Set of ID codes of frames of the specified class\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bodc2n-Tuple{Any}","page":"API","title":"SPICE.bodc2n","text":"bodc2n(code)\n\nTranslate the SPICE integer code of a body into a common name for that body.\n\nArguments\n\ncode: Integer ID code to be translated into a name\n\nOutput\n\nA common name for the body identified by code or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bodc2s-Tuple{Any}","page":"API","title":"SPICE.bodc2s","text":"bodc2s(code)\n\nTranslate a body ID code to either the corresponding name or if no name to ID code mapping exists, the string representation of the body ID value.\n\nArguments\n\ncode: Integer ID code to translate to a string\n\nOutput\n\nReturns a string corresponding to code\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.boddef-Tuple{Any, Any}","page":"API","title":"SPICE.boddef","text":"boddef(name, code)\n\nDefine a body name/ID code pair for later translation via bodn2c or bodc2n.\n\nArguments\n\nname: Common name of some body\ncode: Integer code for that body\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bodfnd-Tuple{Any, Any}","page":"API","title":"SPICE.bodfnd","text":"bodfnd(body, item)\n\nDetermine whether values exist for some item for any body in the kernel pool.\n\nArguments\n\nbody: ID code of body\nitem: Item to find (\"RADII\", \"NUTAMPRA\", etc.)\n\nOutput\n\nReturns true if the item is in the kernel pool and false if it is not.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bodn2c-Tuple{Any}","page":"API","title":"SPICE.bodn2c","text":"bodn2c(name)\n\nTranslate the name of a body or object to the corresponding SPICE integer ID code.\n\nArguments\n\nname: Body name to be translated into a SPICE ID code\n\nOutput\n\nReturn the SPICE integer ID code for the named body or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bods2c-Tuple{Any}","page":"API","title":"SPICE.bods2c","text":"bods2c(name)\n\nTranslate a string containing a body name or ID code to an integer code.\n\nArguments\n\nname: String to be translated to an ID code\n\nOutput\n\nRetunrs the integer ID code corresponding to name or nothing if none as found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.bodvcd","page":"API","title":"SPICE.bodvcd","text":"bodvcd(bodyid, item)\n\nFetch from the kernel pool the double precision values of an item associated with a body, where the body is specified by an integer ID code.\n\nArguments\n\nbodyid: Body ID code\nitem: Item for which values are desired. (\"RADII\", \"NUT_PREC_ANGLES\", etc.)\nmaxn: Maximum number of values that may be returned (default: 100)\n\nOutput\n\nReturns the requested values.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bodvrd","page":"API","title":"SPICE.bodvrd","text":"bodvrd(bodynm, item)\n\nFetch from the kernel pool the double precision values of an item associated with a body.\n\nArguments\n\nbodynm: Body name\nitem: Item for which values are desired. (\"RADII\", \"NUT_PREC_ANGLES\", etc.)\nmaxn: Maximum number of values that may be returned (default: 100)\n\nOutput\n\nvalues: Values\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.brcktd","page":"API","title":"SPICE.brcktd","text":"brcktd(number, e1, e2)\n\nwarning: Deprecated\nUse clamp from Julia's standard library instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.brckti","page":"API","title":"SPICE.brckti","text":"brckti(number, e1, e2)\n\nwarning: Deprecated\nUse clamp from Julia's standard library instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bschoc","page":"API","title":"SPICE.bschoc","text":"bschoc(value, array, order)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bschoi","page":"API","title":"SPICE.bschoi","text":"bschoi(value, array, order)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bsrchc","page":"API","title":"SPICE.bsrchc","text":"bsrchc(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bsrchd","page":"API","title":"SPICE.bsrchd","text":"bsrchd(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.bsrchi","page":"API","title":"SPICE.bsrchi","text":"bsrchi(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.card-Tuple{SPICE.SpiceCell}","page":"API","title":"SPICE.card","text":"card(cell)\n\nReturns the cardinality (number of elements) of cell.\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ccifrm-Tuple{Any, Any}","page":"API","title":"SPICE.ccifrm","text":"ccifrm(frclss, clssid)\n\nReturn the frame name, frame ID, and center associated with a given frame class and class ID.\n\nArguments\n\nfrclss: Class of frame\nclssid: Class ID of frame\n\nOutput\n\nReturns nothing if no frame was found or\n\nfrcode: ID code of the frame\nfrname: Name of the frame\ncenter: ID code of the center of the frame\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cgv2el-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cgv2el","text":"cgv2el(center, vec1, vec2)\n\nForm an ellipse from a center vector and two generating vectors.\n\nArguments\n\ncenter: Center vector\nvec1: Generating vector\nvec2: Generating vector\n\nOutput\n\nReturns the ellipse defined by the input vectors.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.chbder-NTuple{4, Any}","page":"API","title":"SPICE.chbder","text":"chbder(cp, x2s, x, nderiv)\n\nGiven the coefficients for the Chebyshev expansion of a polynomial, this returns the value of the polynomial and its first nderiv derivatives evaluated at the input x.\n\nArguments\n\ncp: Chebyshev polynomial coefficients\nx2s: Transformation parameters of polynomial\nx: Value for which the polynomial is to be evaluated\nnderiv: The number of derivatives to compute\n\nOutput\n\nReturns the derivatives of the polynomial.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cidfrm-Tuple{Any}","page":"API","title":"SPICE.cidfrm","text":"cidfrm(cent)\n\nRetrieve frame ID code and name to associate with a frame center.\n\nArguments\n\ncent: ID code for an object for which there is a preferred reference frame\n\nOutput\n\nReturns nothing if no frame was found or\n\nfrcode: The ID code of the frame associated with cent\nfrname: The name of the frame with ID frcode\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckcls-Tuple{Any}","page":"API","title":"SPICE.ckcls","text":"ckcls(handle)\n\nClose an open CK file.\n\nArguments\n\nhandle: Handle of the CK file to be closed\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckcov!-NTuple{7, Any}","page":"API","title":"SPICE.ckcov!","text":"ckcov!(ck, idcode, needav, level, tol, timsys, cover)\n\nFind the coverage window for a specified object in a specified CK file.\n\nArguments\n\nck: Name of CK file\nidcode: ID code of object\nneedav: Flag indicating whether angular velocity is needed\nlevel: Coverage level: \"SEGMENT\" OR \"INTERVAL\"\ntol: Tolerance in ticks\ntimsys: Time system used to represent coverage\ncover: Window giving coverage for idcode. Data already present in cover will be combined with coverage found for the object designated by idcode in the file ck.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckcov-NTuple{6, Any}","page":"API","title":"SPICE.ckcov","text":"ckcov(ck, idcode, needav, level, tol, timsys)\n\nFind the coverage window for a specified object in a specified CK file.\n\nArguments\n\nck: Name of CK file\nidcode: ID code of object\nneedav: Flag indicating whether angular velocity is needed\nlevel: Coverage level: \"SEGMENT\" OR \"INTERVAL\"\ntol: Tolerance in ticks\ntimsys: Time system used to represent coverage\n\nOutput\n\nWindow giving coverage for idcode\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckgp-NTuple{4, Any}","page":"API","title":"SPICE.ckgp","text":"ckgp(inst, sclkdp, tol, ref)\n\nGet pointing (attitude) for a specified spacecraft clock time.\n\nArguments\n\ninst: NAIF ID of instrument, spacecraft, or structure\nsclkdp: Encoded spacecraft clock time\ntol: Time tolerance\nref: Reference frame\n\nOutputs\n\nReturns nothing if the requested pointing is not available or\n\ncmat: C-matrix pointing data\nclkout: Output encoded spacecraft clock time\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckgpav-NTuple{4, Any}","page":"API","title":"SPICE.ckgpav","text":"ckgpav(inst, sclkdp, tol, ref)\n\nGet pointing (attitude) and angular velocity for a specified spacecraft clock time.\n\nArguments\n\ninst: NAIF ID of instrument, spacecraft, or structure\nsclkdp: Encoded spacecraft clock time\ntol: Time tolerance\nref: Reference frame\n\nOutputs\n\nReturns nothing if the requested pointing is not available or\n\ncmat: C-matrix pointing data\nav: Angular velocity vector\nclkout: Output encoded spacecraft clock time\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cklpf-Tuple{Any}","page":"API","title":"SPICE.cklpf","text":"cklpf(filename)\n\nLoad a CK pointing file for use by the CK readers. Return that file's handle, to be used by other CK routines to refer to the file.\n\nArguments\n\nfilename: Name of the CK file to be loaded\n\nOutput\n\nLoaded file's handle\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckobj!-Tuple{Any, Any}","page":"API","title":"SPICE.ckobj!","text":"ckobj!(ck, ids)\n\nFind the set of ID codes of all objects in a specified CK file.\n\nArguments\n\nck: Name of CK file\nids: Set of ID codes of objects in CK file. Data already present in ids will be combined with ID code set found for the file ck.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckobj-Tuple{Any}","page":"API","title":"SPICE.ckobj","text":"ckobj(ck)\n\nFind the set of ID codes of all objects in a specified CK file.\n\nArguments\n\nck: Name of CK file\n\nOutput\n\nSet of ID codes of objects in CK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckopn","page":"API","title":"SPICE.ckopn","text":"ckopn(fname, ifname=\"CK_file\", ncomch=0)\n\nOpen a new CK file, returning the handle of the opened file.\n\nArguments\n\nfname: The name of the CK file to be opened\nifname: The internal filename for the CK (default: \"CK_file\")\nncomch: The number of characters to reserve for comments (default: 0)\n\nOutput\n\nhandle: The handle of the opened CK file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ckupf-Tuple{Any}","page":"API","title":"SPICE.ckupf","text":"ckupf(handle)\n\nUnload a CK pointing file so that it will no longer be searched by the readers.\n\nArguments\n\nhandle: Handle of CK file to be unloaded\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckw01","page":"API","title":"SPICE.ckw01","text":"ckw01(handle, begtim, endtim, inst, ref, segid, sclkdp, quats, avvs=[zeros(3)])\n\nAdd a type 1 segment to a C-kernel.\n\nArguments\n\nhandle: Handle of an open CK file\nbegtim: The beginning encoded SCLK of the segment\nendtim: The ending encoded SCLK of the segment\ninst: The NAIF instrument ID code\nref: The reference frame of the segment\nsegid: Segment identifier\nsclkdp: Encoded SCLK times\nquats: Quaternions representing instrument pointing\navvs: Angular velocity vectors (optional)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ckw02-NTuple{11, Any}","page":"API","title":"SPICE.ckw02","text":"ckw02(handle, begtim, endtim, inst, ref, segid, start, stop, quats, avvs, rates)\n\nWrite a type 2 segment to a C-kernel.\n\nArguments\n\nhandle: Handle of an open CK file\nbegtim: The beginning encoded SCLK of the segment\nendtim: The ending encoded SCLK of the segment\ninst: The NAIF instrument ID code\nref: The reference frame of the segment\nsegid: Segment identifier\nstart: Encoded SCLK interval start times\nstop: Encoded SCLK interval stop times\nquats: Quaternions representing instrument pointing\navvs: Angular velocity vectors\nrates: Number of seconds per tick for each interval\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ckw03","page":"API","title":"SPICE.ckw03","text":"ckw03(handle, begtim, endtim, inst, ref, segid, sclkdp, quats, starts, avvs=[zeros(3)])\n\nAdd a type 3 segment to a C-kernel.\n\nArguments\n\nhandle: Handle of an open CK file\nbegtim: The beginning encoded SCLK of the segment\nendtim: The ending encoded SCLK of the segment\ninst: The NAIF instrument ID code\nref: The reference frame of the segment\nsegid: Segment identifier\nsclkdp: Encoded SCLK times\nquats: Quaternions representing instrument pointing\nstarts: Encoded SCLK interval start times\navvs: Angular velocity vectors (optional)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ckw05-NTuple{14, Any}","page":"API","title":"SPICE.ckw05","text":"ckw05(handle, subtyp, degree, begtim, endtim, inst, ref, avflag, segid, sclkdp, packts,\n rate, nints, starts)\n\nWrite a type 5 segment to a CK file.\n\nArguments\n\nhandle: Handle of an open CK file\nsubtyp: CK type 5 subtype code\ndegree: Degree of interpolating polynomials\nbegtim: The beginning encoded SCLK of the segment\nendtim: The ending encoded SCLK of the segment\ninst: The NAIF instrument ID code\nref: The reference frame of the segment\navflag: True if the segment will contain angular velocity\nsegid: Segment identifier\nsclkdp: Encoded SCLK times\npackts: Array of packets\nrate: Nominal SCLK rate in seconds per tick\nnints: Number of intervals\nstarts: Encoded SCLK interval start times\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cleard","page":"API","title":"SPICE.cleard","text":"cleard(array)\n\nwarning: Deprecated\nUse empty!(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.clight-Tuple{}","page":"API","title":"SPICE.clight","text":"clight()\n\nReturns the speed of light in vacuo (km/sec).\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.clpool-Tuple{}","page":"API","title":"SPICE.clpool","text":"clpool()\n\nRemove all variables from the kernel pool. Watches on kernel variables are retained.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cmprss-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cmprss","text":"cmprss(delim, n, input)\n\nCompress a character string by removing occurrences of more than n consecutive occurrences of a specified character.\n\nArguments\n\ndelim: Delimiter to be compressed\nn: Maximum consecutive occurrences of delim\ninput: Input string\n\nOutput\n\nReturns the compressed string.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cnmfrm","page":"API","title":"SPICE.cnmfrm","text":"cnmfrm(cname)\n\nRetrieve frame ID code and name to associate with an object.\n\nArguments\n\ncname: Name of the object to find a frame for\n\nOutput\n\nReturns a tuple of the ID code and the name of the frame associated with cname or nothing if no frame is found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.conics-Tuple{Any, Any}","page":"API","title":"SPICE.conics","text":"conics(elts, et)\n\nDetermine the state (position, velocity) of an orbiting body from a set of elliptic, hyperbolic, or parabolic orbital elements.\n\nArguments\n\nelts: Conic elements\net: Input time\n\nOutput\n\nReturns the state of orbiting body at et.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.convrt-Tuple{Any, Any, Any}","page":"API","title":"SPICE.convrt","text":"convrt(x, in, out)\n\nTake a measurement x, the units associated with x, and units to which x should be converted; return y - the value of the measurement in the output units.\n\nArguments\n\nx: Number representing a measurement in some units\nin: The units in which x is measured\nout: Desired units for the measurement\n\nOutput\n\nReturns the measurement in the desired units.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cpos-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cpos","text":"cpos(str, chars, start)\n\nFind the first occurrence in a string of a character belonging to a collection of characters, starting at a specified location, searching forward.\n\nArguments\n\nstr: Any character string\nchars: A collection of characters\nstart: Position to begin looking for one of chars\n\nOutput\n\nReturns the index of the first character of str that is one of the characters in string chars. Returns -1 if none of the characters was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cposr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cposr","text":"cposr(str, chars, start)\n\nFind the first occurrence in a string of a character belonging to a collection of characters, starting at a specified location, searching in reverse.\n\nArguments\n\nstr: Any character string\nchars: A collection of characters\nstart: Position to begin looking for one of chars\n\nOutput\n\nReturns the index of the last character of str that is one of the characters in string chars. Returns -1 if none of the characters was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cvpool-Tuple{Any}","page":"API","title":"SPICE.cvpool","text":"cvpool(agent)\n\nIndicate whether or not any watched kernel variables that have a specified agent on their notification list have been updated.\n\nArguments\n\nagent: Name of the agent to check for notices\n\nOutput\n\nReturns true if variables for agent have been updated.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cyllat-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cyllat","text":"cyllat(r, lonc, z)\n\nConvert from cylindrical to latitudinal coordinates.\n\nArguments\n\nr: Distance of point from z axis\nlonc: Cylindrical angle of point from XZ plane (radians)\nz: Height of point above XY plane\n\nOutput\n\nradius: Radius\nlon: Longitude (radians)\nlat: Latitude (radians)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cylrec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cylrec","text":"cylrec(r, lon, z)\n\nConvert from cylindrical to rectangular coordinates.\n\nArguments\n\nr: Distance of the point of interest from z axis\nlon: Cylindrical angle (in radians) of the point of interest from XZ plane\nz: Height of the point above XY plane\n\nOutput\n\nReturns rectangular coordinates of the point of interest.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.cylsph-Tuple{Any, Any, Any}","page":"API","title":"SPICE.cylsph","text":"cylsph(r, lonc, z)\n\nConvert from cylindrical to spherical coordinates.\n\nArguments\n\nr: Distance of point from z axis\nlonc: Angle (radians) of point from XZ plane\nz: Height of point above XY plane\n\nOutput\n\nradius: Distance of the point from the origin\ncolat: Polar angle (co-latitude in radians)\nlon: Azimuthal angle (longitude)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafac-Tuple{Any, Any}","page":"API","title":"SPICE.dafac","text":"dafac(handle, buffer)\n\nAdd comments from a buffer of character strings to the comment area of a binary DAF file, appending them to any comments which are already present in the file's comment area.\n\nArguments\n\nhandle: Handle of a DAF opened with write access\nbuffer: Buffer of comments to put into the comment area\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafbbs-Tuple{Any}","page":"API","title":"SPICE.dafbbs","text":"dafbbs(handle)\n\nBegin a backward search for arrays in a DAF.\n\nArguments\n\nhandle: Handle of DAF to be searched\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafbfs-Tuple{Any}","page":"API","title":"SPICE.dafbfs","text":"dafbfs(handle)\n\nBegin a forward search for arrays in a DAF.\n\nArguments\n\nhandle: Handle of DAF to be searched\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafcls-Tuple{Any}","page":"API","title":"SPICE.dafcls","text":"dafcls(handle)\n\nClose the DAF associated with a given handle.\n\nArguments\n\nhandle: Handle of DAF to be closed\n\nOutput\n\nReturns the handle of the closed file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafcs-Tuple{Any}","page":"API","title":"SPICE.dafcs","text":"dafcs(handle)\n\nSelect a DAF that already has a search in progress as the one to continue searching.\n\nArguments\n\nhandle: Handle of DAF to continue searching\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafdc-Tuple{Any}","page":"API","title":"SPICE.dafdc","text":"dafdc(handle)\n\nDelete the entire comment area of a specified DAF file.\n\nArguments\n\nhandle: The handle of a binary DAF opened for writing\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafec-Tuple{Any}","page":"API","title":"SPICE.dafec","text":"dafec(handle; bufsiz=256, lenout=1024)\n\nExtract comments from the comment area of a binary DAF.\n\nArguments\n\nhandle: Handle of binary DAF opened with read access\nbufsiz: Maximum size, in lines, of buffer (default: 256)\nlenout: Length of strings in output buffer (default: 1024)\n\nOutput\n\nReturns a buffer where extracted comment lines are placed.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.daffna-Tuple{}","page":"API","title":"SPICE.daffna","text":"daffna()\n\nFind the next (forward) array in the current DAF.\n\nOutput\n\nReturns true if an array was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.daffpa-Tuple{}","page":"API","title":"SPICE.daffpa","text":"daffpa()\n\nFind the previous (backward) array in the current DAF.\n\nOutput\n\nReturns true if an array was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafgda-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dafgda","text":"dafgda(handle, start, stop)\n\nRead the double precision data bounded by two addresses within a DAF.\n\nArguments\n\nhandle: Handle of a DAF\nstart, stop: Initial, final address within file\n\nOutput\n\nReturns the data contained between start and stop.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafgh-Tuple{}","page":"API","title":"SPICE.dafgh","text":"dafgh()\n\nReturn (get) the handle of the DAF currently being searched.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafgn","page":"API","title":"SPICE.dafgn","text":"dafgn(lenout=128)\n\nReturn (get) the name for the current array in the current DAF.\n\nArguments\n\nlenout: Length of array name string (default: 128)\n\nOutput\n\nReturns the name of the current array.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dafgs","page":"API","title":"SPICE.dafgs","text":"dafgs(lenout=128)\n\nReturn (get) the summary for the current array in the current DAF.\n\nArguments\n\nlenout: The maximum length of the summary array\n\nOutput\n\nReturns the summary for the current array.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dafgsr-NTuple{4, Any}","page":"API","title":"SPICE.dafgsr","text":"Read a portion of the contents of a summary record in a DAF file.\n\nArguments\n\nhandle: Handle of DAF\nrecno: Record number\nstart: First word to read from record\nstop: Last word to read from record\n\nOutput\n\nReturns the contents of the record or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafopr-Tuple{Any}","page":"API","title":"SPICE.dafopr","text":"dafopr(fname)\n\nOpen a DAF for subsequent read requests.\n\nArguments\n\nfname: Name of DAF to be opened\n\nOutput\n\nReturns the handle assigned to DAF.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafopw-Tuple{Any}","page":"API","title":"SPICE.dafopw","text":"dafopw(fname)\n\nOpen a DAF for subsequent write requests.\n\nArguments\n\nfname: Name of DAF to be opened\n\nOutput\n\nReturns the handle assigned to DAF.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafps-Tuple{Any, Any}","page":"API","title":"SPICE.dafps","text":"dafps(dc, ic)\n\nPack (assemble) an array summary from its double precision and integer components.\n\nArguments\n\ndc: Double precision components\nic: Integer components\n\nOutput\n\nReturns the array summary.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafrfr","page":"API","title":"SPICE.dafrfr","text":"dafrfr(handle, lenout=128)\n\nRead the contents of the file record of a DAF.\n\nArguments\n\nhandle: Handle of an open DAF file\nlenout: Available room in the output string `ifname' (default: 128)\n\nOutput\n\nnd: Number of double precision components in summaries\nni: Number of integer components in summaries\nifname: Internal file name\nfward: Forward list pointer\nbward: Backward list pointer\nfree: Free address pointer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dafrs-Tuple{Any}","page":"API","title":"SPICE.dafrs","text":"dafrs(sum)\n\nChange the summary for the current array in the current DAF.\n\nArguments\n\nsum: New summary for current array\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dafus-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dafus","text":"dafus(sum, nd, ni)\n\nUnpack an array summary into its double precision and integer components.\n\nArguments\n\nsum: Array summary\nnd: Number of double precision components\nni: Number of integer components\n\nOutput\n\ndc: Double precision components\nic: Integer components\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dasac-Tuple{Any, Any}","page":"API","title":"SPICE.dasac","text":"dasac(handle, buffer)\n\nAdd comments from a buffer of character strings to the comment area of a binary DAS file, appending them to any comments which are already present in the file's comment area.\n\nArguments\n\nhandle: Handle of a DAS opened with write access\nbuffer: Buffer of comments to put into the comment area\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dascls-Tuple{Any}","page":"API","title":"SPICE.dascls","text":"dascls(handle)\n\nClose the DAS associated with a given handle.\n\nArguments\n\nhandle: Handle of DAS to be closed\n\nOutput\n\nReturns the handle of the closed file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dasdc-Tuple{Any}","page":"API","title":"SPICE.dasdc","text":"dasdc(handle)\n\nDelete the entire comment area of a specified DAS file.\n\nArguments\n\nhandle: The handle of a binary DAS opened for writing\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dasec-Tuple{Any}","page":"API","title":"SPICE.dasec","text":"dasec(handle; bufsiz=256, lenout=1024)\n\nExtract comments from the comment area of a binary DAS.\n\nArguments\n\nhandle: Handle of binary DAS opened with read access\nbufsiz: Maximum size, in lines, of buffer (default: 256)\nlenout: Length of strings in output buffer (default: 1024)\n\nOutput\n\nReturns a buffer where extracted comment lines are placed.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dashfn","page":"API","title":"SPICE.dashfn","text":"dashfn(handle, namelen=256)\n\nReturn the name of the DAS file associated with a handle.\n\nArguments\n\nhandle: Handle of a DAS file\nnamlen: Length of output file name string (default: 256)\n\nOutput\n\nReturns the corresponding file name.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dasopr-Tuple{Any}","page":"API","title":"SPICE.dasopr","text":"dasopr(fname)\n\nOpen a DAS for subsequent read requests.\n\nArguments\n\nfname: Name of DAS to be opened\n\nOutput\n\nReturns the handle assigned to DAS.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dasopw-Tuple{Any}","page":"API","title":"SPICE.dasopw","text":"dasopw(fname)\n\nOpen a DAS for subsequent write requests.\n\nArguments\n\nfname: Name of DAS to be opened\n\nOutput\n\nReturns the handle assigned to DAS.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dasrfr","page":"API","title":"SPICE.dasrfr","text":"dasrfr(handle, idwlen=128, ifnlen=256)\n\nRead the contents of the file record of a DAS.\n\nArguments\n\nhandle: DAS file handle\nidwlen: Length of ID word string (default: 128)\nifnlen: Length of internal file name string (default: 256)\n\nOutput\n\nidword: ID word\nifname: DAS internal file name\nnresvr: Number of reserved records in file\nnresvc: Number of characters in use in reserved records area\nncomr: Number of comment records in file\nncomc: Number of characters in use in comment area\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dazldr-NTuple{5, Any}","page":"API","title":"SPICE.dazldr","text":"dazldr(x, y, z, azccw, elplsz)\n\nCompute the Jacobian matrix of the transformation from rectangular to azimuth/elevation coordinates.\n\nArguments\n\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\nazccw: Flag indicating how azimuth is measured. If true, the azimuth increases in the counterclockwise direction; otherwise it increases in the clockwise direction\nelplsz: Flag indicating how elevation is measured. If true, the elevation increases from the XY plane toward +Z; otherwise toward -Z\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dcyldr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dcyldr","text":"dcyldr(x, y, z)\n\nCompute the Jacobian of the transformation from rectangular to cylindrical coordinates.\n\nArguments\n\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.deltet-Tuple{Any, Any}","page":"API","title":"SPICE.deltet","text":"deltet(epoch, eptype)\n\nReturn the value of ΔET (ET-UTC) for an input epoch.\n\nArguments\n\nepoch: Input epoch (seconds past J2000)\neptype: Type of input epoch (\"UTC\" or \"ET\")\n\nOutput\n\nReturns ΔET (ET-UTC) at input epoch.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dgeodr-NTuple{5, Any}","page":"API","title":"SPICE.dgeodr","text":"dgeodr(x, y, z, re, f)\n\nCompute the Jacobian of the transformation from rectangular to geodetic coordinates.\n\nArguments\n\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.diags2-Tuple{Any}","page":"API","title":"SPICE.diags2","text":"diags2(symmat)\n\nDiagonalize a symmetric 2x2 matrix.\n\nArguments\n\nsymmat: A symmetric 2x2 matrix\n\nOutput\n\ndiag: A diagonal matrix similar to symmat\nrotate: A rotation used as the similarity transformation\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dlabbs-Tuple{Any}","page":"API","title":"SPICE.dlabbs","text":"dlabbs(handle)\n\nBegin a backward segment search in a DLA file.\n\nArguments\n\nhandle: Handle of open DLA file\n\nOutput\n\nReturns the descriptor of the last segment in the DLA file or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dlabfs-Tuple{Any}","page":"API","title":"SPICE.dlabfs","text":"dlabfs(handle)\n\nBegin a forward segment search in a DLA file.\n\nArguments\n\nhandle: Handle of open DLA file\n\nOutput\n\nReturns the descriptor of the first segment in the DLA file or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dlafns-Tuple{Any, Any}","page":"API","title":"SPICE.dlafns","text":"dlafns(handle, descr)\n\nFind the segment following a specified segment in a DLA file.\n\nArguments\n\nhandle: Handle of open DLA file\ndescr: Descriptor of a DLA segment\n\nOutput\n\nReturns the descriptor of the next segment in the DLA file or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dlafps-Tuple{Any, Any}","page":"API","title":"SPICE.dlafps","text":"dlafps(handle, descr)\n\nFind the segment preceding a specified segment in a DLA file.\n\nArguments\n\nhandle: Handle of open DLA file\ndescr: Descriptor of a DLA segment\n\nOutput\n\nReturns the descriptor of the previous segment in the DLA file or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dlatdr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dlatdr","text":"dlatdr(x, y, z)\n\nCompute the Jacobian of the transformation from rectangular to latitudinal coordinates.\n\nArguments\n\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dp2hx","page":"API","title":"SPICE.dp2hx","text":"dp2hx(number, lenout=128)\n\nConvert a double precision number to an equivalent character string using base 16 \"scientific notation.\"\n\nArguments\n\nnumber: Number to be converted\nlenout: Available space for output string\n\nOutput\n\nReturns the equivalent character string, left justified.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dpgrdr-NTuple{6, Any}","page":"API","title":"SPICE.dpgrdr","text":"dpgrdr(x, y, z, re, f)\n\nCompute the Jacobian of the transformation from rectangular to planetographic coordinates.\n\nArguments\n\nbody: Body with which coordinate system is associated\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dpmax","page":"API","title":"SPICE.dpmax","text":"dpmax()\n\nwarning: Deprecated\nUse prevfloat(typemax(Float64)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dpmin","page":"API","title":"SPICE.dpmin","text":"dpmin()\n\nwarning: Deprecated\nUse nextfloat(typemin(Float64)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dpr","page":"API","title":"SPICE.dpr","text":"dpr()\n\nwarning: Deprecated\nUse rad2deg(1.0) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.drdazl-NTuple{5, Any}","page":"API","title":"SPICE.drdazl","text":"drdazl(range, az, el, azccw, elplsz)\n\nCompute the Jacobian matrix of the transformation from azimuth/elevation to rectangular coordinates.\n\nArguments\n\nrange: Distance of a point from the origin\naz: Azimuth of input point in radians\nel: Elevation of input point in radians\nazccw: Flag indicating how azimuth is measured. If true, the azimuth increases in the counterclockwise direction; otherwise it increases in the clockwise direction\nelplsz: Flag indicating how elevation is measured. If true, the elevation increases from the XY plane toward +Z; otherwise toward -Z\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.drdcyl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.drdcyl","text":"drdcyl(r, lon, z)\n\nCompute the Jacobian of the transformation from cylindrical to rectangular coordinates.\n\nArguments\n\nr: Distance of a point from the origin\nlon: Angle of the point from the xz plane in radians\nz: Height of the point above the xy plane\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.drdgeo-NTuple{5, Any}","page":"API","title":"SPICE.drdgeo","text":"drdgeo(lon, lat, alt, re, f)\n\nCompute the Jacobian of the transformation from geodetic to rectangular coordinates.\n\nArguments\n\nlon: Geodetic longitude of point (radians)\nlat: Geodetic latitude of point (radians)\nalt: Altitude of point above the reference spheroid\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.drdlat-Tuple{Any, Any, Any}","page":"API","title":"SPICE.drdlat","text":"drdlat(radius, lon, lat)\n\nCompute the Jacobian of the transformation from latitudinal to rectangular coordinates.\n\nArguments\n\nradius: Distance of a point from the origin\nlon: Angle of the point from the XZ plane in radians\nlat: Angle of the point from the XY plane in radians\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.drdpgr-NTuple{6, Any}","page":"API","title":"SPICE.drdpgr","text":"drdpgr(body, lon, lat, alt, re, f)\n\nCompute the Jacobian matrix of the transformation from planetographic to rectangular coordinates.\n\nArguments\n\nbody: Name of body with which coordinates are associated\nlon: Planetographic longitude of a point (radians)\nlat: Planetographic latitude of a point (radians)\nalt: Altitude of a point above reference spheroid\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.drdsph-Tuple{Any, Any, Any}","page":"API","title":"SPICE.drdsph","text":"drdsph(r, colat, lon)\n\nCompute the Jacobian of the transformation from latitudinal to rectangular coordinates.\n\nArguments\n\nr: Distance of a point from the origin\ncolat: Angle of the point from the positive z-axis\nlon: Angle of the point from the xy plane\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskb02-Tuple{Any, Any}","page":"API","title":"SPICE.dskb02","text":"dskb02(handle, dladsc)\n\nReturn bookkeeping data from a DSK type 2 segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\n\nOutput\n\nnv: Number of vertices in model\nnp: Number of plates in model\nnvxtot: Number of voxels in fine grid\nvtxbds: Vertex bounds\nvoxsiz: Fine voxel edge length\nvoxori: Fine voxel grid origin\nvgrext: Fine voxel grid exent\ncgscal: Coarse voxel grid scale\nvtxnpl: Size of vertex-plate correspondence list\nvoxnpt: Size of voxel-plate pointer list\nvoxnpl: Size of voxel-plate correspondence list\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskcls","page":"API","title":"SPICE.dskcls","text":"dskcls(handle, optmiz=true)\n\nClose a DSK file.\n\nArguments\n\nhandle: Handle assigned to the opened DSK file\noptmiz: Flag indicating whether to segregate the DSK (default: true)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dskd02-NTuple{5, Any}","page":"API","title":"SPICE.dskd02","text":"dskd02(handle, dladsc, item, start, room)\n\nFetch double precision data from a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\nitem: Keyword identifying item to fetch\nstart: Start index\nroom: Amount of room in output array\n\nOutput\n\nReturns an array containing the requested item.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskgd-Tuple{Any, Any}","page":"API","title":"SPICE.dskgd","text":"dskgd(handle, dladsc)\n\nReturn the DSK descriptor from a DSK segment identified by a DAS handle and DLA descriptor.\n\nArguments\n\nhandle: Handle of a DSK file\ndladsc: DLA segment descriptor\n\nOutput\n\nReturns the DSK segment descriptor.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskgtl-Tuple{Any}","page":"API","title":"SPICE.dskgtl","text":"dskgtl(keywrd)\n\nRetrieve the value of a specified DSK tolerance or margin parameter.\n\nArguments\n\nkeywrd: Code specifying parameter to retrieve\n\nOutput\n\nReturns the value of the parameter.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dski02-NTuple{5, Any}","page":"API","title":"SPICE.dski02","text":"dski02(handle, dladsc, item, start, room)\n\nFetch integer data from a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\nitem: Keyword identifying item to fetch\nstart: Start index\nroom: Amount of room in output array\n\nOutput\n\nReturns an array containing the requested item.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskmi2-NTuple{9, Any}","page":"API","title":"SPICE.dskmi2","text":"dskmi2(vrtces, plates, finscl, corscl, worksz, voxpsz, voxlsz, makvtl, spaisz)\n\nMake spatial index for a DSK type 2 segment.\n\nArguments\n\nvrtces: Vertices\nplates: Plates\nfinscl: Fine voxel scale\ncorscl: Coarse voxel scale\nworksz: Workspace size\nvoxpsz: Voxel-plate pointer array size\nvoxlsz: Voxel-plate list array size\nmakvtl: Vertex-plate list flag\nspxisz: Spatial index integer component size\n\nOutput\n\nspaixd: Double precision component of spatial index.\nspaixi: Integer component of spatial index.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskn02-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dskn02","text":"dskn02(handle, dladsc, plid)\n\nCompute the unit normal vector for a specified plate from a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\nplid: Plate ID\n\nOutput\n\nReturn the plate's unit normal vector.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskobj!-Tuple{Any, Any}","page":"API","title":"SPICE.dskobj!","text":"dskobj!(set, dsk)\n\nFind the set of body ID codes of all objects for which topographic data are provided in a specified DSK file.\n\nArguments\n\ndsk: Name of DSK file\nset or len: Either a preallocated SpiceIntCell or the size of the output set.\n\nOutput\n\nReturns the set of ID codes of objects in the DSK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskopn-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dskopn","text":"dskopn(fname, ifname, ncomch)\n\nOpen a new DSK file for subsequent write operations.\n\nArguments\n\nfname: Name of a DSK file to be opened\nifname: Internal file name\nncomch: Number of comment characters to allocate\n\nOutput\n\nReturns the handle assigned to the opened DSK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskp02-NTuple{4, Any}","page":"API","title":"SPICE.dskp02","text":"dskp02(handle, dladsc, start, room)\n\nFetch triangular plates from a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\nstart: Start index\nroom: Amount of room in output array\n\nOutput\n\nReturns an array of plates.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskrb2-NTuple{4, Any}","page":"API","title":"SPICE.dskrb2","text":"dskrb2(vrtces, plates, corsys, corpar)\n\nDetermine range bounds for a set of triangular plates to be stored in a type 2 DSK segment.\n\nArguments\n\nvrtces: Vertices\nplates: Plates\ncorsys: DSK coordinate system code\ncorpar: DSK coordinate system parameters\n\nOutput\n\nmncor3: Lower bound on range of third coordinate\nmxcor3: Upper bound on range of third coordinate\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dsksrf!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dsksrf!","text":"dsksrf!(set, dsk)\n\nFind the set of surface ID codes of all objects for which topographic data are provided in a specified DSK file.\n\nArguments\n\ndsk: Name of DSK file\nset or len: Either a preallocated SpiceIntCell or the size of the output set.\n\nOutput\n\nReturns the set of ID codes of surfaces in the DSK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskstl-Tuple{Any, Any}","page":"API","title":"SPICE.dskstl","text":"dskstl(keywrd)\n\nSet the value of a specified DSK tolerance or margin parameter.\n\nArguments\n\nkeywrd: Code specifying parameter to retrieve\ndpval: Value of parameter\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskv02-NTuple{4, Any}","page":"API","title":"SPICE.dskv02","text":"dskv02(handle, dladsc, start, room)\n\nFetch vertices from a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\nstart: Start index\nroom: Amount of room in output array\n\nOutput\n\nReturns an array of vertices.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskw02-NTuple{19, Any}","page":"API","title":"SPICE.dskw02","text":"dskw02(handle, center, surfid, dclass, frame, corsys, corpar, mncor1, mxcor1,\n mncor2, mxcor2, mncor3, mxcor3, first, last, vrtces, plates, spaixd, spaixi)\n\nWrite a type 2 segment to a DSK file.\n\nArguments\n\nhandle: Handle assigned to the opened DSK file\ncenter: Central body ID code\nsurfid: Surface ID code\ndclass: Data class\nframe: Reference frame\ncorsys: Coordinate system code\ncorpar: Coordinate system parameters\nmncor1: Minimum value of first coordinate\nmxcor1: Maximum value of first coordinate\nmncor2: Minimum value of second coordinate\nmxcor2: Maximum value of second coordinate\nmncor3: Minimum value of third coordinate\nmxcor3: Maximum value of third coordinate\nfirst: Coverage start time\nlast: Coverage stop time\nnv: Number of vertices\nvrtces: Vertices\nnp: Number of plates\nplates: Plates\nspaixd: Double precision component of spatial index\nspaixi: Integer component of spatial index\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskx02-NTuple{4, Any}","page":"API","title":"SPICE.dskx02","text":"dskx02(handle, dladsc, vertex, raydir)\n\nDetermine the plate ID and body-fixed coordinates of the intersection of a specified ray with the surface defined by a type 2 DSK plate model.\n\nArguments\n\nhandle: Handle of DSK kernel containing plate model\ndladsc: DLA descriptor of plate model segment\nvertex: Ray vertex in the body fixed frame\nraydir: Ray direction in the body fixed frame\n\nOutput\n\nReturns nothing if no intercept exists or\n\nplid: ID code of the plate intersected by the ray\nxpt: Intercept\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskxsi","page":"API","title":"SPICE.dskxsi","text":"dskxsi(pri, target, nsurf, srflst, et, fixref, vertex, raydir, maxd=1, maxi=1)\n\nCompute a ray-surface intercept using data provided by multiple loaded DSK segments. Return information about the source of the data defining the surface on which the intercept was found: DSK handle, DLA and DSK descriptors, and DSK data type-dependent parameters.\n\nArguments\n\npri: Data prioritization flag\ntarget: Target body name\nsrflst: Surface ID list\net: Epoch, expressed as seconds past J2000 TDB\nfixref: Name of target body-fixed reference frame\nvertex: Vertex of ray\nraydir: Direction vector of ray\nmaxd: Size of DC array (default: 1)\nmaxi: Size of IC array (default: 1)\n\nOutput\n\nReturns nothing if no intercept exists or\n\nxpt: Intercept point\nhandle: Handle of segment contributing surface data\ndladsc: DLA descriptor of segment\ndskdsc: DSK descriptor of segment\ndc: Double precision component of source info\nic: Integer component of source info\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.dskxv-NTuple{7, Any}","page":"API","title":"SPICE.dskxv","text":"dskxv(pri, target, srflst, et, fixref, nrays, vtxarr, dirarr)\n\nCompute ray-surface intercepts for a set of rays, using data provided by multiple loaded DSK segments.\n\nArguments\n\npri: Data prioritization flag\ntarget: Target body name\nsrflst: Surface ID list\net: Epoch, expressed as seconds past J2000 TDB\nfixref: Name of target body-fixed reference frame\nnrays: Number of rays\nvtxarr: Array of vertices of rays\ndirarr: Array of direction vectors of rays\n\nOutput\n\nxptarr: Intercept point array\nfndarr: Found flag array\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dskz02-Tuple{Any, Any}","page":"API","title":"SPICE.dskz02","text":"dskz02(handle, dladsc)\n\nReturn plate model size parameters - plate count and vertex count - for a type 2 DSK segment.\n\nArguments\n\nhandle: DSK file handle\ndladsc: DLA descriptor\n\nOutput\n\nnv: Number of vertices\nnp: Number of plates\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dsphdr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.dsphdr","text":"dsphdr(x, y, z)\n\nCompute the Jacobian of the transformation from rectangular to spherical coordinates.\n\nArguments\n\nx: X-coordinate of point\ny: Y-coordinate of point\nz: Z-coordinate of point\n\nOutput\n\nReturns the matrix of partial derivatives.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dtpool-Tuple{Any}","page":"API","title":"SPICE.dtpool","text":"dtpool(name)\n\nReturn the data about a kernel pool variable.\n\nArguments\n\nname: Name of the variable whose value is to be returned\n\nOutput\n\nReturns the tuple (n ,vartype).\n\nn: Number of values returned for name\nvartype: Type of the variable\n:C if the data is character data\n:N if the data is numeric\n:X if there is no variable name in the pool\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ducrss-Tuple{Any, Any}","page":"API","title":"SPICE.ducrss","text":"ducrss(s1, s2)\n\nCompute the unit vector parallel to the cross product of two 3-dimensional vectors and the derivative of this unit vector.\n\nArguments\n\ns1: Left hand state for cross product and derivative\ns2: Right hand state for cross product and derivative\n\nOutput\n\nReturns the unit vector and derivative of the cross product.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvcrss-Tuple{Any, Any}","page":"API","title":"SPICE.dvcrss","text":"dvcrss(s1, s2)\n\nCompute the cross product of two 3-dimensional vectors and the derivative of this cross product.\n\nArguments\n\ns1: Left hand state for cross product and derivative\ns2: Right hand state for cross product and derivative\n\nOutput\n\nReturns the cross product and its derivative.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvdot-Tuple{Any, Any}","page":"API","title":"SPICE.dvdot","text":"dvdot(s1, s2)\n\nCompute the derivative of the dot product of two double precision position vectors.\n\nArguments\n\ns1: First state vector in the dot product\ns2: Second state vector in the dot product\n\nOutput\n\nReturns the derivative of the dot product s1 ⋅ s2.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvhat-Tuple{Any}","page":"API","title":"SPICE.dvhat","text":"dvhat(s1)\n\nFind the unit vector corresponding to a state vector and the derivative of the unit vector.\n\nArguments\n\ns1: State to be normalized\n\nOutput\n\nReturns the unit vector s1 / |s1|, and its time derivative.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvnorm-Tuple{Any}","page":"API","title":"SPICE.dvnorm","text":"dvnorm(state)\n\nFunction to calculate the derivative of the norm of a 3-vector.\n\nArguments\n\nstate: A 6-vector composed of three coordinates and their derivatives.\n\nOutput\n\nReturns the derivative of the norm of state.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvpool-Tuple{Any}","page":"API","title":"SPICE.dvpool","text":"dvpool(name)\n\nDelete a variable from the kernel pool.\n\nArguments\n\nname: Name of the kernel variable to be deleted\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.dvsep-Tuple{Any, Any}","page":"API","title":"SPICE.dvsep","text":"dvsep(s1, s2)\n\nCalculate the time derivative of the separation angle between two input states, s1 and s2.\n\nArguments\n\ns1: State vector of the first body\ns2: State vector of the second body\n\nOutput\n\nReturns the value of the time derivative of the angular separation between s1 and s2.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.edlimb-NTuple{4, Any}","page":"API","title":"SPICE.edlimb","text":"edlimb(a, b, c, viewpt)\n\nFind the limb of a triaxial ellipsoid, viewed from a specified point.\n\nArguments\n\na: Length of ellipsoid semi-axis lying on the x-axis\nb: Length of ellipsoid semi-axis lying on the y-axis\nc: Length of ellipsoid semi-axis lying on the z-axis\nviewpt: Location of viewing point\n\nOutput\n\nReturns the limb of the ellipsoid as seen from the viewing point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.edterm-NTuple{8, Any}","page":"API","title":"SPICE.edterm","text":"edterm(trmtyp, source, target, et, fixref, abcorr, obsrvr, npts)\n\nCompute a set of points on the umbral or penumbral terminator of a specified target body, where the target shape is modeled as an ellipsoid.\n\nArguments\n\ntrmtyp: Terminator type\nsource: Light source\ntarget: Target body\net: Observation epoch\nfixref: Body-fixed frame associated with target\nabcorr: Aberration correction\nobsrvr: Observer\nnpts: Number of points in terminator set\n\nOutput\n\ntrgepc: Epoch associated with target center\nobspos: Position of observer in body-fixed frame\ntrmpts: Terminator point set\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekacec-NTuple{6, Any}","page":"API","title":"SPICE.ekacec","text":"ekacec(handle, segno, recno, column, cvals, isnull)\n\nAdd data to a character column in a specified EK record.\n\nArguments\n\nhandle: EK file handle\nsegno: Index of segment containing record\nrecno: Record to which data is to be added\ncolumn: Column name\ncvals: Character values to add to column\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekaced-NTuple{6, Any}","page":"API","title":"SPICE.ekaced","text":"ekaced(handle, segno, recno, column, dvals, isnull)\n\nAdd data to an double precision column in a specified EK record.\n\nArguments\n\nhandle: EK file handle\nsegno: Index of segment containing record\nrecno: Record to which data is to be added\ncolumn: Column name\ndvals: Double precision values to add to column\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekacei-NTuple{6, Any}","page":"API","title":"SPICE.ekacei","text":"ekacei(handle, segno, recno, column, ivals, isnull)\n\nAdd data to an integer column in a specified EK record.\n\nArguments\n\nhandle: EK file handle\nsegno: Index of segment containing record\nrecno: Record to which data is to be added\ncolumn: Column name\nivals: Integer values to add to column\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekaclc-NTuple{6, Any}","page":"API","title":"SPICE.ekaclc","text":"ekaclc(handle, segno, column, cvals, nlflgs, rcptrs)\n\nAdd an entire character column to an EK segment.\n\nArguments\n\nhandle: EK file handle.\nsegno: Number of segment to add column to.\ncolumn: Column name.\ncvals: Character values to add to column.\nnlflgs: Array of null flags for column entries.\nrcptrs: Record pointers for segment.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekacld-NTuple{6, Any}","page":"API","title":"SPICE.ekacld","text":"ekacld(handle, segno, column, dvals, nlflgs, rcptrs)\n\nAdd an entire double precision column to an EK segment.\n\nArguments\n\nhandle: EK file handle\nsegno: Number of segment to add column to\ncolumn: Column name\ndvals: Double precision values to add to column\nnlflgs: Array of null flags for column entries\nrcptrs: Record pointers for segment\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekacli-NTuple{6, Any}","page":"API","title":"SPICE.ekacli","text":"ekacli(handle, segno, column, ivals, nlflgs, rcptrs)\n\nAdd an entire integer column to an EK segment.\n\nArguments\n\nhandle: EK file handle\nsegno: Number of segment to add column to\ncolumn: Column name\nivals: Integer values to add to column\nnlflgs: Array of null flags for column entries\nrcptrs: Record pointers for segment\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekappr-Tuple{Any, Any}","page":"API","title":"SPICE.ekappr","text":"ekappr(handle, segno)\n\nAppend a new, empty record at the end of a specified E-kernel segment.\n\nArguments\n\nhandle: File handle\nsegno: Segment number\n\nOutput\n\nReturns the number of appended record.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekbseg-NTuple{4, Any}","page":"API","title":"SPICE.ekbseg","text":"ekbseg(handle, tabnam, cnames, decls)\n\nStart a new segment in an E-kernel.\n\nArguments\n\nhandle: File handle\ntabnam: Table name\ncnames: Names of columns\ndecls: Declarations of columns\n\nOutput\n\nReturns the segment number.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekccnt-Tuple{Any}","page":"API","title":"SPICE.ekccnt","text":"ekccnt(table)\n\nReturn the number of distinct columns in a specified, currently loaded table\n\nArguments\n\ntable: Name of table\n\nOutput\n\nReturns the count of distinct, currently loaded columns.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekcii","page":"API","title":"SPICE.ekcii","text":"ekcii(table, cindex, lenout=256)\n\nReturn attribute information about a column belonging to a loaded EK table, specifying the column by table and index.\n\nArguments\n\ntable: Name of table containing column\ncindex: Index of column whose attributes are to be found\nlenout: Maximum allowed length of column name (default: 256)\n\nOutput\n\ncolumn: Name of column\nattdsc: Column attribute descriptor\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekcls-Tuple{Any}","page":"API","title":"SPICE.ekcls","text":"ekcls(handle)\n\nClose an E-kernel.\n\nArguments\n\nhandle: EK file handle\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekdelr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekdelr","text":"ekdelr(handle, segno, recno)\n\nDelete a specified record from a specified E-kernel segment.\n\nArguments\n\nhandle: File handle\nsegno: Segment number\nrecno: Record number\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekffld-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekffld","text":"ekffld(handle, segno, rcptrs)\n\nComplete a fast write operation on a new E-kernel segment.\n\nArguments\n\nhandle: File handle\nsegno: Segment number\nrcptrs: Record pointers\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekfind","page":"API","title":"SPICE.ekfind","text":"ekfind(query, lenout=256)\n\nFind E-kernel data that satisfy a set of constraints.\n\nArguments\n\nquery: Query specifying data to be found.\nlenout: Declared length of output error message string (default: 256)\n\nOutput\n\nReturns the number of matching rows.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekgc","page":"API","title":"SPICE.ekgc","text":"ekgc(selidx, row, elment, lenout=256)\n\nReturn an element of an entry in a column of character type in a specified row.\n\nArguments\n\nselidx: Index of parent column in SELECT clause\nrow: Row to fetch from\nelment: Index of element, within column entry, to fetch\nlenout: Maximum length of column element (default: 256)\n\nOutput\n\nReturns the character string element of column entry or missing if it was null or nothing if the column was not found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekgd-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekgd","text":"ekgd(selidx, row, element)\n\nReturn an element of an entry in a column of double precision type in a specified row.\n\nArguments\n\nselidx: Index of parent column in SELECT clause\nrow: Row to fetch from\nelment: Index of element, within column entry, to fetch\n\nOutput\n\nReturns the double precision element of column entry or missing if it was null or nothing if the column was not found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekgi-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekgi","text":"ekgi(selidx, row, element)\n\nReturn an element of an entry in a column of integer type in a specified row.\n\nArguments\n\nselidx: Index of parent column in SELECT clause\nrow: Row to fetch from\nelment: Index of element, within column entry, to fetch\n\nOutput\n\nReturns the integer element of column entry or missing if it was null or nothing if the column was not found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekifld-NTuple{5, Any}","page":"API","title":"SPICE.ekifld","text":"ekifld(handle, tabnam, nrows, cnames, decls)\n\nInitialize a new E-kernel segment to allow fast writing.\n\nArguments\n\nhandle: File handle\ntabnam: Table name\nnrows: Number of rows in the segment\ncnames: Names of columns\ndecls: Declarations of columns\n\nOutput\n\nsegno: Segment number\nrcptrs: Array of record pointers\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekinsr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekinsr","text":"ekinsr(handle, segno, recno)\n\nAdd a new, empty record to a specified E-kernel segment at a specified index.\n\nArguments\n\nhandle: File handle\nsegno: Segment number\nrecno: Record number\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.eklef-Tuple{Any}","page":"API","title":"SPICE.eklef","text":"eklef(fname)\n\nLoad an EK file, making it accessible to the EK readers.\n\nArguments\n\nfname: Name of EK file to load\n\nOutput\n\nReturns the file handle of loaded EK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.eknelt-Tuple{Any, Any}","page":"API","title":"SPICE.eknelt","text":"eknelt(selidx, row)\n\nReturn the number of elements in a specified column entry in the current row.\n\nArguments\n\nselidx: Index of parent column in SELECT clause\nrow: Row containing element\n\nOutput\n\nReturns the number of elements in entry in current row.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.eknseg-Tuple{Any}","page":"API","title":"SPICE.eknseg","text":"eknseg(handle)\n\nReturn the number of segments in a specified EK.\n\nArguments\n\nhandle: EK file handle\n\nOutput\n\nReturns the number of segments in the specified E-kernel.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekntab-Tuple{}","page":"API","title":"SPICE.ekntab","text":"ekntab()\n\nReturn the number of loaded EK tables.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekopn-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ekopn","text":"ekopn(fname, ifname, ncomch)\n\nOpen a new E-kernel file and prepare the file for writing.\n\nArguments\n\nfname: Name of EK file\nifname: Internal file name\nncomch: The number of characters to reserve for comments\n\nOutput\n\nReturn the handle attached to the new EK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekopr-Tuple{Any}","page":"API","title":"SPICE.ekopr","text":"ekopr(fname)\n\nOpen an existing E-kernel file for reading.\n\nArguments\n\nfname: Name of EK file\n\nOutput\n\nReturns the handle attached to the EK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekops-Tuple{}","page":"API","title":"SPICE.ekops","text":"ekops()\n\nOpen a scratch (temporary) E-kernel file and prepare the file for writing.\n\nOutput\n\nReturns the handle attached to the EK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekopw-Tuple{Any}","page":"API","title":"SPICE.ekopw","text":"ekopw(fname)\n\nOpen an existing E-kernel file for writing.\n\nArguments\n\nfname: Name of EK file\n\nOutput\n\nReturns the handle attached to the EK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekpsel","page":"API","title":"SPICE.ekpsel","text":"ekpsel(query, msglen=256, tablen=256, collen=256)\n\nParse the SELECT clause of an EK query, returning full particulars concerning each selected item.\n\nArguments\n\nquery: EK query\nmsglen: Available space in the output error message string (default: 256)\ntablen: Length of strings in `tabs' output array (default: 256)\ncollen: Length of strings in `cols' output array (default: 256)\n\nOutput\n\nxbegs: Begin positions of expressions in SELECT clause\nxends: End positions of expressions in SELECT clause\nxtypes: Data types of expressions\nxclass: Classes of expressions\ntabs: Names of tables qualifying SELECT columns\ncols: Names of columns in SELECT clause of query\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekrcec","page":"API","title":"SPICE.ekrcec","text":"ekrcec(handle, segno, recno, column, lenout=256, nelts=100)\n\nRead data from a character column in a specified EK record.\n\nArguments\n\nhandle: Handle attached to EK file\nsegno: Index of segment containing record\nrecno: Record from which data is to be read\ncolumn: Column name\nlenout: Maximum length of output strings\nnelts: Maximum number of elements to return (default: 100)\n\nOutput\n\nReturns the character values in column entry or missing if they are null.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekrced","page":"API","title":"SPICE.ekrced","text":"ekrced(handle, segno, recno, column, nelts=100)\n\nRead data from a double precision column in a specified EK record.\n\nArguments\n\nhandle: Handle attached to EK file\nsegno: Index of segment containing record\nrecno: Record from which data is to be read\ncolumn: Column name\nnelts: Maximum number of elements to return (default: 100)\n\nOutput\n\nReturns the values in column entry.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekrcei","page":"API","title":"SPICE.ekrcei","text":"ekrcei(handle, segno, recno, column, nelts=100)\n\nRead data from an integer column in a specified EK record.\n\nArguments\n\nhandle: Handle attached to EK file\nsegno: Index of segment containing record\nrecno: Record from which data is to be read\ncolumn: Column name\nnelts: Maximum number of elements to return (default: 100)\n\nOutput\n\nReturns the values in column entry.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekssum-Tuple{Any, Any}","page":"API","title":"SPICE.ekssum","text":"ekssum(handle, segno)\n\nReturn summary information for a specified segment in a specified EK.\n\nArguments\n\nhandle: Handle of EK\nsegno: Number of segment to be summarized\n\nOutput\n\nReturns the EK segment summary.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ektnam","page":"API","title":"SPICE.ektnam","text":"ektnam(n, lenout=256)\n\nReturn the name of a specified, loaded table.\n\nArguments\n\nn: Index of table\nlenout: Maximum table name length (default: 256)\n\nOutput\n\nReturns the name of table.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ekucec-NTuple{6, Any}","page":"API","title":"SPICE.ekucec","text":"ekucec(handle, segno, recno, column, cvals, isnull)\n\nUpdate a character column entry in a specified EK record.\n\nArguments\n\nhandle: EK file handle\nsegno: Index of segment containing record\nrecno: Record to which data is to be updated\ncolumn: Column name\ncvals: Character values comprising new column entry\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekuced-NTuple{6, Any}","page":"API","title":"SPICE.ekuced","text":"ekuced(handle, segno, recno, column, dvals, isnull)\n\nUpdate a double precision column entry in a specified EK record.\n\nArguments\n\nhandle: Handle attached to EK file\nsegno: Index of segment containing record\nrecno: Record in which entry is to be updated\ncolumn: Column name\ndvals: Double precision values comprising new column entry\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekucei-NTuple{6, Any}","page":"API","title":"SPICE.ekucei","text":"ekucei(handle, segno, recno, column, dvals, isnull)\n\nUpdate an integer column entry in a specified EK record.\n\nArguments\n\nhandle: Handle attached to EK file\nsegno: Index of segment containing record\nrecno: Record in which entry is to be updated\ncolumn: Column name\nivals: Integer values comprising new column entry\nisnull: Flag indicating whether column entry is null\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ekuef-Tuple{Any}","page":"API","title":"SPICE.ekuef","text":"ekuef(handle)\n\nUnload an EK file, making its contents inaccessible to the EK reader routines, and clearing space in order to allow other EK files to be loaded.\n\nArguments\n\nhandle: Handle of EK file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.el2cgv-Tuple{Any}","page":"API","title":"SPICE.el2cgv","text":"Convert an ellipse to a center vector and two generating vectors. The selected generating vectors are semi-axes of the ellipse.\n\nArguments\n\nellipse: An ellipse\n\nOutput\n\nReturns the center and semi-axes of ellipse.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.elemc","page":"API","title":"SPICE.elemc","text":"elem[c/d/i](item, cell)\n\nwarning: Deprecated\nUse item in cell instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.eqncpv-NTuple{5, Any}","page":"API","title":"SPICE.eqncpv","text":"eqncpv(et, epoch, eqel, rapol, decpol)\n\nCompute the state (position and velocity of an object whose trajectory is described via equinoctial elements relative to some fixed plane (usually the equatorial plane of some planet).\n\nArguments\n\net: Epoch in seconds past J2000 to find state\nepoch: Epoch of elements in seconds past J2000\neqel: Array of equinoctial elements\nrapol: Right Ascension of the pole of the reference plane\ndecpol: Declination of the pole of the reference plane\n\nOutput\n\nReturns the state of the object described by eqel.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.eqstr-Tuple{Any, Any}","page":"API","title":"SPICE.eqstr","text":"eqstr(a, b)\n\nDetermine whether two strings are equivalent.\n\nArguments\n\na, b: Arbitrary character strings\n\nOutput\n\nReturns true if a and b are equivalent.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.esrchc-Tuple{Any, Any}","page":"API","title":"SPICE.esrchc","text":"esrchc(value, array)\n\nSearch for a given value within a character string array.\n\nArguments\n\nvalue: Key value to be found in array\narray: Character string array to search\n\nOutput\n\nReturns the index of the first equivalent array entry, or -1 if no equivalent element is found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.et2lst","page":"API","title":"SPICE.et2lst","text":"et2lst(et, body, lon, typ, timlen=128, ampmlen=128)\n\nGiven an ephemeris epoch, compute the local solar time for an object on the surface of a body at a specified longitude.\n\nArguments\n\net: Epoch in seconds past J2000 epoch\nbody: ID-code of the body of interest\nlon: Longitude of surface point (radians)\ntyp: Type of longitude \"PLANETOCENTRIC\", etc\ntimlen: Available room in output time string (default: 128)\nampmlen: Available room in output `ampm' string (default: 128)\n\nOutput\n\nhr: Local hour on a \"24 hour\" clock\nmn: Minutes past the hour\nsc: Seconds past the minute\ntime: String giving local time on 24 hour clock\nampm: String giving time on A.M./ P.M. scale\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.et2utc-Tuple{Any, Any, Any}","page":"API","title":"SPICE.et2utc","text":"et2utc(et, format, prec)\n\nConvert an input time from ephemeris seconds past J2000 to Calendar, Day-of-Year, or Julian Date format, UTC.\n\nArguments\n\net: Input epoch, given in ephemeris seconds past J2000\nformat: Format of output epoch. It may be any of the following:\n:C: Calendar format, UTC\n:D: Day-of-Year format, UTC\n:J: Julian Date format, UTC\n:ISOC: ISO Calendar format, UTC\n:ISOD: ISO Day-of-Year format, UTC\nprec: Digits of precision in fractional seconds or days\n\nOutput\n\nReturns an output time string equivalent to the input epoch, in the specified format.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.etcal","page":"API","title":"SPICE.etcal","text":"etcal(et, lenout=128)\n\nConvert from an ephemeris epoch measured in seconds past the epoch of J2000 to a calendar string format using a formal calendar free of leapseconds.\n\nArguments\n\net: Ephemeris time measured in seconds past J2000\nlenout: Length of output string (default: 128)\n\nOutput\n\nReturns a standard calendar representation of et.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.eul2m-NTuple{6, Any}","page":"API","title":"SPICE.eul2m","text":"eul2m(angle3, angle2, angle1, axis3, axis2, axis1)\n\nConstruct a rotation matrix from a set of Euler angles.\n\nArguments\n\nangle3, angle2, angle1: Rotation angles about third, second, and first rotation axes (radians)\naxis3, axis2, axis1: Axis numbers of third, second, and first rotation axes\n\nOutput\n\nA rotation matrix corresponding to the product of the 3 rotations.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.eul2xf-NTuple{4, Any}","page":"API","title":"SPICE.eul2xf","text":"eul2xf(eulang, axisa, axisb, axisc)\n\nCompute a state transformation from an Euler angle factorization of a rotation and the derivatives of those Euler angles.\n\nArguments\n\neulang: An array of Euler angles and their derivatives\naxisa: Axis A of the Euler angle factorization\naxisb: Axis B of the Euler angle factorization\naxisc: Axis C of the Euler angle factorization\n\nOutput\n\nReturns a state transformation matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.expool-Tuple{Any}","page":"API","title":"SPICE.expool","text":"expool(name)\n\nConfirm the existence of a kernel variable in the kernel pool.\n\nArguments\n\nname: Name of the variable whose value is to be returned\n\nOutput\n\nReturns true when the variable is in the pool.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.fovray-NTuple{6, Any}","page":"API","title":"SPICE.fovray","text":"fovray(inst, raydir, rframe, abcorr, observer, et)\n\nDetermine if a specified ray is within the field-of-view (FOV) of a specified instrument at a given time.\n\nArguments\n\ninst: Name or ID code string of the instrument\nraydir: Ray's direction vector\nrframe: Body-fixed, body-centered frame for target body\nabcorr: Aberration correction flag\nobserver: Name or ID code string of the observer\net: Time of the observation (seconds past J2000)\n\nOutput\n\nReturns true if the ray is visible.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.fovtrg-NTuple{7, Any}","page":"API","title":"SPICE.fovtrg","text":"fovtrg(inst, target, tshape, tframe, abcorr, obsrvr, et)\n\nDetermine if a specified ephemeris object is within the field-of-view (FOV) of a specified instrument at a given time.\n\nArguments\n\ninst: Name or ID code string of the instrument.\ntarget: Name or ID code string of the target.\ntshape: Type of shape model used for the target.\ntframe: Body-fixed, body-centered frame for target body.\nabcorr: Aberration correction flag.\nobsrvr: Name or ID code string of the observer.\net: Time of the observation (seconds past J2000).\n\nOutput\n\nReturns true if the object is visible.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.frame-Tuple{Any}","page":"API","title":"SPICE.frame","text":"frame(x)\n\nGiven a vector x, this routine builds a right handed orthonormal frame x, y, z where the output x is parallel to the input x.\n\nArguments\n\nx: Input vector\n\nOutput\n\nx: Unit vector parallel to x on output\ny: Unit vector in the plane orthogonal to x\nz: Unit vector given by x × y\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.frinfo-Tuple{Any}","page":"API","title":"SPICE.frinfo","text":"frinfo(frcode)\n\nRetrieve the minimal attributes associated with a frame needed for converting transformations to and from it.\n\nArguments\n\nfrcode: The id code for a reference frame\n\nOutput\n\ncent: The center of the frame\nfrclss: The class (type) of the frame\nclssid: The idcode for the frame within its class\n\nReturns nothing if no frame with id frcode could be found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.frmnam-Tuple{Any}","page":"API","title":"SPICE.frmnam","text":"frmnam(frcode)\n\nRetrieve the name of a reference frame associated with an id code.\n\nArguments\n\nfrcode: The id code for a reference frame\n\nOutput\n\nReturns the name associated with the reference frame.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.furnsh-Tuple","page":"API","title":"SPICE.furnsh","text":"furnsh(kernels...)\n\nLoad one or more SPICE kernels into a program.\n\nArguments\n\nkernels: Path(s) of SPICE kernels to load\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gcpool-Tuple{Any}","page":"API","title":"SPICE.gcpool","text":"gcpool(name; start=1, room=100, lenout=128)\n\nReturn the value of a kernel variable from the kernel pool.\n\nArguments\n\nname: Name of the variable whose value is to be returned\nstart: Which component to start retrieving for name (default: 1)\nroom: The largest number of values to return (default: 100)\nlenout: The length of the longest string to return (default: 128)\n\nOutput\n\nReturns an array of values if the variable exists or nothing if not.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gdpool-Tuple{Any}","page":"API","title":"SPICE.gdpool","text":"gdpool(name; start=1, room=100)\n\nReturn the value of a kernel variable from the kernel pool.\n\nArguments\n\nname: Name of the variable whose value is to be returned\nstart: Which component to start retrieving for name (default: 1)\nroom: The largest number of values to return (default: 100)\n\nOutput\n\nReturns an array of values if the variable exists or nothing if not.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.georec-NTuple{5, Any}","page":"API","title":"SPICE.georec","text":"georec(lon, lat, alt, re, f)\n\nConvert geodetic coordinates to rectangular coordinates.\n\nArguments\n\nlon: Geodetic longitude of point (radians)\nlat: Geodetic latitude of point (radians)\nalt: Altitude of point above the reference spheroid\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nReturns the rectangular coordinates of point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.getelm-Tuple{Any, Any}","page":"API","title":"SPICE.getelm","text":"getelm(frstyr, lines)\n\nGiven the \"lines\" of a two-line element set, parse the lines and return the elements in units suitable for use in SPICE software.\n\nArguments\n\nfrstyr: Year of earliest representable two-line elements\nlines: A pair of \"lines\" containing two-line elements\n\nOutput\n\nepoch: The epoch of the elements in seconds past J2000\nelems: The elements converted to SPICE units\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.getfat","page":"API","title":"SPICE.getfat","text":"getfat(file, arclen=10, typlen=10)\n\nDetermine the file architecture and file type of most SPICE kernel files.\n\nArguments\n\nfile: The name of a file to be examined\narclen: Maximum length of output architecture string (default: 10)\ntyplen: Maximum length of output type string (default: 10)\n\nOutput\n\narch: The architecture of the kernel file\ntyp: The type of the kernel file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.getfov","page":"API","title":"SPICE.getfov","text":"getfov(instid, room=10, shapelen=128, framelen=128)\n\nReturn the field-of-view (FOV) parameters for a specified instrument. The instrument is specified by its NAIF ID code.\n\nArguments\n\ninstid: NAIF ID of an instrument\nroom: Maximum number of vectors that can be returned (default: 10)\nshapelen: Space available in the string shape (default: 128)\nframelen: Space available in the string frame (default: 128)\n\nOutput\n\nReturns a tuple consisting of\n\nshape: Instrument FOV shape\nframe: Name of the frame in which FOV vectors are defined\nbsight: Boresight vector\nbounds: FOV boundary vectors\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.gfdist-NTuple{9, Any}","page":"API","title":"SPICE.gfdist","text":"gfdist(target, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)\n\nReturn the time window over which a specified constraint on observer-target distance is met.\n\nArguments\n\ntarget: Name of the target body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nrelate: Relational operator\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is confined\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfevnt-NTuple{18, Any}","page":"API","title":"SPICE.gfevnt","text":"gfevnt(udstep, udrefn, gquant, qnpars, lenvals, qpnams, qcpars, qdpars, qipars, qlpars,\n op, refval, tol, adjust, rpt, udrepi, udrepu, udrepf, nintvls, bail, udbail, cnfine)\n\nDetermine time intervals when a specified geometric quantity satisfies a specified mathematical condition.\n\nArguments\n\nudstep: Name of the routine that computes and returns a time step\nudrefn: Name of the routine that computes a refined time\ngquant: Type of geometric quantity\nqpnams: Names of quantity definition parameters\nqcpars: Array of character quantity definition parameters\nqdpars: Array of double precision quantity definition parameters\nqipars: Array of integer quantity definition parameters\nqlpars: Array of logical quantity definition parameters\nop: Operator that either looks for an extreme value (max, min, local, absolute) or compares the geometric quantity value and a number\nrefval: Reference value\ntol: Convergence tolerance in second\nadjust: Absolute extremum adjustment value\nrpt: Progress reporter on (true) or off (false)\nudrepi: Function that initializes progress reporting\nudrepu: Function that updates the progress report\nudrepf: Function that finalizes progress reporting\nnintvls: Workspace window interval coun\ncnfine: SPICE window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gffove!-NTuple{16, Any}","page":"API","title":"SPICE.gffove!","text":"gffove!(inst, tshape, raydir, target, tframe, abcorr, obsrvr, tol, udstep, udrefn,\n rpt, udrepi, udrepu, udrepf, cnfine, result)\n\nDetermine time intervals when a specified target body or ray intersects the space bounded by the field-of-view (FOV) of a specified instrument.\n\nArguments\n\ninst: Name of the instrument\ntshape: Type of shape model used for target body\nraydir: Ray's direction vector\ntarget: Name of the target body\ntframe: Body-fixed, body-centered frame for target body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\ntol: Convergence tolerance in seconds\nudstep: Name of the routine returns a time step\nudrefn: Name of the routine that computes a refined time\nrpt: Progress report flag\nudrepi: Function that initializes progress reporting\nudrepu: Function that updates the progress report\nudrepf: Function that finalizes progress reporting\ncnfine: SPICE window to which the search is restricted\nresult: Window containing the results\n\nOutput\n\nReturns result.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfilum-NTuple{14, Any}","page":"API","title":"SPICE.gfilum","text":"gfilum(method, angtyp, target, illmn, fixref, abcorr, obsrvr, spoint, relate, refval,\n adjust, step, nintvls, cnfine)\n\nReturn the time window over which a specified constraint on the observed phase, solar incidence, or emission angle at a specifed target body surface point is met.\n\nArguments\n\nmethod: Computation method\nangtyp: Type of illumination angle\ntarget: Name of the target body\nillmn: Name of the illumination source\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nspoint: Body-fixed coordinates of a target surface point\nrelate: Relational operator\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is confined\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfocce!-NTuple{18, Any}","page":"API","title":"SPICE.gfocce!","text":"function gfocce!(occtyp, front, fshape, fframe, back, bshape, bframe, abcorr, obsrvr, tol,\n udstep, udrefn, rpt, udrepi, udrepu, udrepf, cnfine, result)\n\nDetermine time intervals when an observer sees one target occulted by another.\n\nArguments\n\nocctyp: Type of occultation\nfront: Name of body occulting the other\nfshape: Type of shape model used for front body\nfframe: Body-fixed, body-centered frame for front body\nback: Name of body occulted by the other\nbshape: Type of shape model used for back body\nbframe: Body-fixed, body-centered frame for back body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\ntol: Convergence tolerance in seconds\nudstep: Name of the routine that returns a time step\nudrefn: Name of the routine that computes a refined time\nrpt: Progress report flag\nudrepi: Function that initializes progress reporting\nudrepu: Function that updates the progress report\nudrepf: Function that finalizes progress reporting\ncnfine: SPICE window to which the search is restricted\nresult: SPICE window containing results\n\nOutput\n\nReturns result.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfoclt","page":"API","title":"SPICE.gfoclt","text":"gfoclt(occtyp, front, fshape, fframe, back, bshape, bframe, abcorr, obsrvr, step, cnfine,\n maxwin=100)\n\nDetermine time intervals when an observer sees one target occulted by, or in transit across, another.\n\nThe surfaces of the target bodies may be represented by triaxial ellipsoids or by topographic data provided by DSK files.\n\nArguments\n\nocctyp: Type of occultation\nfront: Name of body occulting the other\nfshape: Type of shape model used for front body\nfframe: Body-fixed, body-centered frame for front body\nback: Name of body occulted by the other\nbshape: Type of shape model used for back body\nbframe: Body-fixed, body-centered frame for back body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nstep: Step size in seconds for finding occultation events\ncnfine: Window to which the search is restricted\nmaxwin: Maximum size of the output window (default: 100)\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.gfpa-NTuple{10, Any}","page":"API","title":"SPICE.gfpa","text":"gfpa(result, target, illmn, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)\n\nDetermine time intervals for which a specified constraint on the phase angle between an illumination source, a target, and observer body centers is met.\n\nArguments\n\ntarget: Name of the target body\nillmn: Name of the illuminating body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nrelate: Relational operator\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is confined\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfposc-NTuple{12, Any}","page":"API","title":"SPICE.gfposc","text":"gfposc(target, frame, abcorr, obsrvr, crdsys, coord, relate, refval, adjust, step,\n nintvls, cnfine)\n\nDetermine time intervals for which a coordinate of an observer-target position vector satisfies a numerical constraint.\n\nArguments\n\ntarget: Name of the target body\nframe: Name of the reference frame for coordinate calculations\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\ncrdsys: Name of the coordinate system containing coord\ncoord: Name of the coordinate of interest\nrelate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfrefn-NTuple{4, Any}","page":"API","title":"SPICE.gfrefn","text":"gfrefn(t1, t2, s1, s2)\n\nFor those times when we can't do better, we use a bisection method to find the next time at which to test for state change.\n\nArguments\n\nt1: One of two values bracketing a state change\nt2: The other value that brackets a state change\ns1: State at t1\ns2: State at t2\n\nOutput\n\nReturns the new value at which to check for transition.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfrepf-Tuple{}","page":"API","title":"SPICE.gfrepf","text":"gfrepf()\n\nFinish a GF progress report.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfrepi-Tuple{SpiceDoubleCell, Any, Any}","page":"API","title":"SPICE.gfrepi","text":"gfrepi(window, begmss, endmss)\n\nInitialize a search progress report.\n\nArguments\n\nwindow: A window over which a job is to be performed\nbegmss: Beginning of the text portion of the output message\nendmss: End of the text portion of the output message\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfrepu-Tuple{Any, Any, Any}","page":"API","title":"SPICE.gfrepu","text":"gfrepu(ivbeg, ivend, time)\n\nTell the progress reporting system how far a search has progressed.\n\nArguments\n\nivbeg: Start time of work interval\nivend: End time of work interval\ntime: Current time being examined in the search process\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfrfov","page":"API","title":"SPICE.gfrfov","text":"gfrfov(inst, raydir, rframe, abcorr, obsrvr, step, cnfine, maxwin=10000)\n\nDetermine time intervals when a specified ray intersects the space bounded by the field-of-view (FOV) of a specified instrument.\n\nArguments\n\ninst: Name of the instrument\nraydir: Ray's direction vector\nrframe: Reference frame of ray's direction vector\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nstep: Step size in seconds for finding FOV events\ncnfine: SPICE window to which the search is restricted\nmaxwin: Maximum length of the output window (default: 10000)\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.gfrr-NTuple{9, Any}","page":"API","title":"SPICE.gfrr","text":"gfrr(target, abcorr, obsrvr, relate, refval, adjust, step, nintvls, cnfine)\n\nDetermine time intervals for which a specified constraint on the observer-target range rate is met.\n\nArguments\n\ntarget: Name of the target body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nrelate: Relational operator\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is confined\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfsep-NTuple{14, Any}","page":"API","title":"SPICE.gfsep","text":"Determine time intervals when the angular separation between the position vectors of two target bodies relative to an observer satisfies a numerical relationship.\n\nArguments\n\ntarg1: Name of first body\nshape1: Name of shape model describing the first body\nframe1: The body-fixed reference frame of the first body\ntarg2: Name of second body\nshape2: Name of the shape model describing the second body\nframe2: The body-fixed reference frame of the second body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nrelate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the angular separation value and refval\nrefval: Reference value\nadjust: Absolute extremum adjustment value\nstep: Step size in seconds for finding angular separation events\nnintvls: Workspace window interval count\ncnfine: Window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfsntc-NTuple{15, Any}","page":"API","title":"SPICE.gfsntc","text":"gfsntc(target, fixref, method, abcorr, obsrvr, dref, dvec, crdsys, coord, relate, refval,\n adjust, step, nintvls, cnfine)\n\nDetermine time intervals for which a coordinate of an surface intercept position vector satisfies a numerical constraint.\n\nArguments\n\ntarget: Name of the target body\nfixref: Body fixed frame associated with target\nmethod: Name of method type for surface intercept calculation\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\ndref: Reference frame of direction vector dvec\ndvec: Pointing direction vector from obsrvr\ncrdsys: Name of the coordinate system containing COORD\ncoord: Name of the coordinate of interest\nrelate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfsstp-Tuple{Any}","page":"API","title":"SPICE.gfsstp","text":"gfsstp(step)\n\nSet the step size to be returned by gfstep.\n\nArguments\n\nstep: Time step to take\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfstep-Tuple{}","page":"API","title":"SPICE.gfstep","text":"gfstep()\n\nReturn the time step set by the most recent call to gfsstp.\n\nArguments\n\nstep: Time step to take\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfstol-Tuple{Any}","page":"API","title":"SPICE.gfstol","text":"gfstol(value)\n\nOverride the default GF convergence value used in the high level GF routines.\n\nArguments\n\nvalue: Double precision value returned or to store\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfsubc-NTuple{13, Any}","page":"API","title":"SPICE.gfsubc","text":"gfsubc(target, fixref, method, abcorr, obsrvr, crdsys, coord, relate, refval, adjust, step,\n nintvls, cnfine)\n\nDetermine time intervals for which a coordinate of an subpoint position vector satisfies a numerical constraint.\n\nArguments\n\ntarget: Name of the target body\nfixref: Body fixed frame associated with target\nmethod: Name of method type for subpoint calculation\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\ncrdsys: Name of the coordinate system containing coord\ncoord: Name of the coordinate of interest\nrelate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the coordinate value and refval\nrefval: Reference value\nadjust: Adjustment value for absolute extrema searches\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: Window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gftfov-NTuple{9, Any}","page":"API","title":"SPICE.gftfov","text":"gftfov(inst, target, tshape, tframe, abcorr, obsrvr, step, nintvls, cnfine)\n\nDetermine time intervals when a specified ephemeris object intersects the space bounded by the field-of-view (FOV) of a specified instrument.\n\nArguments\n\ninst: Name of the instrument\ntarget: Name of the target body\ntshape: Type of shape model used for target body\ntframe: Body-fixed, body-centered frame for target body\nabcorr: Aberration correction flag\nobsrvr: Name of the observing body\nstep: Step size in seconds for finding FOV events\nnintvls: Workspace window interval count\ncnfine: Window to which the search is restricted\n\nOutput\n\nReturns a window containing the results.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfudb!-NTuple{5, Any}","page":"API","title":"SPICE.gfudb!","text":"gfudb!(udfuns, udfunb, step, cnfine, result)\n\nPerform a GF search on a user defined boolean quantity.\n\nArguments\n\nudfuns: Name of the routine that computes a scalar quantity of interest corresponding to an et, e.g. f(et) = ...\nudfunb: Name of the routine returning the boolean value corresponding to an et, e.g. g(f, et) = ...\nstep: Step size used for locating extrema and roots\ncnfine: Window to which the search is restricted\nresult: Window containing results\n\nOutput\n\nReturns result.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gfuds!-NTuple{9, Any}","page":"API","title":"SPICE.gfuds!","text":"gfuds!(udfuns, udqdec, relate, refval, adjust, step, nintvls, cnfine, result)\n\nPerform a GF search on a user defined scalar quantity.\n\nArguments\n\nudfuns: Name of the routine that computes the scalar quantity of interest at some time, e.g. f(et) = ...\nudqdec: Name of the routine that computes whether the scalar quantity is decreasing, e.g. g(f, et) = ...\nrelate: Operator that either looks for an extreme value (max, min, local, absolute) or compares the geometric quantity value and a number\nrefval: Value used as reference for scalar quantity condition\nadjust: Allowed variation for absolute extremal geometric conditions\nstep: Step size used for locating extrema and roots\nnintvls: Workspace window interval count\ncnfine: SPICE window to which the search is restricted\nresult: SPICE window containing results\n\nOutput\n\nReturns result.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gipool-Tuple{Any}","page":"API","title":"SPICE.gipool","text":"gipool(name; start=1, room=100)\n\nReturn the value of a kernel variable from the kernel pool.\n\nArguments\n\nname: Name of the variable whose value is to be returned\nstart: Which component to start retrieving for name (default: 1)\nroom: The largest number of values to return (default: 100)\n\nOutput\n\nReturns an array of values if the variable exists or nothing if not.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.gnpool","page":"API","title":"SPICE.gnpool","text":"gnpool(name, start, room, lenout=128)\n\nReturn names of kernel variables matching a specified template.\n\nArguments\n\nname: Template that names should match\nstart: Index of first matching name to retrieve\nroom: The largest number of values to return\nlenout: Length of strings in output array kvars (default: 128)\n\nOutput\n\nReturns lernel pool variables whose names match name.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.halfpi","page":"API","title":"SPICE.halfpi","text":"halfpi()\n\nwarning: Deprecated\nUse π/2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.hrmint-Tuple{Any, Any, Any}","page":"API","title":"SPICE.hrmint","text":"hrmint(xvals, yvals, x)\n\nEvaluate a Hermite interpolating polynomial at a specified abscissa value.\n\nArguments\n\nxvals: Abscissa values\nyvals: Ordinate and derivative values\nx: Point at which to interpolate the polynomial\n\nOutput\n\nf: Interpolated function value at x\ndf: Interpolated function's derivative at x\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.hx2dp-Tuple{Any}","page":"API","title":"SPICE.hx2dp","text":"hx2dp(str)\n\nConvert a string representing a double precision number in a base 16 \"scientific notation\" into its equivalent double precision number.\n\nArguments\n\nstr: Hex form string to convert to double precision\n\nOutput\n\ndp: Double precision value to be returned\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.illumf-NTuple{8, Any}","page":"API","title":"SPICE.illumf","text":"illumf(method, target, ilusrc, et, fixref, abcorr, obsrvr, spoint)\n\nCompute the illumination angles - phase, incidence, and emission - at a specified point on a target body. Return logical flags indicating whether the surface point is visible from the observer's position and whether the surface point is illuminated.\n\nThe target body's surface is represented using topographic data provided by DSK files, or by a reference ellipsoid.\n\nThe illumination source is a specified ephemeris object.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\nilusrc: Name of illumination source\net: Epoch in TDB seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction flag\nobsrvr: Name of observing body\nspoint: Body-fixed coordinates of a target surface point\n\nOutput\n\ntrgepc: Target surface point epoch\nsrfvec: Vector from observer to target surface point\nphase: Phase angle at the surface point\nincdnc: Source incidence angle at the surface point\nemissn: Emission angle at the surface point\nvisibl: Visibility flag (true if visible)\nlit: Illumination flag (true if illuminated)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.illumg-NTuple{7, Any}","page":"API","title":"SPICE.illumg","text":"illumg(method, target, ilusrc, et, fixref, obsrvr, spoint, abcorr)\n\nFind the illumination angles (phase, incidence, and emission) at a specified surface point of a target body.\n\nThe surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.\n\nThe illumination source is a specified ephemeris object.\n\nArguments\n\nmethod: Computation method.\ntarget: Name of target body.\nilusrc: Name of illumination source.\net: Epoch in ephemeris seconds past J2000 TDB.\nfixref: Body-fixed, body-centered target body frame.\nobsrvr: Name of observing body.\nspoint: Body-fixed coordinates of a target surface point.\nabcorr: Aberration correction.\n\nOutput\n\ntrgepc: Sub-solar point epoch.\nsrfvec: Vector from observer to sub-solar point.\nphase: Phase angle at the surface point.\nincdnc: Solar incidence angle at the surface point.\nemissn: Emission angle at the surface point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ilumin-NTuple{6, Any}","page":"API","title":"SPICE.ilumin","text":"ilumin(method, target, et, fixref, obsrvr, spoint, abcorr)\n\nFind the illumination angles (phase, solar incidence, and emission) at a specified surface point of a target body.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in ephemeris seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nobsrvr: Name of observing body\nspoint: Body-fixed coordinates of a target surface point\nabcorr: Aberration correction\n\nOutput\n\ntrgepc: Sub-solar point epoch\nsrfvec: Vector from observer to sub-solar point\nphase: Phase angle at the surface point\nincdnc: Solar incidence angle at the surface point\nemissn: Emission angle at the surface point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.inedpl-NTuple{4, Any}","page":"API","title":"SPICE.inedpl","text":"inedpl(a, b, c, plane)\n\nFind the intersection of a triaxial ellipsoid and a plane.\n\nArguments\n\na: Length of ellipsoid semi-axis lying on the x-axis\nb: Length of ellipsoid semi-axis lying on the y-axis\nc: Length of ellipsoid semi-axis lying on the z-axis\nplane: Plane that intersects ellipsoid\n\nOutput\n\nellipse: Intersection ellipse\n\nReturns nothing if no ellipse could be found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.inelpl-Tuple{Any, Any}","page":"API","title":"SPICE.inelpl","text":"inelpl(ellips, plane)\n\nFind the intersection of an ellipse and a plane.\n\nArguments\n\nellips: An ellipse\nplane: A plane\n\nOutput\n\nnxpts: Number of intersection points of ellipse and plane\nxpt1, xpt2: Intersection points\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.inrypl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.inrypl","text":"inrypl(vertex, dir, plane)\n\nFind the intersection of a ray and a plane.\n\nArguments\n\nvertex, dir: Vertex and direction vector of ray\nplane: A plane\n\nOutput\n\nnxpts: Number of intersection points of ray and plane\nxpt1, xpt2: Intersection points\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.insrtc!-Tuple{Any, Any}","page":"API","title":"SPICE.insrtc!","text":"insrtc!(set, item)\n\nInsert an item into a character set.\n\nArguments\n\nset: Insertion set\nitem: Item to be inserted\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.insrtd!-Tuple{Any, Any}","page":"API","title":"SPICE.insrtd!","text":"insrtd!(set, item)\n\nInsert an item into a double set.\n\nArguments\n\nset: Insertion set\nitem: Item to be inserted\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.insrti!-Tuple{Any, Any}","page":"API","title":"SPICE.insrti!","text":"insrti!(set, item)\n\nInsert an item into an integer set.\n\nArguments\n\nset: Insertion set\nitem: Item to be inserted\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.inter-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, SPICE.SpiceCell{T}}} where T","page":"API","title":"SPICE.inter","text":"inter(a, b)\n\nIntersect two sets of any data type to form a third set.\n\nArguments\n\na: First input set\nb: Second input set\n\nOutput\n\nReturns intersection of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.intmax","page":"API","title":"SPICE.intmax","text":"intmax()\n\nwarning: Deprecated\nUse typemax(Cint) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.intmin","page":"API","title":"SPICE.intmin","text":"intmin()\n\nwarning: Deprecated\nUse typemin(Cint) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.invert","page":"API","title":"SPICE.invert","text":"invert(matrix)\n\nwarning: Deprecated\nUse inv(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.invort","page":"API","title":"SPICE.invort","text":"invort(matrix)\n\nwarning: Deprecated\nUse inv(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.isordv","page":"API","title":"SPICE.isordv","text":"isordv(vec)\n\nwarning: Deprecated\nUse isperm(vec) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.isrchc","page":"API","title":"SPICE.isrchc","text":"isrchc(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.isrchd","page":"API","title":"SPICE.isrchd","text":"isrchd(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.isrchi","page":"API","title":"SPICE.isrchi","text":"isrchi(value, array)\n\nwarning: Deprecated\nUse findfirst(array .== value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.isrot-Tuple{Any, Any, Any}","page":"API","title":"SPICE.isrot","text":"isrot(m, ntol, dtol)\n\nIndicate whether a 3x3 matrix is a rotation matrix.\n\nArguments\n\nm: A matrix to be tested\nntol: Tolerance for the norms of the columns of m\ndtol: Tolerance for the determinant of a matrix whose columns are the unitized columns of m\n\nOutput\n\nReturns true if m is a rotation matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.iswhsp","page":"API","title":"SPICE.iswhsp","text":"iswhsp(str)\n\nwarning: Deprecated\nUse isempty(strip(str)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.j1900-Tuple{}","page":"API","title":"SPICE.j1900","text":"j1900()\n\nReturns the Julian Date of 1899 DEC 31 12:00:00 (1900 JAN 0.5).\n\nhttps://naif.jpl.nasa.gov/pub/naif/toolkitdocs/C/cspice/j1900c.html\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.j1950-Tuple{}","page":"API","title":"SPICE.j1950","text":"j1950()\n\nReturns the Julian Date of 1950 JAN 01 00:00:00 (1950 JAN 1.0).\n\nhttps://naif.jpl.nasa.gov/pub/naif/toolkitdocs/C/cspice/j1950c.html\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.j2000-Tuple{}","page":"API","title":"SPICE.j2000","text":"j2000()\n\nReturns the Julian Date of 2000 JAN 01 12:00:00 (2000 JAN 1.5).\n\nhttps://naif.jpl.nasa.gov/pub/naif/toolkitdocs/C/cspice/j2000c.html\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.j2100-Tuple{}","page":"API","title":"SPICE.j2100","text":"j2100()\n\nReturns the Julian Date of 2100 JAN 01 12:00:00 (2100 JAN 1.5).\n\nhttps://naif.jpl.nasa.gov/pub/naif/toolkitdocs/C/cspice/j2100c.html\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.jyear-Tuple{}","page":"API","title":"SPICE.jyear","text":"jyear()\n\nReturns the number of seconds per Julian year.\n\nhttps://naif.jpl.nasa.gov/pub/naif/toolkitdocs/C/cspice/jyearc.html\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.kclear-Tuple{}","page":"API","title":"SPICE.kclear","text":"kclear()\n\nClear the KEEPER subsystem: unload all kernels, clear the kernel pool, and re-initialize the subsystem. Existing watches on kernel variables are retained.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.kdata","page":"API","title":"SPICE.kdata","text":"kdata(which, kind, fillen=1024, srclen=256)\n\nReturn data for the n-th kernel that is among a list of specified kernel types.\n\nArguments\n\nwhich: Index of kernel to fetch from the list of kernels\nkind: The kind of kernel to which fetches are limited\nfillen: Available space in output file string\nsrclen: Available space in output source string\n\nOutput\n\nReturns nothing if no kernel was found or a tuple consisting of\n\nfile: The name of the kernel file\nfiltyp: The type of the kernel\nsource: Name of the source file used to load file\nhandle: The handle attached to file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.kinfo","page":"API","title":"SPICE.kinfo","text":"kinfo(file, srclen=256)\n\nArguments\n\nfile: Name of a kernel to fetch information for\nsrclen: Available space in output source string\n\nOutput\n\nReturns nothing if no kernel was found or a tuple consisting of\n\nfiltyp: The type of the kernel\nsource: Name of the source file used to load file\nhandle: The handle attached to file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.kplfrm","page":"API","title":"SPICE.kplfrm","text":"kplfrm(frmcls)\n\nReturn a SPICE set containing the frame IDs of all reference frames of a given class having specifications in the kernel pool.\n\nArguments\n\nfrmcls: Frame class\nsize: Size of the output set\n\nOutput\n\nReturns the set of ID codes of frames of the specified class.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ktotal-Tuple{Any}","page":"API","title":"SPICE.ktotal","text":"ktotal(kind)\n\nReturn the current number of kernels that have been loaded via the KEEPER interface that are of a specified type.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.kxtrct","page":"API","title":"SPICE.kxtrct","text":"kxtrct(keywd, terms, string)\n\nLocate a keyword in a string and extract the substring from the beginning of the first word following the keyword to the beginning of the first subsequent recognized terminator of a list.\n\nArguments\n\nkeywd: Word that marks the beginning of text of interest\nterms: Set of words, any of which marks the end of text\nstring: String containing a sequence of words\n\nOutput\n\nReturns nothing if keywd was found or a tuple consisting of\n\nstring: The input string with the text of interest removed\nsubstr: String from end of keywd to beginning of first terms item found\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lastnb","page":"API","title":"SPICE.lastnb","text":"lastnb(str)\n\nwarning: Deprecated\nUse findprev(!isspace, str, length(str)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.latcyl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.latcyl","text":"latcyl(radius, lon, lat)\n\nConvert from latitudinal coordinates to cylindrical coordinates.\n\nArguments\n\nradius: Distance of a point from the origin\nlon: Angle of the point from the XZ plane in radians\nlat: Angle of the point from the XY plane in radians\n\nOutput\n\nReturn the tuple (r, lonc, z).\n\nr: Distance of the point from the z axis\nlonc: Angle of the point from the XZ plane in radians. 'lonc' is set equal to 'lon'\nz: Height of the point above the XY plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.latrec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.latrec","text":"latrec(radius, lon, lat)\n\nConvert from latitudinal coordinates to rectangular coordinates.\n\nArguments\n\nradius: Distance of a point from the origin\nlon: Angle of the point from the XZ plane in radians\nlat: Angle of the point from the XY plane in radians\n\nOutput\n\nReturn the rectangular coordinates vector of the point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.latsph-Tuple{Any, Any, Any}","page":"API","title":"SPICE.latsph","text":"latsph(radius, lon, lat)\n\nConvert from latitudinal coordinates to spherical coordinates.\n\nArguments\n\nradius: Distance of a point from the origin\nlon: Angle of the point from the XZ plane in radians\nlat: Angle of the point from the XY plane in radians\n\nOutput\n\nReturn the tuple (rho, colat, lons).\n\nrho: Distance of the point from the origin\ncolat: Angle of the point from positive z axis (radians)\nlons: Angle of the point from the XZ plane (radians)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.latsrf-NTuple{5, Any}","page":"API","title":"SPICE.latsrf","text":"latsrf(method, target, et, fixref, npts, lonlat)\n\nMap array of planetocentric longitude/latitude coordinate pairs to surface points on a specified target body.\n\nThe surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in TDB seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nlonlat: Array of longitude/latitude coordinate pairs\n\nOutput\n\nReturns an array of surface points.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lcase","page":"API","title":"SPICE.lcase","text":"lcase(in)\n\nwarning: Deprecated\nUse lowercase(in) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ldpool-Tuple{Any}","page":"API","title":"SPICE.ldpool","text":"ldpool(kernel)\n\nLoad the variables contained in a NAIF ASCII kernel file into the kernel pool.\n\nArguments\n\nkernel: Name of the kernel file\n\nOutput\n\nNone\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lgrind-Tuple{Any, Any, Any}","page":"API","title":"SPICE.lgrind","text":"lgrind(xvals, yvals, x)\n\nEvaluate a Lagrange interpolating polynomial for a specified set of coordinate pairs, at a specified abscissa value. Return the value of both polynomial and derivative.\n\nArguments\n\nxvals: Abscissa values of coordinate pairs\nyvals: Ordinate values of coordinate pairs\nx: Point at which to interpolate the polynomial\n\nOutput\n\np: The value at x of the unique polynomial of degree n-1 that fits the points in the plane defined by xvals and yvals\ndp: The derivative at x of the interpolating polynomial described above\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.limbpt-NTuple{13, Any}","page":"API","title":"SPICE.limbpt","text":"limbpt(method, target, et, fixref, abcorr, corloc, obsrvr, refvec, rolstp, ncuts, schstp,\n soltol, maxn)\n\nFind limb points on a target body. The limb is the set of points of tangency on the target of rays emanating from the observer. The caller specifies half-planes bounded by the observer-target center vector in which to search for limb points.\n\nThe surface of the target body may be represented either by a triaxial ellipsoid or by topographic data.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in ephemeris seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction\ncorloc: Aberration correction locus\nobsrvr: Name of observing body\nrefvec: Reference vector for cutting half-planes\nrolstp: Roll angular step for cutting half-planes\nncuts: Number of cutting half-planes\nschstp: Angular step size for searching\nsoltol: Solution convergence tolerance\nmaxn: Maximum number of entries in output arrays\n\nOutput\n\nReturns the tuple (npts, points, epochs, tangts).\n\nnpts: Counts of limb points corresponding to cuts\npoints: Limb points\nepochs: Times associated with limb points\ntangts: Tangent vectors emanating from the observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lmpool-Tuple{Any}","page":"API","title":"SPICE.lmpool","text":"lmpool(cvals)\n\nLoad the variables contained in an internal buffer into the kernel pool.\n\nArguments\n\ncvals: An array that contains a SPICE text kernel\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lparse","page":"API","title":"SPICE.lparse","text":"lparse(list, delim, nmax)\n\nwarning: Deprecated\nUse split(list, delim, limit=nmax) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lparsm","page":"API","title":"SPICE.lparsm","text":"lparsm(list, delims, nmax)\n\nwarning: Deprecated\nUse split(list, delim, limit=nmax, keepempty=false) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lparss","page":"API","title":"SPICE.lparss","text":"lparss(list, delims)\n\nwarning: Deprecated\nUse Set(split(list, collect(delim))) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lspcn-Tuple{Any, Any, Any}","page":"API","title":"SPICE.lspcn","text":"lspcn(body, et, abcorr)\n\nCompute L_s, the planetocentric longitude of the sun, as seen from a specified body.\n\nArguments\n\nbody: Name of the central body\net: Epoch in seconds past J2000 TDB\nabcorr: Aberration correction\n\nOutput\n\nReturns the planetocentric longitude of the sun for the specified body at the specified time in radians.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lstlec","page":"API","title":"SPICE.lstlec","text":"lstlecd(x, array)\n\nwarning: Deprecated\nUse findfirst(item .<= array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lstled","page":"API","title":"SPICE.lstled","text":"lstle[di](x, array)\n\nwarning: Deprecated\nUse searchsortedlast(array, x) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lstltc","page":"API","title":"SPICE.lstltc","text":"lstltcd(x, array)\n\nwarning: Deprecated\nUse findfirst(item .< array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.lstltd","page":"API","title":"SPICE.lstltd","text":"lstlt[di](x, array)\n\nwarning: Deprecated\nUse searchsortedlast(array, x, lt=<=) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ltime-NTuple{4, Any}","page":"API","title":"SPICE.ltime","text":"ltime(etobs, obs, dir, targ)\n\nThis routine computes the transmit (or receive) time of a signal at a specified target, given the receive (or transmit) time at a specified observer. The elapsed time between transmit and receive is also returned.\n\nArguments\n\netobs: Epoch of a signal at some observer\nobs: NAIF ID of some observer\ndir: Direction the signal travels ( \"->\" or \"<-\" )\ntarg: Time between transmit and receipt of the signal\n\nOutput\n\nettarg: Epoch of the signal at the target\nobs: NAIF ID of some observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lx4dec-Tuple{Any, Any}","page":"API","title":"SPICE.lx4dec","text":"lx4dec(string, first)\n\nScan a string from a specified starting position for the end of a decimal number.\n\nArguments\n\nstring: Any character string\nfirst: First character to scan from in string\n\nOutput\n\nlast: Last character that is part of a decimal number. If there is no such character, last will be returned with the value first-1.\nnchar: Number of characters in the decimal number\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lx4num-Tuple{Any, Any}","page":"API","title":"SPICE.lx4num","text":"lx4num(string, first)\n\nScan a string from a specified starting position for the end of a number.\n\nArguments\n\nstring: Any character string\nfirst: First character to scan from in string\n\nOutput\n\nlast: Last character that is part of a number. If there is no such character, last will be returned with the value first-1.\nnchar: Number of characters in the number\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lx4sgn-Tuple{Any, Any}","page":"API","title":"SPICE.lx4sgn","text":"lx4sgn(string, first)\n\nScan a string from a specified starting position for the end of a signed integer.\n\nArguments\n\nstring: Any character string\nfirst: First character to scan from in string\n\nOutput\n\nlast: Last character that is part of a signed integer. If there is no such character, last will be returned with the value first-1.\nnchar: Number of characters in the signed integer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lx4uns-Tuple{Any, Any}","page":"API","title":"SPICE.lx4uns","text":"lx4uns(string, first)\n\nScan a string from a specified starting position for the end of a unsigned integer.\n\nArguments\n\nstring: Any character string\nfirst: First character to scan from in string\n\nOutput\n\nlast: Last character that is part of an unsigned integer. If there is no such character, last will be returned with the value first-1.\nnchar: Number of characters in the unsigned integer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.lxqstr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.lxqstr","text":"lxqstr(string, qchar, first)\n\nLex (scan) a quoted string.\n\nArguments\n\nstring: String to be scanned\nqchar: Quote delimiter character\nfirst: Character position at which to start scanning\n\nOutput\n\nlast: Character position of end of token\nnchar: Number of characters in token\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.m2eul-NTuple{4, Any}","page":"API","title":"SPICE.m2eul","text":"m2eul(r, axis3, axis2, axis1)\n\nFactor a rotation matrix as a product of three rotations about specified coordinate axes.\n\nArguments\n\nr: A rotation matrix to be factored\naxis3: Number of the third rotation axis\naxis2: Number of the second rotation axis\naxis1: Number of the first rotation axis\n\nOutput\n\nA tuple consisting of the third, second, and first Euler angles in radians.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.m2q-Tuple{Any}","page":"API","title":"SPICE.m2q","text":"m2q(r)\n\nFind a unit quaternion corresponding to a specified rotation matrix.\n\nArguments\n\nr: A rotation matrix\n\nOutput\n\nA unit quaternion representing `r'\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.matchi-NTuple{4, Any}","page":"API","title":"SPICE.matchi","text":"matchi(string, templ, wstr, wchar)\n\nDetermine whether a string is matched by a template containing wild cards. The pattern comparison is case-insensitive.\n\nArguments\n\nstring: String to be tested\ntempl: Template (with wild cards) to test against string\nwstr: Wild string token\nwchr: Wild character token\n\nOutput\n\nReturns true if the string matches.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.matchw-NTuple{4, Any}","page":"API","title":"SPICE.matchw","text":"matchw(string, templ, wstr, wchar)\n\nDetermine whether a string is matched by a template containing wild cards.\n\nArguments\n\nstring: String to be tested\ntempl: Template (with wild cards) to test against string\nwstr: Wild string token\nwchr: Wild character token\n\nOutput\n\nReturns true if the string matches.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.maxd","page":"API","title":"SPICE.maxd","text":"maxd(args...)\n\nwarning: Deprecated\nUse max(args...) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.maxi","page":"API","title":"SPICE.maxi","text":"maxi(args...)\n\nwarning: Deprecated\nUse max(args...) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mequ","page":"API","title":"SPICE.mequ","text":"mequ(m1, mout)\n\nwarning: Deprecated\nUse mout .= m1 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mequg","page":"API","title":"SPICE.mequg","text":"mequg(m1, mout)\n\nwarning: Deprecated\nUse mout .= m1 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mind","page":"API","title":"SPICE.mind","text":"mind(args...)\n\nwarning: Deprecated\nUse min(args...) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mini","page":"API","title":"SPICE.mini","text":"mini(args...)\n\nwarning: Deprecated\nUse min(args...) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mtxm","page":"API","title":"SPICE.mtxm","text":"mtxm(m1, m2)\n\nwarning: Deprecated\nUse m1' * m2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mtxmg","page":"API","title":"SPICE.mtxmg","text":"mtxmg(m1, m2)\n\nwarning: Deprecated\nUse m1' * m2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mtxv","page":"API","title":"SPICE.mtxv","text":"mtxv(m1,v2)\n\nwarning: Deprecated\nUse m1' * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mtxvg","page":"API","title":"SPICE.mtxvg","text":"mtxvg(m1,v2)\n\nwarning: Deprecated\nUse m1' * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxm","page":"API","title":"SPICE.mxm","text":"mxm(m1, m2)\n\nwarning: Deprecated\nUse m1 * m2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxmg","page":"API","title":"SPICE.mxmg","text":"mxmg(m1, m2)\n\nwarning: Deprecated\nUse m1 * m2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxmt","page":"API","title":"SPICE.mxmt","text":"mxmt(m1, m2)\n\nwarning: Deprecated\nUse m1 * m2' instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxmtg","page":"API","title":"SPICE.mxmtg","text":"mxmtg(m1, m2)\n\nwarning: Deprecated\nUse m1 * m2' instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxv","page":"API","title":"SPICE.mxv","text":"mxv(m1,v2)\n\nwarning: Deprecated\nUse m1 * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.mxvg","page":"API","title":"SPICE.mxvg","text":"mxvg(m1,v2)\n\nwarning: Deprecated\nUse m1 * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.namfrm-Tuple{Any}","page":"API","title":"SPICE.namfrm","text":"namfrm(frname)\n\nLook up the frame ID code associated with a string.\n\nArguments\n\nfrname: The name of some reference frame\n\nOutput\n\nThe SPICE ID code of the frame.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ncpos-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ncpos","text":"ncpos(str, chars, start)\n\nFind the first occurrence in a string of a character NOT belonging to a collection of characters, starting at a specified location, searching forward.\n\nArguments\n\nstr: A string\nchars: A collection of characters\nstart: Position to begin looking for a character not in chars\n\nOutput\n\nReturns the index of the first character of str at or following index start that is not in the collection chars.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ncposr-Tuple{Any, Any, Any}","page":"API","title":"SPICE.ncposr","text":"ncposr(str, chars, start)\n\nFind the first occurrence in a string of a character NOT belonging to a collection of characters, starting at a specified location, searching in reverse.\n\nArguments\n\nstr: A string\nchars: A collection of characters\nstart: Position to begin looking for a character not in chars\n\nOutput\n\nReturns the index of the last character of str at or before index start that is not in the collection chars.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.nearpt-NTuple{4, Any}","page":"API","title":"SPICE.nearpt","text":"nearpt(positn, a, b, c)\n\nThis routine locates the point on the surface of an ellipsoid that is nearest to a specified position. It also returns the altitude of the position above the ellipsoid.\n\nArguments\n\npositn: Position of a point in the bodyfixed frame\na: Length of semi-axis parallel to x-axis\nb: Length of semi-axis parallel to y-axis\nc: Length on semi-axis parallel to z-axis\n\nOutput\n\nReturns a tuple consisting of npoint and alt.\n\nnpoint: Point on the ellipsoid closest to positn\nalt: Altitude of positn above the ellipsoid\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.npedln-NTuple{5, Any}","page":"API","title":"SPICE.npedln","text":"npedln(a, b, c, linept, linedr)\n\nFind nearest point on a triaxial ellipsoid to a specified line, and the distance from the ellipsoid to the line.\n\nArguments\n\na: Length of semi-axis in the x direction\nb: Length of semi-axis in the y direction\nc: Length of semi-axis in the z direction\nlinept: Point on line\nlinedr: Direction vector of line\n\nOutput\n\nReturns a tuple consisting of pnear and dist.\n\npnear: Nearest point on ellipsoid to line\ndist: Distance of ellipsoid from line\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.npelpt-Tuple{Any, Any}","page":"API","title":"SPICE.npelpt","text":"npelpt(point, ellips)\n\nFind the nearest point on an ellipse to a specified point, both in three-dimensional space, and find the distance between the ellipse and the point.\n\nArguments\n\npoint: Point whose distance to an ellipse is to be found\nellips: A SPICE ellipse\n\nOutput\n\nReturns a tuple consisting of pnear and dist.\n\npnear: Nearest point on ellipse to input point\ndist: Distance of input point to ellipse\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.nplnpt-Tuple{Any, Any, Any}","page":"API","title":"SPICE.nplnpt","text":"nplnpt(linept, linedr, point)\n\nFind the nearest point on a line to a specified point, and find the distance between the two points.\n\nArguments\n\nlinept: Point on line\nlinedr: Direction vector of line\npoint: A second point\n\nOutput\n\nReturns a tuple consisting of pnear and dist.\n\npnear: Nearest point on the line to point\ndist: Distance between point and pnear\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.nvc2pl-Tuple{Any, Any}","page":"API","title":"SPICE.nvc2pl","text":"nvc2pl(norm, point)\n\nMake a SPICE plane from a normal vector and a point.\n\nArguments\n\nnorm: A normal vector...\nconstant: ...and a constant defining a plane\n\nOutput\n\nReturns a struct representing the plane.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.nvp2pl-Tuple{Any, Any}","page":"API","title":"SPICE.nvp2pl","text":"nvp2pl(norm, point)\n\nMake a SPICE plane from a normal vector and a point.\n\nArguments\n\nnorm: A normal vector...\npoint: ...and a point defining a plane\n\nOutput\n\nReturns a struct representing the plane.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.occult-NTuple{9, Any}","page":"API","title":"SPICE.occult","text":"occult(targ1, shape1, frame1, targ2, shape2, frame2, abcorr, obsrvr, et)\n\nDetermines the occultation condition (not occulted, partially, etc.) of one target relative to another target as seen by an observer at a given time.\n\nThe surfaces of the target bodies may be represented by triaxial ellipsoids or by topographic data provided by DSK files.\n\nArguments\n\ntarg1: Name or ID of first target.\nshape1: Type of shape model used for first target.\nframe1: Body-fixed, body-centered frame for first body.\ntarg2: Name or ID of second target.\nshape2: Type of shape model used for second target.\nframe2: Body-fixed, body-centered frame for second body.\nabcorr: Aberration correction flag.\nobsrvr: Name or ID of the observer.\net: Time of the observation (seconds past J2000).\n\nOutput\n\nReturns the occultation identification code.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ordc-Tuple{Any, Any}","page":"API","title":"SPICE.ordc","text":"ordc(set, item)\n\nThe function returns the ordinal position of any given item in a character set.\n\nArguments\n\nset: A set to search for a given item\nitem: An item to locate within a set\n\nOutput\n\nReturns the ordinal position or nothing if the items does not appear in the set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ordd-Tuple{Any, Any}","page":"API","title":"SPICE.ordd","text":"ordd(set, item)\n\nThe function returns the ordinal position of any given item in a character set.\n\nArguments\n\nset: A set to search for a given item\nitem: An item to locate within a set\n\nOutput\n\nReturns the ordinal position or nothing if the items does not appear in the set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.orderc","page":"API","title":"SPICE.orderc","text":"orderc(array)\n\nwarning: Deprecated\nUse sortperm instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.orderd","page":"API","title":"SPICE.orderd","text":"orderd(array)\n\nwarning: Deprecated\nUse sortperm instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.orderi","page":"API","title":"SPICE.orderi","text":"orderi(array)\n\nwarning: Deprecated\nUse sortperm instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ordi-Tuple{Any, Any}","page":"API","title":"SPICE.ordi","text":"ordi(set, item)\n\nThe function returns the ordinal position of any given item in a character set.\n\nArguments\n\nset: A set to search for a given item\nitem: An item to locate within a set\n\nOutput\n\nReturns the ordinal position or nothing if the items does not appear in the set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.oscelt-Tuple{Any, Any, Any}","page":"API","title":"SPICE.oscelt","text":"oscelt(state, et, mu)\n\nDetermine the set of osculating conic orbital elements that corresponds to the state (position, velocity) of a body at some epoch.\n\nArguments\n\nstate: State of body at epoch of elements\net: Epoch of elements\nmu: Gravitational parameter (GM) of primary body\n\nOutput\n\nReturns the equivalent conic elements:\n\nrp: Perifocal distance\necc: Eccentricity\ninc: Inclination\nlnode: Longitude of the ascending node\nargp: Argument of periapsis\nm0: Mean anomaly at epoch\nt0: Epoch\nmu: Gravitational parameter\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.oscltx-Tuple{Any, Any, Any}","page":"API","title":"SPICE.oscltx","text":"oscltx(state, et, mu)\n\nDetermine the set of osculating conic orbital elements that corresponds to the state (position, velocity) of a body at some epoch. In addition to the classical elements, return the true anomaly, semi-major axis, and period, if applicable.\n\nArguments\n\nstate: State of body at epoch of elements\net: Epoch of elements\nmu: Gravitational parameter (GM) of primary body\n\nOutput\n\nReturns the extended set of classical conic elements:\n\nrp: Perifocal distance.\necc: Eccentricity.\ninc: Inclination.\nlnode: Longitude of the ascending node.\nargp: Argument of periapsis.\nm0: Mean anomaly at epoch.\nt0: Epoch.\nmu: Gravitational parameter.\nnu: True anomaly at epoch.\na: Semi-major axis. A is set to zero if it is not computable.\ntau: Orbital period. Applicable only for elliptical orbits. Set to zero otherwise.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckcls-Tuple{Any}","page":"API","title":"SPICE.pckcls","text":"pckcls(handle)\n\nClose an open PCK file.\n\nArguments\n\nhandle: Handle of the PCK file to be closed\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckcov!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.pckcov!","text":"pckcov!(cover, pck, idcode)\n\nFind the coverage window for a specified reference frame in a specified binary PCK file.\n\nArguments\n\ncover: An initalized window SpiceDoubleCell\npck: Path of PCK file\nidcode: Class ID code of PCK reference frame\n\nOutput\n\nReturns cover containing coverage in pck for idcode\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckfrm!-Tuple{Any, Any}","page":"API","title":"SPICE.pckfrm!","text":"pckfrm!(ids, pck)\n\nFind the set of reference frame class ID codes of all frames in a specified binary PCK file.\n\nArguments\n\nids: An initalized SpiceIntCell\npck: Path of PCK file\n\nOutput\n\nReturns ids containing a set of frame class ID codes of frames in PCK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pcklof-Tuple{Any}","page":"API","title":"SPICE.pcklof","text":"pcklof(filename)\n\nLoad a binary PCK file for use by the readers. Return the handle of the loaded file which is used by other PCK routines to refer to the file.\n\nArguments\n\nfilename: Path of the PCK file\n\nOutput\n\nReturns an integer handle.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckopn-Tuple{Any, Any, Any}","page":"API","title":"SPICE.pckopn","text":"pckopn(name, ifname, ncomch)\n\nCreate a new PCK file, returning the handle of the opened file.\n\nArguments\n\nname: The name of the PCK file to be opened\nifname: The internal filename for the PCK\nncomch: The number of characters to reserve for comments\n\nOutput\n\nReturns the handle of the opened PCK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckuof-Tuple{Any}","page":"API","title":"SPICE.pckuof","text":"pckuof(handle)\n\nUnload a binary PCK file so that it will no longer be searched by the readers.\n\nArguments\n\nhandle: Integer handle of a PCK file\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pckw02-NTuple{9, Any}","page":"API","title":"SPICE.pckw02","text":"pckw02(handle, clssid, frame, first, last, segid, intlen, cdata, btime)\n\nWrite a type 2 segment to a PCK binary file given the file handle, frame class ID, base frame, time range covered by the segment, and the Chebyshev polynomial coefficients.\n\nArguments\n\nhandle: Handle of binary PCK file open for writing.\nclssid: Frame class ID of body-fixed frame.\nframe: Name of base reference frame.\nfirst: Start time of interval covered by segment.\nlast: End time of interval covered by segment.\nsegid: Segment identifier.\nintlen: Length of time covered by logical record.\ncdata: Array of Chebyshev coefficients.\nbtime: Begin time of first logical record.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pcpool-Tuple{Any, Any}","page":"API","title":"SPICE.pcpool","text":"pcpool(name, vals)\n\nInsert character data into the kernel pool.\n\nArguments\n\nname: The kernel pool name to associate with vals\nvals: An array of values to insert into the kernel pool\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pdpool-Tuple{Any, Any}","page":"API","title":"SPICE.pdpool","text":"pdpool(name, vals)\n\nInsert double precision data into the kernel pool.\n\nArguments\n\nname: The kernel pool name to associate with vals\nvals: An array of values to insert into the kernel pool\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pgrrec-NTuple{6, Any}","page":"API","title":"SPICE.pgrrec","text":"pgrrec(body, lon, lat, alt, re, f)\n\nConvert planetographic coordinates to rectangular coordinates.\n\nArguments\n\nbody: Body with which coordinate system is associated.\nlon: Planetographic longitude of a point (radians).\nlat: Planetographic latitude of a point (radians).\nalt: Altitude of a point above reference spheroid.\nre: Equatorial radius of the reference spheroid.\nf: Flattening coefficient.\n\nOutput\n\nReturns the rectangular coordinates of the point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.phaseq-NTuple{5, Any}","page":"API","title":"SPICE.phaseq","text":"phaseq(et, target, illmn, obsrvr, abcorr)\n\nCompute the apparent phase angle for a target, observer, illuminator set of ephemeris objects.\n\nArguments\n\net: Ephemeris seconds past J2000 TDB\ntarget: Target body name\nillmn: Illuminating body name\nobsrvr: Observer body\nabcorr: Aberration correction flag\n\nOutput\n\nReturns the value of the phase angle.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pipool-Tuple{Any, Any}","page":"API","title":"SPICE.pipool","text":"pipool(name, ivals)\n\nInsert integer data into the kernel pool.\n\nArguments\n\nname: The kernel pool name to associate with the values\nivals: An array of integers to insert into the pool\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pjelpl-Tuple{Any, Any}","page":"API","title":"SPICE.pjelpl","text":"pjelpl(elin, plane)\n\nProject an ellipse onto a plane, orthogonally.\n\nArguments\n\nelin: An ellipse to be projected\nplane: A plane onto which elin is to be projected\n\nOutput\n\nReturns the ellipse resulting from the projection.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pl2nvc-Tuple{Any}","page":"API","title":"SPICE.pl2nvc","text":"pl2nvc(plane)\n\nReturn a unit normal vector and constant that define a specified plane.\n\nArguments\n\nplane: A plane\n\nOutput\n\nReturns a tuple consisting of\n\nnormal: A normal vector and...\nconstant: ... constant defining the geometric plane represented by plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pl2nvp-Tuple{Any}","page":"API","title":"SPICE.pl2nvp","text":"pl2nvp(plane)\n\nReturn a unit normal vector and point that define a specified plane.\n\nArguments\n\nplane: A plane\n\nOutput\n\nReturns a tuple consisting of\n\nnormal: A normal vector and...\npoint: ... point defining the geometric plane represented by plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pl2psv-Tuple{Any}","page":"API","title":"SPICE.pl2psv","text":"pl2psv(plane)\n\nReturn a point and two orthogonal spanning vectors that define a specified plane.\n\nArguments\n\nplane: A plane\n\nOutput\n\nReturns a tuple consisting of a point in the plane and two vectors spanning the input plane.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pltar-Tuple{Any, Any}","page":"API","title":"SPICE.pltar","text":"pltar(vrtces, plates)\n\nCompute the total area of a collection of triangular plates.\n\nArguments\n\nvrtces: Array of vertices\nplates: Array of plates\n\nOutput\n\nReturns the area.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pltexp-Tuple{Any, Any}","page":"API","title":"SPICE.pltexp","text":"pltexp(iverts, delta)\n\nExpand a triangular plate by a specified amount. The expanded plate is co-planar with, and has the same orientation as, the original. The centroids of the two plates coincide.\n\nArguments\n\niverts: Vertices of the plate to be expanded\ndelta: Fraction by which the plate is to be expanded\n\nOutput\n\nReturns the vertices of the expanded plate.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pltnp-NTuple{4, Any}","page":"API","title":"SPICE.pltnp","text":"pltnp(point, v1, v2, v3)\n\nFind the nearest point on a triangular plate to a given point.\n\nArguments\n\npoint: A point in 3-dimensional space.\nv1, v2, v3: Vertices of a triangular plate\n\nOutput\n\nReturns a tuple consisting of\n\npnear: Nearest point on the plate to point\ndist: Distance between pnear and point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pltnrm-Tuple{Any, Any, Any}","page":"API","title":"SPICE.pltnrm","text":"pltnrm(v1, v2, v3)\n\nCompute an outward normal vector of a triangular plate. The vector does not necessarily have unit length.\n\nArguments\n\nv1, v2, v3: Vertices of a plate\n\nOutput\n\nReturns the plate's outward normal vector.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pltvol-Tuple{Any, Any}","page":"API","title":"SPICE.pltvol","text":"pltvol(vrtces, plates)\n\nCompute the volume of a three-dimensional region bounded by a collection of triangular plates.\n\nArguments\n\nvrtces: Array of vertices\nplates: Array of plates\n\nOutput\n\nReturns the volume of the spatial region bounded by the plates.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.polyds-Tuple{Any, Any, Any}","page":"API","title":"SPICE.polyds","text":"polyds(coeffs, nderiv, t)\n\nCompute the value of a polynomial and it's first nderiv derivatives at the value t.\n\nArguments\n\ncoeffs: Coefficients of the polynomial to be evaluated\nnderiv: Number of derivatives to compute\nt: Point to evaluate the polynomial and derivatives\n\nOutput\n\nReturns the value of the polynomial and the derivatives as an array.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pos","page":"API","title":"SPICE.pos","text":"pos(str, substr, start)\n\nwarning: Deprecated\nUse first(findnext(substr, str, start)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.posr","page":"API","title":"SPICE.posr","text":"posr(str, substr, start)\n\nwarning: Deprecated\nUse first(findprev(substr, str, start)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.prop2b-Tuple{Any, Any, Any}","page":"API","title":"SPICE.prop2b","text":"prop2b(gm, pvinit, dt)\n\nGiven a central mass and the state of massless body at time t_0, this routine determines the state as predicted by a two-body force model at time t_0 + dt.\n\nArguments\n\ngm: Gravity of the central mass.\npvinit: Initial state from which to propagate a state.\ndt: Time offset from initial state to propagate to.\n\nOutput\n\nReturns the propagated state.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.prsdp","page":"API","title":"SPICE.prsdp","text":"prsdp(str)\n\nwarning: Deprecated\nUse parse(Float64, str) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.prsint","page":"API","title":"SPICE.prsint","text":"prsint(str)\n\nwarning: Deprecated\nUse parse(Int, str) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.psv2pl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.psv2pl","text":"psv2pl(point, span1, span2)\n\nMake a plane from a point and two spanning vectors.\n\nArguments\n\npoint, span1, span2: A point and two spanning vectors defining a plane\n\nOutput\n\nReturns the plane.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pxform-Tuple{Any, Any, Any}","page":"API","title":"SPICE.pxform","text":"pxform(from, to, et)\n\nReturn the matrix that transforms position vectors from one specified frame to another at a specified epoch.\n\nArguments\n\nfrom: Name of the frame to transform from\nto: Name of the frame to transform to\net: Epoch of the rotation matrix\n\nOutput\n\nReturns the rotation matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.pxfrm2-NTuple{4, Any}","page":"API","title":"SPICE.pxfrm2","text":"pxfrm2(from, to, etfrom, etto)\n\nReturn the 3x3 matrix that transforms position vectors from one specified frame at a specified epoch to another specified frame at another specified epoch.\n\nArguments\n\nfrom: Name of the frame to transform from\nto: Name of the frame to transform to\netfrom: Evaluation time of from frame\netto: Evaluation time of to frame\n\nOutput\n\nReturns a position transformation matrix from frame from to frame to.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.q2m-Tuple{Any}","page":"API","title":"SPICE.q2m","text":"q2m(q)\n\nFind the rotation matrix corresponding to a specified unit quaternion.\n\nArguments\n\nq: A unit quaternion\n\nOutput\n\nA rotation matrix corresponding to q.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.qdq2av-Tuple{Any, Any}","page":"API","title":"SPICE.qdq2av","text":"qdq2av(q, dq)\n\nDerive angular velocity from a unit quaternion and its derivative with respect to time.\n\nArguments\n\nq: Unit SPICE quaternion (as any kind of iterable with four elements)\ndq: Derivative of `q' with respect to time\n\nOutput\n\nAngular velocity vector defined by q' anddq'\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.qxq-Tuple{Any, Any}","page":"API","title":"SPICE.qxq","text":"qxq(q1, q2)\n\nMultiply two quaternions.\n\nArguments\n\nq1: First SPICE quaternion factor (as any kind of iterable with four elements)\nq2: Second SPICE quaternion factor (as any kind of iterable with four elements)\n\nOutput\n\nA quaternion corresponding to the product of q1' andq2'\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.radrec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.radrec","text":"radrec(range, ra, dec)\n\nConvert from range, right ascension, and declination to rectangular coordinates.\n\nArguments\n\nrange: Distance of a point from the origin\nra: Right ascension of point in radians\ndec: Declination of point in radians\n\nOutput\n\nReturns the rectangular coordinates of the point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.rav2xf-Tuple{Any, Any}","page":"API","title":"SPICE.rav2xf","text":"rav2xf(rot, av)\n\nDetermine a state transformation matrix from a rotation matrix and the angular velocity of the rotation.\n\nArguments\n\nrot: Rotation matrix\nav: Angular velocity vector\n\nOutput\n\nReturns state transformation matrix associated with rot and av.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.raxisa-Tuple{Any}","page":"API","title":"SPICE.raxisa","text":"raxisa(matrix)\n\nCompute the axis of the rotation given by an input matrix and the angle of the rotation about that axis.\n\nArguments\n\nmatrix: A 3x3 rotation matrix\n\nOutput\n\naxis: Axis of the rotation\nangle: Angle through which the rotation is performed\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.recazl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.recazl","text":"recazl(rectan, azccw, elplsz)\n\nConvert rectangular coordinates of a point to range, azimuth and elevation.\n\nArguments\n\nrectan: Rectangular coordinates of a point\nazccw: Flag indicating how azimuth is measured. If true, the azimuth increases in the counterclockwise direction; otherwise it increases in the clockwise direction\nelplsz: Flag indicating how elevation is measured. If true, the elevation increases from the XY plane toward +Z; otherwise toward -Z\n\nOutput\n\nReturns a tuple consisting of:\n\nrange: Distance of the point from the origin\naz: Azimuth in radians\nel: Elevation in radians\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.reccyl-Tuple{Any}","page":"API","title":"SPICE.reccyl","text":"reccyl(rectan)\n\nConvert from rectangular to cylindrical coordinates.\n\nArguments\n\nrectan: Rectangular coordinates of a point\n\nOutput\n\nr: Distance of the point from the Z axis\nlon: Angle (radians) of the point from the XZ plane\nz: Height of the point above the XY plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.recgeo-Tuple{Any, Any, Any}","page":"API","title":"SPICE.recgeo","text":"recgeo(rectan, re, f)\n\nConvert from rectangular coordinates to geodetic coordinates.\n\nArguments\n\nrectan: Rectangular coordinates of a point\nre: Equatorial radius of the reference spheroid\nf: Flattening coefficient\n\nOutput\n\nlon: Geodetic longitude of the point (radians)\nlat: Geodetic latitude of the point (radians)\nalt: Altitude of the point above reference spheroid\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.reclat-Tuple{Any}","page":"API","title":"SPICE.reclat","text":"reclat(rectan)\n\nConvert from rectangular coordinates to latitudinal coordinates.\n\nArguments\n\nrectan: Rectangular coordinates of a point\n\nOutput\n\nReturns a tuple consisting of:\n\nrad: Distance of the point from the origin\nlon: Longitude of the point (radians)\nlat: Latitude of the point (radians)\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.recpgr-NTuple{4, Any}","page":"API","title":"SPICE.recpgr","text":"recpgr(body, rectan, re, f)\n\nConvert rectangular coordinates to planetographic coordinates.\n\nArguments\n\nbody: Body with which coordinate system is associated\nrectan: Rectangular coordinates of a point\nre: Equatorial radius of the reference spheroid\nf: flattening coefficient\n\nOutput\n\nlon: Planetographic longitude of the point (radians).\nlat: Planetographic latitude of the point (radians).\nalt: Altitude of the point above reference spheroid.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.recrad-Tuple{Any}","page":"API","title":"SPICE.recrad","text":"recrad(rectan)\n\nConvert rectangular coordinates to range, right ascension, and declination.\n\nArguments\n\nrectan: Rectangular coordinates of a point\n\nOutput\n\nReturn the tuple (range, ra, dec).\n\nrange: Distance of the point from the origin\nra: Right ascension in radians\ndec: Declination in radians\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.recsph-Tuple{Any}","page":"API","title":"SPICE.recsph","text":"recsph(rectan)\n\nConvert from rectangular coordinates to spherical coordinates.\n\nArguments\n\nrectan: Rectangular coordinates of a point\n\nOutput\n\nr: Distance of the point from the origin\ncolat: Angle of the point from the Z-axis in radian\nlon: Longitude of the point in radians\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.removc!-Tuple{Any, Any}","page":"API","title":"SPICE.removc!","text":"removc!(set, item)\n\nRemove an item from a character set.\n\nArguments\n\nset: A set\nitem: Item to be removed\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.removd!-Tuple{Any, Any}","page":"API","title":"SPICE.removd!","text":"removd!(set, item)\n\nRemove an item from a double set.\n\nArguments\n\nset: A set\nitem: Item to be removed\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.removi!-Tuple{Any, Any}","page":"API","title":"SPICE.removi!","text":"removi!(set, item)\n\nRemove an item from a character set.\n\nArguments\n\nset: A set\nitem: Item to be removed\n\nOutput\n\nReturns the updated set.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.reordc","page":"API","title":"SPICE.reordc","text":"reordc(iorder, array)\n\nwarning: Deprecated\nUse array[iorder] instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.reordd","page":"API","title":"SPICE.reordd","text":"reordd(iorder, array)\n\nwarning: Deprecated\nUse array[iorder] instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.reordi","page":"API","title":"SPICE.reordi","text":"reordi(iorder, array)\n\nwarning: Deprecated\nUse array[iorder] instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.reordl","page":"API","title":"SPICE.reordl","text":"reordl(iorder, array)\n\nwarning: Deprecated\nUse array[iorder] instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmc","page":"API","title":"SPICE.repmc","text":"repmc(input, marker, value)\n\nwarning: Deprecated\nUse replace(input, marker=>value) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmct","page":"API","title":"SPICE.repmct","text":"repmct\n\nwarning: Deprecated\nUse replace instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmd","page":"API","title":"SPICE.repmd","text":"repmd\n\nwarning: Deprecated\nUse replace instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmf","page":"API","title":"SPICE.repmf","text":"repmf\n\nwarning: Deprecated\nUse replace instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmi","page":"API","title":"SPICE.repmi","text":"repmi\n\nwarning: Deprecated\nUse replace instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.repmot","page":"API","title":"SPICE.repmot","text":"repmot\n\nwarning: Deprecated\nUse replace instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.rotate-Tuple{Any, Any}","page":"API","title":"SPICE.rotate","text":"rotate(angle, iaxis)\n\nCalculate the 3x3 rotation matrix generated by a rotation of a specified angle about a specified axis. This rotation is thought of as rotating the coordinate system.\n\nArguments\n\nangle: Angle of rotation (radians)\niaxis: Axis of rotation (X=1, Y=2, Z=3)\n\nOutput\n\nReturns rotation matrix associated with angle and iaxis.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.rotmat-Tuple{Any, Any, Any}","page":"API","title":"SPICE.rotmat","text":"rotmat(m1, angle, iaxis)\n\nApplies a rotation of angle radians about axis iaxis to a matrix m1. This rotation is thought of as rotating the coordinate system.\n\nArguments\n\nm1: Matrix to be rotated\nangle: Angle of rotation (radians)\niaxis: Axis of rotation (X=1, Y=2, Z=3)\n\nOutput\n\nReturns the resulting rotated matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.rotvec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.rotvec","text":"rotvec(v1, angle, iaxis)\n\nTransform a vector to a new coordinate system rotated by angle radians about axis iaxis. This transformation rotates v1 by -angle radians about the specified axis.\n\nArguments\n\nv1: Vector whose coordinate system is to be rotated\nangle: Angle of rotation in radians\niaxis: Axis of rotation (X=1, Y=2, Z=3)\n\nOutput\n\nReturns the resulting vector expressed in the new coordinate system.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.rpd","page":"API","title":"SPICE.rpd","text":"rpd()\n\nwarning: Deprecated\nUse deg2rad instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.rquad-Tuple{Any, Any, Any}","page":"API","title":"SPICE.rquad","text":"rquad(a, b, c)\n\nFind the roots of a quadratic equation.\n\nArguments\n\na: Coefficient of quadratic term\nb: Coefficient of linear term\nc: Constant\n\nOutput\n\nroot1: Root built from positive discriminant term\nroot2: Root built from negative discriminant term\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.saelgv-Tuple{Any, Any}","page":"API","title":"SPICE.saelgv","text":"saelgv(vec1, vec2)\n\nFind semi-axis vectors of an ellipse generated by two arbitrary three-dimensional vectors.\n\nArguments\n\nvec1, vec2: Two vectors used to generate an ellipse\n\nOutput\n\nsmajor: Semi-major axis of ellipse\nsminor: Semi-minor axis of ellipse\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.scard!-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, Any}} where T","page":"API","title":"SPICE.scard!","text":"scard!(cell::SpiceCell{T}, card) where T\n\nSet the cardinality of a cell.\n\nArguments\n\ncell: The cell\ncard: Cardinality of (number of elements in) the cell\n\nOutput\n\nReturns cell with its cardinality set to card.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.scdecd","page":"API","title":"SPICE.scdecd","text":"scdecd(sc, sclkdp, lenout=128)\n\nConvert double precision encoding of spacecraft clock time into a character representation.\n\nArguments\n\nsc: NAIF spacecraft identification code\nsclkdp: Encoded representation of a spacecraft clock count\nlenout: Maximum allowed length of output SCLK string\n\nOutput\n\nReturns the character representation of a clock count.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.sce2c-Tuple{Any, Any}","page":"API","title":"SPICE.sce2c","text":"sce2c(sc, et)\n\nConvert ephemeris seconds past J2000 (ET) to continuous encoded spacecraft clock (\"ticks\"). Non-integral tick values may be returned.\n\nArguments\n\nsc: NAIF spacecraft ID code\net: Ephemeris time, seconds past J2000\n\nOutput\n\nReturns SCLK, encoded as ticks since spacecraft clock start.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sce2s","page":"API","title":"SPICE.sce2s","text":"sce2s(sc, et, lenout=128)\n\nConvert an epoch specified as ephemeris seconds past J2000 (ET) to a character string representation of a spacecraft clock value (SCLK).\n\nArguments\n\nsc: NAIF spacecraft identification code\net: Ephemeris time, specified as seconds past J2000\nlenout: Maximum allowed length of output SCLK string\n\nOutput\n\nReturns an SCLK string.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.sce2t-Tuple{Any, Any}","page":"API","title":"SPICE.sce2t","text":"sce2t(sc, et)\n\nConvert ephemeris seconds past J2000 (ET) to integral encoded spacecraft clock (\"ticks\"). For conversion to fractional ticks, (required for C-kernel production), see the routine sce2c.\n\nArguments\n\nsc: NAIF spacecraft ID code\net: Ephemeris time, seconds past J2000\n\nOutput\n\nReturns SCLK, encoded as ticks since spacecraft clock start.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.scencd-Tuple{Any, Any}","page":"API","title":"SPICE.scencd","text":"scencd(sc, sclkch)\n\nEncode character representation of spacecraft clock time into a double precision number.\n\nArguments\n\nsc: NAIF spacecraft identification code\nsclkch: Character representation of a spacecraft clock\n\nOutput\n\nReturns the encoded representation of the clock count.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.scfmt","page":"API","title":"SPICE.scfmt","text":"scfmt(sc, ticks, lenout=128)\n\nConvert encoded spacecraft clock ticks to character clock format.\n\nArguments\n\nsc: NAIF spacecraft identification code\nticks: Encoded representation of a spacecraft clock count\nlenout: Maximum allowed length of output string\n\nOutput\n\nReturns a character representation of a clock count.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.scpart-Tuple{Any}","page":"API","title":"SPICE.scpart","text":"scpart(sc)\n\nGet spacecraft clock partition information from a spacecraft clock kernel file.\n\nArguments\n\nsc: NAIF spacecraft identification code\n\nOutput\n\npstart: Array of partition start times\npstop: Array of partition stop times\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.scs2e-Tuple{Any, Any}","page":"API","title":"SPICE.scs2e","text":"scs2e(sc, sclkch)\n\nConvert a spacecraft clock string to ephemeris seconds past J2000 (ET).\n\nArguments\n\nsc: NAIF integer code for a spacecraft\nsclkch: An SCLK string\n\nOutput\n\nReturns ephemeris time seconds past J2000.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sct2e-Tuple{Any, Any}","page":"API","title":"SPICE.sct2e","text":"sct2e(sc, sclkdp)\n\nConvert encoded spacecraft clock (\"ticks\") to ephemeris seconds past J2000 (ET).\n\nArguments\n\nsc: NAIF integer code for a spacecraft\nsclkdp: SCLK, encoded as ticks since spacecraft clock start.\n\nOutput\n\nReturns ephemeris time seconds past J2000.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sctiks-Tuple{Any, Any}","page":"API","title":"SPICE.sctiks","text":"sctiks(sc, clkstr)\n\nConvert a spacecraft clock format string to number of \"ticks\".\n\nArguments\n\nsc: NAIF spacecraft identification code\nclkstr: Character representation of a spacecraft clock\n\nOutput\n\nReturns the number of ticks represented by the clock string.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sdiff-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, SPICE.SpiceCell{T}}} where T","page":"API","title":"SPICE.sdiff","text":"sdiff(a::T, b::T) where T <: SpiceCell\n\nCompute the symmetric difference of two sets of any data type to form a third set.\n\nArguments\n\na: First input set\nb: Second input set\n\nOutput\n\nReturns a cell containing the symmetric difference of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.set-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, Any, SPICE.SpiceCell{T}}} where T","page":"API","title":"SPICE.set","text":"set(a::T, b::T) where T <: SpiceCell\n\nGiven a relational operator, compare two sets of any data type.\n\nArguments\n\na: First set\nop: Comparison operator\nb: Second set\n\nOutput\n\nReturns the result of the comparison: a (op) b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.shellc","page":"API","title":"SPICE.shellc","text":"shellc(array)\n\nwarning: Deprecated\nUse sort!(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.shelld","page":"API","title":"SPICE.shelld","text":"shelld(array)\n\nwarning: Deprecated\nUse sort!(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.shelli","page":"API","title":"SPICE.shelli","text":"shelli(array)\n\nwarning: Deprecated\nUse sort!(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.sincpt-NTuple{8, Any}","page":"API","title":"SPICE.sincpt","text":"sincpt(method, target, et, fixref, abcorr, obsrvr, dref, dvec)\n\nGiven an observer and a direction vector defining a ray, compute the surface intercept of the ray on a target body at a specified epoch, optionally corrected for light time and stellar aberration.\n\nThe surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in TDB seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction flag\nobsrvr: Name of observing body\ndref: Reference frame of ray's direction vector\ndvec: Ray's direction vector\n\nOutput\n\nReturns a tuple consisting of the following data or nothing if no intercept was found.\n\nspoint: Surface intercept point on the target body\ntrgepc: Intercept epoch\nsrfvec: Vector from observer to intercept point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.size_c-Tuple{Any}","page":"API","title":"SPICE.size_c","text":"size_c(cell::SpiceCell)\n\nReturns the maximum number of elements that cell can hold.\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spd-Tuple{}","page":"API","title":"SPICE.spd","text":"spd()\n\nReturns the number of seconds in a day.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sphcyl-Tuple{Any, Any, Any}","page":"API","title":"SPICE.sphcyl","text":"sphcyl(radius, colat, slon)\n\nConverts from spherical coordinates to cylindrical coordinates.\n\nArguments\n\nradius: Distance of point from origin\ncolat: Polar angle (co-latitude in radians) of point\nslon: Azimuthal angle (longitude) of point (radians)\n\nOutput\n\nr: Distance of point from Z axis\nlon: Angle (radians) of point from XZ plane\nz: Height of point above XY plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sphlat-Tuple{Any, Any, Any}","page":"API","title":"SPICE.sphlat","text":"sphlat(r, colat, lons)\n\nConvert from spherical coordinates to latitudinal coordinates.\n\nArguments\n\nr: Distance of the point from the origin\ncolat: Angle of the point from positive z axis (radians)\nlons: Angle of the point from the XZ plane (radians)\n\nOutput\n\nradius: Distance of a point from the origin\nlon: Angle of the point from the XZ plane in radians\nlat: Angle of the point from the XY plane in radians\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sphrec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.sphrec","text":"sphrec(r, colat, lon)\n\nConvert from spherical coordinates to rectangular coordinates.\n\nArguments\n\nr: Distance of a point from the origin\ncolat: Angle of the point from the Z-axis in radians\nlon: Angle of the point from the XZ plane in radians\n\nOutput\n\nReturns the rectangular coordinates of the point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spk14a-NTuple{4, Any}","page":"API","title":"SPICE.spk14a","text":"spk14a(handle, ncsets, coeffs, epochs)\n\nAdd data to a type 14 SPK segment associated with handle. See also spk14b and spk14e.\n\nArguments\n\nhandle: The handle of an SPK file open for writing\nncsets: The number of coefficient sets and epochs\ncoeffs: The collection of coefficient sets\nepochs: The epochs associated with the coefficient sets\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spk14b-NTuple{8, Any}","page":"API","title":"SPICE.spk14b","text":"spk14b(handle, segid, body, center, frame, first, last, chbdeg)\n\nBegin a type 14 SPK segment in the SPK file associated with handle. See also spk14a and spk14e.\n\nArguments\n\nhandle: The handle of an SPK file open for writing\nsegid: The string to use for segment identifier\nbody: The NAIF ID code for the body of the segment\ncenter: The center of motion for body\nframe: The reference frame for this segment\nfirst: The first epoch for which the segment is valid\nlast: The last epoch for which the segment is valid\nchbdeg: The degree of the Chebyshev Polynomial used\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spk14e-Tuple{Any}","page":"API","title":"SPICE.spk14e","text":"spk14e(handle)\n\nEnd the type 14 SPK segment currently being written to the SPK file associated with handle. See also spk14a and spk14b.\n\nArguments\n\nhandle: The handle of an SPK file open for writing\n\nOutput\n\nReturns the handle of the SPK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkacs-NTuple{5, Any}","page":"API","title":"SPICE.spkacs","text":"spkacs(targ, et, ref, abcorr, obs, starg, lt, dlt)\n\nReturn the state (position and velocity) of a target body relative to an observer, optionally corrected for light time and stellar aberration, expressed relative to an inertial reference frame.\n\nArguments\n\ntarg: Target body\net: Observer epoch\nref: Inertial reference frame of output state\nabcorr: Aberration correction flag\nobs: Observer\n\nOutput\n\nstarg: State of target\nlt: One way light time between observer and target\ndlt: Derivative of light time with respect to time\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkapo-NTuple{5, Any}","page":"API","title":"SPICE.spkapo","text":"spkapo(targ, et, ref, sobs, abcorr)\n\nReturn the position of a target body relative to an observer, optionally corrected for light time and stellar aberration.\n\nArguments\n\ntarg: Target body\net: Observer epoch\nref: Inertial reference frame of observer's state\nsobs: State of observer wrt. solar system barycenter\nabcorr: Aberration correction flag\n\nOutput\n\nptarg: Position of target\nlt: One way light time between observer and target\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkaps-NTuple{6, Any}","page":"API","title":"SPICE.spkaps","text":"spkaps(targ, et, ref, abcorr, stobs, accobs)\n\nGiven the state and acceleration of an observer relative to the solar system barycenter, return the state (position and velocity) of a target body relative to the observer, optionally corrected for light time and stellar aberration. All input and output vectors are expressed relative to an inertial reference frame.\n\nUsers normally should call the high-level API routines spkezr or spkez rather than this routine.\n\nArguments\n\ntarg: Target body.\net: Observer epoch.\nref: Inertial reference frame of output state.\nabcorr: Aberration correction flag.\nstobs: State of the observer relative to the SSB.\naccobs: Acceleration of the observer relative to the SSB.\n\nOutput\n\nstarg: State of target.\nlt: One way light time between observer and target.\ndlt: Derivative of light time with respect to time.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcls-Tuple{Any}","page":"API","title":"SPICE.spkcls","text":"spkcls(handle)\n\nClose an open SPK file.\n\nArguments\n\nhandle: Handle of the SPK file to be closed\n\nOutput\n\nReturns the handle of the closed file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcov!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.spkcov!","text":"spkcov!(cover, spk, idcode)\n\nFind the coverage window for a specified ephemeris object in a specified SPK file.\n\nArguments\n\ncover: Window giving coverage in spk for idcode\nspk: Name of the SPK file\nidcode: ID code of ephemeris object\n\nOutput\n\nReturns the extended coverage window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcpo-NTuple{8, Any}","page":"API","title":"SPICE.spkcpo","text":"spkcpo(target, et, outref, refloc, abcorr, obspos, obsctr, obsref)\n\nReturn the state of a specified target relative to an \"observer,\" where the observer has constant position in a specified reference frame. The observer's position is provided by the calling program rather than by loaded SPK files.\n\nArguments\n\ntarget: Name of target ephemeris object\net: Observation epoch\noutref: Reference frame of output state\nrefloc: Output reference frame evaluation locus\nabcorr: Aberration correction\nobspos: Observer position relative to center of motion\nobsctr: Center of motion of observer\nobsref: Frame of observer position\n\nOutput\n\nstate: State of target with respect to observer\nlt: One way light time between target and observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcpt-NTuple{8, Any}","page":"API","title":"SPICE.spkcpt","text":"spkcpt(trgpos, trgctr, trgref, et, outref, refloc, abcorr, obsrvr)\n\nReturn the state, relative to a specified observer, of a target having constant position in a specified reference frame. The target's position is provided by the calling program rather than by loaded SPK files.\n\nArguments\n\ntrgpos: Target position relative to center of motion\ntrgctr: Center of motion of target\ntrgref: Frame of target position\net: Observation epoch\noutref: Reference frame of output state\nrefloc: Output reference frame evaluation locus\nabcorr: Aberration correction\nobsrvr: Name of observing ephemeris object\n\nOutput\n\nstate: State of target with respect to observer\nlt: One way light time between target and observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcvo-NTuple{9, Any}","page":"API","title":"SPICE.spkcvo","text":"spkcvo(target, et, outref, refloc, abcorr, obssta, obsepc, obsctr, obsref)\n\nReturn the state of a specified target relative to an \"observer,\" where the observer has constant velocity in a specified reference frame. The observer's state is provided by the calling program rather than by loaded SPK files.\n\nArguments\n\ntarget: Name of target ephemeris object\net: Observation epoch\noutref: Reference frame of output state\nrefloc: Output reference frame evaluation locus\nabcorr: Aberration correction\nobssta: Observer state relative to center of motion\nobsepc: Epoch of observer state\nobsctr: Center of motion of observer\nobsref: Frame of observer state\n\nOutput\n\nstate: State of target with respect to observer\nlt: One way light time between target and observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkcvt-NTuple{9, Any}","page":"API","title":"SPICE.spkcvt","text":"spkcvt(trgsta, trgepc, trgctr, trgref, et, outref, refloc, abcorr, obsrvr)\n\nReturn the state, relative to a specified observer, of a target having constant velocity in a specified reference frame. The target's state is provided by the calling program rather than by loaded SPK files.\n\nArguments\n\ntrgsta: Target state relative to center of motion\ntrgepc: Epoch of target state\ntrgctr: Center of motion of target\ntrgref: Frame of target state\net: Observation epoch\noutref: Reference frame of output state\nrefloc: Output reference frame evaluation locus\nabcorr: Aberration correction\nobsrvr: Name of observing ephemeris object\n\nOutput\n\nstate: State of target with respect to observer\nlt: One way light time between target and observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkez-NTuple{5, Any}","page":"API","title":"SPICE.spkez","text":"spkez(targ, et, ref, abcorr, obs)\n\nReturn the state (position and velocity) of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.\n\nArguments\n\ntarg: Target body\net: Observer epoch\nref: Reference frame of output state vector\nabcorr: Aberration correction flag\nobs: Observing body\n\nOutput\n\nstarg: State of target\nlt: One way light time between observer and target\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkezp-NTuple{5, Any}","page":"API","title":"SPICE.spkezp","text":"spkezp(targ, et, ref, abcorr, obs)\n\nReturn the position of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.\n\nArguments\n\ntarg: Target body\net: Observer epoch\nref: Reference frame of output state vector\nabcorr: Aberration correction flag\nobs: Observing body\n\nOutput\n\nptarg: Position of target\nlt: One way light time between observer and target\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkezr-NTuple{5, Any}","page":"API","title":"SPICE.spkezr","text":"spkezr(targ, et, ref, abcorr, obs)\n\nReturn the state (position and velocity) of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.\n\nArguments\n\ntarg: Target body name\net: Observer epoch\nref: Reference frame of output state vector\nabcorr: Aberration correction flag\nobs: Observing body name\n\nOutput\n\nstarg: State of target\nlt: One way light time between observer and target\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkgeo-NTuple{4, Any}","page":"API","title":"SPICE.spkgeo","text":"spkgeo(targ, et, ref, obs)\n\nCompute the geometric state (position and velocity) of a target body relative to an observing body.\n\nArguments\n\ntarg: Target body.\net: Target epoch.\nref: Target reference frame.\nobs: Observing body.\n\nOutput\n\nstate: State of target.\nlt: Light time.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkgps-NTuple{4, Any}","page":"API","title":"SPICE.spkgps","text":"spkgps(targ, et, ref, obs)\n\nCompute the geometric position of a target body relative to an observing body.\n\nArguments\n\ntarg: Target body\net: Target epoch\nref: Target reference frame\nobs: Observing body\n\nOutput\n\npos: Position of target\nlt: Light time\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spklef-Tuple{Any}","page":"API","title":"SPICE.spklef","text":"spklef(fname)\n\nLoad an ephemeris file for use by the readers. Return that file's handle, to be used by other SPK routines to refer to the file.\n\nArguments\n\nfname: Name of the file to be loaded\n\nOutput\n\nhandle: Loaded file's handle\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkltc-NTuple{5, Any}","page":"API","title":"SPICE.spkltc","text":"spkltc(targ, et, ref, abcorr, stobs)\n\nReturn the state (position and velocity) of a target body relative to an observer, optionally corrected for light time, expressed relative to an inertial reference frame.\n\nArguments\n\ntarg: Target body\net: Observer epoch\nref: Inertial reference frame of output state\nabcorr: Aberration correction flag\nstobs: State of the observer relative to the SSB\n\nOutput\n\nstarg: State of target\nlt: One way light time between observer and target\ndlt: Derivative of light time with respect to time\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkobj!-Tuple{Any, Any}","page":"API","title":"SPICE.spkobj!","text":"spkobj!(ids, spk)\n\nFind the set of ID codes of all objects in a specified SPK file.\n\nArguments\n\nids: A preallocated set of ID codes of objects in SPK file\nspk: Name of the SPK file\n\nOutput\n\nReturns the set of id codes.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkopa-Tuple{Any}","page":"API","title":"SPICE.spkopa","text":"spkopa(file)\n\nOpen an existing SPK file for subsequent write.\n\nArguments\n\nfile: The name of an existing SPK file\n\nOutput\n\nReturns a handle attached to the SPK file opened to append.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkopn","page":"API","title":"SPICE.spkopn","text":"spkopn(name, ifname=\"\", ncomch=0)\n\nCreate a new SPK file, returning the handle of the opened file.\n\nArguments\n\nname: The name of the new SPK file to be created\nifname: The internal filename for the SPK file (default: \"\")\nncomch: The number of characters to reserve for comments (default: 0)\n\nOutput\n\nReturns the handle of the opened SPK file.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.spkpds-NTuple{6, Any}","page":"API","title":"SPICE.spkpds","text":"spkpds(body, center, frame, typ, first, last)\n\nPerform routine error checks and if all checks pass, pack the descriptor for an SPK segment.\n\nArguments\n\nbody: The NAIF ID code for the body of the segment\ncenter: The center of motion for body\nframe: The frame for this segment\ntype: The type of SPK segment to create\nfirst: The first epoch for which the segment is valid\nlast: The last epoch for which the segment is valid\n\nOutput\n\nReturns an SPK segment descriptor.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkpos-NTuple{5, Any}","page":"API","title":"SPICE.spkpos","text":"spkpos(targ, et, ref, abcorr, obs)\n\nReturn the position of a target body relative to an observing body, optionally corrected for light time (planetary aberration) and stellar aberration.\n\nArguments\n\ntarg: Target body name\net: Observer epoch\nref: Reference frame of output position vector\nabcorr: Aberration correction flag\nobs: Observing body name\n\nOutput\n\nptarg: Position of target\nlt: One way light time between observer and target\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkpvn-Tuple{Any, Any, Any}","page":"API","title":"SPICE.spkpvn","text":"spkpvn(handle, descr, et)\n\nFor a specified SPK segment and time, return the state (position and velocity) of the segment's target body relative to its center of motion.\n\nArguments\n\nhandle: File handle\ndescr: Segment descriptor\net: Evaluation epoch\n\nOutput\n\nref: Segment reference frame ID code\nstate: Output state vector\ncenter: Center of state\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spksfs-Tuple{Any, Any}","page":"API","title":"SPICE.spksfs","text":"spksfs(body, et)\n\nSearch through loaded SPK files to find the highest-priority segment applicable to the body and time specified.\n\nArguments\n\nbody: Body ID\net: Ephemeris time\n\nOutput\n\nReturns nothing if no segment was found or a tuple consisting of:\n\nhandle: Handle of file containing the applicable segment\ndescr: Descriptor of the applicable segment\nident: Identifier of the applicable segment\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkssb-Tuple{Any, Any, Any}","page":"API","title":"SPICE.spkssb","text":"spkssb(targ, et, ref)\n\nReturn the state (position and velocity) of a target body relative to the solar system barycenter.\n\nArguments\n\ntarg: Target body\net: Target epoch\nref: Target reference frame\n\nOutput\n\nReturns the state of target.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spksub!-NTuple{6, Any}","page":"API","title":"SPICE.spksub!","text":"spksub!(newh, handle, descr, ident, start, stop)\n\nExtract a subset of the data in an SPK segment into a separate segment.\n\nArguments\n\nnewh: Handle of new segment\nhandle: Handle of source segment\ndescr: Descriptor of source segment\nident: Identifier of source segment\nstart: Beginning (initial epoch) of subset\nstop: End (final epoch) of subset\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkuds-Tuple{Any}","page":"API","title":"SPICE.spkuds","text":"spkuds(descr)\n\nUnpack the contents of an SPK segment descriptor.\n\nArguments\n\ndescr: An SPK segment descriptor\n\nOutput\n\nbody: The NAIF ID code for the body of the segment\ncenter: The center of motion for body\nframe: The ID code for the frame of this segment\ntype: The type of SPK segment\nfirst: The first epoch for which the segment is valid\nlast: The last epoch for which the segment is valid\nstart: Beginning DAF address of the segment\nstop: Ending DAF address of the segment\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkuef-Tuple{Any}","page":"API","title":"SPICE.spkuef","text":"spkuef(handle)\n\nUnload an ephemeris file so that it will no longer be searched by the readers.\n\nArguments\n\nhandle: Handle of file to be unloaded\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw02-NTuple{10, Any}","page":"API","title":"SPICE.spkw02","text":"spkw02(handle, body, center, frame, first, last, segid, intlen, cdata, btime)\n\nWrite a type 2 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\nintlen: Length of time covered by logical record\ncdata: Array of Chebyshev coefficients\nbtime: Begin time of first logical record\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw03-NTuple{10, Any}","page":"API","title":"SPICE.spkw03","text":"spkw03(handle, body, center, frame, first, last, segid, intlen, cdata, btime)\n\nWrite a type 3 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\nintlen: Length of time covered by logical record\ncdata: Array of Chebyshev coefficients\nbtime: Begin time of first logical record\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw05-NTuple{10, Any}","page":"API","title":"SPICE.spkw05","text":"spkw05(handle, body, center, frame, first, last, segid, gm, states, epochs)\n\nWrite an SPK segment of type 5 given a time-ordered set of discrete states and epochs, and the gravitational parameter of a central body.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\ngm: Gravitational parameter of central body\nstates: States\nepochs: Epochs\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw08-NTuple{11, Any}","page":"API","title":"SPICE.spkw08","text":"spkw08(handle, body, center, frame, first, last, segid, degree, states, epoch1, step)\n\nWrite a type 8 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\ndegree: Degree of interpolating polynomials\nstates: States\nepoch1: Epoch of first state in states array\nstep: Time step separating epochs of states\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw09-NTuple{10, Any}","page":"API","title":"SPICE.spkw09","text":"spkw09(handle, body, center, frame, first, last, segid, degree, states, epochs)\n\nWrite a type 9 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\ndegree: Degree of interpolating polynomials\nstates: States\nepochs: Epochs\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw10-NTuple{10, Any}","page":"API","title":"SPICE.spkw10","text":"spkw10(handle, body, center, frame, first, last, segid, consts, elems, epochs)\n\nWrite a type 10 segment to an SPK file.\n\nArguments\n\nhandle: The handle of a DAF file open for writing\nbody: The NAIF ID code for the body of the segment\ncenter: The center of motion for body\nframe: The reference frame for this segment\nfirst: The first epoch for which the segment is valid\nlast: The last epoch for which the segment is valid\nsegid: The string to use for segment identifier\nconsts: The array of geophysical constants for the segmen\nelems: The collection of \"two-line\" element sets\nepochs: The epochs associated with the element sets\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw12-NTuple{11, Any}","page":"API","title":"SPICE.spkw12","text":"spkw12(handle, body, center, frame, first, last, segid, degree, states, epoch1, step)\n\nWrite a type 12 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\ndegree: Degree of interpolating polynomials\nstates: States\nepoch1: Epoch of first state in states array\nstep: Time step separating epochs of states\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw13-NTuple{10, Any}","page":"API","title":"SPICE.spkw13","text":"spkw13(handle, body, center, frame, first, last, segid, degree, states, epochs)\n\nWrite a type 13 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\ndegree: Degree of interpolating polynomials\nstates: States\nepochs: Epochs\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw15-NTuple{17, Any}","page":"API","title":"SPICE.spkw15","text":"spkw15(handle, body, center, frame, first, last, segid,\n epoch, tp, pa, p, ecc, j2flg, pv, gm, j2, radius)\n\nWrite a type 15 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\nepoch: Epoch of the periapse\ntp: Trajectory pole vector\npa: Periapsis vector\np: Semi-latus rectum\necc: Eccentricity\nj2flg: J2 processing flag\npv: Central body pole vector\ngm: Central body GM\nj2: Central body J2\nradius: Equatorial radius of central body\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw17-NTuple{11, Any}","page":"API","title":"SPICE.spkw17","text":"spkw17(handle, body, center, frame, first, last, segid, epoch, eqel, rapol, decpol)\n\nWrite a type 17 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nbody: Body code for ephemeris object\ncenter: Body code for the center of motion of the body\nframe: The reference frame of the states\nfirst: First valid time for which states can be computed\nlast: Last valid time for which states can be computed\nsegid: Segment identifier\nepoch: Epoch of elements in seconds past J2000\neqel: Array of equinoctial elements\nrapol: Right Ascension of the pole of the reference plane\ndecpol: Declination of the pole of the reference plane\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw18-NTuple{11, Any}","page":"API","title":"SPICE.spkw18","text":"spkw18(handle, subtyp, body, center, frame, first, last, segid, degree, packts, epochs)\n\nWrite a type 18 segment to an SPK file.\n\nArguments\n\nhandle: Handle of an SPK file open for writing\nsubtyp: SPK type 18 subtype code, either :S18TP0 or :S18TP1\nbody: NAIF code for an ephemeris object\ncenter: NAIF code for center of motion of body\nframe: Reference frame name\nfirst: Start time of interval covered by segment\nlast: End time of interval covered by segment\nsegid: Segment identifier\ndegree: Degree of interpolating polynomials\npackts: Time-ordered array of data packets representing geometric states of body\nFor :S18TP0: [x, y, z, dx/dt, dy/dt, dz/dt, vx, vy, vz, dvx/dt, dvy/dt, dvz/dt]\nFor :S18TP1: [x, y, z, dx/dt, dy/dt, dz/dt]\nepochs: Array of epochs corresponding to states.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.spkw20-NTuple{13, Any}","page":"API","title":"SPICE.spkw20","text":"spkw20(handle, body, center, frame, first, last, segid, intlen, n, polydg, cdata, dscale,\n tscale, initjd, initfr)\n\nWrite a type 20 segment to an SPK file.\n\nArguments\n\nhandle: Handle of SPK file open for writing\nbody: NAIF code for ephemeris object\ncenter: NAIF code for the center of motion of the body\nframe: Reference frame name\nfirst: Start time of interval covered by segment\nlast: End time of interval covered by segment\nsegid: Segment identifier\nintlen: Length of time covered by logical record (days)\ncdata: Array of Chebyshev coefficients and positions\ndscale: Distance scale of data\ntscale: Time scale of data\ninitjd: Integer part of begin time (TDB Julian date) of first record\ninitfr: Fractional part of begin time (TDB Julian date) of first record\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfc2s-Tuple{Any, Any}","page":"API","title":"SPICE.srfc2s","text":"srfc2s(code, bodyid)\n\nTranslate a surface ID code, together with a body ID code, to the corresponding surface name. If no such name exists, return a string representation of the surface ID code.\n\nArguments\n\ncode: Integer surface ID code to translate to a string\nbodyid: ID code of body associated with surface\n\nOutput\n\nsrfstr: String corresponding to surface ID code\nisname: Logical flag indicating output is a surface name\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfcss-Tuple{Any, Any}","page":"API","title":"SPICE.srfcss","text":"srfcss(code, bodstr)\n\nTranslate a surface ID code, together with a body string, to the corresponding surface name. If no such surface name exists, return a string representation of the surface ID code.\n\nArguments\n\ncode: Integer surface ID code to translate to a string\nbodstr: Name or ID of body associated with surface\n\nOutput\n\nsrfstr: String corresponding to surface ID code\nisname: Logical flag indicating output is a surface name\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfnrm-NTuple{5, Any}","page":"API","title":"SPICE.srfnrm","text":"srfnrm(method, target, et, fixref, npts, srfpts)\n\nMap array of surface points on a specified target body to the corresponding unit length outward surface normal vectors.\n\nThe surface of the target body may be represented by a triaxial ellipsoid or by topographic data provided by DSK files.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in TDB seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nsrfpts: Array of surface points\n\nOutput\n\nReturns an array of outward, unit length normal vectors.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfrec-Tuple{Any, Any, Any}","page":"API","title":"SPICE.srfrec","text":"srfrec(body, longitude, latitude)\n\nConvert planetocentric latitude and longitude of a surface point on a specified body to rectangular coordinates.\n\nArguments\n\nbody: NAIF integer code of an extended body.\nlongitude: Longitude of point in radians.\nlatitude: Latitude of point in radians.\n\nOutput\n\nReturns the rectangular coordinates of the point.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfs2c-Tuple{Any, Any}","page":"API","title":"SPICE.srfs2c","text":"srfs2c(srfstr, bodstr)\n\nTranslate a surface string, together with a body string, to the corresponding surface ID code. The input strings may contain names or integer ID codes.\n\nArguments\n\nsrfstr: Surface name or ID string\nbodstr: Body name or ID string\n\nOutput\n\nReturns the surface ID code if it was found or nothing otherwise.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfscc-Tuple{Any, Any}","page":"API","title":"SPICE.srfscc","text":"srfscc(srfstr, bodyid)\n\nTranslate a surface string, together with a body ID code, to the corresponding surface ID code. The input surface string may contain a name or an integer ID code.\n\nArguments\n\nsrfstr: Surface name or ID string\nbodyid: Body ID code.\n\nOutput\n\nReturns the surface ID code if it was found or nothing otherwise.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.srfxpt","page":"API","title":"SPICE.srfxpt","text":"srfxpt\n\nwarning: Deprecated\nUse sincpt instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ssize!-Union{Tuple{T}, Tuple{SPICE.SpiceCell{T}, Any}} where T","page":"API","title":"SPICE.ssize!","text":"ssize!(cell, size)\n\nSet the size (maximum cardinality) of a cell of any data type.\n\nArguments\n\ncell: The cell\nsize: Size (maximum cardinality) of the cell\n\nOutput\n\nReturns the updated cell.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.stelab-Tuple{Any, Any}","page":"API","title":"SPICE.stelab","text":"stelab(pobj, vobs)\n\nCorrect the apparent position of an object for stellar aberration.\n\nArguments\n\npobj: Position of an object with respect to the observer\nvobs: Velocity of the observer with respect to the Solar System barycenter\n\nOutput\n\nReturns the apparent position of the object with respect to the observer, corrected for stellar aberration.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.stpool","page":"API","title":"SPICE.stpool","text":"stpool(item, nth, contin, lenout=1024)\n\nRetrieve the nth string from the kernel pool variable, where the string may be continued across several components of the kernel pool variable.\n\nArguments\n\nitem: Name of the kernel pool variable\nnth: Index of the full string to retrieve\ncontin: Character sequence used to indicate continuation\nlenout: Available space in output string (default: 1024)\n\nOutput\n\nReturns the full string concatenated across continuations if the kernel variable was found or nothing otherwise.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.str2et-Tuple{Any}","page":"API","title":"SPICE.str2et","text":"str2et(str)\n\nConvert a string representing an epoch to a double precision value representing the number of TDB seconds past the J2000 epoch corresponding to the input epoch.\n\nArguments\n\nstr: A string representing an epoch\n\nOutput\n\nReturns the equivalent value in seconds past J2000, TDB.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.subpnt-NTuple{6, Any}","page":"API","title":"SPICE.subpnt","text":"subpnt(method, target, et, fixref, obsrvr, abcorr)\n\nCompute the rectangular coordinates of the sub-observer point on a target body at a specified epoch, optionally corrected for light time and stellar aberration.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in ephemeris seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction\nobsrvr: Name of observing body\n\nOutput\n\nspoint: Sub-solar point on the target body\ntrgepc: Sub-solar point epoch\nsrfvec: Vector from observer to sub-solar point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.subpt","page":"API","title":"SPICE.subpt","text":"subpt\n\nwarning: Deprecated\nUse subpnt instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.subpt_pl02","page":"API","title":"SPICE.subpt_pl02","text":"subpt_pl02\n\nwarning: Deprecated\nUse subpnt instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.subslr-NTuple{6, Any}","page":"API","title":"SPICE.subslr","text":"subslr(method, target, et, fixref, abcorr, obsrvr)\n\nCompute the rectangular coordinates of the sub-solar point on a target body at a specified epoch, optionally corrected for light time and stellar aberration.\n\nArguments\n\nmethod: Computation method\ntarget: Name of target body\net: Epoch in ephemeris seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction\nobsrvr: Name of observing body\n\nOutput\n\nspoint: Sub-solar point on the target body\ntrgepc: Sub-solar point epoch\nsrfvec: Vector from observer to sub-solar point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.subsol","page":"API","title":"SPICE.subsol","text":"subsol\n\nwarning: Deprecated\nUse subslr instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.subsol_pl02","page":"API","title":"SPICE.subsol_pl02","text":"subsol_pl02\n\nwarning: Deprecated\nUse subslr instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.sumad","page":"API","title":"SPICE.sumad","text":"sumad(array)\n\nwarning: Deprecated\nUse sum(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.sumai","page":"API","title":"SPICE.sumai","text":"sumai(array)\n\nwarning: Deprecated\nUse sum(array) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.surfnm-NTuple{4, Any}","page":"API","title":"SPICE.surfnm","text":"surfnm(a, b, c, point)\n\nComputes the outward-pointing, unit normal vector from a point on the surface of an ellipsoid.\n\nArguments\n\na: Length of the ellisoid semi-axis along the x-axis\nb: Length of the ellisoid semi-axis along the y-axis\nc: Length of the ellisoid semi-axis along the z-axis\npoint: Body-fixed coordinates of a point on the ellipsoid\n\nOutput\n\nReturn the outward pointing unit normal to ellipsoid at point\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.surfpt-NTuple{5, Any}","page":"API","title":"SPICE.surfpt","text":"surfpt(positn, u, a, b, c)\n\nDetermine the intersection of a line-of-sight vector with the surface of an ellipsoid.\n\nArguments\n\npositn: Position of the observer in body-fixed frame\nu: Vector from the observer in some direction\na: Length of the ellipsoid semi-axis along the x-axis\nb: Length of the ellipsoid semi-axis along the y-axis\nc: Length of the ellipsoid semi-axis along the z-axis\n\nOutput\n\nReturns the point on the ellipsoid pointed to by u or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.surfpv-NTuple{5, Any}","page":"API","title":"SPICE.surfpv","text":"surfpv(stvrtx, stdir, a, b, c)\n\nFind the state (position and velocity) of the surface intercept defined by a specified ray, ray velocity, and ellipsoid.\n\nArguments\n\nstvrtx: State of ray's vertex\nstdir: State of ray's direction vector\na: Length of ellipsoid semi-axis along the x-axis\nb: Length of ellipsoid semi-axis along the y-axis\nc: Length of ellipsoid semi-axis along the z-axis\n\nOutput\n\nReturn the state of surface intercept or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.swpool-Tuple{Any, Any}","page":"API","title":"SPICE.swpool","text":"swpool(agent, names)\n\nAdd a name to the list of agents to notify whenever a member of a list of kernel variables is updated.\n\nArguments\n\nagent: The name of an agent to be notified after updates\nnames: Variable names whose update causes the notice\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.sxform-Tuple{Any, Any, Any}","page":"API","title":"SPICE.sxform","text":"sxform(from, to, et)\n\nReturn the state transformation matrix from one frame to another at a specified epoch.\n\nArguments\n\nfrom: Name of the frame to transform from\nto: Name of the frame to transform to\net: Epoch of the state transformation matrix\n\nOutput\n\nReturns the state transformation matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.szpool-Tuple{Any}","page":"API","title":"SPICE.szpool","text":"szpool(name)\n\nReturn the kernel pool size limitations.\n\nArguments\n\nname: Name of the parameter to be returned\n\nOutput\n\nReturns the value of the parameter specified by name or nothing if none was found.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.termpt-NTuple{14, Any}","page":"API","title":"SPICE.termpt","text":"Find terminator points on a target body. The caller specifies half-planes, bounded by the illumination source center-target center vector, in which to search for terminator points.\n\nThe terminator can be either umbral or penumbral. The umbral terminator is the boundary of the region on the target surface where no light from the source is visible. The penumbral terminator is the boundary of the region on the target surface where none of the light from the source is blocked by the target itself.\n\nThe surface of the target body may be represented either by a triaxial ellipsoid or by topographic data.\n\nArguments\n\nmethod: Computation method\nilusrc: Illumination source\ntarget: Name of target body\net: Epoch in ephemeris seconds past J2000 TDB\nfixref: Body-fixed, body-centered target body frame\nabcorr: Aberration correction\ncorloc: Aberration correction locus\nobsrvr: Name of observing body\nrefvec: Reference vector for cutting half-planes\nrolstp: Roll angular step for cutting half-planes\nncuts: Number of cutting planes\nschstp: Angular step size for searching\nsoltol: Solution convergence tolerance\nmaxn: Maximum number of entries in output arrays\n\nOutput\n\nnpts: Counts of terminator points corresponding to cuts\npoints: Terminator points\nepochs: Times associated with terminator points\ntrmvcs: Terminator vectors emanating from the observer\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.timdef","page":"API","title":"SPICE.timdef","text":"timdef(action, item, value=\"\")\n\nSet and retrieve the defaults associated with calendar input strings.\n\nArguments\n\naction: The kind of action to take, either :SET or :GET\nitem: The default item of interest. The items that may be requested are:\n:CALENDAR with allowed values:\n\"GREGORIAN\"\n\"JULIAN\"\n\"MIXED\"\n:SYSTEM with allowed values:\n\"TDB\"\n\"TDT\"\n\"UTC\"\n:ZONE with allowed values (0 <= HR < 13 and 0 <= MN < 60):\n\"EST\"\n\"EDT\"\n\"CST\"\n\"CDT\"\n\"MST\"\n\"MDT\"\n\"PST\"\n\"PDT\"\n\"UTC+$HR\"\n\"UTC-$HR\"\n\"UTC+$HR:$MN\"\n\"UTC-$HR:$MN\"\n\nOutput\n\nReturns the value associated with the default item.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.timout","page":"API","title":"SPICE.timout","text":"timout(et, pictur, lenout=128)\n\nThis routine converts an input epoch represented in TDB seconds past the TDB epoch of J2000 to a character string formatted to the specifications of a user's format picture.\n\nArguments\n\net: An epoch in seconds past the ephemeris epoch J2000\npictur: A format specification for the output string\nlenout: The length of the output string plus 1 (default: 128)\n\nOutput\n\nReturns a string representation of the input epoch.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.tipbod-Tuple{Any, Any, Any}","page":"API","title":"SPICE.tipbod","text":"tipbod(ref, body, et)\n\nReturn a 3x3 matrix that transforms positions in inertial coordinates to positions in body-equator-and-prime-meridian coordinates.\n\nArguments\n\nref: Name of inertial reference frame to transform from\nbody: ID code of body\net: Epoch of transformation\n\nOutput\n\nReturns transformation matrix from intertial position to prime meridian.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.tisbod-Tuple{Any, Any, Any}","page":"API","title":"SPICE.tisbod","text":"tisbod(ref, body, et)\n\nReturn a 6x6 matrix that transforms states in inertial coordinates to states in body-equator-and-prime-meridian coordinates.\n\nArguments\n\nref: Name of inertial reference frame to transform from\nbody: ID code of body\net: Epoch of transformation\n\nOutput\n\nReturns transformation matrix from intertial state to prime meridian.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.tkvrsn","page":"API","title":"SPICE.tkvrsn","text":"tkvrsn(item=:TOOLKIT)\n\nGiven an item such as the Toolkit or an entry point name, return the latest version string.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.tparse-Tuple{Any}","page":"API","title":"SPICE.tparse","text":"tparse(string)\n\nParse a time string and return seconds past the J2000 epoch on a formal calendar.\n\nArguments\n\nstring: Input time string in UTC\n\nOutput\n\nReturns UTC expressed in seconds since J2000.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.tpictr","page":"API","title":"SPICE.tpictr","text":"tpictr(sample, lenout=80)\n\nGiven a sample time string, create a time format picture suitable for use by the routine timout.\n\nArguments\n\nsample: A sample time string\nlenout: The length for the output picture string (default: 80)\n\nOutput\n\nReturns a format picture that describes sample.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.trace","page":"API","title":"SPICE.trace","text":"trace(matrix)\n\nwarning: Deprecated\nUse LinearAlgebra.tr(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.tsetyr-Tuple{Any}","page":"API","title":"SPICE.tsetyr","text":"tsetyr(year)\n\nSet the lower bound on the 100 year range.\n\nArguments\n\n-year: Lower bound on the 100 year interval of expansion\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.twopi","page":"API","title":"SPICE.twopi","text":"twopi()\n\nwarning: Deprecated\nUse 2π instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.twovec-NTuple{4, Any}","page":"API","title":"SPICE.twovec","text":"twovec(axdef, indexa, plndef, indexp)\n\nFind the transformation to the right-handed frame having a given vector as a specified axis and having a second given vector lying in a specified coordinate plane.\n\nArguments\n\naxdef: Vector defining a principal axis\nindexa: Principal axis number of axdef (X=1, Y=2, Z=3)\nplndef: Vector defining (with axdef) a principal plane\nindexp: Second axis number (with indexa) of principal plane\n\nOutput\n\nReturns output rotation matrix.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.tyear-Tuple{}","page":"API","title":"SPICE.tyear","text":"tyear()\n\nReturns the number of seconds per tropical year.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.ucase","page":"API","title":"SPICE.ucase","text":"ucase(in)\n\nwarning: Deprecated\nUse uppercase(in) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.ucrss","page":"API","title":"SPICE.ucrss","text":"ucrss(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.normalize(LinearAlgebra.cross(v1, v2)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.uddf-Tuple{Any, Any, Any}","page":"API","title":"SPICE.uddf","text":"uddf(udfunc, x, dx)\n\nRoutine to calculate the first derivative of a caller-specified function using a three-point estimation.\n\nArguments\n\nudfunc: A callable that computes the scalar value of interest, e.g. f(x::Float64) -> Float64\nx: Independent variable of udfunc\ndx: Interval from x for derivative calculation\n\nOutput\n\nReturns the approximate derivative of udfunc at x.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.unitim-Tuple{Any, Any, Any}","page":"API","title":"SPICE.unitim","text":"unitim(epoch, insys, outsys)\n\nTransform time from one uniform scale to another.\n\nArguments\n\nepoch: An epoch to be converted\ninsys: The time scale associated with the input epoch\noutsys: The time scale associated with the function value\n\nThe uniform time scales are:\n\n:TAI\n:TDT\n:TDB\n:ET\n:JED\n:JDTDB\n:JDTDT\n\nOutput\n\nReturns the time in the system specified by outsys that is equivalent to the epoch in the insys time scale.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.unload-Tuple{Any}","page":"API","title":"SPICE.unload","text":"unload(file)\n\nUnload a SPICE kernel.\n\nArguments\n\nfile: The file name of a kernel to unload\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.unorm","page":"API","title":"SPICE.unorm","text":"unorm(v1)\n\nwarning: Deprecated\nUse (LinearAlgebra.normalize(v1), LinearAlgebra.norm(v1)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.unormg","page":"API","title":"SPICE.unormg","text":"unormg(v1)\n\nwarning: Deprecated\nUse (LinearAlgebra.normalize(v1), LinearAlgebra.norm(v1)) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.utc2et-Tuple{Any}","page":"API","title":"SPICE.utc2et","text":"utc2et(utcstr)\n\nConvert an input time from Calendar or Julian Date format, UTC, to ephemeris seconds past J2000.\n\nArguments\n\nutcstr: Input time string, UTC\n\nOutput\n\nReturns the equivalent of utcstr, expressed in ephemeris seconds past J2000.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vadd","page":"API","title":"SPICE.vadd","text":"vadd(v1, v2)\n\nwarning: Deprecated\nUse v1 .+ v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vaddg","page":"API","title":"SPICE.vaddg","text":"vaddg(v1, v2)\n\nwarning: Deprecated\nUse v1 .+ v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.valid!-Union{Tuple{SPICE.SpiceCell{T}}, Tuple{T}} where T","page":"API","title":"SPICE.valid!","text":"valid!(set::SpiceCell{T}) where T\n\nCreate a valid SPICE set from a SPICE Cell of any data type.\n\nArguments\n\nset: Set to be validated\n\nOutput\n\nReturns the validated set with ordered elements and duplicates removed.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vcrss","page":"API","title":"SPICE.vcrss","text":"vcrss(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.cross(v1, v2) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vdist","page":"API","title":"SPICE.vdist","text":"vdist(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.norm(v1 .- v2) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vdistg","page":"API","title":"SPICE.vdistg","text":"vdistg(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.norm(v1 .- v2) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vdot","page":"API","title":"SPICE.vdot","text":"vdot(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.dot(v1, v2) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vdotg","page":"API","title":"SPICE.vdotg","text":"vdotg(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.dot(v1, v2) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vequ","page":"API","title":"SPICE.vequ","text":"vequ(v1, v2)\n\nwarning: Deprecated\nUse v1 .= v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vequg","page":"API","title":"SPICE.vequg","text":"vequg(v1, v2)\n\nwarning: Deprecated\nUse v1 .= v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vhat","page":"API","title":"SPICE.vhat","text":"vhat(v1)\n\nwarning: Deprecated\nUse LinearAlgebra.normalize(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vhatg","page":"API","title":"SPICE.vhatg","text":"vhatg(v1)\n\nwarning: Deprecated\nUse LinearAlgebra.normalize(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vlcom","page":"API","title":"SPICE.vlcom","text":"vlcom(a, v1, b, v2)\n\nwarning: Deprecated\nUse a .* v1 .+ b .* v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vlcom3","page":"API","title":"SPICE.vlcom3","text":"vlcom3(a, v1, b, v2, c, v3)\n\nwarning: Deprecated\nUse a .* v1 .+ b .* v2 .+ c .* v3 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vlcomg","page":"API","title":"SPICE.vlcomg","text":"vlcomg(a, v1, b, v2)\n\nwarning: Deprecated\nUse a .* v1 .+ b .* v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vminug","page":"API","title":"SPICE.vminug","text":"vminug(vin)\n\nwarning: Deprecated\nUse -vin instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vminus","page":"API","title":"SPICE.vminus","text":"vminus(vin)\n\nwarning: Deprecated\nUse -vin instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vnorm","page":"API","title":"SPICE.vnorm","text":"vnorm(v1)\n\nwarning: Deprecated\nUse LinearAlgebra.norm(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vnormg","page":"API","title":"SPICE.vnormg","text":"vnormg(v1, v2)\n\nwarning: Deprecated\nUse LinearAlgebra.norm(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vpack","page":"API","title":"SPICE.vpack","text":"vpack(x, y, z)\n\nwarning: Deprecated\nUse [x, y, z] instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vperp-Tuple{Any, Any}","page":"API","title":"SPICE.vperp","text":"vperp(a, b)\n\nFind the component of a vector that is perpendicular to a second vector.\n\nArguments\n\na: The vector whose orthogonal component is sought\nb: The vector used as the orthogonal reference\n\nOutput\n\nReturns the component a orthogonal to b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vprjp-Tuple{Any, Any}","page":"API","title":"SPICE.vprjp","text":"vprjp(vin, plane)\n\nProject a vector onto a specified plane, orthogonally.\n\nArguments\n\nvin: Vector to be projected\nplane: Plane onto which vin is projected\n\nOutput\n\nReturns the vector resulting from the projection.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vprjpi-Tuple{Any, Any, Any}","page":"API","title":"SPICE.vprjpi","text":"vprjpi(vin, projpl, invpl)\n\nFind the vector in a specified plane that maps to a specified vector in another plane under orthogonal projection.\n\nArguments\n\nvin: The projected vector\nprojpl: Plane containing vin\ninvpl: Plane containing inverse image of vin\n\nOutput\n\nReturns the inverse projection of vin or nothing if vin could not be calculated.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vproj-Tuple{Any, Any}","page":"API","title":"SPICE.vproj","text":"vproj(a, b)\n\nFinds the projection of one vector onto another vector. All vectors are 3-dimensional.\n\nArguments\n\na: The vector to be projected\nb: The vector onto which a is to be projected\n\nOutput\n\nReturns the projection of a onto b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vrel-Tuple{Any, Any}","page":"API","title":"SPICE.vrel","text":"vrel(v1, v2)\n\nReturn the relative difference between two 3-dimensional vectors.\n\nArguments\n\nv1, v2: Two three-dimensional input vectors\n\nOutput\n\nReturns the relative differences between v1 and v2.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vrelg-Tuple{Any, Any}","page":"API","title":"SPICE.vrelg","text":"vrelg(v1, v2)\n\nReturn the relative difference between two vectors.\n\nArguments\n\nv1, v2: Input vectors\n\nOutput\n\nReturns the relative differences between v1 and v2.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vrotv-Tuple{Any, Any, Any}","page":"API","title":"SPICE.vrotv","text":"vrotv(v, axis, theta)\n\nRotate a vector about a specified axis vector by a specified angle and return the rotated vector.\n\nArguments\n\nv: Vector to be rotated\naxis: Axis of the rotation\ntheta: Angle of rotation (radians)\n\nOutput\n\nResult of rotating v about axis by theta.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vscl","page":"API","title":"SPICE.vscl","text":"vscl(s, v1)\n\nwarning: Deprecated\nUse s .* v1 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vsclg","page":"API","title":"SPICE.vsclg","text":"vsclg(s, v1)\n\nwarning: Deprecated\nUse s .* v1 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vsep-Tuple{Any, Any}","page":"API","title":"SPICE.vsep","text":"vsep(v1, v2)\n\nReturn the sepative difference between two 3-dimensional vectors.\n\nArguments\n\nv1, v2: Two three-dimensional input vectors\n\nOutput\n\nReturns the angle between v1 and v2 in radians.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vsepg-Tuple{Any, Any}","page":"API","title":"SPICE.vsepg","text":"vsepg(v1, v2)\n\nReturn the sepative difference between two vectors.\n\nArguments\n\nv1, v2: Input vectors\n\nOutput\n\nReturns the angle between v1 and v2 in radians.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.vsub","page":"API","title":"SPICE.vsub","text":"vsub(v1, v2)\n\nwarning: Deprecated\nUse v1 .- v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vsubg","page":"API","title":"SPICE.vsubg","text":"vsubg(v1, v2)\n\nwarning: Deprecated\nUse v1 .- v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vtmv","page":"API","title":"SPICE.vtmv","text":"vtmv(v1, matrix, v2)\n\nwarning: Deprecated\nUse v1' * matrix * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vtmvg","page":"API","title":"SPICE.vtmvg","text":"vtmvg(v1, matrix, v2)\n\nwarning: Deprecated\nUse v1' * matrix * v2 instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vupack","page":"API","title":"SPICE.vupack","text":"vupack(v)\n\nwarning: Deprecated\nUse x, y, z = v instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vzero","page":"API","title":"SPICE.vzero","text":"vzero(v1)\n\nwarning: Deprecated\nUse iszero(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.vzerog","page":"API","title":"SPICE.vzerog","text":"vzerog(v1, v2)\n\nwarning: Deprecated\nUse iszero(v1) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.wncard-Tuple{Any}","page":"API","title":"SPICE.wncard","text":"wncard(window)\n\nReturn the cardinality (number of intervals) of a double precision window.\n\nArguments\n\nwindow: Input window\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wncomd-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wncomd","text":"wncomd(window, left, right)\n\nDetermine the complement of a double precision window with respect to a specified interval.\n\nArguments\n\nwindow: Input window\nleft: Left endpoint of the complement interval\nright: Right endpoint of the complement interval\n\nOutput\n\nReturns the complement of window with respect to [left,right].\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wncond!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wncond!","text":"wncond!(window, left, right)\n\nContract each of the intervals of a double precision window.\n\nArguments\n\nwindow: Window to be contracted\nleft: Amount added to each left endpoint\nright: Amount subtracted from each right endpoint\n\nOutput\n\nReturns the contracted window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wndifd-Tuple{Any, Any}","page":"API","title":"SPICE.wndifd","text":"wndifd(a, b)\n\nPlace the difference of two double precision windows into a third window.\n\nArguments\n\na: Input window\nb: Input window\n\nOutput\n\nReturns a window containing the difference of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnelmd-Tuple{Any, Any}","page":"API","title":"SPICE.wnelmd","text":"wnelmd(window, point)\n\nDetermine whether a point is an element of a double precision window.\n\nArguments\n\nwindow: Input window\npoint: Input point\n\nOutput\n\nReturns true if point is an element of window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnexpd!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wnexpd!","text":"wnexpd(window, left, right)\n\nExpand each of the intervals of a double precision window.\n\nArguments\n\nleft: Amount subtracted from each left endpoint\nright: Amount added to each right endpoint\n\nOutput\n\nReturns the expanded window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnextd!-Tuple{Any, Any}","page":"API","title":"SPICE.wnextd!","text":"wnextd!(window, side)\n\nExtract the left or right endpoints from a double precision window.\n\nArguments\n\nwindow: Window to be extracted\nside: Extract left (:L) or right (:R) endpoints\n\nOutput\n\nReturns the extracted window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnfetd-Tuple{Any, Any}","page":"API","title":"SPICE.wnfetd","text":"wnfetd(window, n)\n\nFetch a particular interval from a double precision window.\n\nArguments\n\nwindow: Input window\nn: Index of interval to be fetched\n\nOutput\n\nReturns a tuple consisting of the left and right endpoints of the n-th interval in the input window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnfild!-Tuple{Any, Any}","page":"API","title":"SPICE.wnfild!","text":"wnfild!(window, small)\n\nFill small gaps between adjacent intervals of a double precision window.\n\nArguments\n\nwindow: Window to be filled\nsmall: Limiting measure of small gaps\n\nOutput\n\nReturns the updated window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnfltd!-Tuple{Any, Any}","page":"API","title":"SPICE.wnfltd!","text":"wnfild!(window, small)\n\nFilter (remove) small intervals from a double precision window.\n\nArguments\n\nwindow: Window to be filtered\nsmall: Limiting measure of small intervals\n\nOutput\n\nReturns the updated window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnincd-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wnincd","text":"wnincd(window, left, right)\n\nDetermine whether an interval is included in a double precision window.\n\nArguments\n\nwindow: Input window\nleft: Left endpoint of the input interval\nright: Right endpoint of the input interval\n\nOutput\n\nReturns true when (left, right) is contained in window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wninsd!-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wninsd!","text":"wninsd!(window, left, right)\n\nInsert an interval into a double precision window.\n\nArguments\n\nwindow: Input window\nleft: Left endpoint of the new interval\nright: Right endpoint of the new interval\n\nOutput\n\nReturns the updated windows.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnintd-Tuple{Any, Any}","page":"API","title":"SPICE.wnintd","text":"wnintd(a, b)\n\nPlace the intersection of two double precision windows into a third window.\n\nArguments\n\na: Input window\nb: Input window\n\nOutput\n\nReturns a window containing the intersection of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnreld-Tuple{Any, Any, Any}","page":"API","title":"SPICE.wnreld","text":"wnreld(a, op, b)\n\nCompare two double precision windows.\n\nnote: Note\nConsider using overloaded operators instead, i.e. a == b, a ⊆ b, and a ⊊ b.\n\nArguments\n\na: First window\nop: Comparison operator\nb: Second window\n\nOutput\n\nReturns the result of comparison a (op) b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnsumd-Tuple{Any}","page":"API","title":"SPICE.wnsumd","text":"wnsumd(window)\n\nSummarize the contents of a double precision window.\n\nArguments\n\nwindow: Window to be summarized\n\nOutput\n\nReturns a tuple consisting of:\n\nmeas: Total measure of intervals in window\navg: Average measure\nstddev: Standard deviation\nshortest: Location of shortest interval\nlongest: Location of longest interval\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnunid-Tuple{Any, Any}","page":"API","title":"SPICE.wnunid","text":"wnunid(a, b)\n\nPlace the union of two double precision windows into a third window.\n\nArguments\n\na: Input window\nb: Input window\n\nOutput\n\nReturns a window containing the union of a and b.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.wnvald!-Tuple{Any}","page":"API","title":"SPICE.wnvald!","text":"wnvald!(window)\n\nForm a valid double precision window from the contents of a window array.\n\nArguments\n\nwindow: A (possibly uninitialized) SpiceDoubleCell containing endpoints of (possibly unordered and non-disjoint) intervals.\n\nOutput\n\nReturns the validated window.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.xf2eul-NTuple{4, Any}","page":"API","title":"SPICE.xf2eul","text":"xf2eul(xform, axisa, axisb, axisc)\n\nConvert a state transformation matrix to Euler angles and their derivatives with respect to a specified set of axes.\n\nArguments\n\nxform: A state transformation matrix\naxisa: Axis A of the Euler angle factorization\naxisb: Axis B of the Euler angle factorization\naxisc: Axis C of the Euler angle factorization\n\nOutput\n\nReturns a tuple of an array of Euler angles and their derivatives and a boolean that indicates whether these are a unique representation.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.xf2rav-Tuple{Any}","page":"API","title":"SPICE.xf2rav","text":"xf2rav(xform)\n\nDetermines the rotation matrix and angular velocity of the rotation from a state transformation matrix.\n\nArguments\n\nxform: State transformation matrix\n\nOutput\n\nReturns a tuple of the rotation matrix and the angular velocity vector associated with xform.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.xfmsta-NTuple{4, Any}","page":"API","title":"SPICE.xfmsta","text":"xfmsta(input_state, input_coord_sys, output_coord_sys, body)\n\nTransform a state between coordinate systems.\n\nArguments\n\ninput_state: Input state\ninput_coord_sys: Current (input) coordinate system\noutput_coord_sys: Desired (output) coordinate system\nbody: Name or NAIF ID of body with which coordinates are associated (if applicable)\n\nOutput\n\nReturns the converted output state.\n\nReferences\n\nNAIF Documentation\n\n\n\n\n\n","category":"method"},{"location":"api/#SPICE.xpose","page":"API","title":"SPICE.xpose","text":"xpose(matrix)\n\nwarning: Deprecated\nUse transpose(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.xpose6","page":"API","title":"SPICE.xpose6","text":"xpose6(matrix)\n\nwarning: Deprecated\nUse transpose(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"api/#SPICE.xposeg","page":"API","title":"SPICE.xposeg","text":"xposeg(matrix)\n\nwarning: Deprecated\nUse transpose(matrix) instead.\n\n\n\n\n\n","category":"function"},{"location":"executables/#SPICEApplications.jl","page":"Executables","title":"SPICEApplications.jl","text":"","category":"section"},{"location":"executables/","page":"Executables","title":"Executables","text":"note: Note\nThe SPICEApplications module is not included within SPICE. To access the functions documented on this page, install SPICEApplications using Julia's package manager: Pkg.install(\"SPICEApplications\").","category":"page"},{"location":"executables/","page":"Executables","title":"Executables","text":"The JPL SPICE Toolkit provides executables for interacting with SPICE kernels, such as mkspk, brief, and others. SPICEApplications.jl provides idiomatic Julia interfaces to these executables, which themselves are packaged by CSPICE_jll.jl.","category":"page"},{"location":"executables/#Usage","page":"Executables","title":"Usage","text":"","category":"section"},{"location":"executables/","page":"Executables","title":"Executables","text":"Each executable can be called through its corresponding function without arguments, or programatically using function arguments. For example, the SPICE Toolkit's BRIEF program prints the description of a provided kernel. When the brief executable is called without arguments, it prints its \"help\" text; this can be replicated by calling SPICEApplications.brief() without arguments. Alternatively, you can pass the kernel that you want to inspect as a positional argument: brief(kernel_file).","category":"page"},{"location":"executables/","page":"Executables","title":"Executables","text":"All SPICE Toolkit executables are documented within the SPICE Toolkit Documentation.","category":"page"},{"location":"executables/","page":"Executables","title":"Executables","text":"using SPICEApplications\n\nkernel = download(\"https://naif.jpl.nasa.gov/pub/naif/CASSINI/kernels/spk/000202R_SK_V1P32_V2P12.bsp\")\n\nbrief(kernel);","category":"page"},{"location":"executables/#Example","page":"Executables","title":"Example","text":"","category":"section"},{"location":"executables/","page":"Executables","title":"Executables","text":"For a concrete usage example, see how SPICEApplications is used to generate docstrings for SPICEKernels.jl.","category":"page"},{"location":"executables/#Reference","page":"Executables","title":"Reference","text":"","category":"section"},{"location":"executables/","page":"Executables","title":"Executables","text":"Modules = [SPICEApplications]\nOrder = [:module, :type, :function, :constant]","category":"page"},{"location":"executables/#SPICEApplications.SPICEApplications","page":"Executables","title":"SPICEApplications.SPICEApplications","text":"Call all SPICE Utilities from within Julia!\n\nwarning: Warning\nThis package is not affiliated with or endorsed by NASA, JPL, Caltech, or any other organization! This is an independently written package by an astrodynamics hobbyist.\n\nExtended help\n\nREADME\n\n(Image: Tests) (Image: Docs) (Image: SciML Code Style)\n\nSPICEApplications\n\nGenerate ephemeris kernel files using NASA JPL's SPICEApplications program, all from within Julia!\n\nPlease consider all minor changes breaking until v1.0!\n\nWarningThis package is not affiliated with or endorsed by NASA, JPL, Caltech, or any other organization! This is an independently written package by an astrodynamics hobbyist.\n\nInstallation\n\nChoose one of the following two lines!\n\nimport Pkg; Pkg.add(\"SPICEApplications\");\n\n]add SPICEApplications # in Julia's REPL\n\nCredits\n\nNASA JPL developed and maintains the NAIF SPICE Toolkit, including SPICEApplications. Helge Eichhorn developed and maintains SPICE.jl, as well as the Julia wrappers around the SPICE Toolkit.\n\nLicense\n\nMIT License\n\nCopyright (c) 2023 Joe Carpinelli\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\nExports\n\nbrief\nchronos\nckbrief\ncommnt\ndskbrief\ndskexp\nfrmdiff\ninspekt\nmkdsk\nmkspk\nmsopck\nspacit\nspkdiff\nspkmerge\ntobin\ntoxfr\n\nImports\n\nBase\nCore\nDocStringExtensions\n\n\n\n\n\n","category":"module"},{"location":"executables/#SPICEApplications.brief-Tuple{Vararg{AbstractString}}","page":"Executables","title":"SPICEApplications.brief","text":"brief(\n file;\n tabular,\n single,\n centers,\n utc,\n utcdoy,\n etsec,\n sec,\n min,\n hour,\n day,\n bytime,\n bycoverage,\n byid,\n byname,\n body,\n center,\n at,\n from,\n to,\n listfile,\n help,\n version,\n stdout,\n stderr,\n stdin,\n append,\n wait\n)\n\n\nBRIEF is a command-line utility program that displays a contents and time coverage summary for one or more binary SPK or binary PCK files.\n\nExtended Help\n\nwarning: Warning\nAll descriptions below were manually parsed from the commandline program's help/usage output.\n\nArgument Equivalent Description\ntabular -t Display summary in a tabular format\nsingle -a Treat all files as a single file\ncenters -c Displays centers of motion/relative-to frames\nutc -utc Display times in UTC calendar date format (needs LSK)\nutcdoy -utcdoy Display times in UTC day-of-year format (needs LSK)\netsec -etsec Display times as ET seconds past J2000\nsec -sec Display times \"rounded inward\" to second\nmin -min Display times \"rounded inward\" to minute\nhour -hour Display times \"rounded inward\" to hour\nday -day Display times \"rounded inward\" to day\nbytime -s Display summary sorted by start time for each body/frame\nbycoverage -g Display summary grouped by coverage\nbyid -n Display bodies/frames using numeric id-codes\nbyname -o Display summary ordered by body/frame name\nbody -sb[bod] Display summary for body [bod]\ncenter -sc[cen] Display summary for center of motion/relative-to frame [cen]\nat -at [time] Display summary if coverage contains epoch [time]\nfrom -from [beg] Display summary if coverage contains interval [beg]:[end]\nto -to [end] Display summary if coverage contains interval [beg]:[end]\nlistfile -f [list] Summarize kernels listed in the [list] file\nhelp -h Display help\nversion -v Display version\n\n\n\n\n\n","category":"method"},{"location":"executables/#SPICEApplications.chronos-Tuple{Vararg{AbstractString}}","page":"Executables","title":"SPICEApplications.chronos","text":"chronos(\n file;\n from,\n fromtype,\n to,\n totype,\n format,\n time,\n sc,\n center,\n landingtime,\n sol1index,\n nolabel,\n trace,\n help,\n usage,\n template,\n stdout,\n stderr,\n stdin,\n append,\n wait\n)\n\n\nCHRONOS is a command-line program that converts between several time systems and time formats.\n\nExtended Help\n\nwarning: Warning\nAll descriptions below were manually parsed from the commandline program's help/usage output.\n\nArgument Equivalent Description\nfrom -FROM <\"from\" time system> \"from\" time system\nfromtype -FROMTYPE <\"from\" time system type> \"from\" time system type\nto -TO <\"to\" time system> \"to\" time system\ntotype -TOTYPE <\"to\" time system type> \"to\" time system type\nformat -FORMAT output time format picture\ntime -TIME intput time\nsc -SC sc ID\ncenter -CENTER cental body ID\nlandingtime -LANDINGTIME UTC time of the landing\nsol1index -SOL1INDEX index of the first SOL\nnolabel -NOLABEL \ntrace -TRACE \nhelp -HELP display help\nusage -USAGE display usage\ntemplate -TEMPLATE display setup file template\n\n\n\n\n\n","category":"method"},{"location":"executables/#SPICEApplications.ckbrief-Tuple{Vararg{AbstractString}}","page":"Executables","title":"SPICEApplications.ckbrief","text":"ckbrief(\n file;\n dump,\n boundaries,\n relframes,\n idframes,\n tabular,\n single,\n bycoverage,\n utc,\n utcdoy,\n sclk,\n dpsclk,\n id,\n summarize,\n help,\n version,\n stdout,\n stderr,\n stdin,\n append,\n wait\n)\n\n\nCKBRIEF is a command-line utility program that displays a contents and time coverage summary for one or more binary CK files.\n\nExtended Help\n\nwarning: Warning\nAll descriptions below were manually parsed from the commandline program's help/usage output.\n\nArgument Equivalent Description\ndump -dump display interpolation intervals boundaries\nboundaries -nm display segment boundaries\nrelframes -rel display relative-to frames\nidframes -n display frames associated with structure IDs\ntabular -t display summary in a tabular format\nsingle -a treat all files as a single file\nbycoverage -g display summary grouped by coverage\nutc -utc display times in UTC calendar date format\nutcdoy -utcdoy display times in UTC day-of-year format\nsclk -sclk display times as SCLK strings\ndpsclk -dpsclk display times as SCLK ticks\nid [ID] display summmary for structure with [ID]\nsummarize -f summarize kernels listed in the [list] file\nhelp -h display help\nversion -v display version\n\n\n\n\n\n","category":"method"},{"location":"executables/#SPICEApplications.commnt","page":"Executables","title":"SPICEApplications.commnt","text":"commnt(; ...)\ncommnt(kernelfile; ...)\ncommnt(\n kernelfile,\n commentfile;\n add,\n extract,\n read,\n delete,\n help,\n stdout,\n stderr,\n stdin,\n append,\n wait\n)\n\n\nCOMMNT is a command-line program that reads, adds, extracts, or deletes comments from SPICE binary kernel files.\n\nExtended Help\n\nwarning: Warning\nAll descriptions below were manually parsed from the commandline program's help/usage output.\n\nArgument Equivalent Description\nadd -a add comments to binary kernel\nextract -e extract comments from a binary kernel\nread -r read the comments in a binary kernel\ndelete -d delete the comments from the binary kernel\nhelp -h display the help message\n\n\n\n\n\n","category":"function"},{"location":"executables/#SPICEApplications.dskbrief-Tuple{Vararg{AbstractString}}","page":"Executables","title":"SPICEApplications.dskbrief","text":"dskbrief(\n file;\n single,\n gaps,\n extended,\n timebounds,\n bysegment,\n full,\n sigdigs,\n version,\n help,\n usage,\n stdout,\n stderr,\n stdin,\n append,\n wait\n)\n\n\nDSKBRIEF is a command-line utility program that displays a summary of the spatial coverage and additional attributes of one or more binary Digital Shape Kernel (DSK) files.\n\nExtended Help\n\nwarning: Warning\nAll descriptions below were manually parsed from the commandline program's help/usage output.\n\nArgument Equivalent Description\nsingle -a treat all DSK files as a single file\ngaps -gaps display coverage gaps (aplies only when -a is used)\nextended -ext display extended summaries: these include data type, data class, and time bounds\ntimebounds -tg require segment time bounds to match when grouping segments\nfull -full display a detailed summary for each segment, including data-type-specific parameters\nsigdigs -d display n significant digits of floating point values\nversion -v display the version of the program\nhelp -h display help text\nusage -u display usage text\n\n\n\n\n\n","category":"method"},{"location":"executables/#SPICEApplications.dskexp-Tuple{}","page":"Executables","title":"SPICEApplications.dskexp","text":"dskexp(\n;\n dsk,\n text,\n format,\n precision,\n stdout,\n stderr,\n stdin,\n append,\n wait\n)\n\n\nDSKEXP is a command-line program that exports data from DSK files to text files.\n\nExtended Help\n\nwarning: Warning\nAll descriptions below were manually parsed from the commandline program's help/usage output.\n\nArgument Equivalent Description\ndsk -dsk DSK kernel\ntext -text output name\nformat -format MKSDK format code/name\nprecision -prec <# of vertex mantissa digits (1:17) number of vertex mantissa digits\n\n\n\n\n\n","category":"method"},{"location":"executables/#SPICEApplications.frmdiff-Tuple{}","page":"Executables","title":"SPICEApplications.frmdiff","text":"frmdiff(\n;\n kernels,\n from1,\n to1,\n frame1,\n supporting_kernels1,\n from2,\n to2,\n frame2,\n supporting_kernels2,\n angular,\n angularframe,\n start,\n stop,\n numpoints,\n timestep,\n timeformat,\n report,\n rotation,\n units,\n sigdigs,\n stdout,\n stderr,\n stdin,\n append,\n wait\n)\n\n\nFRMDIFF is a program that samples orientation of a reference frame known to SPICE or computes differences between orientations of two reference frames known to SPICE, and either displays this orientation or these differences, or shows statistics about it or them.\n\nExtended Help\n\nwarning: Warning\nAll descriptions below were manually parsed from the commandline program's help/usage output.\n\nArgument Equivalent Description\nkernels -k supporting kernel(s) name(s)>\nfrom1 -f1 first \"from\" frame, name or ID\nto1 -t1 first \"to\" frame, name or ID\nframe1 -c1 first frame for coverage look up, name or ID\nsupporting_kernels1 -k1 additional supporting kernel(s) for first file\nfrom2 -f2 second \"from\" frame, name or ID\nto2 -t2 second \"to\" frame, name or ID\nframe2 -c2 second frame for coverage look up, name or ID\nsupporting_kernels2 -k2 additional supporting kernel(s) for second file\nangular -a compare angular velocities\nangularframe -m frame for angular velocities\nstart -b interval start time\nstop -e interval stop time\nnumpoints -n number of points\ntimestep -s