Isis::NormModelFactory Class Reference

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

#include <NormModelFactory.h>

Collaboration diagram for Isis::NormModelFactory:

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.

Private Member Functions
	NormModelFactory ()
	Constructor (its private so you can't use it).
	~NormModelFactory ()
	Destroys the NormModelFactory.

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

History:

2006-01-23 Janet Barrett - Original version

2008-06-18 Steven Koechle - Fixed Documentation Errors

Definition at line 68 of file NormModelFactory.h.

Constructor & Destructor Documentation

Isis::NormModelFactory::NormModelFactory ( )

inlineprivate

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

Use the Create Method instead.

Definition at line 78 of file NormModelFactory.h.

Isis::NormModelFactory::~NormModelFactory ( )

inlineprivate

Destroys the NormModelFactory.

Definition at line 81 of file NormModelFactory.h.

Member Function Documentation

NormModel * Isis::NormModelFactory::Create ( Pvl &  pvl, PhotoModel &  pmodel  )

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

Definition at line 52 of file NormModelFactory.cpp.

References _FILEINFO_, Isis::PvlObject::findObject(), Isis::Plugin::GetPlugin(), Isis::PvlContainer::hasKeyword(), Isis::Pvl::read(), Isis::PvlObject::Traverse, and Isis::IException::User.

Referenced by Isis::Photometry::Photometry().

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

Definition at line 107 of file NormModelFactory.cpp.

References _FILEINFO_, Isis::PvlObject::findObject(), Isis::Plugin::GetPlugin(), Isis::PvlContainer::hasKeyword(), Isis::Pvl::read(), Isis::PvlObject::Traverse, and Isis::IException::User.

---

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

• src/base/objs/NormModelFactory/NormModelFactory.h
• src/base/objs/NormModelFactory/NormModelFactory.cpp