Isis Developer Reference
Isis::MinimumDifference Class Reference

Minimum difference pattern matching. More...

#include <MinimumDifference.h>

Inheritance diagram for Isis::MinimumDifference:
Inheritance graph
Collaboration diagram for Isis::MinimumDifference:
Collaboration graph

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

 MinimumDifference (Pvl &pvl)
 Construct a MinimumDifference search algorithm.
 
virtual ~MinimumDifference ()
 Destructor.
 
virtual double MostLenientTolerance ()
 Minimum tolerance specific to algorithm.
 
ChipPatternChip ()
 Return pointer to pattern chip.
 
ChipSearchChip ()
 Return pointer to search chip.
 
ChipFitChip ()
 Return pointer to fit chip.
 
ChipRegistrationPatternChip ()
 Return pointer to pattern chip used in registration.
 
ChipRegistrationSearchChip ()
 Return pointer to search chip used in registration.
 
ChipReducedPatternChip ()
 Return pointer to reduced pattern chip.
 
ChipReducedSearchChip ()
 Return pointer to reduced search chip.
 
ChipReducedFitChip ()
 Return pointer to reduced fit chip.
 
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.
 
void SetPatternValidPercent (const double percent)
 Set the amount of data in the pattern chip that must be valid.
 
void SetSubsearchValidPercent (const double percent)
 Set the amount of data in the search chip's subchip that must be valid.
 
void SetTolerance (double tolerance)
 Set the tolerance for an acceptable goodness of fit.
 
void SetChipInterpolator (const QString &interpolator)
 Sets the Chip class interpolator type to be used to load pattern and search chips.
 
void SetSurfaceModelWindowSize (int size)
 Set the surface model window size.
 
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.
 
void SetReductionFactor (int reductionFactor)
 Set the reduction factor used to speed up the pattern matching algorithm.
 
void SetPatternZScoreMinimum (double minimum)
 Set the minimum pattern zscore.
 
void SetGradientFilterType (const QString &gradientFilterType)
 Set the gradient filter type to be applied to the search and pattern chips.
 
QString GradientFilterString () const
 
bool SubPixelAccuracy ()
 Return whether this object will attempt to register to whole or sub-pixel accuracy.
 
int ReductionFactor ()
 Return the reduction factor.
 
double PatternValidPercent () const
 Return pattern chip valid percent. The default value is.
 
double SubsearchValidPercent () const
 Return subsearch chip valid percent.
 
double Tolerance () const
 Return match algorithm tolerance.
 
double WindowSize () const
 Return window size.
 
double DistanceTolerance () const
 Return distance tolerance.
 
void Distance (double &sampDistance, double &lineDistance)
 Return the distance point moved.
 
AutoReg::RegisterStatus Register ()
 Walk the pattern chip through the search chip to find the best registration.
 
bool Success () const
 Return whether the match algorithm succeeded or not.
 
double GoodnessOfFit () const
 Return the goodness of fit of the match algorithm.
 
bool IsIdeal (double fit)
 Returns true if the fit parameter is arbitrarily close to the ideal fit value.
 
double ChipSample () const
 Return the search chip sample that best matched.
 
double ChipLine () const
 Return the search chip line that best matched.
 
double CubeSample () const
 Return the search chip cube sample that best matched.
 
double CubeLine () const
 Return the search chip cube line that best matched.
 
double MinimumZScore () const
 Return minimumPatternZScore.
 
void ZScores (double &score1, double &score2) const
 Return the ZScores of the pattern chip.
 
Pvl RegistrationStatistics ()
 This returns the cumulative registration statistics.
 
PvlGroup RegTemplate ()
 This function returns the keywords that this object was created from.
 
PvlGroup UpdatedTemplate ()
 Returns a PvlGroup containing the PvlKeywords of the parameters this object was most recently run with.
 

Protected Member Functions

virtual double MatchAlgorithm (Chip &pattern, Chip &subsearch)
 Minimum difference match algorithm.
 
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.
 
virtual double IdealFit () const
 Returns the ideal (perfect) fit that could be returned by the MatchAlgorithm.
 
