Container

class caput.containers.Container(*args: Any, **kwargs: Any)

Bases: caput.memdata.MemDiskGroup

Basic high level data container.

Basic one-level data container that allows any number of datasets in the root group but no nesting. Data history tracking (in history) and array axis interpretation (in index_map) is also provided.

Instead of subclassing this directly, most use casees will be better served by subclassing ContainerPrototype, which provides additional facilities to simplify the specification of container datasets and axes. This class is intended to be more flexible - datasets can be added or deleted arbitrarily.

Notes

Parameters are passed through to the MemDiskGroup constructor.

property history: caput.memdata.ro_dict

Stores the analysis history for this data.

Do not try to add a new entry by assigning to an element of this property. Use add_history() instead.

Returns:

historyro_dict

Each entry is a dictionary containing metadata about that stage in history. There is also an ‘order’ entry which specifies how the other entries are ordered in time.

property index_attrs: caput.memdata.ro_dict

Exposes the attributes of each index_map entry.

Allows the user to implement custom behaviour associated with the axis. Assignment to this dictionary does nothing but it does allow attribute values to be changed.

Returns:

index_attrsro_dict

Attribute dicts for each index_map entry.

property index_map: caput.memdata.ro_dict

Stores representions of the axes of datasets.

The index map contains arrays used to interpret the axes of the various datasets. For instance, the ‘time’, ‘prod’ and ‘freq’ axes of the visibilities are described in the index map.

Do not try to add a new index_map by assigning to an item of this property. Use create_index_map() instead.

Returns:

index_mapro_dict

Entries are 1D arrays used to interpret the axes of datasets.

property reverse_map: caput.memdata.ro_dict

Stores mappings between index_map entries.

Do not try to add a new reverse_map by assigning to an item of this property. Use create_reverse_map() instead.

Returns:

reverse_mapro_dict

Entries are 1D arrays used to map from product index to stack index.

Methods

add_history(→ None)	Create a new history entry.
create_index_map(→ None)	Create a new index map.
create_reverse_map(→ None)	Create a new reverse map.
dataset_name_allowed(→ bool)	Datasets may only be created and accessed in the root level group.
del_index_map(→ None)	Delete an index map.
del_reverse_map(→ None)	Delete an index map.
group_name_allowed(→ Literal[False])	No groups are exposed to the user. Returns False.
redistribute(→ None)	Redistribute parallel datasets along a specified axis.