USGS Astrogeology Isis API

Definition at line 76 of file ControlNet.h.


Public Types
	Singleton
	Singleton is a network that identifies unique points such as reseaus, tic-marks, etc.
	ImageToImage
	ImageToImage is a network used to tie two or more images together using line/sample coordinates only.
	ImageToGround
	ImageToGround is a network used to tie one or more images (typically many) between each other and a target (e.g., Mars).
enum	NetworkType { Singleton, ImageToImage, ImageToGround }
	Enumeration defining network type. More...
Public Member Functions
	ControlNet ()
	Creates an empty ControlNet object.
	ControlNet (const std::string &ptfile, Progress *progress=0, bool forceBuild=false)
	Creates a ControlNet object with the given list of control points and cubes.
	~ControlNet ()
	Destroy the control network.
void	SetType (const NetworkType &type)
	Set the type of network.
NetworkType	Type () const
	Return the type of network.
void	SetTarget (const std::string &target)
	Set the target name.
std::string	Target () const
	Return the target name.
void	SetNetworkId (const std::string &id)
	Set the network id.
std::string	NetworkId () const
	Return the network id.
void	SetUserName (const std::string &name)
	Set the user name.
std::string	UserName () const
	Return the user name.
void	SetDescription (const std::string &desc)
	Set the description of the network.
std::string	Description () const
	Return the description of the network.
void	SetCreatedDate (const std::string &date)
	Set the creation time.
void	SetModifiedDate (const std::string &date)
	Set the last modified date.
ControlPoint &	operator[] (int index)
	Return the ith control point.
int	Size () const
	Return the number of control points in the network.
int	NumValidPoints ()
	Returns the number of non-ignored control points.
bool	Invalid () const
	Return if the control point is invalid.
int	NumMeasures () const
	Return the total number of measures for all control points in the network.
int	NumValidMeasures () const
	Return the number of valid (non-ignored) measures.
int	NumIgnoredMeasures () const
	Return the number of ignored measures.
void	Add (const ControlPoint &point, bool forceBuild=false)
	Adds a ControlPoint to the ControlNet.
void	Delete (int index)
	Deletes the ControlPoint at the specified index in the ControlNet.
void	Delete (const std::string &id)
	Deletes the ControlPoint with the given id in the ControlNet.
void	ReadControl (const std::string &ptfile, Progress *progress=0, bool forceBuild=false)
	Reads in the control points from the given file.
void	Write (const std::string &ptfile)
	Writes out the ControlPoints.
ControlPoint *	Find (const std::string &id)
	Finds and returns a pointer to the ControlPoint with the specified id.
ControlPoint *	FindClosest (const std::string &serialNumber, double sample, double line)
	Finds and returns a pointer to the closest ControlPoint to the ControlMeasure with the given serial number and line sample location.
bool	Exists (ControlPoint &point)
	Returns true if the given ControlPoint has the same id as another ControlPoint in class.
double	AverageError ()
	Compute the average error of all points in the network.
double	MaximumError ()
	Determine the maximum error of all points in the network.
void	ComputeErrors ()
	Compute error for each point in the network.
void	ComputeApriori ()
	Compute aprior values for each point in the network.
void	SetImages (const std::string &imageListFile)
	Creates the ControlNet's image cameras based on an input file.
void	SetImages (SerialNumberList &list, Progress *progress=0)
	Creates the ControlNet's image camera's based on the list of Serial Numbers.
Isis::Camera *	Camera (int index)
	Returns the camera list from the given image number.
Private Attributes
QVector< QString >	p_pointIds
	QVector of ControlPoint Ids.
QHash< QString, ControlPoint >	p_pointsHash
	Hash table of Control Points.
std::string	p_targetName
	Name of the target.
std::string	p_networkId
	The Network Id.
std::string	p_created
	Creation Date.
std::string	p_modified
	Date Last Modified.
std::string	p_description
	Textual Description of network.
std::string	p_userName
	The user who created the network.
NetworkType	p_type
	The type of network being used.
int	p_numMeasures
	Total number of measures in the network.
int	p_numIgnoredMeasures
	Number of ignored measures.
std::map< std::string, Isis::Camera * >	p_cameraMap
	A map from serialnumber to camera.
std::vector< Isis::Camera * >	p_cameraList
	Vector of image number to camera.
bool	p_invalid
	If the Control Network is currently invalid.

Member Enumeration Documentation

enum Isis::ControlNet::NetworkType

Enumeration defining network type.

Enumerator:

Singleton	Singleton is a network that identifies unique points such as reseaus, tic-marks, etc.
ImageToImage	ImageToImage is a network used to tie two or more images together using line/sample coordinates only.
ImageToGround	ImageToGround is a network used to tie one or more images (typically many) between each other and a target (e.g., Mars).

