Maximum correlation pattern matching. More...

#include <MaximumCorrelation.h>

Inheritance diagram for Isis::MaximumCorrelation:

Collaboration diagram for Isis::MaximumCorrelation:

Public Types
enum	RegisterStatus { SuccessPixel, SuccessSubPixel, PatternChipNotEnoughValidData, FitChipNoData, FitChipToleranceNotMet, SurfaceModelNotEnoughValidData, SurfaceModelSolutionInvalid, SurfaceModelDistanceInvalid, PatternZScoreNotMet, AdaptiveAlgorithmFailed }
	Enumeration of the Register() method's return status. More...

enum	GradientFilterType { None, Sobel }
	Enumeration of the different types of gradient filters that can be applied to the pattern and search chips before matching them. More...

Public Member Functions
	MaximumCorrelation (Pvl &pvl)

Chip *	PatternChip ()
	Return pointer to pattern chip. More...

Chip *	SearchChip ()
	Return pointer to search chip. More...

Chip *	FitChip ()
	Return pointer to fit chip. More...

Chip *	RegistrationPatternChip ()
	Return pointer to pattern chip used in registration. More...

Chip *	RegistrationSearchChip ()
	Return pointer to search chip used in registration. More...

Chip *	ReducedPatternChip ()
	Return pointer to reduced pattern chip. More...

Chip *	ReducedSearchChip ()
	Return pointer to reduced search chip. More...

Chip *	ReducedFitChip ()
	Return pointer to reduced fit chip. More...

void	SetSubPixelAccuracy (bool on)
	If the sub-pixel accuracy is enabled, the Register() method will attempt to match the pattern chip to the search chip at sub-pixel accuracy, otherwise it will be registered at whole pixel accuracy. More...

void	SetPatternValidPercent (const double percent)
	Set the amount of data in the pattern chip that must be valid. More...

void	SetSubsearchValidPercent (const double percent)
	Set the amount of data in the search chip's subchip that must be valid. More...

void	SetTolerance (double tolerance)
	Set the tolerance for an acceptable goodness of fit. More...

void	SetChipInterpolator (const QString &interpolator)
	Sets the Chip class interpolator type to be used to load pattern and search chips. More...

void	SetSurfaceModelWindowSize (int size)
	Set the surface model window size. More...

void	SetSurfaceModelDistanceTolerance (double distance)
	Set a distance the surface model solution is allowed to move away from the best whole pixel fit in the fit chip. More...

void	SetReductionFactor (int reductionFactor)
	Set the reduction factor used to speed up the pattern matching algorithm. More...

void	SetPatternZScoreMinimum (double minimum)
	Set the minimum pattern zscore. More...

void	SetGradientFilterType (const QString &gradientFilterType)
	Set the gradient filter type to be applied to the search and pattern chips. More...

QString	GradientFilterString () const

bool	SubPixelAccuracy ()
	Return whether this object will attempt to register to whole or sub-pixel accuracy. More...

int	ReductionFactor ()
	Return the reduction factor. More...

double	PatternValidPercent () const
	Return pattern chip valid percent. The default value is. More...

double	SubsearchValidPercent () const
	Return subsearch chip valid percent. More...

double	Tolerance () const
	Return match algorithm tolerance. More...

double	WindowSize () const
	Return window size. More...

double	DistanceTolerance () const
	Return distance tolerance. More...

void	Distance (double &sampDistance, double &lineDistance)
	Return the distance point moved. More...

AutoReg::RegisterStatus	Register ()
	Walk the pattern chip through the search chip to find the best registration. More...

bool	Success () const
	Return whether the match algorithm succeeded or not. More...

double	GoodnessOfFit () const
	Return the goodness of fit of the match algorithm. More...

bool	IsIdeal (double fit)
	Returns true if the fit parameter is arbitrarily close to the ideal fit value. More...

double	ChipSample () const
	Return the search chip sample that best matched. More...

double	ChipLine () const
	Return the search chip line that best matched. More...

double	CubeSample () const
	Return the search chip cube sample that best matched. More...

double	CubeLine () const
	Return the search chip cube line that best matched. More...

double	MinimumZScore () const
	Return minimumPatternZScore. More...

void	ZScores (double &score1, double &score2) const
	Return the ZScores of the pattern chip. More...

Pvl	RegistrationStatistics ()
	This returns the cumulative registration statistics. More...

virtual double	MostLenientTolerance ()
	Minimum tolerance specific to algorithm. More...

PvlGroup	RegTemplate ()
	This function returns the keywords that this object was created from. More...

