Isis::ControlPoint Class Reference

A single control point. More...

#include <ControlPoint.h>

Classes
struct	RadiusSource
struct	SurfacePointSource
Public Types
enum	PointType { Fixed = 0, Constrained = 1, Free = 2 }
	These are the valid 'types' of point. More...
enum	Status { Failure, Success, PointLocked }
	This is a return status for many of the mutating (setter) method calls. More...
enum	ConstraintStatus { LatitudeConstrained = 0, LongitudeConstrained = 1, RadiusConstrained = 2 }
	This is a convenience member for checking number of constrained coordinates in the SurfacePoint. More...
Public Member Functions
	ControlPoint ()
	Construct a control point.
	ControlPoint (const ControlPoint &)
	Copy the given control point into this instance.
	ControlPoint (const QString &id)
	Construct a control point with given Id.
	ControlPoint (const ControlPointFileEntryV0002 &fileEntry, const Distance &majorRad, const Distance &minorRad, const Distance &polarRad)
	This is used when reading from a protocol buffer.
	~ControlPoint ()
	This destroys the current instance and cleans up any and all allocated memory.
ControlNet *	Parent ()
void	Load (PvlObject &p)
	Loads the PvlObject into a ControlPoint.
void	Add (ControlMeasure *measure)
	Add a measurement to the control point, taking ownership of the measure in the process.
int	Delete (ControlMeasure *measure)
	Remove a measurement from the control point, deleting reference measure is allowed.
int	Delete (QString serialNumber)
	Remove a measurement from the control point, deleting reference measure is allowed.
int	Delete (int index)
	Remove a measurement from the control point, deleting reference measure is allowed.
Status	ResetApriori ()
	Reset all the Apriori info to defaults.
const ControlMeasure *	GetMeasure (QString serialNumber) const
	Get a control measure based on its cube's serial number.
ControlMeasure *	GetMeasure (QString serialNumber)
	Get a control measure based on its cube's serial number.
const ControlMeasure *	GetMeasure (int index) const
ControlMeasure *	GetMeasure (int index)
const ControlMeasure *	GetRefMeasure () const
	Get the reference control measure.
ControlMeasure *	GetRefMeasure ()
	Get the measure that is the reference directly.
Status	SetChooserName (QString name)
	Set the point's chooser name.
Status	SetDateTime (QString newDateTime)
	Set the point's last modified time.
Status	SetEditLock (bool editLock)
	Set the EditLock state.
Status	SetId (QString id)
	Sets the Id of the control point.
Status	SetRefMeasure (ControlMeasure *cm)
	Set the point's reference measure.
Status	SetRefMeasure (int index)
	Set the point's reference measure.
Status	SetRefMeasure (QString sn)
	Set the points reference measure.
Status	SetRejected (bool rejected)
	Set the jigsawRejected state.
Status	SetIgnored (bool newIgnoreStatus)
	Set whether to ignore or use control point.
Status	SetAdjustedSurfacePoint (SurfacePoint newSurfacePoint)
	Set or update the surface point relating to this control point.
Status	SetType (PointType newType)
	Updates the control point's type.
Status	SetAprioriRadiusSource (RadiusSource::Source source)
	This updates the source of the radius of the apriori surface point.
Status	SetAprioriRadiusSourceFile (QString sourceFile)
	This updates the filename of the DEM that the apriori radius came from.
Status	SetAprioriSurfacePoint (SurfacePoint aprioriSP)
	This updates the apriori surface point.
Status	SetAprioriSurfacePointSource (SurfacePointSource::Source source)
	This updates the source of the surface point.
Status	SetAprioriSurfacePointSourceFile (QString sourceFile)
	This updates the filename of where the apriori surface point came from.
Status	ComputeApriori ()
	This method computes the apriori lat/lon for a point.
Status	ComputeResiduals ()
	This method computes the BundleAdjust residuals for a point.
Status	ComputeResiduals_Millimeters ()
	This method computes the residuals for a point.
SurfacePoint	GetAdjustedSurfacePoint () const
SurfacePoint	GetBestSurfacePoint () const
	Returns the adjusted surface point if it exists, otherwise returns the a priori surface point.
QString	GetChooserName () const
QString	GetDateTime () const
bool	IsEditLocked () const
bool	IsRejected () const
QString	GetId () const
	Return the Id of the control point.
bool	IsIgnored () const
bool	IsValid () const
bool	IsInvalid () const
bool	IsFixed () const
bool	HasAprioriCoordinates ()
bool	IsConstrained ()
bool	IsLatitudeConstrained ()
bool	IsLongitudeConstrained ()
bool	IsRadiusConstrained ()
int	NumberOfConstrainedCoordinates ()
QString	GetPointTypeString () const
	Obtain a string representation of the PointType.
PointType	GetType () const
QString	GetRadiusSourceString () const
	Obtain a string representation of the RadiusSource.
QString	GetSurfacePointSourceString () const
	Obtain a string representation of the SurfacePointSource.
SurfacePoint	GetAprioriSurfacePoint () const
RadiusSource::Source	GetAprioriRadiusSource () const
QString	GetAprioriRadiusSourceFile () const
SurfacePointSource::Source	GetAprioriSurfacePointSource () const
QString	GetAprioriSurfacePointSourceFile () const
int	GetNumMeasures () const
int	GetNumValidMeasures () const
int	GetNumLockedMeasures () const
	Returns the number of locked control measures.
