Ocean
Ocean::CV::Synthesis::Optimizer Class Referenceabstract

This class is the base class for all synthesis optimizers. More...

Inheritance diagram for Ocean::CV::Synthesis::Optimizer:

Public Member Functions

virtual bool invoke (const unsigned int radii, const unsigned int iterations=5u, const unsigned int maxSpatialCost=0xFFFFFFFFu, Worker *worker=nullptr, const bool applyInitialMapping=true) const =0
 Invokes the operator. More...
 
- Public Member Functions inherited from Ocean::CV::Synthesis::Operator
virtual ~Operator ()=default
 Destructs the object. More...
 

Protected Member Functions

 Optimizer (Layer &layer)
 Creates a new operator object. More...
 
- Protected Member Functions inherited from Ocean::CV::Synthesis::Operator
 Operator ()
 Creates a new operator object. More...
 
 Operator (const Operator &object)=delete
 Disabled copy constructor. More...
 
Operatoroperator= (const Operator &object)=delete
 Disabled copy operator. More...
 

Protected Attributes

Layerlayer_
 Optimizer layer. More...
 

Detailed Description

This class is the base class for all synthesis optimizers.

An optimizer tries to improve a given synthesis mapping to provide a more optimal synthesis result.
The optimizer should not be applied before the mapping has been initialized.

Constructor & Destructor Documentation

◆ Optimizer()

Ocean::CV::Synthesis::Optimizer::Optimizer ( Layer layer)
inlineprotected

Creates a new operator object.

Parameters
layerThe layer for that this operator is applied

Member Function Documentation

◆ invoke()

virtual bool Ocean::CV::Synthesis::Optimizer::invoke ( const unsigned int  radii,
const unsigned int  iterations = 5u,
const unsigned int  maxSpatialCost = 0xFFFFFFFFu,
Worker worker = nullptr,
const bool  applyInitialMapping = true 
) const
pure virtual

Invokes the operator.

Parameters
radiiNumber of improvement radii during one optimization iteration for each mapping position
iterationsNumber of optimization iterations that will be applied
maxSpatialCostMaximal spatial cost
workerOptional worker object to distribute the computation
applyInitialMappingTrue, to apply the initial mapping before the optimization starts
Returns
True, if succeeded

Implemented in Ocean::CV::Synthesis::OptimizerSubset.

Field Documentation

◆ layer_

Layer& Ocean::CV::Synthesis::Optimizer::layer_
protected

Optimizer layer.


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