autocti.ArrayIrregular

class autocti.ArrayIrregular(values: Union[List, ndarray])

Bases: Structure

A collection of values which are structured as follows:

[value0, value1, value3]

The values object does not store the values as a list of floats, but instead a 1D NumPy array of shape [total_values]. This array can be mapped to the list of floats structure above. They are stored as a NumPy array so the values can be used efficiently for calculations.

The values input to this function can have any of the following forms:

[value0, value1]

In all cases, they will be converted to a list of floats followed by a 1D NumPy array.

Print methods are overridden so a user always “sees” the values as the list structure.

In contrast to a Array2D structure, ArrayIrregular do not lie on a uniform grid or correspond to values that originate from a uniform grid. Therefore, when handling irregular data-sets ArrayIrregular should be used.

Parameters:

values ([float] or equivalent) – A collection of values.

Methods

all
astype
copy
flip_hdu_for_ds9
from_file	Create a ArrayIrregular object from a .json file which stores the coordinates as a list of list of tuples.
grid_from	Create a Grid2DIrregular object from a 2D ndarray array of values of shape [total_values, 2].
instance_flatten	Flatten an instance of an autoarray class into a tuple of its attributes (i.e.
instance_unflatten	Unflatten a tuple of attributes (i.e.
invert
max
min
output_to_fits	Output the grid to a .fits file.
output_to_json	Output this instance of the Grid2DIrregular object to a list of list of tuples.
reshape
sqrt
structure_2d_from
structure_2d_list_from
sum
trimmed_after_convolution_from
values_from	Create a ArrayIrregular object from a 1D ndarray of values of shape [total_values].
with_new_array	Copy this object but give it a new array.

Attributes

array
derive_grid
derive_indexes
derive_mask
dtype
geometry
hdu_for_output
imag
in_list	Return the values in a list.
native	Returns the data structure in its native format which contains all unmaksed values to the native dimensions.
ndim
origin
pixel_area
pixel_scale
pixel_scale_header
pixel_scales
real
shape
shape_native
shape_slim
size
slim	The ArrayIrregular in their slim representation, a 1D ndarray of shape [total_values].
sub_shape_native
sub_shape_slim
sub_size
total_area
total_pixels
unmasked_grid

property native: Structure

Returns the data structure in its native format which contains all unmaksed values to the native dimensions.

property slim: ArrayIrregular

The ArrayIrregular in their slim representation, a 1D ndarray of shape [total_values].

property in_list: List

Return the values in a list.

values_from(array_slim: ndarray) → ArrayIrregular

Create a ArrayIrregular object from a 1D ndarray of values of shape [total_values].

The returned values have an identical structure to this ArrayIrregular instance.

Parameters:

array_slim – The 1D ndarray with (hape [total_values] whose values are mapped to a ArrayIrregular object.

grid_from(grid_slim: np.ndarray) → Grid2DIrregular

Create a Grid2DIrregular object from a 2D ndarray array of values of shape [total_values, 2].

The returned grid are structured following this ArrayIrregular instance.

Parameters:

grid_slim – The 2d array (shape [total_coordinates, 2]) of (y,x) coordinates that are mapped to a Grid2DIrregular object.

classmethod from_file(file_path: Union[Path, str]) → ArrayIrregular

Create a ArrayIrregular object from a .json file which stores the coordinates as a list of list of tuples.

Parameters:

file_path – The path to the coordinates .dat file containing the coordinates (e.g. ‘/path/to/coordinates.dat’)

output_to_json(file_path: Union[Path, str], overwrite: bool = False)

Output this instance of the Grid2DIrregular object to a list of list of tuples.

Parameters:

• file_path – The path to the coordinates .dat file containing the coordinates (e.g. ‘/path/to/coordinates.dat’)

• overwrite – If there is as exsiting file it will be overwritten if this is True.