Package net.imglib2

Class FlatIterationOrder

java.lang.Object
net.imglib2.FlatIterationOrder
public class FlatIterationOrder extends 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

  • Constructor Details

    • FlatIterationOrder

      public FlatIterationOrder(Interval interval)

  • Method Details

    • equals

      public boolean equals(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 Object
      Returns:
      true, if obj is a compatible FlatIterationOrder.