Utils (discO.utils)

Utilities.

Vector Fields

Vector Field.

This is some documentation.

An example construction.

Reference/API

discO.utils Package

Functions

resolve_framelike(frame[, error_if_not_type])	Determine the frame and return a blank instance.
resolve_representationlike(representation[, ...])	Determine the representation and return the class.

Classes

UnFrame(*args[, copy, representation_type, ...])	Unconnected Coordinate Frame.
NumpyRNGContext(seed)	A context manager (for use with the with statement) that will seed the numpy random number generator (RNG) to a specific value, and then restore the RNG state back to whatever it was before.
BaseVectorField(points, *args[, frame])	Base Vector-Field.
CartesianVectorField(points, vf_x[, vf_y, ...])	Cartesian Vector Field.
CylindricalVectorField(points, vf_rho[, ...])	Cylindrical Vector Field.
SphericalVectorField(points, vf_lon[, ...])	Spherical Vector Field.
PhysicsSphericalVectorField(points, vf_phi)	PhysicsSpherical Vector Field.

Class Inheritance Diagram

digraph inheritance2e82d878d2 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseCoordinateFrame" [URL="https://docs.astropy.org/en/stable/api/astropy.coordinates.BaseCoordinateFrame.html#astropy.coordinates.BaseCoordinateFrame",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The base class for coordinate frames."]; "ShapedLikeNDArray" -> "BaseCoordinateFrame" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseRepresentationOrDifferential" [URL="https://docs.astropy.org/en/stable/api/astropy.coordinates.BaseRepresentationOrDifferential.html#astropy.coordinates.BaseRepresentationOrDifferential",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="3D coordinate representations and differentials."]; "ShapedLikeNDArray" -> "BaseRepresentationOrDifferential" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseVectorField" [URL="../api/discO.utils.BaseVectorField.html#discO.utils.BaseVectorField",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base Vector-Field."]; "BaseRepresentationOrDifferential" -> "BaseVectorField" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CartesianVectorField" [URL="../api/discO.utils.CartesianVectorField.html#discO.utils.CartesianVectorField",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Cartesian Vector Field."]; "BaseVectorField" -> "CartesianVectorField" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CylindricalVectorField" [URL="../api/discO.utils.CylindricalVectorField.html#discO.utils.CylindricalVectorField",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Cylindrical Vector Field."]; "BaseVectorField" -> "CylindricalVectorField" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NDArrayShapeMethods" [URL="https://docs.astropy.org/en/stable/api/astropy.utils.shapes.NDArrayShapeMethods.html#astropy.utils.shapes.NDArrayShapeMethods",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mixin class to provide shape-changing methods."]; "NumpyRNGContext" [URL="../api/discO.utils.NumpyRNGContext.html#discO.utils.NumpyRNGContext",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A context manager (for use with the ``with`` statement) that will seed the"]; "PhysicsSphericalVectorField" [URL="../api/discO.utils.PhysicsSphericalVectorField.html#discO.utils.PhysicsSphericalVectorField",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="PhysicsSpherical Vector Field."]; "BaseVectorField" -> "PhysicsSphericalVectorField" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ShapedLikeNDArray" [URL="https://docs.astropy.org/en/stable/api/astropy.utils.shapes.ShapedLikeNDArray.html#astropy.utils.shapes.ShapedLikeNDArray",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mixin class to provide shape-changing methods."]; "NDArrayShapeMethods" -> "ShapedLikeNDArray" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SphericalVectorField" [URL="../api/discO.utils.SphericalVectorField.html#discO.utils.SphericalVectorField",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Spherical Vector Field."]; "BaseVectorField" -> "SphericalVectorField" [arrowsize=0.5,style="setlinewidth(0.5)"]; "UnFrame" [URL="../api/discO.utils.UnFrame.html#discO.utils.UnFrame",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Unconnected Coordinate Frame. Does not support transformations."]; "BaseCoordinateFrame" -> "UnFrame" [arrowsize=0.5,style="setlinewidth(0.5)"]; }