USGS

Isis 3.0 Application Source Code Reference

Home

Kernels Class Reference

#include <Kernels.h>

List of all members.


Detailed Description

Determine SPICE kernels defined in an ISIS file.

This class determines all SPICE kernels associated to an ISIS cube file and optionally loads them using the NAIF toolkit. This creates the kernel pool as it was when spiceinit determined all the kernels and it initialized the file for geometric operations.

Note that ISIS caches of some of the voluminous NAIF kernels, extracting only what is required from the SPK and CK (generally) kernels for a given observation. After this occurs, these kernels are no longer loaded by the ISIS Spice class hierarchy. This class provides that environment so that further NAIF operations can occur, such as velocity vectors.

Author:
2007-08-19 Kris Becker

Definition at line 121 of file Kernels.h.

Public Types

typedef KernelSet::KernelFiles KernelFiles

Public Member Functions

 Kernels ()
 Default Constructor.
 Kernels (const std::string &filename)
 Construct using an ISIS file name.
 Kernels (Cube &cube)
 Construct using an ISIS Cube object.
 Kernels (Pvl &pvl)
 Construct from an ISIS label.
virtual ~Kernels ()
 Destructor always unloads the kernels from the pool.
int nKeys () const
 Returns the number of kernel keywords found.
int size () const
 Returns the number of kernels found and/or loaded.
void Load (Pvl &pvl)
 Perform the hunt for Spice kernels in an ISIS label.
KernelFiles getList (bool removePath=false) const
 Provide a list of all the kernels found.
void Unload ()
 Unloads all kernels if they were loaded when found.


Member Typedef Documentation

typedef KernelSet::KernelFiles KernelFiles

Definition at line 123 of file Kernels.h.


Constructor & Destructor Documentation

Kernels (  )  [inline]

Default Constructor.

Definition at line 125 of file Kernels.h.

Kernels ( const std::string &  filename  ) 

Construct using an ISIS file name.

Parameters:
filename Name of ISIS cube file

Definition at line 47 of file Kernels.cpp.

Kernels ( Cube cube  ) 

Construct using an ISIS Cube object.

Parameters:
cube Cube object of ISIS file

Definition at line 57 of file Kernels.cpp.

Kernels ( Pvl &  pvl  ) 

Construct from an ISIS label.

Parameters:
pvl ISIS label to get kernel information from

Definition at line 66 of file Kernels.cpp.

virtual ~Kernels (  )  [inline, virtual]

Destructor always unloads the kernels from the pool.

Definition at line 130 of file Kernels.h.


Member Function Documentation

int nKeys (  )  const [inline]

Returns the number of kernel keywords found.

Returns:
int Number keywords

Definition at line 136 of file Kernels.h.

int size (  )  const [inline]

Returns the number of kernels found and/or loaded.

Definition at line 139 of file Kernels.h.

void Load ( Pvl &  pvl  ) 

Perform the hunt for Spice kernels in an ISIS label.

This method must traverse the ISIS label hierarchy to find all the pertinent kernel files. Many of them are found in the Kernel Group, but others exist in Table objects that are SPICE blobs. The actual names are found in the Kernels keyword in the named Table object.

Parameters:
pvl ISIS label

Definition at line 81 of file Kernels.cpp.

Kernels::KernelFiles getList ( bool  removePath = false  )  const

Provide a list of all the kernels found.

This method will return all the kernel file references as found in the ISIS label. It will optionally remove the file paths and return only the kernel file name if requested. If removePath is false, it returns the complete path to the SPICE kernels.

Parameters:
removePath Do we remove the file paths and return only the file names?
Returns:
std::vector<std::string> A vector of filenames of SPICE kernels

Definition at line 119 of file Kernels.cpp.

void Unload (  ) 

Unloads all kernels if they were loaded when found.

Definition at line 139 of file Kernels.cpp.


The documentation for this class was generated from the following files: