Refactoring #1065

Envelope task #1438: === Physics ===

Feature #1287: == Particle form factors ==

Revise particle form factors: change names, add few form factors, change some parametrization

Added by wuttke over 4 years ago. Updated 3 months ago.

Status:BacklogStart date:26 Jul 2016
Priority:LowDue date:
Assignee:-% Done:

100%

Category:-
Target version:-

Description

Class name changes for more internal consistency (get rid of IsGISAXS oddities):
  • FullSphere -> Sphere
  • FullSpheroid -> Spheroid
  • Cone -> ConicalFrustum # if it hasn't an apex, it isn't a come
  • AnisoPyramid -> Frustum2
  • Tetrahedron -> Frustum3 # tetra hedron = four sides, this one has five sides
  • Pyramid -> Frustum4
  • Cone6 -> Frustum6
  • Box -> Prism2
  • Ripple1 -> Sinewave
  • Ripple2 -> Sawtooth
  • TruncatedCube -> FacettedCube # everywhere else, we use "Truncated" for horizontal cuts
  • Cuboctahedron -> BiFrustum4 # plain wrong in legacy
New classes:
  • Prism4 (square base)
  • TruncatedEllipsoid
Inconvenient parametrization to be changed:
  • Cuboctahedron: uses H differently from all other classes; dimensionless number must not be named 'r'.
  • Ripple2: asymmetry parameter ought to be dimensionless
  • various ellipsoid classes: consider use of R_c, do not expose H, use dimension number to describe truncation
  • FacettedCube: use dimension number to describe truncation

Subtasks

Feature #1537: parametrize Gaussians and Lorentzians by mean and fwhmRejected

History

#1 Updated by wuttke over 4 years ago

  • Description updated (diff)

#2 Updated by wuttke over 4 years ago

  • Description updated (diff)

#3 Updated by wuttke over 4 years ago

  • Description updated (diff)

#4 Updated by wuttke over 4 years ago

  • Description updated (diff)

#5 Updated by wuttke over 4 years ago

  • Subject changed from to discuss: name changes and additions to make particle form factor list more consistent to Revise particle form factors: change names, add few form factors, change some parametrization
  • Description updated (diff)

#6 Updated by wuttke over 4 years ago

  • Description updated (diff)

#7 Updated by wuttke over 4 years ago

  • Description updated (diff)

#8 Updated by wuttke over 4 years ago

  • Description updated (diff)

#9 Updated by wuttke over 4 years ago

  • Description updated (diff)

#10 Updated by wuttke over 3 years ago

  • Parent task set to #1287

#11 Updated by wuttke over 3 years ago

  • Assignee set to wuttke

#12 Updated by wuttke over 3 years ago

  • Status changed from New to Sprint
  • Target version set to Sprint 31

agreed since long that this should be part of the next API-breaking sprint

#13 Updated by pospelov over 3 years ago

I suggest to rename really few most unpleasant names already this sprint and not return back to renaming question until the release 3 to not to screw up project file back compatibility, again.

My personal choice would be
Ripple1 -> CosineRipple
Ripple2 -> TriangularRipple

The rest can wait, to my opinion.

#14 Updated by wuttke over 3 years ago

  • Status changed from Sprint to Backlog
  • Target version changed from Sprint 31 to Sprint32
To be done together with other renamings. Decided so far:
  • akronyms not all in capitals, for consistency with camel case: * GuiSuite * GisasSimulation

#15 Updated by wuttke over 3 years ago

Rename FormFactorTrivial -> FormfactorDot ... and suddenly it's physical

#16 Updated by herck over 3 years ago

  • Target version deleted (Sprint32)

Split into separate issues

#17 Updated by wuttke about 3 years ago

  • Assignee deleted (wuttke)

Needs further preparation & discussion

#18 Updated by wuttke 5 months ago

  • Target version set to v2.0

#19 Updated by pospelov 3 months ago

  • Target version deleted (v2.0)

Also available in: Atom PDF