Package sc.fiji.snt.io

Record Class SpimDataUtils.N5Sources

java.lang.Object
java.lang.Record
sc.fiji.snt.io.SpimDataUtils.N5Sources
Record Components:
sources - One SourceAndConverter per channel/setup, in discovery order.
numTimepoints - Number of timepoints shared by all sources.
name - Display name derived from the container's directory name.
chunkShape - Chunk (block) shape of the full-resolution array in N5 axis order (x, y, z[, c, t]), or null if unknown.
remote - Whether the container is read over the network (as opposed to a local file).
Enclosing class:
SpimDataUtils
public static record SpimDataUtils.N5Sources(List<bdv.viewer.SourceAndConverter<?>> sources, int numTimepoints, String name, int[] chunkShape, boolean remote) extends Record
Holds the sources produced by opening an N5 or OME-Zarr container via n5-ij/n5-universe/n5-viewer_fiji (see SpimDataUtils.resolvePathToSource(String)). Unlike AbstractSpimData, there is no BDV-XML descriptor involved: sources are built directly from the container's own N5/OME-NGFF metadata via N5Viewer.buildN5Sources(org.janelia.saalfeldlab.n5.N5Reader, org.janelia.saalfeldlab.n5.ui.DataSelection, bdv.cache.SharedQueue, java.util.List<bdv.tools.brightness.ConverterSetup>, java.util.List<bdv.viewer.SourceAndConverter<T>>, bdv.util.BdvOptions).

  • Constructor Summary

    Constructors
    Constructor
    Description
    N5Sources(List<bdv.viewer.SourceAndConverter<?>> sources, int numTimepoints, String name)
    Creates sources whose chunk shape is unknown
    N5Sources(List<bdv.viewer.SourceAndConverter<?>> sources, int numTimepoints, String name, int[] chunkShape)
    Creates sources of a local container whose chunk shape is known
    N5Sources(List<bdv.viewer.SourceAndConverter<?>> sources, int numTimepoints, String name, int[] chunkShape, boolean remote)
    Creates an instance of a N5Sources record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int[]
    chunkShape()
    Returns the value of the chunkShape 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.
    String
    name()
    Returns the value of the name record component.
    int
    numTimepoints()
    Returns the value of the numTimepoints record component.
    boolean
    remote()
    Returns the value of the remote record component.
    List<bdv.viewer.SourceAndConverter<?>>
    sources()
    Returns the value of the sources 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

    • N5Sources

      public N5Sources(List<bdv.viewer.SourceAndConverter<?>> sources, int numTimepoints, String name, int[] chunkShape)
      Creates sources of a local container whose chunk shape is known

    • N5Sources

      public N5Sources(List<bdv.viewer.SourceAndConverter<?>> sources, int numTimepoints, String name)
      Creates sources whose chunk shape is unknown

    • N5Sources

      public N5Sources(List<bdv.viewer.SourceAndConverter<?>> sources, int numTimepoints, String name, int[] chunkShape, boolean remote)
      Creates an instance of a N5Sources record class.
      Parameters:
      sources - the value for the sources record component
      numTimepoints - the value for the numTimepoints record component
      name - the value for the name record component
      chunkShape - the value for the chunkShape record component
      remote - the value for the remote 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.

    • sources

      public List<bdv.viewer.SourceAndConverter<?>> sources()
      Returns the value of the sources record component.
      Returns:
      the value of the sources record component

    • numTimepoints

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

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • chunkShape

      public int[] chunkShape()
      Returns the value of the chunkShape record component.
      Returns:
      the value of the chunkShape record component

    • remote

      public boolean remote()
      Returns the value of the remote record component.
      Returns:
      the value of the remote record component