Help on class SphericalSignal in module test_signals:
class SphericalSignal(builtins.object)
| Make a 3D spherical test signal
|
| Provides a 3D sinusoidal, hemisperical test signal and its spatial derivatives
|
| Args:
| factor: a parameter controlling the frequency content of the signal.
| Default is 5000.
| xsize: the size of the 3D signal in the 1st dimension. Default is 301.
| ysize: the size of the 3D signal in the 2nd dimension. Default is 301.
| zsize: the size of the 3D signal in the last dimension. Default is 301.
| deriv: what derivative of the test signal to create. Default is None.
|
| Methods defined here:
|
| __init__(self, factor=5000, xsize=301, ysize=301, zsize=301, deriv=None)
| Initialize self. See help(type(self)) for accurate signature.
|
| getXslice(self, x, xstep, ystep)
| A generator for a series of data cubes along a y-z plane at location x
|
| Allows iteration along a y-z plane where at each interation a data cube
| of shape (2*xstep+1, 2*ystep+1, zsize) is returned. Cubes around the edge
| of the test signal volume are padded with the edge value.
|
| Args:
| x: the x value of the required y-z plane
| xstep: number of traces either side of the current location to include
| ystep: number of traces either side of the current location to indlude
|
| Returns:
| A series of data cubes along the specified y-z plane
|
| getYslice(self, y, xstep, ystep)
| A generator for a series of data cubes along a x-z plane at location y
|
| Allows iteration along a x-z plane where at each interation a data cube
| of shape (2*xstep+1, 2*ystep+1, zsize) is returned. Cubes around the edge
| of the test signal volume are padded with the edge value.
|
| Args:
| y: the y value of the required x-z plane
| xstep: number of traces either side of the current location to include
| ystep: number of traces either side of the current location to indlude
|
| Returns:
| A series of data cubes along the specified x-z plane
|
| getZslice(self, z, xstep, ystep, zstep)
| A generator for a series of data cubes on an x-y plane at location z
|
| Allows iteration over an x-y plane where at each interation a data cube
| of shape (2*xstep+1, 2*ystep+1, 2*zsize+1) is returned. Cubes around the edge
| of the test signal volume are padded with the edge value.The iteration
| proceeds along the xSlice direction.
|
| Args:
| z: the z value of the required x-y plane
| xstep: number of traces either side of the current location to include
| ystep: number of traces either side of the current location to indlude
| zstep: number of traces either side of the current location to indlude
|
| Returns:
| A series of data cubes on the specified x-y plane
|
| xSlice(self, x)
| Return an y-z plane at location x
|
| Args:
| x: the x value of the required y-z plane
|
| Returns:
| A 2D array with the y-z plane if x is a valid index
| otherwise returns a plane of zeros.
|
| ySlice(self, y)
| Return an x-z plane at location y
|
| Args:
| y: the y value of the required x-z plane
|
| Returns:
| A 2D array with the x-z plane if y is a valid index
| otherwise returns a plane of zeros.
|
| zSlice(self, z)
| Return an x- plane at location z
|
| Args:
| z: the z value of the required x-y plane
|
| Returns:
| A 2D array with the x-y plane if z is a valid index
| otherwise returns a plane of zeros.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)