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

Rename UniformGrid to ImageData #4518

Merged
merged 12 commits into from
Jun 11, 2023

Conversation

banesullivan
Copy link
Member

Deprecate UniformGrid to rename it ImageData to be better aligned with VTK data model.

Resolves #3320

Please see #3320 for the original proposal and justification. The sooner we do this, the better.

@banesullivan banesullivan added deprecation Deprecation involved. PRs that deprecate things. breaking-change Changes that break backwards compatibility, especially changed default parameters. labels Jun 9, 2023
@banesullivan banesullivan changed the title UniformGrid -> ImageData Rename UniformGrid to ImageData Jun 9, 2023
@github-actions github-actions bot added the documentation Anything related to the documentation/website label Jun 9, 2023
@codecov
Copy link

codecov bot commented Jun 9, 2023

Codecov Report

Merging #4518 (23bff3f) into main (77d3fa3) will decrease coverage by 0.01%.
The diff coverage is 95.45%.

@@            Coverage Diff             @@
##             main    #4518      +/-   ##
==========================================
- Coverage   95.66%   95.66%   -0.01%     
==========================================
  Files         107      107              
  Lines       21048    21060      +12     
==========================================
+ Hits        20135    20146      +11     
- Misses        913      914       +1     

Copy link
Member

@tkoyama010 tkoyama010 left a comment

Choose a reason for hiding this comment

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

+100 for this change. As a PyVista user, I felt that the name UniformGrid was confusing.

tests/core/test_grid.py Outdated Show resolved Hide resolved
Copy link
Member

@adeak adeak left a comment

Choose a reason for hiding this comment

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

Same question as with DefaultTheme applies: do we want to update the namespace test names? We'd only run into problems if we remove UniformGrid later, before restoring it as a vtkUniformGrid subclass.

pyvista/core/composite.py Outdated Show resolved Hide resolved
pyvista/core/grid.py Outdated Show resolved Hide resolved
pyvista/core/grid.py Outdated Show resolved Hide resolved
pyvista/core/grid.py Outdated Show resolved Hide resolved
tests/core/test_grid.py Outdated Show resolved Hide resolved
tests/core/test_grid.py Outdated Show resolved Hide resolved
tests/core/test_grid.py Outdated Show resolved Hide resolved
pyvista/core/__init__.py Show resolved Hide resolved
banesullivan and others added 6 commits June 10, 2023 13:59
Co-authored-by: Andras Deak <adeak@users.noreply.github.com>
Co-authored-by: Andras Deak <adeak@users.noreply.github.com>
Co-authored-by: Andras Deak <adeak@users.noreply.github.com>
Co-authored-by: Andras Deak <adeak@users.noreply.github.com>
adeak
adeak previously approved these changes Jun 10, 2023
Copy link
Member

@adeak adeak left a comment

Choose a reason for hiding this comment

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

Same question as with DefaultTheme applies: do we want to update the namespace test names? We'd only run into problems if we remove UniformGrid later, before restoring it as a vtkUniformGrid subclass.

Assuming an answer to leave it alone, in line with #4516 (comment).

Thanks @banesullivan, LGTM.

tkoyama010
tkoyama010 previously approved these changes Jun 10, 2023
@tkoyama010 tkoyama010 dismissed stale reviews from adeak and themself via 23bff3f June 11, 2023 21:45
@tkoyama010 tkoyama010 enabled auto-merge (squash) June 11, 2023 21:47
@banesullivan banesullivan merged commit 782e66c into main Jun 11, 2023
24 checks passed
@banesullivan banesullivan deleted the breaking-change/uniform-grid-to-image-data branch June 11, 2023 22:56
This was referenced Jun 23, 2023
harrybraviner added a commit to harrybraviner/XLB that referenced this pull request Dec 8, 2023
pyvists 0.43.0 renames UniformGrid to ImageData. See pyvista/pyvista#4518 for details.
Renamed all instances of this for compatability with pyvista 0.43.
Works with pyvista back to and including 0.40.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change Changes that break backwards compatibility, especially changed default parameters. deprecation Deprecation involved. PRs that deprecate things. documentation Anything related to the documentation/website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

UniformGrid -> ImageData
4 participants