xlens.simulator.catalog

Pipeline task that prepares truth catalogs for image simulations.

Classes

`CatalogConnections`	Butler connection definitions for truth catalog generation.
`CatalogConfig`	Configuration options used by `CatalogTask`.
`CatalogTask`
`CatalogShearTaskConfig`	Configuration for `CatalogShearTask` (constant-shear test).
`CatalogShearTask`	Catalog task applying constant shear per redshift bin.
`CatalogHaloTaskConfig`	Configuration for `CatalogHaloTask` (NFW halo lensing).
`CatalogHaloTask`	Catalog task applying NFW halo lensing distortions.
`CatalogLogNormalTaskConfig`	Configuration for `CatalogLogNormalTask`.
`CatalogLogNormalTask`	Catalog task applying a log-normal shear field.

Module Contents

class CatalogConnections(*, config=None)[source]

Bases: lsst.pipe.base.PipelineTaskConnections

Butler connection definitions for truth catalog generation.

skymap[source]

truthCatalog[source]

class CatalogConfig[source]

Bases: lsst.pipe.base.PipelineTaskConfig

Configuration options used by CatalogTask.

catsim_dir[source]

galaxy_type[source]

layout[source]

galId[source]

rotId[source]

indice_group_id[source]

sep_arcsec[source]

extend_ratio[source]

force_pixel_center[source]

apply_lensing_position_shifts[source]

select_observable[source]

select_lower_limit[source]

select_upper_limit[source]

validate()[source]

setDefaults()[source]

class CatalogTask(**kwargs: Any)[source]

Bases: lsst.pipe.base.PipelineTask

_DefaultName = 'CatalogTask'[source]

ConfigClass[source]: Task that creates lensed galaxy catalogs for downstream simulations.

rotate_list[source]

abstract get_perturbation_object(tract_info, seed: int, **kwargs: Any) → object[source]

Return a perturbation object for lensing the catalog.

Must be implemented by subclasses (e.g. shear, halo, log-normal).

prepare_galaxy_catalog(*, seed, tract_info)[source]: Instantiate a galaxy catalog class based on the configuration.

run(*, tract_info, seed: int, **kwargs)[source]: Generate a truth catalog with the configured lensing perturbations.

runQuantum(butlerQC, inputRefs, outputRefs) → None[source]

class CatalogShearTaskConfig[source]

Bases: CatalogConfig

Configuration for CatalogShearTask (constant-shear test).

z_bounds[source]

mode[source]

test_target[source]

test_value[source]

kappa_value[source]

validate()[source]

setDefaults()[source]

class CatalogShearTask(**kwargs: Any)[source]

Bases: CatalogTask

Catalog task applying constant shear per redshift bin.

_DefaultName = 'CatalogShearTask'[source]

ConfigClass[source]: Task that creates lensed galaxy catalogs for downstream simulations.

get_perturbation_object(tract_info, seed: int, **kwargs: Any)[source]

Return a perturbation object for lensing the catalog.

Must be implemented by subclasses (e.g. shear, halo, log-normal).

class CatalogHaloTaskConfig[source]

Bases: CatalogConfig

Configuration for CatalogHaloTask (NFW halo lensing).

mass[source]

conc[source]

z_lens[source]

z_source[source]

no_kappa[source]

validate()[source]

setDefaults()[source]

class CatalogHaloTask(**kwargs: Any)[source]

Bases: CatalogTask

Catalog task applying NFW halo lensing distortions.

_DefaultName = 'CatalogHaloTask'[source]

ConfigClass[source]: Task that creates lensed galaxy catalogs for downstream simulations.

prepare_galaxy_catalog(*, seed, tract_info)[source]: Instantiate a galaxy catalog class based on the configuration.

get_perturbation_object(tract_info, seed: int, **kwargs: Any)[source]

Return a perturbation object for lensing the catalog.

Must be implemented by subclasses (e.g. shear, halo, log-normal).

class CatalogLogNormalTaskConfig[source]

Bases: CatalogConfig

Configuration for CatalogLogNormalTask.

z_source[source]

no_kappa[source]

validate()[source]

setDefaults()[source]

class CatalogLogNormalTask(**kwargs: Any)[source]

Bases: CatalogTask

Catalog task applying a log-normal shear field.

_DefaultName = 'CatalogLogNormalTask'[source]

ConfigClass[source]: Task that creates lensed galaxy catalogs for downstream simulations.

prepare_galaxy_catalog(*, seed, tract_info)[source]: Instantiate a galaxy catalog class based on the configuration.

get_perturbation_object(tract_info, seed: int, **kwargs: Any)[source]

Return a perturbation object for lensing the catalog.

Must be implemented by subclasses (e.g. shear, halo, log-normal).