Celestine API Documentation - v0.2.0
    Preparing search index...

    Function generateSearchSummary

    • Generate summary statistics for search results.

      Parameters

      • transits: TransitTiming[]

        Array of transit timings

      • startJD: number

        Search start date

      • endJD: number

        Search end date

      Returns {
          totalTransits: number;
          byAspect: Partial<Record<AspectType, number>>;
          byBody: Record<string, number>;
          dateRange: { start: TransitDate; end: TransitDate; days: number };
      }

      Summary statistics

      • totalTransits: number

        Total transits found

      • byAspect: Partial<Record<AspectType, number>>

        Transit count by aspect type

      • byBody: Record<string, number>

        Transit count by transiting body

      • dateRange: { start: TransitDate; end: TransitDate; days: number }

        Date range covered