JNISpice
version 2.0.0

Package spice.basic

Class Summary
AberrationCorrection Class AberrationCorrection represents selections of aberration corrections that can be applied to state vectors.
AngularUnits Class AngularUnits represents angular units and supports conversion between them.
AxisAndAngle Class AxisAndAngle provides containers for rotation axis and angle combinations.
Body Class Body is used to represent identities of ephemeris objects.
BodyCode Class BodyCode represents body-name mappings that are initialized by specification of a body ID code.
BodyName Class BodyName represents body-name mappings that are initialized by specification of a body name.
CK Class CK provides methods for writing, summarizing, and conducting low-level read operations on CK files.
Coordinates Class Coordinates is an abstract superclass of all JNISpice classes that represent coordinate systems.
CSPICE Class CSPICE provides a native API enabling higher-level JNISpice methods to call selected CSPICE and DSKLIB_C routines.
CylindricalCoordinates Class CylindricalCoordinates represents sets of coordinates expressed in the cylindrical system: positions are specified by radius, longitude and Z coordinate.
DAF Class DAF supports creation of and low-level read operations on DAF files.
DAS Class DAS supports creation of and low-level read operations on DAS files.
DistanceUnits Class DistanceUnits represents distance units and supports conversion between them.
DLA Class DLA supports forward and backward list traversal of DLA files.
DLADescriptor Class DLADescriptor represents DLA segment descriptors and declares DLA constants.
DSK Class DSK supports segment-level access to DSK files; this class also provides methods to obtain DSK coverage information and to access DSK subsystem tolerance parameters.
DSK02 Class DSK02 declares constants pertaining to type 2 DSK segments.
DSKDescriptor Class DSKDescriptor represents DSK segment descriptors and declares DSK constants.
Duration Class Duration is an abstract superclass of all JNISpice types that represent durations.
Ellipse Class Ellipse represents ellipses in 3-dimensional space and supports geometric operations using ellipses.
EllipsePlaneIntercept Class EllipsePlaneIntercept represents the result of an ellipse-plane intercept computation.
Ellipsoid Class Ellipsoid represents tri-axial ellipsoids in three-dimensional, Euclidean space.
EllipsoidLineNearPoint Class EllipsoidLineNearPoint represents the result of an Ellipsoid-Line near point computation.
EllipsoidPlaneIntercept Class EllipsoidPlaneIntercept represents the result of a ellipsoid-plane intercept computation.
EllipsoidPointNearPoint Class EllipsoidPointNearPoint represents the result of an Ellipsoid-Point near point computation.
EulerAngles Class EulerAngles represents Euler angle sequences.
EulerState Class EulerState represents sequences of Euler angles and their corresponding rates of change.
FOV Class FOV represents instrument fields of view.
FrameInfo Class FrameInfo packages specification parameters common to all SPICE reference frames.
GeodeticCoordinates Class GeodeticCoordinates represents sets of coordinates expressed in the "geodetic" system: positions are specified by longitude, latitude, and altitude.
GF Class GF is the root class of the JNISpice Geometry Finder subsystem.
GFAngularSeparationSearch Class GFAngularSeparationSearch supports searches for angular separation events.
GFBinaryStateSearch Class GFBinaryStateSearch is the abstract superclass for GF binary state searches.
GFConstraint Class GFConstraint represents relational constraints applicable to GF numeric quantity searches.
GFDistanceSearch Class GFDistanceSearch supports searches for distance events.
GFIlluminationAngleSearch Class GFIlluminationAngleSearch supports searches for illumination angle events.
GFNumericSearch Class GFSearch is the abstract superclass for GF numeric quantity searches.
GFOccultationSearch Class GFOccultationSearch supports searches for occultation events.
GFPhaseAngleSearch Class GFPhaseSearch specifies a search for phase angle events.
GFPositionCoordinateSearch Class GFPositionCoordinateSearch supports searches for position coordinate events.
GFRangeRateSearch Class GFRangeRateSearch specifies a search for range rate events.
GFRayInFOVSearch Class GFRayInFOVSearch conducts searches for time intervals over which a specified target body appears in a specified instrument field of view (FOV).
GFScalarQuantity Abstract class GFScalarQuantity provides a template for user-defined classes representing scalar functions of time to be used in GF searches.
GFSearchUtils Class GFDefaultSearchUtils is the default GF search utility class that provides user-defined GF search step, convergence tolerance, refinement, progress reporting, and interrupt handling functions.
GFSubObserverCoordinateSearch Class GFSubObserverCoordinateSearch supports searches for sub-observer point coordinate events.
GFSurfaceInterceptCoordinateSearch Class GFSurfaceInterceptCoordinateSearch supports searches for sub-observer point coordinate events.
GFTargetInFOVSearch Class GFTargetInFOVSearch conducts searches for time intervals over which a specified target body appears in a specified instrument field of view (FOV).
GFUserDefinedScalarSearch Class GFUserDefinedScalarSearch supports searches for events involving user-defined scalar functions of time.
IDMap Class IDMap is an abstract superclass for JNISpice classes implementing mappings between names and ID codes.
IlluminationAngles Class IlluminationAngles supports illumination angle computations.
Instrument Class Instrument is used to represent identities of spacecraft structures or instruments.
InstrumentCode Class InstrumentCode represents instrument-name mappings that are initialized by specification of a instrument ID code.
InstrumentName Class InstrumentName represents instrument-name mappings that are initialized by specification of a instrument name.
IOUtils Class IOUtils provides miscellaneous static methods that simplify common console I/O tasks.
JEDDuration Class JEDDuration measures time intervals in units of Julian ephemeris days; the time system used for this measurement is TDB.
JEDTime Class JEDime represents times as Julian ephemeris dates.
KernelDatabase Class KernelDatabase supports loading and unloading of SPICE kernels.
KernelPool Class KernelPool supports access to the kernel pool data structure.
KernelVarDescriptor Class KernelVarDescriptor packages attributes of kernel variables.
KernelVarStringComponent Class KernelVarStringComponent represents components of continued string values associated with kernel variables.
LatitudinalCoordinates Class LatitudinalCoordinates represents sets of coordinates expressed in the "latitudinal" system: positions are specified by radius, longitude and latitude.
LimbPoint Class LimbPoint supports limb point computations.
Line Class Line represents lines in three-dimensional Euclidean space.
LocalSolarTime Class LocalSolarTime supports local solar time computations.
Matrix33 Class Matrix33 represents 3 by 3 double precision matrices.
Matrix66 Class Matrix66 represents 6 by 6 double precision matrices.
OccultationState Class OccultationState provides methods to classify the occultation of one target object by another, as seen from a specified viewing location.
OsculatingElements Class OsculatingElements provides methods for conversion between state vectors and osculating elements.
OsculatingElementsExtended Class OsculatingElementsExtended provides methods for conversion between state vectors and osculating elements.
PCK Class PCK provides methods for writing, summarizing, and conducting low-level read operations on PCK files.
PhysicalConstants Class PhysicalConstants provides values of fixed, scalar physical quantities.
Plane Class plane represents planes in 3-dimensional space and supports geometric operations using planes.
PlanetographicCoordinates Class PlanetographicCoordinates represents sets of coordinates expressed in the planetographic system: positions are specified by longitude, latitude, and altitude.
PointingAndAVRecord Class PointingAndAVRecord encapsulates outputs from C-kernel pointing and angular velocity lookups.
PointingRecord Class PointingRecord encapsulates outputs from C-kernel lookups.
PositionRecord Class PositionRecord represents the positions of ephemeris objects relative to other objects; position records carry along with them one-way light time.
PositionVector Class PositionVector represents positions of ephemeris objects relative to other objects.
Quaternion Class Quaternion is an abstract superclass for the quaternion classes supported by JNISpice.
RADecCoordinates Class RADecCoordinates represents sets of coordinates expressed in the right ascension/declination system: positions are specified by radius, right ascension, and declination.
Ray Class Ray represents rays in three-dimensional Euclidean space.
RayEllipsoidIntercept Class RayEllipsoidIntercept represents the result of a Ray-Ellipsoid intercept computation.
RayPlaneIntercept Class RayPlaneIntercept represents the result of a ray-plane intercept computation.
ReferenceFrame Class ReferenceFrame represents the identities of reference frames and supports transformations between them.
RotationAndAV Class RotationAndAV packages combinations of rotation matrices and angular velocity vectors that correspond to state transformation matrices.
SCLK Class SCLK represents identities of spacecraft clocks.
SCLKDuration Class SCLKDuration measures time intervals in units of SCLK ticks, where the ticks are associated with a specified clock.
SCLKTime Class SCLKTime represents times measured by spacecraft clocks.
SphericalCoordinates Class SphericalCoordinates represents sets of coordinates expressed in the spherical system: positions are specified by radius, colatitude, and longitude.
SpiceQuaternion Class SpiceQuaternion represents and supports operations on SPICE-style quaternions.
SpiceWindow Class SpiceWindow represents unions of disjoint intervals on the real line.
SPK Class SPK provides methods for writing, summarizing, and conducting low-level read operations on SPK files.
StateRecord Class StateRecord represents the states (positions and velocities) of ephemeris objects relative to other objects; state records carry along with them one-way light time between target and observer.
StateVector Class StateVector represents states (positions and velocities) of ephemeris objects relative to other objects.
SubObserverRecord Class SubObserverRecord supports sub-observer point computations.
SubSolarRecord Class SubSolarRecord supports sub-solar point computations.
Surface Class Surface is used to represent identities of surfaces associated with ephemeris objects.
SurfaceCode Class SurfaceCode represents surface-name mappings that are initialized by specification of a surface ID code and a Body.
SurfaceIDMap Class Surface IDMap is an abstract superclass for JNISpice classes implementing mappings between surface names and ID codes, where the mappings are associated with specified Bodies.
SurfaceIntercept Class SurfaceIntercept supports ray-target surface intercept computations.
SurfaceInterceptWithDSKInfo Class SurfaceInterceptWithDSKInfo provides methods that compute ray-DSK surface intercepts and return information on the data source used to define the surface representation at the intercept points.
SurfaceName Class SurfaceName represents surface-name mappings that are initialized by specification of a surface name and a Body.
SurfacePoint Class SurfacePoint represents 3-dimensional points located on surfaces of specified bodies.
TDBDuration Class TDBDuration measures time intervals in units of TDB seconds.
TDBTime Class TDBTime implements time representations and provides time string parsing, conversion, and output formatting methods.
TDTDuration Class TDTDuration measures time intervals in units of TDT seconds.
TDTTime Class TDTTime implements the representation of time as seconds past J2000 TDT (Terrestrial Dynamical Time).
TerminatorPoint Class TerminatorPoint supports terminator point computations.
TextReader Class TextReader provides a simple interface for reading text files sequentially.
TextWriter Class TextWriter provides a very simple interface that supports writing lines of text to files.
Time Class Time is an abstract superclass that represents absolute times used by JNISpice.
TimeConstants Class TimeConstants provides commonly used dates and scale factors relating to time conversion.
TriangularPlate Class TriangularPlate represents triangular shapes used to tessellate surfaces of extended bodies.
TriangularPlateVertices Class TriangularPlateVertices represents triangular shapes in 3-dimensional space as sets of three 3-vectors.
Units Class Units represents physical units and supports conversions between them.
Vector3 Class Vector3 represents and provides methods implementing mathematical operations on three-dimensional vectors.
Vector6 Class Vector6 represents six-dimensional, double precision vectors.
VelocityVector Class VelocityVector represents velocities of ephemeris objects relative to other objects.
 

