Package net.imglib2

Class FlatIterationOrder


  • public class FlatIterationOrder
    extends java.lang.Object
    A flat iteration order on an IterableInterval. Flat iteration order means that cursors iterate line by line, plane by plane, etc. For instance a 3D interval ranging from (0,0,0) to (1,1,1) is iterated like (0,0,0), (1,0,0), (0,1,0), (1,1,0), (0,0,1), (1,0,1), (0,1,1), (1,1,1)
    Author:
    Tobias Pietzsch, Christian Dietz
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Two Intervals are considered to have same iteration order if two Cursors return the same position in each iteration step, excluding dimensions of size 1.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • FlatIterationOrder

        public FlatIterationOrder​(Interval interval)
    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Two Intervals are considered to have same iteration order if two Cursors return the same position in each iteration step, excluding dimensions of size 1.

        In some cases the equals method is too restrictive, i.e. we have false negatives: e.g., both objects must be instances of FlatIterationOrder in order to be reported as equal.

        TODO: consider improving this definition

        Overrides:
        equals in class java.lang.Object
        Returns:
        true, if obj is a compatible FlatIterationOrder.