PvlGroup	UpdatedTemplate ()
	Returns a PvlGroup containing the PvlKeywords of the parameters this object was most recently run with. More...

Protected Member Functions
virtual double	MatchAlgorithm (Chip &pattern, Chip &subsearch)
	Given two identically sized chips return a double that indicates how well they match. More...

virtual bool	CompareFits (double fit1, double fit2)
	This virtual method must return if the 1st fit is equal to or better than the second fit. More...

virtual double	IdealFit () const
	Returns the ideal (perfect) fit that could be returned by the MatchAlgorithm. More...

virtual QString	AlgorithmName () const
	Returns the name of the algorithm. More...

void	SetChipSample (double sample)
	Sets the search chip subpixel sample that matches the pattern tack sample. More...

void	SetChipLine (double line)
	Sets the search chip subpixel line that matches the pattern tack line. More...

void	SetGoodnessOfFit (double fit)
	Sets the goodness of fit for adaptive algorithms. More...

virtual AutoReg::RegisterStatus	Registration (Chip &sChip, Chip &pChip, Chip &fChip, int startSamp, int startLine, int endSamp, int endLine, int bestSamp, int bestLine)
	Performs matching between the pattern and search at both whole-pixel and subpixel levels. More...

void	Parse (Pvl &pvl)
	Initialize parameters in the AutoReg class using a PVL specification. More...

bool	SetSubpixelPosition (Chip &window)
	Set the search chip sample and line to subpixel values if possible. More...

Chip	Reduce (Chip &chip, int reductionFactor)
	This method reduces the given chip by the given reduction factor. More...

virtual Pvl	AlgorithmStatistics (Pvl &pvl)
	Provide (adaptive) algorithms a chance to report results. More...

Protected Attributes
PvlObject	p_template
	AutoRegistration object that created this projection. More...

Detailed Description

Maximum correlation pattern matching.

This class is used to construct a maximum correlation pattern matching algorith. That is, given a search chip and a pattern chip, the pattern chip is walked through the search chip. At each position the a sub-search chip is extracted which is the same size as the pattern chip. Then the correlation between the two is computed. The best fit = 1.0 which means the pattern chip and sub-search chip are identical

See also: MinimumDifference AutoReg

Author: ????-??-?? Unknown

History:

2006-01-11 Jacob Danton Added idealFit value, unitTest

2006-03-08 Jacob Danton Added sampling options

Definition at line 52 of file MaximumCorrelation.h.

Member Enumeration Documentation

◆ GradientFilterType

enum Isis::AutoReg::GradientFilterType

inherited

Enumeration of the different types of gradient filters that can be applied to the pattern and search chips before matching them.

Enumerator
None	default, no gradient filter
Sobel	Sobel gradient filter.

Definition at line 212 of file AutoReg.h.

◆ RegisterStatus

enum Isis::AutoReg::RegisterStatus

inherited

Enumeration of the Register() method's return status.

All of the enumerations describe a failure to register except "Success". These status values can be used to provide the user with more specific feedback on why registration did not succeed.

Enumerator
SuccessPixel	Success registering to whole pixel.
SuccessSubPixel	Success registering to sub-pixel accuracy.
PatternChipNotEnoughValidData	Not enough valid data in pattern chip.
FitChipNoData	Fit chip did not have any valid data.
FitChipToleranceNotMet	Goodness of fit tolerance not satisfied.
SurfaceModelNotEnoughValidData	Not enough points to fit a surface model for sub-pixel accuracy.
SurfaceModelSolutionInvalid	Could not model surface for sub-pixel accuracy.
SurfaceModelDistanceInvalid	Surface model moves registration more than one pixel.
PatternZScoreNotMet	Pattern data max or min does not pass the z-score test.
AdaptiveAlgorithmFailed	Error occured in Adaptive algorithm.

Definition at line 195 of file AutoReg.h.

Member Function Documentation

◆ AlgorithmName()

virtual QString Isis::MaximumCorrelation::AlgorithmName ( ) const

inlineprotectedvirtual

Returns the name of the algorithm.

Returns: QString

Implements Isis::AutoReg.

Definition at line 63 of file MaximumCorrelation.h.

◆ AlgorithmStatistics()

virtual Pvl Isis::AutoReg::AlgorithmStatistics ( Pvl & pvl )

inlineprotectedvirtualinherited

Provide (adaptive) algorithms a chance to report results.

Provide Adaptive objects the opportunity to report behavior. It is called at the final step prior to program termination.

Parameters

