ClEvaR
0.13.2
Getting Started
Rapid overview
Installation
Citing ClEvaR
Usage Demos
Galaxy Cluster Catalogs
Matching catalogs based on proximity (simple)
Matching catalogs based on proximity (detailed)
Matching catalogs based on membership (simple)
Matching catalogs based on membership (detailed)
Metrics of matching (simple)
Metrics of matching (advanced)
Footprint functionality
Intrinsic Completeness
Appendix: Estimating deviation in completeness approximation
Reference
API Documentation
clevar.catalog module
clevar.constants module
clevar.cosmology package
clevar.cosmology.astropy module
clevar.cosmology.ccl module
clevar.cosmology.parent_class module
clevar.footprint package
clevar.footprint.artificial module
clevar.footprint.footprint module
clevar.footprint.nfw_funcs module
clevar.geometry module
clevar.match package
clevar.match.membership module
clevar.match.parent module
clevar.match.proximity module
clevar.match_metrics package
clevar.match_metrics.distances package
clevar.match_metrics.distances.catalog_funcs module
clevar.match_metrics.distances.funcs module
clevar.match_metrics.recovery package
clevar.match_metrics.recovery.array_funcs module
clevar.match_metrics.recovery.catalog_funcs module
clevar.match_metrics.recovery.funcs module
clevar.match_metrics.scaling package
clevar.match_metrics.scaling.array_funcs module
clevar.match_metrics.scaling.catalog_funcs module
clevar.match_metrics.scaling.funcs module
clevar.match_metrics.plot_helper module
clevar.utils module
clevar.clv_yaml package
clevar.clv_yaml.footprint module
clevar.clv_yaml.helper_funcs module
clevar.clv_yaml.match module
clevar.clv_yaml.match_metrics_distances module
clevar.clv_yaml.match_metrics_mass module
clevar.clv_yaml.match_metrics_recovery_rate module
clevar.clv_yaml.match_metrics_redshift module
clevar.version module
ClEvaR
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
|
Z
A
add_dicts_diff() (in module clevar.clv_yaml.helper_funcs)
add_ftpt_coverfrac() (clevar.catalog.Catalog method)
add_ftpt_masks() (clevar.catalog.Catalog method)
add_grid() (in module clevar.match_metrics.plot_helper)
add_mem_catalog() (in module clevar.clv_yaml.helper_funcs)
add_members() (clevar.catalog.ClCatalog method)
add_panel_bin_label() (in module clevar.match_metrics.plot_helper)
artificial() (in module clevar.clv_yaml.footprint)
autobins() (in module clevar.utils)
B
binmasks() (in module clevar.utils)
C
Catalog (class in clevar.catalog)
central_position() (in module clevar.match_metrics.distances.catalog_funcs)
(in module clevar.match_metrics.distances.funcs)
ClCatalog (class in clevar.catalog)
ClData (class in clevar.catalog)
clevar.catalog
module
clevar.clv_yaml
module
clevar.clv_yaml.footprint
module
clevar.clv_yaml.helper_funcs
module
clevar.clv_yaml.match
module
clevar.clv_yaml.match_metrics_distances
module
clevar.clv_yaml.match_metrics_mass
module
clevar.clv_yaml.match_metrics_recovery_rate
module
clevar.clv_yaml.match_metrics_redshift
module
clevar.constants
module
clevar.cosmology
module
clevar.cosmology.astropy
module
clevar.cosmology.ccl
module
clevar.cosmology.parent_class
module
clevar.footprint
module
clevar.footprint.artificial
module
clevar.footprint.footprint
module
clevar.footprint.nfw_funcs
module
clevar.geometry
module
clevar.match
module
clevar.match.membership
module
clevar.match.parent
module
clevar.match.proximity
module
clevar.match_metrics
module
clevar.match_metrics.distances
module
clevar.match_metrics.distances.catalog_funcs
module
clevar.match_metrics.distances.funcs
module
clevar.match_metrics.plot_helper
module
clevar.match_metrics.recovery
module
clevar.match_metrics.recovery.array_funcs
module
clevar.match_metrics.recovery.catalog_funcs
module
clevar.match_metrics.recovery.funcs
module
clevar.match_metrics.scaling
module
clevar.match_metrics.scaling.array_funcs
module
clevar.match_metrics.scaling.catalog_funcs
module
clevar.match_metrics.scaling.funcs
module
clevar.utils
module
clevar.version
module
CLIGHT (clevar.constants.Constants attribute)
CLIGHT_KMS (clevar.constants.Constants attribute)
colnames (clevar.catalog.TagData property)
Constants (class in clevar.constants)
convert_units() (in module clevar.geometry)
Cosmology (class in clevar.cosmology.parent_class)
create_footprint() (in module clevar.footprint.artificial)
cross_match() (clevar.catalog.Catalog method)
(clevar.match.parent.Match method)
D
data (clevar.catalog.TagData property)
deep_update() (in module clevar.clv_yaml.helper_funcs)
(in module clevar.utils)
default_tags (clevar.catalog.TagData property)
E
eval_da() (clevar.cosmology.parent_class.Cosmology method)
eval_da_z1z2() (clevar.cosmology.parent_class.Cosmology method)
eval_mass2radius() (clevar.cosmology.parent_class.Cosmology method)
F
fill_holes() (in module clevar.footprint.artificial)
fill_holes_conv() (in module clevar.footprint.artificial)
fill_shared_members() (clevar.match.membership.MembershipMatch method)
Footprint (class in clevar.footprint.footprint)
G
gaussian() (in module clevar.utils)
get() (clevar.catalog.ClData method)
(clevar.catalog.TagData method)
(clevar.utils.LowerCaseDict method)
get_bin_label() (in module clevar.match_metrics.plot_helper)
get_coverfrac() (clevar.footprint.footprint.Footprint method)
get_coverfrac_nfw2D() (clevar.footprint.footprint.Footprint method)
get_density_colors() (in module clevar.match_metrics.plot_helper)
get_desc() (clevar.cosmology.parent_class.Cosmology method)
get_dicts_diff() (in module clevar.clv_yaml.helper_funcs)
get_E2() (clevar.cosmology.parent_class.Cosmology method)
get_input_loop() (in module clevar.clv_yaml.helper_funcs)
get_map() (clevar.footprint.footprint.Footprint method)
get_matched_masks() (in module clevar.match)
get_matched_pairs() (in module clevar.match)
get_matching_mask() (clevar.catalog.Catalog method)
get_Omega_m() (clevar.cosmology.parent_class.Cosmology method)
get_recovery_rate() (in module clevar.match_metrics.recovery.array_funcs)
get_values_in_pixels() (clevar.footprint.footprint.Footprint method)
GNEWT (clevar.constants.Constants attribute)
GNEWT_SOLAR_MASS (clevar.constants.Constants attribute)
I
id_dict (clevar.catalog.Catalog property)
id_dict_list (clevar.catalog.MemCatalog property)
ids2inds() (clevar.catalog.Catalog method)
L
load_footprint_quantities() (clevar.catalog.Catalog method)
load_match() (clevar.catalog.Catalog method)
load_matched_members() (clevar.match.membership.MembershipMatch method)
load_matches() (clevar.match.parent.Match method)
load_shared_members() (clevar.match.membership.MembershipMatch method)
loadconf() (in module clevar.clv_yaml.helper_funcs)
LowerCaseDict (class in clevar.utils)
M
make_bins() (in module clevar.clv_yaml.helper_funcs)
make_catalog() (in module clevar.clv_yaml.helper_funcs)
make_cosmology() (in module clevar.clv_yaml.helper_funcs)
make_masks() (in module clevar.clv_yaml.footprint)
mass() (in module clevar.match_metrics.scaling.funcs)
mass_density() (in module clevar.match_metrics.scaling.funcs)
mass_density_dist() (in module clevar.match_metrics.scaling.funcs)
mass_density_metrics() (in module clevar.match_metrics.scaling.funcs)
mass_density_zpanel() (in module clevar.match_metrics.scaling.funcs)
mass_dist() (in module clevar.match_metrics.scaling.funcs)
mass_dist_self() (in module clevar.match_metrics.scaling.funcs)
mass_metrics() (in module clevar.match_metrics.scaling.funcs)
mass_zcolor() (in module clevar.match_metrics.scaling.funcs)
mass_zpanel() (in module clevar.match_metrics.scaling.funcs)
Match (class in clevar.match.parent)
match_from_config() (clevar.match.membership.MembershipMatch method)
(clevar.match.parent.Match method)
(clevar.match.proximity.ProximityMatch method)
match_general() (in module clevar.clv_yaml.match)
match_members() (clevar.match.membership.MembershipMatch method)
membership() (in module clevar.clv_yaml.match)
MembershipMatch (class in clevar.match.membership)
MemCatalog (class in clevar.catalog)
module
clevar.catalog
clevar.clv_yaml
clevar.clv_yaml.footprint
clevar.clv_yaml.helper_funcs
clevar.clv_yaml.match
clevar.clv_yaml.match_metrics_distances
clevar.clv_yaml.match_metrics_mass
clevar.clv_yaml.match_metrics_recovery_rate
clevar.clv_yaml.match_metrics_redshift
clevar.constants
clevar.cosmology
clevar.cosmology.astropy
clevar.cosmology.ccl
clevar.cosmology.parent_class
clevar.footprint
clevar.footprint.artificial
clevar.footprint.footprint
clevar.footprint.nfw_funcs
clevar.geometry
clevar.match
clevar.match.membership
clevar.match.parent
clevar.match.proximity
clevar.match_metrics
clevar.match_metrics.distances
clevar.match_metrics.distances.catalog_funcs
clevar.match_metrics.distances.funcs
clevar.match_metrics.plot_helper
clevar.match_metrics.recovery
clevar.match_metrics.recovery.array_funcs
clevar.match_metrics.recovery.catalog_funcs
clevar.match_metrics.recovery.funcs
clevar.match_metrics.scaling
clevar.match_metrics.scaling.array_funcs
clevar.match_metrics.scaling.catalog_funcs
clevar.match_metrics.scaling.funcs
clevar.utils
clevar.version
mpc2rad() (clevar.cosmology.parent_class.Cosmology method)
mt_hist (clevar.catalog.Catalog property)
multiple() (clevar.match.membership.MembershipMatch method)
(clevar.match.parent.Match method)
(clevar.match.proximity.ProximityMatch method)
N
namedict (clevar.catalog.ClData property)
NameList (class in clevar.utils)
neighbors_of_pixels() (in module clevar.utils)
nest (clevar.footprint.footprint.Footprint property)
nfw2D_profile() (in module clevar.footprint.nfw_funcs)
nfw2D_profile_flatcore() (in module clevar.footprint.nfw_funcs)
nice_panel() (in module clevar.match_metrics.plot_helper)
none_val() (in module clevar.utils)
nside (clevar.footprint.footprint.Footprint property)
nside_from_density() (in module clevar.footprint.artificial)
O
output_catalog_with_matching() (in module clevar.match)
output_matched_catalog() (in module clevar.match)
P
pack_mmt_col() (in module clevar.utils)
pack_mt_col() (in module clevar.utils)
PC_TO_METER (clevar.constants.Constants attribute)
pix2map() (in module clevar.utils)
pixel_dict (clevar.footprint.footprint.Footprint property)
plot() (clevar.footprint.footprint.Footprint method)
(in module clevar.match_metrics.recovery.array_funcs)
(in module clevar.match_metrics.recovery.catalog_funcs)
(in module clevar.match_metrics.recovery.funcs)
(in module clevar.match_metrics.scaling.array_funcs)
(in module clevar.match_metrics.scaling.catalog_funcs)
plot2D() (in module clevar.match_metrics.recovery.array_funcs)
(in module clevar.match_metrics.recovery.catalog_funcs)
(in module clevar.match_metrics.recovery.funcs)
plot_density() (in module clevar.match_metrics.scaling.array_funcs)
(in module clevar.match_metrics.scaling.catalog_funcs)
plot_density_dist() (in module clevar.match_metrics.scaling.array_funcs)
(in module clevar.match_metrics.scaling.catalog_funcs)
plot_density_metrics() (in module clevar.match_metrics.scaling.array_funcs)
(in module clevar.match_metrics.scaling.catalog_funcs)
plot_density_panel() (in module clevar.match_metrics.scaling.array_funcs)
(in module clevar.match_metrics.scaling.catalog_funcs)
plot_dist() (in module clevar.match_metrics.scaling.array_funcs)
(in module clevar.match_metrics.scaling.catalog_funcs)
plot_dist_self() (in module clevar.match_metrics.scaling.catalog_funcs)
plot_healpix_map() (in module clevar.match_metrics.plot_helper)
plot_hist_line() (in module clevar.match_metrics.plot_helper)
plot_histograms() (in module clevar.match_metrics.plot_helper)
plot_metrics() (in module clevar.match_metrics.scaling.array_funcs)
(in module clevar.match_metrics.scaling.catalog_funcs)
plot_panel() (in module clevar.match_metrics.recovery.array_funcs)
(in module clevar.match_metrics.recovery.catalog_funcs)
(in module clevar.match_metrics.recovery.funcs)
(in module clevar.match_metrics.scaling.array_funcs)
(in module clevar.match_metrics.scaling.catalog_funcs)
pop() (clevar.utils.LowerCaseDict method)
prep_cat_for_match() (clevar.match.parent.Match method)
(clevar.match.proximity.ProximityMatch method)
prep_ftpt_config() (in module clevar.clv_yaml.footprint)
proximity() (in module clevar.clv_yaml.match)
ProximityMatch (class in clevar.match.proximity)
R
rad2mpc() (clevar.cosmology.parent_class.Cosmology method)
raw() (clevar.catalog.ClCatalog method)
read() (clevar.catalog.Catalog class method)
(clevar.catalog.ClCatalog class method)
(clevar.catalog.ClData class method)
(clevar.catalog.TagData class method)
(clevar.footprint.footprint.Footprint class method)
read_full() (clevar.catalog.Catalog class method)
(clevar.catalog.TagData class method)
read_members() (clevar.catalog.ClCatalog method)
read_yaml() (in module clevar.clv_yaml.helper_funcs)
redshift() (in module clevar.match_metrics.distances.catalog_funcs)
(in module clevar.match_metrics.distances.funcs)
(in module clevar.match_metrics.scaling.funcs)
redshift_density() (in module clevar.match_metrics.scaling.funcs)
redshift_density_dist() (in module clevar.match_metrics.scaling.funcs)
redshift_density_masspanel() (in module clevar.match_metrics.scaling.funcs)
redshift_density_metrics() (in module clevar.match_metrics.scaling.funcs)
redshift_dist() (in module clevar.match_metrics.scaling.funcs)
redshift_dist_self() (in module clevar.match_metrics.scaling.funcs)
redshift_masscolor() (in module clevar.match_metrics.scaling.funcs)
redshift_masspanel() (in module clevar.match_metrics.scaling.funcs)
redshift_metrics() (in module clevar.match_metrics.scaling.funcs)
remove_members() (clevar.catalog.ClCatalog method)
remove_multiple_duplicates() (clevar.catalog.Catalog method)
RHOCRIT (clevar.constants.Constants attribute)
run() (in module clevar.clv_yaml.match_metrics_distances)
(in module clevar.clv_yaml.match_metrics_mass)
(in module clevar.clv_yaml.match_metrics_recovery_rate)
(in module clevar.clv_yaml.match_metrics_redshift)
S
save_footprint_quantities() (clevar.catalog.Catalog method)
save_match() (clevar.catalog.Catalog method)
save_matched_members() (clevar.match.membership.MembershipMatch method)
save_matches() (clevar.match.parent.Match method)
save_matching_files() (in module clevar.clv_yaml.match)
save_shared_members() (clevar.match.membership.MembershipMatch method)
set_be_cosmo() (clevar.cosmology.parent_class.Cosmology method)
setdefault() (clevar.utils.LowerCaseDict method)
show_mt_hist() (clevar.catalog.Catalog method)
size (clevar.catalog.TagData property)
skyplot() (in module clevar.match_metrics.recovery.array_funcs)
(in module clevar.match_metrics.recovery.catalog_funcs)
(in module clevar.match_metrics.recovery.funcs)
smooth_line() (in module clevar.utils)
smooth_loop() (in module clevar.utils)
SOLAR_MASS (clevar.constants.Constants attribute)
str2dataunit() (in module clevar.utils)
T
tag_column() (clevar.catalog.Catalog method)
(clevar.catalog.TagData method)
tag_columns() (clevar.catalog.TagData method)
TagData (class in clevar.catalog)
tags (clevar.catalog.TagData property)
U
unique() (clevar.match.parent.Match method)
unpack_mmt_col() (in module clevar.utils)
unpack_mt_col() (in module clevar.utils)
update() (clevar.utils.LowerCaseDict method)
updated_dict() (in module clevar.utils)
W
write() (clevar.catalog.Catalog method)
(clevar.catalog.TagData method)
write_output() (in module clevar.clv_yaml.match)
write_yaml() (in module clevar.clv_yaml.helper_funcs)
Z
zmax_masks_from_footprint() (clevar.footprint.footprint.Footprint method)