@libraz/libcantus - v1.1.0
    Preparing search index...

    Type Alias FormSectionOptions

    Options for sectionsFromNotes.

    type FormSectionOptions = {
        ts?: MeterLike;
        meters?: MeterLike;
        unitBars?: number;
        threshold?: number;
        totalBeats?: number;
        budget?: number;
    }
    Index

    A single time signature held across the whole span, as sugar for a one-element meters; defaults to 4/4. Giving both is an input error.

    4/4

    meters?: MeterLike

    The meter as it changes over the span, so a piece that changes metre is cut at its own bar lines.

    4/4 throughout
    
    unitBars?: number

    Length of the unit spans are compared in, in bars; defaults to one hyperbar.

    Sections are found by comparing equal units and merging the neighbours that match, so this is the resolution of the answer rather than the length of a section: a section is any whole number of units long.

    the inferred hyperbar, in bars
    
    threshold?: number

    How alike two units must be before the later one is called a restatement of the earlier, in [0, 1].

    0.8

    totalBeats?: number

    End of the analysed span in beats; defaults to the end of the last note.

    the end of the last note
    
    budget?: number

    Upper bound on the work this call may do.