Context Navigation

Ticket #9126 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Add Flowchart to DetectorDiagnostic documentation

Reported by:	Karl Palmen	Owned by:	Karl Palmen
Priority:	major	Milestone:	Release 3.4
Component:	Documentation	Keywords:
Cc:		Blocked By:
Blocking:	#9718	Tester:	Andrei Savici

Description

Add a flowchart to explain the properties and child algorithms of DetectorDiagnostic. Add the flowchart in the manner explained in http://www.mantidproject.org/Documenting_Workflow_Algorithms .

Simple and obvious properties may be omitted from the flowchart to keep it tidy and easy to follow.

Attachments

DetectorDiagnosticInputPropertiesTable.txt (3.8 KB) - added by Karl Palmen 5 years ago.: This table shows how input properties of DetectorDiagnostic are passed to child algorithms.

Change History

comment:1 Changed 7 years ago by Karl Palmen

Blocking 8917 added

comment:2 Changed 7 years ago by Karl Palmen

The code for DetectorDiagnostic was found in Algorithms rather than WorkflowAlgorithms and so may not be a bona-fide workflow algorthm.

If it is, then a new folder for the flowchart XML file would need creating in the Algorithms folder.

If it is not, then this ticket may be invalid.

Last edited 7 years ago by Karl Palmen (previous) (diff)

comment:3 Changed 7 years ago by Nick Draper

Status changed from new to assigned
Owner set to Michael Reuter
Milestone changed from Release 3.3 to Release 3.2

comment:4 Changed 7 years ago by Nick Draper

remove SSC keyword for child blocking tickets

comment:5 Changed 7 years ago by Nick Draper

Keywords SSC removed

comment:6 Changed 6 years ago by Karl Palmen

Milestone changed from Release 3.2 to Release 3.3

comment:7 Changed 6 years ago by Karl Palmen

Blocking 9718 added

comment:8 Changed 6 years ago by Karl Palmen

Blocking 8917 removed

comment:9 Changed 6 years ago by Karl Palmen

The adding of a usage example is covered by ticket #9704.

comment:10 Changed 6 years ago by Nick Draper

Moved to the backlog at the code freeze of R3.3

comment:11 Changed 6 years ago by Nick Draper

Milestone changed from Release 3.3 to Backlog

comment:12 Changed 6 years ago by Karl Palmen

Milestone changed from Backlog to Release 3.4

This ticket blocks a release 3.4 ticket.

comment:13 Changed 6 years ago by Nick Draper

Owner changed from Michael Reuter to Karl Palmen

comment:14 Changed 6 years ago by Nick Draper

Michael no longer works for the SNS, could you give this a go

comment:15 Changed 5 years ago by Karl Palmen

Status changed from assigned to inprogress

comment:16 Changed 5 years ago by Karl Palmen

On examining the algorithm does five tests, which have essentially identical flowcharts.

Each test is done by a child algorithm that has a test workspace as its input workspace. If its test workspace exists, the child algorithm is executed and outputs a mask workspace and a number of failures. The mask is applied to the main input workspace and the number of failures is added to a running total.

LIST OF TESTS

Workspace                   Child Algorithm
---------                   ---------------
DetVanCompare               MedianDetectorTest
DetVanCompare               DetectorEfficiencyVariation
SampleTotalCountsWorkspace  FindDetectorsOutsideLimits
SampleBackgroundWorkspace   MedianDetectorTest
SampleWorkspace             CreatePSDBleedMask