Package pl.poznan.put.circular

Class Histogram

java.lang.Object
pl.poznan.put.circular.Histogram
Direct Known Subclasses:
ImmutableHistogram
@Immutable public abstract class Histogram extends Object
A collection of angular observations put into bins of specified width.

  • Constructor Details

    • Histogram

      public Histogram()

  • Method Details

    • data

      @Parameter(order=1) public abstract Collection<Angle> data()
      Returns:
      A collection of angular data.

    • binWidth

      @Parameter(order=2) public abstract double binWidth()
      Returns:
      The width of bin in range [0, pi).

    • largestBinSize

      public final double largestBinSize()
      Finds the largest bin and calculate its relative size.
      Returns:
      Value in range [0; 1] describing relative size of the largest bin.

    • findBin

      public final Collection<Angle> findBin(double radiansStart)
      Finds a bin which starts at a given point.
      Parameters:
      radiansStart - Value in radians which describes bin starting point (precision 1.0e-3).
      Returns:
      A collection of circular values in the found bin.

    • bins

      @Lazy protected Collection<pl.poznan.put.circular.Histogram.Bin> bins()

    • check

      @Check protected void check()