OEOverlayOptions

class OEOverlayOptions : public OESystem::OEOptions

This class provides an interface to setup options required for OEOverlay.

The OEOverlayOptions class defines the following public methods:

• GetColorFuncType and SetColorFuncType

• GetColorOptions and SetColorOptions

• GetMaxOptSteps and SetMaxOptSteps

• GetOverlapFunc and SetOverlapFunc

• GetShapeFuncType and SetShapeFuncType

• GetShapeOptions and SetShapeOptions

• GetStarts and SetStarts

Constructors

OEOverlayOptions()
OEOverlayOptions(const OEOverlayOptions&)

Default and copy constructors.

operator=

OEOverlayOptions &operator=(const OEOverlayOptions &)

GetColorFuncType

unsigned GetColorFuncType() const

See SetColorFuncType method.

GetColorOptions

OEColorOptions& GetColorOptions()
const OEColorOptions& GetColorOptions() const

See SetColorOptions method.

GetMaxOptSteps

unsigned GetMaxOptSteps() const

See SetMaxOptSteps method.

GetOverlapFunc

const OEOverlapFuncBase& GetOverlapFunc() const

See SetOverlapFunc method.

GetShapeFuncType

unsigned GetShapeFuncType() const

See SetShapeFuncType method.

GetShapeOptions

OEShapeOptions& GetShapeOptions()
const OEShapeOptions& GetShapeOptions() const

See SetShapeOptions method.

GetStarts

const OEStarts& GetStarts() const

See SetStarts method.

SetColorFuncType

bool SetColorFuncType(const unsigned)

Set the type of color func to be used for estimating color scores, as defined in the OEColorType namespace. Default: OEColorType.Exact.

SetColorOptions

bool SetColorOptions(const OEColorOptions&)

Sets options related to color functions used.

SetMaxOptSteps

bool SetMaxOptSteps(const unsigned int)

Set the maximum number of optimization iteration steps. Default: 200

SetOverlapFunc

void SetOverlapFunc(const OEOverlapFuncBase&)

Set the overlap function by by passing in an OEOverlapFuncBase instance. This defines the shape/color interactions to be optimized for overlay.

SetShapeFuncType

bool SetShapeFuncType(const unsigned)

Set the type of shape func to be used for estimating shape overlap, as defined in the OEShapeType namespace. Default: OEShapeType.Grid.

SetShapeOptions

bool SetShapeOptions(const OEShapeOptions&)

Sets options related to shape functions used.

SetStarts

void SetStarts(const OEStarts&)

Set the starts by by passing in an OEStarts instance. This defines the starts to be used for optimization.