psrchive.h
1 //-*-C++-*-
2 
3 /***************************************************************************
4  *
5  * Copyright (C) 2002, 2006 by Willem van Straten
6  * Licensed under the Academic Free License version 2.1
7  *
8  ***************************************************************************/
9 
10 // psrchive/Base/Classes/Pulsar/psrchive.h
11 
12 #ifndef __Pulsar_psrchive_h
13 #define __Pulsar_psrchive_h
14 
121 #define PSRCHIVE_HTTP "http://psrchive.sourceforge.net"
122 
123 #endif
Application with basic command line options.
Definition: Application.h:30
Stokes< float > get_Stokes(unsigned ibin) const
Get the Stokes 4-vector for the specified bin.
Definition: PolnProfile.C:246
void get_orientation(std::vector< Estimate< double > > &, float sigma) const
Return the orientation and its estimated error for each pulse phase.
Definition: PolnProfile.C:889
void transform(Archive *)
The frequency integration operation.
Definition: TimeIntegrate.C:31
void offset(double offset)
offsets each bin of the profile by offset
Definition: Profile.C:301
void diff(const Profile *profile)
subtract profile from this
Definition: Profile.C:341
void get_polarized(Profile *polarized) const
Return the total polarization profile.
Definition: PolnProfile.C:725
const float * get_amps() const
Return a pointer to the amplitudes array.
Definition: ProfileAmps.C:141
Fills missing frequency channels with empties.
Definition: PatchFrequency.h:26
Estimate< double > shift(const Profile &std) const
Returns the shift (in turns) between profile and standard.
Definition: Profile_shift.C:20
const Integration * get_Integration(const Archive *data, Index subint)
Return the requested profile, cloning and integrating when needed.
Definition: Index.C:118
virtual unsigned get_nsubint() const =0
Get the number of sub-integrations stored in the file.
Algorithms that combine Integration data.
Definition: FrequencyAppend.h:28
const ScalarMath sin(const ScalarMath &x)
void set_contemporaneity_policy(Contemporaneity *)
Set the policy used to judge contemporaneity.
Definition: PatchTime.C:26
Any quantity recorded as a function of pulse phase.
Definition: Profile.h:45
The primary interface to pulsar observational data.
Definition: Archive.h:45
Definition: PhaseResolvedHistogram.h:24
Fills missing sub-integrations with empties.
Definition: PatchTime.h:26
const ScalarMath sqrt(const ScalarMath &x)
Type * get() const
const ScalarMath abs(const ScalarMath &x)
static Archive * new_Archive(const std::string &class_name)
Factory returns a null-constructed instance of the named class.
Definition: Archive.C:104
virtual unsigned get_nchan() const =0
Get the number of frequency channels used.
void shift(unsigned npts, float *arr, double shift)
unsigned get_nbin() const
Get the number of bins.
Definition: PolnProfile.C:139
Integration * get_Integration(unsigned subint)
Return pointer to the specified Integration.
Definition: IntegrationManager.C:41
Definition: MoreProfiles.h:24
Evaluates the contemporaneity of Integrations from two Archives.
Definition: Contemporaneity.h:28
static size_t get_instance_count()
Array of Profiles integrated over the same time interval.
Definition: Integration.h:37
Standard interpreter command line options.
Definition: StandardOptions.h:26
Cross-covariances between the Stokes parameters.
Definition: StokesCrossCovariance.h:31
void get_ellipticity(std::vector< Estimate< double > > &, float sigma) const
Return the ellipticity and its estimated error for each pulse phase.
Definition: PolnProfile.C:759
Polarimetric pulse profile transformations and derivations.
Definition: PolnProfile.h:34
virtual void add(Item *)
T get_value() const
Definition: Contemporaneity.h:56
Computes fourth-order moment pulse profile statistics.
Definition: FourthMomentStats.h:28
const Type * ptr() const
bool in_frequency_order(const Archive *A, const Archive *B)
Return true if A precedes B in frequency order of channels.
Definition: Archive.C:364
virtual Archive * load(const std::string &filename)
Load file.
Definition: Application.C:151
Integrates sub-integrations in an Archive.
Definition: TimeIntegrate.h:45
virtual Archive * clone() const =0
Return a new copy constructed instance equal to this.
const std::string get_message() const
Defines the PSRCHIVE library.
Definition: CalSource.h:17
void get_linear(Profile *linear) const
Return the linear polarization profile.
Definition: PolnProfile.C:733
unsigned get_nbin() const
Return the number of phase bins.
Definition: MoreProfiles.C:70
void set_range(double min, double max)
Set the minimum and maximum values spanned by the histogram.
Definition: PhaseResolvedHistogram.C:32
Unload interpreter command line options.
Definition: UnloadOptions.h:26
virtual void set_range_policy(RangePolicy *rp)
Set the range division policy.
Definition: Integrate.h:57
Definition: FourthMoments.h:24
virtual Profile * get_Profile(unsigned i)
get the ith Profile
Definition: MoreProfiles.C:57
Matrix< 4, 4, double > get_cross_covariance(unsigned ibin, unsigned jbin, unsigned ilag=0) const
Get the Stokes cross covariance for the specified pair of bins.
Definition: StokesCrossCovariance.C:309
Algorithms that combine Integration data.
Definition: TimeAppend.h:24
virtual unsigned get_size() const
get the size of the profile vector
Definition: MoreProfiles.C:44

Generated using doxygen 1.8.17