ccl_redshifts.h File Reference

#include <gsl/gsl_integration.h>
#include <gsl/gsl_spline.h>

Include dependency graph for ccl_redshifts.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	pz_info
struct	dNdz_info
struct	smail_params

Macros
#define	Z_MIN_SOURCES   0.
#define	Z_MAX_SOURCES   5.0

Functions
void	ccl_dNdz_tomog (double z, double bin_zmin, double bin_zmax, pz_info *photo_info, dNdz_info *dN_info, double *tomoout, int *status)
dNdz_info *	ccl_create_dNdz_info (void *params, double(*dNdz_func)(double, void *, int *))
dNdz_info *	ccl_create_Smail_dNdz_info (double alpha, double beta, double z0)
void	ccl_free_dNdz_info (dNdz_info *dN_info)
pz_info *	ccl_create_photoz_info (void *params, double(*pz_func)(double, double, void *, int *))
pz_info *	ccl_create_gaussian_photoz_info (double sigma_z0)
void	ccl_free_photoz_info (pz_info *my_photoz_info)

Macro Definition Documentation

#define Z_MAX_SOURCES   5.0

Definition at line 13 of file ccl_redshifts.h.

Referenced by ccl_dNdz_tomog().

#define Z_MIN_SOURCES   0.

We assume no relevant source redshift distributions exceed z= 5

Definition at line 12 of file ccl_redshifts.h.

Referenced by ccl_dNdz_tomog().

Function Documentation

dNdz_info* ccl_create_dNdz_info	(	void *	params,
		double(*)(double, void *, int *)	dNdz_func
	)

This function creates a structure amalgamating the information on an analytic true dNdz, plus some parameters.

Parameters

params	parameters for the analytic dNdz form
dNdz_func	dNdz function

Returns

a structure with the dNdz and parameters

Definition at line 94 of file ccl_redshifts.c.

References halomod_bm::params, and dNdz_info::your_dN_params.

Referenced by main().

{
  dNdz_info * this_info = malloc(sizeof(dNdz_info));
  this_info ->your_dN_params = params;
  this_info -> your_dN_func = dNdz_func;
  
  return this_info;
}

pz_info* ccl_create_gaussian_photoz_info

(

double

sigma_z0

)

This function creates a structure containing the photo-z model for the built-in Gaussian photo-z pdf.

Parameters

sigma_z0

The photo-z uncertainty at z=0. The photo-z uncertainty is assumed to scale like (1 + z).

Returns

a structure with the built-in Gaussian P(z) and parameters

Definition at line 67 of file ccl_redshifts.c.

References gaussian_pz(), pz_info::your_pz_func, and pz_info::your_pz_params.

Referenced by main().

                                                         {
    
    // Allocate memory so that this value persists
    double* sigma_z0_copy = malloc(sizeof(double));
    *sigma_z0_copy = sigma_z0;
    
    // Construct pz_info struct
    pz_info * this_info = malloc(sizeof(pz_info));
    this_info->your_pz_params = sigma_z0_copy;
    this_info->your_pz_func = &gaussian_pz;
    return this_info;
}

pz_info* ccl_create_photoz_info	(	void *	params,
		double(*)(double, double, void *, int *)	pz_func
	)

This function creates a structure amalgamating the information on the photo-z model, P(z) plus some parameters.

Parameters

params	parameters for the P(z) function
pz_func	P(z) function

Returns

a structure with the P(z) and parameters

Definition at line 21 of file ccl_redshifts.c.

References halomod_bm::params, and pz_info::your_pz_params.

Referenced by main().

{
  pz_info * this_info = malloc(sizeof(pz_info));
  this_info ->your_pz_params = params;
  this_info -> your_pz_func = pz_func;
  
  return this_info;
}

dNdz_info* ccl_create_Smail_dNdz_info	(	double	alpha,
		double	beta,
		double	z0
	)

This function creates a structure containing the true dNdz for the built-in Smail-type analytic form: dNdz ~ z^alpha exp(- (z/z0)^beta)

Parameters

alpha
z0
beta

Returns

a structure with the built-in Smail-type dNdz and parameters

Definition at line 120 of file ccl_redshifts.c.

References smail_params::alpha, beta, smail_params::beta, dNdz_smail(), dNdz_info::your_dN_func, dNdz_info::your_dN_params, and smail_params::z0.

Referenced by main().

                                                                           {
    
    // Allocate a smail type parmaeter structure
    smail_params * smail_par = malloc(sizeof(smail_params));
    smail_par->alpha = alpha;
    smail_par->beta = beta;
    smail_par->z0 = z0;
    
    // Construct dNdz_info struct
    dNdz_info * this_info = malloc(sizeof(dNdz_info));
    this_info->your_dN_params = smail_par;
    this_info->your_dN_func = &dNdz_smail;
    return this_info;
}

void ccl_dNdz_tomog	(	double	z,
		double	bin_zmin,
		double	bin_zmax,
		pz_info *	photo_info,
		dNdz_info *	dN_info,
		double *	tomoout,
		int *	status
	)

Return dNdz in a particular tomographic bin, convolved with a photo-z model (defined by the user), and normalized.

