Class Spectrum

Hierarchy

Spectrum

Constructors

constructor

new Spectrum(): Spectrum

- Defined in Colord-1.0.d.ts:4474
Allocates a spectrum.

Returns Spectrum

Properties

Static name

name: string

Methods

addValue

addValue(data: number): void

- Defined in Colord-1.0.d.ts:4282
Adds a value in nm to the spectrum.

Parameters
- data: number
Returns void

dup

dup(): Spectrum

- Defined in Colord-1.0.d.ts:4283
Returns Spectrum

free

free(): void

- Defined in Colord-1.0.d.ts:4287
Deallocates a color spectrum.

Returns void

getData

getData(): number[]

- Defined in Colord-1.0.d.ts:4292
Gets the spectral data. NOTE: This is not normalized

Returns number[]

getEnd

getEnd(): number

- Defined in Colord-1.0.d.ts:4296
Gets the end value of the spectral data.

Returns number

getId

getId(): string

- Defined in Colord-1.0.d.ts:4300
Gets the spectral data.

Returns string

getNorm

getNorm(): number

- Defined in Colord-1.0.d.ts:4305
Gets the normalization value of the spectral data. NOTE: This affects every value in the spectrum.

Returns number

getResolution

getResolution(): number

- Defined in Colord-1.0.d.ts:4309
Gets the divisor of the spectra, for instance a .

Returns number

getSize

getSize(): number

- Defined in Colord-1.0.d.ts:4313
Gets the size of the spectrum data.

Returns number

getStart

getStart(): number

- Defined in Colord-1.0.d.ts:4317
Gets the start value of the spectral data.

Returns number

getValue

getValue(idx: number): number

- Defined in Colord-1.0.d.ts:4322
Gets the spectrum data at a specified index.

Parameters
- idx: number
  
  an index into the data
Returns number

getValueForNm

getValueForNm(wavelength: number): number

- Defined in Colord-1.0.d.ts:4327
Gets the value from the spectral data for a given wavelength.

Parameters
- wavelength: number
  
  the wavelength in nm
Returns number

getValueMax

getValueMax(): number

- Defined in Colord-1.0.d.ts:4331
Gets the largest normalised value in the spectrum.

Returns number

getValueMin

getValueMin(): number

- Defined in Colord-1.0.d.ts:4335
Gets the smallest normalised value in the spectrum.

Returns number

getValueRaw

getValueRaw(idx: number): number

- Defined in Colord-1.0.d.ts:4341
Gets the spectrum data at a specified index, without any normalization applied. Most people should use cd_spectrum_get_value() instead.

Parameters
- idx: number
  
  an index into the data
Returns number

getWavelength

getWavelength(idx: number): number

- Defined in Colord-1.0.d.ts:4346
Gets the wavelenth that corresponds to the specified index.

Parameters
- idx: number
  
  an index into the data
Returns number

getWavelengthCal

getWavelengthCal(c1: number, c2: number, c3: number): void

- Defined in Colord-1.0.d.ts:4354
Gets the calibration coefficients used to map pixel indexes to wavelengths.

Parameters
- c1: number
  
  the 1st coefficient
- c2: number
  
  the 2nd coefficient
- c3: number
  
  the 3rd coefficient
Returns void

limitMax

limitMax(value: number): void

- Defined in Colord-1.0.d.ts:4360
Ensures no values in the spectrum fall above a set limit. If they are found, set them to value.

Parameters
- value: number
  
  the threshold value to limit the spectrum
Returns void

limitMin

limitMin(value: number): void

- Defined in Colord-1.0.d.ts:4366
Ensures no values in the spectrum fall below a set limit. If they are found, set them to value.

Parameters
- value: number
  
  the threshold value to limit the spectrum
Returns void

multiply

multiply(s2: Spectrum, resolution: number): Spectrum

- Defined in Colord-1.0.d.ts:4372
Multiplies two spectra together.

Parameters
- s2: Spectrum
  
  a #CdSpectrum instance, possibly an absorption spectrum.
- resolution: number
  
  the step size in nm
Returns Spectrum

multiplyScalar

multiplyScalar(value: number): Spectrum

- Defined in Colord-1.0.d.ts:4377
Multiplies a spectra with a scalar value.

Parameters
- value: number
  
  a scalar value
Returns Spectrum

normalize

normalize(wavelength: number, value: number): void

- Defined in Colord-1.0.d.ts:4383
Normalizes a spectrum to a specific value at a specific wavelength.

