Source code for coolest.template.classes.lensing_entity
__author__ = 'aymgal'
from coolest.template.classes.base import APIBaseObject
from coolest.template.classes.mass_light_model import MassModel
__all__ = [
'LensingEntity',
]
SUPPORTED_CHOICES = ['Galaxy', 'MassField']
[docs]
class LensingEntity(APIBaseObject):
"""Abstract lensing entity, typically a Galaxy or an MassField object.
Parameters
----------
name : str
Name of the entity (e.g., the name of the galaxy)
redshift : float
Redshift of the entity, if known / assumed
lensed : bool
Whether the entity is lensed or not
mass_model : MassModel, optional
Mass model (i.e., a set of mass profiles), by default None
Raises
------
ValueError
If the provided redshift is negative.
"""
def __init__(self,
name: str,
redshift: float,
lensed: bool = False,
mass_model: MassModel = None) -> None:
[docs]
self.type = self.__class__.__name__ # name of the children class
if redshift is not None and redshift < 0:
raise ValueError("Redshift cannot be negative.")
[docs]
self.redshift = redshift
if mass_model is None:
mass_model = MassModel()
[docs]
self.mass_model = mass_model
super().__init__()
@property
[docs]
def has_mass_profiles(self):
"""Check if the galaxy has mass profiles."""
return len(self.mass_model) > 0
