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

Public Member Functions

def __init__ (self, station_id)
 
def add_phase_delay_offsets (self, scan_name, delay_offsets, phase_offsets)
 
def apply_sigma_cut (self, sigma_cut_factor)
 
def export_json (self)
 
def get_all_delay_offset_values (self)
 
def get_all_phase_offset_values (self)
 
def get_delay_offset_error (self)
 
def get_delay_offset_mad (self)
 
def get_delay_offset_mean (self)
 
def get_delay_offset_median (self)
 
def get_n_cut_entries (self)
 
def get_n_total_entries (self)
 
def get_n_used_entries (self)
 
def get_phase_offset_error (self)
 
def get_phase_offset_mean (self)
 
def use_data_point (self, data_point)
 
- Public Member Functions inherited from vpal.report_lib.JsonSerializableObject
def import_json (self, json_dict)
 

Public Attributes

 pc_delay_offsets
 
 pc_phase_offsets
 
 station_id
 
 used_scans
 

Detailed Description

container object for the y-x phase/delay offsets of a particular station

Constructor & Destructor Documentation

◆ __init__()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.__init__ (   self,
  station_id 
)

Member Function Documentation

◆ add_phase_delay_offsets()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.add_phase_delay_offsets (   self,
  scan_name,
  delay_offsets,
  phase_offsets 
)
add the phase/delay offsets derived from a particular scan

◆ apply_sigma_cut()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.apply_sigma_cut (   self,
  sigma_cut_factor 
)
remove data points which are more then sigma_cut_factor*sigma away from the mean value 

◆ export_json()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.export_json (   self)
export this object as a dict for json export

Reimplemented from vpal.report_lib.JsonSerializableObject.

◆ get_all_delay_offset_values()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_all_delay_offset_values (   self)

◆ get_all_phase_offset_values()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_all_phase_offset_values (   self)

◆ get_delay_offset_error()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_delay_offset_error (   self)

◆ get_delay_offset_mad()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_delay_offset_mad (   self)

◆ get_delay_offset_mean()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_delay_offset_mean (   self)

◆ get_delay_offset_median()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_delay_offset_median (   self)

◆ get_n_cut_entries()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_n_cut_entries (   self)

◆ get_n_total_entries()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_n_total_entries (   self)

◆ get_n_used_entries()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_n_used_entries (   self)

◆ get_phase_offset_error()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_phase_offset_error (   self)

◆ get_phase_offset_mean()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.get_phase_offset_mean (   self)

◆ use_data_point()

def vpal.fourphase_lib.SingleStationPhaseDelayOffsets.use_data_point (   self,
  data_point 
)
 quick check to see if this data point is use-able after cuts are applied 

Member Data Documentation

◆ pc_delay_offsets

vpal.fourphase_lib.SingleStationPhaseDelayOffsets.pc_delay_offsets

◆ pc_phase_offsets

vpal.fourphase_lib.SingleStationPhaseDelayOffsets.pc_phase_offsets

◆ station_id

vpal.fourphase_lib.SingleStationPhaseDelayOffsets.station_id

◆ used_scans

vpal.fourphase_lib.SingleStationPhaseDelayOffsets.used_scans

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