bool	HasSerialNumber (QString serialNumber) const
	Return true if given serial number exists in point.
int	IndexOf (ControlMeasure *, bool throws=true) const
int	IndexOf (QString sn, bool throws=true) const
int	IndexOfRefMeasure () const
bool	IsReferenceExplicit () const
QString	GetReferenceSN () const
Statistics	GetStatistic (double(ControlMeasure::*statFunc)() const) const
	This function will call a given method on every control measure that this point has.
Statistics	GetStatistic (long dataType) const
QList< ControlMeasure * >	getMeasures (bool excludeIgnored=false) const
QList< QString >	getCubeSerialNumbers () const
const ControlMeasure *	operator[] (QString serialNumber) const
	Same as GetMeasure (provided for convenience).
ControlMeasure *	operator[] (QString serialNumber)
	Same as GetMeasure (provided for convenience).
const ControlMeasure *	operator[] (int index) const
	Same as GetMeasure (provided for convenience).
ControlMeasure *	operator[] (int index)
	Same as GetMeasure (provided for convenience).
bool	operator!= (const ControlPoint &pPoint) const
	Compare two Control Points for inequality.
bool	operator== (const ControlPoint &pPoint) const
	Compare two Control Points for equality.
const ControlPoint &	operator= (const ControlPoint &pPoint)
void	ZeroNumberOfRejectedMeasures ()
	Initialize the number of rejected measures to 0.
void	SetNumberOfRejectedMeasures (int numRejected)
	Set (update) the number of rejected measures for the control point.
int	GetNumberOfRejectedMeasures () const
	Get the number of rejected measures on the control point.
double	GetSampleResidualRms () const
	Get rms of sample residuals.
double	GetLineResidualRms () const
	Get rms of line residuals.
double	GetResidualRms () const
	Get rms of residuals.
void	ClearJigsawRejected ()
	Set jigsaw rejected flag for all measures to false and set the jigsaw rejected flag for the point itself to false.
ControlPointFileEntryV0002	ToFileEntry () const
Static Public Member Functions
static QString	PointTypeToString (PointType type)
	Obtain a string representation of a given PointType.
static PointType	StringToPointType (QString pointTypeString)
	Obtain a PointType given a string representation of it.
static QString	RadiusSourceToString (RadiusSource::Source source)
	Obtain a string representation of a given RadiusSource.
static RadiusSource::Source	StringToRadiusSource (QString str)
	Obtain a RadiusSource::Source from a string.
static QString	SurfacePointSourceToString (SurfacePointSource::Source source)
	Obtain a string representation of a given SurfacePointSource.
static SurfacePointSource::Source	StringToSurfacePointSource (QString str)
	Obtain a SurfacePoint::Source from a string.
Static Public Attributes
static const int	PointTypeCount = 3
Friends
class	ControlNet

Detailed Description

A single control point.

A control point is one or more measurements that identify the same feature or location in different images.

Author:: 2005-07-29 Jeff Anderson

See also:: ControlMeasure ControlNet

Member Enumeration Documentation

enum Isis::ControlPoint::ConstraintStatus

This is a convenience member for checking number of constrained coordinates in the SurfacePoint.

Enumerator:

LatitudeConstrained	This is the status of constrained coordinates in the SurfacePoint.
LongitudeConstrained
RadiusConstrained

enum Isis::ControlPoint::PointType

These are the valid 'types' of point.

A point type defines what a point is tying together.

Enumerator:

Fixed

A Fixed point is a Control Point whose lat/lon is well established and should not be changed.

Some people will refer to this as a truth (i.e., ground truth). A fixed point can be identifed in one or more cubes. Historically this point was called a "Ground" point.

Constrained

A Constrained point is a Control Point whose lat/lon/radius is somewhat established and should not be changed.

Free

A Free point is a Control Point that identifies common measurements between two or more cubes.

While it could have a lat/lon, it is not necessarily correct and is subject to change. This is the most common type of control point. This point type floats freely in a bundle adjustment. Historically this point type was called "Tie".

enum Isis::ControlPoint::Status

This is a return status for many of the mutating (setter) method calls.

We chose to use return status' because often times ignoring them is the behavior the caller wants.

Enumerator:

Failure

This is returned when an operation cannot be performed due to a problem such as the point is ignored and the operation doesn't make sense.

Success

This is returned when the operation successfully took effect.

PointLocked

This is returned when the operation requires Edit Lock to be false but it is currently true.

The operation did not take effect.

Constructor & Destructor Documentation

Isis::ControlPoint::ControlPoint ( )

Construct a control point.

Author:: tsucharski (5/5/2010)

References Free, Isis::ControlPoint::RadiusSource::None, and Isis::ControlPoint::SurfacePointSource::None.

Isis::ControlPoint::ControlPoint ( const ControlPoint & other )

Copy the given control point into this instance.

Parameters:

other

The control point to duplicate

References GetMeasure(), and SetRefMeasure().

Isis::ControlPoint::ControlPoint ( const QString & newId )

Construct a control point with given Id.

Parameters:

id

