Input Parameters¶
Projected Space¶
Input Parameters Dictionary (pcf)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘pcf’) |
| h0 | Hubble constant [km/s/Mpc]. Default=100. |
| omegam | Omega matter. Default=0.3 |
| omegal | Omega lambda. Default=0.7 |
| autogrid | If True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| mxh3 | Nr. of DCOM cells of the SK table. Only relevant if
autogrid=False. See Note on mxh3 below. Default=40 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=12345 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nsepp | Nr. of projected separation bins. Default=22 |
| seppmin | Minimum projected distance to consider [Mpc/h]. Default=0.01 |
| dsepp | Size of projected bins (in dex if log bins). Default=0.15 |
| logsepp | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| nsepv | Nr. of radial separation bins. Default=1 |
| dsepv | Size of radial bins (linear) [Mpc/h]. Default=40. |
| calcdist | If False, take comov. distances from input tables
instead of calculating them. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| file1 | File name of random sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| estimator | Statistical estimator of the correlation function.
Default=’NAT’ * ‘NAT’ : Natural estimator -> \(DD/RR-1\) * ‘HAM’ : Hamilton estimator -> \(DD*RR/DR^{2}-1\) * ‘LS’ : Landy-Szalay estimator -> \((DD-2DR+RR)/RR\) * ‘DP’ : Davis-Peebles estimator -> \(DD/DR-1\) |
| cra,cdec, cred,cwei, cdcom | Column names in data sample table (tab). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| cra1,cdec1, cred1,cwei1 cdcom1 | Column names in random sample (tab1). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Input Parameters Dictionary (pccf)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘pccf’) |
| h0 | Hubble constant [km/s/Mpc]. Default=100. |
| omegam | Omega matter. Default=0.3 |
| omegal | Omega lambda. Default=0.7 |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| mxh3 | Nr. of DCOM cells of the SK table. Only relevant if
autogrid=False. See Note on mxh3 below. Default=40 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=1245 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nsepp | Nr. of projected separation bins. Default=22 |
| seppmin | Minimum projected distance to consider [Mpc/h]. Default=0.01 |
| dsepp | Size of projected bins (in dex if log bins). Default=0.15 |
| logsepp | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| nsepv | Nr. of radial separation bins. Default=1 |
| dsepv | Size of radial bins (linear) [Mpc/h]. Default=40. |
| calcdist | If False, take comov. distances from input tables
instead of calculating them. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| file1 | File name of random sample. Only informative. Default=’‘ |
| file2 | File name of cross sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| estimator | Statistical estimator of the correlation function.
Default=’DP’ * ‘DP’ : Davis-Peebles estimator -> \(CD/CR - 1\) |
| cra,cdec, cred,cwei, cdcom | Column names in data sample table (tab). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| cra1,cdec1, cred1,cwei1 cdcom1 | Column names in random sample (tab1). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| cra2,cdec2, cred2,cwei2 cdcom2 | Column names in cross sample table (tab2). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Input Parameters Dictionary (rppiA)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘rppiA’) |
| h0 | Hubble constant [km/s/Mpc]. Default=100. |
| omegam | Omega matter. Default=0.3 |
| omegal | Omega lambda. Default=0.7 |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| mxh3 | Nr. of DCOM cells of the SK table. Only relevant if
autogrid=False. See Note on mxh3 below. Default=40 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=1245 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nsepp | Nr. of projected separation bins. Default=22 |
| seppmin | Minimum projected separation to consider [Mpc/h]. Default=0.01 |
| dsepp | Size of projected bins (in dex if log bins). Default=0.15 |
| logsepp | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| nsepv | Nr. of radial separation bins. Default=1 |
| dsepv | Size of radial bins (linear) [Mpc/h]. Default=40. |
| calcdist | If False, take comov. distances from input tables
instead of calculating them. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| cra,cdec, cred,cwei, cdcom | Column names in th sample table (tab). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Input Parameters Dictionary (rppiC)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘rppiC’) |
| h0 | Hubble constant [km/s/Mpc]. Default=100. |
| omegam | Omega matter. Default=0.3 |
| omegal | Omega lambda. Default=0.7 |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| mxh3 | Nr. of DCOM cells of the SK table. Only relevant if
autogrid=False. See Note on mxh3 below. Default=40 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=1245 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nsepp | Nr. of projected separation bins. Default=22 |
| seppmin | Minimum projected distance to consider [Mpc/h]. Default=0.01 |
| dsepp | Size of projected bins (in dex if log bins). Default=0.15 |
| logsepp | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| nsepv | Nr. of radial separation bins. Default=1 |
| dsepv | Size of radial bins (linear) [Mpc/h]. Default=40. |
| calcdist | If False, take comov. distances from input tables
instead of calculating them. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| file1 | File name of random sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| cra,cdec, cred,cwei, cdcom | Column names in data sample table (tab). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| cra1,cdec1, cred1,cwei1 cdcom1 | Column names in random sample (tab1). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Note on mxh3¶
Due to performance reasons, the number of cells in the radial (comoving) distance
actually used to build the skip table is always set as mxh3=int((dcmax-dcmin)/rvmax).
Hence, the parameter mxh3 supplied at input will be ignored unless it is
smaller than this optimum value.
Note however that mxh3 is only relevant for the performance of the algorithms.
It is not related with the number of radial bins nsepv where we want to
get output counts.
Redshift Space¶
Input Parameters Dictionary (rcf)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘rcf’) |
| h0 | Hubble constant [km/s/Mpc]. Default=100. |
| omegam | Omega matter. Default=0.3 |
| omegal | Omega lambda. Default=0.7 |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| mxh3 | Nr. of DCOM cells of the SK table. Only relevant if
autogrid=False. See Note on mxh3 below. Default=40 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=12345 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nseps | Nr. of redshift space bins. Default=22 |
| sepsmin | Minimum separation to consider [Mpc/h]. Default=0.01 |
| dseps | Size of redshift space bins (in dex if log bins). Default=0.15 |
| logseps | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| calcdist | If False, take comov. distances from input tables
instead of calculating them. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| file1 | File name of random sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| estimator | Statistical estimator of the correlation function.
Default=’NAT’ * ‘NAT’ : Natural estimator -> \(DD/RR-1\) * ‘HAM’ : Hamilton estimator -> \(DD*RR/DR^{2}-1\) * ‘LS’ : Landy-Szalay estimator -> \((DD-2DR+RR)/RR\) * ‘DP’ : Davis-Peebles estimator -> \(DD/DR-1\) |
| cra,cdec, cred,cwei, cdcom | Column names in data sample table (tab). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| cra1,cdec1, cred1,cwei1 cdcom1 | Column names in random sample (tab1). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Input Parameters Dictionary (rccf)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘rccf’) |
| h0 | Hubble constant [km/s/Mpc]. Default=100. |
| omegam | Omega matter. Default=0.3 |
| omegal | Omega lambda. Default=0.7 |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| mxh3 | Nr. of DCOM cells of the SK table. Only relevant if
autogrid=False. See Note on mxh3 below. Default=40 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=1245 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nseps | Nr. of redshift space bins. Default=22 |
| sepsmin | Minimum separation to consider [Mpc/h]. Default=0.01 |
| dseps | Size of redshift space bins (in dex if log bins). Default=0.15 |
| logseps | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| calcdist | If False, take comov. distances from input tables
instead of calculating them. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| file1 | File name of random sample. Only informative. Default=’‘ |
| file2 | File name of cross sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| estimator | Statistical estimator of the correlation function.
Default=’DP’ * ‘DP’ : Davis-Peebles estimator -> \(CD/CR - 1\) |
| cra,cdec, cred,cwei, cdcom | Column names in data sample table (tab). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| cra1,cdec1, cred1,cwei1 cdcom1 | Column names in random sample (tab1). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| cra2,cdec2, cred2,cwei2 cdcom2 | Column names in cross sample table (tab2). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Input Parameters Dictionary (sA)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘sA’) |
| h0 | Hubble constant [km/s/Mpc]. Default=100. |
| omegam | Omega matter. Default=0.3 |
| omegal | Omega lambda. Default=0.7 |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| mxh3 | Nr. of DCOM cells of the SK table. Only relevant if
autogrid=False. See Note on mxh3 below. Default=40 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=1245 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nseps | Nr. of redshift space bins. Default=22 |
| sepsmin | Minimum separation to consider [Mpc/h]. Default=0.01 |
| dseps | Size of redshift space bins (in dex if log bins). Default=0.15 |
| logseps | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| calcdist | If False, take comov. distances from input tables
instead of calculating them. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| cra,cdec, cred,cwei, cdcom | Column names in th sample table (tab). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Input Parameters Dictionary (sC)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘sC’) |
| h0 | Hubble constant [km/s/Mpc]. Default=100. |
| omegam | Omega matter. Default=0.3 |
| omegal | Omega lambda. Default=0.7 |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| mxh3 | Nr. of DCOM cells of the SK table. Only relevant if
autogrid=False. See Note on mxh3 below. Default=40 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=1245 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nseps | Nr. of redshift space bins. Default=22 |
| sepsmin | Minimum separation to consider [Mpc/h]. Default=0.01 |
| dseps | Size of redshift space bins (in dex if log bins). Default=0.15 |
| logseps | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| calcdist | If False, take comov. distances from input tables
instead of calculating them. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| file1 | File name of random sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| cra,cdec, cred,cwei, cdcom | Column names in data sample table (tab). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| cra1,cdec1, cred1,cwei1 cdcom1 | Column names in random sample (tab1). Default=(‘ra’ , ‘dec’, ‘z’, ‘wei’, ‘dcom’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Note on mxh3¶
Due to performance reasons, the number of cells in the radial (comoving) distance
actually used to build the skip table is always set as mxh3=int((dcmax-dcmin)/rvmax).
Hence, the parameter mxh3 supplied at input will be ignored unless it is
smaller than this optimum value.
Note however that mxh3 is only relevant for the performance of the algorithms.
It is not related with the number of radial bins nsepv where we want to
get output counts.
Angular Space¶
Input Parameters Dictionary (acf)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘acf’) |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=1245 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nsept | Nr. of angular bins. Default=22 |
| septmin | Minimum separation to consider [deg]. Default=0.01 |
| dsept | Size of angular bins (in dex if log bins). Default=0.15 |
| logsept | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| file1 | File name of random sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| estimator | Statistical estimator of the correlation function.
Default=’NAT’ * ‘NAT’ : Natural estimator -> \(DD/RR-1\) * ‘HAM’ : Hamilton estimator -> \(DD*RR/DR^{2}-1\) * ‘LS’ : Landy-Szalay estimator -> \((DD-2DR+RR)/RR\) * ‘DP’ : Davis-Peebles estimator -> \(DD/DR-1\) |
| cra,cdec, cwei | Column names in data sample table (tab). Default=(‘ra’, ‘dec’, ‘wei’) |
| cra1,cdec1, cwei1 | Column names in random sample table (tab1). Default=(‘ra’, ‘dec’, ‘wei’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Input Parameters Dictionary (accf)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘accf’) |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=1245 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nsept | Nr. of angular bins. Default=22 |
| septmin | Minimum separation to consider [deg]. Default=0.01 |
| dsept | Size of angular bins (in dex if log bins). Default=0.15 |
| logsept | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| file1 | File name of random sample. Only informative. Default=’‘ |
| file2 | File name of cross sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| estimator | Statistical estimator of the correlation function.
Default=’DP’ * ‘DP’ : Davis-Peebles estimator -> \(CD/CR - 1\) |
| cra,cdec, cwei | Column names in data sample table (tab). Default=(‘ra’, ‘dec’, ‘wei’) |
| cra1,cdec1, cwei1 | Column names in random sample table (tab1). Default=(‘ra’, ‘dec’, ‘wei’) |
| cra2,cdec2, cwei2 | Column names in cross sample table (tab2). Default=(‘ra’, ‘dec’, ‘wei’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Input Parameters Dictionary (thA)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘thA’) |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| pxorder | Data ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=1245 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nsept | Nr. of angular bins. Default=22 |
| septmin | Minimum separation to consider [deg]. Default=0.01 |
| dsept | Size of angular bins (in dex if log bins). Default=0.15 |
| logsept | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| cra,cdec, cred,cwei | Column names in data sample table (tab). Default=(‘ra’, ‘dec’, ‘wei’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |
Input Parameters Dictionary (thC)¶
Dictionary with attribute-style access, that stores all input parameters for the code, plus some useful run time information during output (see Additional Runtime Information in Ouput)
| Parameter | Description |
|---|---|
| kind | Kind of correlation function (‘thC’) |
| autogrid | If autogrid=True choose the optimum nr. of cells
(mxh1,mxh2,mxh3) of the skip table (SK). Default=True |
| dens | Custom nr. of particles per SK cell used when autogrid=True.
No need to specify unless desired. Default=None |
| mxh1 | Nr. of DEC cells of the SK table. Only relevant if
autogrid=False. Default=30 |
| mxh2 | Nr. of RA cells of the SK table. Only relevant if
autogrid=False. Default=180 |
| pxorder | Pixel ordering method. See Pixel Ordering Methods for details and options. Default=’natural’ |
| doboot | If True, calculate bootstrap counts and error bars.
Default=False |
| nbts | Nr. of bootstrap samples. Only relevant if doboot=True.
Default=50 |
| bseed | Fixed seed for boostrap RNG. Always set bseed>0 if running
in paralell. Default=12345 |
| wfib | If True apply SDSS fiber correction for pairs closer than
55”. See wfiber() Fortran function. Default=False |
| nsept | Nr. of angular bins. Default=22 |
| septmin | Minimum separation to consider [deg]. Default=0.01 |
| dsept | Size of angular bins (in dex if log bins). Default=0.15 |
| logsept | If True use log-spaced bins. Otherwise use linear-spaced
bins. Default=True |
| file | File name of data sample. Only informative. Default=’‘ |
| file1 | File name of random sample. Only informative. Default=’‘ |
| description | Short description of the run. Only informative. Default=’‘ |
| pxorder | Sorting method for data. See Pixel Ordering Methods for options. Default=’natural’ |
| cra,cdec, cwei | Column names in data sample table (tab). Default=(‘ra’, ‘dec’, ‘wei’) |
| cra1,cdec1, cwei1 | Column names in random sample table (tab1). Default=(‘ra’, ‘dec’, ‘wei’) |
| custRAbound | Specify custom RA boundaries for samples that cross the RA=0 limit. See Custom RA Boundaries. Default=None |
| outfn | Base name for all output files (e.g. /home/myuser/redagn) |