Iterate parts of the processing pipeline.
This iterator executes the processing toolchain until the flow changes become small eanough or some given iteration count is reached.You have to activate at least one stop criterion by setting maxRuns or epsilon to a value greater than zero.
input slots | |
| InputSlot< CImgList< T > > | flow |
| flow result calculaged during current iteration | |
| InputSlot< CImgList< T > > | flowAdditional |
| additional flow | |
| InputSlot< CImgList< T > > | flowInit |
| initial flow guess if different from helper | |
| InputSlot< IteratorHelper< T > * > | helper |
| iterator helper input | |
| InputSlot< CImgList< T > > | residual |
| residual energy from current iteration | |
| InputSlot< CImgList< T > > | residualInit |
| residual energy from previous iteration | |
| InputSlot< bool > | stop |
| external stop criterion | |
output slots | |
| OutputSlot< CImgList< T > > | finalResidual |
| final residual after all iterations | |
| OutputSlot< CImgList< T > > | result |
| final flow result after all iterations | |
parameters | |
| Parameter< bool > | accumulate |
| set to true if iteration calculates flow difference (operates with zero initial guess) | |
| Parameter< double > | epsilon |
| flow change threshold | |
| Parameter< bool > | inverseResidual |
| return inverse residual, if set | |
| Parameter< unsigned int > | maxRuns |
| maximum number of iterations (0 to disable) | |
| Parameter< std::string > | norm |
| norm postprocessing (implemented: "max", "mean") | |
| Parameter< double > | updateRate |
| update rate, i.e. ratio of change that is used | |
| Parameter< std::string > | writeFlow |
| filename to write current flow to | |
| Parameter< std::string > | writeFlowInit |
| filename to write previous flow to | |
| Parameter< std::string > | writeResidual |
| filename to write current residual to | |
| Parameter< std::string > | writeResidualInit |
| filename to write previous residual to | |
This Module subclasses TemplatedParameteredObject< T >.
For documentation of parameters and slots inherited by this base class,
please have a look at the corresponding Module reference.
This module is templated. There are instances with T=int,float,double.
An additional parameter called templatetype
may be used to select which instantiation you want.
The detailed doxygen documentation beyond the parameters/slots may be found here.