autolens.Array2D

class autolens.Array2D(shape, dtype=float, buffer=None, offset=0, strides=None, order=None)

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(*args, **kwargs)	Initialize self.
all([axis, out, keepdims])	Returns True if all elements evaluate to True.
any([axis, out, keepdims])	Returns True if any of the elements of a evaluate to True.
apply_mask(mask)
argmax([axis, out])	Return indices of the maximum values along the given axis.
argmin([axis, out])	Return indices of the minimum values along the given axis of a.
argpartition(kth[, axis, kind, order])	Returns the indices that would partition this array.
argsort([axis, kind, order])	Returns the indices that would sort this array.
astype(dtype[, order, casting, subok, copy])	Copy of the array, cast to a specified type.
byteswap([inplace])	Swap the bytes of the array elements
choose(choices[, out, mode])	Use an index array to construct a new array from a set of choices.
clip([min, max, out])	Return an array whose values are limited to [min, max].
compress(condition[, axis, out])	Return selected slices of this array along given axis.
conj()	Complex-conjugate all elements.
conjugate()	Return the complex conjugate, element-wise.
copy([order])	Return a copy of the array.
cumprod([axis, dtype, out])	Return the cumulative product of the elements along the given axis.
cumsum([axis, dtype, out])	Return the cumulative sum of the elements along the given axis.
diagonal([offset, axis1, axis2])	Return specified diagonals.
dot(b[, out])	Dot product of two arrays.
dump(file)	Dump a pickle of the array to the specified file.
dumps()	Returns the pickle of the array as a string.
extent_of_zoomed_array([buffer])	For an extracted zoomed array computed from the method zoomed_around_mask compute its extent in scaled coordinates.
fill(value)	Fill the array with a scalar value.
flatten([order])	Return a copy of the array collapsed into one dimension.
from_fits(file_path, pixel_scales[, hdu, …])	Create an Array2D (see AbstractArray2D.__new__) by loading the array values from a .fits file.
full(fill_value, shape_native, pixel_scales)	Create an Array2D (see AbstractArray2D.__new__) where all values are filled with an input fill value, analogous to the method np.full().
getfield(dtype[, offset])	Returns a field of the given array as a certain type.
item(*args)	Copy an element of an array to a standard Python scalar and return it.
itemset(*args)	Insert scalar into an array (scalar is cast to array’s dtype, if possible)
manual(array, pixel_scales[, shape_native, …])	Create an Array2D (see AbstractArray2D.__new__) by inputting the array values in 1D or 2D, automatically determining whether to use the ‘manual_slim’ or ‘manual_native’ methods.
manual_mask(array, mask[, header])	Create an Array2D (see AbstractArray2D.__new__) by inputting the array values in 1D or 2D with its mask, for example:
manual_native(array, pixel_scales[, …])	Create an Array2D (see AbstractArray2D.__new__) by inputting the array values in 2D, for example:
manual_slim(array, shape_native, pixel_scales)	Create an Array2D (see AbstractArray2D.__new__) by inputting the array values in 1D, for example:
manual_yx_and_values(y, x, values, …[, …])	Create an Array2D (see AbstractArray2D.__new__) by inputting the y and x pixel values where the array is filled and the values to fill the array, for example:
max([axis, out, keepdims, initial, where])	Return the maximum along a given axis.
mean([axis, dtype, out, keepdims])	Returns the average of the array elements along given axis.
min([axis, out, keepdims, initial, where])	Return the minimum along a given axis.
newbyteorder([new_order])	Return the array with the same data viewed with a different byte order.
nonzero()	Return the indices of the elements that are non-zero.
ones(shape_native, pixel_scales[, sub_size, …])	Create an Array2D (see AbstractArray2D.__new__) where all values are filled with ones, analogous to the method np.ones().
output_to_fits(file_path[, overwrite])	Output the array to a .fits file.
padded_before_convolution_from(kernel_shape)	When the edge pixels of a mask are unmasked and a convolution is to occur, the signal of edge pixels will be ‘missing’ if the grid is used to evaluate the signal via an analytic function.
partition(kth[, axis, kind, order])	Rearranges the elements in the array in such a way that the value of the element in kth position is in the position it would be in a sorted array.
prod([axis, dtype, out, keepdims, initial, …])	Return the product of the array elements over the given axis
ptp([axis, out, keepdims])	Peak to peak (maximum - minimum) value along a given axis.
put(indices, values[, mode])	Set a.flat[n] = values[n] for all n in indices.
ravel([order])	Return a flattened array.
repeat(repeats[, axis])	Repeat elements of an array.
reshape(shape[, order])	Returns an array containing the same data with a new shape.
resize(new_shape[, refcheck])	Change shape and size of array in-place.
resized_from(new_shape[, mask_pad_value])	Resize the array around its centre to a new input shape.
round([decimals, out])	Return a with each element rounded to the given number of decimals.
searchsorted(v[, side, sorter])	Find indices where elements of v should be inserted in a to maintain order.
setfield(val, dtype[, offset])	Put a value into a specified place in a field defined by a data-type.
setflags([write, align, uic])	Set array flags WRITEABLE, ALIGNED, (WRITEBACKIFCOPY and UPDATEIFCOPY), respectively.
sort([axis, kind, order])	Sort an array in-place.
squeeze([axis])	Remove single-dimensional entries from the shape of a.
std([axis, dtype, out, ddof, keepdims])	Returns the standard deviation of the array elements along given axis.
structure_2d_from(result)
structure_2d_list_from(result_list)
sum([axis, dtype, out, keepdims, initial, where])	Return the sum of the array elements over the given axis.
swapaxes(axis1, axis2)	Return a view of the array with axis1 and axis2 interchanged.
take(indices[, axis, out, mode])	Return an array formed from the elements of a at the given indices.
tobytes([order])	Construct Python bytes containing the raw data bytes in the array.
tofile(fid[, sep, format])	Write array to a file as text or binary (default).
tolist()	Return the array as an a.ndim-levels deep nested list of Python scalars.
tostring([order])	A compatibility alias for tobytes, with exactly the same behavior.
trace([offset, axis1, axis2, dtype, out])	Return the sum along diagonals of the array.
transpose(*axes)	Returns a view of the array with axes transposed.
trimmed_after_convolution_from(kernel_shape)	When the edge pixels of a mask are unmasked and a convolution is to occur, the signal of edge pixels will be ‘missing’ if the grid is used to evaluate the signal via an analytic function.
var([axis, dtype, out, ddof, keepdims])	Returns the variance of the array elements, along given axis.
view([dtype][, type])	New view of array with the same data.
zeros(shape_native, pixel_scales[, …])	Create an Array2D (see AbstractArray2D.__new__) where all values are filled with zeros, analogous to the method np.ones().
zoomed_around_mask([buffer])	Extract the 2D region of an array corresponding to the rectangle encompassing all unmasked values.