Parameters
- wavelength: number
  
  the wavelength in nm
- value: number
  
  the value to normalize to
Returns void

normalizeMax

normalizeMax(value: number): void

- Defined in Colord-1.0.d.ts:4388
Normalizes a spectrum to a specific value at its maximum value.

Parameters
- value: number
  
  the value to normalize to
Returns void

resample

resample(start: number, end: number, resolution: number): Spectrum

- Defined in Colord-1.0.d.ts:4395
Resample a new spectrum with linear index to wavelength coefficients.

Parameters
- start: number
  
  the new spectrum start
- end: number
  
  the new spectrum end
- resolution: number
  
  the resolution to use when resampling
Returns Spectrum

resampleToSize

resampleToSize(size: number): Spectrum

- Defined in Colord-1.0.d.ts:4400
Resample a new spectrum with the desired number of points.

Parameters
- size: number
  
  the output spectrum size
Returns Spectrum

setData

setData(value: number[]): void

- Defined in Colord-1.0.d.ts:4405
Sets the spectrum data.

Parameters
- value: number[]
  
  component value
Returns void

setEnd

setEnd(end: number): void

- Defined in Colord-1.0.d.ts:4413
Set the end value of the spectal data in nm.

If there is already spectral data, the wavelength calibration will also be set automatically.

Parameters
- end: number
  
  the end value of the spectral data
Returns void

setId

setId(id: string): void

- Defined in Colord-1.0.d.ts:4418
Sets a spectrum id.

Parameters
- id: string
  
  component id
Returns void

setNorm

setNorm(norm: number): void

- Defined in Colord-1.0.d.ts:4424
Set the normalization value of the spectrum. NOTE: This affects every value in the spectrum.

Parameters
- norm: number
  
  the end value of the spectral data
Returns void

setStart

setStart(start: number): void

- Defined in Colord-1.0.d.ts:4429
Set the start value of the spectal data in nm.

Parameters
- start: number
  
  the start value of the spectral data
Returns void

setValue

setValue(idx: number, data: number): void

- Defined in Colord-1.0.d.ts:4435
Overwrites the spectrum data at a specified index.

Parameters
- idx: number
  
  an index into the data
- data: number
  
  a data value
Returns void

setWavelengthCal

setWavelengthCal(c1: number, c2: number, c3: number): void

- Defined in Colord-1.0.d.ts:4446
Sets the calibration coefficients used to map pixel indexes to wavelengths.

This function will set the 'end' wavelength automatically, potentially overwriting the value set by cd_spectrum_set_end().

Parameters
- c1: number
  
  the 1st coefficient
- c2: number
  
  the 2nd coefficient
- c3: number
  
  the 3rd coefficient
Returns void

subtract

subtract(s2: Spectrum, resolution: number): Spectrum

- Defined in Colord-1.0.d.ts:4453
Subtracts one spectral plot from another. If the spectra have the same start, end and the same number of data points they are not resampled.

Parameters
- s2: Spectrum
  
  a #CdSpectrum instance, e.g. a dark calibration
- resolution: number
  
  the resolution to use when resampling
Returns Spectrum

toString

toString(maxWidth: number, maxHeight: number): string

- Defined in Colord-1.0.d.ts:4459
Returns a graphical representation of the spectrum.

Parameters
- maxWidth: number
  
  the terminal width
- maxHeight: number
  
  the terminal height
Returns string

Static new

new(): Spectrum

- Defined in Colord-1.0.d.ts:4479
Allocates a spectrum.

Returns Spectrum

Static planckianNew

planckianNew(temperature: number): Spectrum

- Defined in Colord-1.0.d.ts:4485
Allocates a Planckian spectrum at a specific temperature.

Parameters
- temperature: number
  
  the temperature in Kelvin
Returns Spectrum

Static planckianNewFull

planckianNewFull(temperature: number, start: number, end: number, resolution: number): Spectrum

- Defined in Colord-1.0.d.ts:4494
Allocates a Planckian spectrum at a specific temperature.

Parameters
- temperature: number
  
  the temperature in Kelvin
- start: number
  
  the new spectrum start
- end: number
  
  the new spectrum end
- resolution: number
  
  the resolution to use when resampling
Returns Spectrum

Static sizedNew

sizedNew(reservedSize: number): Spectrum

- Defined in Colord-1.0.d.ts:4500
Allocates a spectrum with a preallocated size.

Parameters
- reservedSize: number
  
  the future size of the spectrum
Returns Spectrum