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

Export Use Case #77

Open
jacksonjacobs1 opened this issue Feb 24, 2025 · 0 comments
Open

Export Use Case #77

jacksonjacobs1 opened this issue Feb 24, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request v2.0 Pertains to the v2.0 branch

Comments

@jacksonjacobs1
Copy link
Collaborator

Feature: Export Ground Truths

Pages

  • Project Page
  • Annotation Page

Preconditions

  • At least one ground truth annotation has been committed.

Postconditions

  • One GeoJSON file per image containing annotations is saved.
  • At least one mask file is saved.

User Experience

Export Button

  • The project page and the annotation page each have an Export button.
  • Clicking the button opens an Export Modal.

Export Modal

  • The modal contains a radio selection with three options:

    1. Save Locally
    2. Save Remotely
    3. Push to Digital Slide Archive
  • The form elements displayed are conditional based on the selected option.

Save Locally

Displays the following form fields:

  • Annotations Export Format (Dropdown)
    • Options: GeoJSON
  • Metrics Export Format (Dropdown)
    • Options: Do not export metrics, Within GeoJSON properties, TSV
  • Export button

Save Remotely

Displays the following form fields:

  • Save Path (Text input)
    • The root of this path is within the /data directory.
  • All other form fields are identical to the Save Locally option.

Push to Digital Slide Archive

Displays the following form fields:

  • API Key (Text input)
  • Collection Name (Text input)
  • Folder Name (Text input)
  • Export button

Acceptance Criteria

  • The export button should be available on both the project and annotation pages.
  • The export modal should display the correct form fields based on the selected export option.
  • The system should generate a GeoJSON file per image with annotations.
  • At least one mask file should be saved.
  • The Save Remotely option should correctly save to a path within /data.
  • The Push to Digital Slide Archive option should correctly send data using the provided API key.

Additional Notes

  • Consider validation for required fields before allowing export.
  • Ensure error handling for API failures or incorrect file paths.
  • Prioritize export functionality in the project page over the annotation page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v2.0 Pertains to the v2.0 branch
Projects
None yet
Development

No branches or pull requests

2 participants