from __future__ import annotations
from abc import abstractmethod
from typing import TYPE_CHECKING, Any
import numpy as np
from numpy.random import Generator
from cratermaker.constants import FloatLike
from cratermaker.core.base import ComponentBase, import_components
if TYPE_CHECKING:
from cratermaker.components.projectile import Projectile
from cratermaker.components.target import Target
[docs]
class Scaling(ComponentBase):
"""
The abstract base class for all scaling models. It defines the interface for converting between projectile and crater diameters.
"""
_registry: dict[str, Scaling] = {}
def __init__(
self,
target: Target | str | None = None,
projectile: Projectile | str | None = None,
rng: Generator | None = None,
rng_seed: int | None = None,
rng_state: dict | None = None,
**kwargs: Any,
):
"""
**Warning:** This object should not be instantiated directly. Instead, use the ``.maker()`` method.
Parameters
----------
target : Target | str, default="Moon"
The target body for the impact. Can be a Target object or a string representing the target name.
projectile : Projectile | str, default="asteroids"
The projectile model for the impact. Can be an Projectile object or a string representing the projectile name.
rng : numpy.random.Generator | None
|rng|
rng_seed : Any type allowed by the rng_seed argument of numpy.random.Generator, optional
|rng_seed|
rng_state : dict, optional
|rng_state|
**kwargs : Any
|kwargs|
"""
from cratermaker.components.projectile import Projectile
from cratermaker.components.target import Target
super().__init__(rng=rng, rng_seed=rng_seed, rng_state=rng_state, **kwargs)
object.__setattr__(self, "_target", None)
object.__setattr__(self, "_projectile", None)
# combine the kwargs with the common_args, giving common_args priority
kwargs = {**kwargs, **vars(self.common_args)}
self._target = Target.maker(target, **kwargs)
self._projectile = Projectile.maker(projectile, target=self.target, **kwargs)
[docs]
@classmethod
def maker(
cls,
scaling: str | Scaling | None = None,
target: Target | str | None = None,
projectile: Projectile | str | None = None,
rng: Generator | None = None,
rng_seed: int | None = None,
rng_state: dict | None = None,
**kwargs: Any,
) -> Scaling:
"""
Initialize a Scaling model with the given name or instance.
Parameters
----------
scaling : str, Scaling, or None, default=None
The name of the scaling model to initialize. If None, the default model is used.
target : Target | str, default="Moon"
The target body for the impact. Can be a Target object or a string representing the target name.
projectile : Projectile | str, default="asteroids"
The projectile model for the impact. Can be an Projectile object or a string representing the projectile name.
rng : numpy.random.Generator | None
|rng|
rng_seed : Any type allowed by the rng_seed argument of numpy.random.Generator, optional
|rng_seed|
rng_state : dict, optional
|rng_state|
**kwargs : Any
|kwargs|
Returns
-------
Scaling
An instance of the specified scaling model.
Raises
------
KeyError
If the specified scaling model name is not found in the registry.
TypeError
If the specified scaling model is not a string or a subclass of Scaling.
"""
if scaling is None:
scaling = "montecarlo"
scaling = super().maker(
component=scaling,
target=target,
projectile=projectile,
rng=rng,
rng_seed=rng_seed,
rng_state=rng_state,
**kwargs,
)
if projectile is not None:
scaling.projectile = projectile
if target is not None:
scaling.target = target
return scaling
[docs]
@abstractmethod
def projectile_to_transient(self, **kwargs: Any) -> np.float64: ...
[docs]
@abstractmethod
def transient_to_projectile(self, **kwargs: Any) -> np.float64: ...
[docs]
@abstractmethod
def transient_to_final(self, transient_diameter: FloatLike, **kwargs: Any) -> tuple[np.float64, str]: ...
[docs]
@abstractmethod
def final_to_transient(self, final_diameter: FloatLike, morphology_type: str | None = None, **kwargs: Any) -> np.float64: ...
[docs]
@abstractmethod
def recompute(self, **kwargs: Any) -> None: ...
def __str__(self) -> str:
str_repr = super().__str__()
str_repr += f"Target: {self.target.name}\n"
str_repr += f"Projectile: <{self.projectile.component_name}>\n"
return str_repr
@property
def target(self):
"""The Target object associated with this Scaling object."""
return self._target
@target.setter
def target(self, value):
from cratermaker.components.target import Target
self._target = Target.maker(value, **vars(self.common_args))
return
@property
def projectile(self):
"""The Projectile object associated with this Scaling object."""
return self._projectile
@projectile.setter
def projectile(self, value):
from cratermaker.components.projectile import Projectile
self._projectile = Projectile.maker(value, **vars(self.common_args))
return
@property
def model(self):
"""The name of the scaling model."""
return self._component_name
import_components(__name__, __path__)
