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

File Path Handling: call for consistency #1498

Open
HaleySchuhl opened this issue Apr 19, 2024 · 0 comments
Open

File Path Handling: call for consistency #1498

HaleySchuhl opened this issue Apr 19, 2024 · 0 comments
Labels
update Updates an existing feature/method

Comments

@HaleySchuhl
Copy link
Contributor

HaleySchuhl commented Apr 19, 2024

Is your feature request related to a problem? Please describe.
In the case of pcv.io.read_dataset the argument is named source_path, but in the case of pcv.transform.checkerboard_calib the argument is named img_path. In two other plantcv functions, pcv.transform.merge_images, pcv.visualize.pixel_scatter_plot, pcv.visualize.time_lapse_video, and pcv.segment_image_series uses slightly different logic where the arguments is paths_to_imgs, paths_to_imgs, img_list, and imgs_paths respectively and in all these cases, the user is expected to provide a list of filepaths rather than putting all input images into a single directory.

Describe the solution you'd like
I personally think it's more user friendly to have the function take a directory rather than using pcv.io.read_dataset prior to running functions that take more than one image as input. I also think img_dir is succinct while descriptive but definitely open to discussion.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context, sample data, or code relevant to the feature request here.

@HaleySchuhl HaleySchuhl added the update Updates an existing feature/method label Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
update Updates an existing feature/method
Projects
None yet
Development

No branches or pull requests

1 participant