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

FILT: Add Oxford Channel 5 Binary file reader. #1126

Merged

Conversation

imikejackson
Copy link
Contributor

@imikejackson imikejackson commented Nov 3, 2024

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

- Requires EbsdLib 1.0.35 or higher
- Filter requires BOTH .cpr and .crc files to be present

Open Data set was used for testing.

Miranda, Elena (2018), “McGinn and Miranda EBSD data for 17NZ41 (untwinned) and 17NZ42 (Dauphine twinned)”, Mendeley Data, V1, doi: 10.17632/dg7kv5mcv3.1

[https://data.mendeley.com/datasets/dg7kv5mcv3/1](https://data.mendeley.com/datasets/dg7kv5mcv3/1)

Signed-off-by: Michael Jackson <[email protected]>
@imikejackson imikejackson enabled auto-merge (squash) November 11, 2024 15:18
@imikejackson imikejackson merged commit 725b356 into BlueQuartzSoftware:develop Nov 11, 2024
7 checks passed
@imikejackson imikejackson deleted the filter/cpr_crc_reader branch November 11, 2024 16:22
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.

2 participants