A mostly ABC of objects that can be handed into hash_case and calculates correlation functions. More...
#include <corr.h>
Inheritance diagram for tracking::Corr:
Collaboration diagram for tracking::Corr:
Public Member Functions | |
| virtual void | compute (const particle *, const std::vector< const particle * > &)=0 |
| takes in a particle_base object. More... | |
| virtual void | out_to_wrapper (utilities::Generic_wrapper &, const std::string &, const utilities::Md_store *) const =0 |
| outputs the result of the computation to the wrapper More... | |
| virtual float | get_max_range () const =0 |
| returns the maximum range that the Corr object looks out to. More... | |
| void | add_plane_temperature (float temp) |
| Adds the temperature for a plane. More... | |
| virtual | ~Corr () |
| Destructor. More... | |
Protected Member Functions | |
| Corr () | |
Protected Attributes | |
| float | temperature_sum_ |
| The sum of the temperatures added. More... | |
| unsigned int | plane_count_ |
| Count of the number of planes added. More... | |
Detailed Description
A mostly ABC of objects that can be handed into hash_case and calculates correlation functions.
This class deals with temperature meta-data
Constructor & Destructor Documentation
|
inlinevirtual |
Destructor.
|
protected |
Member Function Documentation
| void Corr::add_plane_temperature | ( | float | temp) |
Adds the temperature for a plane.
References plane_count_, and temperature_sum_.
Referenced by tracking::Hash_shelf::compute_corr().
|
pure virtual |
takes in a particle_base object.
For correlations that need the tracking information this should throw an error or something clever like that
Implemented in tracking::Dummy_corr, tracking::Corr_pair_diffusion, tracking::Corr_theta_2pt, tracking::Corr_gofr, and tracking::Corr_goftheta.
Referenced by tracking::hash_box::compute_corr().
|
pure virtual |
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
Implemented in tracking::Dummy_corr, tracking::Corr_pair_diffusion, tracking::Corr_gofr, tracking::Corr_goftheta, and tracking::Corr_theta_2pt.
Referenced by tracking::hash_box::compute_corr(), and tracking::Hash_shelf::compute_corr().
|
pure virtual |
outputs the result of the computation to the wrapper
Implemented in tracking::Dummy_corr, tracking::Corr_pair_diffusion, tracking::Corr_theta_2pt, and tracking::Corr_gofr.
Member Data Documentation
|
protected |
Count of the number of planes added.
Referenced by add_plane_temperature(), tracking::Corr_gofr::out_to_wrapper(), and tracking::Corr_theta_2pt::out_to_wrapper().
|
protected |
The sum of the temperatures added.
Referenced by 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 files:
