Id

int (4)

Database primary key of the spectrum. Set to 0, when you want to create a new spectrum, anyway set to the appropriate Id

Name

string

Name of the spectrum

Description

string

Long description of the spectrum

Ucd

string

Universal Content Descriptor

Ra

double (8)

Right ascenation of the object in J2000

Dec

double (8)

Declination of the object in J2000

Cx

double (8)

Cy

double (8)

Cz

double (8)

HtmId

long (8)

HTM ID of the object

Synthetic

bool

Flag for synthetic or composite spectra

Z

float (4)

Redshift of the spectrum

ZError

float (4)

Error of redshift of the spectrum

ZStatus

enum

Status of the redshift value following the conventions

ZWarning

enum

Warning flags about the redshift following the conventions used in SDSS

ZCofidence

float (4)

Confidence of Z value

Class

enum

Class of the spatial object

SurveyID

long (8)

Identifies the large sky surveys

ObjectID

long (8)

Original ID of the spatial object in the survey's catalog

DateMeasured

datetime

Date of exposition of the spectrum

DateCreated

datetime

Date of registration into the database, read-only

DateModified

datetime

Date of the last modification, read-only

WavelengthMin

double (8)

Minimum of the wavelength interval, read-only, calculated by the service

WavelengthMax

double (8)

Maximum of the wavelength interval, read-only, calculated by the service

WavelengthScale

enum

Wavelenght scale
0: Linear
1: Logarithmic
2: Other

ValueUnitId

int (4)

Unit of the values of the spectrum
1: Jy (10e-17 ergs/s/cm^2/A)
2: counts (uncalibrated)

Public

bool

Determines whether the spectrum is accessible by other users than the one who added the spectrum to the database

UserFolder

int (4)

ID of your 'My Spectra' folder.

Keys

array

An array of Key object containing custom data fields

Points

array

An array of Point objects to store wavelength-value pairs

Name

string

A name identifying the custom field

Value

string

The value, which can be either numeric or string

CreateSpectrum

Records a new spectrum header to the database

string UserGUID

Your WebServiceId

string name

Name of the spectrum

string description

Long description of the spectrum

string ucd

Universal Content Descriptor

double ra

Right ascenation of the object in J2000

double dec

Declination of the object in J2000

float z

Redshift of the spectrum

float zError

Error of redshift of the spectrum

enum spectrumClass

Class of the spatial object

enum wavelengthScale

Linear = 0 or Logarithmic = 1 or Other = 2

return value int

Returns the database ID of the new spectrum

CreateSpectrumIndirect

Records a new spectrum header to the database, but accepts a standard SOAP Spectrum object as an imput parameter. Can be used from SOAP client only. Also records the SpectrumPoint objects in one step.

string UserGUID

Your WebServiceId

object spectrum

Spectrum to record to the database

return value int

Returns the database ID of the new spectrum

ModifySpectrum

Modifies an existing spectrum header

int spectrumId

ID of the spectrum to modify

string UserGUID

Your WebServiceId

string name

Name of the spectrum

string description

Long description of the spectrum

string ucd

Universal Content Descriptor

double ra

Right ascenation of the object in J2000

double dec

Declination of the object in J2000

float z

Redshift of the spectrum

float zError

Error of redshift of the spectrum

enum spectrumClass

Class of the spatial object

enum wavelengthScale

Linear = 0 or Logarithmic = 1 or Other = 2

return value bool

Returns true when the spectrum modified successfully, otherwise false

ModifySpectrumIndirect

Modifies an existing spectrum header record.
Note! Since a SOAP spectrum object can contain spectrum points, and those can be sent to this method too, you should know that this function does not modify the wavelength-value pairs, only the header info. To modify points, delete them first using the DeleteSpectrumPoints method, and insert the new points with AppendSpectrumPointIndirect.

string UserGUID

Your WebServiceId

object spectrum

The spectrum to modify with the new data in a SOAP object. The object's SpectrumId must be specified.

return value bool

Returns true when the spectrum modified successfully, otherwise false

DeleteSpectrum

Deletes a spectrum from the database by it's ID

string UserGUID

Your WebServiceId

int id

ID of the spectrum to delete

return value bool

Returns true when the spectrum deleted successfully, otherwise false

DeleteSpectrumIndirect

Deletes a spectrum from the database by it's ID. Accepts a Spectrum SOAP object as input.

string userGUID

Your WebServiceId

object spectrum

The spectrum to delete in the form of a SOAP object. The object's SpectrumId must be specified.

return value bool

Returns true when the spectrum deleted successfully, otherwise false

AppendSpectrumPoint

Appends a wavelength-value pair to a spectrum specified by its Id

string UserGUID

Your WebServiceId

int spectrumId

Id of the spectrum which the new wavelength-value pair to attach

float wavelength

Wavelength in Angstroms

float response

Value

float error

Error of value

return value bool

Returns true when the new wavelength-value pair appended successfully, otherwise false

AppendSpectrumPointIndirect

Appends an array of wavelength-value pairs to a spectrum specified by its Id

string UserGUID

Your WebServiceId

int spectrumId

Id of the spectrum which the new wavelength-response pairs to attach

array responses

An array of wavelength-value pairs in the form of a SOAP array.

return value bool

Returns true when the new wavelength-value pairs appended successfully, otherwise false

DeleteSpectrumPoints

Deletes all wavelength-value pairs associated with the spectrum

string UserGUID

Your WebServiceId

int spectrumId

Id of the spectrum whose wavelength-value pairs should be deleted

