This is the documentation for the import-level namespace of \(O\).
Reference/API
discO Package
Disk Expansion Project.
Classes
UnFrame(*args[, copy, representation_type, ...])
|
Unconnected Coordinate Frame. |
PotentialWrapper(potential, *[, frame, ...])
|
Base-class for evaluating potentials. |
PotentialSampler(potential, *[, total_mass, ...])
|
Sample a Potential. |
MeshGridPotentialSampler(potential, meshgrid, *)
|
Mesh-Grid Position Distribution. |
MeasurementErrorSampler(*[, c_err, method])
|
Draw a realization given measurement errors. |
RVS_Continuous(*, rvs[, c_err, method])
|
Draw a realization given a scipy.stats.rv_continuous. |
GaussianMeasurementError(*[, c_err, method])
|
Draw a realization given Gaussian measurement errors. |
PotentialFitter(potential_cls, *[, key])
|
Fit a Potential. |
ResidualMethod(*args[, method])
|
Calculate Residual. |
GridResidual(*args[, method])
|
Residual on a grid. |
Pipeline(sampler[, measurer, fitter, ...])
|
Analysis Pipeline. |
PipelineResult(pipe[, sample, measured, ...])
|
Pipeline Evaluation Result.
|
Class Inheritance Diagram
digraph inheritanceb758b61aab {
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)"];
"CommonBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base-class for interfacing with a Potential."];
"GaussianMeasurementError" [URL="../api/discO.GaussianMeasurementError.html#discO.GaussianMeasurementError",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="Draw a realization given Gaussian measurement errors."];
"RVS_Continuous" -> "GaussianMeasurementError" [arrowsize=0.5,style="setlinewidth(0.5)"];
"GridResidual" [URL="../api/discO.GridResidual.html#discO.GridResidual",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="Residual on a grid."];
"ResidualMethod" -> "GridResidual" [arrowsize=0.5,style="setlinewidth(0.5)"];
"MeasurementErrorSampler" [URL="../api/discO.MeasurementErrorSampler.html#discO.MeasurementErrorSampler",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="Draw a realization given measurement errors."];
"CommonBase" -> "MeasurementErrorSampler" [arrowsize=0.5,style="setlinewidth(0.5)"];
"MeshGridPotentialSampler" [URL="../api/discO.core.sample.MeshGridPotentialSampler.html#discO.core.sample.MeshGridPotentialSampler",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="Mesh-Grid Position Distribution."];
"PotentialSampler" -> "MeshGridPotentialSampler" [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."];
"Pipeline" [URL="../api/discO.Pipeline.html#discO.Pipeline",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="Analysis Pipeline."];
"PipelineResult" [URL="../api/discO.PipelineResult.html#discO.PipelineResult",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=":class:`~discO.core.Pipeline` Evaluation Result."];
"recarray" -> "PipelineResult" [arrowsize=0.5,style="setlinewidth(0.5)"];
"PotentialFitter" [URL="../api/discO.PotentialFitter.html#discO.PotentialFitter",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="Fit a Potential."];
"CommonBase" -> "PotentialFitter" [arrowsize=0.5,style="setlinewidth(0.5)"];
"PotentialSampler" [URL="../api/discO.core.sample.PotentialSampler.html#discO.core.sample.PotentialSampler",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="Sample a Potential."];
"CommonBase" -> "PotentialSampler" [arrowsize=0.5,style="setlinewidth(0.5)"];
"PotentialWrapper" [URL="../api/discO.PotentialWrapper.html#discO.PotentialWrapper",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-class for evaluating potentials."];
"RVS_Continuous" [URL="../api/discO.RVS_Continuous.html#discO.RVS_Continuous",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="Draw a realization given a :class:`scipy.stats.rv_continuous`."];
"MeasurementErrorSampler" -> "RVS_Continuous" [arrowsize=0.5,style="setlinewidth(0.5)"];
"ResidualMethod" [URL="../api/discO.ResidualMethod.html#discO.ResidualMethod",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="Calculate Residual."];
"CommonBase" -> "ResidualMethod" [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)"];
"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)"];
"ndarray" [URL="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray",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="ndarray(shape, dtype=float, buffer=None, offset=0,"];
"recarray" [URL="https://numpy.org/doc/stable/reference/generated/numpy.recarray.html#numpy.recarray",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="Construct an ndarray that allows field access using attributes."];
"ndarray" -> "recarray" [arrowsize=0.5,style="setlinewidth(0.5)"];
}