Class for reading code options. More...

#include <option_class.hpp>

Public Member Functions
void	read_opts (int, char *[], double)
	This method reads options provided as arguments for Main. More...

void	read_merge_opts (int, char *[], double)
	This method reads options provided as arguments for Cat_Merge. More...

void	read_split_opts (int, char *[], double)
	This method reads options provided as arguments for Cat_Split. More...

Public Attributes
int	min_ngal
	Minimum number of member Galaxy instances required to form a Cluster instance. More...

int	max_ngal
	Maximum number of member Galaxy allowed to form a Cluster instance. More...

int	n_ra_bins
	Number of bins in right ascension. More...

int	n_dec_bins
	Number of bins in declination. More...

int	n_procs
	Number of processes. More...

double	link_r
	Transverse linking parameter. More...

double	link_z
	Line-of-sight linking parameter. More...

double	z_bin_size
	Redshift bin size. More...

double	z_min
	Minimum redshift allowed. More...

double	z_max
	Maximum redshift allowed. More...

double	z_ref
	Reference redshift for calculations. More...

double	z_err_max
	Maxmimum photometric redshift error allowed. More...

std::string	nz_data
	Input file name for N(z) data. More...

double	c
	Speed of light [km/s]. More...

double	H0
	Hubble parameter [km/s/Mpc]. More...

double	omega_m
	Matter density. More...

double	omega_l
	Dark energy density. More...

double	ra_lower
	Minimum right ascension of range. More...

double	ra_upper
	Maximum right ascension of range. More...

double	dec_lower
	Minimum declination of range. More...

double	dec_upper
	Maximum declination of range. More...

double	ra_overlap
	Overlap in right ascension. More...

double	dec_overlap
	Overlap in declination. More...

std::string	config_file
	Configuration File. More...

std::string	input_file
	Input file name. More...

std::string	output_clusters
	Output cluster file name. More...

std::string	output_members
	Output member file name. More...

std::string	output_file
	Output file name. More...

bool	print_bin_data
	Option to print Zbin data. More...

bool	print_kdtree_data
	Option to print kd-tree data. More...

bool	print_bg_data
	Option to print background data. More...

std::string	bg_data
	Input file name for background data. More...

std::string	input_mode
	Input mode ["ascii"/"fits"]. More...

std::string	output_mode
	Output mode ["ascii"/"fits"]. More...

std::string	fof_mode
	FoF mode ["spec"/"phot"]. More...

std::string	link_mode
	FoF linking mode ["dynamic"/"fixed"]. More...

std::string	size_units
	Cluser size units ["arcmin"/"deg"/"Mpc"]. More...

Private Member Functions
void	version (double)
	This method prints the code version number. More...

void	print_parameters ()
	This method prints the current parameter values. More...

Detailed Description

Class for reading code options.

This class reads the code options as arguments or from a parameter file.

Member Function Documentation

◆ print_parameters()

void Option::print_parameters ( )

private

This method prints the current parameter values.

◆ read_merge_opts()

void Option::read_merge_opts	(	int	argc,
		char *	argv[],
		double	version_number
	)

This method reads options provided as arguments for Cat_Merge.

Parameters

[in]	argc	Argument count.
[in]	argv	Argument vector.
[in]	version_number	Code version number.

◆ read_opts()

void Option::read_opts	(	int	argc,
		char *	argv[],
		double	version_number
	)

This method reads options provided as arguments for Main.

Parameters

[in]	argc	Argument count.
[in]	argv	Argument vector.
[in]	version_number	Code version number.

◆ read_split_opts()

void Option::read_split_opts	(	int	argc,
		char *	argv[],
		double	version_number
	)

This method reads options provided as arguments for Cat_Split.

Parameters

[in]	argc	Argument count.
[in]	argv	Argument vector.
[in]	version_number	Code version number.

◆ version()

void Option::version ( double version_number )

private

This method prints the code version number.

Member Data Documentation

◆ bg_data

std::string Option::bg_data

Input file name for background data.

