API Reference¶
ndcube Package¶
ndcube¶
A base package for multi-dimensional contiguous and non-contiguous coordinate-aware arrays.
Homepage: https://github.com/sunpy/ndcube
Documentation: https://docs.sunpy.org/projects/ndcube/
Classes¶
|
Class representing N-D data described by a single array and set of WCS transformations. |
|
Class representing a sequence of |
|
Class for holding and manipulating an unordered collection of NDCubes or NDCubeSequences. |
|
A representation of additional world coordinates associated with pixel axes. |
|
A structured representation of coordinate information applicable to a whole NDCube. |
Class Inheritance Diagram¶
ndcube.extra_coords.table_coord Module¶
Classes¶
|
A lookup table based on a |
|
A lookup table created from a |
|
A lookup table made up of |
Class Inheritance Diagram¶
ndcube.mixins Package¶
Classes¶
Mixin to provide slicing on objects using the |
Class Inheritance Diagram¶
ndcube.visualization Package¶
Classes¶
|
Base class for NDCube plotter objects. |
Class Inheritance Diagram¶
ndcube.visualization.mpl_plotter Module¶
Classes¶
|
Provide visualization methods for NDCube which use |
Class Inheritance Diagram¶
ndcube.utils Package¶
ndcube.utils.sequence Module¶
Utilities for ndcube sequence.
Functions¶
Converts a cube-like index for an NDCubeSequence to a sequence index and a common axis index. |
|
|
Convert a tuple for slicing an NDCubeSequence in the cube-like API to a list of SequenceItems. |
Classes¶
|
Define SequenceItem named tuple of length 2. |
Class Inheritance Diagram¶
ndcube.utils.wcs Module¶
Miscellaneous WCS utilities.
Functions¶
|
Calculate the array indices corresponding to each high level world object. |
|
Reflects axis index about center of number of axes. |
|
Given a string representation of a world axis or a numerical array index, convert it to a numerical world index aligning to the position in wcs.world_axis_object_components. |
|
Retrieves the indices of the world axis physical types corresponding to a pixel axis. |
|
Gets the pixel axis indices corresponding to the index of a world axis. |
|
Gets the world axis physical types corresponding to a pixel axis. |
|
Gets the pixel axis indices corresponding to a world axis physical type. |
|
Returns world axis index of a physical type based on WCS world_axis_physical_types. |
|
Find indices of all pixel axes associated with the world axes linked to the input pixel axis. |
|
Find indices of all array axes associated with the world axes linked to the input array axis. |
|
Given a WCS world axis index, return indices of dependent WCS world axes. |
|
Given a world axis physical type, return the dependent physical types including the input type. |
|
Calculate the array indices corresponding to each high level world object. |
|
Validate a list of physical types against the UCD1+ standard |
ndcube.utils.misc Module¶
Functions¶
|
Return unique values in the order they are first encountered in the iterable. |
ndcube.tests.helpers Module¶
Helpers for testing ndcube.
Functions¶
|
A decorator for a test that verifies the hash of the current figure or the returned figure, with the name of the test function as the hash identifier in the library. |
Generate the hash library name for this env. |
|
|
|
|
|
|
|
|
|
|
Assert function for testing two wcs object. |