coolest.template.classes.lensing_entity_list

coolest.template.classes.lensing_entity_list#

Classes#

LensingEntityList

The list of components that define the lensing system.

Module Contents#

class LensingEntityList(*entities: Tuple[coolest.template.classes.lensing_entity.LensingEntity])[source]#

The list of components that define the lensing system. In COOLEST, a LensingEntity is an instance Galaxy or a MassField.

Note that unique identifiers (IDs) for each profile and parameters will be generated at instantiation time.

  • A given profile has a unique IDs with the following pattern:

{entity index}-{{massfield} or {galaxy}}-{{mass} or {light}}-{profile index}_{profile name}

  • A given parameter has the same ID as above, just with the parameter name at the end:

{entity index}-{{massfield} or {galaxy}}-{{mass} or {light}}-{profile index}_{profile name}-{parameter name}

Parameters:

*entities (LensingEntity instances) – As many LensingEntity instances as required

get_parameters(with_name=None, with_fixed=True)[source]#

Returns the list of either all parameters in the model, or only a subset of them for parameters with a specific name.

Parameters:

  • with_name (str, optional) – Parameter for which we want to get all corresponding IDs (default: None).

  • with_fixed (bool, optional) – If True, includes also fixed parameters (default: True).

Returns:

List of parameter instances

Return type:

list

get_parameter_ids(with_name=None, with_fixed=True)[source]#

Returns the list of either all parameter IDs in the model, or only a subset of them for parameters with a specific name.

Parameters:

  • with_name (str, optional) – Parameter for which we want to get all corresponding IDs (default: None).

  • with_fixed (bool, optional) – If True, includes also fixed parameters (default: True).

Returns:

List of IDs (strings)

Return type:

list

get_parameter_from_id(param_id)[source]#

Returns the Parameter instance that has the given parameter ID, or None.

Parameters:

param_id (str) – Parameter ID

Returns:

Instance of a Parameter with ID equal to param_ID

Return type:

coolest.template.classes.parameters.Parameter or None

Contents