utils/units#

convertFrequency()#

function convertFrequency(
   value, 
   fromUnit, 
   toUnit, 
   carrierFrequencyHz?): number;

Convert frequency value from one unit to another. Note: PPM conversion requires carrier frequency (not handled here - returns as-is).

Parameters#

Parameter	Type
`value`	`number`
`fromUnit`	`FrequencyUnit`
`toUnit`	`FrequencyUnit`
`carrierFrequencyHz?`	`number`

Returns#

number

convertFrequencyArray()#

function convertFrequencyArray(
   values, 
   fromUnit, 
   toUnit, 
   carrierFrequencyHz?): number[];

Convert an array of frequency values between units.

Parameters#

Parameter	Type
`values`	`number`[]
`fromUnit`	`FrequencyUnit`
`toUnit`	`FrequencyUnit`
`carrierFrequencyHz?`	`number`

Returns#

number[]

createNMRDurationSelector()#

function createNMRDurationSelector(target): (RootState) => Duration | undefined;

Parameters#

Parameter	Type
`target`	`NMRPulseDirection`

Returns#

(RootState) => Duration | undefined

createNMRDurationsSelector()#

function createNMRDurationsSelector<T>(targets): (state) => Record<T[number], Duration | undefined>;

Type Parameters#

Type Parameter
`T` extends readonly `NMRPulseDirection`[]

Parameters#

Parameter	Type
`targets`	`T`

Returns#

(state) => Record<T[number], Duration | undefined>

durationToSeconds()#

function durationToSeconds(duration): number;

Parameters#

Parameter	Type
`duration`	`Duration`

Returns#

number

formatDurationNice()#

function formatDurationNice(duration): string;

Parameters#

Parameter	Type
`duration`	`Duration`

Returns#

string

getFrequencyUnitLabel()#

function getFrequencyUnitLabel(frequencyUnit?): string;

Parameters#

Parameter	Type
`frequencyUnit?`	`FrequencyUnit`

Returns#

string

getLinearUnitLabel()#

function getLinearUnitLabel(linearUnit): string;

Parameters#

Parameter	Type
`linearUnit`	`LinearUnit`

Returns#

string

getTimeUnitLabel()#

function getTimeUnitLabel(timeUnit): string;

Parameters#

Parameter	Type
`timeUnit`	`TimeUnit`

Returns#

string