Control Point Id

References Free, Isis::ControlPoint::RadiusSource::None, and Isis::ControlPoint::SurfacePointSource::None.

Isis::ControlPoint::ControlPoint	(	const ControlPointFileEntryV0002 &	fileEntry,
		const Distance &	majorRad,
		const Distance &	minorRad,
		const Distance &	polarRad
	)

This is used when reading from a protocol buffer.

Given a file representation (protocol buffer), and log data, construct the control point.

History:: 2008-06-18 Debbie A. Cook, Swapped Init with SetRadii calls to avoid resetting the surface points with no radii

References _FILEINFO_, Isis::ControlPoint::RadiusSource::AverageOfMeasures, Isis::ControlPoint::SurfacePointSource::AverageOfMeasures, Isis::ControlPoint::SurfacePointSource::Basemap, Isis::ControlPoint::RadiusSource::BundleSolution, Isis::ControlPoint::SurfacePointSource::BundleSolution, Constrained, Isis::ControlPoint::RadiusSource::DEM, Isis::ControlPoint::RadiusSource::Ellipsoid, Fixed, Free, Isis::Distance::isValid(), LatitudeConstrained, LongitudeConstrained, Isis::Displacement::Meters, Isis::ControlPoint::RadiusSource::None, Isis::ControlPoint::SurfacePointSource::None, Isis::IException::Programmer, RadiusConstrained, Isis::ControlPoint::SurfacePointSource::Reference, Isis::SurfacePoint::SetRadii(), Isis::SurfacePoint::SetRectangularMatrix(), SetRefMeasure(), Isis::ControlPoint::RadiusSource::User, and Isis::ControlPoint::SurfacePointSource::User.

Isis::ControlPoint::~ControlPoint ( )

This destroys the current instance and cleans up any and all allocated memory.

Member Function Documentation

void Isis::ControlPoint::Add ( ControlMeasure * measure )

Add a measurement to the control point, taking ownership of the measure in the process.

Parameters:

measure

The ControlMeasure to add

Referenced by Isis::StereoTool::createPoint(), and Isis::MatchTool::createPoint().

void Isis::ControlPoint::ClearJigsawRejected ( )

Set jigsaw rejected flag for all measures to false and set the jigsaw rejected flag for the point itself to false.

References GetMeasure(), SetRejected(), and Isis::ControlMeasure::SetRejected().

Referenced by Isis::ControlNet::ClearJigsawRejected().

ControlPoint::Status Isis::ControlPoint::ComputeApriori ( )

This method computes the apriori lat/lon for a point.

It computes this by determining the average lat/lon of all the measures. Note that this does not change ignored, or fixed points. Also, it does not use unmeasured or ignored measures when computing the lat/lon.

References _FILEINFO_, Isis::ControlPoint::RadiusSource::AverageOfMeasures, Isis::ControlPoint::SurfacePointSource::AverageOfMeasures, cam, Isis::ControlMeasure::Camera(), Isis::Sensor::Coordinate(), Isis::Camera::DistortionMap(), Fixed, GetId(), Isis::ControlMeasure::GetLine(), GetMeasure(), Isis::ControlMeasure::GetSample(), GetType(), Isis::SurfacePoint::GetX(), Isis::SurfacePoint::GetY(), Isis::ControlMeasure::IsIgnored(), IsLatitudeConstrained(), IsRadiusConstrained(), Isis::Displacement::Kilometers, NumberOfConstrainedCoordinates(), Isis::IException::Programmer, SetAprioriRadiusSource(), SetAprioriSurfacePointSource(), Isis::ControlMeasure::SetFocalPlaneMeasured(), Isis::Camera::SetImage(), Isis::SurfacePoint::SetRectangular(), Success, Isis::CameraDistortionMap::UndistortedFocalPlaneX(), Isis::CameraDistortionMap::UndistortedFocalPlaneY(), Isis::IException::User, Isis::SurfacePoint::Valid(), x, and y.

Referenced by Isis::ControlNet::ComputeApriori().

ControlPoint::Status Isis::ControlPoint::ComputeResiduals ( )

This method computes the BundleAdjust residuals for a point.

*** Warning: Only BundleAdjust and its applications should be using this method.

History:: 2008-07-17 Tracie Sucharski, Added ptid and measure serial number to the unable to map to surface error.

History:: 2009-12-06 Tracie Sucharski, Renamed from ComputeErrors

History:: 2010-08-05 Tracie Sucharski, Changed lat/lon/radius to x/y/z

History:: 2010-12-10 Debbie A. Cook, Revised error calculation for radar because it was always reporting line errors=0.

History:: 2011-03-17 Debbie A. Cook, Fixed typo in radar call to get longitude

History:: 2011-03-24 Debbie A. Cook, Removed IsMeasured check since it was really checking for Candidate measures.

History:: 2011-07-01 Debbie A. Cook, Removed editLock check to allow BundleAdjust to compute residuals for editLocked points

History:: 2012-01-18 Debbie A. Cook, Revised to call ComputeResidualsMillimeters() to avoid duplication of code

ControlPoint::Status Isis::ControlPoint::ComputeResiduals_Millimeters ( )

This method computes the residuals for a point.

