Tutorial Toolkit Function Descriptions > Graphics > Spectrums
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Spectrums
 
ga_spectrum_colors_get
( name, colors )
Description:
Get the colors defined in a spectrum.
Input:
STRING
name[]
Spectrum name.
Output:
INTEGER
colors ( )
Color index values.
INTEGER
<Return Value>
GA error status.
Error Conditions:
11000030
The spectrum name is invalid.
11000106
The specified spectrum was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_colors_get (p. 177) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_colors_set
( name, offset, number, colors )
Description:
Set the colors in spectrum.
Input:
STRING
name[]
Name of spectrum.
INTEGER
offset
Starting position in color table where colors should be modified.
INTEGER
number
Number of colors in spectrum.
INTEGER
colors ( )
Color values.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000030
The spectrum name is invalid.
11000032
An incorrect offset was specified in spectrum color table.
11000031
An incorrect number of colors was specified for the spectrum.
11000106
The specified spectrum was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_colors_set (p. 179) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_continuous_get
( name, value )
 
Description:
Get the continuous tone flag.
Input:
STRING
name[]
Spectrum name.
Output:
INTEGER
value
Continuous tone flag.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000030
The spectrum name is invalid.
11000106
The specified spectrum was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_continuous_get (p. 180) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_continuous_set
( name, value )
Description:
Set the continuous tone flag.
Input:
STRING
name[]
Spectrum name.
INTEGER
value
Continuous tone flag.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000030
The spectrum name is invalid.
11000106
The specified spectrum was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
See example for ga_spectrum_colors_set, 72. See also ga_spectrum_continuous_set (p. 182) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_create
( name, number, colors )
Description:
Creates a spectrum color table.
Input:
STRING
name[]
Name of spectrum table.
INTEGER
number
Number of colors in spectrum.
INTEGER
colors ( )
Color index values.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000030
The spectrum name is invalid.
11000031
An incorrect number of colors was specified for the spectrum.
11000029
A spectrum with the given name is already in the database.
11000097
There is not enough disk space to complete operation.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_create (p. 183) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_current_get
( name )
Description:
Gets the current spectrum.
Input:
None.
Output:
STRING
name[]
Spectrum name.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000030
The spectrum name is invalid.
11000106
The specified spectrum was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_current_get (p. 185) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_current_set
( name )
Description:
Sets the current spectrum.
Input:
STRING
name[]
Spectrum name.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000030
The spectrum name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_current_set (p. 186) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_delete
( name )
 
Description:
Delete a spectrum table.
Input:
STRING
name[]
Name of spectrum table.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000030
The spectrum name is invalid.
11000106
The specified spectrum was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_delete (p. 188) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_interpolation_get
( name, factor )
Description:
Get the interpolation factor.
Input:
STRING
name[]
Spectrum name.
Output:
REAL
factor
Interpolation factor.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000030
The spectrum name is invalid.
11000106
The specified spectrum was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_interpolation_get (p. 190) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_interpolation_set
( name, factor )
Description:
Set the interpolation factor.
Input:
STRING
name[]
Spectrum name.
REAL
factor
Interpolation factor.
Output:
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000030
The spectrum name is invalid.
11000033
An incorrect interpolation factor was specified.
11000106
The specified spectrum was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
See example for ga_spectrum_colors_set, 72. See also ga_spectrum_interpolation_set (p. 191) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_ncolors_get
( name, number )
Description:
Get the number of colors defined in spectrum.
Input:
STRING
name[]
Spectrum name.
Output:
INTEGER
number
Number of colors.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000030
The spectrum name is invalid.
11000106
The specified spectrum was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_ncolors_get (p. 193) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_nspectrums_get
( nspectrums )
Description:
Gets the number of spectrums.
Input:
None.
Output:
INTEGER
nspectrums
Number of spectrums.
INTEGER
<Return Value>
See error conditions.
Error Conditions:
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_nspectrums_get (p. 194) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_rename
( old, new )
 
Description:
Rename a spectrum.
Input:
STRING
old[]
Current name of spectrum.
STRING
new[]
New name of spectrum.
Output:
INTEGER
<Return Value>
GA Error status
Error Conditions:
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_rename (p. 195) in the MSC Acumen Toolkit - Code Examples.
 
ga_spectrum_spectrums_get
( spectrums )
Description:
Gets the list of spectrums.
Input:
None.
Output:
STRING
spectrums [ ] ( )
List of spectrums.
INTEGER
<Return Value>
GA error status.
Error Conditions:
11000098
A fatal error has occurred in the database. Database is corrupted.
Example:
Please see ga_spectrum_spectrums_get (p. 196) in the MSC Acumen Toolkit - Code Examples.