autolens.PointDict

class PointDict

Bases: dict

A dictionary containing the entire point-source dataset, which could be many instances of the PointDataset object.

This dictionary uses the name of the PointDataset to act as the key of every entry of the dictionary, making it straight forward to access the attributes based on the dataset name.

Parameters:

point_dataset_list (List[PointDataset]) – A list of all point-source datasets that are to be added to the point-source dictionary.

Returns:

A dictionary where the keys are the name entries of each PointDataset and the values are the corresponding instance of the PointDataset class.

Return type:

Dict[PointDataset]

Methods

clear
copy
from_dicts	Create an instance from a list of dictionaries.
from_json
fromkeys	Create a new dictionary with keys from iterable and values set to value.
get	Return the value for key if key is in the dictionary, else default.
items
keys
output_to_json
pop	If key is not found, default is returned if given, otherwise KeyError is raised
popitem	Remove and return a (key, value) pair as a 2-tuple.
setdefault	Insert key with a value of default if key is not in the dictionary.
update	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values

Attributes

dicts	A list of dictionaries representing this collection of point source datasets.
positions_list

property dicts: List[dict]

A list of dictionaries representing this collection of point source datasets.

Return type:

List[dict]

classmethod from_dicts(dicts)

Create an instance from a list of dictionaries.

Parameters:

dicts (List[dict]) – Dictionaries, each representing one point source dataset.

Return type:

A collection of point source datasets.