Package sc.fiji.snt.util

Record Class ImgUtils.SliceResult<T extends net.imglib2.type.numeric.RealType<T>>

java.lang.Object
java.lang.Record
sc.fiji.snt.util.ImgUtils.SliceResult<T>
Type Parameters:
T - pixel type
Record Components:
img - the extracted image slice with preserved metadata
channelIndex - the channel index that was extracted (0-based), or -1 if no channel axis existed or no channel was extracted
timeIndex - the time index that was extracted (0-based), or -1 if no time axis existed or no timepoint was extracted
Enclosing class:
ImgUtils
public static record ImgUtils.SliceResult<T extends net.imglib2.type.numeric.RealType<T>>(net.imagej.ImgPlus<T extends net.imglib2.type.numeric.RealType<T>> img, int channelIndex, int timeIndex) extends Record
Result of a channel/time slice extraction from an ImgPlus.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SliceResult(net.imagej.ImgPlus<T> img, int channelIndex, int timeIndex)
    Creates an instance of a SliceResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    channelIndex()
    Returns the value of the channelIndex record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    net.imagej.ImgPlus<T>
    img()
    Returns the value of the img record component.
    int
    timeIndex()
    Returns the value of the timeIndex record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SliceResult

      public SliceResult(net.imagej.ImgPlus<T> img, int channelIndex, int timeIndex)
      Creates an instance of a SliceResult record class.
      Parameters:
      img - the value for the img record component
      channelIndex - the value for the channelIndex record component
      timeIndex - the value for the timeIndex record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • img

      public net.imagej.ImgPlus<T> img()
      Returns the value of the img record component.
      Returns:
      the value of the img record component

    • channelIndex

      public int channelIndex()
      Returns the value of the channelIndex record component.
      Returns:
      the value of the channelIndex record component

    • timeIndex

      public int timeIndex()
      Returns the value of the timeIndex record component.
      Returns:
      the value of the timeIndex record component