Skip to content

Functions regrouping

Peter Lünenschloß requested to merge FunctionsRegrouping into develop

Regrouping of functions (nearly) as discussed in #114 (closed). See the list below for an overview of the new modules as realized in this merge.

Some changes not discussed in !114 (closed) . Objections welcome:

  • i comprised copy, drop and rename in module shape - opposing the suggestion datatools
  • for functions, detecting (and assigning labels) rather than flagging, i went for the verb "assign" rather than "detect" as prefix.
  • i threw out slidingZScore - since it is slow and also intransparent in its count parameter. The supported way to achieve compareable flagging, is, to calculate polynomial residues with calculatePolynomialResidues first (which is numba boosted) and then apply flagMAD or flagGrubbs or whatever one wants onto the residues
  • I again altered the harm wrapper funct names slightly - please have a look at the resampling module summary in the table below and object if you cant consent.
  • in the table of !114 (closed) i forgot to include flagBasic - since nothing is basic about this function, i tried to find a name describing i a little better - its flagUponReturn now.

(I assigned the request to @palmb - but since you all also have to live with the naming conventions for all future - @schaefed - you might want to have a brief look as well.)

(develop isnt merged yet - wanted to wait till the last moment cause get it will get a bit "conflict-ish")

new name old name calling chain
generic
flag
process
flagstools
flagForceFail
flagGood
flagDummy
flagManual
clearFlags
shape
rename
drop
copy
outliers
flagRange
flagMVScores oddWater scorekNN-stray-reduceMVflags
flagByStray _stray
flagByGrubbs
flagCrossScoring
flagRaise
flagMAD
flagUponReturn
breaks BreakDetection
flagJumps detectChangePoints
flagIsolated detectChangePoints
flagMissing detectChangePoints
constants ConstantsDetection
flagConstant
flagByVariance
changepoints
assignChangePoints flagChangePoints
flagChangePoints
resampling
shiftToFreq harm_shift2Grid
linearAtFreq harm_linear2Grid interpolateIndex
aggregateAtFreq harm_aggregate2Grid resample
interpolateAtFreq harm_interpolate2Grid interpolateIndex
shift
resample
mapToOriginal harm_deharmonize reindexFlags
reindexFlags proc_projectFlags reindexFlags
interpolation
interpolateByRolling
interpolateInvalid proc_interpolateMissing
interpolateIndex proc_interpolateGrid
curvefit
fitPolynomial
residues
calculatePolynomialResidues modelling_polyfit fitPolynomial
rolling
roll
scores
assignKNNScores
drift
flagDriftFromNorm
flagDriftFromReference
flagDriftFromScaledNorm
correctExpDrift proc_seefoDriftCorrecture
correctOffset correctRegime
correctRegime detectChangePoints
assignRegimeAnomaly
flagRegimeAnomaly
pattern
flagPatternByWavelet
flagPatternByDTW
Edited by Peter Lünenschloß

Merge request reports