Definition at line 88 of file ControlNet.h.

Constructor & Destructor Documentation

Isis::ControlNet::ControlNet ( )

Creates an empty ControlNet object.

Definition at line 9 of file ControlNet.cpp.

References p_invalid, p_numIgnoredMeasures, and p_numMeasures.

Isis::ControlNet::ControlNet	(	const std::string &	ptfile,
		Progress *	progress = `0`,
		bool	forceBuild = `false`
	)

Creates a ControlNet object with the given list of control points and cubes.

Parameters:

	ptfile	Name of file containing a Pvl list of control points
	progress	A pointer to the progress of reading in the control points
	forceBuild	Forces invalid Control Points to be added to this Control Network

Definition at line 24 of file ControlNet.cpp.

References p_invalid, p_numIgnoredMeasures, p_numMeasures, and ReadControl().

Isis::ControlNet::~ControlNet ( ) [inline]

Destroy the control network.

Definition at line 83 of file ControlNet.h.

Member Function Documentation

void Isis::ControlNet::Add	(	const ControlPoint &	point,
		bool	forceBuild = `false`
	)

Adds a ControlPoint to the ControlNet.

Parameters:

	point	Control point to be added
	forceBuild	Forces invalid Control Points to be added to this Control Network

Exceptions:

Isis::iException::Programmer

- "ControlPoint must have unique Id"

Definition at line 42 of file ControlNet.cpp.

References _FILEINFO_, Isis::ControlPoint::Id(), Isis::iException::Message(), p_pointIds, and p_pointsHash.

Referenced by ReadControl().

double Isis::ControlNet::AverageError ( )

Compute the average error of all points in the network.

Returns:: double Average error of points

Definition at line 373 of file ControlNet.cpp.

References p_pointIds, and p_pointsHash.

Referenced by Isis::BundleAdjust::Solve().

Isis::Camera* Isis::ControlNet::Camera ( int index ) [inline]

Returns the camera list from the given image number.

Parameters:

index

The image number

Returns:: Isis::Camera* The pointer to the resultant camera list

Definition at line 216 of file ControlNet.h.

Referenced by Isis::BundleAdjust::Cmatrix(), Isis::BundleAdjust::Solve(), Isis::BundleAdjust::SpVector(), and Isis::BundleAdjust::Update().

void Isis::ControlNet::ComputeApriori ( )

Compute aprior values for each point in the network.

Definition at line 335 of file ControlNet.cpp.

References p_pointIds, and p_pointsHash.

Referenced by Isis::BundleAdjust::Solve().

void Isis::ControlNet::ComputeErrors ( )

Compute error for each point in the network.

Definition at line 346 of file ControlNet.cpp.

References p_pointIds, and p_pointsHash.

Referenced by Isis::BundleAdjust::Solve().

void Isis::ControlNet::Delete ( const std::string & id )

Deletes the ControlPoint with the given id in the ControlNet.

Parameters:

The id of the ControlPoint to be deleted

Exceptions:

Isis::iException::User

- "A ControlPoint matching the id was not found in the ControlNet"

Definition at line 97 of file ControlNet.cpp.

References _FILEINFO_, Isis::iException::Message(), p_pointIds, and p_pointsHash.

void Isis::ControlNet::Delete ( int index )

Deletes the ControlPoint at the specified index in the ControlNet.

Parameters:

index

The index of the ControlPoint to be deleted

Exceptions:

Isis::iException::User

- "There is no ControlPoint at the given index number"

Definition at line 61 of file ControlNet.cpp.

References _FILEINFO_, Invalid(), Isis::iException::Message(), p_invalid, p_pointIds, p_pointsHash, and Size().

std::string Isis::ControlNet::Description ( ) const [inline]

Return the description of the network.

Returns:: The description of this Control Network

Definition at line 145 of file ControlNet.h.

References p_description.

bool Isis::ControlNet::Exists ( ControlPoint & point )

Returns true if the given ControlPoint has the same id as another ControlPoint in class.

Parameters:

point

The ControlPoint whos id is being compared

Returns:: bool If the ControlPoint id was found

Definition at line 290 of file ControlNet.cpp.

References Isis::ControlPoint::Id(), and p_pointsHash.

ControlPoint * Isis::ControlNet::Find ( const std::string & id )

Finds and returns a pointer to the ControlPoint with the specified id.

Parameters:

The id of the ControlPoint to be deleted

Returns:: ControlPoint* Pointer to the ControlPoint with the given id

Exceptions:

Isis::iException::User

- "A ControlPoint matching the id was not found in the ControlNet"

Definition at line 272 of file ControlNet.cpp.

