Class SegmentedObjectsAtScale

Object
SegmentedObjectsAtScale

public class SegmentedObjectsAtScale extends Object
Exposes a particular set of segmented-objects at a particular scale.
Author:
Owen Feehan
  • Constructor Details

    • SegmentedObjectsAtScale

      public SegmentedObjectsAtScale(List<LabelledWithConfidence<MultiScaleObject>> source, Function<MultiScaleObject,ObjectMask> extractObject, Stack background, StackDisplayer displayer, ExecutionTimeRecorder executionTimeRecorder, String executionTimeSuffix)
      Creates a new SegmentedObjectsAtScale instance.
      Parameters:
      source - A list containing MultiScaleObject from which we derive other representations at a specific scale.
      extractObject - Extracts an ObjectMask at the desired specific scale from a MultiScaleObject in source.
      background - The background image associated with this particular scale.
      displayer - How to convert the background in an image suitable to be displayed.
      executionTimeRecorder - Records the execution-time of particular operations.
      executionTimeSuffix - Appended to the execution-time identifiers to indicate more precisely what is being recorded.
  • Method Details

    • listWithLabels

      public List<LabelledWithConfidence<ObjectMask>> listWithLabels()
      Create a List of all contained objects, including confidence.
      Returns:
      a newly created List that reuses the existing ObjectMask stored in the structure.
    • listWithoutLabels

      public List<WithConfidence<ObjectMask>> listWithoutLabels()
      Create a List of all contained objects, including confidence.
      Returns:
      a newly created List that reuses the existing ObjectMask stored in the structure.
    • objects

      public ObjectCollection objects()
      Create a ObjectCollection of all contained objects, excluding confidence.
      Returns:
      ObjectCollection derived from source and cached.
    • objectsWithProperties

      public ObjectCollectionWithProperties objectsWithProperties()
      Like objects() but instead creates a ObjectCollectionWithProperties containing empty properties.
      Returns:
      an ObjectCollection derived from objects() and cached.
    • backgroundDisplayStack

      public DisplayStack backgroundDisplayStack()
      Like background() but instead creates a DisplayStack.
      Returns:
      a DisplayStack derived from background() and cached.
    • extent

      public Extent extent()
      The width and height and depth of the background image, associated with the objects.

      i.e. the size of each of the three possible dimensions.

      All objects should reside exclusively within this space.

      Returns:
      the extent.
    • size

      public int size()
      A count of the total number of elements in each representation.
      Returns:
      the total number of elements, valid for all representations.
    • background

      public Stack background()
      The background image associated with this particular scale.