Galaxy Class Reference

Class for storing galaxy properties. More...

#include <galaxy_class.hpp>

Public Member Functions
	Galaxy (int num_val, unsigned long id_val, double ra_val, double dec_val, double z_val)
	Initialise Galaxy instance. More...
	Galaxy (int num_val, unsigned long id_val, double ra_val, double dec_val, double z_val, double z_err_val)
	Initialise Galaxy instance. More...
void	assign_dist (double, double, double, double)
	This method calculates the angular diameter distance of a Galaxy instance for a given cosmology. More...
void	assign_bin (double, double)
	This method assigns the Zbin instance corresponding to the Galaxy instance. More...
void	assign_bins (double, double, double)
	This method assigns the Zbin instances corresponding to the Galaxy instance. More...
void	set_cluster_status (int)
	This method sets the initial Cluster instance membership of the Galaxy instance to False. More...

Public Attributes
UnionFind	uf
	Class structure for galaxy properties. More...
int	num
	Number associated to Galaxy instance. More...
int	bin
	Zbin instance corresponding to Galaxy instance. More...
std::vector< int >	bins
Point	P
	coordinates of the Galaxy instance: the entries corresponds to Right ascension and Declination respectively More...
double	z
	Redshift of Galaxy instance. More...
double	z_err
	Photometric redshift error of Galaxy instance. More...
double	da
	Angular diameter distance of Galaxy instance. More...
double	v
	Velocity of Galaxy instance. More...
unsigned long	id
	ID of Galaxy instance. More...
std::vector< bool >	in_cluster
	Vector of flags indicating if the Galaxy instance is a member of a Cluster instance for a given Zbin instance. More...

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

Friends
bool	operator== (const Galaxy &gal1, const Galaxy &gal2)
	Bool == operator for Galaxy class. More...
bool	operator< (const Galaxy &gal1, const Galaxy &gal2)
	Bool < operator for Galaxy class. More...

Detailed Description

Class for storing galaxy properties.

This class calculates and stores Galaxy properties.

Constructor & Destructor Documentation

Galaxy() [1/2]

Galaxy::Galaxy	(	int	num_val,
		unsigned long	id_val,
		double	ra_val,
		double	dec_val,
		double	z_val
	)

Initialise Galaxy instance.

[FoF mode: "spec"]

Parameters

[in]	num_val	Integer value.
[in]	id_val	Galaxy ID.
[in]	ra_val	Galaxy right ascension.
[in]	dec_val	Galaxy declination.
[in]	z_val	Galaxy spectroscopic redshift.

Galaxy() [2/2]

Galaxy::Galaxy	(	int	num_val,
		unsigned long	id_val,
		double	ra_val,
		double	dec_val,
		double	z_val,
		double	z_err_val
	)

Initialise Galaxy instance.

[FoF mode: "phot"]

Parameters

[in]	num_val	Integer value.
[in]	id_val	Galaxy ID.
[in]	ra_val	Galaxy right ascension.
[in]	dec_val	Galaxy declination.
[in]	z_val	Galaxy photometric redshift.
[in]	z_err_val	Galaxy photometric redshift error.

Member Function Documentation

assign_bin()

void Galaxy::assign_bin	(	double	min_value,
		double	bin_size
	)

This method assigns the Zbin instance corresponding to the Galaxy instance.

Parameters

[in]	min_value	Minimum value in redshift range.
[in]	bin_size	Redshift bin size.

assign_bins()

void Galaxy::assign_bins	(	double	min_value,
		double	bin_size,
		double	delta_z
	)

This method assigns the Zbin instances corresponding to the Galaxy instance.

Parameters

[in]	min_value	Minimum value in redshift range.
[in]	bin_size	Redshift bin size.
[in]	delta_z	Bin width.

assign_dist()

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

This method calculates the angular diameter distance of a Galaxy 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.

set_cluster_status()

void Galaxy::set_cluster_status

(

int

nbins

)

This method sets the initial Cluster instance membership of the Galaxy instance to False.

Parameters

[in]

nbins

Number of redshift bins.

Friends And Related Function Documentation

operator<

bool operator< ( const Galaxy &  gal1, const Galaxy &  gal2  )

friend

Bool < operator for Galaxy class.

Compares the ID between two Cluster instances.

operator==

bool operator== ( const Galaxy &  gal1, const Galaxy &  gal2  )

friend

Bool == operator for Galaxy class.

Compares the ID between two Cluster instances.

Member Data Documentation

astro

Astro Galaxy::astro

private

Include Astro class.

bin

int Galaxy::bin

Zbin instance corresponding to Galaxy instance.

bins

std::vector<int> Galaxy::bins

cosmo

Cosmo Galaxy::cosmo

private

Include Cosmo class.

da

double Galaxy::da

Angular diameter distance of Galaxy instance.

id

unsigned long Galaxy::id

ID of Galaxy instance.

in_cluster

std::vector<bool> Galaxy::in_cluster

Vector of flags indicating if the Galaxy instance is a member of a Cluster instance for a given Zbin instance.

num

int Galaxy::num

Number associated to Galaxy instance.

P

Point Galaxy::P

coordinates of the Galaxy instance: the entries corresponds to Right ascension and Declination respectively

uf

UnionFind Galaxy::uf

Class structure for galaxy properties.

Include UnionFind class.

v

double Galaxy::v

Velocity of Galaxy instance.

z

double Galaxy::z

Redshift of Galaxy instance.

z_err

double Galaxy::z_err

Photometric redshift error of Galaxy instance.

---

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

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