References _FILEINFO_, Isis::iException::Message(), p_pointIds, and p_pointsHash.

Referenced by Qisis::MosaicPointTool::findPoint().

ControlPoint * Isis::ControlNet::FindClosest	(	const std::string &	serialNumber,
		double	sample,
		double	line
	)

Finds and returns a pointer to the closest ControlPoint to the ControlMeasure with the given serial number and line sample location.

Parameters:

	serialNumber	The serial number of the the file the ControlMeasure is on
	sample	The sample number of the ControlMeasure
	line	The line number of the ControlMeasure

Returns:: ControlPoint* Pointer to the ControlPoint closest to the given line, sample position

Definition at line 310 of file ControlNet.cpp.

References dist, p_pointIds, and p_pointsHash.

bool Isis::ControlNet::Invalid ( ) const [inline]

Return if the control point is invalid.

Definition at line 175 of file ControlNet.h.

References p_invalid.

Referenced by Delete().

double Isis::ControlNet::MaximumError ( )

Determine the maximum error of all points in the network.

Returns:: double Max error of points

Definition at line 358 of file ControlNet.cpp.

References p_pointIds, and p_pointsHash.

Referenced by Isis::BundleAdjust::Solve().

std::string Isis::ControlNet::NetworkId ( ) const [inline]

Return the network id.

Definition at line 121 of file ControlNet.h.

References p_networkId.

int Isis::ControlNet::NumIgnoredMeasures ( ) const [inline]

Return the number of ignored measures.

Definition at line 184 of file ControlNet.h.

References p_numIgnoredMeasures.

int Isis::ControlNet::NumMeasures ( ) const [inline]

Return the total number of measures for all control points in the network.

Definition at line 178 of file ControlNet.h.

References p_numMeasures.

int Isis::ControlNet::NumValidMeasures ( ) const [inline]

Return the number of valid (non-ignored) measures.

Definition at line 181 of file ControlNet.h.

References p_numIgnoredMeasures, and p_numMeasures.

Referenced by Isis::BundleAdjust::Solve().

int Isis::ControlNet::NumValidPoints ( )

Returns the number of non-ignored control points.

Returns:: Number of valid control points

Definition at line 463 of file ControlNet.cpp.

References p_pointIds, p_pointsHash, Size(), and size.

ControlPoint& Isis::ControlNet::operator[] ( int index ) [inline]

Return the ith control point.

Parameters:

index

Control Point index

Returns:: The Control Point at the provided index

Definition at line 168 of file ControlNet.h.

References p_pointIds, and p_pointsHash.

void Isis::ControlNet::ReadControl	(	const std::string &	ptfile,
		Progress *	progress = `0`,
		bool	forceBuild = `false`
	)

Reads in the control points from the given file.

Parameters:

	ptfile	Name of file containing a Pvl list of control points
	progress	A pointer to the progress of reading in the control points
	forceBuild	Forces invalid Control Points to be added to this Control Network

Exceptions:

	Isis::iException::User	- "Invalid Network Type"
	Isis::iException::User	- "Invalid Control Point"
	Isis::iException::User	- "Invalid Format"

For internal use only.

History:: 2009-04-07 Tracie Sucharski - Keep track of ignored measures.

Definition at line 139 of file ControlNet.cpp.

References _FILEINFO_, Add(), Isis::Progress::CheckStatus(), e, Isis::PvlObject::FindObject(), ImageToGround, ImageToImage, Isis::PvlContainer::IsNamed(), Isis::iException::Message(), Isis::PvlObject::Object(), Isis::PvlObject::Objects(), p_created, p_description, p_modified, p_networkId, p_numIgnoredMeasures, p_numMeasures, p_targetName, p_type, p_userName, Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), and Singleton.

Referenced by ControlNet().

void Isis::ControlNet::SetCreatedDate ( const std::string & date ) [inline]

Set the creation time.

Parameters:

date

The date this Control Network was created

Definition at line 152 of file ControlNet.h.

References p_created.

Referenced by Write().

void Isis::ControlNet::SetDescription ( const std::string & desc ) [inline]

Set the description of the network.

Parameters:

desc

The description of this Control Network

Definition at line 138 of file ControlNet.h.

References p_description.

void Isis::ControlNet::SetImages	(	SerialNumberList &	list,
		Progress *	progress = `0`
	)

Creates the ControlNet's image camera's based on the list of Serial Numbers.

Parameters:

	list	The list of Serial Numbers
	progress	A pointer to the progress of creating the cameras

Exceptions:

	Isis::iException::System	- "Unable to create camera for cube file"
	Isis::iException::User	- "Control point measure does not have a cube with a matching serial number"

For internal use only.