pvl	Pvl structure to add report to

Returns: Pvl Results

Reimplemented in Isis::Gruen.

Definition at line 477 of file AutoReg.h.

◆ ChipLine()

double Isis::AutoReg::ChipLine ( ) const

inlineinherited

Return the search chip line that best matched.

Definition at line 351 of file AutoReg.h.

References Isis::AutoReg::p_chipLine.

◆ ChipSample()

double Isis::AutoReg::ChipSample ( ) const

inlineinherited

Return the search chip sample that best matched.

Definition at line 346 of file AutoReg.h.

References Isis::AutoReg::p_chipSample.

◆ CompareFits()

bool Isis::MaximumCorrelation::CompareFits	(	double	fit1,
		double	fit2
	)

protectedvirtual

This virtual method must return if the 1st fit is equal to or better than the second fit.

Parameters

fit1	1st goodness of fit
fit2	2nd goodness of fit

Reimplemented from Isis::AutoReg.

Definition at line 35 of file MaximumCorrelation.cpp.

◆ CubeLine()

double Isis::AutoReg::CubeLine ( ) const

inlineinherited

Return the search chip cube line that best matched.

Definition at line 361 of file AutoReg.h.

References Isis::AutoReg::p_cubeLine.

Referenced by Isis::SmtkMatcher::makeRegisteredPoint(), Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ CubeSample()

double Isis::AutoReg::CubeSample ( ) const

inlineinherited

Return the search chip cube sample that best matched.

Definition at line 356 of file AutoReg.h.

References Isis::AutoReg::p_cubeSample.

Referenced by Isis::SmtkMatcher::makeRegisteredPoint(), Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ Distance()

void Isis::AutoReg::Distance	(	double &	sampDistance,
		double &	lineDistance
	)

inlineinherited

Return the distance point moved.

Parameters

sampDistance	Sample movement
lineDistance	Line movement

Definition at line 326 of file AutoReg.h.

References Isis::AutoReg::p_lineMovement, and Isis::AutoReg::p_sampMovement.

Referenced by Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ DistanceTolerance()

double Isis::AutoReg::DistanceTolerance ( ) const

inlineinherited

Return distance tolerance.

Definition at line 316 of file AutoReg.h.

References Isis::AutoReg::p_distanceTolerance.

Referenced by Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ FitChip()

Chip* Isis::AutoReg::FitChip ( )

inlineinherited

Return pointer to fit chip.

Definition at line 228 of file AutoReg.h.

References Isis::AutoReg::p_fitChip.

Referenced by Isis::ControlPointEdit::saveChips(), and Isis::ControlMeasureEditWidget::saveChips().

◆ GoodnessOfFit()

double Isis::AutoReg::GoodnessOfFit ( ) const

inlineinherited

Return the goodness of fit of the match algorithm.

Definition at line 339 of file AutoReg.h.

References Isis::AutoReg::p_goodnessOfFit.

Referenced by Isis::ControlPointEdit::registerPoint(), Isis::ControlMeasureEditWidget::registerPoint(), Isis::ControlPointEdit::saveMeasure(), and Isis::ControlMeasureEditWidget::saveMeasure().

◆ IdealFit()

virtual double Isis::MaximumCorrelation::IdealFit ( ) const

inlineprotectedvirtual

Returns the ideal (perfect) fit that could be returned by the MatchAlgorithm.

Returns: double

Implements Isis::AutoReg.

Definition at line 60 of file MaximumCorrelation.h.

◆ IsIdeal()

bool Isis::AutoReg::IsIdeal ( double fit )

inlineinherited

Returns true if the fit parameter is arbitrarily close to the ideal fit value.

Parameters

fit	Fit value to be compared to the ideal fit

Returns: bool Indicates whether the fit is ideal

Definition at line 1175 of file AutoReg.cpp.

◆ MatchAlgorithm()

double Isis::MaximumCorrelation::MatchAlgorithm	(	Chip &	pattern,
		Chip &	subsearch
	)

protectedvirtual

Given two identically sized chips return a double that indicates how well they match.

For example, a correlation match algorithm would return a correlation coefficient ranging from -1 to 1.

Parameters

pattern	Pattern chip to match against
subsearch	Subchip of the search chip to match with

Returns: double

Implements Isis::AutoReg.

Definition at line 6 of file MaximumCorrelation.cpp.

References Isis::MultivariateStatistics::AddData(), Isis::MultivariateStatistics::Correlation(), Isis::Chip::GetValue(), Isis::Chip::Lines(), Isis::Null, Isis::AutoReg::PatternValidPercent(), Isis::Chip::Samples(), and Isis::MultivariateStatistics::ValidPixels().

