C++ API Documentation

• IO Management
  • file_writer
    • write_testrun()
    • write_payload_to_file()
    • write_runtime_to_file()
    • convert_vector_to_json()
    • convert_matrix_to_json()
    • convert_relative_path()
  • payload
    • payload()
    • payload()
    • add_flux()
    • assign_rot_phases()
    • freqs
    • dataframe
    • rot_phases
    • desc
    • payload::description
      • Pulsar
      • NBRFI
      • BBRFI
  • runtime
    • num_sparks
    • conal_latitudes
    • spark_rotation_axis_polar_att0
    • drift_vel
    • spark_dimension
    • spark_mid_freqs
    • spark_flux_powers
    • direction
    • dm_homogeneous
    • scintillation_index_homogeneous
    • std_dm
    • std_scintillation_index
  • aggregated_payload
    • LOAD_STATE
      • RAW
      • TO_BE_PROPAGATED
      • DETECTED
      • FLUX
    • aggregated_payload()
    • add()
    • tag
    • haul
    • runtime_params
• Pulsar Simulation
  • antenna
    • antenna()
    • calculate_antenna_output_voltage_matrix()
    • gen_noise_NBRFI()
    • gen_noise_BBRFI()
    • antenna_temperature()
    • gen_terresterial_noise()
    • randomize_antenna_output()
    • is_pulsar_present()
    • nbrfi_count
    • bbrfi_count
    • pulsar_count
    • freq_channels
    • rot_phases
    • dataframe
    • sensitivity
    • prob_nbrfi
    • prob_bbrfi
  • data_generator
    • data_generator()
    • generate_data_spark_pattern()
    • generate_random_spark_pattern()
    • generate_payload_at_acquisition_frequency()
    • generate_random_ism_obj()
    • randomize_existing_spark_pattern()
    • animator
    • freq_channels
  • interstellar_medium
    • interstellar_medium()
    • calc_disperse_phase_shift()
    • randomize_props()
    • propagate_through()
    • std_dm
    • std_scintillation_index
    • scintillation_index_homogeneous
    • dm_homogeneous
  • pulsar_animator
    • pulsar_animator()
    • add_spark()
    • operator()()
    • update_pulsar_state_vectors()
    • generate_radio_packet()
    • generate_radio_packet_stream()
    • __rot_axis
    • __mag_axis_tilt
    • mag_frame_basis_att0
    • rot_frame_basis
    • mag_frame_basis
    • spark_genlist
    • spark_spectrum_model_list
    • find_perpendicular_basis_vectors()
    • calculate_radio_packet_at_direction()
    • rotate_reference_frame()
  • spark_pattern_generator
    • create_patterned_spark_pattern()
    • spark_pattern_generator::spark
      • spark()
      • get_spark_dimension()
      • get_spark_center()
      • set_spark_center()
      • get_spark_rotation_axis_polar_att0()
      • set_spark_rotation_axis_polar_att0()
      • get_drift_vel()
      • set_drift_vel()
      • get_mid_frequency()
      • get_flux_power()
      • get_id()
      • apply_physics_model()
      • calculate_spark_center_att()
      • calculate_magframe_basis_att()
      • SPARK_RADIUS_THRESH_FACTOR
      • spark_id
      • spark_cone_id
      • _spark_dimension
      • _spark_center
      • _spark_rotation_axis_polar_att0
      • _drift_vel
      • _drift_phase
      • _mid_freq
      • _flux_power
      • ortho_vector_parametric()
      • find_perpendicular_basis_vectors()
    • spark_pattern_generator::spark_spectral_model
      • spark_spectral_model()
      • operator()()
      • model
      • spectral_index
      • b
      • curvature_parameter
• Python Extension Modules
  • generate_single()
  • PYBIND11_MODULE()
  • PYBIND11_MODULE()
  • update_pulsar_state_vectors()
  • PYBIND11_MODULE()
  • randomize_antenna_output()
  • PYBIND11_MODULE()
• Util
  • calculation
    • matrix_mult()
    • scalar_vector_mult()
    • dot_product_parray()
    • cross_product()
    • vector_magnitude()
    • convolve()
    • arange()
    • uniform_real_distribution()
    • normal_distribution()
    • normal_distribution()
    • random_vector()
    • normalize_vector()
    • interp_func()
    • interp()
    • transpose()
  • std
  • quaternion
    • quaternion()
    • rotate()
    • get_vector()
    • get_q()
    • q
  • reference_frame_operation
    • transform2spherical()
    • transform2cartesian()
    • polar2cart()
    • rotate_reference_frame()
    • reference_frame_operation::rot_frame_basis_vectors
      • new_rot_frame_basis
      • rot_frame_basis
      • rot_frame_quaternion
    • reference_frame_operation::mag_pole_rot_frame
      • mag_pol_position_rot_frame_cartesian
      • mag_pol_position_celestial_frame_cartesian
      • mag_pol_position_rot_frame_spherical
      • mag_pol_position_celestial_frame_spherical
      • mag_frame_basis_vectors
    • reference_frame_operation::earth_pos_in_pulsar_frame
      • earth_rot_frame
      • vector_to_earth_dir
      • earth_rot_frame_spherical
      • vector_to_earth_dir_spherical
  • tuple_vec
    • tuple_vec()
    • a
    • b
  • params
    • rot_phases
    • pulsar_celestial_coors
    • pulsar_rotation_axis
    • mag_axis_tilt
    • conal_azimuths
    • conal_declinations
    • rad_conal
    • rad_core
    • scintillation_index_homo
    • freq_list
    • dm_homogeneous
    • pulsar_period
    • T_S
    • bandwidth
    • acquisition_time
    • time_of_occurrence_BBRFI
    • channels_effected_rangeBBRFI
    • spread_in_phaseBBRFI
    • amplitudeBBRFI
    • probability_of_occurrence_BBRFI
    • center_channel_indexNBRFI
    • spread_in_channelsNBRFI
    • amplitudeNBRFI
    • probability_of_occurrence_NBRFI