Skip to content

Class: OverlayReviewSession ​

Defined in: src/review/OverlayReviewDataset.ts:211

Constructors ​

Constructor ​

ts
new OverlayReviewSession(dataset, options?): OverlayReviewSession;

Defined in: src/review/OverlayReviewDataset.ts:216

Parameters ​

dataset ​

OverlayReviewDataset

options? ​

OverlayReviewSessionOptions = {}

Returns ​

OverlayReviewSession

Accessors ​

subjectCount ​

Get Signature ​

ts
get subjectCount(): number;

Defined in: src/review/OverlayReviewDataset.ts:225

Returns ​

number


currentSubjectIndex ​

Get Signature ​

ts
get currentSubjectIndex(): number;

Defined in: src/review/OverlayReviewDataset.ts:229

Returns ​

number


currentContrastId ​

Get Signature ​

ts
get currentContrastId(): string;

Defined in: src/review/OverlayReviewDataset.ts:233

Returns ​

string


subjects ​

Get Signature ​

ts
get subjects(): readonly SubjectInfo[];

Defined in: src/review/OverlayReviewDataset.ts:237

Returns ​

readonly SubjectInfo[]


contrasts ​

Get Signature ​

ts
get contrasts(): readonly ValidatedOverlayReviewContrast[];

Defined in: src/review/OverlayReviewDataset.ts:241

Returns ​

readonly ValidatedOverlayReviewContrast[]


template ​

Get Signature ​

ts
get template(): NeuroVol;

Defined in: src/review/OverlayReviewDataset.ts:245

Returns ​

NeuroVol

Methods ​

setSubjectIndex() ​

ts
setSubjectIndex(index): void;

Defined in: src/review/OverlayReviewDataset.ts:249

Parameters ​

index ​

number

Returns ​

void


setContrast() ​

ts
setContrast(id): void;

Defined in: src/review/OverlayReviewDataset.ts:254

Parameters ​

id ​

string

Returns ​

void


getContrast() ​

ts
getContrast(id?): ValidatedOverlayReviewContrast;

Defined in: src/review/OverlayReviewDataset.ts:259

Parameters ​

id? ​

string = ...

Returns ​

ValidatedOverlayReviewContrast


getDisplayRange() ​

ts
getDisplayRange(id?): Range;

Defined in: src/review/OverlayReviewDataset.ts:267

Parameters ​

id? ​

string = ...

Returns ​

Range


getSubjectVolume() ​

ts
getSubjectVolume(subjectIndex?, contrastId?): NeuroVol;

Defined in: src/review/OverlayReviewDataset.ts:272

Parameters ​

subjectIndex? ​

number = ...

contrastId? ​

string = ...

Returns ​

NeuroVol

Released under the MIT License.