◆ MinimumZScore()

double Isis::AutoReg::MinimumZScore ( ) const

inlineinherited

Return minimumPatternZScore.

Definition at line 366 of file AutoReg.h.

References Isis::AutoReg::p_minimumPatternZScore.

Referenced by Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ MostLenientTolerance()

virtual double Isis::AutoReg::MostLenientTolerance ( )

inlinevirtualinherited

Minimum tolerance specific to algorithm.

Reimplemented in Isis::MinimumDifference.

Definition at line 386 of file AutoReg.h.

◆ Parse()

void Isis::AutoReg::Parse ( Pvl & pvl )

protectedinherited

Initialize parameters in the AutoReg class using a PVL specification.

An example of the PVL required for this is:

Object = AutoRegistration
  Group = Algorithm
    Name      = MaximumCorrelation
    Tolerance = 0.7
  EndGroup
  Group = PatternChip
    Samples = 21
    Lines   = 21
  EndGroup
  Group = SearchChip
    Samples = 51
    Lines = 51
  EndGroup
EndObject

There are many other options that can be set via the pvl and are described in other documentation (see below).

See also: patternMatch.doc under the coreg application

Parameters

pvl	The pvl object containing the specification

Exceptions

iException::User "Improper format for AutoReg PVL."

History:

2010-06-15 Jeannie Walldren - Added ability to read ChipInterpolator keyword from the Algorithm group.

2010-07-20 Jeannie Walldren - Added ability to read search sub chip valid percent

Definition at line 207 of file AutoReg.cpp.

References _FILEINFO_, Isis::PvlContainer::fileName(), Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), Isis::PvlContainer::hasKeyword(), Isis::ValidMaximum, and Isis::ValidMinimum.

◆ PatternChip()

Chip* Isis::AutoReg::PatternChip ( )

inlineinherited

Return pointer to pattern chip.

Definition at line 218 of file AutoReg.h.

References Isis::AutoReg::p_patternChip.

Referenced by Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ PatternValidPercent()

double Isis::AutoReg::PatternValidPercent ( ) const

inlineinherited

Return pattern chip valid percent. The default value is.

Definition at line 296 of file AutoReg.h.

References Isis::AutoReg::p_patternValidPercent.

Referenced by MatchAlgorithm(), Isis::Gruen::MinValidPoints(), Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ Reduce()

Chip Isis::AutoReg::Reduce	(	Chip &	chip,
		int	reductionFactor
	)

protectedinherited

This method reduces the given chip by the given reduction factor.

Used to speed up the match algorithm.

Parameters

chip	Chip to be reduced
reductionFactor	Factor by which to reduce chip.

Returns: Chip Reduced chip object

Definition at line 552 of file AutoReg.cpp.

References Isis::Statistics::AddData(), Isis::Statistics::Average(), Isis::Chip::GetValue(), Isis::Chip::Lines(), Isis::Null, Isis::Statistics::Reset(), Isis::Chip::Samples(), and Isis::Chip::SetValue().

◆ ReducedFitChip()

Chip* Isis::AutoReg::ReducedFitChip ( )

inlineinherited

Return pointer to reduced fit chip.

Definition at line 263 of file AutoReg.h.

References Isis::AutoReg::p_reducedFitChip.

◆ ReducedPatternChip()

Chip* Isis::AutoReg::ReducedPatternChip ( )

inlineinherited

Return pointer to reduced pattern chip.

Definition at line 253 of file AutoReg.h.

References Isis::AutoReg::p_reducedPatternChip.

◆ ReducedSearchChip()

Chip* Isis::AutoReg::ReducedSearchChip ( )

inlineinherited

Return pointer to reduced search chip.

Definition at line 258 of file AutoReg.h.

References Isis::AutoReg::p_reducedSearchChip.

◆ ReductionFactor()

int Isis::AutoReg::ReductionFactor ( )

inlineinherited

Return the reduction factor.

Definition at line 291 of file AutoReg.h.

References Isis::AutoReg::p_reduceFactor.

◆ Register()

AutoReg::RegisterStatus Isis::AutoReg::Register ( )

inherited

Walk the pattern chip through the search chip to find the best registration.

Returns: AutoReg::RegisterStatus Returns the status of the registration.

Exceptions

iException::User	- "Search chips samples must be at least N pixels wider than the pattern chip samples for successful surface modeling"
iException::User	- "Search chips lines must be at least N pixels taller than the pattern chip lines for successful surface modeling"
iException::User	- "Reduction factor is too large"

