sunpy / sunkit-image

A image processing toolbox for Solar Physics
https://docs.sunpy.org/projects/sunkit-image/en/stable/
BSD 2-Clause "Simplified" License
35 stars 46 forks source link

One of these functions is not like the others #220

Open GillySpace27 opened 4 months ago

GillySpace27 commented 4 months ago

Basically, in the sunkit-image.radial module, the exported functions are all "full, stand-alone" algorithms except for the "set attenuation coefficients" function, which is just a helper for the FNRGF algorithm.

`all = ["fnrgf", "intensity_enhance", "set_attenuation_coefficients", "nrgf", "rhef"]

I would suggest that the parameters could just be passed in as arguments to the main algorithm, rather than having an extra public function. Could also be handled by importing from the utils file, for ease of understanding.

https://github.com/sunpy/sunkit-image/blob/f7df5023d1b1a97b2433ae8439083058d041158d/sunkit_image/radial.py#L13-L18

### Tasks
nabobalis commented 4 months ago

Yeah, that is good idea!