Use-chromatone documentation / Exports / Calculations

Module: Calculations ​

Description

All the basic math for note-frequency convertion

Table of contents ​

Variables ​

• midiA

Functions ​

• freqColor
• freqPitch
• getCents
• getCircleCoord
• getStandardFrequency
• isInChroma
• midiColor
• pitchColor
• pitchFreq
• pitchNoteOctave
• rotateArray

Variables ​

midiA ​

• Const midiA: 69

Note 0 in MIDI

Defined in ​

use/calculations.ts:9

Functions ​

freqColor ​

▸ freqColor(freq): string

Get a color for a certain pitch frequency in Hz

Parameters ​

Returns ​

string

Defined in ​

use/calculations.ts:61

freqPitch ​

▸ freqPitch(freq, middleA?): number

Get a pitch from a frequency

Parameters ​

Returns ​

number

Defined in ​

use/calculations.ts:68

getCents ​

▸ getCents(frequency, pitch): number

Get cents difference between a certain pitch and an arbitrary frequency

Parameters ​

Returns ​

number

Defined in ​

use/calculations.ts:98

getCircleCoord ​

▸ getCircleCoord(n?, total?, radius?, width?): Object

Radial coordinates calculation

Parameters ​

Returns ​

Object

Defined in ​

use/calculations.ts:82

getStandardFrequency ​

▸ getStandardFrequency(pitch, middleA?): number

Get a frequency for any given pitch

Parameters ​

Returns ​

number

Defined in ​

use/calculations.ts:106

isInChroma ​

▸ isInChroma(chroma, tonic, note): boolean

Check if a note in included in a chroma string

Parameters ​

Returns ​

boolean

Defined in ​

use/calculations.ts:75

midiColor ​

▸ midiColor(note): string

Parameters ​

Returns ​

string

Defined in ​

use/calculations.ts:11

pitchColor ​

▸ pitchColor(pitch?, octave?, velocity?, alpha?): string

Get a color for any given pitch and octave (velocity and alpha are also configurable)

Parameters ​

Returns ​

string

Defined in ​

use/calculations.ts:50

pitchFreq ​

▸ pitchFreq(pitch?, octave?, middleA?, tuning?): number

Determine a frequency in Hz out of a pitch with octave and optional tuning info

Parameters ​

Returns ​

number

Defined in ​

use/calculations.ts:29

pitchNoteOctave ​

▸ pitchNoteOctave(pitch): Object

Convert an unbound pitch to 0-11 pitch + octave

Parameters ​

Returns ​

Object

Defined in ​

use/calculations.ts:19

rotateArray ​

▸ rotateArray(arr, count?): any[]

Rotate and array by a number of steps

Parameters ​

Returns ​

any[]

Defined in ​

use/calculations.ts:91