Interface Coords.Builder

All Superinterfaces:
Coords.CoordsBuilder
Enclosing interface:
Coords
public static interface Coords.Builder extends Coords.CoordsBuilder
The real Builder for Coords.

  • Method Details

    • build

      Coords build()
      Specified by:
      build in interface Coords.CoordsBuilder

    • channel

      Coords.Builder channel(int channel)
      Set the channel index. Equivalent to index(Coords.CHANNEL, channel).
      Specified by:
      channel in interface Coords.CoordsBuilder
      Parameters:
      channel - channel index (0-based)
      Returns:
      this

    • c

      Coords.Builder c(int channel)
      Shorthand for channel.
      Parameters:
      channel - channel index (0-based)
      Returns:
      this

    • timePoint

      Coords.Builder timePoint(int frame)
      Set the time point (frame) index. Equivalent to index(Coords.TIME_POINT, frame).
      Parameters:
      frame - time point (frame) index (0-based)
      Returns:
      this

    • time

      @Deprecated Coords.Builder time(int timepoint)
      Deprecated.
      Due to being confusing with physical time.
      Same as timePoint.
      Specified by:
      time in interface Coords.CoordsBuilder
      Parameters:
      timepoint - (0-based)
      Returns:
      this

    • t

      Coords.Builder t(int timepoint)
      Shorthand for time.
      Parameters:
      timepoint - (0-based)
      Returns:
      this

    • zSlice

      Coords.Builder zSlice(int slice)
      Set the Z slice index. Equivalent to index(Coords.Z_SLICE, slice).
      Parameters:
      slice - z slice index (0-based)
      Returns:
      this

    • z

      Coords.Builder z(int slice)
      Shorthand for zSlice(int). Set the Z slice index. Equivalent to index(Coords.Z_SLICE, slice).
      Specified by:
      z in interface Coords.CoordsBuilder
      Parameters:
      slice - z slice index (0-based)
      Returns:
      this

    • stagePosition

      Coords.Builder stagePosition(int index)
      Set the stage position index. Equivalent to index(Coords.STAGE_POSITION, index).
      Specified by:
      stagePosition in interface Coords.CoordsBuilder
      Parameters:
      index - stage position index (0-based)
      Returns:
      this

    • p

      Coords.Builder p(int index)
      Shorthand for stagePosition. Set the stage position index. Equivalent to index(Coords.STAGE_POSITION, index).
      Parameters:
      index - stage position index (0-based)
      Returns:
      this

    • index

      Coords.Builder index(String axis, int index)
      Set the index along a given axis.

      If you set a negative value, the axis will be removed.

      Specified by:
      index in interface Coords.CoordsBuilder
      Parameters:
      axis - coordinate axis, such as Coords.CHANNEL
      index - 0-based index
      Returns:
      this

    • removeAxis

      Coords.Builder removeAxis(String axis)
      Remove the specified axis.
      Specified by:
      removeAxis in interface Coords.CoordsBuilder
      Parameters:
      axis - coordinate axis, such as Coords.CHANNEL
      Returns:
      this

    • offset

      Coords.Builder offset(String axis, int offset) throws IllegalArgumentException, IndexOutOfBoundsException
      Offset the given axis by a given count.
      Specified by:
      offset in interface Coords.CoordsBuilder
      Parameters:
      axis - coordinate axis, such as Coords.CHANNEL
      offset - offset to be applied to axis
      Returns:
      this
      Throws:
      IllegalArgumentException - if axis does not exist
      IndexOutOfBoundsException - if applying the offset would result in a negative index.