Computes the distribution made by the angles between pairs of particles to vertical for pairs in the given separation range. More...
#include <corr_theta_2pt.h>
Inheritance diagram for tracking::Corr_theta_2pt:
Collaboration diagram for tracking::Corr_theta_2pt:
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 utilities::Md_store *) const |
| outputs the result of the computation to the wrapper More... | |
| float | get_max_range () const |
| returns the maximum range that the Corr object looks out to. More... | |
| Corr_theta_2pt (int t_bins, float min_r, float max_r) | |
| constructor. More... | |
| 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 | |
| utilities::Histogram | theta_ |
| A vector of histograms for. More... | |
| float | min_r_range2_ |
| minimum r range More... | |
| float | max_r_range2_ |
| maximum r range More... | |
Detailed Description
Computes the distribution made by the angles between pairs of particles to vertical for pairs in the given separation range.
Constructor & Destructor Documentation
| Corr_theta_2pt::Corr_theta_2pt | ( | int | t_bins, |
| float | min_r, | ||
| float | max_r | ||
| ) |
constructor.
- Parameters
-
[in] t_bins the number of theta bins [in] max_r the maximum displacement to be included [in] min_r the minimum displacement to be included
Member Function Documentation
|
inherited |
Adds the temperature for a plane.
References tracking::Corr::plane_count_, and tracking::Corr::temperature_sum_.
Referenced by tracking::Hash_shelf::compute_corr().
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.
References utilities::Histogram::add_data_point(), tracking::particle_base::get_disp(), utilities::Tuple< T, length >::magnitude_sqr(), min_r_range2_, and theta_.
|
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
Implements tracking::Corr.
References max_r_range2_.
|
virtual |
outputs the result of the computation to the wrapper
Implements tracking::Corr.
References utilities::Generic_wrapper::add_meta_data(), utilities::Generic_wrapper::close_group(), utilities::Generic_wrapper::close_wrapper(), utilities::Generic_wrapper::is_open(), max_r_range2_, min_r_range2_, utilities::Generic_wrapper::open_group(), utilities::Generic_wrapper::open_wrapper(), utilities::Histogram::output_to_wrapper(), tracking::Corr::plane_count_, tracking::Corr::temperature_sum_, and theta_.
Member Data Documentation
|
private |
maximum r range
Referenced by get_max_range(), and out_to_wrapper().
|
private |
minimum r range
Referenced by compute(), and out_to_wrapper().
|
protectedinherited |
Count of the number of planes added.
Referenced by tracking::Corr::add_plane_temperature(), tracking::Corr_gofr::out_to_wrapper(), and out_to_wrapper().
|
protectedinherited |
The sum of the temperatures added.
Referenced by tracking::Corr::add_plane_temperature(), tracking::Corr_gofr::out_to_wrapper(), and out_to_wrapper().
|
private |
A vector of histograms for.
Referenced by compute(), and out_to_wrapper().
The documentation for this class was generated from the following files:
- common_src/include/corr_theta_2pt.h
- common_src/cxx/corr_theta_2pt.cpp
