Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Calculation of RQA parameters for "white vertical structures" #24

Closed
heliosdrm opened this issue Dec 31, 2018 · 8 comments
Closed

Calculation of RQA parameters for "white vertical structures" #24

heliosdrm opened this issue Dec 31, 2018 · 8 comments
Assignees

Comments

@heliosdrm
Copy link
Collaborator

Create the dedicated functions, and extend rqa to support the new related keys.

@heliosdrm heliosdrm self-assigned this Dec 31, 2018
@heliosdrm
Copy link
Collaborator Author

heliosdrm commented Jan 3, 2019

@pucicu: what parameters should be included?

  • Mean recurrence time
  • Recurrence time entropy
  • Maximum recurrence time
  • ... other?

On the other hand, what estimate to recurrence times do you recommend?
(a) distance between starting points of vertical recurrent structures
(b) length of vertical "white lines"

Both are easy to calculate and can be provided if necessary, but I wonder whether that would be complicating the interface too much...

EDIT: or we can calculate the average of (a) and (b), as a tradeoff.

@pucicu
Copy link
Contributor

pucicu commented Jan 3, 2019 via email

@heliosdrm
Copy link
Collaborator Author

About the most probable recurrence time: what is the criterion when there are ties? (i.e. an histogram of recurrence times with two or more bins equal to the maximum)

@pucicu
Copy link
Contributor

pucicu commented Jan 5, 2019 via email

@heliosdrm
Copy link
Collaborator Author

Well, I have read Ngamga's paper (DOI: 10.1103/PhysRevE.75.036222), and realized that there is no such ambiguity: it is not the "most probable recurrence time", but the "number of the most probable recurrence time", i.e. the size of the maximum bin in the histogram, not its position. So ties are not an issue anymore.

@heliosdrm
Copy link
Collaborator Author

I'm about finishing this. My main remaining doubt is about the names of the functions to calculate those parameters. Following Julia's style guide I propose this:

  • meanrecurrencetime , with key "MRT" in the corresponding dictionary item returned by rqa.
  • recurrencetime_entropy, with key "RTE".
  • mostprobable_recurrencetime, with key "NMPRT".

The "N" in the last key comes is present in the acronym given in Ngnamga's paper, standing for "number of the most probable recurrence time" (NMPRT), which is a more accurate description. (To be consistent the function name should be something like "number_mostprobable_recurrencetime", but I think that it is just too much...

Yet another doubt is if, to keep consistency between names, we should use mean_recurrencetime instead of meanrecurrencetime, and rqa_entropy instead of rqaentropy (cf. #30). Both "squashed names" are readable, but perhaps it is easer to remember them if the words "entropy" and "recurrencetime" are always separated by an underscore.

@Datseris
Copy link
Member

Datseris commented Jan 7, 2019

I'd propose to name the function nmprt instead of the current long names. Maybe not very readable, true, but the other names suffer from extreme verbosity. Coupling two words together (or using a 3rd small like is or mean) is the limit I've found from experience. For more than that, it becomes too verbose and lengthy to be beneficial. This also means that I think meanrecurrencetime is okay.

For the entropy, I suggest rt_entropy. And taking the opportunity, maybe it is worth also changing rqaentropy not to rqa_entropy but instead to dl_entropy from "diagonal lengths entropy".

Honestly, the functions offered by RecurrenceAnalysis are so many that I think one should always have a tab of the documentation page open just to be on the safe side :D so I wouldn't be too concerned with this in the end of the day!

@pucicu
Copy link
Contributor

pucicu commented Jan 7, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants