Code stringlengths 103 85.9k | Summary listlengths 0 94 |
|---|---|
Please provide a description of the function:def ekinsr(handle, segno, recno):
handle = ctypes.c_int(handle)
segno = ctypes.c_int(segno)
recno = ctypes.c_int(recno)
libspice.ekinsr_c(handle, segno, recno) | [
"\n Add a new, empty record to a specified E-kernel segment at a specified\n index.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekinsr_c.html\n\n :param handle: File handle.\n :type handle: int\n :param segno: Segment number.\n :type segno: int\n :param recno: Record number.\... |
Please provide a description of the function:def eklef(fname):
fname = stypes.stringToCharP(fname)
handle = ctypes.c_int()
libspice.eklef_c(fname, ctypes.byref(handle))
return handle.value | [
"\n Load an EK file, making it accessible to the EK readers.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/eklef_c.html\n\n :param fname: Name of EK file to load.\n :type fname: str\n :return: File handle of loaded EK file.\n :rtype: int\n "
] |
Please provide a description of the function:def eknelt(selidx, row):
selidx = ctypes.c_int(selidx)
row = ctypes.c_int(row)
return libspice.eknelt_c(selidx, row) | [
"\n Return the number of elements in a specified column entry in\n the current row.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/eknelt_c.html\n\n :param selidx: Index of parent column in SELECT clause.\n :type selidx: int\n :param row: Row containing element.\n :type row: int\n ... |
Please provide a description of the function:def ekntab():
n = ctypes.c_int(0)
libspice.ekntab_c(ctypes.byref(n))
return n.value | [
"\n Return the number of loaded EK tables.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekntab_c.html\n\n :return: The number of loaded EK tables.\n :rtype: int\n "
] |
Please provide a description of the function:def ekopn(fname, ifname, ncomch):
fname = stypes.stringToCharP(fname)
ifname = stypes.stringToCharP(ifname)
ncomch = ctypes.c_int(ncomch)
handle = ctypes.c_int()
libspice.ekopn_c(fname, ifname, ncomch, ctypes.byref(handle))
return handle.value | [
"\n Open a new E-kernel file and prepare the file for writing.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekopn_c.html\n\n :param fname: Name of EK file.\n :type fname: str\n :param ifname: Internal file name.\n :type ifname: str\n :param ncomch: The number of characters to res... |
Please provide a description of the function:def ekopr(fname):
fname = stypes.stringToCharP(fname)
handle = ctypes.c_int()
libspice.ekopr_c(fname, ctypes.byref(handle))
return handle.value | [
"\n Open an existing E-kernel file for reading.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekopr_c.html\n\n :param fname: Name of EK file.\n :type fname: str\n :return: Handle attached to EK file.\n :rtype: int\n "
] |
Please provide a description of the function:def ekops():
handle = ctypes.c_int()
libspice.ekops_c(ctypes.byref(handle))
return handle.value | [
"\n Open a scratch (temporary) E-kernel file and prepare the file\n for writing.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekops_c.html\n\n :return: Handle attached to new EK file.\n :rtype: int\n "
] |
Please provide a description of the function:def ekopw(fname):
fname = stypes.stringToCharP(fname)
handle = ctypes.c_int()
libspice.ekopw_c(fname, ctypes.byref(handle))
return handle.value | [
"\n Open an existing E-kernel file for writing.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekopw_c.html\n\n :param fname: Name of EK file.\n :type fname: str\n :return: Handle attached to EK file.\n :rtype: int\n "
] |
Please provide a description of the function:def ekpsel(query, msglen, tablen, collen):
query = stypes.stringToCharP(query)
msglen = ctypes.c_int(msglen)
tablen = ctypes.c_int(tablen)
collen = ctypes.c_int(collen)
n = ctypes.c_int()
xbegs = stypes.emptyIntVector(_SPICE_EK_MAXQSEL)
xends... | [
"\n Parse the SELECT clause of an EK query, returning full particulars\n concerning each selected item.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekpsel_c.html\n note: oddly docs at url are incomplete/incorrect.\n\n :param query: EK query.\n :type query: str\n :param msglen: A... |
Please provide a description of the function:def ekrcec(handle, segno, recno, column, lenout, nelts=_SPICE_EK_EKRCEX_ROOM_DEFAULT):
handle = ctypes.c_int(handle)
segno = ctypes.c_int(segno)
recno = ctypes.c_int(recno)
column = stypes.stringToCharP(column)
lenout = ctypes.c_int(lenout)
nvals... | [
"\n Read data from a character column in a specified EK record.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekrcec_c.html\n\n :param handle: Handle attached to EK file.\n :type handle: int\n :param segno: Index of segment containing record.\n :type segno: int\n :param recno: Rec... |
Please provide a description of the function:def ekrced(handle, segno, recno, column, nelts=_SPICE_EK_EKRCEX_ROOM_DEFAULT):
handle = ctypes.c_int(handle)
segno = ctypes.c_int(segno)
recno = ctypes.c_int(recno)
column = stypes.stringToCharP(column)
nvals = ctypes.c_int(0)
dvals = stypes.empt... | [
"\n Read data from a double precision column in a specified EK record.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekrced_c.html\n\n :param handle: Handle attached to EK file.\n :type handle: int\n :param segno: Index of segment containing record.\n :type segno: int\n :param rec... |
Please provide a description of the function:def ekrcei(handle, segno, recno, column, nelts=_SPICE_EK_EKRCEX_ROOM_DEFAULT):
handle = ctypes.c_int(handle)
segno = ctypes.c_int(segno)
recno = ctypes.c_int(recno)
column = stypes.stringToCharP(column)
nvals = ctypes.c_int()
ivals = stypes.empty... | [
"\n Read data from an integer column in a specified EK record.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekrcei_c.html\n\n :param handle: Handle attached to EK file.\n :type handle: int\n :param segno: Index of segment containing record.\n :type segno: int\n :param recno: Reco... |
Please provide a description of the function:def ekssum(handle, segno):
handle = ctypes.c_int(handle)
segno = ctypes.c_int(segno)
segsum = stypes.SpiceEKSegSum()
libspice.ekssum_c(handle, segno, ctypes.byref(segsum))
return segsum | [
"\n Return summary information for a specified segment in a specified EK.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekssum_c.html\n\n :param handle: Handle of EK.\n :type handle: int\n :param segno: Number of segment to be summarized.\n :type segno: int\n :return: EK segment s... |
Please provide a description of the function:def ektnam(n, lenout=_default_len_out):
n = ctypes.c_int(n)
lenout = ctypes.c_int(lenout)
table = stypes.stringToCharP(lenout)
libspice.ektnam_c(n, lenout, table)
return stypes.toPythonString(table) | [
"\n Return the name of a specified, loaded table.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ektnam_c.html\n\n :param n: Index of table.\n :type n: int\n :param lenout: Maximum table name length.\n :type lenout: int\n :return: Name of table.\n :rtype: str\n "
] |
Please provide a description of the function:def ekucec(handle, segno, recno, column, nvals, cvals, isnull):
handle = ctypes.c_int(handle)
segno = ctypes.c_int(segno)
recno = ctypes.c_int(recno)
column = stypes.stringToCharP(column)
nvals = ctypes.c_int(nvals)
vallen = ctypes.c_int(len(max(... | [
"\n Update a character column entry in a specified EK record.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekucec_c.html\n\n :param handle: EK file handle.\n :type handle: int\n :param segno: Index of segment containing record.\n :type segno: int\n :param recno: Record to which d... |
Please provide a description of the function:def ekuced(handle, segno, recno, column, nvals, dvals, isnull):
handle = ctypes.c_int(handle)
segno = ctypes.c_int(segno)
recno = ctypes.c_int(recno)
column = stypes.stringToCharP(column)
nvals = ctypes.c_int(nvals)
dvals = stypes.toDoubleVector(... | [
"\n Update a double precision column entry in a specified EK record.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekuced_c.html\n\n :param handle: EK file handle.\n :type handle: int\n :param segno: Index of segment containing record.\n :type segno: int\n :param recno: Record to ... |
Please provide a description of the function:def ekucei(handle, segno, recno, column, nvals, ivals, isnull):
handle = ctypes.c_int(handle)
segno = ctypes.c_int(segno)
recno = ctypes.c_int(recno)
column = stypes.stringToCharP(column)
nvals = ctypes.c_int(nvals)
ivals = stypes.toIntVector(iva... | [
"\n Update an integer column entry in a specified EK record.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ekucei_c.html\n\n :param handle: EK file handle.\n :type handle: int\n :param segno: Index of segment containing record.\n :type segno: int\n :param recno: Record to which da... |
Please provide a description of the function:def el2cgv(ellipse):
assert (isinstance(ellipse, stypes.Ellipse))
center = stypes.emptyDoubleVector(3)
smajor = stypes.emptyDoubleVector(3)
sminor = stypes.emptyDoubleVector(3)
libspice.el2cgv_c(ctypes.byref(ellipse), center, smajor, sminor)
retu... | [
"\n Convert an ellipse to a center vector and two generating\n vectors. The selected generating vectors are semi-axes of the\n ellipse.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/el2cgv_c.html\n\n :param ellipse: An Ellipse\n :type ellipse: spiceypy.utils.support_types.Ellipse\n ... |
Please provide a description of the function:def elemc(item, inset):
assert isinstance(inset, stypes.SpiceCell)
item = stypes.stringToCharP(item)
return bool(libspice.elemc_c(item, ctypes.byref(inset))) | [
"\n Determine whether an item is an element of a character set.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/elemc_c.html\n\n :param item: Item to be tested.\n :type item: str\n :param inset: Set to be tested.\n :type inset: spiceypy.utils.support_types.SpiceCell\n :return: True ... |
Please provide a description of the function:def elemd(item, inset):
assert isinstance(inset, stypes.SpiceCell)
assert inset.dtype == 1
item = ctypes.c_double(item)
return bool(libspice.elemd_c(item, ctypes.byref(inset))) | [
"\n Determine whether an item is an element of a double precision set.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/elemd_c.html\n\n :param item: Item to be tested.\n :type item: float\n :param inset: Set to be tested.\n :type inset: spiceypy.utils.support_types.SpiceCell\n :retu... |
Please provide a description of the function:def elemi(item, inset):
assert isinstance(inset, stypes.SpiceCell)
assert inset.dtype == 2
item = ctypes.c_int(item)
return bool(libspice.elemi_c(item, ctypes.byref(inset))) | [
"\n Determine whether an item is an element of an integer set.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/elemi_c.html\n\n :param item: Item to be tested.\n :type item: int\n :param inset: Set to be tested.\n :type inset: spiceypy.utils.support_types.SpiceCell\n :return: True i... |
Please provide a description of the function:def eqncpv(et, epoch, eqel, rapol, decpol):
et = ctypes.c_double(et)
epoch = ctypes.c_double(epoch)
eqel = stypes.toDoubleVector(eqel)
rapol = ctypes.c_double(rapol)
decpol = ctypes.c_double(decpol)
state = stypes.emptyDoubleVector(6)
libspic... | [
"\n Compute the state (position and velocity of an object whose\n trajectory is described via equinoctial elements relative to some\n fixed plane (usually the equatorial plane of some planet).\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/eqncpv_c.html\n\n :param et: Epoch in seconds pa... |
Please provide a description of the function:def eqstr(a, b):
return bool(libspice.eqstr_c(stypes.stringToCharP(a), stypes.stringToCharP(b))) | [
"\n Determine whether two strings are equivalent.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/eqstr_c.html\n\n :param a: Arbitrary character string.\n :type a: str\n :param b: Arbitrary character string.\n :type b: str\n :return: True if A and B are equivalent.\n :rtype: bool... |
Please provide a description of the function:def erract(op, lenout, action=None):
if action is None:
action = ""
lenout = ctypes.c_int(lenout)
op = stypes.stringToCharP(op)
action = ctypes.create_string_buffer(str.encode(action), lenout.value)
actionptr = ctypes.c_char_p(ctypes.addresso... | [
"\n Retrieve or set the default error action.\n spiceypy sets the default error action to \"report\" on init.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/erract_c.html\n\n :param op: peration, \"GET\" or \"SET\".\n :type op: str\n :param lenout: Length of list for output.\n :typ... |
Please provide a description of the function:def errch(marker, string):
marker = stypes.stringToCharP(marker)
string = stypes.stringToCharP(string)
libspice.errch_c(marker, string) | [
"\n Substitute a character string for the first occurrence of\n a marker in the current long error message.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/errch_c.html\n\n :param marker: A substring of the error message to be replaced.\n :type marker: str\n :param string: The characte... |
Please provide a description of the function:def errdev(op, lenout, device):
lenout = ctypes.c_int(lenout)
op = stypes.stringToCharP(op)
device = ctypes.create_string_buffer(str.encode(device), lenout.value)
deviceptr = ctypes.c_char_p(ctypes.addressof(device))
libspice.errdev_c(op, lenout, dev... | [
"\n Retrieve or set the name of the current output device for error messages.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/errdev_c.html\n\n :param op: The operation, \"GET\" or \"SET\".\n :type op: str\n :param lenout: Length of device for output.\n :type lenout: int\n :param de... |
Please provide a description of the function:def errdp(marker, number):
marker = stypes.stringToCharP(marker)
number = ctypes.c_double(number)
libspice.errdp_c(marker, number) | [
"\n Substitute a double precision number for the first occurrence of\n a marker found in the current long error message.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/errdp_c.html\n\n :param marker: A substring of the error message to be replaced.\n :type marker: str\n :param number:... |
Please provide a description of the function:def errint(marker, number):
marker = stypes.stringToCharP(marker)
number = ctypes.c_int(number)
libspice.errint_c(marker, number) | [
"\n Substitute an integer for the first occurrence of a marker found\n in the current long error message.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/errint_c.html\n\n :param marker: A substring of the error message to be replaced.\n :type marker: str\n :param number: The integer t... |
Please provide a description of the function:def errprt(op, lenout, inlist):
lenout = ctypes.c_int(lenout)
op = stypes.stringToCharP(op)
inlist = ctypes.create_string_buffer(str.encode(inlist), lenout.value)
inlistptr = ctypes.c_char_p(ctypes.addressof(inlist))
libspice.errdev_c(op, lenout, inl... | [
"\n Retrieve or set the list of error message items to be output when an\n error is detected.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/errprt_c.html\n\n :param op: The operation, \"GET\" or \"SET\".\n :type op: str\n :param lenout: Length of list for output.\n :type lenout: i... |
Please provide a description of the function:def esrchc(value, array):
value = stypes.stringToCharP(value)
ndim = ctypes.c_int(len(array))
lenvals = ctypes.c_int(len(max(array, key=len)) + 1)
array = stypes.listToCharArray(array, xLen=lenvals, yLen=ndim)
return libspice.esrchc_c(value, ndim, le... | [
"\n Search for a given value within a character string array.\n Return the index of the first equivalent array entry, or -1\n if no equivalent element is found.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/esrchc_c.html\n\n :param value: Key value to be found in array.\n :type value... |
Please provide a description of the function:def et2lst(et, body, lon, typein, timlen=_default_len_out, ampmlen=_default_len_out):
et = ctypes.c_double(et)
body = ctypes.c_int(body)
lon = ctypes.c_double(lon)
typein = stypes.stringToCharP(typein)
timlen = ctypes.c_int(timlen)
ampmlen = ctyp... | [
"\n Given an ephemeris epoch, compute the local solar time for\n an object on the surface of a body at a specified longitude.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/et2lst_c.html\n\n :param et: Epoch in seconds past J2000 epoch.\n :type et: float\n :param body: ID-code of the ... |
Please provide a description of the function:def et2utc(et, formatStr, prec, lenout=_default_len_out):
et = ctypes.c_double(et)
prec = ctypes.c_int(prec)
lenout = ctypes.c_int(lenout)
formatStr = stypes.stringToCharP(formatStr)
utcstr = stypes.stringToCharP(lenout)
libspice.et2utc_c(et, for... | [
"\n Convert an input time from ephemeris seconds past J2000\n to Calendar, Day-of-Year, or Julian Date format, UTC.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/et2utc_c.html\n\n :param et: Input epoch, given in ephemeris seconds past J2000.\n :type et: float\n :param formatStr: For... |
Please provide a description of the function:def etcal(et, lenout=_default_len_out):
lenout = ctypes.c_int(lenout)
string = stypes.stringToCharP(lenout)
if hasattr(et, "__iter__"):
strings = []
for t in et:
libspice.etcal_c(t, lenout, string)
checkForSpiceError(N... | [
"\n Convert from an ephemeris epoch measured in seconds past\n the epoch of J2000 to a calendar string format using a\n formal calendar free of leapseconds.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/etcal_c.html\n\n :param et: Ephemeris time measured in seconds past J2000.\n :typ... |
Please provide a description of the function:def eul2m(angle3, angle2, angle1, axis3, axis2, axis1):
angle3 = ctypes.c_double(angle3)
angle2 = ctypes.c_double(angle2)
angle1 = ctypes.c_double(angle1)
axis3 = ctypes.c_int(axis3)
axis2 = ctypes.c_int(axis2)
axis1 = ctypes.c_int(axis1)
r =... | [
"\n Construct a rotation matrix from a set of Euler angles.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/eul2m_c.html\n\n :param angle3: Rotation angle about third rotation axis (radians).\n :type angle3: float\n :param angle2: Rotation angle about second rotation axis (radians).\n ... |
Please provide a description of the function:def eul2xf(eulang, axisa, axisb, axisc):
assert len(eulang) is 6
eulang = stypes.toDoubleVector(eulang)
axisa = ctypes.c_int(axisa)
axisb = ctypes.c_int(axisb)
axisc = ctypes.c_int(axisc)
xform = stypes.emptyDoubleMatrix(x=6, y=6)
libspice.eu... | [
"\n This routine computes a state transformation from an Euler angle\n factorization of a rotation and the derivatives of those Euler\n angles.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/eul2xf_c.html\n\n :param eulang: An array of Euler angles and their derivatives.\n :type eulan... |
Please provide a description of the function:def exists(fname):
fname = stypes.stringToCharP(fname)
return bool(libspice.exists_c(fname)) | [
"\n Determine whether a file exists.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/exists_c.html\n\n :param fname: Name of the file in question.\n :return: True if the file exists, False otherwise.\n :rtype: bool\n "
] |
Please provide a description of the function:def expool(name):
name = stypes.stringToCharP(name)
found = ctypes.c_int()
libspice.expool_c(name, ctypes.byref(found))
return bool(found.value) | [
"\n Confirm the existence of a kernel variable in the kernel pool.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/expool_c.html\n\n :param name: Name of the variable whose value is to be returned.\n :type name: str\n :return: True when the variable is in the pool.\n :rtype: bool\n ... |
Please provide a description of the function:def fn2lun(fname):
fnameP = stypes.stringToCharP(fname)
unit_out = ctypes.c_int()
fname_len = ctypes.c_int(len(fname)+1)
libspice.fn2lun_(fnameP,ctypes.byref(unit_out),fname_len)
return unit_out.value | [
"\n Internal undocumented command for mapping name of open file to\n its FORTRAN (F2C) logical unit.\n\n https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/FORTRAN/spicelib/fn2lun.html\n\n :param fname: name of the file to be mapped to its logical unit.\n :type fname: str\n :return: the FORTRAN (F2C)... |
Please provide a description of the function:def fovray(inst, raydir, rframe, abcorr, observer, et):
inst = stypes.stringToCharP(inst)
raydir = stypes.toDoubleVector(raydir)
rframe = stypes.stringToCharP(rframe)
abcorr = stypes.stringToCharP(abcorr)
observer = stypes.stringToCharP(observer)
... | [
"\n Determine if a specified ray is within the field-of-view (FOV) of a\n specified instrument at a given time.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/fovray_c.html\n\n :param inst: Name or ID code string of the instrument.\n :type inst: str\n :param raydir: Ray's direction ve... |
Please provide a description of the function:def fovtrg(inst, target, tshape, tframe, abcorr, observer, et):
inst = stypes.stringToCharP(inst)
target = stypes.stringToCharP(target)
tshape = stypes.stringToCharP(tshape)
tframe = stypes.stringToCharP(tframe)
abcorr = stypes.stringToCharP(abcorr)
... | [
"\n Determine if a specified ephemeris object is within the field-of-view (FOV)\n of a specified instrument at a given time.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/fovtrg_c.html\n\n :param inst: Name or ID code string of the instrument.\n :type inst: str\n :param target: Name ... |
Please provide a description of the function:def frame(x):
x = stypes.toDoubleVector(x)
y = stypes.emptyDoubleVector(3)
z = stypes.emptyDoubleVector(3)
libspice.frame_c(x, y, z)
return stypes.cVectorToPython(x), stypes.cVectorToPython(y), stypes.cVectorToPython(
z) | [
"\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/frame_c.html\n\n :param x: Input vector. A parallel unit vector on output.\n :type x: 3-Element Array of floats\n :return: a tuple of 3 list[3]\n :rtype: tuple\n "
] |
Please provide a description of the function:def frinfo(frcode):
frcode = ctypes.c_int(frcode)
cent = ctypes.c_int()
frclss = ctypes.c_int()
clssid = ctypes.c_int()
found = ctypes.c_int()
libspice.frinfo_c(frcode, ctypes.byref(cent), ctypes.byref(frclss),
ctypes.byref(... | [
"\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/frinfo_c.html\n\n :param frcode: the idcode for some frame.\n :type frcode: int\n :return: a tuple of attributes associated with the frame.\n :rtype: tuple\n "
] |
Please provide a description of the function:def frmnam(frcode, lenout=_default_len_out):
frcode = ctypes.c_int(frcode)
lenout = ctypes.c_int(lenout)
frname = stypes.stringToCharP(lenout)
libspice.frmnam_c(frcode, lenout, frname)
return stypes.toPythonString(frname) | [
"\n Retrieve the name of a reference frame associated with a SPICE ID code.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/frmnam_c.html\n\n :param frcode: an integer code for a reference frame\n :type frcode: int\n :param lenout: Maximum length of output string.\n :type lenout: int\n... |
Please provide a description of the function:def furnsh(path):
if isinstance(path, list):
for p in path:
libspice.furnsh_c(stypes.stringToCharP(p))
else:
path = stypes.stringToCharP(path)
libspice.furnsh_c(path) | [
"\n Load one or more SPICE kernels into a program.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/furnsh_c.html\n\n :param path: one or more paths to kernels\n :type path: str or list of str\n "
] |
Please provide a description of the function:def gcpool(name, start, room, lenout=_default_len_out):
name = stypes.stringToCharP(name)
start = ctypes.c_int(start)
room = ctypes.c_int(room)
lenout = ctypes.c_int(lenout)
n = ctypes.c_int()
cvals = stypes.emptyCharArray(lenout, room)
found... | [
"\n Return the character value of a kernel variable from the kernel pool.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gcpool_c.html\n\n :param name: Name of the variable whose value is to be returned.\n :type name: str\n :param start: Which component to start retrieving for name.\n ... |
Please provide a description of the function:def gdpool(name, start, room):
name = stypes.stringToCharP(name)
start = ctypes.c_int(start)
values = stypes.emptyDoubleVector(room)
room = ctypes.c_int(room)
n = ctypes.c_int()
found = ctypes.c_int()
libspice.gdpool_c(name, start, room, ctyp... | [
"\n Return the d.p. value of a kernel variable from the kernel pool.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gdpool_c.html\n\n :param name: Name of the variable whose value is to be returned.\n :type name: str\n :param start: Which component to start retrieving for name.\n :typ... |
Please provide a description of the function:def georec(lon, lat, alt, re, f):
lon = ctypes.c_double(lon)
lat = ctypes.c_double(lat)
alt = ctypes.c_double(alt)
re = ctypes.c_double(re)
f = ctypes.c_double(f)
rectan = stypes.emptyDoubleVector(3)
libspice.georec_c(lon, lat, alt, re, f, re... | [
"\n Convert geodetic coordinates to rectangular coordinates.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/georec_c.html\n\n :param lon: Geodetic longitude of point (radians).\n :type lon: float\n :param lat: Geodetic latitude of point (radians).\n :type lat: float\n :param alt: ... |
Please provide a description of the function:def getelm(frstyr, lineln, lines):
frstyr = ctypes.c_int(frstyr)
lineln = ctypes.c_int(lineln)
lines = stypes.listToCharArrayPtr(lines, xLen=lineln, yLen=2)
epoch = ctypes.c_double()
elems = stypes.emptyDoubleVector(10) # guess for length
libspi... | [
"\n Given a the \"lines\" of a two-line element set, parse the\n lines and return the elements in units suitable for use\n in SPICE software.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/getelm_c.html\n\n :param frstyr: Year of earliest representable two-line elements.\n :type frsty... |
Please provide a description of the function:def getfat(file):
file = stypes.stringToCharP(file)
arclen = ctypes.c_int(4)
typlen = ctypes.c_int(4)
arch = stypes.stringToCharP(arclen)
rettype = stypes.stringToCharP(typlen)
libspice.getfat_c(file, arclen, typlen, arch, rettype)
return sty... | [
"\n Determine the file architecture and file type of most SPICE kernel files.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/getfat_c.html\n\n :param file: The name of a file to be examined.\n :type file: str\n :return: The architecture of the kernel file, The type of the kernel file.\n ... |
Please provide a description of the function:def getfov(instid, room, shapelen=_default_len_out, framelen=_default_len_out):
instid = ctypes.c_int(instid)
shape = stypes.stringToCharP(" " * shapelen)
framen = stypes.stringToCharP(" " * framelen)
shapelen = ctypes.c_int(shapelen)
framelen = ctyp... | [
"\n This routine returns the field-of-view (FOV) parameters for a\n specified instrument.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/getfov_c.html\n\n :param instid: NAIF ID of an instrument.\n :type instid: int\n :param room: Maximum number of vectors that can be returned.\n :... |
Please provide a description of the function:def getmsg(option, lenout=_default_len_out):
option = stypes.stringToCharP(option)
lenout = ctypes.c_int(lenout)
msg = stypes.stringToCharP(lenout)
libspice.getmsg_c(option, lenout, msg)
return stypes.toPythonString(msg) | [
"\n Retrieve the current short error message,\n the explanation of the short error message, or the\n long error message.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/getmsg_c.html\n\n :param option: Indicates type of error message.\n :type option: str\n :param lenout: Available s... |
Please provide a description of the function:def gfdist(target, abcorr, obsrvr, relate, refval, adjust, step, nintvls,
cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
result = stypes.SPICEDOUBLE_CELL(2000)
else:
... | [
"\n Return the time window over which a specified constraint on\n observer-target distance is met.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfdist_c.html\n\n :param target: Name of the target body.\n :type target: str\n :param abcorr: Aberration correction flag.\n :type abcor... |
Please provide a description of the function:def gfevnt(udstep, udrefn, gquant, qnpars, lenvals, qpnams,
qcpars, qdpars, qipars, qlpars, op, refval,
tol, adjust, rpt, udrepi, udrepu, udrepf,
nintvls, bail, udbail, cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell... | [
"\n Determine time intervals when a specified geometric quantity\n satisfies a specified mathematical condition.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfevnt_c.html\n\n :param udstep: Name of the routine that computes and returns a\n :type udstep: spiceypy.utils.callbacks.UDSTEP... |
Please provide a description of the function:def gffove(inst, tshape, raydir, target, tframe, abcorr, obsrvr,
tol, udstep, udrefn, rpt, udrepi, udrepu, udrepf, bail, udbail, cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
... | [
"\n Determine time intervals when a specified target body or ray\n intersects the space bounded by the field-of-view (FOV) of a\n specified instrument. Report progress and handle interrupts if so\n commanded.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gffove_c.html\n\n :param inst... |
Please provide a description of the function:def gfilum(method, angtyp, target, illumn,
fixref, abcorr, obsrvr, spoint,
relate, refval, adjust, step, nintvls, cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
res... | [
"\n Return the time window over which a specified constraint on\n the observed phase, solar incidence, or emission angle at\n a specifed target body surface point is met.\n\n :param method: Shape model used to represent the surface of the target body.\n :type method: str\n :param angtyp: The type ... |
Please provide a description of the function:def gfocce(occtyp, front, fshape, fframe, back,
bshape, bframe, abcorr, obsrvr, tol,
udstep, udrefn, rpt, udrepi, udrepu,
udrepf, bail, udbail, cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_do... | [
"\n Determine time intervals when an observer sees one target\n occulted by another. Report progress and handle interrupts\n if so commanded.\n\n The surfaces of the target bodies may be represented by triaxial\n ellipsoids or by topographic data provided by DSK files.\n\n http://naif.jpl.nasa.gov... |
Please provide a description of the function:def gfoclt(occtyp, front, fshape, fframe, back, bshape, bframe, abcorr, obsrvr,
step, cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
result = stypes.SPICEDOUBLE_CELL(2000)
... | [
"\n Determine time intervals when an observer sees one target\n occulted by, or in transit across, another.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfoclt_c.html\n\n :param occtyp: Type of occultation.\n :type occtyp: str\n :param front: Name of body occulting the other.\n :... |
Please provide a description of the function:def gfpa(target, illmin, abcorr, obsrvr, relate, refval, adjust, step, nintvals,
cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
result = stypes.SPICEDOUBLE_CELL(2000)
else:
... | [
"\n Determine time intervals for which a specified constraint\n on the phase angle between an illumination source, a target,\n and observer body centers is met.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfpa_c.html\n\n :param target: Name of the target body.\n :type target: str\n... |
Please provide a description of the function:def gfposc(target, inframe, abcorr, obsrvr, crdsys, coord, relate, refval,
adjust, step, nintvals, cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
result = stypes.SPICEDOUBLE_C... | [
"\n Determine time intervals for which a coordinate of an\n observer-target position vector satisfies a numerical constraint.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfposc_c.html\n\n :param target: Name of the target body.\n :type target: str\n :param inframe: Name of the refe... |
Please provide a description of the function:def gfrefn(t1, t2, s1, s2):
t1 = ctypes.c_double(t1)
t2 = ctypes.c_double(t2)
s1 = ctypes.c_int(s1)
s2 = ctypes.c_int(s2)
t = ctypes.c_double()
libspice.gfrefn_c(t1, t2, s1, s2, ctypes.byref(t))
return t.value | [
"\n For those times when we can't do better, we use a bisection\n method to find the next time at which to test for state change.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfrefn_c.html\n\n :param t1: One of two values bracketing a state change.\n :type t1: float\n :param t2: The... |
Please provide a description of the function:def gfrepi(window, begmss, endmss):
begmss = stypes.stringToCharP(begmss)
endmss = stypes.stringToCharP(endmss)
# don't do anything if we were given a pointer to a SpiceCell, like if we were in a callback
if not isinstance(window, ctypes.POINTER(stypes.S... | [
"\n This entry point initializes a search progress report.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfrepi_c.html\n\n :param window: A window over which a job is to be performed.\n :type window: spiceypy.utils.support_types.SpiceCell\n :param begmss: Beginning of the text portion o... |
Please provide a description of the function:def gfrepu(ivbeg, ivend, time):
ivbeg = ctypes.c_double(ivbeg)
ivend = ctypes.c_double(ivend)
time = ctypes.c_double(time)
libspice.gfrepu_c(ivbeg, ivend, time) | [
"\n This function tells the progress reporting system\n how far a search has progressed.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfrepu_c.html\n\n :param ivbeg: Start time of work interval.\n :type ivbeg: float\n :param ivend: End time of work interval.\n :type ivend: float\... |
Please provide a description of the function:def gfrfov(inst, raydir, rframe, abcorr, obsrvr, step, cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
result = stypes.SPICEDOUBLE_CELL(2000)
else:
assert isinstance(result, s... | [
"\n Determine time intervals when a specified ray intersects the\n space bounded by the field-of-view (FOV) of a specified\n instrument.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfrfov_c.html\n\n :param inst: Name of the instrument.\n :type inst: str\n :param raydir: Ray's di... |
Please provide a description of the function:def gfsep(targ1, shape1, inframe1, targ2, shape2, inframe2, abcorr, obsrvr,
relate, refval, adjust, step, nintvals, cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
result = styp... | [
"\n Determine time intervals when the angular separation between\n the position vectors of two target bodies relative to an observer\n satisfies a numerical relationship.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfsep_c.html\n\n :param targ1: Name of first body.\n :type targ1: s... |
Please provide a description of the function:def gfsntc(target, fixref, method, abcorr, obsrvr, dref, dvec, crdsys, coord,
relate, refval, adjust, step, nintvals,
cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
... | [
"\n Determine time intervals for which a coordinate of an\n surface intercept position vector satisfies a numerical constraint.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfsntc_c.html\n\n :param target: Name of the target body.\n :type target: str\n :param fixref: Body fixed fram... |
Please provide a description of the function:def gfstep(time):
time = ctypes.c_double(time)
step = ctypes.c_double()
libspice.gfstep_c(time, ctypes.byref(step))
return step.value | [
"\n Return the time step set by the most recent call to :func:`gfsstp`.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfstep_c.html\n\n :param time: Ignored ET value.\n :type time: float\n :return: Time step to take.\n :rtype: float\n "
] |
Please provide a description of the function:def gfsubc(target, fixref, method, abcorr, obsrvr, crdsys, coord, relate,
refval, adjust, step, nintvals, cnfine,
result):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
result = stypes.... | [
"\n Determine time intervals for which a coordinate of an\n subpoint position vector satisfies a numerical constraint.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfsubc_c.html\n\n :param target: Name of the target body.\n :type target: str\n :param fixref: Body fixed frame associa... |
Please provide a description of the function:def gftfov(inst, target, tshape, tframe, abcorr, obsrvr, step, cnfine, result=None):
assert isinstance(cnfine, stypes.SpiceCell)
assert cnfine.is_double()
if result is None:
result = stypes.SPICEDOUBLE_CELL(20000)
else:
assert isinstance(... | [
"\n Determine time intervals when a specified ephemeris object\n intersects the space bounded by the field-of-view (FOV) of a\n specified instrument.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gftfov_c.html\n\n :param inst: Name of the instrument.\n :type inst: str\n :param tar... |
Please provide a description of the function:def gfudb(udfuns, udfunb, step, cnfine, result):
step = ctypes.c_double(step)
libspice.gfudb_c(udfuns, udfunb, step, ctypes.byref(cnfine), ctypes.byref(result)) | [
"\n Perform a GF search on a user defined boolean quantity.\n\n https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfudb_c.html\n\n :param udfuns: Name of the routine that computes a scalar quantity of interest corresponding to an 'et'.\n :type udfuns: ctypes.CFunctionType\n :param udfunb: Name... |
Please provide a description of the function:def gfuds(udfuns, udqdec, relate, refval, adjust, step, nintvls, cnfine, result):
relate = stypes.stringToCharP(relate)
refval = ctypes.c_double(refval)
adjust = ctypes.c_double(adjust)
step = ctypes.c_double(step)
nintvls = ctypes.c_int(nintvl... | [
"\n Perform a GF search on a user defined scalar quantity.\n\n https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gfuds_c.html\n\n :param udfuns: Name of the routine that computes the scalar quantity of interest at some time.\n :type udfuns: ctypes.CFunctionType\n :param udqdec: Name of the rou... |
Please provide a description of the function:def gipool(name, start, room):
name = stypes.stringToCharP(name)
start = ctypes.c_int(start)
ivals = stypes.emptyIntVector(room)
room = ctypes.c_int(room)
n = ctypes.c_int()
found = ctypes.c_int()
libspice.gipool_c(name, start, room, ctypes.b... | [
"\n Return the integer value of a kernel variable from the kernel pool.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gipool_c.html\n\n :param name: Name of the variable whose value is to be returned.\n :type name: str\n :param start: Which component to start retrieving for name.\n :... |
Please provide a description of the function:def gnpool(name, start, room, lenout=_default_len_out):
name = stypes.stringToCharP(name)
start = ctypes.c_int(start)
kvars = stypes.emptyCharArray(yLen=room, xLen=lenout)
room = ctypes.c_int(room)
lenout = ctypes.c_int(lenout)
n = ctypes.c_int()... | [
"\n Return names of kernel variables matching a specified template.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/gnpool_c.html\n\n :param name: Template that names should match.\n :type name: str\n :param start: Index of first matching name to retrieve.\n :type start: int\n :para... |
Please provide a description of the function:def hrmint(xvals, yvals, x):
work = stypes.emptyDoubleVector(int(2*len(yvals)+1))
n = ctypes.c_int(len(xvals))
xvals = stypes.toDoubleVector(xvals)
yvals = stypes.toDoubleVector(yvals)
x = ctypes.c_double(x)
f = ctypes.c_double(0)
... | [
"\n Evaluate a Hermite interpolating polynomial at a specified\n abscissa value.\n \n https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/hrmint_c.html\n \n :param xvals: Abscissa values.\n :type xvals: Array of floats\n :param yvals: Ordinate and derivative values.\n :type yvals: Ar... |
Please provide a description of the function:def hx2dp(string):
string = stypes.stringToCharP(string)
lenout = ctypes.c_int(80)
errmsg = stypes.stringToCharP(lenout)
number = ctypes.c_double()
error = ctypes.c_int()
libspice.hx2dp_c(string, lenout, ctypes.byref(number), ctypes.byref(error),... | [
"\n Convert a string representing a double precision number in a\n base 16 scientific notation into its equivalent double\n precision number.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/hx2dp_c.html\n\n :param string: Hex form string to convert to double precision.\n :type string: ... |
Please provide a description of the function:def ident():
matrix = stypes.emptyDoubleMatrix()
libspice.ident_c(matrix)
return stypes.cMatrixToNumpy(matrix) | [
"\n This routine returns the 3x3 identity matrix.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ident_c.html\n\n :return: The 3x3 identity matrix.\n :rtype: 3x3-Element Array of floats\n "
] |
Please provide a description of the function:def illum(target, et, abcorr, obsrvr, spoint):
target = stypes.stringToCharP(target)
et = ctypes.c_double(et)
abcorr = stypes.stringToCharP(abcorr)
obsrvr = stypes.stringToCharP(obsrvr)
spoint = stypes.toDoubleVector(spoint)
phase = ctypes.c_doub... | [
"\n Deprecated: This routine has been superseded by the CSPICE\n routine ilumin. This routine is supported for purposes of\n backward compatibility only.\n\n Find the illumination angles at a specified surface point of a\n target body.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/il... |
Please provide a description of the function:def illumf(method, target, ilusrc, et, fixref, abcorr, obsrvr, spoint):
method = stypes.stringToCharP(method)
target = stypes.stringToCharP(target)
ilusrc = stypes.stringToCharP(ilusrc)
et = ctypes.c_double(et)
fixref = stypes.stringToCharP(fixre... | [
"\n Compute the illumination angles---phase, incidence, and\n emission---at a specified point on a target body. Return logical\n flags indicating whether the surface point is visible from\n the observer's position and whether the surface point is\n illuminated.\n\n The target body's surface is rep... |
Please provide a description of the function:def illumg(method, target, ilusrc, et, fixref, abcorr, obsrvr, spoint):
method = stypes.stringToCharP(method)
target = stypes.stringToCharP(target)
ilusrc = stypes.stringToCharP(ilusrc)
et = ctypes.c_double(et)
fixref = stypes.stringToCharP(fixre... | [
"\n Find the illumination angles (phase, incidence, and \n emission) at a specified surface point of a target body. \n \n The surface of the target body may be represented by a triaxial \n ellipsoid or by topographic data provided by DSK files. \n \n The illumination source is a specified ephemeris o... |
Please provide a description of the function:def ilumin(method, target, et, fixref, abcorr, obsrvr, spoint):
method = stypes.stringToCharP(method)
target = stypes.stringToCharP(target)
et = ctypes.c_double(et)
fixref = stypes.stringToCharP(fixref)
abcorr = stypes.stringToCharP(abcorr)
obsrv... | [
"\n Find the illumination angles (phase, solar incidence, and\n emission) at a specified surface point of a target body.\n\n This routine supersedes illum.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ilumin_c.html\n\n :param method: Computation method.\n :type method: str\n :par... |
Please provide a description of the function:def inedpl(a, b, c, plane):
assert (isinstance(plane, stypes.Plane))
ellipse = stypes.Ellipse()
a = ctypes.c_double(a)
b = ctypes.c_double(b)
c = ctypes.c_double(c)
found = ctypes.c_int()
libspice.inedpl_c(a, b, c, ctypes.byref(plane), ctypes... | [
"\n Find the intersection of a triaxial ellipsoid and a plane.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/inedpl_c.html\n\n :param a: Length of ellipsoid semi-axis lying on the x-axis.\n :type a: float\n :param b: Length of ellipsoid semi-axis lying on the y-axis.\n :type b: float... |
Please provide a description of the function:def inelpl(ellips, plane):
assert (isinstance(plane, stypes.Plane))
assert (isinstance(ellips, stypes.Ellipse))
nxpts = ctypes.c_int()
xpt1 = stypes.emptyDoubleVector(3)
xpt2 = stypes.emptyDoubleVector(3)
libspice.inelpl_c(ctypes.byref(ellips), c... | [
"\n Find the intersection of an ellipse and a plane.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/inelpl_c.html\n\n :param ellips: A SPICE ellipse.\n :type plane: spiceypy.utils.support_types.Ellipse\n :param plane: A SPICE plane.\n :type plane: spiceypy.utils.support_types.Plane\n ... |
Please provide a description of the function:def inrypl(vertex, direct, plane):
assert (isinstance(plane, stypes.Plane))
vertex = stypes.toDoubleVector(vertex)
direct = stypes.toDoubleVector(direct)
nxpts = ctypes.c_int()
xpt = stypes.emptyDoubleVector(3)
libspice.inrypl_c(vertex, direct, c... | [
"\n Find the intersection of a ray and a plane.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/inrypl_c.html\n\n :param vertex: Vertex vector of ray.\n :type vertex: 3-Element Array of floats\n :param direct: Direction vector of ray.\n :type direct: 3-Element Array of floats\n :par... |
Please provide a description of the function:def insrtc(item, inset):
assert isinstance(inset, stypes.SpiceCell)
if isinstance(item, list):
for c in item:
libspice.insrtc_c(stypes.stringToCharP(c), ctypes.byref(inset))
else:
item = stypes.stringToCharP(item)
libspice... | [
"\n Insert an item into a character set.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/insrtc_c.html\n\n :param item: Item to be inserted.\n :type item: str or list of str\n :param inset: Insertion set.\n :type inset: spiceypy.utils.support_types.SpiceCell\n "
] |
Please provide a description of the function:def insrtd(item, inset):
assert isinstance(inset, stypes.SpiceCell)
if hasattr(item, "__iter__"):
for d in item:
libspice.insrtd_c(ctypes.c_double(d), ctypes.byref(inset))
else:
item = ctypes.c_double(item)
libspice.insrtd... | [
"\n Insert an item into a double precision set.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/insrtd_c.html\n\n :param item: Item to be inserted.\n :type item: Union[float,Iterable[float]]\n :param inset: Insertion set.\n :type inset: spiceypy.utils.support_types.SpiceCell\n "
] |
Please provide a description of the function:def insrti(item, inset):
assert isinstance(inset, stypes.SpiceCell)
if hasattr(item, "__iter__"):
for i in item:
libspice.insrti_c(ctypes.c_int(i), ctypes.byref(inset))
else:
item = ctypes.c_int(item)
libspice.insrti_c(ite... | [
"\n Insert an item into an integer set.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/insrti_c.html\n\n :param item: Item to be inserted.\n :type item: Union[float,Iterable[int]]\n :param inset: Insertion set.\n :type inset: spiceypy.utils.support_types.SpiceCell\n "
] |
Please provide a description of the function:def inter(a, b):
assert isinstance(a, stypes.SpiceCell)
assert isinstance(b, stypes.SpiceCell)
assert a.dtype == b.dtype
# Next line was redundant with [raise NotImpImplementedError] below
# assert a.dtype == 0 or a.dtype == 1 or a.dtype == 2
if ... | [
"\n Intersect two sets of any data type to form a third set.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/inter_c.html\n\n :param a: First input set.\n :type a: spiceypy.utils.support_types.SpiceCell\n :param b: Second input set.\n :type b: spiceypy.utils.support_types.SpiceCell\n ... |
Please provide a description of the function:def invert(m):
m = stypes.toDoubleMatrix(m)
mout = stypes.emptyDoubleMatrix()
libspice.invert_c(m, mout)
return stypes.cMatrixToNumpy(mout) | [
"\n Generate the inverse of a 3x3 matrix.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/invert_c.html\n\n :param m: Matrix to be inverted.\n :type m: 3x3-Element Array of floats\n :return: Inverted matrix (m1)^-1\n :rtype: 3x3-Element Array of floats\n "
] |
Please provide a description of the function:def invort(m):
m = stypes.toDoubleMatrix(m)
mout = stypes.emptyDoubleMatrix()
libspice.invort_c(m, mout)
return stypes.cMatrixToNumpy(mout) | [
"\n Given a matrix, construct the matrix whose rows are the\n columns of the first divided by the length squared of the\n the corresponding columns of the input matrix.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/invort_c.html\n\n :param m: A 3x3 Matrix.\n :type m: 3x3-Element Arra... |
Please provide a description of the function:def isordv(array, n):
array = stypes.toIntVector(array)
n = ctypes.c_int(n)
return bool(libspice.isordv_c(array, n)) | [
"\n Determine whether an array of n items contains the integers\n 0 through n-1.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/isordv_c.html\n\n :param array: Array of integers.\n :type array: Array of ints\n :param n: Number of integers in array.\n :type n: int\n :return:\n ... |
Please provide a description of the function:def isrchc(value, ndim, lenvals, array):
value = stypes.stringToCharP(value)
array = stypes.listToCharArrayPtr(array, xLen=lenvals, yLen=ndim)
ndim = ctypes.c_int(ndim)
lenvals = ctypes.c_int(lenvals)
return libspice.isrchc_c(value, ndim, lenvals, ar... | [
"\n Search for a given value within a character string array. Return\n the index of the first matching array entry, or -1 if the key\n value was not found.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/isrchc_c.html\n\n :param value: Key value to be found in array.\n :type value: str... |
Please provide a description of the function:def isrchd(value, ndim, array):
value = ctypes.c_double(value)
ndim = ctypes.c_int(ndim)
array = stypes.toDoubleVector(array)
return libspice.isrchd_c(value, ndim, array) | [
"\n Search for a given value within a double precision array. Return\n the index of the first matching array entry, or -1 if the key value\n was not found.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/isrchd_c.html\n\n :param value: Key value to be found in array.\n :type value: flo... |
Please provide a description of the function:def isrchi(value, ndim, array):
value = ctypes.c_int(value)
ndim = ctypes.c_int(ndim)
array = stypes.toIntVector(array)
return libspice.isrchi_c(value, ndim, array) | [
"\n Search for a given value within an integer array. Return\n the index of the first matching array entry, or -1 if the key\n value was not found.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/isrchi_c.html\n\n :param value: Key value to be found in array.\n :type value: int\n :p... |
Please provide a description of the function:def isrot(m, ntol, dtol):
m = stypes.toDoubleMatrix(m)
ntol = ctypes.c_double(ntol)
dtol = ctypes.c_double(dtol)
return bool(libspice.isrot_c(m, ntol, dtol)) | [
"\n Indicate whether a 3x3 matrix is a rotation matrix.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/isrot_c.html\n\n :param m: A matrix to be tested.\n :type m: 3x3-Element Array of floats\n :param ntol: Tolerance for the norms of the columns of m.\n :type ntol: float\n :param d... |
Please provide a description of the function:def iswhsp(string):
string = stypes.stringToCharP(string)
return bool(libspice.iswhsp_c(string)) | [
"\n Return a boolean value indicating whether a string contains\n only white space characters.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/iswhsp_c.html\n\n :param string: String to be tested.\n :type string: str\n :return:\n the boolean value True if the string is empty... |
Please provide a description of the function:def kdata(which, kind, fillen=_default_len_out, typlen=_default_len_out, srclen=_default_len_out):
which = ctypes.c_int(which)
kind = stypes.stringToCharP(kind)
fillen = ctypes.c_int(fillen)
typlen = ctypes.c_int(typlen)
srclen = ctypes.c_int(srclen)... | [
"\n Return data for the nth kernel that is among a list of specified\n kernel types.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/kdata_c.html\n\n :param which: Index of kernel to fetch from the list of kernels.\n :type which: int\n :param kind: The kind of kernel to which fetches a... |
Please provide a description of the function:def kinfo(file, typlen=_default_len_out, srclen=_default_len_out):
typlen = ctypes.c_int(typlen)
srclen = ctypes.c_int(srclen)
file = stypes.stringToCharP(file)
filtyp = stypes.stringToCharP(" " * typlen.value)
source = stypes.stringToCharP(" " * src... | [
"\n Return information about a loaded kernel specified by name.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/kinfo_c.html\n\n :param file: Name of a kernel to fetch information for\n :type file: str\n :param typlen: Available space in output kernel type string.\n :type typlen: int\n... |
Please provide a description of the function:def kplfrm(frmcls, outCell=None):
if not outCell:
outCell = stypes.SPICEINT_CELL(1000)
frmcls = ctypes.c_int(frmcls)
libspice.kplfrm_c(frmcls, ctypes.byref(outCell))
return outCell | [
"\n Return a SPICE set containing the frame IDs of all reference\n frames of a given class having specifications in the kernel pool.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/kplfrm_c.html\n\n :param frmcls: Frame class.\n :type frmcls: int\n :param outCell: Optional output Spice... |
Please provide a description of the function:def ktotal(kind):
kind = stypes.stringToCharP(kind)
count = ctypes.c_int()
libspice.ktotal_c(kind, ctypes.byref(count))
return count.value | [
"\n Return the current number of kernels that have been loaded\n via the KEEPER interface that are of a specified type.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ktotal_c.html\n\n :param kind: A list of kinds of kernels to count.\n :type kind: str\n :return: The number of kernels... |
Please provide a description of the function:def kxtrct(keywd, terms, nterms, instring, termlen=_default_len_out, stringlen=_default_len_out, substrlen=_default_len_out):
assert nterms <= len(terms)
# Python strings and string arrays => to C char pointers
keywd = stypes.stringToCharP(keywd)
terms =... | [
"\n Locate a keyword in a string and extract the substring from\n the beginning of the first word following the keyword to the\n beginning of the first subsequent recognized terminator of a list.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/kxtrct_c.html\n\n :param keywd: Word that mar... |
Please provide a description of the function:def latcyl(radius, lon, lat):
radius = ctypes.c_double(radius)
lon = ctypes.c_double(lon)
lat = ctypes.c_double(lat)
r = ctypes.c_double()
lonc = ctypes.c_double()
z = ctypes.c_double()
libspice.latcyl_c(radius, lon, lat, ctypes.byref(r), cty... | [
"\n Convert from latitudinal coordinates to cylindrical coordinates.\n\n http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/latcyl_c.html\n\n :param radius: Distance of a point from the origin.\n :type radius:\n :param lon: Angle of the point from the XZ plane in radians.\n :param lat: Angle ... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.