Your first analysis
This guide takes one image through analysis, review and Excel export. Use a small representative region for the first check. For analysis without drawing ROIs, follow Whole-slide analysis.
You need a saved QuPath project, a calibrated image and an installed module intended for your tissue, stain and species. Hover over the top-right status dot and check that its tooltip says Connected. See Install and connect if setup is incomplete, or Choose and install a module if none is installed. Follow the image-plane requirements when working with a z-stack or time series.
A module without measurements still produces analysis objects. You can follow this guide through reviewing those objects; the measurement and Excel-export steps apply only to modules that define measurements.
Choose an image and module
Open the image in QuPath.
In HistoForge’s Project tab, check the box beside that image. Leave other images unchecked.
Select Set Module and choose your installed module.
Its name appears in the Module column. If the row says not installed, install that module or choose an installed one before continuing.
Choose an analysis region
A region of interest (ROI) specifies the area to analyze. Draw a HistoForge rectangle or use areas you have already outlined in QuPath. Choose one of the following methods.
Draw a HistoForge ROI
In the Draw ROI controls, set the width, height and unit.
Select the HistoForge ROI tool in QuPath’s toolbar.
Click on the tissue to place a rectangle of that size. You can also drag to draw a rectangle.
Select Save Project & Refresh in HistoForge.
Set Scope to HistoForge ROIs.
The first ROI on an image appears as a cyan annotation named ROI 1. The annotation is locked, and the image row should report one ROI after saving. Check its position and size before running the analysis.
HistoForge ROIs must not overlap. Each side must be between 1,024 and 6,000 full-resolution image pixels. If the ROI is rejected or the save fails, correct the reported problem before continuing.
Use existing annotations
Give the area annotations you want to analyze a dedicated QuPath class, such as Analysis region.
Select Save Project & Refresh.
Set Scope to Annotations by class.
Choose that class in Annotation class.
This includes all matching area annotations on the checked image, not just the highlighted one. Their outlines must stay inside the image and must not overlap. HistoForge locks and saves the selected boundaries before inference. See annotation selection rules for supported shapes and changing a boundary later.
Run the analysis
Save your edits before starting and avoid editing objects on this image while analysis runs.
Keep the image checked.
Keep the Scope and, if used, Annotation class chosen above.
Leave the model selector at All models.
Select Fill and wait for the operation to finish.
Fill runs missing model output. Progress appears below the image table. On a first successful run that creates objects, Last Run shows Saved, and the classified objects appear in QuPath.
With All models selected, the analysis includes the recipe’s processing scripts and any measurements. A separate Metrics click is not required after a successful analysis. See Actions and results before selecting individual models or replacing existing output.
If the row reports Failed, Conflict or Partial, read its full message before proceeding. These are not complete results; see Troubleshooting.
Review the result
Review the predictions against the tissue and the module’s documented classes using your study’s review procedure. Corrections are optional. If needed, edit the objects in QuPath and save with Save Project & Refresh.
If the model consistently misses a relevant class or misidentifies structures, do not use its measurements unchanged. Correct the annotations, choose a better-suited module, or consider fine-tuning with reviewed examples.
Review measurements
For a module that defines measurements, the tables appear in Project after a successful analysis. Check their labels and units against the module documentation.
If you changed objects, keep the image checked and select Metrics to recalculate the displayed values without rerunning the models. Earlier values do not describe the edited result. Export also recalculates measurements when needed; neither action reruns processing scripts.
Export to Excel
Keep the reviewed image checked, with the same Scope and annotation class used for analysis.
Select Export and save the Excel file as
metrics.xlsx.Wait for the export confirmation, then open the file in Excel or another
.xlsxreader.
Check the image name, module, units and region coverage. See Export to Excel for the workbook sheets and study groups.
Review this first result before selecting more images. Before moving to larger regions or whole slides, check the image preparation limits.