Main Class Reference

Class for running the FoF algorithm. More...

#include <sfof.hpp>

Public Member Functions
void	read_options (int, char *[])
	This method calls Option to read the code options from the provided arguments and/or the parameter file. More...
void	read_data ()
	This method calls Fileio to read the input file and stores the data in Galaxy instances. More...
void	set_up_zbins ()
	This method sets up redshift bins in Zbin instances. More...
void	assign_linking_param ()
	This method assigns linking parameter values to Zbin instances. More...
void	check_results ()
	This method checks how many cluster candidates have been detected. More...
void	make_kdtree ()
	This method initialises a Kdtree instance. More...
void	background_counts ()
	This method counts the number of background galaxies at each redshift. More...
void	find_friends ()
	This method initialises a series of FoF instances for the corresponding Zbin instances. More...
void	merge_clusters ()
	This method initialises a Merge instance. More...
void	assign_cluster_props ()
	This method assigns properties to the Cluster instances. More...
void	output_results ()
	This method calls Fileio to write the Cluster instances and corresponding member Galaxy instances to files. More...

Public Attributes
Comp	comp
	Include Comp class. More...

Private Attributes
Astro	astro
	Include Astro class. More...
Fileio	fileio
	Include Fileio class. More...
Kdtree	tree
	Include Kdtree class. More...
Option	opt
	Include Option class. More...
Spline	spline_nz
	Include Spline. More...
Spline	spline_bg
int	num_bins
	Number of redshift bins. More...
std::string	param_file
	Option parameter file name. More...
std::vector< Zbin >	zbins
	Vector of Zbin instances. More...
std::vector< Galaxy >	galaxies
	Vector of Galaxy instances. More...
std::vector< Cluster >	clusters
	Vector of Cluster instances. More...

Detailed Description

Class for running the FoF algorithm.

This class runs the friends-of-friends cluster detection algorithm.

Member Function Documentation

assign_cluster_props()

void Main::assign_cluster_props

(

)

This method assigns properties to the Cluster instances.

assign_linking_param()

void Main::assign_linking_param

(

)

This method assigns linking parameter values to Zbin instances.

A reference value is defined in order to ensure uniformity.

background_counts()

void Main::background_counts

(

)

This method counts the number of background galaxies at each redshift.

check_results()

void Main::check_results

(

)

This method checks how many cluster candidates have been detected.

find_friends()

void Main::find_friends

(

)

This method initialises a series of FoF instances for the corresponding Zbin instances.

make_kdtree()

void Main::make_kdtree

(

)

This method initialises a Kdtree instance.

merge_clusters()

void Main::merge_clusters

(

)

This method initialises a Merge instance.

output_results()

void Main::output_results

(

)

This method calls Fileio to write the Cluster instances and corresponding member Galaxy instances to files.

read_data()

void Main::read_data

(

)

This method calls Fileio to read the input file and stores the data in Galaxy instances.

read_options()

void Main::read_options	(	int	argc,
		char *	argv[]
	)

This method calls Option to read the code options from the provided arguments and/or the parameter file.

Parameters

[in]	argc	Argument count.
[in]	argv	Argument vector.

set_up_zbins()

void Main::set_up_zbins

(

)

This method sets up redshift bins in Zbin instances.

Member Data Documentation

astro

Astro Main::astro

private

Include Astro class.

clusters

std::vector<Cluster> Main::clusters

private

Vector of Cluster instances.

comp

Comp Main::comp

Include Comp class.

fileio

Fileio Main::fileio

private

Include Fileio class.

galaxies

std::vector<Galaxy> Main::galaxies

private

Vector of Galaxy instances.

num_bins

int Main::num_bins

private

Number of redshift bins.

opt

Option Main::opt

private

Include Option class.

param_file

std::string Main::param_file

private

Option parameter file name.

spline_bg

Spline Main::spline_bg

private

spline_nz

Spline Main::spline_nz

private

Include Spline.

tree

Kdtree Main::tree

private

Include Kdtree class.

zbins

std::vector<Zbin> Main::zbins

private

Vector of Zbin instances.

---

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

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