Package no.marec.lsss.api.regions

Interface Regions

@DoNotImplement public interface Regions
A collection of Regions.

  • Method Details

    • selected

      ObservableValue<? extends Collection<? extends Region>> selected()
      Returns an observable for the selected regions.
      Returns:
      an observable for the selected regions

    • setSelected

      void setSelected(Collection<? extends Region> regions)
      Replaces the selected regions.
      Parameters:
      regions - the regions to be selected

    • changed

      Observable<? extends RegionChangeEvent> changed()
      Returns an observable for regions that are modified.
      Returns:
      an observable for regions that are modified

    • deleted

      Observable<? extends Collection<? extends Region>> deleted()
      Returns an observable for regions that are deleted.
      Returns:
      an observable for regions that are deleted

    • labelsChanged

      Observable<? extends Region> labelsChanged()
      Returns an observable for regions with modified labels.
      Returns:
      an observable for regions with modified labels

    • depthRanges

      List<? extends FloatRange> depthRanges(Region region, Ping ping, int channel)
      Gets the effective depth intervals for a region.

      This takes into account:

      • Schools on top of layers
      • Ping interval exclusions
      • Depth dependent deletion
      Parameters:
      region - a region
      ping - a ping
      channel - a channel
      Returns:
      a list of depth ranges

    • finishedEditingInterpretations

      void finishedEditingInterpretations()
      Should be called after editing one or more Interpretation.

    • interpretationChanged

      Observable<?> interpretationChanged()
      Returns an observable for changed interpretation.
      Returns:
      an observable for changed interpretation

    • createSchool

      @Nullable Region createSchool(Map<PingIndex,List<FloatRange>> mask)
      Creates a new school.
      Parameters:
      mask - the school mask as a map from ping index to depth ranges
      Returns:
      the new school, or null if a school could not be created