USGS

Isis 3.0 Object Programmers' Reference

 Home

Isis::AutoRegFactory Class Reference
[Pattern Matching]

This class is used to create AutoReg objects. More...

#include <AutoRegFactory.h>

List of all members.

Static Public Member Functions

static AutoReg * Create (Pvl &pvl)
 Create an AutoReg object using a PVL specification.

Private Member Functions

 AutoRegFactory ()
 Constructor (its private so you can't use it).
 ~AutoRegFactory ()
 Destroys the AutoRegFactory.

Detailed Description

This class is used to create AutoReg objects.

Typically applications which need use autoregistration would like to use different techniques such as MaximumCorrelation or MinimumDifference. If this factory is given a Pvl object which contains a AutoReg definition it will create that specific instance of the class. For example,

 Object = AutoReg
   Group = Algorithm
     Name = MinimumDifference
     ...
   EndGroup
   ...
 EndObject
 End

Will create a MinimumDifference object (which is derived from AutoReg). The simplest way to create an AutoReg class is to use the static Create method

 Pvl p("myautoreg.pvl");
 AutoReg *ar = AutoRegFactory::Create(p);
Author:
2005-05-04 Jeff Anderson

For internal use only.

History:
2006-03-27 Jacob Danton Added unitTest
History:
2008-06-18 Christopher Austin Fixed documentation errors
History:
2008-06-19 Steven Lambright Fixed memory leak

Definition at line 67 of file AutoRegFactory.h.

Constructor & Destructor Documentation

Isis::AutoRegFactory::AutoRegFactory (  )  [inline, private]

Constructor (its private so you can't use it).

Use the Create Method instead.

Definition at line 76 of file AutoRegFactory.h.

Isis::AutoRegFactory::~AutoRegFactory (  )  [inline, private]

Destroys the AutoRegFactory.

Definition at line 79 of file AutoRegFactory.h.

Member Function Documentation

AutoReg * Isis::AutoRegFactory::Create ( Pvl &  pvl  )  [static]

Create an AutoReg object 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).

Parameters:
pvl The pvl object containing the specification
See also:
automaticRegistration.doc

Definition at line 61 of file AutoRegFactory.cpp.

References Isis::PvlObject::FindGroup(), Isis::Plugin::GetPlugin(), Isis::Pvl::Read(), and Isis::PvlObject::Traverse.

Referenced by Isis::ControlPointEdit::ControlPointEdit(), and Isis::ControlPointEdit::setTemplateFile().

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