Cluster Class Reference

Class for storing galaxy cluster properties and members. More...

#include <cluster_class.hpp>

Public Member Functions
	Cluster (int num_val)
	Initialise Cluster instance. More...
	Cluster ()
void	add_gal (Galaxy *)
	This method adds a Galaxy instance to a Cluster instance. More...
void	assign_dist (double, double, double, double)
	This method calculates the angular diameter distance of a Cluster instance for a given cosmology. More...
void	assign_props ()
	This method assigns properties based on those of the members to the Cluster instance. More...
void	assign_sn (double)
	This method assigns a signal-to-noise value to a Cluster instance given a value of the expected background number density. More...
void	update_size (const std::string)
	This method updates the units of the cluster size to those specified. More...
void	clear ()
	This method clears all members from a Cluster instance. More...
void	rename (int)
	This method resets the number associated to a Cluster instance. More...
void	unique ()
	This method removes all duplicate members from a Cluster instance. More...

Public Attributes
int	num
	Number asscosiated to Cluster instance. More...
int	ngal
	Number of members in Cluster instance. More...
double	ra
	Right ascension of Cluster instance. More...
double	ra_err
	Right ascension error of Cluster instance. More...
double	dec
	Declination of Cluster instance. More...
double	dec_err
	Declination error of Cluster instance. More...
double	z
	Redshift of Cluster instance. More...
double	z_err
	Redshift error of Cluster instance. More...
double	size
	Size of Cluster instance in specified units. More...
double	area
	Area of Cluster instance in specified units. More...
double	sn
	Signal-to-noise of Cluster instance. More...
double	da
	Angular diameter distance of Cluster instance. More...
std::vector< Galaxy * >	mem
	Vector of Cluster member Galaxy instances. More...

Private Attributes
Astro	astro
	Include Astro class. More...
Cosmo	cosmo
	Include Cosmo class. More...

Friends
bool	operator< (const Cluster &clt1, const Cluster &clt2)
	Bool < operator for Cluster class. More...

Detailed Description

Class for storing galaxy cluster properties and members.

This class stores Galaxy instances as galaxy cluster members and calculates the corresponding Cluster properties from the member properties.

Constructor & Destructor Documentation

Cluster() [1/2]

Cluster::Cluster

(

int

num_val

)

Initialise Cluster instance.

Parameters

[in]

num_val

Integer value.

Cluster() [2/2]

Cluster::Cluster

(

)

Member Function Documentation

add_gal()

void Cluster::add_gal

(

Galaxy *

gal

)

This method adds a Galaxy instance to a Cluster instance.

Parameters

gal	Galaxy instance.

assign_dist()

void Cluster::assign_dist	(	double	c,
		double	H0,
		double	Omega_M,
		double	Omega_L
	)

This method calculates the angular diameter distance of a Cluster instance for a given cosmology.

Parameters

[in]	c	Speed of light [km/s].
[in]	H0	Hubble parameter [km/s/Mpc].
[in]	Omega_M	Matter density.
[in]	Omega_L	Dark energy density.

assign_props()

void Cluster::assign_props

(

)

This method assigns properties based on those of the members to the Cluster instance.

assign_sn()

void Cluster::assign_sn

(

double

bg_expect

)

This method assigns a signal-to-noise value to a Cluster instance given a value of the expected background number density.

Parameters

[in]

bg_expect

Background number density [n_gal / arcmin^2]

clear()

void Cluster::clear

(

)

This method clears all members from a Cluster instance.

rename()

void Cluster::rename

(

int

num_val

)

This method resets the number associated to a Cluster instance.

Parameters

[in]

num_val

Integer value.

unique()

void Cluster::unique

(

)

This method removes all duplicate members from a Cluster instance.

update_size()

void Cluster::update_size

(

const std::string

size_units

)

This method updates the units of the cluster size to those specified.

Parameters

[in]

size_units

Cluster size units.

Friends And Related Function Documentation

operator<

bool operator< ( const Cluster &  clt1, const Cluster &  clt2  )

friend

Bool < operator for Cluster class.

Compares the number of members between two Cluster instances.

Member Data Documentation

area

double Cluster::area

Area of Cluster instance in specified units.

astro

Astro Cluster::astro

private

Include Astro class.

cosmo

Cosmo Cluster::cosmo

private

Include Cosmo class.

da

double Cluster::da

Angular diameter distance of Cluster instance.

dec

double Cluster::dec

Declination of Cluster instance.

dec_err

double Cluster::dec_err

Declination error of Cluster instance.

mem

std::vector<Galaxy*> Cluster::mem

Vector of Cluster member Galaxy instances.

ngal

int Cluster::ngal

Number of members in Cluster instance.

num

int Cluster::num

Number asscosiated to Cluster instance.

ra

double Cluster::ra

Right ascension of Cluster instance.

ra_err

double Cluster::ra_err

Right ascension error of Cluster instance.

size

double Cluster::size

Size of Cluster instance in specified units.

sn

double Cluster::sn

Signal-to-noise of Cluster instance.

z

double Cluster::z

Redshift of Cluster instance.

z_err

double Cluster::z_err

Redshift error of Cluster instance.

---

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

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