Ask a Question | Search PSRCHIVE: |
![]()
|
Classes |
Public Member Functions |
Static Public Member Functions |
Static Public Attributes |
List of all members
Integration Class Referenceabstract Array of Profiles integrated over the same time interval. More...
Inheritance diagram for Integration:
![]()
Detailed DescriptionArray of Profiles integrated over the same time interval. This class stores a two-dimensional array of pulse Profile instances as a function of polarization and frequency. Member Function Documentation◆ add_extension()
Add an Extension to the Integration instance. The derived class must ensure that only one instance of the Extension type is stored.
Derived classes need only define this method, as the non-const version implemented by the Integration base class simply calls this method. ◆ cal_levels()
Returns the mean hi/lo and variance of the mean hi/lo of every profile. Returns the mean (and variance of the mean) off the on and off pulse cal levels. ◆ combine()
Combine from into this. Users of this method should be aware that it does not keep full track of all the parameters of an Integration. It is designed to be used for low level arithmetic style addition only, not fully consistent combination. The supplied tscrunch routines should be used for such purposes. This method is provided for experimental purposes and should not be used lightly. If the time spans of the two combined subints are not contiguous, several parameters in the result are no longer meaningful. Also, there is no way of knowing whether the profiles are aligned in phase. Developers who use this operator should perform the necessary rotations at the archive level (where the polyco resides) before summing the data in the Integrations. Referenced by Pulsar::ColdPlasma< Calculator, History >::range(). ◆ copy()
Copy the profiles and attributes through set_ get_ methods. Copy the common information from another Integration ◆ dedisperse()
Remove dispersion delays with respect to centre frequency. Calls Dispersion::transform ◆ defaraday()
Remove Faraday rotation with respect to centre frequency. Calls FaradayRotation::transform ◆ find_max_phase()
Returns the centre phase of the region with maximum total intensity.
◆ find_min_phase()
Returns the centre phase of the region with minimum total intensity.
◆ find_peak_edges()
Find the bins in which the total intensity exceeds a threshold.
◆ find_transitions()
Find the transitions between high and low states in total intensity.
◆ fscrunch()
Integrate profiles from neighbouring chans.
◆ get() [1/2]
template<class T>
e.g. Integration* integration; MyExtension* ext = integration->get<MyExtension>(); ◆ get() [2/2]
template<class T>
e.g. const Integration* integration; const MyExtension* ext = integration->get<MyExtension>(); ◆ get_absolute_birefringence_corrected()
Absolute inter-channel birefringence has been removed. Auxiliary inter-channel birefringence has been removed. ◆ get_absolute_dispersion_corrected()
Absolute inter-channel dispersive delay has been removed. Auxiliary inter-channel dispersion delay has been removed. ◆ get_centre_frequency()
Get the Profile centre frequency attribute of the given channel. Get the centre frequency of the given channel.
◆ get_effective_dispersion_measure()
Get the effective dispersion measure that remains to be corrected. Returns the sum of get_relative_dispersion_measure and get_absolute_dispersion_measure. ◆ get_effective_rotation_measure()
Get the effective rotation measure that remains to be corrected. Returns the sum of get_relative_rotation_measure and get_absolute_rotation_measure. ◆ get_extension() [1/2]
Return a pointer to the specified extension. Simply calls get_extension const ◆ get_extension() [2/2]
Return a pointer to the specified extension. Derived classes need only define this method, as the non-const version implemented by the Integration base class simply calls this method. ◆ get_nbin()
Get the number of bins in each profile. This attribute may be set only through Integration::resize ◆ get_nchan()
Get the number of chans. This attribute may be set only through Integration::resize ◆ get_npol()
Get the number of polarization measurements. This attribute may be set only through Integration::resize ◆ get_Stokes() [1/2]
Returns a vector of Stokes parameters along the specified dimension. The vector of Stokes parameters may be calculated with either pulse phase or observing frequency as the abscissa.
By default, "get_Stokes (S, ichan);" will return the polarimetric profile from chan, ichan. To get the polarimetric spectra from the middle of the pulse profile, for example, call "get_Stokes (S, get_nbin()/2, Axis::Frequency);" ◆ get_Stokes() [2/2]
Return the Stokes 4-vector for the frequency channel and phase bin.
◆ get_weight()
Get the Profile weight attribute of the given channel. Get the weight of the given channel.
◆ getadd()
template<class T>
If the specified extension type T does not exist, an atempt is made to add it using add_extension. ◆ invint()
Transform from Stokes (I,Q,U,V) to the polarimetric invariant interval.
◆ mixable()
Test if integration may be combined with this. This function defines the set of observing and processing parameters that should be equal (within certain limits) before two Integrations may be combined using operators.
◆ new_PolnProfile()
Returns a pointer to a new PolnProfile containing references to Profiles. Returns a pointer to a new PolnProfile instance specified by ichan. ◆ new_Profile()
◆ remove_baseline()
Remove the baseline from all profiles. If baseline is not specified, this method calls Integration::baseline to find the baseline mask. This mask is then used to remove the baseline from each of the profiles over all polarizations and frequencies. If the dispersion measure and folding period have been previously set, the baseline phase is shifted according to the dispersion relation. ◆ resize()
Set the dimensions of the data container. If any current dimension is greater than that requested, the Profiles will be deleted and the dimension resized. If any current dimension is smaller than that requested, the dimension will be resized and new Profiles will be constructed. If any of the supplied paramaters is equal to zero, the dimension is left unchanged. ◆ reverse_chan()
Reverse the order of frequency channels. Reverse the order of frequency channels for each polarization. ◆ set_centre_frequency()
Set the Profile centre frequency attributes of the given channel. Set the centre frequency of the given channel.
◆ set_weight()
Set the Profile weight attributes of the given channel. Set the weight of the given channel.
◆ total()
Return an orphaned pscrunched dedispersed fscrunched clone of self. This method is primarily designed for use by the Integration::find_* methods. After calling fscrunch, the resulting Profile may have a different centre frequency than that of the Integration. Therefore, the Profile is dedispersed to match the phase referenced at the frequency returned by Integration::get_centre_frequency. ◆ weighted_frequency()
Computes the weighted centre frequency of an interval of sub-channels.
Member Data Documentation◆ match_max_frequency_difference
Maximum centre frequency difference in Integration::mixable. Maximum frequency difference in MHz The documentation for this class was generated from the following files:
Generated using doxygen 1.14.0
|