Populations¶
Classes for population data.
API¶
Classes:
|
Populations class holding attributes and methods pertaining to population data |
- class populations.Populations(kin_aper=None, pop_cols=None, **kwargs)¶
Populations class holding attributes and methods pertaining to population data
- Parameters:
- kin_aperint or None, optional
If an integer, the index of the kinematic data set (starting with 0) which shares its apertures with the population data set. If None, the population data set has its own apertures. The default is None.
- pop_colslist of str or None, optional
If the population data set shares its apertures with a kinematic data set, this is a list of the population columns to keep in the data. If the population data set has its own apertures, it is None. The default is None.
Methods:
clean_data(pop_cols)Removes all data columns except for the index and the populations data.
get_data()Returns the populations data.
update(**kwargs)Updates one or more attributes, including consistency check
- clean_data(pop_cols)¶
Removes all data columns except for the index and the populations data.
- Returns:
- None.
- get_data()¶
Returns the populations data.
This returns a deep copy of the self.data attribute.
- Returns:
- astropy table
The populations data
- update(**kwargs)¶
Updates one or more attributes, including consistency check
- Parameters:
- **kwargsattribute=value pairs
- Returns:
- None.
- Raises:
- ValueError
If class attribute does not exist
Inheritance Diagram¶
