pdebuyl-lab/tidynamics

Reasoning for inconsistency (or consistency) of input arguments

Closed this issue · 1 comments

malramsay64 commented

For your functions

  • tidynamics.acf takes data, the input signal
  • tidynamics.msd takes pos, the input trajectory
  • tidynamics.cross_displacement takes x, the input trajectory,

Using pos for msd does make sense. Should x be a conceptually different type of input data? If so, an explanation of each would be useful.

pdebuyl commented

acf is rather generic hence the data argument.

The x in cross_displacement is intended to be "positions", so I'll change only this one for consistency.