from lenstronomy.Data.imaging_data import ImageData
from lenstronomy.Data.psf import PSF
from lenstronomy.LensModel.lens_model import LensModel
from lenstronomy.LightModel.light_model import LightModel
from lenstronomy.PointSource.point_source import PointSource
from lenstronomy.ImSim.differential_extinction import DifferentialExtinction
from lenstronomy.ImSim.image_linear_solve import ImageLinearFit
from lenstronomy.ImSim.tracer_model import TracerModelSource
from lenstronomy.Util.package_util import exporter
export, __all__ = exporter()
[docs]
@export
def create_class_instances(
lens_model_list=None,
z_lens=None,
z_source=None,
z_source_convention=None,
lens_redshift_list=None,
kwargs_interp=None,
multi_plane=False,
distance_ratio_sampling=False,
observed_convention_index=None,
source_light_model_list=None,
lens_light_model_list=None,
point_source_model_list=None,
fixed_magnification_list=None,
flux_from_point_source_list=None,
point_source_frame_list=None,
additional_images_list=None,
kwargs_lens_eqn_solver=None,
source_deflection_scaling_list=None,
source_redshift_list=None,
cosmo=None,
index_lens_model_list=None,
index_source_light_model_list=None,
index_lens_light_model_list=None,
index_point_source_model_list=None,
optical_depth_model_list=None,
index_optical_depth_model_list=None,
band_index=0,
tau0_index_list=None,
all_models=False,
point_source_magnification_limit=None,
surface_brightness_smoothing=0.001,
sersic_major_axis=None,
tabulated_deflection_angles=None,
tracer_source_model_list=None,
tracer_source_band=0,
tracer_partition=None,
):
"""
:param lens_model_list: list of strings indicating the type of lens models
:param z_lens: redshift of the deflector (for single lens plane mode, but only relevant when computing physical quantities)
:param z_source: redshift of source (for single source plane mode, or for multiple source planes the redshift of the point source). In regard to this redshift the reduced deflection angles are defined in the lens model.
:param z_source_convention: float, redshift of a source to define the reduced deflection angles of the lens models.
If None, 'z_source' is used.
:param lens_redshift_list:
:param multi_plane: bool, if True, computes the lensing quantities in multi-plane mode
:param distance_ratio_sampling: bool, if True, samples the distance ratios in multi-lens-plane
:param kwargs_interp: interpolation keyword arguments specifying the numerics.
See description in the Interpolate() class. Only applicable for 'INTERPOL' and 'INTERPOL_SCALED' models.
:param observed_convention_index:
:param source_light_model_list:
:param lens_light_model_list:
:param point_source_model_list:
:param fixed_magnification_list:
:param flux_from_point_source_list: list of bools (optional), if set, will only return image positions
(for imaging modeling) for the subset of the point source lists that =True. This option enables to model
:param point_source_frame_list: list of lists mirroring the structure of the image positions.
Integers correspond to the i'th list entry of index_lens_model_list indicating in which frame/band the image is
appearing
:param additional_images_list:
:param kwargs_lens_eqn_solver: keyword arguments specifying the numerical settings for the lens equation solver
see LensEquationSolver() class for details
:param source_deflection_scaling_list: List of floats for each source ligth model (optional, and only applicable
for single-plane lensing. The factors re-scale the reduced deflection angles described from the lens model.
=1 means identical source position as without this option. This option enables multiple source planes.
The geometric difference between the different source planes needs to be pre-computed and is cosmology dependent.
:param source_redshift_list:
:param cosmo: astropy.cosmology instance
:param index_lens_model_list:
:param index_source_light_model_list:
:param index_lens_light_model_list: optional, list of list of all model indexes for each modeled band
:param index_point_source_model_list:
:param optical_depth_model_list: list of strings indicating the optical depth model to compute (differential) extinctions from the source
:param index_optical_depth_model_list:
:param band_index: int, index of band to consider. Has an effect if only partial models are considered for a specific band
:param tau0_index_list: list of integers of the specific extinction scaling parameter tau0 for each band
:param all_models: bool, if True, will make class instances of all models ignoring potential keywords that are excluding specific models as indicated.
:param point_source_magnification_limit: float >0 or None, if set and additional images are computed, then it will cut the point sources computed to the limiting (absolute) magnification
:param surface_brightness_smoothing: float, smoothing scale of light profile (minimal distance to the center of a profile)
this can help to avoid inaccuracies in the very center of a cuspy light profile
:param sersic_major_axis: boolean or None, if True, uses the semi-major axis as the definition of the Sersic
half-light radius, if False, uses the product average of semi-major and semi-minor axis. If None, uses the
convention in the lenstronomy yaml setting (which by default is =False)
:param tabulated_deflection_angles: a user-specified class with a call method that returns deflection angles given
(x, y) coordinates on the sky. This class gets passed to the lens model class TabulatedDeflections
:param tracer_source_model_list: list of tracer source models (not used in this function)
:param tracer_source_band: integer, list index of source surface brightness band to apply tracer model to
:param tracer_partition: in case of tracer models for specific sub-parts of the surface brightness model
[[list of light profiles, list of tracer profiles], [list of light profiles, list of tracer profiles], [...], ...]
:type tracer_partition: None or list
:return: lens_model_class, source_model_class, lens_light_model_class, point_source_class, extinction_class
"""
if lens_model_list is None:
lens_model_list = []
if lens_light_model_list is None:
lens_light_model_list = []
if source_light_model_list is None:
source_light_model_list = []
if point_source_model_list is None:
point_source_model_list = []
if index_lens_model_list is None or all_models is True:
lens_model_list_i = lens_model_list
lens_redshift_list_i = lens_redshift_list
observed_convention_index_i = observed_convention_index
else:
lens_model_list_i = [
lens_model_list[k] for k in index_lens_model_list[band_index]
]
if lens_redshift_list is not None:
lens_redshift_list_i = [
lens_redshift_list[k] for k in index_lens_model_list[band_index]
]
else:
lens_redshift_list_i = lens_redshift_list
if observed_convention_index is not None:
counter = 0
observed_convention_index_i = []
for k in index_lens_model_list[band_index]:
if k in observed_convention_index:
observed_convention_index_i.append(counter)
counter += 1
else:
observed_convention_index_i = observed_convention_index
lens_model_class = LensModel(
lens_model_list=lens_model_list_i,
z_lens=z_lens,
z_source=z_source,
z_source_convention=z_source_convention,
lens_redshift_list=lens_redshift_list_i,
multi_plane=multi_plane,
cosmo=cosmo,
distance_ratio_sampling=distance_ratio_sampling,
observed_convention_index=observed_convention_index_i,
kwargs_interp=kwargs_interp,
numerical_alpha_class=tabulated_deflection_angles,
)
lens_model_class_all = LensModel(
lens_model_list=lens_model_list,
z_lens=z_lens,
z_source=z_source,
z_source_convention=z_source_convention,
lens_redshift_list=lens_redshift_list,
multi_plane=multi_plane,
cosmo=cosmo,
distance_ratio_sampling=distance_ratio_sampling,
observed_convention_index=observed_convention_index,
kwargs_interp=kwargs_interp,
numerical_alpha_class=tabulated_deflection_angles,
)
if index_source_light_model_list is None or all_models is True:
source_light_model_list_i = source_light_model_list
source_deflection_scaling_list_i = source_deflection_scaling_list
source_redshift_list_i = source_redshift_list
else:
source_light_model_list_i = [
source_light_model_list[k]
for k in index_source_light_model_list[band_index]
]
if source_deflection_scaling_list is None:
source_deflection_scaling_list_i = source_deflection_scaling_list
else:
source_deflection_scaling_list_i = [
source_deflection_scaling_list[k]
for k in index_source_light_model_list[band_index]
]
if source_redshift_list is None:
source_redshift_list_i = source_redshift_list
else:
source_redshift_list_i = [
source_redshift_list[k]
for k in index_source_light_model_list[band_index]
]
source_model_class = LightModel(
light_model_list=source_light_model_list_i,
deflection_scaling_list=source_deflection_scaling_list_i,
source_redshift_list=source_redshift_list_i,
smoothing=surface_brightness_smoothing,
sersic_major_axis=sersic_major_axis,
)
if index_lens_light_model_list is None or all_models is True:
lens_light_model_list_i = lens_light_model_list
else:
lens_light_model_list_i = [
lens_light_model_list[k] for k in index_lens_light_model_list[band_index]
]
lens_light_model_class = LightModel(
light_model_list=lens_light_model_list_i,
smoothing=surface_brightness_smoothing,
sersic_major_axis=sersic_major_axis,
)
point_source_model_list_i = point_source_model_list
fixed_magnification_list_i = fixed_magnification_list
additional_images_list_i = additional_images_list
point_source_frame_list_i = point_source_frame_list
if index_point_source_model_list is not None and not all_models:
point_source_model_list_i = [
point_source_model_list[k]
for k in index_point_source_model_list[band_index]
]
if fixed_magnification_list is not None:
fixed_magnification_list_i = [
fixed_magnification_list[k]
for k in index_point_source_model_list[band_index]
]
if additional_images_list is not None:
additional_images_list_i = [
additional_images_list[k]
for k in index_point_source_model_list[band_index]
]
if point_source_frame_list is not None:
point_source_frame_list_i = [
point_source_frame_list[k]
for k in index_point_source_model_list[band_index]
]
point_source_class = PointSource(
point_source_type_list=point_source_model_list_i,
lens_model=lens_model_class_all,
fixed_magnification_list=fixed_magnification_list_i,
flux_from_point_source_list=flux_from_point_source_list,
additional_images_list=additional_images_list_i,
magnification_limit=point_source_magnification_limit,
kwargs_lens_eqn_solver=kwargs_lens_eqn_solver,
point_source_frame_list=point_source_frame_list_i,
index_lens_model_list=index_lens_model_list,
)
if tau0_index_list is None:
tau0_index = 0
else:
tau0_index = tau0_index_list[band_index]
if index_optical_depth_model_list is not None:
optical_depth_model_list_i = [
optical_depth_model_list[k]
for k in index_optical_depth_model_list[band_index]
]
else:
optical_depth_model_list_i = optical_depth_model_list
extinction_class = DifferentialExtinction(
optical_depth_model=optical_depth_model_list_i, tau0_index=tau0_index
)
return (
lens_model_class,
source_model_class,
lens_light_model_class,
point_source_class,
extinction_class,
)
[docs]
@export
def create_image_model(
kwargs_data, kwargs_psf, kwargs_numerics, kwargs_model, image_likelihood_mask=None
):
"""
:param kwargs_data: ImageData keyword arguments
:param kwargs_psf: PSF keyword arguments
:param kwargs_numerics: numerics keyword arguments for Numerics() class
:param kwargs_model: model keyword arguments
:param image_likelihood_mask: image likelihood mask
(same size as image_data with 1 indicating being evaluated and 0 being left out)
:return: ImageLinearFit() instance
"""
data_class = ImageData(**kwargs_data)
psf_class = PSF(**kwargs_psf)
(
lens_model_class,
source_model_class,
lens_light_model_class,
point_source_class,
extinction_class,
) = create_class_instances(**kwargs_model)
imageModel = ImageLinearFit(
data_class,
psf_class,
lens_model_class,
source_model_class,
lens_light_model_class,
point_source_class,
extinction_class,
kwargs_numerics,
likelihood_mask=image_likelihood_mask,
)
return imageModel
[docs]
@export
def create_im_sim(
multi_band_list,
multi_band_type,
kwargs_model,
bands_compute=None,
image_likelihood_mask_list=None,
band_index=0,
kwargs_pixelbased=None,
linear_solver=True,
):
"""
:param multi_band_list: list of [[kwargs_data, kwargs_psf, kwargs_numerics], [], ..]
:param multi_band_type: string, option when having multiple imaging data sets modelled simultaneously. Options are:
- 'multi-linear': linear amplitudes are inferred on single data set
- 'linear-joint': linear amplitudes ae jointly inferred
- 'single-band': single band
:param kwargs_model: model keyword arguments
:param bands_compute: (optional), bool list to indicate which band to be included in the modeling
:param image_likelihood_mask_list: list of image likelihood mask
(same size as image_data with 1 indicating being evaluated and 0 being left out)
:param band_index: integer, index of the imaging band to model (only applied when using 'single-band' as option)
:param kwargs_pixelbased: keyword arguments with various settings related to the pixel-based solver (see SLITronomy documentation)
:param linear_solver: bool, if True (default) fixes the linear amplitude parameters 'amp' (avoid sampling) such
that they get overwritten by the linear solver solution.
:return: MultiBand class instance
"""
if linear_solver is False and multi_band_type not in [
"single-band",
"multi-linear",
]:
raise ValueError(
'setting "linear_solver" to False is only supported in "single-band" mode '
'or if "multi-linear" model has only one band.'
)
if multi_band_type == "multi-linear":
from lenstronomy.ImSim.MultiBand.multi_linear import MultiLinear
multiband = MultiLinear(
multi_band_list,
kwargs_model,
compute_bool=bands_compute,
likelihood_mask_list=image_likelihood_mask_list,
linear_solver=linear_solver,
)
elif multi_band_type == "joint-linear":
from lenstronomy.ImSim.MultiBand.joint_linear import JointLinear
multiband = JointLinear(
multi_band_list,
kwargs_model,
compute_bool=bands_compute,
likelihood_mask_list=image_likelihood_mask_list,
)
elif multi_band_type == "single-band":
from lenstronomy.ImSim.MultiBand.single_band_multi_model import (
SingleBandMultiModel,
)
multiband = SingleBandMultiModel(
multi_band_list,
kwargs_model,
likelihood_mask_list=image_likelihood_mask_list,
band_index=band_index,
kwargs_pixelbased=kwargs_pixelbased,
linear_solver=linear_solver,
)
else:
raise ValueError("type %s is not supported!" % multi_band_type)
return multiband
def create_tracer_model(tracer_data, kwargs_model, tracer_likelihood_mask=None):
"""
:param tracer_data:
:param kwargs_model:
:param tracer_likelihood_mask_list:
:return:
"""
tracer_source_band = kwargs_model.get("tracer_source_band", 0)
tracer_source_class = LightModel(
light_model_list=kwargs_model.get("tracer_source_model_list", [])
)
tracer_partition = kwargs_model.get("tracer_partition", None)
kwargs_data, kwargs_psf, kwargs_numerics = tracer_data
(
lens_model_class,
source_model_class,
lens_light_model_class,
point_source_class,
extinction_class,
) = create_class_instances(band_index=tracer_source_band, **kwargs_model)
data_class = ImageData(**kwargs_data)
psf_class = PSF(**kwargs_psf)
tracer_model = TracerModelSource(
data_class,
psf_class=psf_class,
lens_model_class=lens_model_class,
source_model_class=source_model_class,
lens_light_model_class=lens_light_model_class,
point_source_class=point_source_class,
extinction_class=extinction_class,
tracer_source_class=tracer_source_class,
kwargs_numerics=kwargs_numerics,
likelihood_mask=tracer_likelihood_mask,
psf_error_map_bool_list=None,
kwargs_pixelbased=None,
tracer_partition=tracer_partition,
)
return tracer_model