Prep for walking the search chip by computing the starting and ending sample and line positions of the search chip to extract a sub-search chip to compare with the pattern chip.

Because the sub-search chip needs to have the same pixel dimensions as the pattern chip, and will be composed from its center pixel outwards, buffer the start and end boundaries so an area the size of the pattern chip can always be extracted around the current position.

For example, consider trying to extract a 5x5 sub-search chip from some search chip. If one starts at sample 1 and line 1, then because the "current position" is treated as the center of the sub-search chip, the algorithm could not form a 5x5 chip because there is nothing up and to the left of the current position. Consequently, for this example, there needs to be a two-pixel buffer from the edge of the search chip as the algorithm walks through it to make sure a 5x5 sub-search chip can always be extracted with the current position as its center.

Definition at line 600 of file AutoReg.cpp.

References _FILEINFO_, Isis::Chip::CubeLine(), Isis::Chip::CubeSample(), Isis::Chip::IsValid(), Isis::Chip::Lines(), Isis::Null, Isis::Chip::Samples(), Isis::Chip::SetChipPosition(), Isis::Chip::TackLine(), and Isis::Chip::TackSample().

Referenced by Isis::SmtkMatcher::makeRegisteredPoint(), Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ Registration()

AutoReg::RegisterStatus Isis::AutoReg::Registration	(	Chip &	sChip,
		Chip &	pChip,
		Chip &	fChip,
		int	startSamp,
		int	startLine,
		int	endSamp,
		int	endLine,
		int	bestSamp,
		int	bestLine
	)

protectedvirtualinherited

Performs matching between the pattern and search at both whole-pixel and subpixel levels.

For adaptive algorithms, only subpixel matching occurs. Such algorithms override this method to use their alternative matching procedures.

For those algorithms that need it, the best sample and line in the search chip is provided. This is either the initial tack sample and line in the search chip or it is the centered sample and line after the reduction algorithm is applied (KJB, 2009-08-26).

Author: janderson (6/2/2009)

Parameters

sChip	Search chip
pChip	Pattern chip
fChip	Fit chip
startSamp	Defines the starting sample of the window the algorithm should remain inside this boundary.
startLine	Defines the starting line of the window the algorithm should remain inside this boundary.
endSamp	Defines the ending sample of the window the algorithm should remain inside this boundary.
endLine	Defines the ending line of the window the algorithm should remain inside this boundary.
bestSamp	Best sample
bestLine	Best line

Returns: AutoReg::RegisterStatus Status of match

Reimplemented in Isis::Gruen.

Definition at line 824 of file AutoReg.cpp.

References Isis::Chip::Extract(), Isis::Chip::IsValid(), Isis::Null, and Isis::Chip::SetChipPosition().

◆ RegistrationPatternChip()

Chip* Isis::AutoReg::RegistrationPatternChip ( )

inlineinherited

Return pointer to pattern chip used in registration.

Definition at line 233 of file AutoReg.h.

References Isis::AutoReg::None, Isis::AutoReg::p_gradientFilterType, Isis::AutoReg::p_gradientPatternChip, and Isis::AutoReg::p_patternChip.

Referenced by Isis::ControlPointEdit::saveChips(), and Isis::ControlMeasureEditWidget::saveChips().

◆ RegistrationSearchChip()

Chip* Isis::AutoReg::RegistrationSearchChip ( )

inlineinherited

Return pointer to search chip used in registration.

Definition at line 243 of file AutoReg.h.

References Isis::AutoReg::None, Isis::AutoReg::p_gradientFilterType, Isis::AutoReg::p_gradientSearchChip, and Isis::AutoReg::p_searchChip.

Referenced by Isis::ControlPointEdit::saveChips(), and Isis::ControlMeasureEditWidget::saveChips().

◆ RegistrationStatistics()

Pvl Isis::AutoReg::RegistrationStatistics ( )

inherited

This returns the cumulative registration statistics.

That is, the Register() method accumulates statistics regard the errors each time is called. Invoking this method returns a PVL summary of those statisitics

Author: janderson (3/26/2009)

Returns: Pvl

Definition at line 1190 of file AutoReg.cpp.

References Isis::PvlObject::addGroup(), and Isis::toString().

◆ RegTemplate()

PvlGroup Isis::AutoReg::RegTemplate ( )

inherited

This function returns the keywords that this object was created from.

Returns: PvlGroup The keywords this object used in initialization

