flywire_islatest: Check that one or more FlyWire root ids have not been further...

In natverse/fafbseg: Support Functions for Analysis of FAFB EM Segmentation

Check that one or more FlyWire root ids have not been further edited

Description

You can think of flywire_islatest as returning whether a root id is valid at a given timestamp (by default now). If the corresponding object has been edited, invalidating the root id, or does not (yet) exist then

Usage

flywire_islatest(
  x,
  cloudvolume.url = NULL,
  timestamp = NULL,
  version = NULL,
  cache = NA,
  ...
)

Arguments

x	FlyWire rootids in any format understandable to ngl_segments including as integer64
cloudvolume.url	URL for CloudVolume to fetch segmentation image data. The default value of NULL chooses the flywire production segmentation dataset.
timestamp	(optional) argument to set an endpoint - edits after this time will be ignored (see details).
version	An optional CAVE materialisation version number. See details and examples.
cache	Whether to cache the result - the default value of NA will do this if a timestamp or version argument is supplied.
...	Additional arguments to flywire_fetch

Details

This call is quite fast (think thousands of ids per second). The current implementation also de-duplicates the input automatically. You can pass in a vector containing duplicates and only the unique ids will be passed on to the server.

If you provide input as integer64 then data will be sent in binary form to the flywire server. This can have a significant time saving for large queries (think 10000+).

When a timestamp or version is provided, only edits up until that time point will be considered. Note that since August 2022 flywire_islatest will return FALSE in the case of a rootid that was not created until after the timestamp. Formerly it returned TRUE (see seung-lab/PyChunkedGraph#412)

Value

A logical vector of length matching the input. NA/0 input values will return NA as output.

See Also

Other flywire-ids: flywire_last_modified(), flywire_latestid(), flywire_leaves(), flywire_rootid(), flywire_updateids(), flywire_xyz2id()

Examples

flywire_islatest("720575940621039145")
flywire_islatest(c("720575940619073968", "720575940637707136"))

# check the first id up to a given timestamp
# when was it created (= last modified)
flywire_last_modified('720575940619073968')
# TRUE
flywire_islatest('720575940619073968', timestamp = '2020-12-03 UTC')
# FALSE since it didn't exist
flywire_islatest("720575940619073968", timestamp = "2020-12-01 UTC")

## Not run: 
latest=flywire_latestid("720575940619073968")
flywire_islatest(latest)

# compare checking roots downstream of two large bilateral neurons
blids=c("720575940619073968", "720575940637707136")
blidsout=flywire_partners(blids)
# 3.2 vs 4.7s in my test
bench::mark(bin=flywire_islatest(blidsout$post_id),
  str=flywire_islatest(as.character(blidsout$post_id)))

## End(Not run)

natverse/fafbseg documentation built on Nov. 11, 2024, 9:50 p.m.