HOPS
HOPS class reference
Public Member Functions | Public Attributes | List of all members
vpal.ffres2pcp_lib.SingleStationPCPhases Class Reference
Inheritance diagram for vpal.ffres2pcp_lib.SingleStationPCPhases:
[legend]

Public Member Functions

def __init__ (self, station_id, pol)
 
def add_pc_phases (self, scan_name, baseline, pol, pc_phases_dict)
 
def apply_sigma_cut (self, sigma_cut_factor)
 
def compute_mean_phases (self)
 
def export_json (self)
 
def get_channel_n_datapoints (self)
 
def get_mean_phases (self)
 
def get_stddev_phases (self)
 
def is_empty (self)
 
def merge (self, obj)
 
- Public Member Functions inherited from vpal.report_lib.JsonSerializableObject
def import_json (self, json_dict)
 

Public Attributes

 mean_pc_phases
 
 pc_phases
 
 pol
 
 scan_baselines_used
 
 station_id
 
 stddev_pc_phases
 

Detailed Description

container class for the pc_phases (corrections) of a single polarization of a single station
the values stored in this class must be corrected for the baseline order of the involved stations,
such that this station is treated as if it were always a remote station
the value of scan_baselines_used, keeps track of which scans and baselines were used when
computing the average values of the pc_phases 

Constructor & Destructor Documentation

◆ __init__()

def vpal.ffres2pcp_lib.SingleStationPCPhases.__init__ (   self,
  station_id,
  pol 
)

Member Function Documentation

◆ add_pc_phases()

def vpal.ffres2pcp_lib.SingleStationPCPhases.add_pc_phases (   self,
  scan_name,
  baseline,
  pol,
  pc_phases_dict 
)
 add a set of phases derived from a scan/baseline to the collection 

◆ apply_sigma_cut()

def vpal.ffres2pcp_lib.SingleStationPCPhases.apply_sigma_cut (   self,
  sigma_cut_factor 
)
 we expect each channel to have a mean phase and standard deviation (sigma)
this function eliminates outliers by iterating over each channel
and removing all data points which lie beyond the range of sigma_cut_factor*sigma from the channel mean 

◆ compute_mean_phases()

def vpal.ffres2pcp_lib.SingleStationPCPhases.compute_mean_phases (   self)
 compute the mean phases of each channel 

◆ export_json()

def vpal.ffres2pcp_lib.SingleStationPCPhases.export_json (   self)
 create a dict to be used as json output 

Reimplemented from vpal.report_lib.JsonSerializableObject.

◆ get_channel_n_datapoints()

def vpal.ffres2pcp_lib.SingleStationPCPhases.get_channel_n_datapoints (   self)
 get number of data points associated with each channel 

◆ get_mean_phases()

def vpal.ffres2pcp_lib.SingleStationPCPhases.get_mean_phases (   self)
 get mean phases of each channel 

◆ get_stddev_phases()

def vpal.ffres2pcp_lib.SingleStationPCPhases.get_stddev_phases (   self)
 get the std. dev. of the phases of each channel 

◆ is_empty()

def vpal.ffres2pcp_lib.SingleStationPCPhases.is_empty (   self)
determine if this object has any pc phases data or not 

◆ merge()

def vpal.ffres2pcp_lib.SingleStationPCPhases.merge (   self,
  obj 
)
 merge in the data from another object of the same time (assuming it matches the station and pol) 

Member Data Documentation

◆ mean_pc_phases

vpal.ffres2pcp_lib.SingleStationPCPhases.mean_pc_phases

◆ pc_phases

vpal.ffres2pcp_lib.SingleStationPCPhases.pc_phases

◆ pol

vpal.ffres2pcp_lib.SingleStationPCPhases.pol

◆ scan_baselines_used

vpal.ffres2pcp_lib.SingleStationPCPhases.scan_baselines_used

◆ station_id

vpal.ffres2pcp_lib.SingleStationPCPhases.station_id

◆ stddev_pc_phases

vpal.ffres2pcp_lib.SingleStationPCPhases.stddev_pc_phases

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