USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::CameraPointInfo Class Reference

CameraPointInfo provides quick access to the majority of information avaliable from a camera on a point. More...

#include <CameraPointInfo.h>

List of all members.

Public Member Functions

 CameraPointInfo ()
 Constructor, initializes CubeManager and other variables for use.
virtual ~CameraPointInfo ()
 Destructor, deletes CubeManager object used.
void SetCube (const std::string &cubeFilename)
 SetCube opens the given cube in a CubeManager.
PvlGroupSetImage (const double sample, const double line, const bool outside=false, const bool error=false)
 SetImage sets a sample, line image coordinate in the camera so data can be accessed.
PvlGroupSetCenter (const bool outside=false, const bool error=false)
 SetCenter sets the image coordinates to the center of the image.
PvlGroupSetSample (const double sample, const bool outside=false, const bool error=false)
 SetSample sets the image coordinates to the center line and the given sample.
PvlGroupSetLine (const double line, const bool outside=false, const bool error=false)
 SetLine sets the image coordinates to the center sample and the given line.
PvlGroupSetGround (const double latitude, const double longitude, const bool outside=false, const bool error=false)
 SetGround sets a latitude, longitude grrund coordinate in the camera so data can be accessed.

Detailed Description

CameraPointInfo provides quick access to the majority of information avaliable from a camera on a point.

CameraPointInfo provides the functionality which was a part of campt in class form. This functionality is access to the majoirty of information avaliable on any given point on an image. The main difference is the use of a CubeManager within CameraPointInfo for effeciency when working with control nets and the opening of cubes several times.

Author:
2009-08-25 Mackenzie Boyd

Constructor & Destructor Documentation

Isis::CameraPointInfo::CameraPointInfo (  ) 

Constructor, initializes CubeManager and other variables for use.

References Isis::CubeManager::SetNumOpenCubes().

Isis::CameraPointInfo::~CameraPointInfo (  )  [virtual]

Destructor, deletes CubeManager object used.


Member Function Documentation

PvlGroup * Isis::CameraPointInfo::SetCenter ( const bool  outside = false,
const bool  errors = false 
)

SetCenter sets the image coordinates to the center of the image.

Returns:
PvlGroup* The pertinent data from the Camera class on the point. Ownership is passed to caller.

References Isis::Cube::getLineCount(), Isis::Cube::getSampleCount(), and Isis::Camera::SetImage().

void Isis::CameraPointInfo::SetCube ( const std::string &  cubeFilename  ) 

SetCube opens the given cube in a CubeManager.

The CubeManager is for effeciency when working with control nets where cubes are accesed multiple times.

Parameters:
cubeFilename A cube filename

References Isis::Cube::getCamera(), and Isis::CubeManager::OpenCube().

PvlGroup * Isis::CameraPointInfo::SetGround ( const double  latitude,
const double  longitude,
const bool  outside = false,
const bool  errors = false 
)

SetGround sets a latitude, longitude grrund coordinate in the camera so data can be accessed.

Parameters:
latitude A latitude coordinate in or almost in the cube
longitude A longitude coordinate in or almost in the cube
Returns:
PvlGroup* The pertinent data from the Camera class on the point. Ownership is passed to caller.

References Isis::Camera::SetUniversalGround().

PvlGroup * Isis::CameraPointInfo::SetImage ( const double  sample,
const double  line,
const bool  outside = false,
const bool  errors = false 
)

SetImage sets a sample, line image coordinate in the camera so data can be accessed.

Parameters:
sample A sample coordinate in or almost in the cube
line A line coordinate in or almost in the cubei
Returns:
PvlGroup* The pertinent data from the Camera class on the point. Ownership is passed to caller.

References Isis::Camera::SetImage().

PvlGroup * Isis::CameraPointInfo::SetLine ( const double  line,
const bool  outside = false,
const bool  errors = false 
)

SetLine sets the image coordinates to the center sample and the given line.

Returns:
PvlGroup* The pertinent data from the Camera class on the point. Ownership is passed to caller.

References Isis::Cube::getSampleCount(), and Isis::Camera::SetImage().

PvlGroup * Isis::CameraPointInfo::SetSample ( const double  sample,
const bool  outside = false,
const bool  errors = false 
)

SetSample sets the image coordinates to the center line and the given sample.

Returns:
PvlGroup* The pertinent data from the Camera class on the point. Ownership is passed to caller.

References Isis::Cube::getLineCount(), and Isis::Camera::SetImage().


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