sed-processor
0.2.0
Getting Started
Table of Contents
Installation
Binning demonstration on locally generated fake data
Demonstration of the conversion pipeline using time-resolved ARPES data stored on Zenodo
Binning with metadata generation, and storing into a NeXus file
Tutorial for binning data from the HEXTOF instrument at FLASH
Binning of temperature-dependent ARPES data using time-stamped external temperature data
Distortion correction with orthorhombic symmetry
Correct use of Jittering
SED Core Modules
Core
Dataframe Operations
Data loader
Binning
Calibrator
Dataset
Diagnostics
IO
Metadata
Config
Contributing
Contributing to sed
How to Maintain
sed-processor
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
A
add() (sed.core.metadata.MetaHandler method)
(sed.dataset.dataset.DatasetsManager static method)
add_attribute() (sed.core.SedProcessor method)
add_delay_offset() (sed.core.SedProcessor method)
add_energy_offset() (sed.core.SedProcessor method)
add_features() (sed.calibrator.momentum.MomentumCorrector method)
add_jitter() (sed.core.SedProcessor method)
add_offsets() (sed.calibrator.delay.DelayCalibrator method)
(sed.calibrator.energy.EnergyCalibrator method)
add_ranges() (sed.calibrator.energy.EnergyCalibrator method)
add_time_stamped_data() (in module sed.core.dfops)
(sed.core.SedProcessor method)
adjust_energy_correction() (sed.calibrator.energy.EnergyCalibrator method)
(sed.core.SedProcessor method)
adjust_ranges() (sed.calibrator.energy.EnergyCalibrator method)
align_dld_sectors() (sed.calibrator.energy.EnergyCalibrator method)
(sed.core.SedProcessor method)
append_delay_axis() (sed.calibrator.delay.DelayCalibrator method)
append_energy_axis() (sed.calibrator.energy.EnergyCalibrator method)
(sed.core.SedProcessor method)
append_k_axis() (sed.calibrator.momentum.MomentumCorrector method)
append_tof_ns_axis() (sed.calibrator.energy.EnergyCalibrator method)
(sed.core.SedProcessor method)
apply_correction() (sed.calibrator.momentum.MomentumCorrector method)
apply_corrections() (sed.calibrator.momentum.MomentumCorrector method)
apply_dfield() (in module sed.calibrator.momentum)
apply_energy_correction() (sed.calibrator.energy.EnergyCalibrator method)
(sed.core.SedProcessor method)
apply_filter() (in module sed.core.dfops)
apply_jitter() (in module sed.core.dfops)
apply_momentum_calibration() (sed.core.SedProcessor method)
apply_momentum_correction() (sed.core.SedProcessor method)
attributes (sed.core.SedProcessor property)
available (sed.dataset.dataset.Dataset property)
available_channels (sed.loader.flash.loader.FlashLoader property)
(sed.loader.sxp.loader.SXPLoader property)
B
backward_fill_lazy() (in module sed.core.dfops)
BaseLoader (class in sed.loader.base.loader)
bin_and_load_momentum_calibration() (sed.core.SedProcessor method)
bin_centers_to_bin_edges() (in module sed.binning.utils)
bin_data() (sed.calibrator.energy.EnergyCalibrator method)
bin_dataframe() (in module sed.binning)
bin_edges_to_bin_centers() (in module sed.binning.utils)
bin_partition() (in module sed.binning)
binned (sed.core.SedProcessor property)
binsearch() (in module sed.binning.numba_bin)
buffer_file_handler() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
C
calc_geometric_distances() (sed.calibrator.momentum.MomentumCorrector method)
calc_inverse_dfield() (sed.calibrator.momentum.MomentumCorrector method)
calc_symmetry_scores() (sed.calibrator.momentum.MomentumCorrector method)
calibrate() (sed.calibrator.energy.EnergyCalibrator method)
(sed.calibrator.momentum.MomentumCorrector method)
calibrate_delay_axis() (sed.core.SedProcessor method)
calibrate_energy_axis() (sed.core.SedProcessor method)
calibrate_momentum_axes() (sed.core.SedProcessor method)
cleanup_oldest_scan() (sed.loader.mirrorutil.CopyTool method)
cm2palette() (in module sed.calibrator.momentum)
complete_dictionary() (in module sed.core.config)
compute() (sed.core.SedProcessor method)
concatenate_channels() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
config (sed.core.SedProcessor property)
coordinate_transform() (sed.calibrator.momentum.MomentumCorrector method)
copy() (sed.loader.mirrorutil.CopyTool method)
CopyTool (class in sed.loader.mirrorutil)
correction_function() (in module sed.calibrator.energy)
cpy() (sed.core.SedProcessor method)
create_buffer_file() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
create_dataframe_per_channel() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
create_dataframe_per_electron() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
create_dataframe_per_file() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
create_dataframe_per_pulse() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
create_dataframe_per_train() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
create_multi_index_per_electron() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
create_multi_index_per_pulse() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
create_numpy_array_per_channel() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
D
data_name (sed.dataset.dataset.Dataset property)
dataframe (sed.core.SedProcessor property)
Dataset (class in sed.dataset.dataset)
DatasetsManager (class in sed.dataset.dataset)
define_features() (sed.core.SedProcessor method)
DelayCalibrator (class in sed.calibrator.delay)
detector_coordinates_2_k_coordinates() (in module sed.calibrator.momentum)
dictmerge() (in module sed.calibrator.momentum)
drop_column() (in module sed.core.dfops)
dup (sed.calibrator.energy.EnergyCalibrator property)
DuplicateEntryError
E
EnergyCalibrator (class in sed.calibrator.energy)
existing_data_paths (sed.dataset.dataset.Dataset property)
extract_bias() (in module sed.calibrator.energy)
extract_delay_stage_parameters() (in module sed.calibrator.delay)
F
feature_extract() (sed.calibrator.energy.EnergyCalibrator method)
(sed.calibrator.momentum.MomentumCorrector method)
feature_select() (sed.calibrator.momentum.MomentumCorrector method)
features (sed.calibrator.momentum.MomentumCorrector property)
FILENAME (sed.dataset.dataset.DatasetsManager attribute)
files (sed.core.SedProcessor property)
(sed.loader.flash.loader.FlashLoader attribute)
(sed.loader.generic.loader.GenericLoader attribute)
(sed.loader.mpes.loader.MpesLoader attribute)
(sed.loader.sxp.loader.SXPLoader attribute)
filter_column() (sed.core.SedProcessor method)
find_bias_peaks() (sed.core.SedProcessor method)
find_correspondence() (in module sed.calibrator.energy)
find_nearest() (in module sed.calibrator.energy)
fit_energy_calibration() (in module sed.calibrator.energy)
FlashLoader (class in sed.loader.flash.loader)
forward_fill_lazy() (in module sed.core.dfops)
G
gather_calibration_metadata() (sed.calibrator.energy.EnergyCalibrator method)
(sed.calibrator.momentum.MomentumCorrector method)
gather_correction_metadata() (sed.calibrator.energy.EnergyCalibrator method)
(sed.calibrator.momentum.MomentumCorrector method)
gather_files() (in module sed.loader.utils)
gather_metadata() (sed.loader.mpes.loader.MpesLoader method)
(sed.loader.sxp.loader.SXPLoader method)
generate_inverse_dfield() (in module sed.calibrator.momentum)
generate_splinewarp() (sed.core.SedProcessor method)
GenericLoader (class in sed.loader.generic.loader)
get() (sed.dataset.dataset.Dataset method)
get_archiver_data() (in module sed.loader.mpes.loader)
get_attribute() (in module sed.loader.mpes.loader)
get_channels() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
get_count_rate() (in module sed.loader.mpes.loader)
(sed.loader.base.loader.BaseLoader method)
(sed.loader.flash.loader.FlashLoader method)
(sed.loader.generic.loader.GenericLoader method)
(sed.loader.mpes.loader.MpesLoader method)
(sed.loader.sxp.loader.SXPLoader method)
get_elapsed_time() (in module sed.loader.mpes.loader)
(sed.loader.base.loader.BaseLoader method)
(sed.loader.flash.loader.FlashLoader method)
(sed.loader.generic.loader.GenericLoader method)
(sed.loader.mpes.loader.MpesLoader method)
(sed.loader.sxp.loader.SXPLoader method)
get_files_from_run_id() (sed.loader.base.loader.BaseLoader method)
(sed.loader.flash.loader.FlashLoader method)
(sed.loader.generic.loader.GenericLoader method)
(sed.loader.mpes.loader.MpesLoader method)
(sed.loader.sxp.loader.SXPLoader method)
get_groups_and_aliases() (in module sed.loader.mpes.loader)
get_loader() (in module sed.loader.loader_interface)
get_metadata() (sed.loader.flash.metadata.MetadataRetriever method)
get_names_of_all_loaders() (in module sed.loader.loader_interface)
get_normalization_histogram() (sed.core.SedProcessor method)
get_start_and_end_time() (sed.loader.mpes.loader.MpesLoader method)
get_target_dir() (in module sed.loader.mirrorutil)
grid_histogram() (in module sed.diagnostics)
H
hdf5_to_array() (in module sed.loader.mpes.loader)
hdf5_to_dataframe() (in module sed.loader.mpes.loader)
hdf5_to_timed_array() (in module sed.loader.mpes.loader)
hdf5_to_timed_dataframe() (in module sed.loader.mpes.loader)
I
initialize_paths() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
J
json_path (sed.dataset.dataset.DatasetsManager attribute)
L
load() (sed.core.SedProcessor method)
load_bias_series() (sed.core.SedProcessor method)
load_config() (in module sed.core.config)
load_data() (sed.calibrator.energy.EnergyCalibrator method)
(sed.calibrator.momentum.MomentumCorrector method)
load_datasets_dict() (sed.dataset.dataset.DatasetsManager static method)
load_dfield() (in module sed.calibrator.momentum)
load_h5() (in module sed.io)
load_tiff() (in module sed.io)
LOADER (in module sed.loader.base.loader)
(in module sed.loader.flash.loader)
(in module sed.loader.generic.loader)
(in module sed.loader.mpes.loader)
(in module sed.loader.sxp.loader)
M
map_columns_2d() (in module sed.core.dfops)
metadata (sed.core.metadata.MetaHandler property)
(sed.loader.flash.loader.FlashLoader attribute)
(sed.loader.generic.loader.GenericLoader attribute)
(sed.loader.mpes.loader.MpesLoader attribute)
(sed.loader.sxp.loader.SXPLoader attribute)
MetadataRetriever (class in sed.loader.flash.metadata)
MetaHandler (class in sed.core.metadata)
mm_to_ps() (in module sed.calibrator.delay)
module
sed.binning
sed.binning.numba_bin
sed.binning.utils
sed.calibrator.delay
sed.calibrator.energy
sed.calibrator.momentum
sed.core
sed.core.config
sed.core.dfops
sed.core.metadata
sed.dataset.dataset
sed.diagnostics
sed.io
sed.loader.base.loader
sed.loader.flash.loader
sed.loader.flash.metadata
sed.loader.generic.loader
sed.loader.loader_interface
sed.loader.mirrorutil
sed.loader.mpes.loader
sed.loader.sxp.loader
sed.loader.utils
MomentumCorrector (class in sed.calibrator.momentum)
MpesLoader (class in sed.loader.mpes.loader)
mycopy() (in module sed.loader.mirrorutil)
mymakedirs() (in module sed.loader.mirrorutil)
N
NAME (sed.dataset.dataset.DatasetsManager attribute)
normalization_histogram (sed.core.SedProcessor property)
normalize() (sed.calibrator.energy.EnergyCalibrator method)
normalized (sed.core.SedProcessor property)
normspec() (in module sed.calibrator.energy)
nranges (sed.calibrator.energy.EnergyCalibrator property)
ntraces (sed.calibrator.energy.EnergyCalibrator property)
numba_histogramdd() (in module sed.binning.numba_bin)
O
offset_by_other_columns() (in module sed.core.dfops)
P
parquet_handler() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
parse_config() (in module sed.core.config)
parse_h5_keys() (in module sed.loader.utils)
parse_metadata() (sed.loader.flash.loader.FlashLoader method)
peakdetect1d() (in module sed.calibrator.energy)
peaksearch() (in module sed.calibrator.energy)
plot_single_hist() (in module sed.diagnostics)
poly_energy_calibration() (in module sed.calibrator.energy)
pose_adjustment() (sed.calibrator.momentum.MomentumCorrector method)
(sed.core.SedProcessor method)
pre_binning() (sed.core.SedProcessor method)
R
range_convert() (in module sed.calibrator.energy)
read_dataframe() (sed.loader.base.loader.BaseLoader method)
(sed.loader.flash.loader.FlashLoader method)
(sed.loader.generic.loader.GenericLoader method)
(sed.loader.mpes.loader.MpesLoader method)
(sed.loader.sxp.loader.SXPLoader method)
remove() (sed.dataset.dataset.Dataset method)
(sed.dataset.dataset.DatasetsManager static method)
reset_deformation() (sed.calibrator.momentum.MomentumCorrector method)
reset_multi_index() (sed.loader.flash.loader.FlashLoader method)
(sed.loader.sxp.loader.SXPLoader method)
runs (sed.loader.flash.loader.FlashLoader attribute)
(sed.loader.generic.loader.GenericLoader attribute)
(sed.loader.mpes.loader.MpesLoader attribute)
(sed.loader.sxp.loader.SXPLoader attribute)
S
save() (sed.core.SedProcessor method)
save_config() (in module sed.core.config)
save_delay_calibration() (sed.core.SedProcessor method)
save_delay_offsets() (sed.core.SedProcessor method)
save_energy_calibration() (sed.core.SedProcessor method)
save_energy_correction() (sed.core.SedProcessor method)
save_energy_offset() (sed.core.SedProcessor method)
save_momentum_calibration() (sed.core.SedProcessor method)
save_splinewarp() (sed.core.SedProcessor method)
save_transformations() (sed.core.SedProcessor method)
save_workflow_params() (sed.core.SedProcessor method)
sed.binning
module
sed.binning.numba_bin
module
sed.binning.utils
module
sed.calibrator.delay
module
sed.calibrator.energy
module
sed.calibrator.momentum
module
sed.core
module
sed.core.config
module
sed.core.dfops
module
sed.core.metadata
module
sed.dataset.dataset
module
sed.diagnostics
module
sed.io
module
sed.loader.base.loader
module
sed.loader.flash.loader
module
sed.loader.flash.metadata
module
sed.loader.generic.loader
module
sed.loader.loader_interface
module
sed.loader.mirrorutil
module
sed.loader.mpes.loader
module
sed.loader.sxp.loader
module
sed.loader.utils
module
SedProcessor (class in sed.core)
select_k_range() (sed.calibrator.momentum.MomentumCorrector method)
select_slice() (sed.calibrator.momentum.MomentumCorrector method)
select_slicer() (sed.calibrator.momentum.MomentumCorrector method)
simplify_binning_arguments() (in module sed.binning.utils)
size() (sed.loader.mirrorutil.CopyTool method)
spline_warp_estimate() (sed.calibrator.momentum.MomentumCorrector method)
split_channel_bitwise() (in module sed.loader.utils)
split_dld_time_from_sector_id() (in module sed.loader.utils)
supported_file_types (sed.loader.base.loader.BaseLoader attribute)
(sed.loader.flash.loader.FlashLoader attribute)
(sed.loader.generic.loader.GenericLoader attribute)
(sed.loader.mpes.loader.MpesLoader attribute)
(sed.loader.sxp.loader.SXPLoader attribute)
SXPLoader (class in sed.loader.sxp.loader)
symscores (sed.calibrator.momentum.MomentumCorrector property)
T
timed_dataframe (sed.core.SedProcessor property)
to_h5() (in module sed.io)
to_nexus() (in module sed.io)
to_tiff() (in module sed.io)
tof2ev() (in module sed.calibrator.energy)
tof2evpoly() (in module sed.calibrator.energy)
tof2ns() (in module sed.calibrator.energy)
U
update_deformation() (sed.calibrator.momentum.MomentumCorrector method)
V
view() (sed.calibrator.energy.EnergyCalibrator method)
(sed.calibrator.momentum.MomentumCorrector method)
view_event_histogram() (sed.core.SedProcessor method)