◆ c

double Option::c

Speed of light [km/s].

◆ config_file

std::string Option::config_file

Configuration File.

◆ dec_lower

double Option::dec_lower

Minimum declination of range.

◆ dec_overlap

double Option::dec_overlap

Overlap in declination.

◆ dec_upper

double Option::dec_upper

Maximum declination of range.

◆ fof_mode

std::string Option::fof_mode

FoF mode ["spec"/"phot"].

◆ H0

double Option::H0

Hubble parameter [km/s/Mpc].

◆ input_file

std::string Option::input_file

Input file name.

◆ input_mode

std::string Option::input_mode

Input mode ["ascii"/"fits"].

◆ link_mode

std::string Option::link_mode

FoF linking mode ["dynamic"/"fixed"].

◆ link_r

double Option::link_r

Transverse linking parameter.

◆ link_z

double Option::link_z

Line-of-sight linking parameter.

◆ max_ngal

int Option::max_ngal

Maximum number of member Galaxy allowed to form a Cluster instance.

◆ min_ngal

int Option::min_ngal

Minimum number of member Galaxy instances required to form a Cluster instance.

◆ n_dec_bins

int Option::n_dec_bins

Number of bins in declination.

◆ n_procs

int Option::n_procs

Number of processes.

◆ n_ra_bins

int Option::n_ra_bins

Number of bins in right ascension.

◆ nz_data

std::string Option::nz_data

Input file name for N(z) data.

◆ omega_l

double Option::omega_l

Dark energy density.

◆ omega_m

double Option::omega_m

Matter density.

◆ output_clusters

std::string Option::output_clusters

Output cluster file name.

◆ output_file

std::string Option::output_file

Output file name.

◆ output_members

std::string Option::output_members

Output member file name.

◆ output_mode

std::string Option::output_mode

Output mode ["ascii"/"fits"].

◆ print_bg_data

bool Option::print_bg_data

Option to print background data.

◆ print_bin_data

bool Option::print_bin_data

Option to print Zbin data.

◆ print_kdtree_data

bool Option::print_kdtree_data

Option to print kd-tree data.

◆ ra_lower

double Option::ra_lower

Minimum right ascension of range.

◆ ra_overlap

double Option::ra_overlap

Overlap in right ascension.

◆ ra_upper

double Option::ra_upper

Maximum right ascension of range.

◆ size_units

std::string Option::size_units

Cluser size units ["arcmin"/"deg"/"Mpc"].

◆ z_bin_size

double Option::z_bin_size

Redshift bin size.

◆ z_err_max

double Option::z_err_max

Maxmimum photometric redshift error allowed.

◆ z_max

double Option::z_max

Maximum redshift allowed.

◆ z_min

double Option::z_min

Minimum redshift allowed.

◆ z_ref

double Option::z_ref

Reference redshift for calculations.

The documentation for this class was generated from the following files:

/Users/sfarrens/Documents/Codes/github/sfof/sfof/src/option_class.hpp
/Users/sfarrens/Documents/Codes/github/sfof/sfof/src/option_class.cpp

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ print_parameters()

◆ read_merge_opts()

◆ read_opts()

◆ read_split_opts()

◆ version()

Member Data Documentation

◆ bg_data

◆ c

◆ config_file

◆ dec_lower

◆ dec_overlap

◆ dec_upper

◆ fof_mode

◆ H0

◆ input_file

◆ input_mode

◆ link_mode

◆ link_r

◆ link_z

◆ max_ngal

◆ min_ngal

◆ n_dec_bins

◆ n_procs

◆ n_ra_bins

◆ nz_data

◆ omega_l

◆ omega_m

◆ output_clusters

◆ output_file

◆ output_members

◆ output_mode

◆ print_bg_data

◆ print_bin_data

◆ print_kdtree_data

◆ ra_lower

◆ ra_overlap

◆ ra_upper

◆ size_units

◆ z_bin_size

◆ z_err_max

◆ z_max

◆ z_min

◆ z_ref