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(loadColorFF: bool = True) -> OEOverlayOptions
OEOverlayOptions(argOptions: OEOverlayOptions) -> OEOverlayOptions

Default and copy constructors.

Assignment operator.
GetColorFuncType
GetColorFuncType() -> int
See SetColorFuncType method.

GetColorOptions
GetColorOptions() -> OEColorOptions
See SetColorOptions method.

GetMaxOptSteps
GetMaxOptSteps() -> int
See SetMaxOptSteps method.

GetOverlapFunc
GetOverlapFunc() -> OEOverlapFuncBase
See SetOverlapFunc method.

GetShapeFuncType
GetShapeFuncType() -> int
See SetShapeFuncType method.

GetShapeOptions
GetShapeOptions() -> OEShapeOptions
See SetShapeOptions method.

GetStarts
GetStarts() -> OEStarts
See SetStarts method.

SetColorFuncType
SetColorFuncType(value: int) -> bool
Set the type of color func to be used for estimating color scores, as defined in the OEColorType namespace. Default: OEColorType_Exact.

SetColorOptions
SetColorOptions(opts: OEColorOptions) -> None
Sets options related to color functions used.

SetMaxOptSteps
SetMaxOptSteps(value: int) -> bool
Set the maximum number of optimization iteration steps. Default: 200

SetOverlapFunc
SetOverlapFunc(func: OEOverlapFuncBase) -> bool
Set the overlap function by by passing in an OEOverlapFuncBase instance. This defines the shape/color interactions to be optimized for overlay.

SetShapeFuncType
SetShapeFuncType(value: int) -> bool
Set the type of shape func to be used for estimating shape overlap, as defined in the OEShapeType namespace. Default: OEShapeType_Grid.

SetShapeOptions
SetShapeOptions(opts: OEShapeOptions) -> None
Sets options related to shape functions used.

SetStarts
SetStarts(argStarts: OEStarts) -> None
Set the starts by by passing in an OEStarts instance. This defines the starts to be used for optimization.