Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Phantom Explanation section #395

Open
pvillacorta opened this issue May 30, 2024 · 1 comment · May be fixed by #495
Open

Add Phantom Explanation section #395

pvillacorta opened this issue May 30, 2024 · 1 comment · May be fixed by #495
Labels
1) high priority documentation Improvements to docs., it also triggers doc preview

Comments

@pvillacorta
Copy link
Collaborator

pvillacorta commented May 30, 2024

Explanations: Add "Phantom" section, with the following subsections:

  • Phantom structure
  • Motion: by the moment, SimpleMotion and simple motion types
  • .phantom file format
@pvillacorta pvillacorta added enhancement New feature or request documentation Improvements to docs., it also triggers doc preview and removed enhancement New feature or request labels May 30, 2024
@pvillacorta
Copy link
Collaborator Author

pvillacorta commented Sep 19, 2024

AbstractMotion:

  • struct NoMotion
  • struct MotionList (The same as an AbstractArray{Motion} but we didn't use arrays, because ... ? we will need to discuss this in the paper)
    • struct Motion (This one makes sense)
      • Action <: AbstractAction
      • TimeSpan <: AbstractTimeSpan
      • SpinSpan <: AbstractSpinSpan (Is the user meant to extend this one?)

Is it like this?

If I don't want to define a list, can I just define obj.motion = Translate(...)?

What function must I define to generate a new AbstractMotion/AbstractAction/...?

If I want to define my new custom motion, should create a new AbstractAction or a new AbstractMotion?

Is ECG triggering possible? #73

Commented by @cncastillo

@pvillacorta pvillacorta mentioned this issue Sep 19, 2024
6 tasks
@pvillacorta pvillacorta linked a pull request Oct 9, 2024 that will close this issue
@pvillacorta pvillacorta linked a pull request Oct 9, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1) high priority documentation Improvements to docs., it also triggers doc preview
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants