Isis::NormModelFactory Class Reference
[Pattern Matching]

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

#include <NormModelFactory.h>

Static Public Member Functions
static NormModel *	Create (Pvl &pvl, PhotoModel &pmodel)
	Create a NormModel object using a PVL specification.
static NormModel *	Create (Pvl &pvl, PhotoModel &pmodel, AtmosModel &amodel)
	Create a NormModel object using a PVL specification.

Detailed Description

This class is used to create NormModel objects.

Typically, applications which perform normalization corrections need to use different methods such as Shade, ShadeAtm, Albedo, etc. If this factory is given a Pvl object which contains a NormModel definition, it will create that specific instance of the class. For example,

 Object = NormalizationModel
   Group = Algorithm
     Name = Shade
     ...
   EndGroup
   ...
 EndObject
 End

Will create a Shade normalization object (which is derived from NormModel). The simplest way to create a NormModel class is to use the static Create method.

 Pvl p("mynormmodel.pvl");
 NormModel *ar = NormModelFactory::Create(p);

Author:: 2006-01-23 Janet Barrett

Member Function Documentation

NormModel * Isis::NormModelFactory::Create	(	Pvl &	pvl,
		PhotoModel &	pmodel,
		AtmosModel &	amodel
	)			`[static]`

Create a NormModel object using a PVL specification.

An example of the PVL required for this is:

 Object = NormalizationModel
   Group = Algorithm
     NormName/Name = ShadeAtm
     PhotoModel = Minnaert
     AtmosModel = Isotropic1
   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:: normalizationModels.doc

References _FILEINFO_, Isis::FileName::fileExists(), Isis::PvlObject::FindObject(), Isis::Plugin::GetPlugin(), Isis::PvlContainer::HasKeyword(), Isis::Pvl::Read(), Isis::PvlObject::Traverse, and Isis::IException::User.

NormModel * Isis::NormModelFactory::Create	(	Pvl &	pvl,
		PhotoModel &	pmodel
	)			`[static]`