vasca.columns

VASCA column definitions.

This module is currently not in productive use. Using this, the plan is to refactor the tables dictionary module in the future.

Module Contents

Classes

VASCAColumn

Base class describing all parameters of VASCA columns.

Data

field_id

Field source ID number

API

class vasca.columns.VASCAColumn[source]

Base class describing all parameters of VASCA columns.

The parameters defined here, are used to construct the various Table objects to be held by a TableCollection.

Parameters:

  • name (str) – Column Name

  • dtype (str) – Data type of the column data (FITS compliant)

  • unit (str) – Unit of the column data (FITS compliant)

  • default (str) – Default value taken as placeholder during initialization of TableCollection.

  • description (str) – Short description of the column’s content

Example:
>>> dummy_column = VASCAColumn(name="foo", dtype="int32", unit="1", default="-1", description="bar")
>>> dummy_column.to_dict()
{'name': 'foo',
 'dtype': 'int32',
 'unit': '1',
 'default': '-1',
 'description': 'bar'}
name: str = None
dtype: str = None
unit: str = None
default: str = None
description: str = None
to_dict() → dict[str, str][source]

Returns a dictionary representation of the dataclass using dataclasses.asdict().

vasca.columns.field_id = 'VASCAColumn(...)'

Field source ID number