change kwargs in read4stem #166
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CSSFrancis
reviewed
Jan 29, 2026
| **kwargs: dict | ||
| Additional keyword arguments to pass to the Dataset4dstem constructor. | ||
| Additional keyword arguments to pass to the file reader. | ||
|
|
There was a problem hiding this comment.
I'd add sampling, Orgin and Units as Other Parameters:
Suggested change
| Other Parameters | |
| ---------------- | |
| name : str | None, optional | |
| A descriptive name for the dataset. If None, defaults to "4D-STEM dataset" | |
| origin : NDArray | tuple | list | float | int | None, optional | |
| The origin coordinates for each dimension. If None, defaults to zeros | |
| sampling : NDArray | tuple | list | float | int | None, optional | |
| The sampling rate/spacing for each dimension. If None, defaults to ones | |
| units : list[str] | tuple | list | None, optional | |
| Units for each dimension. If None, defaults to ["pixels"] * 4 | |
| signal_units : str, optional | |
| Units for the array values, by default "arb. units" |
| sampling_override = kwargs.pop("sampling", None) | ||
| origin_override = kwargs.pop("origin", None) | ||
| units_override = kwargs.pop("units", None) | ||
|
|
There was a problem hiding this comment.
Suggested change
| name_override = kwargs.pop("name", None) |
| sampling = ( | ||
| sampling_override | ||
| if sampling_override is not None | ||
| else [ax["scale"] for ax in imported_axes] |
There was a problem hiding this comment.
Not all axes have offsets and scales. For example sometimes there will be axes with non-linear scales. Then you can acess the non-linear axis via ax["axis"]
Suggested change
| else [ax["scale"] for ax in imported_axes] | |
| else [ax.get("scale", 1) for ax in imported_axes] |
| "origin", | ||
| [ax["offset"] for ax in imported_axes], | ||
| origin = ( | ||
| origin_override if origin_override is not None else [ax["offset"] for ax in imported_axes] |
There was a problem hiding this comment.
Same as above:
Not sure the policy on logging but you could output a warning that the scale is non-linear.
Suggested change
| origin_override if origin_override is not None else [ax["offset"] for ax in imported_axes] | |
| origin_override if origin_override is not None else [ax.get("offset", 0) for ax in imported_axes] |
| units = kwargs.pop( | ||
| "units", | ||
| ["pixels" if ax["units"] == "1" else ax["units"] for ax in imported_axes], | ||
| units = ( |
There was a problem hiding this comment.
All axes will have units :) and a name. That is the minimal definition.
| array=imported_data["data"], | ||
| sampling=sampling, | ||
| origin=origin, | ||
| units=units, |
There was a problem hiding this comment.
Suggested change
| units=units, | |
| units=units, | |
| name = name, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.