virtual QString AlgorithmName () const
 Returns the name of the algorithm.
 
void SetChipSample (double sample)
 Sets the search chip subpixel sample that matches the pattern tack sample.
 
void SetChipLine (double line)
 Sets the search chip subpixel line that matches the pattern tack line.
 
void SetGoodnessOfFit (double fit)
 Sets the goodness of fit for adaptive algorithms.
 
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.
 
void Parse (Pvl &pvl)
 Initialize parameters in the AutoReg class using a PVL specification.
 
bool SetSubpixelPosition (Chip &window)
 Set the search chip sample and line to subpixel values if possible.
 
Chip Reduce (Chip &chip, int reductionFactor)
 This method reduces the given chip by the given reduction factor.
 
virtual Pvl AlgorithmStatistics (Pvl &pvl)
 Provide (adaptive) algorithms a chance to report results.
 

Protected Attributes

PvlObject p_template
 AutoRegistration object that created this projection.
 

Detailed Description

Minimum difference pattern matching.

This class is used to construct a minimum difference 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 absolute value of the difference is computed at each matching pixel in the pattern and sub-search chip. These differences are then summed to produce the goodness of fit. The sub-search chip with the lowest goodness of fit will be identified as the pattern match (if a tolerance is met). The best fit = 0 which means the pattern chip and sub-search chip are identical

See also
MinimumDifference AutoReg
Author
2005-05-05 Jeff Anderson

Member Enumeration Documentation

◆ GradientFilterType

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.

◆ RegisterStatus

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.

Constructor & Destructor Documentation

◆ MinimumDifference()

Isis::MinimumDifference::MinimumDifference ( Pvl & pvl)
inline

Construct a MinimumDifference search algorithm.

This will construct a minimum difference search algorith. It is recommended that you use a AutoRegFactory class as opposed to this constructor

Parameters
pvlA Pvl object that contains a valid automatic registration definition

◆ ~MinimumDifference()

virtual Isis::MinimumDifference::~MinimumDifference ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ AlgorithmName()

virtual QString Isis::MinimumDifference::AlgorithmName ( ) const
inlineprotectedvirtual

Returns the name of the algorithm.

Returns
QString

Implements Isis::AutoReg.

◆ 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
pvlPvl structure to add report to
Returns
Pvl Results

Reimplemented in Isis::Gruen.

Referenced by Isis::AutoReg::RegistrationStatistics().

◆ ChipLine()

double Isis::AutoReg::ChipLine ( ) const
inlineinherited

Return the search chip line that best matched.

◆ ChipSample()

double Isis::AutoReg::ChipSample ( ) const
inlineinherited

Return the search chip sample that best matched.

◆ CompareFits()

bool Isis::MinimumDifference::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
fit11st goodness of fit
fit22nd goodness of fit

Reimplemented from Isis::AutoReg.

◆ CubeLine()

double Isis::AutoReg::CubeLine ( ) const
inlineinherited

Return the search chip cube line that best matched.

◆ CubeSample()

double Isis::AutoReg::CubeSample ( ) const
inlineinherited

Return the search chip cube sample that best matched.

◆ Distance()

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

Return the distance point moved.

Parameters
sampDistanceSample movement
lineDistanceLine movement

◆ DistanceTolerance()

double Isis::AutoReg::DistanceTolerance ( ) const
inlineinherited

Return distance tolerance.

Referenced by Isis::AutoReg::UpdatedTemplate().

◆ FitChip()

Chip * Isis::AutoReg::FitChip ( )
inlineinherited

◆ GoodnessOfFit()

double Isis::AutoReg::GoodnessOfFit ( ) const
inlineinherited

Return the goodness of fit of the match algorithm.

◆ GradientFilterString()

QString Isis::AutoReg::GradientFilterString ( ) const
inherited

◆ IdealFit()

virtual double Isis::MinimumDifference::IdealFit ( ) const
inlineprotectedvirtual

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

Returns
double

Implements Isis::AutoReg.

◆ IsIdeal()

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

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

Parameters
fitFit value to be compared to the ideal fit
Returns
bool Indicates whether the fit is ideal

