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

Public Member Functions

def __init__ (self)
 
def __eq__ (self, other)
 
def __hash__ (self)
 
def add_fringe_object (self, obj)
 
def export_json (self)
 
def get_dtec_list (self)
 
def get_dtec_max_deviation (self)
 
def get_dtec_mean (self)
 
def get_dtec_stddev (self)
 
def get_fringe_object (self, polprod)
 
def get_max_snr (self)
 
def get_mean_snr (self)
 
def get_min_snr (self)
 
def get_phase_residuals (self, pol_product)
 
def get_snr_list (self)
 
def init_values (self)
 
def is_complete (self)
 
def polarization_product_is_required (self, pp_check)
 
- Public Member Functions inherited from vpal.report_lib.JsonSerializableObject
def import_json (self, json_dict)
 

Public Attributes

 associated_root_file
 
 baseline
 
 cached_required_polprod_list
 
 control_file_hash
 
 control_filename
 
 dtec_mdev
 
 dtec_mean
 
 dtec_stddev
 
 fringe_objects
 
 max_snr
 
 mean_snr
 
 min_snr
 
 required_polprod_list
 
 root_id
 
 scan_name
 

Detailed Description

 container class to store the fringe data associated with each polarization product for a particular scan/baseline 

Constructor & Destructor Documentation

◆ __init__()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.__init__ (   self)

Member Function Documentation

◆ __eq__()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.__eq__ (   self,
  other 
)

◆ __hash__()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.__hash__ (   self)

◆ add_fringe_object()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.add_fringe_object (   self,
  obj 
)
add a finge file object that should be associated with this collection 

◆ export_json()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.export_json (   self)
 dump this object to a dictionary for inspection 

Reimplemented from vpal.report_lib.JsonSerializableObject.

◆ get_dtec_list()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.get_dtec_list (   self)
 get the baseline dTEC associated with fringe of each polarization product 

◆ get_dtec_max_deviation()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.get_dtec_max_deviation (   self)
 get the larged difference between a dTEC value and the mean 

◆ get_dtec_mean()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.get_dtec_mean (   self)
 get the mean dTEC value 

◆ get_dtec_stddev()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.get_dtec_stddev (   self)
 get the std. dev. of the dTEC values 

◆ get_fringe_object()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.get_fringe_object (   self,
  polprod 
)
return the fringe data associated with a particular polarization product

◆ get_max_snr()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.get_max_snr (   self)

◆ get_mean_snr()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.get_mean_snr (   self)

◆ get_min_snr()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.get_min_snr (   self)

◆ get_phase_residuals()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.get_phase_residuals (   self,
  pol_product 
)
 get the channel-by-channel phase residual associated with the fringe-fit of each polarization product 

◆ get_snr_list()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.get_snr_list (   self)
 get the SNRs of each polarization product fringe 

◆ init_values()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.init_values (   self)
 compute any internal data members after pol prod fringes are set 

◆ is_complete()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.is_complete (   self)
determine if we have all of the available polarization products 

◆ polarization_product_is_required()

def vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.polarization_product_is_required (   self,
  pp_check 
)
 indicate if a polarization producted is needed to make this a complete collection 

Member Data Documentation

◆ associated_root_file

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.associated_root_file

◆ baseline

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.baseline

◆ cached_required_polprod_list

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.cached_required_polprod_list

◆ control_file_hash

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.control_file_hash

◆ control_filename

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.control_filename

◆ dtec_mdev

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.dtec_mdev

◆ dtec_mean

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.dtec_mean

◆ dtec_stddev

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.dtec_stddev

◆ fringe_objects

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.fringe_objects

◆ max_snr

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.max_snr

◆ mean_snr

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.mean_snr

◆ min_snr

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.min_snr

◆ required_polprod_list

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.required_polprod_list

◆ root_id

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.root_id

◆ scan_name

vpal.fringe_file_manipulation.SingleBaselinePolarizationProductCollection.scan_name

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