GridResidual¶

class discO.GridResidual(*args, method: str | None = None, **kwargs)[source]¶

Residual on a grid.

Parameters:

gridBaseCoordinateFrame or SkyCoord: The grid on which to evaluate the residual. Mandatory.
original_potential: object or :class:`~PotentialWrapper` or None (optional): The potential. If not already a PotentialWrapper, it is wrapped: this means that the frame is UnFrame. When evaluating the residual, the grid can only be frame-like if this has a frame (is not UnFrame).
observablestr (optional): name of method in PotentialWrapper.

Other Parameters:

representation_typerepresentation-resolvable (optional, keyword-only): The output representation type. If None, resolves to PotentialWrapper.base_representation
**kwargs: default arguments into evaluate_potential.

Methods Summary

evaluate_potential(potential[, observable, ...])

Evaluate method on potential.

Methods Documentation

Evaluate method on potential.

Parameters:

potentialobject or PotentialWrapper: The potential. If not already a PotentialWrapper, it is wrapped: this means that the frame is UnFrame.
observablestr: name of method in PotentialWrapper. If None (default), uses default value – .observable.
representation_type: representation-resolvable (optional, keyword-only): The output representation type. If None (default), uses default representation point.
**kwargs: Passed to method in PotentialWrapper. First mixed in with default_params (preferring kwargs).

Returns:

Other Parameters:

pointsframe-like or BaseRepresentation (optional, keyword-only): Not recommended, but allowed, to force the points on which the residual is calculated. The points can only be frame-like if the frame of the potentials is not UnFrame. If not specified, and it shouldn’t be, uses points determined by the class at initialization.