References Isis::AutoReg::IdealFit().

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

◆ MatchAlgorithm()

double Isis::MinimumDifference::MatchAlgorithm ( Chip & pattern,
Chip & subsearch )
protectedvirtual

Minimum difference match algorithm.

This virtual function overrides the pure virtual method in the AutoReg class. In this case, we sum the absolute value of the differences between pixels in the pattern and subsearch chips and divide by the valid pixel count. We ignore special pixels

Parameters
pattern[in] A Chip object usually containing an nxm area of a cube. Must be the same diminsions as subsearch.
subsearch[in] A Chip object usually containing an nxm area of a cube. Must be the same diminsions as pattern. This is normally a subarea of a larger portion of the image.
Returns
The sum of the absolute value of the DN differences divided by the valid pixel count OR Isis::NULL if the valid pixel percent is not met.

Implements Isis::AutoReg.

References Isis::IsSpecial().

◆ MinimumZScore()

double Isis::AutoReg::MinimumZScore ( ) const
inlineinherited

Return minimumPatternZScore.

Referenced by Isis::AutoReg::UpdatedTemplate().

◆ MostLenientTolerance()

virtual double Isis::MinimumDifference::MostLenientTolerance ( )
inlinevirtual

Minimum tolerance specific to algorithm.

Reimplemented from Isis::AutoReg.

◆ 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
Tolerance = 0.7
EndGroup
Group = PatternChip
Samples = 21
Lines = 21
EndGroup
Group = SearchChip
Samples = 51
Lines = 51
EndGroup
EndObject
Chip * SearchChip()
Return pointer to search chip.
Definition AutoReg.h:207
Chip * PatternChip()
Return pointer to pattern chip.
Definition AutoReg.h:202
double Tolerance() const
Return match algorithm tolerance.
Definition AutoReg.h:290
Maximum correlation pattern matching.
Definition MaximumCorrelation.h:36

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
pvlThe pvl object containing the specification
Exceptions
iException::User"Improper format for AutoReg PVL."

References _FILEINFO_, Isis::PvlObject::findObject(), Isis::AutoReg::PatternChip(), Isis::AutoReg::SearchChip(), Isis::AutoReg::SetChipInterpolator(), Isis::AutoReg::SetGradientFilterType(), Isis::AutoReg::SetPatternValidPercent(), Isis::AutoReg::SetPatternZScoreMinimum(), Isis::AutoReg::SetReductionFactor(), Isis::Chip::SetSize(), Isis::AutoReg::SetSubPixelAccuracy(), Isis::AutoReg::SetSubsearchValidPercent(), Isis::AutoReg::SetSurfaceModelDistanceTolerance(), Isis::AutoReg::SetSurfaceModelWindowSize(), Isis::AutoReg::SetTolerance(), Isis::Chip::SetValidRange(), Isis::PvlObject::Traverse, Isis::IException::User, Isis::ValidMaximum, and Isis::ValidMinimum.

Referenced by Isis::AutoReg::AutoReg().

◆ PatternChip()

Chip * Isis::AutoReg::PatternChip ( )
inlineinherited

Return pointer to pattern chip.

Referenced by Isis::AutoReg::Parse(), and Isis::AutoReg::UpdatedTemplate().

◆ PatternValidPercent()

double Isis::AutoReg::PatternValidPercent ( ) const
inlineinherited

Return pattern chip valid percent. The default value is.

Referenced by Isis::MaximumCorrelation::MatchAlgorithm(), and Isis::AutoReg::UpdatedTemplate().

◆ 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
chipChip to be reduced
reductionFactorFactor by which to reduce chip.
Returns
Chip Reduced chip object

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

Referenced by Isis::AutoReg::Register().

◆ ReducedFitChip()

Chip * Isis::AutoReg::ReducedFitChip ( )
inlineinherited

Return pointer to reduced fit chip.

◆ ReducedPatternChip()

Chip * Isis::AutoReg::ReducedPatternChip ( )
inlineinherited

Return pointer to reduced pattern chip.

◆ ReducedSearchChip()

Chip * Isis::AutoReg::ReducedSearchChip ( )
inlineinherited

