Reference/API¶
ndcube Package¶
Classes¶
|
|
|
|
|
A class for holding and manipulating a collection of aligned NDCube or NDCubeSequences. |
Class Inheritance Diagram¶
ndcube.mixins Package¶
Classes¶
Add plotting functionality to a NDCube class. |
|
Mixin to provide slicing on objects using the |
Class Inheritance Diagram¶
ndcube.utils Package¶
ndcube.utils.cube Module¶
Utilities for ndcube.
Functions¶
|
Converts a wcs axis number to the corresponding data axis number. |
|
Converts a data axis number to the corresponding wcs axis number. |
|
Returns indices of the correct data order axis priority given a list of WCS CTYPEs. |
Converts NDCube.extra_coords attribute to format required as input for new NDCube. |
|
|
Returns axis number (numpy ordering) given a substring unique to a world axis type string. |
ndcube.utils.sequence Module¶
Utilities for ndcube sequence.
Functions¶
|
Slice an NDCubeSequence given a slicing/index item. |
Converts NDCubeSequence __getitem__ item to list of SequenceSlice objects. |
|
Converts an input item to NDCubeSequence.index_as_cube to a list od SequenceSlice objects. |
|
|
Converts None types within a slice to the appropriate ints based on object to be sliced. |
Classes¶
|
Define SequenceSlice named tuple of length 2. |
|
Define SequenceItem named tuple of length 2. |
Class Inheritance Diagram¶
ndcube.utils.wcs Module¶
Miscellaneous WCS utilities.
Functions¶
|
Re-index a WCS given indices. |
|
Given a data axis index, return indices of dependent data axes. |
|
Given a data axis index, return indices of dependent data axes. |
|
Return True/False matrix indicating which WCS axes are dependent on others. |
|
Appends a 1-to-1 dummy axis to a WCS object. |
Classes¶
|
Initiates a WCS object with additional functionality to add dummy axes. |
Class Inheritance Diagram¶
ndcube.tests.helpers Module¶
Helpers for testing ndcube.
Functions¶
|
|
|
|
|
|
|
|
|
Assert function for testing two wcs object. |