Enum Summary
DSKToleranceKey Enum DSKToleranceKey represents keywords associated with tolerances used by the DSK subsystem.
OccultationCode Enum OccultationCode declares parameters associated with occultation states computed by the class OccultationState.
TimeSystem Enum TimeSystem identifies the time systems known to JNISPICE.
 

Exception Summary
DAFRecordNotFoundException The DAFRecordNotFoundException class is used to signal a "not found" condition when an attempt is made to access a DAF record.
FrameNotFoundException The FrameNotFoundException class is used to signal a "not found" condition when an attempt is made to locate data for a reference frame.
IDCodeNotFoundException The IDCodeNotFoundException class is used to signal a "not found" condition when an attempt is made to translate a name to an ID code.
KernelVarNotFoundException The KernelVarNotFoundException class is used to signal a "not found" condition when an attempt is made to access a CSPICE kernel pool variable.
NameNotFoundException The NameNotFoundException class is used to signal a "not found" condition when an attempt is made to translate an ID code to a name.
PointingNotFoundException The PointingNotFoundException class is used to indicate that a C-kernel lookup failed to find requested pointing.
PointNotFoundException The PointNotFoundException class is used to signal a "not found" condition when an attempt is made to access a 3-vector that does not exist.
SpiceErrorException The SpiceErrorException class is used to signal errors encountered within the JNISpice system.
SpiceException The SpiceException class is used to signal errors or non-error exceptional cases encountered within the JNISpice system.
SpiceKernelNotLoadedException Class SpiceKernelNotLoadedException indicates that a specified file is not loaded in the JNISpice kernel databasee.
 


JNISpice
version 2.0.0

JNISpice Alpha Test Version 2.0.0 28-JAN-2017 (NJB)