Definition at line 1229 of file AutoReg.cpp.

References Isis::PvlContainer::hasKeyword().

◆ SearchChip()

Chip* Isis::AutoReg::SearchChip ( )

inlineinherited

Return pointer to search chip.

Definition at line 223 of file AutoReg.h.

References Isis::AutoReg::p_searchChip.

Referenced by Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ SetChipInterpolator()

void Isis::AutoReg::SetChipInterpolator ( const QString & interpolator )

inherited

Sets the Chip class interpolator type to be used to load pattern and search chips.

Acceptable values for the interpolator parameter include:

NearestNeighborType
BiLinearType
CubicConvolutionType

If this method is not called, the chip interpolator type defaults to CubicConvolutionType in the Chip class.

Parameters

interpolator Name of interpolator type to be used. This is taken from the Pvl's ChipInterpolator keyword value.

Exceptions

iException::User - "Invalid Interpolator type."

Author: Jeannie Walldren

History:: 2010-06-15 Jeannie Walldren - Original version.

Definition at line 453 of file AutoReg.cpp.

References _FILEINFO_.

◆ SetChipLine()

void Isis::AutoReg::SetChipLine ( double line )

inlineprotectedinherited

Sets the search chip subpixel line that matches the pattern tack line.

Parameters

line	Value to set for search chip subpixel line

Definition at line 420 of file AutoReg.h.

References Isis::AutoReg::p_chipLine.

Referenced by Isis::Gruen::Registration().

◆ SetChipSample()

void Isis::AutoReg::SetChipSample ( double sample )

inlineprotectedinherited

Sets the search chip subpixel sample that matches the pattern tack sample.

Parameters

sample Value to set for search chip subpixel sample

Definition at line 409 of file AutoReg.h.

References Isis::AutoReg::p_chipSample.

Referenced by Isis::Gruen::Registration().

◆ SetGoodnessOfFit()

void Isis::AutoReg::SetGoodnessOfFit ( double fit )

inlineprotectedinherited

Sets the goodness of fit for adaptive algorithms.

Parameters

fit	Fit value to set

Definition at line 429 of file AutoReg.h.

References Isis::AutoReg::p_bestFit.

Referenced by Isis::Gruen::Registration().

◆ SetGradientFilterType()

void Isis::AutoReg::SetGradientFilterType ( const QString & gradientFilterType )

inherited

Set the gradient filter type to be applied to the search and pattern chips.

Parameters

gradientFilterType the gradient filter type to use

Exceptions

iException::User - "Invalid Gradient type."

Definition at line 286 of file AutoReg.cpp.

◆ SetPatternValidPercent()

void Isis::AutoReg::SetPatternValidPercent ( const double percent )

inherited

Set the amount of data in the pattern chip that must be valid.

For example, a 21x21 pattern chip has 441 pixels. If percent is 75 then at least 330 pixels pairs must be valid in order for a comparision between the pattern and search sub-region to occur. That is, both the pattern pixel and search pixel must be valid to be counted. Pixels are considered valid based on the min/max range specified on each of the Chips (see Chip::SetValidRange method).

If the pattern chip reduction option is used this percentage will apply to all reduced patterns. Additionally, the pattern sampling effects the pixel count. For example if pattern sampling is 50% then only 220 pixels in the 21x21 pattern are considered so 165 must be valid.

If this method is not called, the PatternChip ValidPercent defaults to 50 in the AutoReg object constructor.

See also: SetValidRange()

Parameters

percent Percentage of valid data between 0 and 100, default is 50% if never invoked

Exceptions

iException::User - "Invalid value for PatternChip ValidPercent."

Definition at line 352 of file AutoReg.cpp.

References _FILEINFO_.

◆ SetPatternZScoreMinimum()

void Isis::AutoReg::SetPatternZScoreMinimum ( double minimum )

inherited

Set the minimum pattern zscore.

This option is used to ignore pattern chips which are bland (low standard deviation). If the minimum or maximum pixel value in the pattern chip does not meet the minimum zscore value (see a statisitcs book for definition of zscore) then invalid registration will occur.

If this method is not called, the z-score minimum defaults to 1.0 in the AutoReg object constructor.

Parameters

minimum The minimum zscore value for the pattern chip. Default is 1.0

Exceptions

iException::User - "Invalid value for PatternChip MinimumZScore."

Definition at line 407 of file AutoReg.cpp.

References _FILEINFO_.

◆ SetReductionFactor()

void Isis::AutoReg::SetReductionFactor ( int factor )

inherited