History:: 2008-07-17 Tracie Sucharski - Added ptid and measure serial number to the unable to map to surface error.

History:: 2010-12-06 Tracie Sucharski - Renamed from ComputeErrors

History:: 2011-03-19 Debbie A. Cook - Changed to use the Camera classes like ComputeResiduals and get the correct calculations for each camera type.

History:: 2011-03-24 Debbie A. Cook - Removed IsMeasured check since it was really checking for Candidate measures.

History:: 2012-01-18 Debbie A. Cook - Made radar case the same as other instruments and removed incorrect call to SetResidual, which was setting focal plane residuals in x and y instead of image residuals in sample and line.

References cam, Isis::ControlMeasure::Camera(), Failure, GetAdjustedSurfacePoint(), Isis::Camera::GetCameraType(), Isis::ControlMeasure::GetLine(), Isis::ControlMeasure::GetSample(), Isis::CameraGroundMap::GetXY(), Isis::Camera::GroundMap(), Isis::ControlMeasure::IsIgnored(), IsIgnored(), Isis::ControlMeasure::SetFocalPlaneComputed(), Isis::Camera::SetImage(), and Success.

Referenced by ComputeResiduals().

int Isis::ControlPoint::Delete ( int index )

Remove a measurement from the control point, deleting reference measure is allowed.

Parameters:

index

The index of the control measure to delete

References _FILEINFO_, Delete(), and Isis::IException::Programmer.

int Isis::ControlPoint::Delete ( QString serialNumber )

Remove a measurement from the control point, deleting reference measure is allowed.

Parameters:

serialNumber

The serial number of the measure to delete

References Isis::ControlMeasure::IsEditLocked(), Isis::ControlMeasure::IsIgnored(), IsIgnored(), Isis::ControlMeasure::MeasureLocked, and Isis::ControlMeasure::Success.

int Isis::ControlPoint::Delete ( ControlMeasure * measure )

Remove a measurement from the control point, deleting reference measure is allowed.

Parameters:

measure

The measure to delete

References ASSERT, and Isis::ControlMeasure::GetCubeSerialNumber().

Referenced by Delete(), Isis::ControlNet::DeleteMeasuresWithId(), Isis::MatchTool::deletePoint(), and operator=().

SurfacePoint Isis::ControlPoint::GetAdjustedSurfacePoint ( ) const

Referenced by ComputeResiduals_Millimeters(), Isis::ControlNetFilter::PointDistanceFilter(), Isis::ControlNetFilter::PointLatLonFilter(), and ToFileEntry().

ControlPoint::RadiusSource::Source Isis::ControlPoint::GetAprioriRadiusSource ( ) const

Referenced by ToFileEntry().

QString Isis::ControlPoint::GetAprioriRadiusSourceFile ( ) const

Referenced by ToFileEntry().

SurfacePoint Isis::ControlPoint::GetAprioriSurfacePoint ( ) const

Referenced by ToFileEntry().

ControlPoint::SurfacePointSource::Source Isis::ControlPoint::GetAprioriSurfacePointSource ( ) const

Referenced by Isis::InterestOperator::FindCnetRef(), and ToFileEntry().

QString Isis::ControlPoint::GetAprioriSurfacePointSourceFile ( ) const

Referenced by ToFileEntry().

SurfacePoint Isis::ControlPoint::GetBestSurfacePoint ( ) const

Returns the adjusted surface point if it exists, otherwise returns the a priori surface point.

References Isis::SurfacePoint::Valid().

QString Isis::ControlPoint::GetChooserName ( ) const

References Isis::Application::Name().

Referenced by ToFileEntry().

QList< QString > Isis::ControlPoint::getCubeSerialNumbers ( ) const

Returns:: A list of cube serial numbers

Referenced by Isis::ControlNet::SetImages().

QString Isis::ControlPoint::GetDateTime ( ) const

References Isis::Application::DateTime().

Referenced by ToFileEntry().

QString Isis::ControlPoint::GetId ( ) const

Return the Id of the control point.

Returns:: Control Point Id

double Isis::ControlPoint::GetLineResidualRms ( ) const

Get rms of line residuals.

Returns:: The rms of line residuals

References Isis::Statistics::AddData(), Isis::ControlMeasure::GetLineResidual(), GetMeasure(), Isis::ControlMeasure::IsIgnored(), Isis::ControlMeasure::IsRejected(), Isis::Statistics::Rms(), and stats.

ControlMeasure * Isis::ControlPoint::GetMeasure ( int index )

References _FILEINFO_, GetMeasure(), and Isis::IException::Programmer.

const ControlMeasure * Isis::ControlPoint::GetMeasure ( int index ) const

References _FILEINFO_, GetMeasure(), and Isis::IException::Programmer.

ControlMeasure * Isis::ControlPoint::GetMeasure ( QString serialNumber )

Get a control measure based on its cube's serial number.

Parameters:

serialNumber

serial number of measure to get

Returns:: control measure with matching serial number

const ControlMeasure * Isis::ControlPoint::GetMeasure ( QString serialNumber ) const

Get a control measure based on its cube's serial number.

Parameters:

serialNumber

serial number of measure to get

Returns:: const control measure with matching serial number

QList< ControlMeasure * > Isis::ControlPoint::getMeasures ( bool excludeIgnored = false ) const

