deepanshs / mrsimulator

A fast solid-state NMR spectrum simulation and analysis library.
https://mrsimulator.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
34 stars 13 forks source link

Distinguish overlapping class names in the signal_processor module #243

Closed mgiammar closed 1 year ago

mgiammar commented 1 year ago

Some of the operations available throughout the signal processor module have duplicate names but different inheritance patterns/uses. For example:

These two classes perform distinct and useful functions, but share the same name which will cause confusion. Class names, descriptions, and documentation should be updated to remove any ambiguity before version 0.8 is released.

Additionally, the ComplexConjugate class should be implemented for convenience sake.

mgiammar commented 1 year ago

Should not be confusion between the sp.Scale and sp.affine.Scale operations. Additionally, the ComplexConjugate operation can be done natively with csdmpy.