Particle Identification and Tracking: tracking::Dummy_corr Class Reference

Particle Identification and Tracking

A subclass of Corr that does nothing. More...

#include <corr.h>

Inheritance diagram for tracking::Dummy_corr:

Collaboration diagram for tracking::Dummy_corr:

Public Member Functions
void	compute (const particle , const std::vector< const particle > &)
	takes in a particle_base object. More...

void	out_to_wrapper (utilities::Generic_wrapper &, const std::string &) const

virtual float	get_max_range () const
	returns the maximum range that the Corr object looks out to. More...

void	out_to_wrapper (utilities::Generic_wrapper &, const std::string &, const utilities::Md_store *) const
	outputs the result of the computation to the wrapper More...

	~Dummy_corr ()

	Dummy_corr (float in)

void	add_plane_temperature (float temp)
	Adds the temperature for a plane. More...

Protected Attributes
float	temperature_sum_
	The sum of the temperatures added. More...

unsigned int	plane_count_
	Count of the number of planes added. More...

Private Attributes
float	size_

Detailed Description

A subclass of Corr that does nothing.

This is useful for testing

Constructor & Destructor Documentation

tracking::Dummy_corr::~Dummy_corr ( )

inline

tracking::Dummy_corr::Dummy_corr ( float in)

inline

Member Function Documentation

void Corr::add_plane_temperature ( float temp)

inherited

Adds the temperature for a plane.

References tracking::Corr::plane_count_, and tracking::Corr::temperature_sum_.

Referenced by tracking::Hash_shelf::compute_corr().

void tracking::Dummy_corr::compute	(	const particle *	,
		const std::vector< const particle * > &
	)

inlinevirtual

takes in a particle_base object.

For correlations that need the tracking information this should throw an error or something clever like that

Implements tracking::Corr.

virtual float tracking::Dummy_corr::get_max_range ( ) const

inlinevirtual

returns the maximum range that the Corr object looks out to.

This is needed so that the Hash_shelf can properly limit the particles that it hands in

Implements tracking::Corr.

References size_.

void tracking::Dummy_corr::out_to_wrapper	(	utilities::Generic_wrapper &	,
		const std::string &
	)		const

inline

void tracking::Dummy_corr::out_to_wrapper	(	utilities::Generic_wrapper &	,
		const std::string &	,
		const utilities::Md_store *
	)		const

inlinevirtual

outputs the result of the computation to the wrapper

Implements tracking::Corr.

Member Data Documentation

unsigned int tracking::Corr::plane_count_

protectedinherited

Count of the number of planes added.

Referenced by tracking::Corr::add_plane_temperature(), tracking::Corr_gofr::out_to_wrapper(), and tracking::Corr_theta_2pt::out_to_wrapper().

float tracking::Dummy_corr::size_

private

Referenced by get_max_range().

float tracking::Corr::temperature_sum_

protectedinherited

The sum of the temperatures added.

Referenced by tracking::Corr::add_plane_temperature(), tracking::Corr_gofr::out_to_wrapper(), and tracking::Corr_theta_2pt::out_to_wrapper().

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

common_src/include/corr.h