proc
Module containing patch processing routines.
Functions
| Name | Description |
|---|---|
| abs | Take the absolute value of the patch data. |
| adaptive_spectral_filter | Suppress energy which is not coherent within a window: the AFK filter. |
| add_distance_to | Calculate the distance to “origin” and create new coordinate. |
| align_to_coord | Align (shift) patch dim(s) based on values in a non-dimension coordinate. |
| angle | Return a new patch with the phase angles from the data array. |
| append_dims | Insert dimensions at the end of the patch. |
| bool_patch | Get the boolean value of a patch. |
| conj | Apply the complex conjugate of the patch data. |
| convert_units | Convert the patch data or coordinate units. |
| coords_from_df | Update non-dimensional coordinate of a patch using a dataframe. |
| correlate | Correlate source row/columns in a patch with all other row/columns. |
| correlate_shift | Apply a shift to the patch data to undo correlation in frequency domain. |
| decimate | Decimate a patch along a dimension. |
| demean | Remove the mean along a given dimension of a DASCore patch. |
| demedian | Remove the median along a given dimension of a DASCore patch. |
| detrend | Remove a constant or linear trend from the data along one dimension. |
| drop_coords | Drop one or more non-dimensional coordinates. |
| drop_private_coords | Drop all private coords in the patch. |
| dropna | Return a patch with nullish values dropped along dimension. |
| enrich | Copy inventory metadata onto a patch. |
| equals | Determine if the current patch equals another. |
| fill_gaps | Fill the gaps between a dimension’s segments with a constant value. |
| fillna | Return a patch with nullish values replaced by a value. |
| first | Get the first value along one or more dimensions. |
| flip | Flip patch data and (optionally coords) along specified dimensions. |
| full | Return an identical patch with the data replaced by fill_value. |
| gaussian_filter | Applies a Gaussian filter along specified dimensions. |
| get_array | Get an array associated with patch data or a coordinate. |
| get_axis | Get the axis corresponding to a Patch dimension. Raise error if not found. |
| get_coord | Get a managed coordinate from the patch. |
| hampel_filter | A Hampel filter implementation useful for removing spikes in data. |
| idxmax | Return the coordinate value where the data are largest along a dimension. |
| idxmin | Return the coordinate value where the data are smallest along a dimension. |
| imag | Return a new patch with the imaginary part of the data array. |
| interpolate | Set coordinates of patch along a dimension using interpolation. |
| isel | Select sample positions with xarray-compatible dimension indexing. |
| last | Get the last value along one or more dimensions. |
| line_mute | Mute (zero out) data in a region specified by one or more lines. |
| make_broadcastable_to | Stretch a patch until it broadcasts against a shape. |
| mean | Calculate the mean along one or more dimensions. |
| median | Calculate the median along one or more dimensions. |
| median_filter | Apply 2-D median filter. |
| normalize | Normalize a patch along a specified dimension. |
| notch_filter | Apply a second-order IIR notch digital filter on patch’s data. |
| order | Re-order the patch contents based on coordinate values or indices. |
| pad | Pad the patch data along specified dimensions. |
| pass_filter | Apply a Butterworth pass filter (bandpass, highpass, or lowpass). |
| pin_id |
Return the patch with a data_id hashed from the data it holds.
|
| pipe | Pipe the patch to a function. |
| pow_coord | Scale the data by coordinate values raised to a power. |
| real | Return a new patch with the real part of the data array. |
| reassemble | Blend a stack of tiles back into the patch they were cut from. |
| rename_coords | Rename coordinate of Patch. |
| resample | Resample along a single dimension using Fourier Method and interpolation. |
| roll | Roll patch array elements along a given dimension. |
| rolling | Apply a rolling function along a specified dimension. |
| savgol_filter | Applies Savgol filter along specified dimensions. |
| sel | Select coordinate labels with xarray-compatible dimension indexing. |
| select | Return a subset of the patch. |
| set_dims | Set dimension to non-dimensional coordinate. |
| set_units | Set the units of a patch’s data or coordinates. |
| simplify_units | Simplify the units contained by the patch to base metric units. |
| slope_filter | Filter the patch over certain slopes in the 2D Fourier domain. |
| slope_mute | Apply a mute between specified slopes (eg velocities). |
| snap_coords | Snap coordinates to evenly spaced samples. |
| sobel_filter | Estimate the gradient along one dimension with a Sobel operator. |
| sort_coords | Sort one or more coordinates. |
| split_gaps | Split the patch into contiguous patches. |
| squeeze | Return a new object with len one dimensions flattened. |
| standardize | Standardize data by removing the mean and scaling to unit variance. |
| std | Calculate the standard deviation along one or more dimensions. |
| taper | Taper the ends of the signal. |
| taper_range | Taper a range inside the patch. |
| transpose | Transpose the data array to any dimension order desired. |
| unselect | Return the patch outside a selection. |
| update | Return a copy of the Patch with replaced data, coords, dims, or attrs. |
| update_attrs | Update patch attrs and return a new Patch. |
| update_coords | Update the coordinates of a patch. |
| where | Return elements from patch where condition is True, else fill with other. |
| whiten | Spectral whitening of a signal. |
| wiener_filter | Apply a Wiener filter to reduce noise in the patch data. |
Classes
| Name | Description |
|---|---|
| Abs | Take the absolute value of the patch data. |
| AddDistanceTo | Calculate the distance to “origin” and create new coordinate. |
| AlignToCoord | Align (shift) patch dim(s) based on values in a non-dimension coordinate. |
| Angle | Return a new patch with the phase angles from the data array. |
| AppendDims | Insert dimensions at the end of the patch. |
| Conj | Apply the complex conjugate of the patch data. |
| ConvertUnits | Convert the patch data or coordinate units. |
| CoordsFromDf | Update non-dimensional coordinate of a patch using a dataframe. |
| Correlate | Correlate source row/columns in a patch with all other row/columns. |
| CorrelateShift | Apply a shift to the patch data to undo correlation in frequency domain. |
| Decimate | Decimate a patch along a dimension. |
| Demean | Remove the mean along a given dimension of a DASCore patch. |
| Demedian | Remove the median along a given dimension of a DASCore patch. |
| Detrend | Remove a constant or linear trend from the data along one dimension. |
| DropCoords | Drop one or more non-dimensional coordinates. |
| DropPrivateCoords | Drop all private coords in the patch. |
| Dropna | Return a patch with nullish values dropped along dimension. |
| Enrich | Copy inventory metadata onto a patch. |
| FillGaps | Fill the gaps between a dimension’s segments with a constant value. |
| Fillna | Return a patch with nullish values replaced by a value. |
| Flip | Flip patch data and (optionally coords) along specified dimensions. |
| Full | Return an identical patch with the data replaced by fill_value. |
| GaussianFilter | Applies a Gaussian filter along specified dimensions. |
| HampelFilter | A Hampel filter implementation useful for removing spikes in data. |
| Imag | Return a new patch with the imaginary part of the data array. |
| Interpolate | Set coordinates of patch along a dimension using interpolation. |
| Isel | Select sample positions with xarray-compatible dimension indexing. |
| LineMute | Mute (zero out) data in a region specified by one or more lines. |
| MakeBroadcastableTo | Stretch a patch until it broadcasts against a shape. |
| MedianFilter | Apply 2-D median filter. |
| Normalize | Normalize a patch along a specified dimension. |
| NotchFilter | Apply a second-order IIR notch digital filter on patch’s data. |
| Order | Re-order the patch contents based on coordinate values or indices. |
| Pad | Pad the patch data along specified dimensions. |
| PassFilter | Apply a Butterworth pass filter (bandpass, highpass, or lowpass). |
| PowCoord | Scale the data by coordinate values raised to a power. |
| Real | Return a new patch with the real part of the data array. |
| Reassemble | Blend a stack of tiles back into the patch they were cut from. |
| RenameCoords | Rename coordinate of Patch. |
| Resample | Resample along a single dimension using Fourier Method and interpolation. |
| Roll | Roll patch array elements along a given dimension. |
| SavgolFilter | Applies Savgol filter along specified dimensions. |
| Sel | Select coordinate labels with xarray-compatible dimension indexing. |
| Select | Return a subset of the patch. |
| SetUnits | Set the units of a patch’s data or coordinates. |
| SimplifyUnits | Simplify the units contained by the patch to base metric units. |
| SlopeFilter | Filter the patch over certain slopes in the 2D Fourier domain. |
| SlopeMute | Apply a mute between specified slopes (eg velocities). |
| SnapCoords | Snap coordinates to evenly spaced samples. |
| SobelFilter | Estimate the gradient along one dimension with a Sobel operator. |
| SortCoords | Sort one or more coordinates. |
| Squeeze | Return a new object with len one dimensions flattened. |
| Standardize | Standardize data by removing the mean and scaling to unit variance. |
| Taper | Taper the ends of the signal. |
| TaperRange | Taper a range inside the patch. |
| Transpose | Transpose the data array to any dimension order desired. |
| Unselect | Return the patch outside a selection. |
| UpdateCoords | Update the coordinates of a patch. |
| Where | Return elements from patch where condition is True, else fill with other. |
| Whiten | Spectral whitening of a signal. |
| WienerFilter | Apply a Wiener filter to reduce noise in the patch data. |
Modules
| Name | Description |
|---|---|
| aggregate | Module for applying aggregations (reductions) along a specified axis. |
| align | Functions to align patches based on some criterion. |
| basic | Basic operations for patches. |
| coords | Processing operations that have much to do with coordinates. |
| filter | dascore Filtering module. |
| hampel | Functionality for Hampel despiking. |
| impulse | Impulse windows: an operation’s reach measured from its response to an impulse. |
| inventory | Copy metadata from a DASDAE inventory onto a patch. |
| mute | Processing for muting (zeroing) patch data in specified regions. |
| tile_apply | Apply a function to overlapping windows of a patch, and blend them back. |
| units | Processing functions dealing with units and unit conversions. |
| wiener | Wiener filtering functionality for noise reduction. |
| window | Windows of a patch, and what is done in them. |
| adaptive_spectral_filter | The adaptive spectral (AFK) filter: every window’s spectrum weighted by a |
| _adaptive_spectral_filter_numba | Optional Numba/rocket-fft engine for the two-dimensional adaptive spectral filter. |
| correlate | Module for calculating cross-correlation over time or distance. |
| whiten | Spectral whitening. |
| resample | Module for re-sampling patches. |
| taper | Processing for applying a taper. |
| detrend | Module for detrending. |
| rolling | Processing for applying roller operations. |