Skip to content

Commit

Permalink
remove "models" from public API in model fitting
Browse files Browse the repository at this point in the history
* deprecation warning already exists for the old helper methods, and plugin APIs have not been released yet, so no need to add deprecations here
  • Loading branch information
kecnry committed Feb 19, 2025
1 parent 02b73db commit 1ec16ab
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 7 deletions.
31 changes: 30 additions & 1 deletion jdaviz/configs/default/plugins/model_fitting/model_fitting.py
Original file line number Diff line number Diff line change
Expand Up @@ -852,7 +852,7 @@ def get_models(self, models=None, model_label=None, x=None, y=None):

return selected_models

def get_model_parameters(self, models=None, model_label=None, x=None, y=None):
def _get_model_parameters(self, models=None, model_label=None, x=None, y=None):
"""
Convert each parameter of model inside models into a coordinate that
maps the model name and parameter name to a `astropy.units.Quantity`
Expand Down Expand Up @@ -987,6 +987,35 @@ def get_model_parameters(self, models=None, model_label=None, x=None, y=None):

return parameters_cube

def get_model_parameters(self, model_label=None, x=None, y=None):
"""
Convert each parameter of model inside models into a coordinate that
maps the model name and parameter name to a `astropy.units.Quantity`
object.
Parameters
----------
model_label : str
Get model parameters for a particular model by inputting its label.
x : int
The x coordinate of the model spaxels that will be returned from
get_models.
y : int
The y coordinate of the model spaxels that will be returned from
get_models.
Returns
-------
:dict: a dictionary of the form
{model name: {parameter name: [[`astropy.units.Quantity`]]}}
for 3d models or
{model name: {parameter name: `astropy.units.Quantity`}} where the
Quantity object represents the parameter value and unit of one of
spaxel models or the 1d models, respectively.
"""
return self._get_model_parameters(models=None, model_label=model_label,
x=x, y=y)

def vue_add_model(self, event):
self.create_model_component()

Expand Down
12 changes: 6 additions & 6 deletions jdaviz/core/helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ def get_models(self, models=None, model_label=None, x=None, y=None):
plg = self.plugins.get('Model Fitting', None)
if plg is None:
raise ValueError("Model Fitting plugins is not loaded")
return plg.get_models(models=models,
model_label=model_label,
x=x, y=y)
return plg._obj.get_models(models=models,
model_label=model_label,
x=x, y=y)

@deprecated(since="4.2")
def get_model_parameters(self, models=None, model_label=None, x=None, y=None):
Expand Down Expand Up @@ -248,9 +248,9 @@ def get_model_parameters(self, models=None, model_label=None, x=None, y=None):
plg = self.plugins.get('Model Fitting', None)
if plg is None:
raise ValueError("Model Fitting plugins is not loaded")
return plg.get_model_parameters(models=models,
model_label=model_label,
x=x, y=y)
return plg._obj.get_model_parameters(models=models,
model_label=model_label,
x=x, y=y)

def show(self, loc="inline", title=None, height=None): # pragma: no cover
"""Display the Jdaviz application.
Expand Down

0 comments on commit 1ec16ab

Please sign in to comment.