Attributes

T	The transposed array.
base	Base object if memory is from some other object.
binned	Convenience method to access the binned-up array in its 1D representation, which is a Grid2D stored as an ndarray of shape [total_unmasked_pixels, 2].
binned_across_columns
binned_across_rows
ctypes	An object to simplify the interaction of the array with the ctypes module.
data	Python buffer object pointing to the start of the array’s data.
dtype	Data-type of the array’s elements.
extent
flags	Information about the memory layout of the array.
flat	A 1-D iterator over the array.
imag	The imaginary part of the array.
in_counts
in_counts_per_second
itemsize	Length of one array element in bytes.
native	Return a Array2D where the data is stored in its native representation, which is an ndarray of shape [sub_size*total_y_pixels, sub_size*total_x_pixels].
nbytes	Total bytes consumed by the elements of the array.
ndim	Number of array dimensions.
origin
original_orientation
pixel_area
pixel_scale
pixel_scales
readout_offsets
real	The real part of the array.
shape	Tuple of array dimensions.
shape_native
shape_slim
size	Number of elements in the array.
slim	Return an Array2D where the data is stored its slim representation, which is an ndarray of shape [total_unmasked_pixels * sub_size**2].
strides	Tuple of bytes to step in each dimension when traversing an array.
sub_shape_native
sub_shape_slim
sub_size
total_area
total_pixels
unmasked_grid