aopp_deconv_tool.geo_array.GeoArray

class documentation

class GeoArray:

A Geometric Array. An array of data, along with coordinate axes that describe the position of the data.

# ATTRIBUTES #

self.data : np.ndarray: The data the array holds
self.axes : np.ndarray: The 'points in space' where self.data is defined. These are what changes when the GeoArray undergoes a geometric transform

Static Method	`scale_to_axes`	Applies a `scale` to a `shape` such that the result is centred around `centre`
Method	`__array__`	For compatibility with numpy routines
Method	`__init__`	Undocumented
Method	`copy`	Copy the GeoArray
Method	`fft`	Return the fast fourier transform of the GeoArray
Method	`ifft`	Return the inverse fast fourier transform of the GeoArray
Instance Variable	`axes`	Undocumented
Instance Variable	`data`	Undocumented
Property	`extent`	Return the "extent" (i.e., min,max in each dimension) of the GeoArray
Property	`mesh`	Return a meshgrid that covers the GeoArray
Property	`scale`	Return the scale (i.e., difference between min and max) of the GeoArray

@staticmethod
def scale_to_axes(scale: tuple[float, ...], shape: tuple[int, ...], centre: float = 0) -> np.ndarray: ¶

Applies a scale to a shape such that the result is centred around centre

def __array__(self): ¶

For compatibility with numpy routines

def __init__(self, data: np.ndarray, axes: tuple[np.ndarray, ...] | None): ¶

Undocumented

def copy(self): ¶

Copy the GeoArray

def fft(self): ¶

Return the fast fourier transform of the GeoArray

def ifft(self): ¶

Return the inverse fast fourier transform of the GeoArray

axes = ¶

Undocumented

data = ¶

Undocumented

@property
extent = ¶

Return the "extent" (i.e., min,max in each dimension) of the GeoArray

@property
mesh: np.ndarray = ¶

Return a meshgrid that covers the GeoArray

@property
scale: tuple[float, ...] = ¶

Return the scale (i.e., difference between min and max) of the GeoArray