return value bool

Returns true when the points deleted succesfully, otherwise false

GetSpectrum
GetSpectrumAscii

Returns a Spectrum in different formats. The function can return the header only, or the values too.

int id

Id of the spectrum to return

bool returnPoints

If true, function returns spectrum values too

return value object

The spectrum in a SOAP XML object, VOTable or an ascii string

FindSpectraByKeyword

Performs a LIKE query on the spectra table and returns results as an array of spectra. The search is performed on the following columns of the Spectra table: Name, Description, UCD

bool returnPoints

If true, function returns spectrum values too

return value array

The array of spectra matching the criterium

FindSpectraAdvanced

Returns spectra matching the advanced criteria. The different search conditions are connected with AND. Specify zero string ("") to omit condition with string data type, and -1 for numeric data types.

string keyword

LIKE query in the following columns of the Spectra table: Name, Description, UCD, Version.

string name

LIKE query on the Name column.

string description

LIKE query on the Description column.

string ucd

LIKE query on the UCD column.

double raFrom

Minimum of ra in J2000

double raTo

Maximum of ra in J2000

double decFrom

Minimum of dec in J2000

double decTo

Maximum of dec in J2000

float zFrom

Minimum of redshift

float zTo

Maximum of redshift

float zErrorFrom

Minimum of error of redshift

float zErrorTo

Maximum of error of redshift

float zConfidenceFrom

Minimum of confidence of redshift

float zCondifdenceTo

Maximum of confidence of redshift

enum spectrumClass

Class of spatial object

int surveyId

ID of the survey in which the spectrum was measured

string dateMeasuredFrom

If specified, the column must be greater than this value.

string dateMeasuredTo

If specified, the column must be less than this value.

string dateCreatedFrom

If specified, the column must be greater than this value.

string dateCreatedTo

If specified, the column must be less than this value.

string dateModifiedFrom

If specified, the column must be greater than this value.

string dateModifiedTo

If specified, the column must be less than this value.

double wavelengthMinFrom

If specified, the column must be greater than this value.

double wavelengthMinTo

If specified, the column must be less than this value.

double wavelengthMaxFrom

If specified, the column must be greater than this value.

double wavelengthMaxTo

If specified, the column must be less than this value.

enum wavelengthScale

Linear = 0 or Logarithmic = 1 or Other = 2 or Any = -1
Specify Any to omit this criterium

int valueUnitId

Restricts search to spectra with the specified flux unit

bool returnPoints

If true, function returns spectrum values too

return value array

Array of spactra matching the criteria

FindSpectraAdvancedIndirect

Function works exacly as FindSpectraAdvanced, except it uses a structure as an input instead of the numerous parameters

struct par

Structure of parameters as describer above

bool returnPoints

If true, function returns spectrum values too

return value array

Array of spectra matching the criteria

FindSpectraBySqlQuery

Function returns spectra matching the specified SQL query

string sql

A SQL WHERE and ORDER BY clause to run on the Spectra table.

bool returnPoints

If true, function returns spectrum values too

return value array

Array of spectra matching the criteria

FindSpectraCone 

This functions returns spectra of spatial object within the specified cone

double ra

Right ascenation in J2000

double dec

Declination in J2000

double sr

Angle of the cone in arcmins

bool returnPoints

If true, function returns spectrum values too

return value array

Array of spectra matching the criteria

FindSpectraRedshift

This function returns spectra of spatial object with redshift in the specified range. Be careful, because a 0.1 interval contains more than 1000 spectra.

float zFrom

Lower limit of redshift

float zTo

Upper limit of redshift

bool returnPoints

If true, function returns spectrum values too

return value array

Array of spectra matching the criteria

ResampleSpectra

Resamples the spectrum to a different wavelength interval and scale. The function uses nearest neighbour interpolation at the unknown wavelength values and set the no_data mask outside the measured interval. This operation is required before convolving with filters.

The formula to determine new wavelength values:

Linear resampling: wavelength = start + i * inc
Logarithmic resampling: 10^(start + i * inc)

where i goes from 0 to points - 1

array spectra

The spectra objects with filled Points array

enum scale

Linear = 0 or Logarithmic = 1, determines the new scale of the wavelength axis

double start

The new minimum wavelength in the resampled spectrum.

double inc

Incrementum of the resampledspectrum, used in the formula above

int points

Number of points to resample to

double z

The function can redshift spectra to the passed z in one turn. Pass the Z field of the spectrum header to leave the spectrum in the measured redshift, or specify 0 to put into restframe.

return value array

Array of the resampled spectra

NormalizeSpectra

This function normalizes spectra in the following way: First step it puts the spectrum into restframe, weights the spectrum's values with a formula described at the WeightSpectra function, normalizes it taking samples from the specified intervals, then runs the Weight function with inverse values.

array spectra

Array of spectra to normalize in one turn

float[] limitsStart

Defines intervals for the spectrum normalizer function. Must be the same size as the normalizeLimitsEnd array.

float []limitsEnd

see above

float power

Parameter for the normalizer, varies upon object class

float factor

Parameter for the normalizer, varies upon object class

return value array

Array of the normalized spectra

RedshiftSpectra

Shifts passed spectra to the specified z

array spectra

Array of spectra to shift

float z

Shift spectra to a new z value. Specify 0 to put into restframe

return value array

Array of the shifted spectra

WeightSpectra

Weights the values with the following formula:

value = value * factor * wavelength ^ power;

array spectra

Array of spectra to weight.

float power

The power parameter of the formula