USGS

Isis 3.0 Object Programmers' Reference

Home

Isis::Target Class Reference

This class is used to create and store valid Isis3 targets. More...

#include <Target.h>

Collaboration diagram for Isis::Target:
Collaboration graph

Public Member Functions

 Target (Spice *spice, Pvl &label)
 Constructs a Target object and loads target information.
 
 Target ()
 Constructs an empty Target object.
 
 ~Target ()
 Destroys the Target.
 
void init ()
 Initialize member variables.
 
bool isSky () const
 Return if our target is the sky.
 
SpiceInt naifBodyCode () const
 This returns the NAIF body code of the target.
 
QString name () const
 Return target name.
 
std::vector< Distanceradii () const
 Returns the radii of the body in km.
 
void restoreShape ()
 Restores the shape to the original after setShapeEllipsoid has overridden it.
 
void setShapeEllipsoid ()
 Set the shape to the ellipsoid and save the original shape.
 
void setRadii (std::vector< Distance > radii)
 Sets the radii of the body.
 
ShapeModelshape () const
 Return the shape.
 
Spicespice () const
 Return the spice object.
 

Private Member Functions

SpiceInt lookupNaifBodyCode () const
 This returns the NAIF body code of the target indicated in the labels.
 

Private Attributes

SpiceInt * m_bodyCode
 
   The NaifBodyCode value, if it exists in the

labels.

 
QString * m_name
 Name of the target.
 
std::vector< Distancem_radii
 The radii of the target.
 
ShapeModelm_originalShape
 The shape model of the target.
 
ShapeModelm_shape
 The shape model of the target.
 
bool m_sky
 Indicates whether the target of the observation is the sky.
 
Spicem_spice
 The parent Spice object. This is needed to get pixel resolution in ShapeModels.
 

Detailed Description

This class is used to create and store valid Isis3 targets.

Author
2012-03-20 Debbie A. Cook

Definition at line 47 of file Target.h.

Constructor & Destructor Documentation

Isis::Target::Target ( Spice spice,
Pvl lab 
)

Constructs a Target object and loads target information.

Parameters
labLabel containing Instrument and Kernels groups.
Author
2012-03-20 Debbie A. Cook
History:
2012-10-11 Debbie A. Cook - Original version

Definition at line 49 of file Target.cpp.

References Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), and Isis::toInt().

Isis::Target::Target ( )

Constructs an empty Target object.

Author
2012-03-20 Debbie A. Cook
History:
2012-08-29 Debbie A. Cook - Original version

Definition at line 99 of file Target.cpp.

Isis::Target::~Target ( )

Destroys the Target.

Destroys the Target object.

Definition at line 126 of file Target.cpp.

Member Function Documentation

void Isis::Target::init ( )

Initialize member variables.

Author
2012-03-20 Debbie A. Cook
History:
2012-08-31 Debbie A. Cook - Original version

Definition at line 115 of file Target.cpp.

bool Isis::Target::isSky ( ) const

Return if our target is the sky.

Definition at line 148 of file Target.cpp.

SpiceInt Isis::Target::lookupNaifBodyCode ( ) const
private

This returns the NAIF body code of the target indicated in the labels.

Returns
SpiceInt NAIF body code

Definition at line 159 of file Target.cpp.

References _FILEINFO_.

SpiceInt Isis::Target::naifBodyCode ( ) const

This returns the NAIF body code of the target.

Returns
SpiceInt NAIF body code

Definition at line 179 of file Target.cpp.

QString Isis::Target::name ( ) const

Return target name.

Definition at line 185 of file Target.cpp.

Referenced by Isis::FeatureNomenclatureTool::findMissingNomenclature(), and Isis::Spice::targetName().

std::vector< Distance > Isis::Target::radii ( ) const

Returns the radii of the body in km.

The radii are obtained from the appropriate SPICE kernel for the body specified by TargetName in the Instrument group of the labels.

Definition at line 195 of file Target.cpp.

Referenced by Isis::Camera::BasicMapping().

void Isis::Target::restoreShape ( )

Restores the shape to the original after setShapeEllipsoid has overridden it.

Definition at line 203 of file Target.cpp.

Referenced by Isis::Sensor::IgnoreElevationModel().

void Isis::Target::setRadii ( std::vector< Distance radii)

Sets the radii of the body.

Parameters
r[]Radii of the target in kilometers

Definition at line 233 of file Target.cpp.

void Isis::Target::setShapeEllipsoid ( )

Set the shape to the ellipsoid and save the original shape.

Definition at line 221 of file Target.cpp.

Referenced by Isis::Sensor::IgnoreElevationModel().

Spice * Isis::Target::spice ( ) const

Return the spice object.

Definition at line 251 of file Target.cpp.

Member Data Documentation

SpiceInt* Isis::Target::m_bodyCode
private

   The NaifBodyCode value, if it exists in the

labels.

Otherwise, if the target is sky, it's the SPK code and if not sky then it's calculated by the NaifBodyCode() method.

Definition at line 70 of file Target.h.

QString* Isis::Target::m_name
private

Name of the target.

Definition at line 74 of file Target.h.

ShapeModel* Isis::Target::m_originalShape
private

The shape model of the target.

Definition at line 76 of file Target.h.

std::vector<Distance> Isis::Target::m_radii
private

The radii of the target.

Definition at line 75 of file Target.h.

ShapeModel* Isis::Target::m_shape
private

The shape model of the target.

Definition at line 77 of file Target.h.

bool Isis::Target::m_sky
private

Indicates whether the target of the observation is the sky.

Definition at line 78 of file Target.h.

Spice* Isis::Target::m_spice
private

The parent Spice object. This is needed to get pixel resolution in ShapeModels.

Definition at line 83 of file Target.h.


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