Set the reduction factor used to speed up the pattern matching algorithm.

If this method is not called, the reduction factor defaults to 1 in the AutoReg object constructor.

Parameters

factor Reduction factor. Must be greater than or equal to 1.

Exceptions

iException::User - "Invalid value for Algorithm ReductionFactor."

Definition at line 534 of file AutoReg.cpp.

References _FILEINFO_.

◆ SetSubPixelAccuracy()

void Isis::AutoReg::SetSubPixelAccuracy ( bool on )

inherited

If the sub-pixel accuracy is enabled, the Register() method will attempt to match the pattern chip to the search chip at sub-pixel accuracy, otherwise it will be registered at whole pixel accuracy.

If this method is not called, the sub pixel accuracy defaults to on = true in the AutoReg object constructor.

Parameters

on	Set the state of registration accuracy. The default is sub-pixel accuracy is on

Definition at line 325 of file AutoReg.cpp.

◆ SetSubpixelPosition()

bool Isis::AutoReg::SetSubpixelPosition ( Chip & window )

protectedinherited

Set the search chip sample and line to subpixel values if possible.

This method uses a centroiding method to gravitate the whole pixel best fit to a subpixel extremum in the continuous image space. The weights of the centers of gravity in the centroiding algorithm are modeled by goodness of fit values within a discrete search window.

Parameters

window The search window extracted from the fit chip

Returns: bool Returns true if the subpixel solution is valid

Definition at line 1100 of file AutoReg.cpp.

References Isis::Chip::ChipLine(), Isis::Chip::ChipSample(), Isis::Chip::GetValue(), Isis::Chip::Lines(), Isis::Chip::Samples(), Isis::Centroid::select(), Isis::Centroid::setDNRange(), and Isis::Chip::SetValue().

◆ SetSubsearchValidPercent()

void Isis::AutoReg::SetSubsearchValidPercent ( const double percent )

inherited

Set the amount of data in the search chip's subchip that must be valid.

If this method is not called, the SearchChip SubchipValidPercent defaults to 50 in the AutoReg object constructor.

Parameters

percent Percentage of valid data between 0 and 100, default is 50% if never invoked

See also: SetPatternValidPercent()

Exceptions

iException::User - "Invalid value for SearchChip SubchipValidPercent."

Author: 2010-07-20 Jeannie Walldren

History:: 2010-07-20 Jeannie Walldren - Original Version.

Definition at line 380 of file AutoReg.cpp.

References _FILEINFO_.

◆ SetSurfaceModelDistanceTolerance()

void Isis::AutoReg::SetSurfaceModelDistanceTolerance ( double distance )

inherited

Set a distance the surface model solution is allowed to move away from the best whole pixel fit in the fit chip.

If this method is not called, the distance tolerance defaults to 1.5 in the AutoReg object constructor.

Parameters

distance The distance allowed to move in pixels. Must be greater than 0.

Exceptions

iException::User - "Invalid value for SurfaceModel DistanceTolerance."

Definition at line 514 of file AutoReg.cpp.

References _FILEINFO_.

◆ SetSurfaceModelWindowSize()

void Isis::AutoReg::SetSurfaceModelWindowSize ( int size )

inherited

Set the surface model window size.

The pixels in this window will be used to fit a surface model in order to compute sub-pixel accuracy. In some cases the default (3x3) and produces erroneous sub-pixel accuracy values.

If this method is not called, the window size defaults to 5 in the AutoReg object constructor.

Parameters

size	The size of the window must be three or greater and odd.

Exceptions

iException::User - "Invalid value for SurfaceModel WindowSize."

Definition at line 493 of file AutoReg.cpp.

References _FILEINFO_.

◆ SetTolerance()

void Isis::AutoReg::SetTolerance ( double tolerance )

inherited

Set the tolerance for an acceptable goodness of fit.

If this method is not called, the tolerance value defaults to Isis::Null in the AutoReg object constructor.

Parameters

tolerance This tolerance is used to test against the goodness of fit returned by the MatchAlgorith method after a surface model has been fit. See TestGoodnessOfFit

Definition at line 429 of file AutoReg.cpp.

◆ SubPixelAccuracy()

bool Isis::AutoReg::SubPixelAccuracy ( )

inlineinherited

Return whether this object will attempt to register to whole or sub-pixel accuracy.

Returns: on Is sub-pixel accuracy enabled?

Definition at line 286 of file AutoReg.h.

References Isis::AutoReg::p_subpixelAccuracy.

◆ SubsearchValidPercent()

