crikit.utils package¶
Subpackages¶
Submodules¶
crikit.utils.breadcrumb module¶
Breadcrumb Module¶
BCPre : Container describing pre-processing steps
Class Methods¶
- HDFtoClass(filename [str], datasetname [str])Load dataset in HDF
file into the HSI Class
Bases:
object
Container that describes processing steps (ie it contains “breadcrumbs”)
- offsetint
Instead of starting at Step 0, start at offset (0 + offset)
A list-of-lists. Each contained list follows the format [‘Process Name’, ‘Var1 Name’, Val1, ‘Var2 Name’, Val2, …]. The variable names and values may be input values to the pre-processing step. Only the Process Name is mnadatory: the rest are optional.
- Type
Flag identifying which steps were backed-up to disk (e.g., for undo)
- Type
Unique identifier for each step. Can be used to name back-up/undo files
- Type
list (read-only)
Identifier of id’s cut with pop_to_last method
- Type
list (read-only)
Number of processing steps
- Type
Dictionary-version of process_list that can be written to HDF5 dataset metadata (properties)
- Type
-
add_step : Add a new processing step
-
backed_up : Mark most recent process step as backed up in backed_flag list
-
pop_to_last : Remove entries until nearest backup point (excluding current step).
Adds a steps to the list
- Parameters
process_desc (list) – List containing elements of new process with format: [‘Process Name’, ‘Var1 Name’, Val1, ‘Var2 Name’, Val2, …]. The variable names and values may be input values to the pre-processing step. Only the Process Name is mnadatory: the rest are optional.
- Returns
None
- Return type
-
property
attr_dict
¶
Marks most recent process step as backed up in backed_flag list
Dump current state of data (class of type crikit.data.spectrum or subclass)to pickle file (filename= fname).
Can append additional attributes (addl_attr) to attribute dictionary (self.attr)
-
property
cut_list
¶
-
property
id_list
¶
Static method.
Return a loaded pickled version of this class (filename= fname).
-
property
num_steps
¶
Remove entries until nearest backup point (excluding current step). That is, if current step IS a backup point, moves to previous one. If current step is NOT a backup point, moves to nearest point.
If all = True, will cut everything
crikit.utils.datacheck module¶
Functions to check and (if needed) convert input variables
Created on Sat Jun 18 00:16:27 2016
@author: chc
crikit.utils.general module¶
General utilities
expand_1d_to_ndim_data : Match 1D data array dimensionality to that of another array
expand_1d_to_ndim : Expand 1D data array dimensionality to ndim
- find_nearestGiven a vector and a value, find the index and value
of the closest match
- padWrapper around numpy.pad that also returns a window defining the
original signal
Notes
-
crikit.utils.general.
arange_nonzero
(start, stop, dtype=<class 'float'>)[source]¶ Similar to numpy arange but only returns non-zero elements
-
crikit.utils.general.
expand_1d_to_ndim_data
(data, data_to_match)[source]¶ Make 1D data array equal in dimensions to data_to_match
-
crikit.utils.general.
find_nearest
(np_vec, to_find=0)[source]¶ Given a vector and a value (or list/vector of values), find the index and value of the closest match
-
crikit.utils.general.
lin_from_row_col
(row, col, sh)[source]¶ Convert a col and row counter to 1D linear count
-
crikit.utils.general.
mean_nd_to_1d
(data, axis=- 1)[source]¶ Take the mean of an nd array, except axis, returning a 1D array
-
crikit.utils.general.
np_fcn_nd_to_1d
(fcn, data, axis=- 1)[source]¶ Take in an n-dimensional array and return a 1D version operated on by fcn. Works with many numpy functions that can take an “axis” parameter
-
crikit.utils.general.
pad
(y, pad_width, mode)[source]¶ Pad array with either constants or edge values.
Note: For N-D arrays, pads the -1 axis
-
crikit.utils.general.
pad_dual
(y, edge_pad_width, constant_pad_width)[source]¶ Pad array with edge values followed by constant 0’s.
Note: For N-D arrays, pads the -1 axis
- Parameters
- Returns
Padded array and window. Window defines the region of the original signal
- Return type
y_pad, window
-
crikit.utils.general.
pad_edge_mean
(y, pad_width, n_edge=1, axis=- 1)[source]¶ Pad data y with edge-values or near-edge mean values along axis
- Parameters
- Returns
(y_pad, window)
y_pad (ndarray) – Padded y
window (ndarray (1D)) – Mask with 0’s for pad regions, 1’s for original size
crikit.utils.roi module¶
Created on Wed Jun 15 23:33:41 2016
@author: chc
-
crikit.utils.roi.
pts_in_path
(path)[source]¶ Return points (pixels) that fall within path (but not on boundary)