Class FinalDimensions

java.lang.Object
net.imglib2.FinalDimensions
All Implemented Interfaces:
Dimensions, EuclideanSpace
public final class FinalDimensions extends Object implements Dimensions
An implementation of dimensionality that can wrap a long[] array. The same principle for wrapping as in Point is used.

  • Field Details

    • dimensions

      final long[] dimensions

  • Constructor Details

    • FinalDimensions

      protected FinalDimensions(long[] dimensions, boolean copy)
      Protected constructor that can re-use the passed position array.
      Parameters:
      dimensions - array used to store the position.
      copy - flag indicating whether position array should be duplicated.

    • FinalDimensions

      public FinalDimensions(long... dimensions)
      Create a FinalDimensions with a defined size
      Parameters:
      dimensions - the size

    • FinalDimensions

      public FinalDimensions(int... dimensions)
      Create a FinalDimensions with a defined size
      Parameters:
      dimensions - the size

    • FinalDimensions

      public FinalDimensions(Dimensions dimensions)
      Create a FinalDimensions with a defined size
      Parameters:
      dimensions - the size

  • Method Details

    • numDimensions

      public int numDimensions()
      Description copied from interface: EuclideanSpace
      Gets the space's number of dimensions.
      Specified by:
      numDimensions in interface EuclideanSpace

    • dimensions

      public void dimensions(long[] dims)
      Description copied from interface: Dimensions
      Write the number of pixels in each dimension into long[].
      Specified by:
      dimensions in interface Dimensions
      Parameters:
      dims -

    • dimension

      public long dimension(int d)
      Description copied from interface: Dimensions
      Get the number of pixels in a given dimension d.
      Specified by:
      dimension in interface Dimensions
      Parameters:
      d -

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • wrap

      public static FinalDimensions wrap(long[] dimensions)
      Create a FinalDimensions object that stores its coordinates in the provided position array.
      Parameters:
      dimensions - array to use for storing the position.