Ticket #208 (closed: fixed)

Opened 12 years ago

Last modified 5 years ago

Document Algorithms

Reported by: Nick Draper Owned by: Anders Markvardsen
Priority: critical Milestone: Iteration 16
Component: Keywords:
Cc: Blocked By:
Blocking: Tester:

Description (last modified by Nick Draper) (diff)

Please document the following algorithms on the wiki in a manner similar to http://www.mantidproject.org/Plus

  • LoadInstrument
  • LoadLog
  • All of the CurveFitting Algorithms
  • SaveCSV
  • LoadInstrumentFromRaw
  • Any others that you have been involved in

Change History

comment:1 Changed 12 years ago by Nick Draper

  • Description modified (diff)

comment:2 Changed 12 years ago by Nick Draper

  • Description modified (diff)

comment:3 Changed 12 years ago by Nick Draper

  • Priority changed from major to critical
  • Milestone changed from Iteration 11 to Iteration 12

comment:4 Changed 12 years ago by Nick Draper

  • Milestone changed from Iteration 12 to Iteration 13

comment:5 Changed 12 years ago by Anders Markvardsen

(In [1469]) Updated doc for LoadLog.h,.cpp and wiki. Refs #208.

comment:6 Changed 12 years ago by Nick Draper

  • Milestone changed from Iteration 13 to Iteration 14

comment:7 Changed 12 years ago by Nick Draper

  • Milestone changed from Iteration 14 to Iteration 15

comment:8 Changed 12 years ago by Anders Markvardsen

(In [1942]) Added wiki doc for Gaussian and updated a few comments in code. Refs #208.

comment:9 Changed 12 years ago by Anders Markvardsen

(In [2006]) 1. Added doc for back-to-back exponential peak shape function

  1. Found mistake in the mathematical expression Paolo sent to me for this function

and corrected this in the code.

  1. A few minor changes to doxygen doc for the Gaussian function. Refs #208.

comment:10 Changed 12 years ago by Anders Markvardsen

(In [2018]) Added wiki doc for SaveCSV and updated a few comments in code. Refs #208.

comment:11 Changed 12 years ago by Nick Draper

  • Milestone changed from Iteration 15 to Iteration 16

Batch move uncompleted tickes to next iteration

comment:12 Changed 12 years ago by Anders Markvardsen

(In [2074]) Start on wiki doc for HowToDefineGeometricShape and in this context added additional test. Refs #208.

comment:13 Changed 12 years ago by Anders Markvardsen

  • Status changed from new to assigned

Finish wiki doc for LoadInstrument, which links to InstrumentDefinitionFile and HowToDefineGeometricShape. The InstrumentDefinitionFile wiki contains a link to LOQ_Definition which explains in some detail the LOQ IDF. There is of course still room for improving the wiki further for describing the instrument definition file format, but this is a least a good start.

comment:14 Changed 12 years ago by Anders Markvardsen

(In [2108]) Wiki stuff for LoadEmptyInstrument and LoadInstrumentFromRaw and a few mods to doc in code for these algorithms. Refs #208.

comment:15 Changed 12 years ago by Anders Markvardsen

(In [2173]) Purely some cosmetic changes to IDFs in connection with writing the wiki doc for an IDF. Refs #208.

comment:16 Changed 12 years ago by Anders Markvardsen

(In [2174]) Replace all facing rot="something" tags from IDFs, done in connection with writing of wiki doc for IDFs. Refs #208.

comment:17 Changed 12 years ago by Anders Markvardsen

(In [2180]) Removed all <origin> sub-elements of <defaults>. Turn out to serve no purpose only potential confusion. Done in connection with writing wiki for IDFs. Refs #208.

comment:18 Changed 12 years ago by Anders Markvardsen

(In [2200]) Remove reference to unused <offsets> in IDFs. Refs #208.

comment:19 Changed 12 years ago by Anders Markvardsen

  • Status changed from assigned to closed
  • Resolution set to fixed

Added more doc for IDFs. See InstrumentDefinitionFile and HowToDefineGeometricShape. In addition updated documentation->Concepts->instrument and documentation->Concept->'Geometry of Shape' to link to these new wiki pages.

comment:20 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​1056

Note: See TracTickets for help on using tickets.