double Isis::AutoReg::SubsearchValidPercent ( ) const

inlineinherited

Return subsearch chip valid percent.

Definition at line 301 of file AutoReg.h.

References Isis::AutoReg::p_subsearchValidPercent.

◆ Success()

bool Isis::AutoReg::Success ( ) const

inlineinherited

Return whether the match algorithm succeeded or not.

Definition at line 334 of file AutoReg.h.

References Isis::AutoReg::p_registrationStatus, Isis::AutoReg::SuccessPixel, and Isis::AutoReg::SuccessSubPixel.

Referenced by Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ Tolerance()

double Isis::AutoReg::Tolerance ( ) const

inlineinherited

Return match algorithm tolerance.

Definition at line 306 of file AutoReg.h.

References Isis::AutoReg::p_tolerance.

Referenced by Isis::Gruen::CheckConstraints(), Isis::ControlPointEdit::registerPoint(), and Isis::ControlMeasureEditWidget::registerPoint().

◆ UpdatedTemplate()

PvlGroup Isis::AutoReg::UpdatedTemplate ( )

inherited

Returns a PvlGroup containing the PvlKeywords of the parameters this object was most recently run with.

Because of publically accessible mutators, AutoReg's runtime parameters can change, and this version of the template is designed to reflect the paramters it was actually run with, as opposed to simply initialized with. If no mutators were ever called externally, then this PvlGroup should be the same as the one received from RegTemplate().

Returns: PvlGroup The keywords this object was most recently run with

Definition at line 1302 of file AutoReg.cpp.

References Isis::Chip::Lines(), Isis::Chip::Samples(), and Isis::toString().

◆ WindowSize()

double Isis::AutoReg::WindowSize ( ) const

inlineinherited

Return window size.

Definition at line 311 of file AutoReg.h.

References Isis::AutoReg::p_windowSize.

◆ ZScores()

void Isis::AutoReg::ZScores	(	double &	score1,
		double &	score2
	)		const

inlineinherited

Return the ZScores of the pattern chip.

Parameters

score1	First Z Score
score2	Second Z Score

Definition at line 376 of file AutoReg.h.

References Isis::AutoReg::p_zScoreMax, and Isis::AutoReg::p_zScoreMin.

Referenced by Isis::ControlPointEdit::registerPoint(), Isis::ControlMeasureEditWidget::registerPoint(), Isis::ControlPointEdit::saveMeasure(), and Isis::ControlMeasureEditWidget::saveMeasure().

Member Data Documentation

◆ p_template

PvlObject Isis::AutoReg::p_template

protectedinherited

AutoRegistration object that created this projection.

Definition at line 465 of file AutoReg.h.

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

src/base/objs/MaximumCorrelation/MaximumCorrelation.h
src/base/objs/MaximumCorrelation/MaximumCorrelation.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ GradientFilterType

◆ RegisterStatus

Member Function Documentation

◆ AlgorithmName()

◆ AlgorithmStatistics()

◆ ChipLine()

◆ ChipSample()

◆ CompareFits()

◆ CubeLine()

◆ CubeSample()

◆ Distance()

◆ DistanceTolerance()

◆ FitChip()

◆ GoodnessOfFit()

◆ IdealFit()

◆ IsIdeal()

◆ MatchAlgorithm()

◆ MinimumZScore()

◆ MostLenientTolerance()

◆ Parse()

◆ PatternChip()

◆ PatternValidPercent()

◆ Reduce()

◆ ReducedFitChip()

◆ ReducedPatternChip()

◆ ReducedSearchChip()

◆ ReductionFactor()

◆ Register()

◆ Registration()

◆ RegistrationPatternChip()

◆ RegistrationSearchChip()

◆ RegistrationStatistics()

◆ RegTemplate()

◆ SearchChip()

◆ SetChipInterpolator()

◆ SetChipLine()

◆ SetChipSample()

◆ SetGoodnessOfFit()

◆ SetGradientFilterType()

◆ SetPatternValidPercent()

◆ SetPatternZScoreMinimum()

◆ SetReductionFactor()

◆ SetSubPixelAccuracy()

◆ SetSubpixelPosition()

◆ SetSubsearchValidPercent()

◆ SetSurfaceModelDistanceTolerance()

◆ SetSurfaceModelWindowSize()

◆ SetTolerance()

◆ SubPixelAccuracy()

◆ SubsearchValidPercent()

◆ Success()

◆ Tolerance()

◆ UpdatedTemplate()

◆ WindowSize()

◆ ZScores()

Member Data Documentation

◆ p_template