Evaluation

This module defines abstract base classes for evaluation classes to be defined in subpackages. Evaluation classes must implement a "measure" property and a "plot" method to work with the analysis classes.

Evaluation

Class representing an evaluation of an orbit's commensurability.

This class defines methods for evaluating an orbit and generating plots.

Source code in commensurability/evaluation.py

class Evaluation:
    """
    Class representing an evaluation of an orbit's commensurability.

    This class defines methods for evaluating an orbit and generating plots.
    """

    def __init__(self, orbit: c.SkyCoord):
        """
        Initialize Evaluation object.

        Args:
            orbit: Orbit to be evaluated.
        """
        self.orbit = orbit

    def __reduce__(self):
        return self.__class__, (self.orbit,)

    @property
    @abstractmethod
    def measure(self) -> float:
        """
        Get the evaluation value.

        Returns:
            Measure of the evaluation.
        """
        pass

    @abstractmethod
    def plot(self):
        """
        Create a plot of the evaluation.
        """
        pass

measure: float abstractmethod property

Get the evaluation value.

Returns:

Type	Description
float	Measure of the evaluation.

__init__(orbit)

Initialize Evaluation object.

Parameters:

Name	Type	Description	Default
orbit	SkyCoord	Orbit to be evaluated.	required

Source code in commensurability/evaluation.py

def __init__(self, orbit: c.SkyCoord):
    """
    Initialize Evaluation object.

    Args:
        orbit: Orbit to be evaluated.
    """
    self.orbit = orbit

plot() abstractmethod

Create a plot of the evaluation.

Source code in commensurability/evaluation.py

@abstractmethod
def plot(self):
    """
    Create a plot of the evaluation.
    """
    pass