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

#include <CameraPointInfo.h>

Collaboration diagram for Isis::CameraPointInfo:

Public Member Functions
	CameraPointInfo ()
	Constructor, initializes CubeManager and other variables for use. More...

virtual	~CameraPointInfo ()
	Destructor, deletes CubeManager object used. More...

void	SetCube (const QString &cubeFileName)
	SetCube opens the given cube in a CubeManager. More...

void	SetCSVOutput (bool csvOutput)
	Set the output format (true is CSV, false is PVL) More...

PvlGroup *	SetImage (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. More...

PvlGroup *	SetCenter (const bool outside=false, const bool error=false)
	SetCenter sets the image coordinates to the center of the image. More...

PvlGroup *	SetSample (const double sample, const bool outside=false, const bool error=false)
	SetSample sets the image coordinates to the center line and the given sample. More...

PvlGroup *	SetLine (const double line, const bool outside=false, const bool error=false)
	SetLine sets the image coordinates to the center sample and the given line. More...

PvlGroup *	SetGround (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. More...

Protected Member Functions
Camera *	camera ()
	Retrieves a pointer to the camera. More...

Cube *	cube ()
	Retrieves a pointer to the current cube. More...

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

◆ CameraPointInfo()

Isis::CameraPointInfo::CameraPointInfo ( )

Constructor, initializes CubeManager and other variables for use.

References Isis::CubeManager::SetNumOpenCubes().

◆ ~CameraPointInfo()

Isis::CameraPointInfo::~CameraPointInfo ( )

virtual

Destructor, deletes CubeManager object used.

Member Function Documentation

◆ camera()

Camera * Isis::CameraPointInfo::camera ( )

protected

Retrieves a pointer to the camera.

Returns: Camera* A pointer to the Camera.

◆ cube()

Cube * Isis::CameraPointInfo::cube ( )

protected

Retrieves a pointer to the current cube.

Returns: Cube* A pointer to the current cube.

◆ SetCenter()

PvlGroup * Isis::CameraPointInfo::SetCenter	(	const bool	allowOutside = `false`,
		const bool	allowErrors = `false`
	)

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

Parameters

allowOutside	Indicates whether to allow extrapolation.
allowErrors	Indicates whether to allow the program to throw an error if a problem occurs.

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

References Isis::Cube::lineCount(), Isis::Cube::sampleCount(), and Isis::Camera::SetImage().

◆ SetCSVOutput()

void Isis::CameraPointInfo::SetCSVOutput ( bool csvOutput )

Set the output format (true is CSV, false is PVL)

Parameters

csvOutput The new value to set csvOutput

◆ SetCube()

void Isis::CameraPointInfo::SetCube ( const QString & 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 file name.

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

◆ SetGround()

PvlGroup * Isis::CameraPointInfo::SetGround	(	const double	latitude,
		const double	longitude,
		const bool	allowOutside = `false`,
		const bool	allowErrors = `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
allowOutside	Indicates whether to allow extrapolation.
allowErrors	Indicates whether to allow the program to throw an error if a problem occurs.

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

References Isis::Camera::SetUniversalGround().

◆ SetImage()

PvlGroup * Isis::CameraPointInfo::SetImage	(	const double	sample,
		const double	line,
		const bool	allowOutside = `false`,
		const bool	allowErrors = `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 cube.
allowOutside	Indicates whether to allow extrapolation.
allowErrors	Indicates whether to allow the program to throw an error if a problem occurs.

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

References Isis::Camera::SetImage().

◆ SetLine()

PvlGroup * Isis::CameraPointInfo::SetLine	(	const double	line,
		const bool	allowOutside = `false`,
		const bool	allowErrors = `false`
	)

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

Parameters

line	A line coordinate in or almost in the cube.
allowOutside	Indicates whether to allow extrapolation.
allowErrors	Indicates whether to allow the program to throw an error if a problem occurs.

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

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

◆ SetSample()

PvlGroup * Isis::CameraPointInfo::SetSample	(	const double	sample,
		const bool	allowOutside = `false`,
		const bool	allowErrors = `false`
	)

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

Parameters

sample	A sample coordinate in or almost in the cube.
allowOutside	Indicates whether to allow extrapolation.
allowErrors	Indicates whether to allow the program to throw an error if a problem occurs.

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

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

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

/Users/jmapel/ISIS3/isis/src/base/objs/CameraPointInfo/CameraPointInfo.h
/Users/jmapel/ISIS3/isis/src/base/objs/CameraPointInfo/CameraPointInfo.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CameraPointInfo()

◆ ~CameraPointInfo()

Member Function Documentation

◆ camera()

◆ cube()

◆ SetCenter()

◆ SetCSVOutput()

◆ SetCube()

◆ SetGround()

◆ SetImage()

◆ SetLine()

◆ SetSample()