Skip to content

Commit

Permalink
fixes javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
lacan committed Nov 25, 2024
1 parent 02efdc8 commit bf6e6e7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/main/java/ch/epfl/biop/operetta/OperettaManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,7 @@ public ImagePlus getWellImage(Well well) {
* Returns a stitched stack for the given well and associated fields
*
* @param well the well to export
* @param fields the fields that we want to use for this well
* @param bounds a ROI describing the subregion we want to export (pixel coordinates)
* @return an ImageStack
*/
Expand Down Expand Up @@ -794,6 +795,8 @@ private ImageProcessor openTiffFileAsImageProcessor(String id) {
/**
* Processes all fields in the selected wells based on the desired builder options.
* @see OperettaManager.Builder
*
* @param wells the list of Wells we want to process
*/
public void process(List<Well> wells) { process( wells, null, null ); }

Expand Down Expand Up @@ -1294,7 +1297,7 @@ public Builder coordinatesCorrectionFactor(double correction_factor) {
/**
* Set the downsampling from the builder
*
* @param downsample a downsample factor > 1 explaining by how much we should reduce the XY image
* @param downsample a downsample factor &gt; 1 explaining by how much we should reduce the XY image
* @return a Builder object, to continue building parameters
*/
public Builder setDownsample(int downsample) {
Expand All @@ -1316,6 +1319,7 @@ public Builder useAveraging( boolean use_averaging) {
* Optional: adds a way to monitor the progression of a process using scijava TaskService
*
* @param taskService a service that monitors the progression of a process
* @return this Builder, to continue building options
*/
public Builder setTaskService(TaskService taskService) {
this.taskService = taskService;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,7 @@ public void doProcess() {
/**
* Returns the available Fields as a String list with format [Field #, Field #,...]
*
* @param opm the {@link OperettaManager} instance to use
* @return a list of field ids as Strings
*/
public List<String> getAvailableFieldsString(OperettaManager opm ) {
Expand All @@ -447,6 +448,7 @@ public List<String> getAvailableFieldsString(OperettaManager opm ) {
/**
* Returns the available Wells as a String list with format [R#-C#, R#-C#,...]
*
* @param opm the {@link OperettaManager} instance to use
* @return aa list of Strings with the Well names
*/
public List<String> getAvailableWellsString(OperettaManager opm ) {
Expand Down

0 comments on commit bf6e6e7

Please sign in to comment.