pointpats icon indicating copy to clipboard operation
pointpats copied to clipboard

usage of `intensity` within `random.py` distributions?

Open jGaboardi opened this issue 2 years ago • 2 comments

Within random.parse_size_and_intensity() the intensity variable is returned when called within each available distribution (poisson, normal, cluster_poisson, and cluster_normal). However, intensity does not appear to used outside parse_size_and_intensity().

Does intensity actually need to be returned from parse_size_and_intensity()?

jGaboardi avatar Aug 09 '23 22:08 jGaboardi

Intensity and the first element of the "Size" tuple give the same information. Like, sampling a unit square at intensity 2 should be the same as sampling two points from it.

The intensity is returned from the parse function just in case future functions find it easier to work with that than with the sizes. Right now, though, we're always using the sizes, either inferred from intensity or given by the user.

That make sense?

ljwolf avatar Aug 10 '23 06:08 ljwolf

Yes, that makes sense.

The intensity is returned from the parse function just in case future functions find it easier to work with that than with the sizes. Right now, though, we're always using the sizes, either inferred from intensity or given by the user.

Would you be against me putting in a PR that adds some information to the docstring to remind us (me) for future reference?

@ljwolf Thoughts in this?

jGaboardi avatar Aug 10 '23 18:08 jGaboardi