Skip to content

Commit

Permalink
docs: rewrite docs
Browse files Browse the repository at this point in the history
  • Loading branch information
EscapedGibbon committed Jun 14, 2024
1 parent 711c0d0 commit 49de559
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/Stack.ts
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ export class Stack {
return sum(this);
}
/**
* Computes average grayscale value of each region of interest for each image.
* @returns map object with average image values for each ROI.
* Find a `maxImage` of the stack, then get a map object where keys are `roi.id`s and values are arrays of average values of each ROI in each image.
* @returns map object with `roi.id`s and their average values in the stack.
*/
public roiMeanValues() {
return roiMeanValues(this);
Expand Down
4 changes: 2 additions & 2 deletions src/stack/compute/roiMeanValues.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ import { Stack } from '../../Stack';
import { fromMask } from '../../roi';

/**
* Computes average grayscale value of each region of interest for each image.
* Find a `maxImage` of the stack, then get a map object where keys are `roi.id`s and values are arrays of average values of each ROI in each image.
* @param stack - Stack of images.
* @returns map object with average image values for each ROI.
* @returns map object with `roi.id`s and their average values in the stack.
*/
export function roiMeanValues(stack: Stack) {
if (stack.colorModel !== 'GREY') {
Expand Down

0 comments on commit 49de559

Please sign in to comment.