rss_ringoccs.calibration.dlp_class module

Purpose:

Create a class whose attributes have all the necessary inputs for performing a Fresnel inversion usng DiffractionCorrection, given instances of the classes RSRReader, Geometry, and Calibration.
Dependencies:
  1. numpy
  2. copy
  3. scipy
class rss_ringoccs.calibration.dlp_class.DiffractionLimitedProfile(rsr_inst, geo_inst, cal_inst, dr_km, verbose=False, write_file=True, profile_range=[65000.0, 150000.0])

Bases: object

Purpose:Framework for an object class containing the diffraction-limited optical depth profile (DLP) and related attributes.
Arguments
rsr_inst (object):
 Instance of RSRReader class
geo_inst (object):
 Instance of Geometry class
cal_inst (object):
 Instance of Calibration class
dr_km (float):radial sampling rate \Delta\rho for the DLP in kilometers. DLP radial resolution is the Nyquist radial sampling, i.e., twice the input value of dr_km, meaning that this will affect the minimum resolution of the diffraction-reconstructed profile. Value for dr_km can range from 0.05 km to 0.75 km for the reconstruction resolutions supported by rss_ringoccs. PDS sampling rate is 0.25 km, which gives a DLP resolution of 0.5 km.
Keyword Arguments
verbose (bool):When True, turns on verbose output. Default is False.
write_file (bool):
 When True, writes processing results to file. Default is True.
profile_range (list):
 1x2 list specifying the radial limits in km of on the occultation. Default is [65000,150000].
Attributes
dr_km (float):raw DLP sampling rate
raw_tau_threshold_vals (np.ndarray):
 threshold optical depth
rho_km_vals (np.ndarray):
 Ring-intercept points in km
t_oet_spm_vals (np.ndarray):
 Observed event times in seconds past midnight
p_norm_vals (np.ndarray):
 Normalized diffraction-limited power
phase_rad_vals (np.ndarray):
 Phase of diffraction-limited signal, in radians
B_rad_vals (np.ndarray):
 Ring opening angle in radians
D_km_vals (np.ndarray):
 Ring intercept point to spacecraft distance in km
F_km_vals (np.ndarray):
 Fresnel scale in km
f_sky_hz_vals (np.ndarray):
 Sky frequency in Hz
phi_rad_vals (np.ndarray):
 Observed ring azimuth
t_ret_spm_vals (np.ndarray):
 Ring event time in seconds past midnight
t_set_spm_vals (np.ndarray):
 Spacecraft event time in seconds past midnight
phi_rl_rad_vals (np.ndarray):
 Ring longitude in radians
rho_dot_kms_vals (np.ndarray):
 Ring intercept radial velocity in km/s
rho_corr_pole_km_vals (np.ndarray):
 Radius correction due to improved pole. This is populated with a placeholder of zeros
rho_corr_timing_km_vals (np.ndarray):
 Radius correction due to timing offset. This is populated with a placeholder of zeros
tau_vals (np.ndarray):
 Diffraction-limited optical depth
history (dict):Processing history with all inputs necessary to rerun pipeline to obtain identical output
rev_info (dict):
 dict containing rev- and rsr-specific info
Note:
  1. All np.ndarray attributes are sampled at dr_km radial spacing.
classmethod create_dlps(rsr_inst, geo_inst, cal_inst, dr_km, verbose=False, write_file=False, profile_range=[65000.0, 150000.0])

Create ingress and egress instances of DiffractionLimitedProfile.

Arguments
rsr_inst (object):
 Instance of RSRReader class
geo_inst (object):
 Instance of Geometry class
cal_inst (object):
 Instance of Calibration class
dr_km (float):radial sampling rate \Delta\rho for the DLP in kilometers. DLP radial resolution is the Nyquist radial sampling, i.e., twice the input value of dr_km, meaning that this will affect the minimum resolution of the diffraction-reconstructed profile. Value for dr_km can range from 0.05 km to 0.75 km for the reconstruction resolutions supported by rss_ringoccs. PDS sampling rate is 0.25 km, which gives a DLP resolution of 0.5 km.
Keyword Arguments
verbose (bool):When True, turns on verbose output. Default is False.
write_file (bool):
 When True, writes processing results to file. Default is True.
profile_range (list):
 1x2 list specifying the radial limits in km of on the occultation. Default is [65000,150000].