public class IterativeErosion extends AbstractIterativeArrayProcessor<Matrix<? extends UpdatablePArray>> implements IterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
Iterative erosion of the matrix.
This class is an implementation of IterativeArrayProcessor
interface,
performing erosion
of some source matrix (Matrix
(UpdatablePArray
))
by sequential Minkowski multiples
of some pattern: k⊗P, k=1,2,....
Every erosion is added to some accumulator matrix, named result and returned by
result()
method.
If the source matrix is binary, then each element of the result matrix will be an integer,
which is nonzero only for nonzero elements of the source one and which shows the distance from this point
to the nearest zero element, "measured" in the "sizes" of the pattern.
More precisely, in this implementation:
current context
in the returned instance is equal
to the current context of the Morphology
object, passed to getInstance
method.performIteration(ArrayContext)
method calculateserosion
(source_matrix,
Patterns.newMinkowskiSum
(ptn_{0},ptn_{1},...,ptn_{k}))
(k+1 summands),getInstance
method.
If only one pattern P was passed to getInstance
method,
it means the erosion by Minkowski multiple pattern
(k+1)⊗P.
This erosion is arithmetically added, with truncation of overflows, to the result matrix,
by Matrices.applyFunc(ArrayContext, Func, Matrix, Matrix, Matrix)
with
Func.X_PLUS_Y
function.
(Really, this method does not actually perform these operation, but performs equivalent
calculations with some optimization.)
done()
method returns true if the last erosion was the same as the previous erosion:
for bit matrices, it usually means that both erosions are zerofilled (all "objects" were removed).result()
method always returns the reference to the accumulator matrix result.The result matrix is created and zerofilled by getInstance
method,
and before the first iteration the source matrix is added to it (that means just copying).
Please note: there is no guarantees that result matrix, returned by result()
method,
is updated after each iteration. This class contains some optimization, that can lead to updating result
only after some iteration, for example, after iteration #8, #16, etc.
There is only the guarantee that result()
returns valid matrix
when done()
returns true.
This class may be applied to a matrix with any number of dimensions.
AlgART Laboratory 2007–2014
context, memoryModel
Modifier and Type  Method and Description 

boolean 
done()
Returns true if and only if the algorithm was successfully finished and there is
no sense to perform further iterations.

long 
estimatedNumberOfIterations()
Estimates the number of iterations, that should be performed from this moment to finish the algorithm.

static long 
estimatedNumberOfIterations(Matrix<? extends PArray> matrix,
Pattern pattern) 
void 
freeResources(ArrayContext context)
If there are some resources, allocated by this object, which are not controlled
by Java garbage collectors — files, streams, sockets, locks, etc. —
this method tries to release them (for example, to close any files).

static IterativeErosion 
getInstance(Morphology morphology,
java.lang.Class<? extends UpdatablePArray> requiredType,
Matrix<? extends PArray> matrix,
Pattern... patterns)
Creates new instance of this class.

void 
performIteration(ArrayContext context)
Performs the next iteration of the iterative algorithm.

Matrix<? extends UpdatablePArray> 
result()
Returns the result of the previous iteration.

java.lang.String 
toString()
Returns a brief string description of this object.

chain, context, limitIterations, part, process
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
chain, limitIterations, process
context
public static IterativeErosion getInstance(Morphology morphology, java.lang.Class<? extends UpdatablePArray> requiredType, Matrix<? extends PArray> matrix, Pattern... patterns)
morphology
 the Morphology
object that will be used for performing erosions.requiredType
 the type of builtin AlgART array for result()
matrix.
Should be enough for storing elementwise sums of hundreds of eroded matrices;
in other case, overflows will lead to trunctation of the sums.matrix
 the source matrix, that will be eroded by Minkowski sums of the passed patterns
(or just by Minkowski muptiples k⊗P, if patterns
argument contains only 1 pattern).patterns
 one or several patterns for performing erosion. For little pattern sizes, you may
specify several patterns with near form to increase the precision
of the resulting matrix.java.lang.NullPointerException
 if one of arguments or one of passed patterns is null.java.lang.IllegalArgumentException
 if patterns.length==0 (no patterns passed).public void performIteration(ArrayContext context)
IterativeArrayProcessor
IterativeArrayProcessor.done()
, the results are unspecified:
please never call this method if IterativeArrayProcessor.done()
returns true.
You usually don't need to call this method: please call
IterativeArrayProcessor.process()
instead.
If you need to perform only one or n iterations, you may use
limitIterations(n)
call.
Warning: this method should ignore the current execution context
of this object.
Instead, this method should use the context of execution specified by context argument.
This method is called by IterativeArrayProcessor.process()
method with the argument,
describing a subtrask
of the full algorithm.
The context argument may be null:
this method should work properly in this case (ignore the context).
This method must be implemented while creating a new iterative arrayprocessing algorithm.
performIteration
in interface IterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
performIteration
in class AbstractIterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
context
 the context used by this instance for all operations; may be null.public boolean done()
IterativeArrayProcessor
This method usually does not perform actual calculations and works very quickly (just returns and internal flag). However, this condition is not strict.
You usually don't need to call this method: it is automatically called by
IterativeArrayProcessor.process()
method.
This method must be implemented while creating a new iterative arrayprocessing algorithm.
done
in interface IterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
done
in class AbstractIterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
public long estimatedNumberOfIterations()
IterativeArrayProcessor
This method may require some time for its execution.
You usually don't need to call this method: it is automatically called from time to time by
IterativeArrayProcessor.process()
method.
It is used for creating subcontexts, describing a part
of the full task.
This method must be implemented while creating a new iterative arrayprocessing algorithm.
estimatedNumberOfIterations
in interface IterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
estimatedNumberOfIterations
in class AbstractIterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
public Matrix<? extends UpdatablePArray> result()
IterativeArrayProcessor
UpdatableArray
or
Matrix
<? extends UpdatableArray
>.
This method returns valid result even if no iterations were performed yet.
If IterativeArrayProcessor.done()
method returns true, the result of this method
is the final result of iterative processing performed by this instance.
This method may return null. In this case, the concrete implementation of this interface should provide additional methods for returning calculation results.
This method does not perform actual calculations and works very quickly.
This method must be implemented while creating a new iterative arrayprocessing algorithm.
result
in interface IterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
result
in class AbstractIterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
public void freeResources(ArrayContext context)
IterativeArrayProcessor
Usually, this method just calls
Array.freeResources(context)
and
Matrix.freeResources(context)
for all temporary arrays and matrices, allocated by this object for storing work data.
If IterativeArrayProcessor.result()
method returns AlgART array or matrix (typical situation),
this method calls Array.freeResources(context)
/
Matrix.freeResources(context)
methods
for this array / matrix.
This method may be used in situations when the instance of this object has long time life and will be reused in future.
This method must be implemented while creating a new iterative arrayprocessing algorithm.
freeResources
in interface IterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
freeResources
in class AbstractIterativeArrayProcessor<Matrix<? extends UpdatablePArray>>
context
 the context of execution; may be null, then it will be ignored.public java.lang.String toString()
toString
in class java.lang.Object