Source API¶

Source¶

class core.source.Source.Source(name)[source]¶

It gets the name for the source

getFreeableParams()[source]¶

It gets parameters to free

class core.source.Source.PointSource(name)[source]¶

get(parameterName)[source]¶

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)[source]¶

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)[source]¶

It sets a source’s parameter.

Example

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

setVal(parameterName, parameterValue)[source]¶

It sets a source’s parameter.

Example

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

getFreeParams()[source]¶

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

Example

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