Return pointer to reduced search chip.

◆ ReductionFactor()

int Isis::AutoReg::ReductionFactor ( )
inlineinherited

Return the reduction factor.

Referenced by Isis::AutoReg::UpdatedTemplate().

◆ 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"

References _FILEINFO_, Isis::AutoReg::FitChipNoData, Isis::Chip::Lines(), Isis::AutoReg::None, Isis::Null, Isis::AutoReg::PatternChipNotEnoughValidData, Isis::AutoReg::PatternZScoreNotMet, Isis::AutoReg::Reduce(), Isis::AutoReg::Registration(), Isis::Chip::Samples(), Isis::Chip::SetChipPosition(), Isis::Chip::SetSize(), Isis::Chip::SetValue(), Isis::AutoReg::Success(), Isis::AutoReg::SuccessSubPixel, and Isis::IException::User.

◆ 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
sChipSearch chip
pChipPattern chip
fChipFit chip
startSampDefines the starting sample of the window the algorithm should remain inside this boundary.
startLineDefines the starting line of the window the algorithm should remain inside this boundary.
endSampDefines the ending sample of the window the algorithm should remain inside this boundary.
endLineDefines the ending line of the window the algorithm should remain inside this boundary.
bestSampBest sample
bestLineBest line
Returns
AutoReg::RegisterStatus Status of match

Reimplemented in Isis::Gruen.

References Isis::AutoReg::CompareFits(), Isis::AutoReg::FitChipNoData, Isis::AutoReg::FitChipToleranceNotMet, Isis::AutoReg::IsIdeal(), Isis::Null, Isis::AutoReg::SetSubpixelPosition(), Isis::AutoReg::SuccessPixel, Isis::AutoReg::SuccessSubPixel, Isis::AutoReg::SurfaceModelDistanceInvalid, Isis::AutoReg::SurfaceModelNotEnoughValidData, Isis::AutoReg::SurfaceModelSolutionInvalid, and Isis::AutoReg::Tolerance().

Referenced by Isis::AutoReg::Register().

◆ RegistrationPatternChip()

Chip * Isis::AutoReg::RegistrationPatternChip ( )
inlineinherited

Return pointer to pattern chip used in registration.

References Isis::AutoReg::None.

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

◆ RegistrationSearchChip()

Chip * Isis::AutoReg::RegistrationSearchChip ( )
inlineinherited

Return pointer to search chip used in registration.

References Isis::AutoReg::None.

Referenced by Isis::ControlMeasureEditWidget::saveChips(), and Isis::ControlPointEdit::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

References Isis::AutoReg::AlgorithmStatistics(), 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

References Isis::PvlObject::findGroup(), Isis::PvlObject::hasGroup(), Isis::AutoReg::p_template, Isis::AutoReg::SetPatternValidPercent(), Isis::AutoReg::SetSubsearchValidPercent(), and Isis::PvlObject::Traverse.

◆ SearchChip()

Chip * Isis::AutoReg::SearchChip ( )
inlineinherited

Return pointer to search chip.

Referenced by Isis::AutoReg::Parse(), and Isis::AutoReg::UpdatedTemplate().

◆ 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
interpolatorName 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

References _FILEINFO_, Isis::Interpolator::BiLinearType, Isis::Interpolator::CubicConvolutionType, Isis::Interpolator::NearestNeighborType, Isis::Chip::SetReadInterpolator(), and Isis::IException::User.

Referenced by Isis::AutoReg::Parse().

◆ SetChipLine()

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

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

Parameters
lineValue to set for search chip subpixel line

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
sampleValue to set for search chip subpixel sample

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

◆ SetGoodnessOfFit()

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

Sets the goodness of fit for adaptive algorithms.

Parameters
fitFit value to set

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
gradientFilterTypethe gradient filter type to use
Exceptions
iException::User- "Invalid Gradient type."

References _FILEINFO_, Isis::AutoReg::None, Isis::AutoReg::Sobel, and Isis::IException::User.

Referenced by Isis::AutoReg::Parse().

◆ 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
percentPercentage of valid data between 0 and 100, default is 50% if never invoked
Exceptions
iException::User- "Invalid value for PatternChip ValidPercent."

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

