ARTOF documentation

Welcome to artof’s documentation. The artof package is a tool to read, process and analyze data collected from angle resolved time of flight (ARTOF) sensors.

Contents:

• Getting Started
  • Installation
  • Example
• ARTOFLoader
  • ARTOFLoader
• PumpProbeLoader
  • PumpProbeLoader
• artof_utils
  • edges_to_values()
  • format_value()
  • get_axes_permutations()
  • get_datetime_string()
  • get_incident_energy()
  • get_incident_energy_for_binding()
  • get_next_step()
  • get_previous_step()
  • is_last_step()
  • load_data_from_csv()
  • next_file_exists()
  • previous_file_exists()
  • print_progress()
  • values_to_edges()
• base_loader
  • BaseLoader
  • TransformFormat
• normalize
  • get_norm_scaling_factor()
  • norm_sweep()
• data_process
  • calc_step_norm()
  • get_axes_values()
  • get_bin_edges()
  • project_data()
  • wrap_angle()
• data_read
  • Acquisition
  • Analyzer
  • Detector
  • DetectorConfig
  • DetectorSetup
  • ElementConfig
  • Elements
  • Extra
  • General
  • Lensmode
  • Metadata
  • Timing
  • TimingData
  • empty_float_array()
  • get_aquisition_df()
  • load_counts()
  • load_file()
  • load_metadata()
  • parse_type()
  • read_acquisition_cfg()
  • read_metadata()
• LiveLoader
  • LiveLoader
• log_utils
  • get_run_logs()
• default_bin_config
  • get_default_bipolar_config()
  • get_default_e_config()
  • get_default_k_config()
  • get_default_phi_config()
  • get_default_t_config()
  • get_default_theta_config()
  • get_default_xyr_config()
• plotting
  • create_heatmap()
  • create_heatmap_frame()
  • create_scatter()
  • create_scatter_frame()
  • get_axis_label()
  • get_counts_label()
  • includes_energy_axis()
  • plot_1d()
  • plot_2d_heatmap()
  • plot_2d_slider()
  • plot_3d()
  • plot_counts()
  • plot_data()
  • setup_animation_layout()
  • update_subtitle()
• sweep
  • SweepConfig
  • get_scienta_sweep_config()
• threading_utils
  • PropagatingThread
• Transformer
  • Transformer
• igor_binning
  • igor_histogramdd()