Parameters:

excludeIgnored

Ignored measures are excluded if this is true. It is false by default.

Returns:: A list of this points measures

References Isis::ControlMeasure::IsIgnored().

Referenced by Isis::ControlNet::AddPoint(), Isis::ControlNet::DeletePoint(), Isis::ControlNet::operator=(), and Isis::ControlPointGraphicsItem::paint().

int Isis::ControlPoint::GetNumberOfRejectedMeasures ( ) const

Get the number of rejected measures on the control point.

Returns:: The number of rejected measures on this control point

int Isis::ControlPoint::GetNumLockedMeasures ( ) const

Returns the number of locked control measures.

Returns:: Number of locked control measures

References size.

Referenced by Isis::InterestOperator::FindCnetRef(), Isis::ControlNetStatistics::GeneratePointStats(), Isis::ControlNet::GetNumEditLockMeasures(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::ControlNetFilter::PointEditLockFilter(), Isis::ControlNetFilter::PointGoodnessOfFitFilter(), Isis::ControlNetFilter::PointNumMeasuresEditLockFilter(), and Isis::ControlNetFilter::PointStats().

int Isis::ControlPoint::GetNumMeasures ( ) const

int Isis::ControlPoint::GetNumValidMeasures ( ) const

Returns:: Number of valid control measures

References size.

Referenced by Isis::ControlNetStatistics::GeneratePointStats(), Isis::ControlNet::GetNumIgnoredMeasures(), Isis::ControlNet::GetNumValidMeasures(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::ControlNetFilter::PointEditLockFilter(), Isis::ControlNetFilter::PointGoodnessOfFitFilter(), and Isis::ControlNetFilter::PointStats().

QString Isis::ControlPoint::GetPointTypeString ( ) const

Obtain a string representation of the PointType.

Returns:: A string representation of the PointType

References GetType(), and PointTypeToString().

QString Isis::ControlPoint::GetRadiusSourceString ( ) const

Obtain a string representation of the RadiusSource.

Returns:: A string representation of the RadiusSource

References RadiusSourceToString().

QString Isis::ControlPoint::GetReferenceSN ( ) const

Returns:: The cube serial number of the reference measure

References _FILEINFO_, Isis::ControlMeasure::GetCubeSerialNumber(), GetId(), and Isis::IException::Programmer.

ControlMeasure * Isis::ControlPoint::GetRefMeasure ( )

Get the measure that is the reference directly.

References _FILEINFO_, GetId(), and Isis::IException::Programmer.

const ControlMeasure * Isis::ControlPoint::GetRefMeasure ( ) const

Get the reference control measure.

Returns:: const reference measure for this point

References _FILEINFO_, GetId(), and Isis::IException::Programmer.

Referenced by Isis::MatchTool::deletePoint(), Isis::InterestOperator::FindCnetRef(), Isis::ControlMeasure::IsEditLocked(), Isis::ControlNetFilter::PointDistanceFilter(), Isis::ControlNetFilter::PointGoodnessOfFitFilter(), Isis::ControlNetFilter::PointLatLonFilter(), Isis::ControlNetFilter::PointMeasurePropertiesFilter(), Isis::ControlNetFilter::PointMeasuresFilter(), Isis::ControlNetFilter::PointNumMeasuresEditLockFilter(), Isis::ControlNetFilter::PointPixelShiftFilter(), and Isis::ControlNetFilter::PointResMagnitudeFilter().

double Isis::ControlPoint::GetResidualRms ( ) const

Get rms of residuals.

Returns:: The rms of residuals

References Isis::Statistics::AddData(), Isis::ControlMeasure::GetLineResidual(), GetMeasure(), Isis::ControlMeasure::GetSampleResidual(), Isis::ControlMeasure::IsIgnored(), Isis::ControlMeasure::IsRejected(), Isis::Statistics::Rms(), and stats.

double Isis::ControlPoint::GetSampleResidualRms ( ) const

Get rms of sample residuals.

Returns:: The rms of sample residuals

References Isis::Statistics::AddData(), GetMeasure(), Isis::ControlMeasure::GetSampleResidual(), Isis::ControlMeasure::IsIgnored(), Isis::ControlMeasure::IsRejected(), Isis::Statistics::Rms(), and stats.

Statistics Isis::ControlPoint::GetStatistic ( long dataType ) const

References Isis::Statistics::AddData(), Isis::ControlMeasure::GetLogData(), Isis::ControlMeasureLogData::GetNumericalValue(), Isis::ControlMeasure::IsIgnored(), and stats.

Statistics Isis::ControlPoint::GetStatistic ( double(ControlMeasure::*)() const statFunc ) const

This function will call a given method on every control measure that this point has.

Parameters:

statFunc

The function to use for data collection

Returns:: The gathered statistic

History:: 2011-03-08 Debbie A. Cook - Changed to get statistics for all point types and not just Candidate.

References Isis::Statistics::AddData(), Isis::ControlMeasure::IsIgnored(), and stats.

Referenced by Isis::ControlNet::AverageResidual(), and Isis::ControlNet::GetMaximumResidual().

QString Isis::ControlPoint::GetSurfacePointSourceString ( ) const

Obtain a string representation of the SurfacePointSource.

Returns:: A string representation of the SurfacePointSource

References SurfacePointSourceToString().

ControlPoint::PointType Isis::ControlPoint::GetType ( ) const

Returns:: this point't type

bool Isis::ControlPoint::HasAprioriCoordinates ( )

References Isis::SurfacePoint::GetX(), Isis::SurfacePoint::GetY(), Isis::SurfacePoint::GetZ(), and Isis::Displacement::isValid().

bool Isis::ControlPoint::HasSerialNumber ( QString serialNumber ) const

Return true if given serial number exists in point.

Parameters:

serialNumber

The serial number

Returns:: True if point contains serial number, false if not

Referenced by Isis::StereoTool::paintViewport().

int Isis::ControlPoint::IndexOf	(	QString	sn,
		bool	throws = `true`
	)			const

Parameters:

	sn	The serial number of the control measure to find the index of
	throws	Throws an exception on failure instead of returning -1. Be aware that by default this is true!

Returns:: The index of the measure with serial number matching sn, or -1 on failure if throws is false.

References _FILEINFO_, and Isis::IException::Programmer.

int Isis::ControlPoint::IndexOf	(	ControlMeasure *	cm,
		bool	throws = `true`
	)			const

Parameters:

	cm	The control measure to find the index of
	throws	Throws an exception on failure instead of returning -1. Be aware that by default this is true!

Returns:: The index of the passed in measure, or -1 on failure if throws is false.

References ASSERT, and Isis::ControlMeasure::GetCubeSerialNumber().

int Isis::ControlPoint::IndexOfRefMeasure ( ) const

Parameters:

throws

Throws an exception on failure instead of returning -1. Be aware that by default this is true!

Returns:: The index of the reference measure, or -1 if no measures exist in the point (A point with at least one measure ALWAYS has a reference measure.

References _FILEINFO_, ASSERT, Isis::ControlMeasure::GetCubeSerialNumber(), and Isis::IException::Programmer.

Referenced by Isis::InterestOperator::FindCnetRef(), and ToFileEntry().

bool Isis::ControlPoint::IsConstrained ( )

bool Isis::ControlPoint::IsEditLocked ( ) const

bool Isis::ControlPoint::IsFixed ( ) const

References Fixed.

bool Isis::ControlPoint::IsIgnored ( ) const

Referenced by Isis::ControlNet::AverageResidual(), Isis::ControlNet::ComputeApriori(), ComputeResiduals(), ComputeResiduals_Millimeters(), Isis::ControlPointGraphicsItem::ControlPointGraphicsItem(), Isis::ControlNetFilter::CubeDistanceFilter(), Delete(), Isis::ControlNet::DeletePoint(), Isis::InterestOperator::FindCnetRef(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::ControlNetStatistics::GeneratePointStats(), Isis::ControlNet::GetNumValidMeasures(), Isis::ControlNet::GetNumValidPoints(), Isis::BundleAdjust::GetSparseParameterCorrections(), Isis::ControlNet::operator=(), Isis::ChipViewport::paintEvent(), Isis::StereoTool::paintViewport(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::ControlNetFilter::PointEditLockFilter(), Isis::ControlNetFilter::PointGoodnessOfFitFilter(), Isis::ControlNetFilter::PointPixelShiftFilter(), Isis::ControlNetFilter::PointPropertiesFilter(), Isis::ControlNetFilter::PointResMagnitudeFilter(), Isis::ControlNetFilter::PointStats(), Isis::ControlMeasure::SetIgnored(), Isis::ControlNet::sortedMeasureList(), ToFileEntry(), and Isis::MatchTool::updatePointInfo().

bool Isis::ControlPoint::IsInvalid ( ) const

Referenced by Isis::ControlNet::DeletePoint().

bool Isis::ControlPoint::IsLatitudeConstrained ( )

References LatitudeConstrained.

Referenced by ComputeApriori().

bool Isis::ControlPoint::IsLongitudeConstrained ( )

References LongitudeConstrained.

bool Isis::ControlPoint::IsRadiusConstrained ( )

References RadiusConstrained.

Referenced by ComputeApriori().

bool Isis::ControlPoint::IsReferenceExplicit ( ) const

Returns:: true Returns true if SetRefMeasure has ever been set on this point.

Referenced by Isis::MatchTool::deletePoint().

bool Isis::ControlPoint::IsRejected ( ) const

Referenced by ToFileEntry().

bool Isis::ControlPoint::IsValid ( ) const

void Isis::ControlPoint::Load ( PvlObject & p )

Loads the PvlObject into a ControlPoint.

Parameters:

	p	PvlObject containing ControlPoint information
	forceBuild	Allows invalid Control Measures to be added to this Control Point

Exceptions:

	Isis::iException::User	- Invalid Point Type
	Isis::iException::User	- Unable to add ControlMeasure to Control Point

History:: 2008-06-18 Tracie Sucharski/Jeannie Walldren, Fixed bug with checking for "True" vs "true", change to lower case for comparison.

History:: 2009-12-29 Tracie Sucharski - Added new ControlPoint information.

History:: 2010-01-13 Tracie Sucharski - Changed from Set methods to simply setting private variables to increase speed?

History:: 2010-07-30 Tracie Sucharski, Updated for changes made after additional working sessions for Control network design.

History:: 2010-09-01 Tracie Sucharski, Add checks for AprioriLatLonSource AprioriLatLonSourceFile. If there are AprioriSigmas,but no AprioriXYZ, use the XYZ values.

History:: 2010-09-15 Tracie Sucharski, It was decided after mtg with Debbie, Stuart, Ken and Tracie that ControlPoint will only function with x/y/z, not lat/lon/radius. It will be the responsibility of the application or class using ControlPoint to set up a SurfacePoint object to do conversions between x/y/z and lat/lon/radius. So... remove all conversion methods from this class. It was also decided that when importing old networks that contain Sigmas, the sigmas will not be imported , due to conflicts with the units of the sigmas,we cannot get accurate x,y,z sigams from the lat,lon,radius sigmas without the covariance matrix.

History:: 2010-09-28 Tracie Sucharski, Added back the conversion methods from lat,lon,radius to x,y,z only for the point, since that is what most applications need.

History:: 2010-12-02 Debbie A. Cook, Added units to SurfacePoint.SetSpherical calls.

History:: 2011-03-12 Debbie A. Cook, Added targetRadius to do conversions

int Isis::ControlPoint::NumberOfConstrainedCoordinates ( )

Referenced by ComputeApriori().

bool Isis::ControlPoint::operator!= ( const ControlPoint & other ) const

Compare two Control Points for inequality.

Parameters:

other

The other point to compare this one to

Returns:: true if the two points are not equal, and false otherwise

const ControlPoint & Isis::ControlPoint::operator= ( const ControlPoint & other )

Parameters:

pPoint

Returns:: ControlPoint&

References Delete(), and SetRefMeasure().

bool Isis::ControlPoint::operator== ( const ControlPoint & other ) const

Compare two Control Points for equality.

Parameters:

other

The other point to compare to

Returns:: true if the two points are equal, and false otherwise

References GetNumMeasures().

ControlMeasure * Isis::ControlPoint::operator[] ( int index )

Same as GetMeasure (provided for convenience).

Parameters:

index

If there are n measures, the measure returned will be the ith measure added to the point

Returns:: The measure which has the provided serial number

References GetMeasure().

const ControlMeasure * Isis::ControlPoint::operator[] ( int index ) const

Same as GetMeasure (provided for convenience).

Parameters:

index

If there are n measures, the measure returned will be the ith measure added to the point

Returns:: const version of the measure which has the provided serial number

References GetMeasure().

ControlMeasure * Isis::ControlPoint::operator[] ( QString serialNumber )

Same as GetMeasure (provided for convenience).

Parameters:

serialNumber

Cube serial number of desired control measure

Returns:: The measure which has the provided serial number

References GetMeasure().

const ControlMeasure * Isis::ControlPoint::operator[] ( QString serialNumber ) const

Same as GetMeasure (provided for convenience).

Parameters:

serialNumber

Cube serial number of desired control measure

Returns:: const version of the measure which has the provided serial number

References GetMeasure().

ControlNet* Isis::ControlPoint::Parent ( ) [inline]

Referenced by Isis::MatchTool::deletePoint(), Isis::MatchTool::modifyPoint(), and Isis::ControlMeasure::SetIgnored().

QString Isis::ControlPoint::PointTypeToString ( PointType pointType ) [static]

Obtain a string representation of a given PointType.

Parameters:

type

PointType to convert to a string

Returns:: A string representation of type

References Constrained, Fixed, Free, and str.

Referenced by GetPointTypeString().

QString Isis::ControlPoint::RadiusSourceToString ( RadiusSource::Source source ) [static]

Obtain a string representation of a given RadiusSource.

Parameters:

source

RadiusSource to convert to string

Returns:: A string representation of RadiusSource

References Isis::ControlPoint::RadiusSource::AverageOfMeasures, Isis::ControlPoint::RadiusSource::BundleSolution, Isis::ControlPoint::RadiusSource::DEM, Isis::ControlPoint::RadiusSource::Ellipsoid, Isis::ControlPoint::RadiusSource::None, str, and Isis::ControlPoint::RadiusSource::User.

Referenced by GetRadiusSourceString().

ControlPoint::Status Isis::ControlPoint::ResetApriori ( )

Reset all the Apriori info to defaults.

Author:: Sharmila Prasad (10/22/2010)

References IsEditLocked(), Isis::ControlPoint::RadiusSource::None, Isis::ControlPoint::SurfacePointSource::None, PointLocked, and Success.

ControlPoint::Status Isis::ControlPoint::SetAdjustedSurfacePoint ( SurfacePoint newSurfacePoint )

Set or update the surface point relating to this control point.

This is the point on the surface of the planet that the measures are tied to. This updates the last modified attributes of this point. *** Warning: Only BundleAdjust and its applications should be using this method.

Parameters:

newSurfacePoint

The point on the target's surface the measures are tied to

References Success.

ControlPoint::Status Isis::ControlPoint::SetAprioriRadiusSource ( RadiusSource::Source source )

This updates the source of the radius of the apriori surface point.

See also:: RadiusSource::Source

Parameters:

source

Where the radius came from

References PointLocked, and Success.

Referenced by ComputeApriori().

ControlPoint::Status Isis::ControlPoint::SetAprioriRadiusSourceFile ( QString sourceFile )

This updates the filename of the DEM that the apriori radius came from.

It doesn't really make sense to call this unless the RadiusSource is DEM.

See also:: RadiusSource::Source

Parameters:

source

Where the radius came from

References PointLocked, and Success.

ControlPoint::Status Isis::ControlPoint::SetAprioriSurfacePoint ( SurfacePoint aprioriSP )

This updates the apriori surface point.

See also:: SetAprioriRadiusSource; SetAprioriRadiusSourceFile; SetAprioriPointSource; SetAprioriPointSourceFile; aprioriSurfacePoint

Parameters:

aprioriSP

The apriori surface point to remember

References Isis::SurfacePoint::GetLatSigma(), Isis::SurfacePoint::GetLocalRadiusSigma(), Isis::SurfacePoint::GetLonSigma(), Isis::ControlNet::GetTargetRadii(), Isis::Distance::isValid(), Isis::Angle::isValid(), LatitudeConstrained, LongitudeConstrained, PointLocked, RadiusConstrained, Isis::SurfacePoint::SetRadii(), and Success.

Referenced by Isis::StereoTool::createPoint().

ControlPoint::Status Isis::ControlPoint::SetAprioriSurfacePointSource ( SurfacePointSource::Source source )

This updates the source of the surface point.

See also:: SurfacePointSource::Source

Parameters:

source

Where the surface point came from

References PointLocked, and Success.

Referenced by ComputeApriori().

ControlPoint::Status Isis::ControlPoint::SetAprioriSurfacePointSourceFile ( QString sourceFile )

This updates the filename of where the apriori surface point came from.

See also:: RadiusSource::Source

Parameters:

sourceFile

Where the surface point came from

References PointLocked, and Success.

ControlPoint::Status Isis::ControlPoint::SetChooserName ( QString name )

Set the point's chooser name.

This will be lost if any attributes relating to this point is later changed and the current user will be set. This is one of the 'last modified attributes' referred to in other comments.

Parameters:

name

The username of the person who last modified this control point

References PointLocked, and Success.

Referenced by Isis::MatchTool::createPoint().

ControlPoint::Status Isis::ControlPoint::SetDateTime ( QString newDateTime )

Set the point's last modified time.

This will be lost if any attributes relating to this point are later changed and the current time will be set. This is one of the 'last modified attributes' referred to in other comments.

Parameters:

newDateTime

The date and time this control point was last modified

References PointLocked, and Success.

ControlPoint::Status Isis::ControlPoint::SetEditLock ( bool lock )

Set the EditLock state.

If edit lock is on, then most attributes relating to this point are not modifiable. Edit lock is like "Don't modify my attributes, but you can still modify my measures' attributes". The reference measure is implicitely edit locked if the point is edit locked.

Parameters:

lock

True to enable edit lock, false to disable it and allow the point to be modified.

References Success.

Referenced by Isis::MatchTool::updatePointInfo().

ControlPoint::Status Isis::ControlPoint::SetId ( QString newId )

Sets the Id of the control point.

Parameters:

id

Control Point Id

Returns:: (int) status Success or PointLocked

References PointLocked, and Success.

ControlPoint::Status Isis::ControlPoint::SetIgnored ( bool newIgnoreStatus )

Set whether to ignore or use control point.

Parameters:

newIgnoreStatus

True to ignore this Control Point, False to un-ignore

References Isis::ControlMeasure::IsIgnored(), PointLocked, and Success.

Referenced by Isis::InterestOperator::FindCnetRef(), Isis::InterestOperator::ProcessLocked_Point_Reference(), and Isis::MatchTool::updatePointInfo().

void Isis::ControlPoint::SetNumberOfRejectedMeasures ( int numRejected )

Set (update) the number of rejected measures for the control point.

Parameters:

numRejected

The number of rejected measures

ControlPoint::Status Isis::ControlPoint::SetRefMeasure ( QString sn )

Set the points reference measure.

Parameters:

sn

The serial number of the new reference measure

References _FILEINFO_, PointLocked, Isis::IException::Programmer, and Success.

ControlPoint::Status Isis::ControlPoint::SetRefMeasure ( int index )

Set the point's reference measure.

Parameters:

index

The index of the new reference measure

References _FILEINFO_, PointLocked, Isis::IException::Programmer, and Success.

ControlPoint::Status Isis::ControlPoint::SetRefMeasure ( ControlMeasure * cm )

Set the point's reference measure.

Parameters:

cm

The new reference measure

References ASSERT, PointLocked, and Success.

Referenced by ControlPoint(), Isis::InterestOperator::FindCnetRef(), and operator=().

ControlPoint::Status Isis::ControlPoint::SetRejected ( bool reject )

Set the jigsawRejected state.

If IsRejected is true, then this point should be ignored until the next iteration in the bundle adjustement. BundleAdjust decides when to reject or accept a point. The initial IsRejected state of a measure is false.

Parameters:

reject

True to reject a measure, false to include it in the adjustment

References Success.

Referenced by ClearJigsawRejected().

ControlPoint::Status Isis::ControlPoint::SetType ( PointType newType )

Updates the control point's type.

This updates the last modified attributes of this point.