Skip to content

Conversation

@dbirman
Copy link
Member

@dbirman dbirman commented Jan 27, 2026

This PR introduces Section and Sectioning into Procedures in a backward compatible way (the old Section is now PlanarSection).

@dbirman dbirman linked an issue Jan 27, 2026 that may be closed by this pull request
@dbirman dbirman requested a review from saskiad February 4, 2026 18:53

class Section(DataModel):
"""Description of a slice of brain tissue"""
"""Description of a single section of brain tissue"""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's specify that this should not be used for slices and point to the PlanarSectioning for that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added


output_specimen_id: str = Field(..., title="Specimen ID")
targeted_structure: Optional[BrainStructureModel] = Field(default=None, title="Targeted structure")
includes_surrounding_tissue: Optional[bool] = Field(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it possible to indicate which of these fields will become required in v3.0 (similar to how we mark the deprecated fields)? It might just help to get that information so future upgrades will be easier. (and so we remember to make them required)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather track this with tickets #1723

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users won't see the tickets, so they won't know to include fields that will be required in the future. But, users also don't read the schema ...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to how we do deprecation messages we can also do "v3" messaging so it shows up in the documentation that this will be a required field in the future. If we do that we should do a pass over the whole schema to add those flags everywhere we can find them though. Do you want to open a ticket for that work? We probably have to do it together

Copy link
Collaborator

@saskiad saskiad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just some questions - still remembering how this works

@dbirman dbirman removed the request for review from mekhlakapoor February 5, 2026 00:23
@dbirman dbirman added this pull request to the merge queue Feb 5, 2026
Merged via the queue into dev with commit 4c0a6a3 Feb 5, 2026
5 checks passed
@dbirman dbirman deleted the 1684-chunk-sections-and-handling-multi-slice-mapseq-sections branch February 5, 2026 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Chunk sections and handling multi-slice MAPseq sections

2 participants