Consider multiple scans on the same confined phase space.

[RubelMozumder]

Two new base claases:

1. NXscan_region -> Mainly all fields are from mesh_scan group of NXscan_control
2. NXscan_pattern -> Handles common fields from all types of scan patterns like mesh_SCAN, snake_SCAN, spiral_SCAN, and so on.
3. Addition of some new fields considering multiple scans on the same region.

Summary by Sourcery

Enhance the NXscan_control definition to support multiple scans on the same confined phase space by adding new fields for scan repetition and ordering.

New Features:

• Add support for repeated scans over the same scan region
• Introduce a scan order parameter to distinguish between multiple scans in the same region

Enhancements:

• Improve scan metadata by adding fields to track scan repetitions and ordering

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces new fields to the NXscan_control definition, enabling support for repeated scans over the same confined phase space. It also comments out several scan groups.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added fields to support repeated scans over the same region with distinguishing parameters.	Added a repeats field to indicate if the scan is repeated. Added a scan_order field to specify the order of repeated scans. Added a NOTE group to include notes for individual scans or scan orders.	contributed_definitions/NXscan_control.nxdl.xml contributed_definitions/nyaml/NXscan_control.yaml
Commented out several scan groups.	Commented out the spiral_SCAN group. Commented out the snake_SCAN group. Commented out the traj_SCAN group. Commented out the linear_SCAN group.	contributed_definitions/NXscan_control.nxdl.xml contributed_definitions/nyaml/NXscan_control.yaml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[RubelMozumder]

This is the start of the discussion for issue #371.

[RubelMozumder]

Refactor the app definitions according to the changes in the base classes.

[mkuehbach]

@RubelMozumder we need to think what we would like to propose to the NIAC if anything of this or if we want to have the generic NXscan class for us on the fairmat branch. If we use it in fairmat the question is in which techniques, mpes, opt, and soon apm and em will have been accepted and there is at the moment not a super priority to change them immediately so fundamentally as that we replace each scan pattern in all of these appdefs with the proposal that is made her.

So we should focus, my suggestion is that you either:
Work this NXscan idea out and use it in the NXspm proposal towards the NIAC or we focus on the NXspm proposal making without such generalized NXscan for now

[RubelMozumder]

@rettigl @lukaspie, is there any suggestion in schemas, if you want the modification or any extension in this PR? I will bring bring this change to the spm definition with respect to your feedback.

[lukaspie]

@rettigl @lukaspie, is there any suggestion in schemas, if you want the modification or any extension in this PR? I will bring bring this change to the spm definition with respect to your feedback.

Given that this was mostly requested by @rettigl, I would defer to him here. However, this will probably take a while because of the proposal.