1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# Licensed under a 3-clause BSD style license - see LICENSE.rst
# This module implements the base NDDataBase class.
from __future__ import (absolute_import, division, print_function,
unicode_literals)
from abc import ABCMeta, abstractproperty, abstractmethod
from ..extern import six
__all__ = ['NDDataBase']
@six.add_metaclass(ABCMeta)
class NDDataBase(object):
"""Base metaclass that defines the interface for N-dimensional datasets
with associated meta information used in ``astropy``.
All properties and ``__init__`` have to be overridden in subclasses. See
`NDData` for a subclass that defines this interface on `numpy.ndarray`-like
``data``.
"""
@abstractmethod
def __init__(self):
pass
@abstractproperty
def data(self):
"""The stored dataset.
"""
pass
@abstractproperty
def mask(self):
"""Mask for the dataset.
Masks should follow the ``numpy`` convention that **valid** data points
are marked by ``False`` and **invalid** ones with ``True``.
"""
return None
@abstractproperty
def unit(self):
"""Unit for the dataset.
"""
return None
@abstractproperty
def wcs(self):
"""World coordinate system (WCS) for the dataset.
"""
return None
@abstractproperty
def meta(self):
"""Additional meta information about the dataset.
Should be `dict`-like.
"""
return None
@abstractproperty
def uncertainty(self):
"""Uncertainty in the dataset.
Should have an attribute ``uncertainty_type`` that defines what kind of
uncertainty is stored, such as ``"std"`` for standard deviation or
``"var"`` for variance.
"""
return None
|
