ATP::AutoTiePoint Class Reference

Base class for all automatic tiepoints. More...

#include <AutoTiePoint.h>

Inheritance diagram for ATP::AutoTiePoint:

Public Member Functions
	AutoTiePoint ()
	AutoTiePoint (const AutoTiePoint &copy_me)
	AutoTiePoint (std::shared_ptr< AtpGenerator > generator, const std::string &id)
	Constructs given two images and a point on the REF image. More...
	AutoTiePoint (const Json::Value &tp_json_node)
	Creates new tiepoint from JSON object formatted as: { "id": <unsigned int>="">, // may be ignored if not valid "type": "M"|"A"|"G" For “manual”, “auto”, or “GCP-associated” "imagePoints: [ { "imageId": <string>, "x": <double>, "y": <double>, "covariance": [ cxx, cyy, cxy ], "gcpId": <string> Only if associated with a GCP } ] }. More...
virtual	~AutoTiePoint ()
void	setRefImagePt (const ossimDpt &imagePt)
	Sets the reference image's image point (in image space) for this tiepoint. More...
void	setRefViewPt (const ossimDpt &viewPt)
	Sets the reference image's view point (in view space) for this tiepoint. More...
bool	getVectorResidual (ossimDpt &residual) const
	Returns the vector residual (CMP-REF) of current active peak (in view space) via argument. More...
bool	getRefImagePoint (ossimDpt &image_pt) const
	Returns the center location of the reference patch (the feature) in image-space. More...
bool	getCmpImagePoint (ossimDpt &image_pt) const
	Fetches the comparison image point for current best peak. Returns false if no valid peak. More...
virtual std::ostream &	print (std::ostream &out) const
	Stream output dump of object. More...
std::vector< MatchPoint > &	matchPoints ()
	Access to peaks list for GUI debug display. More...
void	addImageMatch (const ossimDpt &cmpPt, double confidenceValue=1.0)
	Inserts match in image space by confidence in descending order. More...
void	addViewMatch (const ossimDpt &cmpViewPt, double confidenceValue=1.0)
	Inserts match in image space by confidence in descending order. More...
unsigned int	getNumMatches () const
	Returns the total number of peaks in the list. More...
bool	hasValidMatch () const
	Returns true if there is a valid peak in the list. More...
bool	getConfidenceMeasure (double &confidence) const
	Returns the correlation value of current active peak via argument. Returns true if valid. More...
bool	getRefViewPoint (ossimDpt &view_pt) const
	Returns the center location of the reference patch (the feature) in view-space. More...
bool	getRefGroundPoint (ossimGpt &gpt) const
	Returns the center location of the reference patch (the feature) in geographic. More...
bool	getCmpViewPoint (ossimDpt &view_pt, unsigned int peak_idx=0) const
	Fetches the comparison view point for current best peak, or for the peak indicated if provided. More...
bool	bumpActiveMatch ()
	Removes the active match and sets the next peak as active. More...
virtual void	saveJSON (Json::Value &json) const
Public Member Functions inherited from ossim::TiePoint
	TiePoint ()
	TiePoint (const TiePoint &copy)
	TiePoint (const Json::Value &tp_json_node)
	Creates new tiepoint from JSON object formatted as: { "id": <unsigned int>="">, // may be ignored if not valid "type": "M"|"A"|"G" For “manual”, “auto”, or “GCP-associated” "imagePoints: [ { "imageId": <string>, "x": <double>, "y": <double>, "covariance": [ cxx, cyy, cxy ], "gcpId": <string> Only if associated with a GCP } ] }. More...
virtual	~TiePoint ()
unsigned int	getImageCount () const
const std::string &	getTiePointId () const
void	setTiePointId (const std::string &id)
void	getImagePoint (unsigned int index, std::string &imageId, ossimDpt &imagePoint, NEWMAT::SymmetricMatrix &cov) const
	Fetches the image point coordinates along with image ID and GCP ID if available. More...
void	setImagePoint (std::shared_ptr< Image > image, const ossimDpt &imagePoint, const NEWMAT::SymmetricMatrix &cov)
	Sets image point value and associated measurement covariance for specified image ID. More...
Type	getType () const
void	setType (Type t)
const std::string &	getGcpId () const
void	setGcpId (const std::string &id)
virtual void	loadJSON (const Json::Value &json)
Public Member Functions inherited from ossim::JsonInterface
	JsonInterface ()
virtual	~JsonInterface ()

Protected Member Functions
virtual void	recomputeResidual ()
	Recomputes active peak's residual after a model adjustment or change in peak. More...

Protected Attributes
std::shared_ptr< AtpGenerator >	m_generator
std::vector< MatchPoint >	m_matchPoints
ossimDpt	m_refViewPt
ossimDpt	m_cmpViewPt
ossimDpt	m_residual
double	m_relativeError
	Uncertainty in position of feature in CMP image. More...
Protected Attributes inherited from ossim::TiePoint
Type	m_type
std::string	m_tiePointId
std::vector< std::shared_ptr< Image > >	m_images
std::vector< ossimDpt >	m_imagePoints
std::vector< NEWMAT::SymmetricMatrix >	m_covariances
double	m_gsd
std::string	m_gcpId

Additional Inherited Members
Public Types inherited from ossim::TiePoint
enum	Type { UNASSIGNED, MANUAL, AUTO, GCP }
Static Protected Attributes inherited from ossim::TiePoint
static int	s_runningId = 1

Detailed Description

Base class for all automatic tiepoints.

These differ from tiepoint base class in that it is guarantied to represent a single image pair. Therefore, residuals between the pair can be computed without referencing image ids, etc. TODO: Eventually need to generalize to permit N-way auto-tiepoints, at which point it should merge with TiePoint base class.

Definition at line 30 of file AutoTiePoint.h.

Constructor & Destructor Documentation

AutoTiePoint() [1/4]

ATP::AutoTiePoint::AutoTiePoint

(

)

Definition at line 18 of file AutoTiePoint.cpp.

: m_relativeError(0),
  m_generator(0)
{
}

AutoTiePoint() [2/4]

ATP::AutoTiePoint::AutoTiePoint

(

const AutoTiePoint &

copy_me

)

Definition at line 24 of file AutoTiePoint.cpp.

References m_matchPoints.

        : TiePoint (copy),
          m_generator(copy.m_generator),
          m_refViewPt(copy.m_refViewPt),
          m_cmpViewPt(copy.m_cmpViewPt),
          m_residual(copy.m_residual),
          m_relativeError(copy.m_relativeError)
{
   for (size_t i=0; i<copy.m_matchPoints.size(); ++i)
      m_matchPoints.push_back(copy.m_matchPoints[i]);
}

AutoTiePoint() [3/4]

ATP::AutoTiePoint::AutoTiePoint	(	std::shared_ptr< AtpGenerator >	generator,
		const std::string &	id
	)

Constructs given two images and a point on the REF image.

The matching is still to be established.

Parameters

overlap

The combiner source representing the overlap between REF and CMP images. Tie point ID

AutoTiePoint() [4/4]

ATP::AutoTiePoint::AutoTiePoint

(

const Json::Value &

tp_json_node

)

Creates new tiepoint from JSON object formatted as: { "id": <unsigned int>="">, // may be ignored if not valid "type": "M"|"A"|"G" For “manual”, “auto”, or “GCP-associated” "imagePoints: [ { "imageId": <string>, "x": <double>, "y": <double>, "covariance": [ cxx, cyy, cxy ], "gcpId": <string> Only if associated with a GCP } ] }.

Definition at line 55 of file AutoTiePoint.cpp.

:  TiePoint(tp_json_node),
   m_relativeError(0),
   m_generator(0)
{
}

~AutoTiePoint()

ATP::AutoTiePoint::~AutoTiePoint ( )

virtual

Definition at line 62 of file AutoTiePoint.cpp.

References m_matchPoints.

{
   m_matchPoints.clear();
}

Member Function Documentation

addImageMatch()

void ATP::AutoTiePoint::addImageMatch	(	const ossimDpt &	cmpPt,
		double	confidenceValue = 1.0
	)

Inserts match in image space by confidence in descending order.

Definition at line 154 of file AutoTiePoint.cpp.

References ossim::TiePoint::m_imagePoints, m_matchPoints, m_residual, ossimDpt::makeNan(), and recomputeResidual().

Referenced by addViewMatch().

{
   // Check if we will be inserting in first position. If so, need to set m_cmpViewPt and
   // m_residual data  members to this (active) active peak info:
   if (m_matchPoints.size() == 0)
   {
      if (m_imagePoints.empty())
      {
         ossimDpt nanRefPt;
         nanRefPt.makeNan();
         m_imagePoints.push_back(nanRefPt);
      }
      if (m_imagePoints.size() == 1)
         m_imagePoints.push_back(cmpImagePt);
      else
         m_imagePoints[1] = cmpImagePt;

      recomputeResidual();
   }

   // Instantiate a new peak. Insert this peak into the map, where it is ordered by peak value:
   m_matchPoints.emplace_back(MatchPoint(cmpImagePt, confidenceValue, m_residual));
}

addViewMatch()

void ATP::AutoTiePoint::addViewMatch	(	const ossimDpt &	cmpViewPt,
		double	confidenceValue = 1.0
	)

Inserts match in image space by confidence in descending order.

Definition at line 207 of file AutoTiePoint.cpp.

References addImageMatch(), m_cmpViewPt, m_generator, and m_matchPoints.

{
   // Need to compute what the CMP image point is for the peak:
   ossimDpt cmpImagePt;
   m_generator->getCmpIVT()->viewToImage(cmpViewPt, cmpImagePt);

   // Check if we will be inserting in first position. If so, need to set m_cmpViewPt and
   // m_residual data  members to this (active) active peak info:
   if (m_matchPoints.size() == 0)
      m_cmpViewPt = cmpViewPt;

   addImageMatch(cmpImagePt, confidenceValue);
}

bumpActiveMatch()

bool ATP::AutoTiePoint::bumpActiveMatch

(

)

Removes the active match and sets the next peak as active.

Returns TRUE unless there are no more active matches.

Definition at line 192 of file AutoTiePoint.cpp.

References m_matchPoints, and recomputeResidual().

{
   m_matchPoints.erase(m_matchPoints.begin());
   if (m_matchPoints.empty())
      return false;

   recomputeResidual();
   return true;
}

getCmpImagePoint()

bool ATP::AutoTiePoint::getCmpImagePoint

(

ossimDpt &

image_pt

)

const

Fetches the comparison image point for current best peak. Returns false if no valid peak.

Definition at line 73 of file AutoTiePoint.cpp.

References ossim::TiePoint::m_imagePoints.

{
   if ((m_imagePoints.size() < 2) || m_imagePoints[1].isNan())
      return false;
   image_point = m_imagePoints[1];
   return true;
}

getCmpViewPoint()

bool ATP::AutoTiePoint::getCmpViewPoint	(	ossimDpt &	view_pt,
		unsigned int	peak_idx = 0
	)		const

Fetches the comparison view point for current best peak, or for the peak indicated if provided.

Returns false if no valid peak.

Definition at line 229 of file AutoTiePoint.cpp.

References m_cmpViewPt.

{
   if (peak_idx == 0)
   {
      view_point = m_cmpViewPt; // last known point, may be invalid.
      return true;
   }

   return false;
}

getConfidenceMeasure()

bool ATP::AutoTiePoint::getConfidenceMeasure

(

double &

confidence

)

const

Returns the correlation value of current active peak via argument. Returns true if valid.

Definition at line 178 of file AutoTiePoint.cpp.

References hasValidMatch(), and m_matchPoints.

{
   // Check for empty list or if we are at the end of the list (no points remaining):
   if ((!hasValidMatch()))
   {
      confidence = 0;
      return false;
   }

   // The first peak in the list is always the best peak:
   confidence = m_matchPoints.begin()->getConfidenceMeasure();
   return true;
}

getNumMatches()

unsigned int ATP::AutoTiePoint::getNumMatches ( ) const

inline

Returns the total number of peaks in the list.

Definition at line 95 of file AutoTiePoint.h.

References m_matchPoints.

{ return (unsigned int) m_matchPoints.size(); }

getRefGroundPoint()

bool ATP::AutoTiePoint::getRefGroundPoint

(

ossimGpt &

gpt

)

const

Returns the center location of the reference patch (the feature) in geographic.

Returns false if point not yet defined. Note that there may not be any valid peak.

Definition at line 258 of file AutoTiePoint.cpp.

References ossimDpt::isNan(), m_generator, m_refViewPt, and ossimGpt::makeNan().

{
   gpt.makeNan();
   if (m_refViewPt.isNan())
      return false;

   m_generator->getRefIVT()->getViewGeometry()->localToWorld(m_refViewPt, gpt);
   return true;
}

getRefImagePoint()

bool ATP::AutoTiePoint::getRefImagePoint

(

ossimDpt &

image_pt

)

const

Returns the center location of the reference patch (the feature) in image-space.

Returns false if point not yet defined. Note that there not be any valid peak.

Definition at line 81 of file AutoTiePoint.cpp.

References ossim::TiePoint::m_imagePoints.

{
   if (m_imagePoints.empty() || m_imagePoints[0].isNan())
      return false;
   image_point = m_imagePoints[0];
   return true;
}

getRefViewPoint()

bool ATP::AutoTiePoint::getRefViewPoint

(

ossimDpt &

view_pt

)

const

Returns the center location of the reference patch (the feature) in view-space.

Returns false if point not yet defined. Note that there may not be any valid peak.

Definition at line 221 of file AutoTiePoint.cpp.

References ossimDpt::isNan(), and m_refViewPt.

{
   view_point = m_refViewPt;
   if (m_refViewPt.isNan())
      return false;
   return true;
}

getVectorResidual()

bool ATP::AutoTiePoint::getVectorResidual

(

ossimDpt &

residual

)

const

Returns the vector residual (CMP-REF) of current active peak (in view space) via argument.

Returns true if valid.

Definition at line 67 of file AutoTiePoint.cpp.

References m_residual.

{
   residual = m_residual;
   return true;
}

hasValidMatch()

bool ATP::AutoTiePoint::hasValidMatch

(

)

const

Returns true if there is a valid peak in the list.

Definition at line 202 of file AutoTiePoint.cpp.

References m_matchPoints.

Referenced by getConfidenceMeasure().

{
   return !m_matchPoints.empty();
}

matchPoints()

std::vector<MatchPoint>& ATP::AutoTiePoint::matchPoints ( )

inline

Access to peaks list for GUI debug display.

Definition at line 86 of file AutoTiePoint.h.

References m_matchPoints.

{ return m_matchPoints; }

print()

ostream & ATP::AutoTiePoint::print ( std::ostream &  out ) const

virtual

Stream output dump of object.

Reimplemented from ossim::TiePoint.

Definition at line 129 of file AutoTiePoint.cpp.

References DEG_PER_RAD, ossim::TiePoint::m_imagePoints, m_matchPoints, m_residual, ossim::TiePoint::m_tiePointId, ossim_hdf5::print(), ossimDpt::x, and ossimDpt::y.

{
   double azimuth = atan2(m_residual.x, - m_residual.y)*DEG_PER_RAD;
   if (azimuth < 0.0)
      azimuth += 360.0;

   out << "\nDump of AutoTiePoint ID = " << m_tiePointId;
   out << "\n  refImgPt    = " << m_imagePoints[0];
   out << "\n  residual (p) = " << m_residual;
   out << "\n  azimuth deg  = " << azimuth;
   TiePoint::print(out);
   if (m_matchPoints.size() == 0)
   {
      out<<"\n  No matches.";
   }
   else
   {
      out<<"\n  Matches:";
      for (size_t i=0; i<m_matchPoints.size(); ++i)
         out<<"\n    "<<m_matchPoints[i];
   }

   return out;
}

recomputeResidual()

void ATP::AutoTiePoint::recomputeResidual ( )

protectedvirtual

Recomputes active peak's residual after a model adjustment or change in peak.

Residuals are in view space for this type.

Definition at line 240 of file AutoTiePoint.cpp.

References m_cmpViewPt, m_generator, ossim::TiePoint::m_imagePoints, m_refViewPt, m_residual, and ossimDpt::makeNan().

Referenced by addImageMatch(), and bumpActiveMatch().

{
   if (!m_generator)
      m_residual.makeNan();

   if (m_imagePoints.size() < 2)
      return;

   // Since the REF input projection may have changed, recompute the REF view pt data member:
   m_generator->getRefIVT()->imageToView(m_imagePoints[0], m_refViewPt);

   // Establish the view-space coordinates of the peak given the peak's image point (in REF imae)
   // in order to compute residual:
   m_generator->getCmpIVT()->imageToView(m_imagePoints[1], m_cmpViewPt);

   m_residual = m_cmpViewPt - m_refViewPt;
}

saveJSON()

void ATP::AutoTiePoint::saveJSON ( Json::Value &  json ) const

virtual

Reimplemented from ossim::TiePoint.

Definition at line 109 of file AutoTiePoint.cpp.

References ossimGpt::azimuthTo(), ossimGpt::distanceTo(), m_cmpViewPt, m_generator, m_matchPoints, and m_refViewPt.

{
   TiePoint::saveJSON(json_node);// ID
   if (m_matchPoints.empty())
      return;
   json_node["confidence"] = m_matchPoints[0].getConfidenceMeasure();

   auto geom = m_generator->getRefIVT()->getViewGeometry();
   if (geom)
   {
      ossimGpt refGpt, cmpGpt;
      geom->localToWorld(m_refViewPt, refGpt);
      geom->localToWorld(m_cmpViewPt, cmpGpt);
      Json::Value residual;
      residual["range"] = refGpt.distanceTo(cmpGpt);
      residual["azimuth"] = refGpt.azimuthTo(cmpGpt);
      json_node["residual"] = residual;
   }
}

setRefImagePt()

void ATP::AutoTiePoint::setRefImagePt

(

const ossimDpt &

imagePt

)

Sets the reference image's image point (in image space) for this tiepoint.

Definition at line 89 of file AutoTiePoint.cpp.

References m_generator, ossim::TiePoint::m_imagePoints, and m_refViewPt.

{
   if (m_imagePoints.empty())
      m_imagePoints.push_back(imagePt);
   else
      m_imagePoints[0] = imagePt;
   m_generator->getRefIVT()->imageToView(imagePt, m_refViewPt);
}

setRefViewPt()

void ATP::AutoTiePoint::setRefViewPt

(

const ossimDpt &

viewPt

)

Sets the reference image's view point (in view space) for this tiepoint.

Definition at line 98 of file AutoTiePoint.cpp.

References m_generator, ossim::TiePoint::m_imagePoints, and m_refViewPt.

{
   m_refViewPt = viewPt;
   ossimDpt imagePt;
   m_generator->getRefIVT()->viewToImage(viewPt, imagePt);
   if (m_imagePoints.empty())
      m_imagePoints.push_back(imagePt);
   else
      m_imagePoints[0] = imagePt;
}

Member Data Documentation

m_cmpViewPt

ossimDpt ATP::AutoTiePoint::m_cmpViewPt

protected

Definition at line 132 of file AutoTiePoint.h.

Referenced by addViewMatch(), getCmpViewPoint(), recomputeResidual(), and saveJSON().

m_generator

std::shared_ptr<AtpGenerator> ATP::AutoTiePoint::m_generator

protected

Definition at line 129 of file AutoTiePoint.h.

Referenced by addViewMatch(), getRefGroundPoint(), recomputeResidual(), saveJSON(), setRefImagePt(), and setRefViewPt().

m_matchPoints

std::vector<MatchPoint> ATP::AutoTiePoint::m_matchPoints

protected

Definition at line 130 of file AutoTiePoint.h.

Referenced by addImageMatch(), addViewMatch(), AutoTiePoint(), bumpActiveMatch(), getConfidenceMeasure(), getNumMatches(), hasValidMatch(), matchPoints(), print(), saveJSON(), and ~AutoTiePoint().

m_refViewPt

ossimDpt ATP::AutoTiePoint::m_refViewPt

protected

Definition at line 131 of file AutoTiePoint.h.

Referenced by getRefGroundPoint(), getRefViewPoint(), recomputeResidual(), saveJSON(), setRefImagePt(), and setRefViewPt().

m_relativeError

double ATP::AutoTiePoint::m_relativeError

protected

Uncertainty in position of feature in CMP image.

Definition at line 134 of file AutoTiePoint.h.

m_residual

ossimDpt ATP::AutoTiePoint::m_residual

protected

Definition at line 133 of file AutoTiePoint.h.

Referenced by addImageMatch(), getVectorResidual(), print(), and recomputeResidual().

---

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

• AutoTiePoint.h
• AutoTiePoint.cpp