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

BUG/API: Histogram Sync #1073

Merged
merged 25 commits into from
Sep 26, 2024

Conversation

nyoungbq
Copy link
Contributor

@nyoungbq nyoungbq commented Sep 17, 2024

fixes #1044

Naming Conventions

Naming of variables should descriptive where needed. Loop Control Variables can use i if warranted. Most of these conventions are enforced through the clang-tidy and clang-format configuration files. See the file simplnx/docs/Code_Style_Guide.md for a more in depth explanation.

Filter Checklist

The help file simplnx/docs/Porting_Filters.md has documentation to help you port or write new filters. At the top is a nice checklist of items that should be noted when porting a filter.

Unit Testing

The idea of unit testing is to test the filter for proper execution and error handling. How many variations on a unit test each filter needs is entirely dependent on what the filter is doing. Generally, the variations can fall into a few categories:

  • 1 Unit test to test output from the filter against known exemplar set of data
  • 1 Unit test to test invalid input code paths that are specific to a filter. Don't test that a DataPath does not exist since that test is already performed as part of the SelectDataArrayAction.

Code Cleanup

  • No commented out code (rare exceptions to this is allowed..)
  • No API changes were made (or the changes have been approved)
  • No major design changes were made (or the changes have been approved)
  • Added test (or behavior not changed)
  • Updated API documentation (or API not changed)
  • Added license to new files (if any)
  • Added example pipelines that use the filter
  • Classes and methods are properly documented

@nyoungbq nyoungbq marked this pull request as ready for review September 24, 2024 13:59
@nyoungbq nyoungbq requested a review from JDuffeyBQ September 24, 2024 13:59
@nyoungbq nyoungbq requested a review from JDuffeyBQ September 25, 2024 16:01
@imikejackson imikejackson self-requested a review September 25, 2024 21:01
@nyoungbq nyoungbq merged commit 7b73128 into BlueQuartzSoftware:develop Sep 26, 2024
7 checks passed
@nyoungbq nyoungbq deleted the bug/histogram_sync branch September 26, 2024 11:05
imikejackson pushed a commit to imikejackson/simplnx that referenced this pull request Oct 20, 2024
* Add HistogramUtilities File
* Integrated Histogram API into Compute Array Statistics and Compute Array Histogram
* complete extensive documentation for histogram utilities
* Update test case to reflect new histogram that produces results inline with plot.ly histogram
* repair broken pipelines after key updates
* Added a size() function to IDataStore for std::vector compatibility
* Update CalculateBin for special bool case

---------

Co-authored-by: Jared Duffey <[email protected]>
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.

Histogram Generation between 2 filters do not agree
3 participants