Ticket #9719 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Add usage examples for Le Bail fit related algorithms

Reported by: Wenduo Zhou Owned by: Wenduo Zhou
Priority: critical Milestone: Release 3.3
Component: Framework Keywords:
Cc: Blocked By:
Blocking: Tester: Lottie Greenwood

Description (last modified by Wenduo Zhou) (diff)

Added usage examples for the following algorithms:

  1. ProcessBackground.cpp
  2. RefinePowderInstrumentParameters3.cpp
  3. FitPowderDiffPeaks.cpp
  4. LeBailFit.cpp
  5. RefinePowderInstrumentParameters.cpp
  6. ProcessDasNexusLog.cpp
  7. ExaminePowderDiffProfile.py
  8. LoadFullprofFile.py
  9. RefinePowderDiffProfileSeq.py
  10. SelectPowderDiffPeaks.py

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Wenduo Zhou

  • Status changed from assigned to inprogress

comment:3 Changed 6 years ago by Wenduo Zhou

Removed isOptional for python. Refs #9719.

Changeset: 23d502450863226b82d016a21e884c0304fa00e7

comment:4 Changed 6 years ago by Wenduo Zhou

Minor modification on doc. Refs #9719.

Changeset: 535a8e48f6e28ad92127f8ad9d5b7c6494b7a800

comment:5 Changed 6 years ago by Wenduo Zhou

Refs #9719. Added usage example of FitPowderDiffPeaks.

On branch feature/9719_lebail_usage_example

modified: ../Mantid/docs/source/algorithms/FitPowderDiffPeaks-v1.rst new file: ../../Test/AutoTestData/UsageData/2011B_HR60b3.irf new file: ../../Test/AutoTestData/UsageData/PG3_11487-3.dat

Changeset: 4795a22703824013e930c2ee21633df1b2287e33

comment:6 Changed 6 years ago by Wenduo Zhou

Refs #9719. Remove RefinePowderInstrumentParameters v1 out.

Changeset: 2c3bc33b38bf406f17ff2d947f94555907f566e1

comment:7 Changed 6 years ago by Wenduo Zhou

Refs #9719. More docs on RefinePowderInstrumentParameters.

Changeset: 899a89d55ed6d166f2f10e11ca5592e4ed92b00f

comment:8 Changed 6 years ago by Wenduo Zhou

Refs #9719. Added a few words.

Changeset: 64ea7640ac5633479494851b3b81155be0714105

comment:9 Changed 6 years ago by Wenduo Zhou

Removed isOptional for python. Refs #9719.

Changeset: 02f904e24743cc7cd881ac674b6c6cb54d428ac0

comment:10 Changed 6 years ago by Wenduo Zhou

Minor modification on doc. Refs #9719.

Changeset: 9acea899ee454b616cd11f7b0851a0741fe1ec1d

comment:11 Changed 6 years ago by Wenduo Zhou

Refs #9719. Added usage example of FitPowderDiffPeaks.

On branch feature/9719_lebail_usage_example

modified: ../Mantid/docs/source/algorithms/FitPowderDiffPeaks-v1.rst new file: ../../Test/AutoTestData/UsageData/2011B_HR60b3.irf new file: ../../Test/AutoTestData/UsageData/PG3_11487-3.dat

Changeset: b13ea9d926f95990afc2837eec1b735d113cba41

comment:12 Changed 6 years ago by Wenduo Zhou

Refs #9719. Remove RefinePowderInstrumentParameters v1 out.

Changeset: 3c3d446435e39a38ea76b9988100bd365d790e76

comment:13 Changed 6 years ago by Wenduo Zhou

Refs #9719. More docs on RefinePowderInstrumentParameters.

Changeset: b040c4e35dfb0d20ee9b7dd3516a53d687a37368

comment:14 Changed 6 years ago by Wenduo Zhou

Refs #9719. Added a few words.

Changeset: 6120ad3f2e6fba58864741dac5d731b978c90a64

comment:15 Changed 6 years ago by Wenduo Zhou

Corrected FitPowderDiffPeaks usage sample. Refs #9719.

Changeset: 9efd5146c7988689d02e531098f929500bfe3dc9

comment:16 Changed 6 years ago by Wenduo Zhou

  • Description modified (diff)

comment:17 Changed 6 years ago by Wenduo Zhou

  • Description modified (diff)

comment:18 Changed 6 years ago by Wenduo Zhou

  • Description modified (diff)

comment:19 Changed 6 years ago by Wenduo Zhou

For Tester

I added the usage example for part of the algorithms listed in the ticket description. The rest will be dealt with in ticket #10758.

Added usage examples for the following algorithms:

The usage example for these three algorithms have been added in this ticket or previous tickets.

  1. ProcessBackground.cpp
  2. FitPowderDiffPeaks.cpp
  3. LoadFullprofFile.py

The following two algorithms are claimed to be deprecated. And thus there is no need to add any usage example for them.

  1. ProcessDasNexusLog.cpp
  2. SelectPowderDiffPeaks.py

ASAP

  1. ExaminePowderDiffProfile.py (workflow algorithm)

The usage examples for these 4 algorithms will be implemented in ticket #10758.

  1. RefinePowderInstrumentParameters.cpp
  2. RefinePowderInstrumentParameters3.cpp
  3. LeBailFit.cpp
  4. RefinePowderDiffProfileSeq.py
Last edited 6 years ago by Wenduo Zhou (previous) (diff)

comment:20 Changed 6 years ago by Wenduo Zhou

Refs #9719. Added usage example for ExaminePowderDiffProfile.

And corrected some bugs in this algorithm.

Changeset: 7c899e0e7a7157d4e40bf7e8ef3819df1812e263

comment:21 Changed 6 years ago by Wenduo Zhou

Refs #9719. Claimed SelectPowderDiffPeaks deprecated.

And edit its sphinx doc.

Changeset: 2aa79501c3cd4dcfcad299dd33768fac5f7cf8d7

comment:22 Changed 6 years ago by Wenduo Zhou

Fixed doc test. Refs #9719.

Changeset: cd92fa1673eb711b4d2c5c8459da885ce473d13d

comment:23 Changed 6 years ago by Wenduo Zhou

  • Status changed from inprogress to verify
  • Resolution set to fixed

comment:24 Changed 6 years ago by Lottie Greenwood

  • Status changed from verify to verifying
  • Tester set to Lottie Greenwood

comment:25 Changed 6 years ago by Lottie Greenwood

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9719_more_usage_example'

Full changeset: ​0e08da3f36db355e89a9a3e2d75b0fda4069e736

comment:26 Changed 6 years ago by Lottie Greenwood

Refs #9719 Fixed bullet point formatting

Changeset: f3e733dd3a89a2da04b864ec7834530ec9316327

comment:27 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10561

Note: See TracTickets for help on using tickets.