Referenced by Isis::AutoReg::AutoReg(), Isis::AutoReg::Parse(), and Isis::AutoReg::RegTemplate().

◆ 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
minimumThe minimum zscore value for the pattern chip. Default is 1.0
Exceptions
iException::User- "Invalid value for PatternChip MinimumZScore."

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

Referenced by Isis::AutoReg::AutoReg(), and Isis::AutoReg::Parse().

◆ 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
factorReduction factor. Must be greater than or equal to 1.
Exceptions
iException::User- "Invalid value for Algorithm ReductionFactor."

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

Referenced by Isis::AutoReg::AutoReg(), and Isis::AutoReg::Parse().

◆ 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
onSet the state of registration accuracy. The default is sub-pixel accuracy is on

Referenced by Isis::AutoReg::AutoReg(), and Isis::AutoReg::Parse().

◆ 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
windowThe search window extracted from the fit chip
Returns
bool Returns true if the subpixel solution is valid

References Isis::Centroid::setDNRange().

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

◆ 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
percentPercentage of valid data between 0 and 100, default is 50% if never invoked
See also
SetPatternValidPercent()
Exceptions
iException::User- "Invalid value for SearchChip SubchipValidPercent."

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

Referenced by Isis::AutoReg::AutoReg(), Isis::AutoReg::Parse(), and Isis::AutoReg::RegTemplate().

◆ 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
distanceThe distance allowed to move in pixels. Must be greater than 0.
Exceptions
iException::User- "Invalid value for SurfaceModel DistanceTolerance."

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

Referenced by Isis::AutoReg::AutoReg(), and Isis::AutoReg::Parse().

◆ 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
sizeThe size of the window must be three or greater and odd.
Exceptions
iException::User- "Invalid value for SurfaceModel WindowSize."

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

Referenced by Isis::AutoReg::AutoReg(), and Isis::AutoReg::Parse().

◆ 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
toleranceThis tolerance is used to test against the goodness of fit returned by the MatchAlgorith method after a surface model has been fit. See TestGoodnessOfFit

Referenced by Isis::AutoReg::AutoReg(), and Isis::AutoReg::Parse().

◆ 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?

Referenced by Isis::AutoReg::UpdatedTemplate().

◆ SubsearchValidPercent()

double Isis::AutoReg::SubsearchValidPercent ( ) const
inlineinherited

Return subsearch chip valid percent.

Referenced by Isis::AutoReg::UpdatedTemplate().

◆ Success()

bool Isis::AutoReg::Success ( ) const
inlineinherited

Return whether the match algorithm succeeded or not.

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

Referenced by Isis::AutoReg::Register().

◆ Tolerance()

double Isis::AutoReg::Tolerance ( ) const
inlineinherited

Return match algorithm tolerance.

Referenced by Isis::AutoReg::Registration(), and Isis::AutoReg::UpdatedTemplate().

◆ 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

References Isis::AutoReg::AlgorithmName(), Isis::AutoReg::DistanceTolerance(), Isis::AutoReg::GradientFilterString(), Isis::AutoReg::MinimumZScore(), Isis::AutoReg::PatternChip(), Isis::AutoReg::PatternValidPercent(), Isis::AutoReg::ReductionFactor(), Isis::AutoReg::SearchChip(), Isis::AutoReg::SubPixelAccuracy(), Isis::AutoReg::SubsearchValidPercent(), Isis::AutoReg::Tolerance(), Isis::toString(), and Isis::AutoReg::WindowSize().

◆ WindowSize()

double Isis::AutoReg::WindowSize ( ) const
inlineinherited

Return window size.

Referenced by Isis::AutoReg::UpdatedTemplate().

◆ ZScores()

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

Return the ZScores of the pattern chip.

Parameters
score1First Z Score
score2Second Z Score

Member Data Documentation

◆ p_template

PvlObject Isis::AutoReg::p_template
protectedinherited

AutoRegistration object that created this projection.

Referenced by Isis::AutoReg::AutoReg(), and Isis::AutoReg::RegTemplate().


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