Skip to content

Commit

Permalink
typos correction
Browse files Browse the repository at this point in the history
  • Loading branch information
@foglienimatteo
foglienimatteo committed Mar 7, 2023
1 parent 86e62db commit 0b61c52
Show file tree
Hide file tree
Showing 17 changed files with 2,276 additions and 2,270 deletions.
72 changes: 36 additions & 36 deletions README.md
View file

Large diffs are not rendered by default.

4,157 changes: 2,078 additions & 2,079 deletions ipynbs/TUTORIAL.ipynb
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions src/GNC_AutoCorrelations/GNC_AutoDoppler.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ end
ξ_GNC_Doppler(s1, s2, y, cosmo::Cosmology;
kwargs...) ::Float64
Return the Two-Point Correlation Function (TPCF) of the Doppler auto-correlation effect
Returns the Two-Point Correlation Function (TPCF) of the Doppler auto-correlation effect
arising from the Galaxy Number Counts (GNC).
In the first method, you should pass the two `Point` (`P1` and `P2`) where to
Expand Down Expand Up @@ -169,7 +169,7 @@ where:
- ``f_1 = f(s_1)``, ... is the linear growth rate (evaluated in ``s_1``);
- ``\\mathcal{H}_1 = \\mathcal{H}(s_1)``, ... is the comoving
Hubble distances (evaluated in ``s_1``);
Hubble parameter (evaluated in ``s_1``, ...);
- ``y = \\cos{\\theta} = \\hat{\\mathbf{s}}_1 \\cdot \\hat{\\mathbf{s}}_2``;
Expand Down Expand Up @@ -223,9 +223,9 @@ if you set `obs = :no`, `obs = false` or even `obs = :noobsvel` they will not be
- `P1::Point` and `P2::Point`, or `s1` and `s2`: `Point`/comoving distances where the
TPCF has to be calculated; they contain all the
data of interest needed for this calculus (comoving distance, growth factor and so on).
data of interest needed for this calculus (comoving distance, growth factor and so on);
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer;
- `cosmo::Cosmology`: cosmology to be used in this computation; it contains all the splines
used for the conversion `s` -> `Point`, and all the cosmological parameters ``b``, ...
Expand All @@ -234,10 +234,10 @@ if you set `obs = :no`, `obs = false` or even `obs = :noobsvel` they will not be
- `obs::Union{Bool,Symbol} = :noobsvel` : do you want to consider the observer terms in the computation of the
chosen GNC TPCF effect?
- `:yes` or `true` -> all the observer effects will be considered
- `:no` or `false` -> no observer term will be taken into account
- `:yes` or `true` -> all the observer terms will be considered;
- `:no` or `false` -> no observer term will be taken into account;
- `:noobsvel` -> the observer terms related to the observer velocity (that you can find in the CF concerning Doppler)
will be neglected, the other ones will be taken into account
will be neglected, the other ones will be taken into account.
See also: [`Point`](@ref), [`Cosmology`](@ref), [`ξ_GNC_multipole`](@ref),
[`map_ξ_GNC_multipole`](@ref), [`print_map_ξ_GNC_multipole`](@ref)
Expand Down
22 changes: 11 additions & 11 deletions src/GNC_AutoCorrelations/GNC_AutoIntegratedGP.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ where:
- ``f_1 = f(s_1)``, ... is the linear growth rate (evaluated in ``s_1``);
- ``\\mathcal{H}_1 = \\mathcal{H}(s_1)``, ... is the comoving
Hubble distances (evaluated in ``s_1``);
Hubble parameter (evaluated in ``s_1``, ...);
- ``y = \\cos{\\theta} = \\hat{\\mathbf{s}}_1 \\cdot \\hat{\\mathbf{s}}_2``;
Expand Down Expand Up @@ -188,10 +188,10 @@ This function is used inside `ξ_GNC_IntegratedGP` with [`trapz`](@ref) from the
- `obs::Union{Bool,Symbol} = :noobsvel` : do you want to consider the observer terms in the computation of the
chosen GNC TPCF effect?
- `:yes` or `true` -> all the observer effects will be considered
- `:no` or `false` -> no observer term will be taken into account
- `:yes` or `true` -> all the observer terms will be considered;
- `:no` or `false` -> no observer term will be taken into account;
- `:noobsvel` -> the observer terms related to the observer velocity (that you can find in the CF concerning Doppler)
will be neglected, the other ones will be taken into account
will be neglected, the other ones will be taken into account.
See also: [`Point`](@ref), [`Cosmology`](@ref), [`ξ_GNC_multipole`](@ref),
Expand Down Expand Up @@ -267,7 +267,7 @@ end
ξ_GNC_IntegratedGP(s1, s2, y, cosmo::Cosmology;
kwargs...) ::Float64
Return the Two-Point Correlation Function (TPCF) of the Integrated
Returns the Two-Point Correlation Function (TPCF) of the Integrated
Gravitational Potential (GP) auto-correlation effect
arising from the Galaxy Number Counts (GNC).
Expand Down Expand Up @@ -319,7 +319,7 @@ where:
- ``f_1 = f(s_1)``, ... is the linear growth rate (evaluated in ``s_1``);
- ``\\mathcal{H}_1 = \\mathcal{H}(s_1)``, ... is the comoving
Hubble distances (evaluated in ``s_1``);
Hubble parameter (evaluated in ``s_1``, ...);
- ``y = \\cos{\\theta} = \\hat{\\mathbf{s}}_1 \\cdot \\hat{\\mathbf{s}}_2``;
Expand Down Expand Up @@ -368,9 +368,9 @@ This function is computed integrating `integrand_ξ_GNC_IntegratedGP` with [`tra
- `P1::Point` and `P2::Point`, or `s1` and `s2`: `Point`/comoving distances where the
TPCF has to be calculated; they contain all the
data of interest needed for this calculus (comoving distance, growth factor and so on).
data of interest needed for this calculus (comoving distance, growth factor and so on);
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer;
- `cosmo::Cosmology`: cosmology to be used in this computation; it contains all the splines
used for the conversion `s` -> `Point`, and all the cosmological parameters ``b``, ...
Expand All @@ -379,10 +379,10 @@ This function is computed integrating `integrand_ξ_GNC_IntegratedGP` with [`tra
- `obs::Union{Bool,Symbol} = :noobsvel` : do you want to consider the observer terms in the computation of the
chosen GNC TPCF effect?
- `:yes` or `true` -> all the observer effects will be considered
- `:no` or `false` -> no observer term will be taken into account
- `:yes` or `true` -> all the observer terms will be considered;
- `:no` or `false` -> no observer term will be taken into account;
- `:noobsvel` -> the observer terms related to the observer velocity (that you can find in the CF concerning Doppler)
will be neglected, the other ones will be taken into account
will be neglected, the other ones will be taken into account.
- `en::Float64 = 1e6`: just a float number used in order to deal better
with small numbers;
Expand Down
22 changes: 11 additions & 11 deletions src/GNC_AutoCorrelations/GNC_AutoLensing.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ where:
- ``f_1 = f(s_1)``, ... is the linear growth rate (evaluated in ``s_1``);
- ``\\mathcal{H}_1 = \\mathcal{H}(s_1)``, ... is the comoving
Hubble distances (evaluated in ``s_1``);
Hubble parameter (evaluated in ``s_1``, ...);
- ``y = \\cos{\\theta} = \\hat{\\mathbf{s}}_1 \\cdot \\hat{\\mathbf{s}}_2``;
Expand Down Expand Up @@ -244,10 +244,10 @@ This function is used inside `ξ_GNC_Lensing` with [`trapz`](@ref) from the
- `obs::Union{Bool,Symbol} = :noobsvel` : do you want to consider the observer terms in the computation of the
chosen GNC TPCF effect?
- `:yes` or `true` -> all the observer effects will be considered
- `:no` or `false` -> no observer term will be taken into account
- `:yes` or `true` -> all the observer terms will be considered;
- `:no` or `false` -> no observer term will be taken into account;
- `:noobsvel` -> the observer terms related to the observer velocity (that you can find in the CF concerning Doppler)
will be neglected, the other ones will be taken into account
will be neglected, the other ones will be taken into account.
- `Δχ_min::Float64 = 1e-4` : when
``\\Delta\\chi = \\sqrt{\\chi_1^2 + \\chi_2^2 - 2 \\, \\chi_1 \\chi_2 y} \\to 0^{+}``,
Expand Down Expand Up @@ -315,7 +315,7 @@ end
ξ_GNC_Lensing(s1, s2, y, cosmo::Cosmology;
kwargs...) ::Float64
Return the Two-Point Correlation Function (TPCF) of the Lensing auto-correlation effect
Returns the Two-Point Correlation Function (TPCF) of the Lensing auto-correlation effect
arising from the Galaxy Number Counts (GNC).
In the first method, you should pass the two `Point` (`P1` and `P2`) where to
Expand Down Expand Up @@ -397,7 +397,7 @@ where:
- ``f_1 = f(s_1)``, ... is the linear growth rate (evaluated in ``s_1``);
- ``\\mathcal{H}_1 = \\mathcal{H}(s_1)``, ... is the comoving
Hubble distances (evaluated in ``s_1``);
Hubble parameter (evaluated in ``s_1``, ...);
- ``y = \\cos{\\theta} = \\hat{\\mathbf{s}}_1 \\cdot \\hat{\\mathbf{s}}_2``;
Expand Down Expand Up @@ -446,9 +446,9 @@ This function is computed integrating `integrand_ξ_GNC_Lensing` with [`trapz`](
- `P1::Point` and `P2::Point`, or `s1` and `s2`: `Point`/comoving distances where the
TPCF has to be calculated; they contain all the
data of interest needed for this calculus (comoving distance, growth factor and so on).
data of interest needed for this calculus (comoving distance, growth factor and so on);
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer;
- `cosmo::Cosmology`: cosmology to be used in this computation; it contains all the splines
used for the conversion `s` -> `Point`, and all the cosmological parameters ``b``, ...
Expand All @@ -457,10 +457,10 @@ This function is computed integrating `integrand_ξ_GNC_Lensing` with [`trapz`](
- `obs::Union{Bool,Symbol} = :noobsvel` : do you want to consider the observer terms in the computation of the
chosen GNC TPCF effect?
- `:yes` or `true` -> all the observer effects will be considered
- `:no` or `false` -> no observer term will be taken into account
- `:yes` or `true` -> all the observer terms will be considered;
- `:no` or `false` -> no observer term will be taken into account;
- `:noobsvel` -> the observer terms related to the observer velocity (that you can find in the CF concerning Doppler)
will be neglected, the other ones will be taken into account
will be neglected, the other ones will be taken into account.
- `en::Float64 = 1e6`: just a float number used in order to deal better
with small numbers;
Expand Down
8 changes: 4 additions & 4 deletions src/GNC_AutoCorrelations/GNC_AutoLocalGP.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ end
ξ_GNC_LocalGP(s1, s2, y, cosmo::Cosmology;
kwargs...) ::Float64
Return the Two-Point Correlation Function (TPCF) of the Local Gravitational
Returns the Two-Point Correlation Function (TPCF) of the Local Gravitational
Potential (GP) auto-correlation effect arising from the Galaxy Number Counts (GNC).
In the first method, you should pass the two `Point` (`P1` and `P2`) where to
Expand Down Expand Up @@ -163,7 +163,7 @@ where:
- ``f_1 = f(s_1)``, ... is the linear growth rate (evaluated in ``s_1``);
- ``\\mathcal{H}_1 = \\mathcal{H}(s_1)``, ... is the comoving
Hubble distances (evaluated in ``s_1``);
Hubble parameter (evaluated in ``s_1``, ...);
- ``y = \\cos{\\theta} = \\hat{\\mathbf{s}}_1 \\cdot \\hat{\\mathbf{s}}_2``;
Expand Down Expand Up @@ -218,9 +218,9 @@ if you set `obs = :noobsvel` they will still be computed.
- `P1::Point` and `P2::Point`, or `s1` and `s2`: `Point`/comoving distances where the
TPCF has to be calculated; they contain all the
data of interest needed for this calculus (comoving distance, growth factor and so on).
data of interest needed for this calculus (comoving distance, growth factor and so on);
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer;
- `cosmo::Cosmology`: cosmology to be used in this computation; it contains all the splines
used for the conversion `s` -> `Point`, and all the cosmological parameters ``b``, ...
Expand Down
16 changes: 8 additions & 8 deletions src/GNC_AutoCorrelations/GNC_AutoNewtonian.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ end
ξ_GNC_Newtonian(s1, s2, y, cosmo::Cosmology;
kwargs...) ::Float64
Return the Two-Point Correlation Function (TPCF) of the Newtonian auto-correlation effect
Returns the Two-Point Correlation Function (TPCF) of the Newtonian auto-correlation effect
arising from the Galaxy Number Counts (GNC).
In the first method, you should pass the two `Point` (`P1` and `P2`) where to
evaluate the function, while in the second method (that internally recalls the first)
you must provide the two corresponding comoving distances `s1` and `s2`.
We remember that all the distances are measured in ``h_0^{-1}\\mathrm{Mpc}``.
We recall that all the distances are measured in ``h_0^{-1}\\mathrm{Mpc}``.
The analytical expression of this term is the following:
Expand Down Expand Up @@ -138,7 +138,7 @@ where:
- ``f_1 = f(s_1)``, ... is the linear growth rate (evaluated in ``s_1``);
- ``\\mathcal{H}_1 = \\mathcal{H}(s_1)``, ... is the comoving
Hubble distances (evaluated in ``s_1``);
Hubble parameter (evaluated in ``s_1``, ...);
- ``y = \\cos{\\theta} = \\hat{\\mathbf{s}}_1 \\cdot \\hat{\\mathbf{s}}_2``;
Expand Down Expand Up @@ -191,9 +191,9 @@ the other GNC TPCFs.
- `P1::Point` and `P2::Point`, or `s1` and `s2`: `Point`/comoving distances where the
TPCF has to be calculated; they contain all the
data of interest needed for this calculus (comoving distance, growth factor and so on).
data of interest needed for this calculus (comoving distance, growth factor and so on);
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer;
- `cosmo::Cosmology`: cosmology to be used in this computation; it contains all the splines
used for the conversion `s` -> `Point`, and all the cosmological parameters ``b``, ...
Expand All @@ -202,10 +202,10 @@ the other GNC TPCFs.
- `obs::Union{Bool,Symbol} = :noobsvel` : do you want to consider the observer terms in the computation of the
chosen GNC TPCF effect?
- `:yes` or `true` -> all the observer effects will be considered
- `:no` or `false` -> no observer term will be taken into account
- `:yes` or `true` -> all the observer terms will be considered;
- `:no` or `false` -> no observer term will be taken into account;
- `:noobsvel` -> the observer terms related to the observer velocity (that you can find in the CF concerning Doppler)
will be neglected, the other ones will be taken into account
will be neglected, the other ones will be taken into account.
See also: [`Point`](@ref), [`Cosmology`](@ref), [`ξ_GNC_multipole`](@ref),
[`map_ξ_GNC_multipole`](@ref), [`print_map_ξ_GNC_multipole`](@ref)
Expand Down
28 changes: 14 additions & 14 deletions src/GNC_CrossCorrelations/GNC_DopplerIntegratedGP.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ where:
- ``f_1 = f(s_1)``, ... is the linear growth rate (evaluated in ``s_1``);
- ``\\mathcal{H}_1 = \\mathcal{H}(s_1)``, ... is the comoving
Hubble distances (evaluated in ``s_1``);
Hubble parameter (evaluated in ``s_1``, ...);
- ``y = \\cos{\\theta} = \\hat{\\mathbf{s}}_1 \\cdot \\hat{\\mathbf{s}}_2``;
Expand Down Expand Up @@ -228,10 +228,10 @@ This function is used inside `ξ_GNC_Doppler_IntegratedGP` with [`trapz`](@ref)
- `obs::Union{Bool,Symbol} = :noobsvel` : do you want to consider the observer terms in the computation of the
chosen GNC TPCF effect?
- `:yes` or `true` -> all the observer effects will be considered
- `:no` or `false` -> no observer term will be taken into account
- `:yes` or `true` -> all the observer terms will be considered;
- `:no` or `false` -> no observer term will be taken into account;
- `:noobsvel` -> the observer terms related to the observer velocity (that you can find in the CF concerning Doppler)
will be neglected, the other ones will be taken into account
will be neglected, the other ones will be taken into account.
See also: [`Point`](@ref), [`Cosmology`](@ref), [`ξ_GNC_multipole`](@ref),
[`map_ξ_GNC_multipole`](@ref), [`print_map_ξ_GNC_multipole`](@ref),
Expand All @@ -251,7 +251,7 @@ integrand_ξ_GNC_Doppler_IntegratedGP
obs::Union{Bool,Symbol}=:noobsvel
) ::Float64
Return the Two-Point Correlation Function (TPCF) given by the cross correlation between the
Returns the Two-Point Correlation Function (TPCF) given by the cross correlation between the
Doppler and the Integrated Gravitational Potential (GP) effects arising from the Galaxy Number Counts (GNC).
You must provide the two comoving distances `s1` and `s2` where to
Expand Down Expand Up @@ -315,7 +315,7 @@ where:
- ``f_1 = f(s_1)``, ... is the linear growth rate (evaluated in ``s_1``);
- ``\\mathcal{H}_1 = \\mathcal{H}(s_1)``, ... is the comoving
Hubble distances (evaluated in ``s_1``);
Hubble parameter (evaluated in ``s_1``, ...);
- ``y = \\cos{\\theta} = \\hat{\\mathbf{s}}_1 \\cdot \\hat{\\mathbf{s}}_2``;
Expand Down Expand Up @@ -374,9 +374,9 @@ This function is computed integrating `integrand_ξ_GNC_Doppler_IntegratedGP` wi
- `P1::Point` and `P2::Point`, or `s1` and `s2`: `Point`/comoving distances where the
TPCF has to be calculated; they contain all the
data of interest needed for this calculus (comoving distance, growth factor and so on).
data of interest needed for this calculus (comoving distance, growth factor and so on);
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer;
- `cosmo::Cosmology`: cosmology to be used in this computation; it contains all the splines
used for the conversion `s` -> `Point`, and all the cosmological parameters ``b``, ...
Expand All @@ -385,10 +385,10 @@ This function is computed integrating `integrand_ξ_GNC_Doppler_IntegratedGP` wi
- `obs::Union{Bool,Symbol} = :noobsvel` : do you want to consider the observer terms in the computation of the
chosen GNC TPCF effect?
- `:yes` or `true` -> all the observer effects will be considered
- `:no` or `false` -> no observer term will be taken into account
- `:yes` or `true` -> all the observer terms will be considered;
- `:no` or `false` -> no observer term will be taken into account;
- `:noobsvel` -> the observer terms related to the observer velocity (that you can find in the CF concerning Doppler)
will be neglected, the other ones will be taken into account
will be neglected, the other ones will be taken into account.
- `en::Float64 = 1e6`: just a float number used in order to deal better
with small numbers;
Expand Down Expand Up @@ -434,7 +434,7 @@ end
ξ_GNC_IntegratedGP_Doppler(s1, s2, y, cosmo::Cosmology; kwargs...) =
ξ_GNC_Doppler_IntegratedGP(s2, s1, y, cosmo; kwargs...)
Return the Two-Point Correlation Function (TPCF) given by the cross correlation between the
Returns the Two-Point Correlation Function (TPCF) given by the cross correlation between the
Integrated Gravitational Potential (GP) and the Doppler effects arising from the Galaxy Number Counts (GNC).
It's computed through the symmetric function `ξ_GNC_Doppler_IntegratedGP`; check its documentation for
Expand All @@ -446,14 +446,14 @@ We remember that all the distances are measured in ``h_0^{-1}\\mathrm{Mpc}``.
- `s1` and `s2`: comoving distances where the TPCF has to be calculated;
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer
- `y`: the cosine of the angle between the two points `P1` and `P2` wrt the observer;
- `cosmo::Cosmology`: cosmology to be used in this computation; it contains all the splines
used for the conversion `s` -> `Point`, and all the cosmological parameters ``b``, ...
## Keyword Arguments
- `kwargs...` : Keyword arguments to be passed to the symmetric TPCF
- `kwargs...` : Keyword arguments to be passed to the symmetric TPCF.
See also: [`Point`](@ref), [`Cosmology`](@ref), [`ξ_GNC_multipole`](@ref),
[`map_ξ_GNC_multipole`](@ref), [`print_map_ξ_GNC_multipole`](@ref),
Expand Down
Loading

0 comments on commit 0b61c52

Please sign in to comment.