OEHermiteOverlayOptions

Attention

This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

class OEHermiteOverlayOptions : public OESystem::OEOptions

This class provides an interface to set up options required for OEHermiteOverlay.

The OEHermiteOverlayOptions class defines the following public methods:

GetHermiteOptions and SetHermiteOptions
GetMaxOptSteps and SetMaxOptSteps
GetStarts and SetStarts

Constructors

OEHermiteOverlayOptions()
OEHermiteOverlayOptions(const OEHermiteOverlayOptions&)

Default and copy constructors.

operator=

OEHermiteOverlayOptions &operator=(const OEHermiteOverlayOptions &)

GetHermiteOptions
OEHermiteOptions& GetHermiteOptions()
const OEHermiteOptions& GetHermiteOptions() const
See the SetHermiteOptions method.

GetMaxOptSteps
unsigned GetMaxOptSteps() const
See the SetMaxOptSteps method.

GetStarts
const OEStarts& GetStarts() const
See the SetStarts method.

SetHermiteOptions
bool SetHermiteOptions(const OEHermiteOptions&)
Sets the Hermite parameters that control the Hermite expansion of reference and fit objects via the OEHermiteOptions class.

SetMaxOptSteps
bool SetMaxOptSteps(const unsigned int)
Sets the maximum number of optimization iteration steps. Default: 200.

SetStarts
void SetStarts(const OEStarts&)
Set the starts by passing in an OEStarts instance. This defines the starts to be used for optimization.