BGlib.be.translators.df_utils.be_utilsΒΆ

Created on Tue Jan 05 07:55:56 2016

@author: Suhas Somnath, Chris Smith, Rama K. Vasudevan

Functions

createSpecVals

This function will determine the proper Spectroscopic Value array for the dataset

flat_parm_dict_to_nested

Creates a nested dictionary of parameters for Band EXcitation from the standard flat dictionary

generatePlotGroups

Generates the spatially averaged datasets for the given raw dataset.

generateTestSpectroscopicData

Generates a (preferably small) test data set using the given parameters.

generate_bipolar_triangular_waveform

Generates a bi-polar triangular waveform based on basic parameters

getActiveUDVSsteps

Returns all the active UDVS steps in the data

getDataIndicesForUDVSstep

Returns the spectroscopic indices that correspond to the given udvs_step_index that can be used to slice the main data matrix.

getForExcitWfm

Slices the provided H5 dataset by the provided wave type.

getIndicesforPlotGroup

For a provided plot group name in the udvs table, this function returns the corresponding spectroscopic indices that can be used to index / slice the main data set and the data within the udvs table for the requested plot group * Developer note - Replace the first parameter with the Raw_Data dataset

getSliceForExcWfm

Returns the indices that correspond to the given excitation waveform that can be used to slice the bin datasets * Developer note - Replace the first parameter with the Raw_Data dataset

getSpecSliceForUDVSstep

Returns the spectroscopic indices that correspond to the given udvs_step_index that can be used to slice the main data matrix * Developer note - Replace the first parameter with the Raw_Data dataset

getSpectroscopicParmLabel

Returns the label for the spectroscopic parameter in the plot group.

infer_bipolar_triangular_fraction_phase

Infers the VS cycle fraction and phase when parameters were stored in old mat files

isSimpleDataset

This function figures out if a single number defines the bins for all UDVS steps In such cases (udvs_steps x bins, pos) can be reshaped to (bins, positions x steps) for (theoretically) faster computation, especially for large datasets

maxReadPixels

Calculates the maximum number of pixels that can be loaded into the specified memory size.

normalizeBEresponse

This function normalizes the BE waveform to correct the phase by diving by the excitation

parmsToDict

Translates the parameters in the text file into a dictionary.

remove_non_exist_spec_dim_labs

Removes non-existent spectroscopic dimension name and units from attributes of spectroscopic datasets.

requires_conjugate

Determines whether or not the conjugate of the data needs to be taken based on the quality factor

reshape_mean_data

Takes in the mean data vector and rearranges that data according to plot group as [step number,bins]

trimUDVS

Removes unused (typically default) plot groups

visualize_plot_groups

Visualizes the plot groups present in the provided BE data file

Classes

BEHistogram

Class just functions as a container so we can have shared objects Chris Smith -- csmith55@utk.edu