Source API

Source

class core.source.Source.Source(name)

getName()

It gets the name for the source

Parameters:

None –

Returns:

Source name

Return type:

name(str)

getFreeableParams()

It gets parameters to free

Parameters:

None –

Returns:

parameters to free

Return type:

List(str)

Point Source

class core.source.Source.PointSource(name)

get(parameterName)

It returns a source’s parameter.

Parameters:

paramName (str) – the name of the source’s parameter.

Raises:

SourceParameterNotFound – if the source’s parameter is not found.

Returns:

A dictionary containing the source’s attributes.

Example

>>> s.get("index")
>>> s.get("pos")
>>> s.get("multiFlux")

getVal(parameterName)

It returns a source’s parameter value.

Parameters:

paramName (str) – the name of the source’s parameter.

Raises:

SourceParameterNotFound – if the source’s parameter is not found.

Returns:

The value of the source’s parameter.

Example

>>> s.getVal("index")
>>> s.getVal("pos")
>>> s.getVal("multiFlux")

set(parameterName, attributeValueDict)

It sets a source’s parameter.

Parameters:

parameterName (str) – the name of the source’s parameter.

Returns:

None

Example

>>> s.set("index",{"value":1, "min":10})

setVal(parameterName, parameterValue)

It sets a source’s parameter.

Parameters:

parameterName (str) – the name of the source’s parameter.

Returns:

None

Example

>>> s.set("index",{"value":1, "min":10})

getFreeParams()

It returns the source’s attributes that are free to vary.

Returns:

The list of attributes that are free to vary.

Example

>>> s.getFreeParams()
>>> ["flux", "index"]