Class Spectrum

Hierarchy

Spectrum

Constructors

constructor

new Spectrum(): Spectrum

- Defined in @types/Gjs/Colord-1.0.d.ts:4332
Allocates a spectrum.

Returns Spectrum

Properties

Static name

name: string

Methods

add_value

add_value(data: number): void

- Defined in @types/Gjs/Colord-1.0.d.ts:4140
Adds a value in nm to the spectrum.

Parameters
- data: number
Returns void

dup

dup(): Spectrum

- Defined in @types/Gjs/Colord-1.0.d.ts:4141
Returns Spectrum

free

free(): void

- Defined in @types/Gjs/Colord-1.0.d.ts:4145
Deallocates a color spectrum.

Returns void

get_data

get_data(): number[]

- Defined in @types/Gjs/Colord-1.0.d.ts:4150
Gets the spectral data. NOTE: This is not normalized

Returns number[]

get_end

get_end(): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4154
Gets the end value of the spectral data.

Returns number

get_id

get_id(): string

- Defined in @types/Gjs/Colord-1.0.d.ts:4158
Gets the spectral data.

Returns string

get_norm

get_norm(): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4163
Gets the normalization value of the spectral data. NOTE: This affects every value in the spectrum.

Returns number

get_resolution

get_resolution(): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4167
Gets the divisor of the spectra, for instance a .

Returns number

get_size

get_size(): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4171
Gets the size of the spectrum data.

Returns number

get_start

get_start(): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4175
Gets the start value of the spectral data.

Returns number

get_value

get_value(idx: number): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4180
Gets the spectrum data at a specified index.

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

get_value_for_nm

get_value_for_nm(wavelength: number): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4185
Gets the value from the spectral data for a given wavelength.

Parameters
- wavelength: number
  
  the wavelength in nm
Returns number

get_value_max

get_value_max(): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4189
Gets the largest normalised value in the spectrum.

Returns number

get_value_min

get_value_min(): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4193
Gets the smallest normalised value in the spectrum.

Returns number

get_value_raw

get_value_raw(idx: number): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4199
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

get_wavelength

get_wavelength(idx: number): number

- Defined in @types/Gjs/Colord-1.0.d.ts:4204
Gets the wavelenth that corresponds to the specified index.

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

get_wavelength_cal

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

- Defined in @types/Gjs/Colord-1.0.d.ts:4212
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

limit_max

limit_max(value: number): void

- Defined in @types/Gjs/Colord-1.0.d.ts:4218
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

limit_min

limit_min(value: number): void

- Defined in @types/Gjs/Colord-1.0.d.ts:4224
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 @types/Gjs/Colord-1.0.d.ts:4230
Multiplies two spectra together.

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

multiply_scalar

multiply_scalar(value: number): Spectrum

- Defined in @types/Gjs/Colord-1.0.d.ts:4235
Multiplies a spectra with a scalar value.

Parameters
- value: number
  
  a scalar value
Returns Spectrum

normalize

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

- Defined in @types/Gjs/Colord-1.0.d.ts:4241
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

normalize_max

normalize_max(value: number): void

- Defined in @types/Gjs/Colord-1.0.d.ts:4246
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 @types/Gjs/Colord-1.0.d.ts:4253
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

resample_to_size

resample_to_size(size: number): Spectrum

- Defined in @types/Gjs/Colord-1.0.d.ts:4258
Resample a new spectrum with the desired number of points.

Parameters
- size: number
  
  the output spectrum size
Returns Spectrum

set_data

set_data(value: number[]): void

- Defined in @types/Gjs/Colord-1.0.d.ts:4263
Sets the spectrum data.

Parameters
- value: number[]
  
  component value
Returns void

set_end

set_end(end: number): void

- Defined in @types/Gjs/Colord-1.0.d.ts:4271
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

set_id

set_id(id: string): void

- Defined in @types/Gjs/Colord-1.0.d.ts:4276
Sets a spectrum id.

Parameters
- id: string
  
  component id
Returns void

set_norm

set_norm(norm: number): void

- Defined in @types/Gjs/Colord-1.0.d.ts:4282
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

set_start

set_start(start: number): void

- Defined in @types/Gjs/Colord-1.0.d.ts:4287
Set the start value of the spectal data in nm.

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

set_value

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

- Defined in @types/Gjs/Colord-1.0.d.ts:4293
Overwrites the spectrum data at a specified index.

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

set_wavelength_cal

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

- Defined in @types/Gjs/Colord-1.0.d.ts:4304
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 @types/Gjs/Colord-1.0.d.ts:4311
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

to_string

to_string(max_width: number, max_height: number): string

- Defined in @types/Gjs/Colord-1.0.d.ts:4317
Returns a graphical representation of the spectrum.

Parameters
- max_width: number
  
  the terminal width
- max_height: number
  
  the terminal height
Returns string

Static new

new(): Spectrum

- Defined in @types/Gjs/Colord-1.0.d.ts:4337
Allocates a spectrum.

Returns Spectrum

Static planckian_new

planckian_new(temperature: number): Spectrum

- Defined in @types/Gjs/Colord-1.0.d.ts:4343
Allocates a Planckian spectrum at a specific temperature.

Parameters
- temperature: number
  
  the temperature in Kelvin
Returns Spectrum

Static planckian_new_full

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

- Defined in @types/Gjs/Colord-1.0.d.ts:4352
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 sized_new

sized_new(reserved_size: number): Spectrum

- Defined in @types/Gjs/Colord-1.0.d.ts:4358
Allocates a spectrum with a preallocated size.

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