Parameters

z	redshift
dNdz_type	the choice of dN/dz from Chang+
bin_zmin	the minimum redshift of the tomorgraphic bin
bin_zmax	the maximum redshift of the tomographic bin
photo_info	the P(z) info struct
tomoout	the output dN/dz
status	Status flag. 0 if there are no errors, nonzero otherwise.

Returns

void

Definition at line 222 of file ccl_redshifts.c.

References norm_params::bin_zmax_, norm_params::bin_zmin_, ccl_cosmology_read_config(), ccl_dNdz(), CCL_ERROR_INTEG, CCL_ERROR_MISSING_CONFIG_FILE, ccl_gsl, ccl_norm_integrand(), ccl_photoz(), ccl_raise_exception(), ccl_raise_gsl_warning(), ccl_splines, norm_params::dN_information, ccl_gsl_params::INTEGRATION_DNDZ_EPSREL, ccl_gsl_params::N_ITERATION, pz_params::pz_information, norm_params::pz_information, pz_params::status, norm_params::status, z, Z_MAX_SOURCES, Z_MIN_SOURCES, and pz_params::z_true.

Referenced by main().

{   
  // This uses equation 33 of Joachimi & Schneider 2009, arxiv:0905.0393
  double numerator_integrand=0, denom_integrand=0, dNdz_t;
  // This struct contains a spec redshift and a pointer to a photoz information struct.
  struct pz_params pz_p_val; //parameters for the integral over the photoz's
  struct norm_params norm_p_val;    
  
  // Check whether ccl_splines and ccl_gsl exist; exit gracefully if they 
  // can't be loaded
  if(ccl_splines==NULL || ccl_gsl==NULL) ccl_cosmology_read_config();
  if(ccl_splines==NULL || ccl_gsl==NULL) {
    ccl_raise_exception(CCL_ERROR_MISSING_CONFIG_FILE, 
                        "ccl_redshifts.c: Failed to read config file.");
    *status = CCL_ERROR_MISSING_CONFIG_FILE;
    return;
  }
  
  // Set up the parameters to pass to the normalising integral (of type struct norm_params
  norm_p_val.bin_zmin_=bin_zmin;
  norm_p_val.bin_zmax_=bin_zmax;
  norm_p_val.pz_information = photo_info;   
  norm_p_val.status = status;
  norm_p_val.dN_information = dN_info;
  
  dNdz_t = ccl_dNdz(z, dN_info, status);
  
  // Set up the parameters for the integral over the photo z function in the numerator (of type struct pz_params)
  pz_p_val.z_true = z;
  pz_p_val.status = status;
  pz_p_val.pz_information = photo_info; // pointer to user information
 
  // Integrate over the assumed pdf of photo-z wrt true-z in this bin (this goes in the numerator of the result):
  gsl_integration_cquad_workspace * workspace = gsl_integration_cquad_workspace_alloc(ccl_gsl->N_ITERATION);
  gsl_function F;
  F.function = ccl_photoz;
  F.params = &pz_p_val;
  int gslstatus = gsl_integration_cquad(&F, bin_zmin, bin_zmax, 0.0,ccl_gsl->INTEGRATION_DNDZ_EPSREL,workspace,&numerator_integrand, NULL, NULL);
  if(gslstatus != GSL_SUCCESS) {
    ccl_raise_gsl_warning(gslstatus, "ccl_redshifts.c: ccl_norm_integrand():");
    *status |= gslstatus;
  } 
  gsl_integration_cquad_workspace_free(workspace);  
  
  // Now get the denominator, which normalizes dNdz over the photometric bin
  workspace = gsl_integration_cquad_workspace_alloc(ccl_gsl->N_ITERATION);
  F.function = ccl_norm_integrand;
  F.params = &norm_p_val;
  gslstatus = gsl_integration_cquad(&F, Z_MIN_SOURCES, Z_MAX_SOURCES, 0.0,ccl_gsl->INTEGRATION_DNDZ_EPSREL,workspace,&denom_integrand, NULL, NULL);
  if(gslstatus != GSL_SUCCESS) {
    ccl_raise_gsl_warning(gslstatus, "ccl_redshifts.c: ccl_norm_integrand():");
    *status |= gslstatus;
  }
   
  gsl_integration_cquad_workspace_free(workspace);
  if (*status) {
    *status = CCL_ERROR_INTEG;
    return;
  }
  *tomoout = dNdz_t * numerator_integrand / denom_integrand;

}

void ccl_free_dNdz_info

(

dNdz_info *

dN_info

)

Free memory holding the structure containing dNdz information.

Parameters

dN_info

that holds user-defined dNdz and parameters

Returns

void

Definition at line 152 of file ccl_redshifts.c.

Referenced by main().

{
  free(my_dNdz_info);
}

void ccl_free_photoz_info

(

pz_info *

my_photoz_info

)

Free memory holding the structure containing user-input photoz information.

Parameters

my_photoz_info

that holds user-defined P(z) and parameters

Returns

void

Definition at line 84 of file ccl_redshifts.c.

Referenced by main().

{
  free(my_photoz_info);
}